blob: 9e01f4875768fd957e7045a8d2c895875b1d8c76 [file] [log] [blame]
Guido van Rossum864407d1991-04-10 19:48:25 +00001
Guido van Rossumb6775db1994-08-01 11:34:53 +00002/* UNIX password file access module */
Guido van Rossum864407d1991-04-10 19:48:25 +00003
Barry Warsaw50c5cf11996-12-11 16:54:40 +00004#include "Python.h"
Martin v. Löwisdbd55b32002-03-01 10:38:44 +00005#include "structseq.h"
Guido van Rossum864407d1991-04-10 19:48:25 +00006
7#include <sys/types.h>
8#include <pwd.h>
Guido van Rossum864407d1991-04-10 19:48:25 +00009
Martin v. Löwisdbd55b32002-03-01 10:38:44 +000010static PyStructSequence_Field struct_pwd_type_fields[] = {
11 {"pw_name", "user name"},
12 {"pw_passwd", "password"},
13 {"pw_uid", "user id"},
14 {"pw_gid", "group id"},
15 {"pw_gecos", "real name"},
16 {"pw_dir", "home directory"},
17 {"pw_shell", "shell program"},
18 {0}
19};
20
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000021PyDoc_STRVAR(struct_passwd__doc__,
Martin v. Löwisdbd55b32002-03-01 10:38:44 +000022"pwd.struct_passwd: Results from getpw*() routines.\n\n\
23This object may be accessed either as a tuple of\n\
24 (pw_name,pw_passwd,pw_uid,pw_gid,pw_gecos,pw_dir,pw_shell)\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000025or via the object attributes as named in the above tuple.");
Martin v. Löwisdbd55b32002-03-01 10:38:44 +000026
27static PyStructSequence_Desc struct_pwd_type_desc = {
28 "pwd.struct_passwd",
29 struct_passwd__doc__,
30 struct_pwd_type_fields,
31 7,
32};
33
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000034PyDoc_STRVAR(pwd__doc__,
35"This module provides access to the Unix password database.\n\
Guido van Rossum3e79c441998-03-03 22:03:26 +000036It is available on all Unix versions.\n\
37\n\
38Password database entries are reported as 7-tuples containing the following\n\
39items from the password database (see `<pwd.h>'), in order:\n\
40pw_name, pw_passwd, pw_uid, pw_gid, pw_gecos, pw_dir, pw_shell.\n\
41The uid and gid items are integers, all others are strings. An\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000042exception is raised if the entry asked for cannot be found.");
Guido van Rossum3e79c441998-03-03 22:03:26 +000043
44
Martin v. Löwis19ab6c92006-04-16 18:55:50 +000045static int initialized;
Martin v. Löwisdbd55b32002-03-01 10:38:44 +000046static PyTypeObject StructPwdType;
47
Martin v. Löwis29275c92002-09-17 09:34:06 +000048static void
49sets(PyObject *v, int i, char* val)
50{
51 if (val)
52 PyStructSequence_SET_ITEM(v, i, PyString_FromString(val));
53 else {
54 PyStructSequence_SET_ITEM(v, i, Py_None);
55 Py_INCREF(Py_None);
56 }
57}
58
Barry Warsaw50c5cf11996-12-11 16:54:40 +000059static PyObject *
Peter Schneider-Kamp39e0e5a2000-07-10 13:12:27 +000060mkpwent(struct passwd *p)
Guido van Rossum864407d1991-04-10 19:48:25 +000061{
Martin v. Löwisdbd55b32002-03-01 10:38:44 +000062 int setIndex = 0;
63 PyObject *v = PyStructSequence_New(&StructPwdType);
64 if (v == NULL)
65 return NULL;
66
67#define SETI(i,val) PyStructSequence_SET_ITEM(v, i, PyInt_FromLong((long) val))
Martin v. Löwis29275c92002-09-17 09:34:06 +000068#define SETS(i,val) sets(v, i, val)
Martin v. Löwisdbd55b32002-03-01 10:38:44 +000069
70 SETS(setIndex++, p->pw_name);
Martin v. Löwis79acb9e2002-12-06 12:48:53 +000071#ifdef __VMS
72 SETS(setIndex++, "");
73#else
Martin v. Löwisdbd55b32002-03-01 10:38:44 +000074 SETS(setIndex++, p->pw_passwd);
Martin v. Löwis79acb9e2002-12-06 12:48:53 +000075#endif
Martin v. Löwisdbd55b32002-03-01 10:38:44 +000076 SETI(setIndex++, p->pw_uid);
77 SETI(setIndex++, p->pw_gid);
Martin v. Löwis79acb9e2002-12-06 12:48:53 +000078#ifdef __VMS
79 SETS(setIndex++, "");
80#else
Martin v. Löwisdbd55b32002-03-01 10:38:44 +000081 SETS(setIndex++, p->pw_gecos);
Martin v. Löwis79acb9e2002-12-06 12:48:53 +000082#endif
Martin v. Löwisdbd55b32002-03-01 10:38:44 +000083 SETS(setIndex++, p->pw_dir);
84 SETS(setIndex++, p->pw_shell);
85
86#undef SETS
87#undef SETI
88
89 if (PyErr_Occurred()) {
90 Py_XDECREF(v);
91 return NULL;
92 }
93
94 return v;
Guido van Rossum864407d1991-04-10 19:48:25 +000095}
96
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000097PyDoc_STRVAR(pwd_getpwuid__doc__,
98"getpwuid(uid) -> (pw_name,pw_passwd,pw_uid,\n\
99 pw_gid,pw_gecos,pw_dir,pw_shell)\n\
Guido van Rossum3e79c441998-03-03 22:03:26 +0000100Return the password database entry for the given numeric user ID.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000101See pwd.__doc__ for more on password database entries.");
Guido van Rossum3e79c441998-03-03 22:03:26 +0000102
Barry Warsaw50c5cf11996-12-11 16:54:40 +0000103static PyObject *
Peter Schneider-Kamp39e0e5a2000-07-10 13:12:27 +0000104pwd_getpwuid(PyObject *self, PyObject *args)
Guido van Rossum864407d1991-04-10 19:48:25 +0000105{
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000106 unsigned int uid;
Guido van Rossum864407d1991-04-10 19:48:25 +0000107 struct passwd *p;
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000108 if (!PyArg_ParseTuple(args, "I:getpwuid", &uid))
Guido van Rossum864407d1991-04-10 19:48:25 +0000109 return NULL;
110 if ((p = getpwuid(uid)) == NULL) {
Barry Warsawe1b1c872004-01-20 21:07:23 +0000111 PyErr_Format(PyExc_KeyError,
112 "getpwuid(): uid not found: %d", uid);
Guido van Rossum864407d1991-04-10 19:48:25 +0000113 return NULL;
114 }
115 return mkpwent(p);
116}
117
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000118PyDoc_STRVAR(pwd_getpwnam__doc__,
119"getpwnam(name) -> (pw_name,pw_passwd,pw_uid,\n\
120 pw_gid,pw_gecos,pw_dir,pw_shell)\n\
Guido van Rossum3e79c441998-03-03 22:03:26 +0000121Return the password database entry for the given user name.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000122See pwd.__doc__ for more on password database entries.");
Guido van Rossum3e79c441998-03-03 22:03:26 +0000123
Barry Warsaw50c5cf11996-12-11 16:54:40 +0000124static PyObject *
Peter Schneider-Kamp39e0e5a2000-07-10 13:12:27 +0000125pwd_getpwnam(PyObject *self, PyObject *args)
Guido van Rossum864407d1991-04-10 19:48:25 +0000126{
Guido van Rossumef0a00e1992-01-27 16:51:30 +0000127 char *name;
Guido van Rossum864407d1991-04-10 19:48:25 +0000128 struct passwd *p;
Neal Norwitzba3a16c2002-03-31 15:27:00 +0000129 if (!PyArg_ParseTuple(args, "s:getpwnam", &name))
Guido van Rossum864407d1991-04-10 19:48:25 +0000130 return NULL;
Guido van Rossumef0a00e1992-01-27 16:51:30 +0000131 if ((p = getpwnam(name)) == NULL) {
Barry Warsawe1b1c872004-01-20 21:07:23 +0000132 PyErr_Format(PyExc_KeyError,
133 "getpwnam(): name not found: %s", name);
Guido van Rossum864407d1991-04-10 19:48:25 +0000134 return NULL;
135 }
136 return mkpwent(p);
137}
138
Guido van Rossum1171ee61997-08-22 20:42:00 +0000139#ifdef HAVE_GETPWENT
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000140PyDoc_STRVAR(pwd_getpwall__doc__,
141"getpwall() -> list_of_entries\n\
Guido van Rossum3e79c441998-03-03 22:03:26 +0000142Return a list of all available password database entries, \
143in arbitrary order.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000144See pwd.__doc__ for more on password database entries.");
Guido van Rossum3e79c441998-03-03 22:03:26 +0000145
Barry Warsaw50c5cf11996-12-11 16:54:40 +0000146static PyObject *
Neal Norwitz3a6f9782002-03-25 20:46:46 +0000147pwd_getpwall(PyObject *self)
Guido van Rossum864407d1991-04-10 19:48:25 +0000148{
Barry Warsaw50c5cf11996-12-11 16:54:40 +0000149 PyObject *d;
Guido van Rossum864407d1991-04-10 19:48:25 +0000150 struct passwd *p;
Barry Warsaw50c5cf11996-12-11 16:54:40 +0000151 if ((d = PyList_New(0)) == NULL)
Guido van Rossum864407d1991-04-10 19:48:25 +0000152 return NULL;
Andrew MacIntyre7bf68332002-03-03 02:59:16 +0000153#if defined(PYOS_OS2) && defined(PYCC_GCC)
154 if ((p = getpwuid(0)) != NULL) {
155#else
Guido van Rossum864407d1991-04-10 19:48:25 +0000156 setpwent();
157 while ((p = getpwent()) != NULL) {
Andrew MacIntyre7bf68332002-03-03 02:59:16 +0000158#endif
Barry Warsaw50c5cf11996-12-11 16:54:40 +0000159 PyObject *v = mkpwent(p);
160 if (v == NULL || PyList_Append(d, v) != 0) {
161 Py_XDECREF(v);
162 Py_DECREF(d);
Guido van Rossum864407d1991-04-10 19:48:25 +0000163 return NULL;
164 }
Barry Warsaw4bc9d391997-01-09 22:22:05 +0000165 Py_DECREF(v);
Guido van Rossum864407d1991-04-10 19:48:25 +0000166 }
Fred Drake8e68eb62001-03-11 03:03:07 +0000167 endpwent();
Guido van Rossum864407d1991-04-10 19:48:25 +0000168 return d;
169}
Guido van Rossum1171ee61997-08-22 20:42:00 +0000170#endif
Guido van Rossum864407d1991-04-10 19:48:25 +0000171
Barry Warsaw50c5cf11996-12-11 16:54:40 +0000172static PyMethodDef pwd_methods[] = {
Neal Norwitzba3a16c2002-03-31 15:27:00 +0000173 {"getpwuid", pwd_getpwuid, METH_VARARGS, pwd_getpwuid__doc__},
174 {"getpwnam", pwd_getpwnam, METH_VARARGS, pwd_getpwnam__doc__},
Guido van Rossum1171ee61997-08-22 20:42:00 +0000175#ifdef HAVE_GETPWENT
Neil Schemenauercc07ec12002-03-29 19:58:25 +0000176 {"getpwall", (PyCFunction)pwd_getpwall,
177 METH_NOARGS, pwd_getpwall__doc__},
Guido van Rossum1171ee61997-08-22 20:42:00 +0000178#endif
Guido van Rossum864407d1991-04-10 19:48:25 +0000179 {NULL, NULL} /* sentinel */
180};
181
Mark Hammondfe51c6d2002-08-02 02:27:13 +0000182PyMODINIT_FUNC
Thomas Woutersf3f33dc2000-07-21 06:00:07 +0000183initpwd(void)
Guido van Rossum864407d1991-04-10 19:48:25 +0000184{
Neal Norwitz726e0132002-04-15 16:29:00 +0000185 PyObject *m;
Fred Drake88c93442002-04-13 21:07:45 +0000186 m = Py_InitModule3("pwd", pwd_methods, pwd__doc__);
Neal Norwitz1ac754f2006-01-19 06:09:39 +0000187 if (m == NULL)
188 return;
Fred Drake88c93442002-04-13 21:07:45 +0000189
Martin v. Löwis19ab6c92006-04-16 18:55:50 +0000190 if (!initialized)
191 PyStructSequence_InitType(&StructPwdType,
192 &struct_pwd_type_desc);
Fred Drake88c93442002-04-13 21:07:45 +0000193 Py_INCREF((PyObject *) &StructPwdType);
Guido van Rossum16b9fa82003-10-23 23:54:57 +0000194 PyModule_AddObject(m, "struct_passwd", (PyObject *) &StructPwdType);
195 /* And for b/w compatibility (this was defined by mistake): */
Fred Drake88c93442002-04-13 21:07:45 +0000196 PyModule_AddObject(m, "struct_pwent", (PyObject *) &StructPwdType);
Martin v. Löwis19ab6c92006-04-16 18:55:50 +0000197 initialized = 1;
Guido van Rossum864407d1991-04-10 19:48:25 +0000198}