cpython/Modules/nismodule.c
Eric Snow a9c6e0618f
gh-99113: Add Py_MOD_PER_INTERPRETER_GIL_SUPPORTED (gh-104205)
Here we are doing no more than adding the value for Py_mod_multiple_interpreters and using it for stdlib modules.  We will start checking for it in gh-104206 (once PyInterpreterState.ceval.own_gil is added in gh-104204).
2023-05-05 21:11:27 +00:00

537 lines
13 KiB
C

/***********************************************************
Written by:
Fred Gansevles <Fred.Gansevles@cs.utwente.nl>
B&O group,
Faculteit der Informatica,
Universiteit Twente,
Enschede,
the Netherlands.
******************************************************************/
/* NIS module implementation */
#include "Python.h"
#include <stdlib.h> // free()
#include <sys/time.h>
#include <sys/types.h>
#include <rpc/rpc.h>
#include <rpcsvc/yp_prot.h>
#include <rpcsvc/ypclnt.h>
#ifdef __sgi
/* This is missing from rpcsvc/ypclnt.h */
extern int yp_get_default_domain(char **);
#endif
PyDoc_STRVAR(get_default_domain__doc__,
"get_default_domain() -> str\n\
Corresponds to the C library yp_get_default_domain() call, returning\n\
the default NIS domain.\n");
PyDoc_STRVAR(match__doc__,
"match(key, map, domain = defaultdomain)\n\
Corresponds to the C library yp_match() call, returning the value of\n\
key in the given map. Optionally domain can be specified but it\n\
defaults to the system default domain.\n");
PyDoc_STRVAR(cat__doc__,
"cat(map, domain = defaultdomain)\n\
Returns the entire map as a dictionary. Optionally domain can be\n\
specified but it defaults to the system default domain.\n");
PyDoc_STRVAR(maps__doc__,
"maps(domain = defaultdomain)\n\
Returns an array of all available NIS maps within a domain. If domain\n\
is not specified it defaults to the system default domain.\n");
typedef struct {
PyObject *nis_error;
} nis_state;
static inline nis_state*
get_nis_state(PyObject *module)
{
void *state = PyModule_GetState(module);
assert(state != NULL);
return (nis_state *)state;
}
static int
nis_clear(PyObject *m)
{
Py_CLEAR(get_nis_state(m)->nis_error);
return 0;
}
static int
nis_traverse(PyObject *m, visitproc visit, void *arg)
{
Py_VISIT(get_nis_state(m)->nis_error);
return 0;
}
static void
nis_free(void *m)
{
nis_clear((PyObject *) m);
}
static PyObject *
nis_error(nis_state *state, int err)
{
PyErr_SetString(state->nis_error, yperr_string(err));
return NULL;
}
static struct nis_map {
char *alias;
char *map;
int fix;
} aliases [] = {
{"passwd", "passwd.byname", 0},
{"group", "group.byname", 0},
{"networks", "networks.byaddr", 0},
{"hosts", "hosts.byname", 0},
{"protocols", "protocols.bynumber", 0},
{"services", "services.byname", 0},
{"aliases", "mail.aliases", 1}, /* created with 'makedbm -a' */
{"ethers", "ethers.byname", 0},
{0L, 0L, 0}
};
static char *
nis_mapname(char *map, int *pfix)
{
int i;
*pfix = 0;
for (i=0; aliases[i].alias != 0L; i++) {
if (!strcmp (aliases[i].alias, map) || !strcmp (aliases[i].map, map)) {
*pfix = aliases[i].fix;
return aliases[i].map;
}
}
return map;
}
#if defined(__APPLE__) || defined(__OpenBSD__) || defined(__FreeBSD__)
typedef int (*foreachfunc)(unsigned long, char *, int, char *, int, void *);
#else
typedef int (*foreachfunc)(int, char *, int, char *, int, char *);
#endif
struct ypcallback_data {
PyObject *dict;
int fix;
PyThreadState *state;
};
static int
nis_foreach(int instatus, char *inkey, int inkeylen, char *inval,
int invallen, struct ypcallback_data *indata)
{
if (instatus == YP_TRUE) {
PyObject *key;
PyObject *val;
int err;
PyEval_RestoreThread(indata->state);
if (indata->fix) {
if (inkeylen > 0 && inkey[inkeylen-1] == '\0')
inkeylen--;
if (invallen > 0 && inval[invallen-1] == '\0')
invallen--;
}
key = PyUnicode_DecodeFSDefaultAndSize(inkey, inkeylen);
val = PyUnicode_DecodeFSDefaultAndSize(inval, invallen);
if (key == NULL || val == NULL) {
/* XXX error -- don't know how to handle */
PyErr_Clear();
Py_XDECREF(key);
Py_XDECREF(val);
indata->state = PyEval_SaveThread();
return 1;
}
err = PyDict_SetItem(indata->dict, key, val);
Py_DECREF(key);
Py_DECREF(val);
if (err != 0)
PyErr_Clear();
indata->state = PyEval_SaveThread();
if (err != 0)
return 1;
return 0;
}
return 1;
}
static PyObject *
nis_get_default_domain(PyObject *module, PyObject *Py_UNUSED(ignored))
{
char *domain;
int err;
PyObject *res;
nis_state *state = get_nis_state(module);
if ((err = yp_get_default_domain(&domain)) != 0) {
return nis_error(state, err);
}
res = PyUnicode_FromStringAndSize (domain, strlen(domain));
return res;
}
static PyObject *
nis_match(PyObject *module, PyObject *args, PyObject *kwdict)
{
char *match;
char *domain = NULL;
Py_ssize_t keylen;
int len;
char *key, *map;
int err;
PyObject *ukey, *bkey, *res;
int fix;
static char *kwlist[] = {"key", "map", "domain", NULL};
if (!PyArg_ParseTupleAndKeywords(args, kwdict,
"Us|s:match", kwlist,
&ukey, &map, &domain)) {
return NULL;
}
if ((bkey = PyUnicode_EncodeFSDefault(ukey)) == NULL) {
return NULL;
}
/* check for embedded null bytes */
if (PyBytes_AsStringAndSize(bkey, &key, &keylen) == -1) {
Py_DECREF(bkey);
return NULL;
}
nis_state *state = get_nis_state(module);
if (!domain && ((err = yp_get_default_domain(&domain)) != 0)) {
Py_DECREF(bkey);
return nis_error(state, err);
}
map = nis_mapname (map, &fix);
if (fix)
keylen++;
Py_BEGIN_ALLOW_THREADS
err = yp_match (domain, map, key, keylen, &match, &len);
Py_END_ALLOW_THREADS
Py_DECREF(bkey);
if (fix)
len--;
if (err != 0) {
return nis_error(state, err);
}
res = PyUnicode_DecodeFSDefaultAndSize(match, len);
free (match);
return res;
}
static PyObject *
nis_cat(PyObject *module, PyObject *args, PyObject *kwdict)
{
char *domain = NULL;
char *map;
struct ypall_callback cb;
struct ypcallback_data data;
PyObject *dict;
int err;
static char *kwlist[] = {"map", "domain", NULL};
if (!PyArg_ParseTupleAndKeywords(args, kwdict, "s|s:cat",
kwlist, &map, &domain)) {
return NULL;
}
nis_state *state = get_nis_state(module);
if (!domain && ((err = yp_get_default_domain(&domain)) != 0)) {
return nis_error(state, err);
}
dict = PyDict_New ();
if (dict == NULL)
return NULL;
cb.foreach = (foreachfunc)nis_foreach;
data.dict = dict;
map = nis_mapname (map, &data.fix);
cb.data = (char *)&data;
data.state = PyEval_SaveThread();
err = yp_all (domain, map, &cb);
PyEval_RestoreThread(data.state);
if (err != 0) {
Py_DECREF(dict);
return nis_error(state, err);
}
return dict;
}
/* These should be u_long on Sun h/w but not on 64-bit h/w.
This is not portable to machines with 16-bit ints and no prototypes */
#ifndef YPPROC_MAPLIST
#define YPPROC_MAPLIST 11
#endif
#ifndef YPPROG
#define YPPROG 100004
#endif
#ifndef YPVERS
#define YPVERS 2
#endif
typedef char *domainname;
typedef char *mapname;
enum nisstat {
NIS_TRUE = 1,
NIS_NOMORE = 2,
NIS_FALSE = 0,
NIS_NOMAP = -1,
NIS_NODOM = -2,
NIS_NOKEY = -3,
NIS_BADOP = -4,
NIS_BADDB = -5,
NIS_YPERR = -6,
NIS_BADARGS = -7,
NIS_VERS = -8
};
typedef enum nisstat nisstat;
struct nismaplist {
mapname map;
struct nismaplist *next;
};
typedef struct nismaplist nismaplist;
struct nisresp_maplist {
nisstat stat;
nismaplist *maps;
};
typedef struct nisresp_maplist nisresp_maplist;
static struct timeval TIMEOUT = { 25, 0 };
static
bool_t
nis_xdr_domainname(XDR *xdrs, domainname *objp)
{
if (!xdr_string(xdrs, objp, YPMAXDOMAIN)) {
return (FALSE);
}
return (TRUE);
}
static
bool_t
nis_xdr_mapname(XDR *xdrs, mapname *objp)
{
if (!xdr_string(xdrs, objp, YPMAXMAP)) {
return (FALSE);
}
return (TRUE);
}
static
bool_t
nis_xdr_ypmaplist(XDR *xdrs, nismaplist *objp)
{
if (!nis_xdr_mapname(xdrs, &objp->map)) {
return (FALSE);
}
if (!xdr_pointer(xdrs, (char **)&objp->next,
sizeof(nismaplist), (xdrproc_t)nis_xdr_ypmaplist))
{
return (FALSE);
}
return (TRUE);
}
static
bool_t
nis_xdr_ypstat(XDR *xdrs, nisstat *objp)
{
if (!xdr_enum(xdrs, (enum_t *)objp)) {
return (FALSE);
}
return (TRUE);
}
static
bool_t
nis_xdr_ypresp_maplist(XDR *xdrs, nisresp_maplist *objp)
{
if (!nis_xdr_ypstat(xdrs, &objp->stat)) {
return (FALSE);
}
if (!xdr_pointer(xdrs, (char **)&objp->maps,
sizeof(nismaplist), (xdrproc_t)nis_xdr_ypmaplist))
{
return (FALSE);
}
return (TRUE);
}
static
nisresp_maplist *
nisproc_maplist_2(domainname *argp, CLIENT *clnt)
{
static nisresp_maplist res;
memset(&res, 0, sizeof(res));
if (clnt_call(clnt, YPPROC_MAPLIST,
(xdrproc_t)nis_xdr_domainname, (caddr_t)argp,
(xdrproc_t)nis_xdr_ypresp_maplist, (caddr_t)&res,
TIMEOUT) != RPC_SUCCESS)
{
return (NULL);
}
return (&res);
}
static
nismaplist *
nis_maplist(nis_state *state, char *dom)
{
nisresp_maplist *list;
CLIENT *cl;
char *server = NULL;
int mapi = 0;
while (!server && aliases[mapi].map != 0L) {
yp_master (dom, aliases[mapi].map, &server);
mapi++;
}
if (!server) {
PyErr_SetString(state->nis_error, "No NIS master found for any map");
return NULL;
}
cl = clnt_create(server, YPPROG, YPVERS, "tcp");
if (cl == NULL) {
PyErr_SetString(state->nis_error, clnt_spcreateerror(server));
goto finally;
}
list = nisproc_maplist_2 (&dom, cl);
clnt_destroy(cl);
if (list == NULL)
goto finally;
if (list->stat != NIS_TRUE)
goto finally;
free(server);
return list->maps;
finally:
free(server);
return NULL;
}
static PyObject *
nis_maps (PyObject *module, PyObject *args, PyObject *kwdict)
{
char *domain = NULL;
nismaplist *maps;
PyObject *list;
int err;
static char *kwlist[] = {"domain", NULL};
if (!PyArg_ParseTupleAndKeywords(args, kwdict,
"|s:maps", kwlist, &domain)) {
return NULL;
}
nis_state *state = get_nis_state(module);
if (!domain && ((err = yp_get_default_domain (&domain)) != 0)) {
nis_error(state, err);
return NULL;
}
if ((maps = nis_maplist(state, domain)) == NULL) {
return NULL;
}
if ((list = PyList_New(0)) == NULL) {
return NULL;
}
for (; maps; maps = maps->next) {
PyObject *str = PyUnicode_FromString(maps->map);
if (!str || PyList_Append(list, str) < 0)
{
Py_XDECREF(str);
Py_SETREF(list, NULL);
break;
}
Py_DECREF(str);
}
/* XXX Shouldn't we free the list of maps now? */
return list;
}
static PyMethodDef nis_methods[] = {
{"match", _PyCFunction_CAST(nis_match),
METH_VARARGS | METH_KEYWORDS,
match__doc__},
{"cat", _PyCFunction_CAST(nis_cat),
METH_VARARGS | METH_KEYWORDS,
cat__doc__},
{"maps", _PyCFunction_CAST(nis_maps),
METH_VARARGS | METH_KEYWORDS,
maps__doc__},
{"get_default_domain", nis_get_default_domain,
METH_NOARGS,
get_default_domain__doc__},
{NULL, NULL} /* Sentinel */
};
static int
nis_exec(PyObject *module)
{
nis_state* state = get_nis_state(module);
state->nis_error = PyErr_NewException("nis.error", NULL, NULL);
if (state->nis_error == NULL) {
return -1;
}
Py_INCREF(state->nis_error);
if (PyModule_AddObject(module, "error", state->nis_error) < 0) {
Py_DECREF(state->nis_error);
return -1;
}
return 0;
}
static PyModuleDef_Slot nis_slots[] = {
{Py_mod_exec, nis_exec},
// XXX gh-103092: fix isolation.
{Py_mod_multiple_interpreters, Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED},
//{Py_mod_multiple_interpreters, Py_MOD_PER_INTERPRETER_GIL_SUPPORTED},
{0, NULL}
};
PyDoc_STRVAR(nis__doc__,
"This module contains functions for accessing NIS maps.\n");
static struct PyModuleDef nismodule = {
PyModuleDef_HEAD_INIT,
.m_name = "nis",
.m_doc = nis__doc__,
.m_size = sizeof(nis_state),
.m_methods = nis_methods,
.m_traverse = nis_traverse,
.m_clear = nis_clear,
.m_free = nis_free,
.m_slots = nis_slots,
};
PyMODINIT_FUNC
PyInit_nis(void)
{
if (PyErr_WarnEx(PyExc_DeprecationWarning,
"'nis' is deprecated and slated for removal in "
"Python 3.13",
7)) {
return NULL;
}
return PyModuleDef_Init(&nismodule);
}