2 Unix SMB/CIFS implementation.
4 Python wrapper for winbind client functions.
6 Copyright (C) Tim Potter 2002-2003
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #include "py_winbind.h"
26 * Exceptions raised by this module
29 PyObject *winbind_error; /* A winbind call returned WINBINDD_ERROR */
31 /* Prototypes from common.h */
33 NSS_STATUS winbindd_request(int req_type,
34 struct winbindd_request *request,
35 struct winbindd_response *response);
38 * Name <-> SID conversion
41 /* Convert a name to a sid */
43 static PyObject *py_name_to_sid(PyObject *self, PyObject *args)
46 struct winbindd_request request;
47 struct winbindd_response response;
52 if (!PyArg_ParseTuple(args, "s", &name))
56 ZERO_STRUCT(response);
58 sep = lp_winbind_separator();
60 if ((p = strchr(name, sep[0]))) {
62 fstrcpy(request.data.name.dom_name, name);
63 fstrcpy(request.data.name.name, p + 1);
65 fstrcpy(request.data.name.dom_name, lp_workgroup());
66 fstrcpy(request.data.name.name, name);
69 if (winbindd_request(WINBINDD_LOOKUPNAME, &request, &response)
70 != NSS_STATUS_SUCCESS) {
71 PyErr_SetString(winbind_error, "lookup failed");
75 result = PyString_FromString(response.data.sid.sid);
80 /* Convert a sid to a name */
82 static PyObject *py_sid_to_name(PyObject *self, PyObject *args)
84 struct winbindd_request request;
85 struct winbindd_response response;
89 if (!PyArg_ParseTuple(args, "s", &sid))
93 ZERO_STRUCT(response);
95 fstrcpy(request.data.sid, sid);
97 if (winbindd_request(WINBINDD_LOOKUPSID, &request, &response)
98 != NSS_STATUS_SUCCESS) {
99 PyErr_SetString(winbind_error, "lookup failed");
103 asprintf(&name, "%s%s%s", response.data.name.dom_name,
104 lp_winbind_separator(), response.data.name.name);
106 result = PyString_FromString(name);
114 * Enumerate users/groups
117 /* Enumerate domain users */
119 static PyObject *py_enum_domain_users(PyObject *self, PyObject *args)
121 struct winbindd_response response;
124 if (!PyArg_ParseTuple(args, ""))
127 ZERO_STRUCT(response);
129 if (winbindd_request(WINBINDD_LIST_USERS, NULL, &response)
130 != NSS_STATUS_SUCCESS) {
131 PyErr_SetString(winbind_error, "lookup failed");
135 result = PyList_New(0);
137 if (response.extra_data) {
138 const char *extra_data = response.extra_data;
141 while (next_token(&extra_data, name, ",", sizeof(fstring)))
142 PyList_Append(result, PyString_FromString(name));
148 /* Enumerate domain groups */
150 static PyObject *py_enum_domain_groups(PyObject *self, PyObject *args)
152 struct winbindd_response response;
153 PyObject *result = NULL;
155 if (!PyArg_ParseTuple(args, ""))
158 ZERO_STRUCT(response);
160 if (winbindd_request(WINBINDD_LIST_GROUPS, NULL, &response)
161 != NSS_STATUS_SUCCESS) {
162 PyErr_SetString(winbind_error, "lookup failed");
166 result = PyList_New(0);
168 if (response.extra_data) {
169 const char *extra_data = response.extra_data;
172 while (next_token(&extra_data, name, ",", sizeof(fstring)))
173 PyList_Append(result, PyString_FromString(name));
180 * Miscellaneous domain related
183 /* Enumerate domain groups */
185 static PyObject *py_enum_trust_dom(PyObject *self, PyObject *args)
187 struct winbindd_response response;
188 PyObject *result = NULL;
190 if (!PyArg_ParseTuple(args, ""))
193 ZERO_STRUCT(response);
195 if (winbindd_request(WINBINDD_LIST_TRUSTDOM, NULL, &response)
196 != NSS_STATUS_SUCCESS) {
197 PyErr_SetString(winbind_error, "lookup failed");
201 result = PyList_New(0);
203 if (response.extra_data) {
204 const char *extra_data = response.extra_data;
207 while (next_token(&extra_data, name, ",", sizeof(fstring)))
208 PyList_Append(result, PyString_FromString(name));
214 /* Check machine account password */
216 static PyObject *py_check_secret(PyObject *self, PyObject *args)
218 struct winbindd_response response;
220 if (!PyArg_ParseTuple(args, ""))
223 ZERO_STRUCT(response);
225 if (winbindd_request(WINBINDD_CHECK_MACHACC, NULL, &response)
226 != NSS_STATUS_SUCCESS) {
227 PyErr_SetString(winbind_error, "lookup failed");
231 return PyInt_FromLong(response.data.num_entries);
235 * Return a dictionary consisting of all the winbind related smb.conf
236 * parameters. This is stored in the module object.
239 static PyObject *py_config_dict(void)
245 if (!(result = PyDict_New()))
248 /* Various string parameters */
250 PyDict_SetItemString(result, "workgroup",
251 PyString_FromString(lp_workgroup()));
253 PyDict_SetItemString(result, "separator",
254 PyString_FromString(lp_winbind_separator()));
256 PyDict_SetItemString(result, "template_homedir",
257 PyString_FromString(lp_template_homedir()));
259 PyDict_SetItemString(result, "template_shell",
260 PyString_FromString(lp_template_shell()));
262 /* idmap uid/gid range */
264 if (lp_idmap_uid(&ulow, &uhi)) {
265 PyDict_SetItemString(result, "uid_low", PyInt_FromLong(ulow));
266 PyDict_SetItemString(result, "uid_high", PyInt_FromLong(uhi));
269 if (lp_idmap_gid(&glow, &ghi)) {
270 PyDict_SetItemString(result, "gid_low", PyInt_FromLong(glow));
271 PyDict_SetItemString(result, "gid_high", PyInt_FromLong(ghi));
281 /* Convert a uid to a SID */
283 static PyObject *py_uid_to_sid(PyObject *self, PyObject *args)
285 struct winbindd_request request;
286 struct winbindd_response response;
289 if (!PyArg_ParseTuple(args, "i", &id))
292 ZERO_STRUCT(request);
293 ZERO_STRUCT(response);
295 request.data.uid = id;
297 if (winbindd_request(WINBINDD_UID_TO_SID, &request, &response)
298 != NSS_STATUS_SUCCESS) {
299 PyErr_SetString(winbind_error, "lookup failed");
303 return PyString_FromString(response.data.sid.sid);
306 /* Convert a gid to a SID */
308 static PyObject *py_gid_to_sid(PyObject *self, PyObject *args)
310 struct winbindd_request request;
311 struct winbindd_response response;
314 if (!PyArg_ParseTuple(args, "i", &id))
317 ZERO_STRUCT(request);
318 ZERO_STRUCT(response);
320 request.data.gid = id;
322 if (winbindd_request(WINBINDD_GID_TO_SID, &request, &response)
323 != NSS_STATUS_SUCCESS) {
324 PyErr_SetString(winbind_error, "lookup failed");
328 return PyString_FromString(response.data.sid.sid);
331 /* Convert a sid to a uid */
333 static PyObject *py_sid_to_uid(PyObject *self, PyObject *args)
335 struct winbindd_request request;
336 struct winbindd_response response;
339 if (!PyArg_ParseTuple(args, "s", &sid))
342 ZERO_STRUCT(request);
343 ZERO_STRUCT(response);
345 fstrcpy(request.data.sid, sid);
347 if (winbindd_request(WINBINDD_SID_TO_UID, &request, &response)
348 != NSS_STATUS_SUCCESS) {
349 PyErr_SetString(winbind_error, "lookup failed");
353 return PyInt_FromLong(response.data.uid);
356 /* Convert a sid to a gid */
358 static PyObject *py_sid_to_gid(PyObject *self, PyObject *args)
360 struct winbindd_request request;
361 struct winbindd_response response;
364 if (!PyArg_ParseTuple(args, "s", &sid))
367 ZERO_STRUCT(request);
368 ZERO_STRUCT(response);
370 fstrcpy(request.data.sid, sid);
372 if (winbindd_request(WINBINDD_SID_TO_GID, &request, &response)
373 != NSS_STATUS_SUCCESS) {
374 PyErr_SetString(winbind_error, "lookup failed");
378 return PyInt_FromLong(response.data.gid);
382 * PAM authentication functions
385 /* Plaintext authentication */
387 static PyObject *py_auth_plaintext(PyObject *self, PyObject *args)
389 struct winbindd_request request;
390 struct winbindd_response response;
391 char *username, *password;
393 if (!PyArg_ParseTuple(args, "ss", &username, &password))
396 ZERO_STRUCT(request);
397 ZERO_STRUCT(response);
399 fstrcpy(request.data.auth.user, username);
400 fstrcpy(request.data.auth.pass, password);
402 if (winbindd_request(WINBINDD_PAM_AUTH, &request, &response)
403 != NSS_STATUS_SUCCESS) {
404 PyErr_SetString(winbind_error, "lookup failed");
408 return PyInt_FromLong(response.data.auth.nt_status);
411 /* Challenge/response authentication */
413 static PyObject *py_auth_crap(PyObject *self, PyObject *args, PyObject *kw)
415 static char *kwlist[] =
416 {"username", "password", "use_lm_hash", "use_nt_hash", NULL };
417 struct winbindd_request request;
418 struct winbindd_response response;
419 char *username, *password;
420 int use_lm_hash = 1, use_nt_hash = 1;
422 if (!PyArg_ParseTupleAndKeywords(
423 args, kw, "ss|ii", kwlist, &username, &password,
424 &use_lm_hash, &use_nt_hash))
427 ZERO_STRUCT(request);
428 ZERO_STRUCT(response);
430 if (push_utf8_fstring(request.data.auth_crap.user, username) == -1) {
431 PyErr_SetString(winbind_error, "unable to create utf8 string");
435 generate_random_buffer(request.data.auth_crap.chal, 8, False);
438 SMBencrypt((uchar *)password, request.data.auth_crap.chal,
439 (uchar *)request.data.auth_crap.lm_resp);
440 request.data.auth_crap.lm_resp_len = 24;
444 SMBNTencrypt((uchar *)password, request.data.auth_crap.chal,
445 (uchar *)request.data.auth_crap.nt_resp);
446 request.data.auth_crap.nt_resp_len = 24;
449 if (winbindd_request(WINBINDD_PAM_AUTH_CRAP, &request, &response)
450 != NSS_STATUS_SUCCESS) {
451 PyErr_SetString(winbind_error, "lookup failed");
455 return PyInt_FromLong(response.data.auth.nt_status);
458 #if 0 /* Include when auth_smbd merged to HEAD */
460 /* Challenge/response authentication, with secret */
462 static PyObject *py_auth_smbd(PyObject *self, PyObject *args, PyObject *kw)
464 static char *kwlist[] =
465 {"username", "password", "use_lm_hash", "use_nt_hash", NULL };
466 struct winbindd_request request;
467 struct winbindd_response response;
468 char *username, *password;
469 int use_lm_hash = 1, use_nt_hash = 1;
471 if (!PyArg_ParseTupleAndKeywords(
472 args, kw, "ss|ii", kwlist, &username, &password,
473 &use_lm_hash, &use_nt_hash))
476 ZERO_STRUCT(request);
477 ZERO_STRUCT(response);
479 if (push_utf8_fstring(request.data.auth_crap.user, username) == -1) {
480 PyErr_SetString("unable to create utf8 string");
484 generate_random_buffer(request.data.smbd_auth_crap.chal, 8, False);
487 SMBencrypt((uchar *)password,
488 request.data.smbd_auth_crap.chal,
489 (uchar *)request.data.smbd_auth_crap.lm_resp);
490 request.data.smbd_auth_crap.lm_resp_len = 24;
494 SMBNTencrypt((uchar *)password,
495 request.data.smbd_auth_crap.chal,
496 (uchar *)request.data.smbd_auth_crap.nt_resp);
497 request.data.smbd_auth_crap.nt_resp_len = 24;
500 if (!secrets_fetch_trust_account_password(
501 lp_workgroup(), request.data.smbd_auth_crap.proof, NULL)) {
503 winbind_error, "unable to fetch domain secret");
509 if (winbindd_request(WINBINDD_SMBD_AUTH_CRAP, &request, &response)
510 != NSS_STATUS_SUCCESS) {
511 PyErr_SetString(winbind_error, "lookup failed");
515 return PyInt_FromLong(response.data.auth.nt_status);
520 /* Get user info from name */
522 static PyObject *py_getpwnam(PyObject *self, PyObject *args)
524 struct winbindd_request request;
525 struct winbindd_response response;
529 if (!PyArg_ParseTuple(args, "s", &username))
532 ZERO_STRUCT(request);
533 ZERO_STRUCT(response);
535 fstrcpy(request.data.username, username);
537 if (winbindd_request(WINBINDD_GETPWNAM, &request, &response)
538 != NSS_STATUS_SUCCESS) {
539 PyErr_SetString(winbind_error, "lookup failed");
543 if (!py_from_winbind_passwd(&result, &response)) {
551 /* Get user info from uid */
553 static PyObject *py_getpwuid(PyObject *self, PyObject *args)
555 struct winbindd_request request;
556 struct winbindd_response response;
560 if (!PyArg_ParseTuple(args, "i", &uid))
563 ZERO_STRUCT(request);
564 ZERO_STRUCT(response);
566 request.data.uid = uid;
568 if (winbindd_request(WINBINDD_GETPWUID, &request, &response)
569 != NSS_STATUS_SUCCESS) {
570 PyErr_SetString(winbind_error, "lookup failed");
574 if (!py_from_winbind_passwd(&result, &response)) {
583 * Method dispatch table
586 static PyMethodDef winbind_methods[] = {
588 { "getpwnam", (PyCFunction)py_getpwnam, METH_VARARGS, "getpwnam(3)" },
589 { "getpwuid", (PyCFunction)py_getpwuid, METH_VARARGS, "getpwuid(3)" },
591 /* Name <-> SID conversion */
593 { "name_to_sid", (PyCFunction)py_name_to_sid, METH_VARARGS,
594 "name_to_sid(s) -> string\n"
596 "Return the SID for a name.\n"
600 ">>> winbind.name_to_sid('FOO/Administrator')\n"
601 "'S-1-5-21-406022937-1377575209-526660263-500' " },
603 { "sid_to_name", (PyCFunction)py_sid_to_name, METH_VARARGS,
604 "sid_to_name(s) -> string\n"
606 "Return the name for a SID.\n"
610 ">>> import winbind\n"
611 ">>> winbind.sid_to_name('S-1-5-21-406022937-1377575209-526660263-500')\n"
612 "'FOO/Administrator' " },
614 /* Enumerate users/groups */
616 { "enum_domain_users", (PyCFunction)py_enum_domain_users, METH_VARARGS,
617 "enum_domain_users() -> list of strings\n"
619 "Return a list of domain users.\n"
623 ">>> winbind.enum_domain_users()\n"
624 "['FOO/Administrator', 'FOO/anna', 'FOO/Anne Elk', 'FOO/build', \n"
625 "'FOO/foo', 'FOO/foo2', 'FOO/foo3', 'FOO/Guest', 'FOO/user1', \n"
626 "'FOO/whoops-ptang'] " },
628 { "enum_domain_groups", (PyCFunction)py_enum_domain_groups,
630 "enum_domain_groups() -> list of strings\n"
632 "Return a list of domain groups.\n"
636 ">>> winbind.enum_domain_groups()\n"
637 "['FOO/cows', 'FOO/Domain Admins', 'FOO/Domain Guests', \n"
638 "'FOO/Domain Users'] " },
642 { "uid_to_sid", (PyCFunction)py_uid_to_sid, METH_VARARGS,
643 "uid_to_sid(int) -> string\n"
645 "Return the SID for a UNIX uid.\n"
649 ">>> winbind.uid_to_sid(10000) \n"
650 "'S-1-5-21-406022937-1377575209-526660263-500' " },
652 { "gid_to_sid", (PyCFunction)py_gid_to_sid, METH_VARARGS,
653 "gid_to_sid(int) -> string\n"
655 "Return the UNIX gid for a SID.\n"
659 ">>> winbind.gid_to_sid(10001)\n"
660 "'S-1-5-21-406022937-1377575209-526660263-512' " },
662 { "sid_to_uid", (PyCFunction)py_sid_to_uid, METH_VARARGS,
663 "sid_to_uid(string) -> int\n"
665 "Return the UNIX uid for a SID.\n"
669 ">>> winbind.sid_to_uid('S-1-5-21-406022937-1377575209-526660263-500')\n"
672 { "sid_to_gid", (PyCFunction)py_sid_to_gid, METH_VARARGS,
673 "sid_to_gid(string) -> int\n"
675 "Return the UNIX gid corresponding to a SID.\n"
679 ">>> winbind.sid_to_gid('S-1-5-21-406022937-1377575209-526660263-512')\n"
684 { "check_secret", (PyCFunction)py_check_secret, METH_VARARGS,
685 "check_secret() -> int\n"
687 "Check the machine trust account password. The NT status is returned\n"
688 "with zero indicating success. " },
690 { "enum_trust_dom", (PyCFunction)py_enum_trust_dom, METH_VARARGS,
691 "enum_trust_dom() -> list of strings\n"
693 "Return a list of trusted domains. The domain the server is a member \n"
694 "of is not included.\n"
698 ">>> winbind.enum_trust_dom()\n"
699 "['NPSD-TEST2', 'SP2NDOM'] " },
701 /* PAM authorisation functions */
703 { "auth_plaintext", (PyCFunction)py_auth_plaintext, METH_VARARGS,
704 "auth_plaintext(s, s) -> int\n"
706 "Authenticate a username and password using plaintext authentication.\n"
707 "The NT status code is returned with zero indicating success." },
709 { "auth_crap", (PyCFunction)py_auth_crap, METH_VARARGS,
710 "auth_crap(s, s) -> int\n"
712 "Authenticate a username and password using the challenge/response\n"
713 "protocol. The NT status code is returned with zero indicating\n"
716 #if 0 /* Include when smbd_auth merged to HEAD */
718 { "auth_smbd", (PyCFunction)py_auth_crap, METH_VARARGS,
719 "auth_smbd(s, s) -> int\n"
721 "Authenticate a username and password using the challenge/response\n"
722 "protocol but using the domain secret to prove we are root. The NT \n"
723 "status code is returned with zero indicating success." },
730 static struct const_vals {
734 } module_const_vals[] = {
736 /* Well known RIDs */
738 { "DOMAIN_USER_RID_ADMIN", DOMAIN_USER_RID_ADMIN,
739 "Well-known RID for Administrator user" },
741 { "DOMAIN_USER_RID_GUEST", DOMAIN_USER_RID_GUEST,
742 "Well-known RID for Guest user" },
744 { "DOMAIN_GROUP_RID_ADMINS", DOMAIN_GROUP_RID_ADMINS,
745 "Well-known RID for Domain Admins group" },
747 { "DOMAIN_GROUP_RID_USERS", DOMAIN_GROUP_RID_USERS,
748 "Well-known RID for Domain Users group" },
750 { "DOMAIN_GROUP_RID_GUESTS", DOMAIN_GROUP_RID_GUESTS,
751 "Well-known RID for Domain Guests group" },
756 static void const_init(PyObject *dict)
758 struct const_vals *tmp;
761 for (tmp = module_const_vals; tmp->name; tmp++) {
762 obj = PyInt_FromLong(tmp->value);
763 PyDict_SetItemString(dict, tmp->name, obj);
769 * Module initialisation
772 static char winbind_module__doc__[] =
773 "A python extension to winbind client functions.";
775 void initwinbind(void)
777 PyObject *module, *dict;
779 /* Initialise module */
781 module = Py_InitModule3("winbind", winbind_methods,
782 winbind_module__doc__);
784 dict = PyModule_GetDict(module);
786 winbind_error = PyErr_NewException("winbind.error", NULL, NULL);
787 PyDict_SetItemString(dict, "error", winbind_error);
789 /* Do samba initialisation */
793 /* Initialise constants */
797 /* Insert configuration dictionary */
799 PyDict_SetItemString(dict, "config", py_config_dict());