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 /* Winbind uid/gid range */
264 if (lp_winbind_uid(&ulow, &uhi)) {
265 PyDict_SetItemString(result, "uid_low", PyInt_FromLong(ulow));
266 PyDict_SetItemString(result, "uid_high", PyInt_FromLong(uhi));
269 if (lp_winbind_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 fstrcpy(request.data.auth_crap.user, username);
432 generate_random_buffer(request.data.auth_crap.chal, 8, False);
435 SMBencrypt((uchar *)password, request.data.auth_crap.chal,
436 (uchar *)request.data.auth_crap.lm_resp);
437 request.data.auth_crap.lm_resp_len = 24;
441 SMBNTencrypt((uchar *)password, request.data.auth_crap.chal,
442 (uchar *)request.data.auth_crap.nt_resp);
443 request.data.auth_crap.nt_resp_len = 24;
446 if (winbindd_request(WINBINDD_PAM_AUTH_CRAP, &request, &response)
447 != NSS_STATUS_SUCCESS) {
448 PyErr_SetString(winbind_error, "lookup failed");
452 return PyInt_FromLong(response.data.auth.nt_status);
455 #if 0 /* Include when auth_smbd merged to HEAD */
457 /* Challenge/response authentication, with secret */
459 static PyObject *py_auth_smbd(PyObject *self, PyObject *args, PyObject *kw)
461 static char *kwlist[] =
462 {"username", "password", "use_lm_hash", "use_nt_hash", NULL };
463 struct winbindd_request request;
464 struct winbindd_response response;
465 char *username, *password;
466 int use_lm_hash = 1, use_nt_hash = 1;
468 if (!PyArg_ParseTupleAndKeywords(
469 args, kw, "ss|ii", kwlist, &username, &password,
470 &use_lm_hash, &use_nt_hash))
473 ZERO_STRUCT(request);
474 ZERO_STRUCT(response);
476 fstrcpy(request.data.smbd_auth_crap.user, username);
478 generate_random_buffer(request.data.smbd_auth_crap.chal, 8, False);
481 SMBencrypt((uchar *)password,
482 request.data.smbd_auth_crap.chal,
483 (uchar *)request.data.smbd_auth_crap.lm_resp);
484 request.data.smbd_auth_crap.lm_resp_len = 24;
488 SMBNTencrypt((uchar *)password,
489 request.data.smbd_auth_crap.chal,
490 (uchar *)request.data.smbd_auth_crap.nt_resp);
491 request.data.smbd_auth_crap.nt_resp_len = 24;
494 if (!secrets_fetch_trust_account_password(
495 lp_workgroup(), request.data.smbd_auth_crap.proof, NULL)) {
497 winbind_error, "unable to fetch domain secret");
503 if (winbindd_request(WINBINDD_SMBD_AUTH_CRAP, &request, &response)
504 != NSS_STATUS_SUCCESS) {
505 PyErr_SetString(winbind_error, "lookup failed");
509 return PyInt_FromLong(response.data.auth.nt_status);
514 /* Get user info from name */
516 static PyObject *py_getpwnam(PyObject *self, PyObject *args)
518 struct winbindd_request request;
519 struct winbindd_response response;
523 if (!PyArg_ParseTuple(args, "s", &username))
526 ZERO_STRUCT(request);
527 ZERO_STRUCT(response);
529 fstrcpy(request.data.username, username);
531 if (winbindd_request(WINBINDD_GETPWNAM, &request, &response)
532 != NSS_STATUS_SUCCESS) {
533 PyErr_SetString(winbind_error, "lookup failed");
537 if (!py_from_winbind_passwd(&result, &response)) {
545 /* Get user info from uid */
547 static PyObject *py_getpwuid(PyObject *self, PyObject *args)
549 struct winbindd_request request;
550 struct winbindd_response response;
554 if (!PyArg_ParseTuple(args, "i", &uid))
557 ZERO_STRUCT(request);
558 ZERO_STRUCT(response);
560 request.data.uid = uid;
562 if (winbindd_request(WINBINDD_GETPWUID, &request, &response)
563 != NSS_STATUS_SUCCESS) {
564 PyErr_SetString(winbind_error, "lookup failed");
568 if (!py_from_winbind_passwd(&result, &response)) {
577 * Method dispatch table
580 static PyMethodDef winbind_methods[] = {
582 { "getpwnam", (PyCFunction)py_getpwnam, METH_VARARGS, "getpwnam(3)" },
583 { "getpwuid", (PyCFunction)py_getpwuid, METH_VARARGS, "getpwuid(3)" },
585 /* Name <-> SID conversion */
587 { "name_to_sid", (PyCFunction)py_name_to_sid, METH_VARARGS,
588 "name_to_sid(s) -> string
590 Return the SID for a name.
594 >>> winbind.name_to_sid('FOO/Administrator')
595 'S-1-5-21-406022937-1377575209-526660263-500' " },
597 { "sid_to_name", (PyCFunction)py_sid_to_name, METH_VARARGS,
598 "sid_to_name(s) -> string
600 Return the name for a SID.
605 >>> winbind.sid_to_name('S-1-5-21-406022937-1377575209-526660263-500')
606 'FOO/Administrator' " },
608 /* Enumerate users/groups */
610 { "enum_domain_users", (PyCFunction)py_enum_domain_users, METH_VARARGS,
611 "enum_domain_users() -> list of strings
613 Return a list of domain users.
617 >>> winbind.enum_domain_users()
618 ['FOO/Administrator', 'FOO/anna', 'FOO/Anne Elk', 'FOO/build',
619 'FOO/foo', 'FOO/foo2', 'FOO/foo3', 'FOO/Guest', 'FOO/user1',
620 'FOO/whoops-ptang'] " },
622 { "enum_domain_groups", (PyCFunction)py_enum_domain_groups,
624 "enum_domain_groups() -> list of strings
626 Return a list of domain groups.
630 >>> winbind.enum_domain_groups()
631 ['FOO/cows', 'FOO/Domain Admins', 'FOO/Domain Guests',
632 'FOO/Domain Users'] " },
636 { "uid_to_sid", (PyCFunction)py_uid_to_sid, METH_VARARGS,
637 "uid_to_sid(int) -> string
639 Return the SID for a UNIX uid.
643 >>> winbind.uid_to_sid(10000)
644 'S-1-5-21-406022937-1377575209-526660263-500' " },
646 { "gid_to_sid", (PyCFunction)py_gid_to_sid, METH_VARARGS,
647 "gid_to_sid(int) -> string
649 Return the UNIX gid for a SID.
653 >>> winbind.gid_to_sid(10001)
654 'S-1-5-21-406022937-1377575209-526660263-512' " },
656 { "sid_to_uid", (PyCFunction)py_sid_to_uid, METH_VARARGS,
657 "sid_to_uid(string) -> int
659 Return the UNIX uid for a SID.
663 >>> winbind.sid_to_uid('S-1-5-21-406022937-1377575209-526660263-500')
666 { "sid_to_gid", (PyCFunction)py_sid_to_gid, METH_VARARGS,
667 "sid_to_gid(string) -> int
669 Return the UNIX gid corresponding to a SID.
673 >>> winbind.sid_to_gid('S-1-5-21-406022937-1377575209-526660263-512')
678 { "check_secret", (PyCFunction)py_check_secret, METH_VARARGS,
679 "check_secret() -> int
681 Check the machine trust account password. The NT status is returned
682 with zero indicating success. " },
684 { "enum_trust_dom", (PyCFunction)py_enum_trust_dom, METH_VARARGS,
685 "enum_trust_dom() -> list of strings
687 Return a list of trusted domains. The domain the server is a member
692 >>> winbind.enum_trust_dom()
693 ['NPSD-TEST2', 'SP2NDOM'] " },
695 /* PAM authorisation functions */
697 { "auth_plaintext", (PyCFunction)py_auth_plaintext, METH_VARARGS,
698 "auth_plaintext(s, s) -> int
700 Authenticate a username and password using plaintext authentication.
701 The NT status code is returned with zero indicating success." },
703 { "auth_crap", (PyCFunction)py_auth_crap, METH_VARARGS,
704 "auth_crap(s, s) -> int
706 Authenticate a username and password using the challenge/response
707 protocol. The NT status code is returned with zero indicating
710 #if 0 /* Include when smbd_auth merged to HEAD */
712 { "auth_smbd", (PyCFunction)py_auth_crap, METH_VARARGS,
713 "auth_smbd(s, s) -> int
715 Authenticate a username and password using the challenge/response
716 protocol but using the domain secret to prove we are root. The NT
717 status code is returned with zero indicating success." },
724 static struct const_vals {
728 } module_const_vals[] = {
730 /* Well known RIDs */
732 { "DOMAIN_USER_RID_ADMIN", DOMAIN_USER_RID_ADMIN,
733 "Well-known RID for Administrator user" },
735 { "DOMAIN_USER_RID_GUEST", DOMAIN_USER_RID_GUEST,
736 "Well-known RID for Guest user" },
738 { "DOMAIN_GROUP_RID_ADMINS", DOMAIN_GROUP_RID_ADMINS,
739 "Well-known RID for Domain Admins group" },
741 { "DOMAIN_GROUP_RID_USERS", DOMAIN_GROUP_RID_USERS,
742 "Well-known RID for Domain Users group" },
744 { "DOMAIN_GROUP_RID_GUESTS", DOMAIN_GROUP_RID_GUESTS,
745 "Well-known RID for Domain Guests group" },
750 static void const_init(PyObject *dict)
752 struct const_vals *tmp;
755 for (tmp = module_const_vals; tmp->name; tmp++) {
756 obj = PyInt_FromLong(tmp->value);
757 PyDict_SetItemString(dict, tmp->name, obj);
763 * Module initialisation
766 static char winbind_module__doc__[] =
767 "A python extension to winbind client functions.";
769 void initwinbind(void)
771 PyObject *module, *dict;
773 /* Initialise module */
775 module = Py_InitModule3("winbind", winbind_methods,
776 winbind_module__doc__);
778 dict = PyModule_GetDict(module);
780 winbind_error = PyErr_NewException("winbind.error", NULL, NULL);
781 PyDict_SetItemString(dict, "error", winbind_error);
783 /* Do samba initialisation */
787 /* Initialise constants */
791 /* Insert configuration dictionary */
793 PyDict_SetItemString(dict, "config", py_config_dict());