]> git.k1024.org Git - pylibacl.git/blob - acl.c
Unify attribute deletion checks for Entry
[pylibacl.git] / acl.c
1 /*
2     posix1e - a python module exposing the posix acl functions
3
4     Copyright (C) 2002-2009, 2012, 2014, 2015 Iustin Pop <iustin@k1024.org>
5
6     This library is free software; you can redistribute it and/or
7     modify it under the terms of the GNU Lesser General Public
8     License as published by the Free Software Foundation; either
9     version 2.1 of the License, or (at your option) any later version.
10
11     This library is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14     Lesser General Public License for more details.
15
16     You should have received a copy of the GNU Lesser General Public
17     License along with this library; if not, write to the Free Software
18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19     02110-1301  USA
20
21 */
22
23 #include <Python.h>
24
25 #include <sys/types.h>
26 #include <sys/acl.h>
27
28 #ifdef HAVE_LINUX
29 #include <acl/libacl.h>
30 #define get_perm acl_get_perm
31 #elif HAVE_FREEBSD
32 #define get_perm acl_get_perm_np
33 #endif
34
35 /* Used for cpychecker: */
36 /* The checker automatically defines this preprocessor name when creating
37    the custom attribute: */
38 #if defined(WITH_CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF_ATTRIBUTE)
39 #define CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF(typename) \
40   __attribute__((cpychecker_type_object_for_typedef(typename)))
41 #else
42 /* This handles the case where we're compiling with a "vanilla"
43    compiler that doesn't supply this attribute: */
44 #define CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF(typename)
45 #endif
46
47 /* The checker automatically defines this preprocessor name when creating
48    the custom attribute: */
49 #if defined(WITH_CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION_ATTRIBUTE)
50    #define CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION \
51 __attribute__((cpychecker_negative_result_sets_exception))
52    #else
53    #define CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
54 #endif
55
56 static PyTypeObject ACL_Type
57   CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF("ACL_Object");
58 static PyObject* ACL_applyto(PyObject* obj, PyObject* args);
59 static PyObject* ACL_valid(PyObject* obj, PyObject* args);
60
61 #ifdef HAVE_ACL_COPY_EXT
62 static PyObject* ACL_get_state(PyObject *obj, PyObject* args);
63 static PyObject* ACL_set_state(PyObject *obj, PyObject* args);
64 #endif
65
66 #ifdef HAVE_LEVEL2
67 static PyTypeObject Entry_Type
68   CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF("Entry_Object");
69 static PyTypeObject Permset_Type
70   CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF("Permset_Object");
71 static PyObject* Permset_new(PyTypeObject* type, PyObject* args,
72                              PyObject *keywds);
73 #endif
74
75 static acl_perm_t holder_ACL_EXECUTE = ACL_EXECUTE;
76 static acl_perm_t holder_ACL_READ = ACL_READ;
77 static acl_perm_t holder_ACL_WRITE = ACL_WRITE;
78
79 typedef struct {
80     PyObject_HEAD
81     acl_t acl;
82 #ifdef HAVE_LEVEL2
83     int entry_id;
84 #endif
85 } ACL_Object;
86
87 #ifdef HAVE_LEVEL2
88
89 typedef struct {
90     PyObject_HEAD
91     PyObject *parent_acl; /* The parent acl, so it won't run out on us */
92     acl_entry_t entry;
93 } Entry_Object;
94
95 typedef struct {
96     PyObject_HEAD
97     PyObject *parent_entry; /* The parent entry, so it won't run out on us */
98     acl_permset_t permset;
99 } Permset_Object;
100
101 #endif
102
103 /* Creation of a new ACL instance */
104 static PyObject* ACL_new(PyTypeObject* type, PyObject* args,
105                          PyObject *keywds) {
106     PyObject* newacl;
107
108     newacl = type->tp_alloc(type, 0);
109
110     if(newacl != NULL) {
111         ((ACL_Object*)newacl)->acl = NULL;
112 #ifdef HAVEL_LEVEL2
113         ((ACL_Object*)newacl)->entry_id = ACL_FIRST_ENTRY;
114 #endif
115     }
116
117     return newacl;
118 }
119
120 /* Initialization of a new ACL instance */
121 static int ACL_init(PyObject* obj, PyObject* args, PyObject *keywds) {
122     ACL_Object* self = (ACL_Object*) obj;
123 #ifdef HAVE_LINUX
124     static char *kwlist[] = { "file", "fd", "text", "acl", "filedef",
125                               "mode", NULL };
126     char *format = "|etisO!si";
127     int mode = -1;
128 #else
129     static char *kwlist[] = { "file", "fd", "text", "acl", "filedef", NULL };
130     char *format = "|etisO!s";
131 #endif
132     char *file = NULL;
133     char *filedef = NULL;
134     char *text = NULL;
135     int fd = -1;
136     ACL_Object* thesrc = NULL;
137
138     if(!PyTuple_Check(args) || PyTuple_Size(args) != 0 ||
139        (keywds != NULL && PyDict_Check(keywds) && PyDict_Size(keywds) > 1)) {
140         PyErr_SetString(PyExc_ValueError, "a max of one keyword argument"
141                         " must be passed");
142         return -1;
143     }
144     if(!PyArg_ParseTupleAndKeywords(args, keywds, format, kwlist,
145                                     NULL, &file, &fd, &text, &ACL_Type,
146                                     &thesrc, &filedef
147 #ifdef HAVE_LINUX
148                                     , &mode
149 #endif
150                                     ))
151         return -1;
152
153     /* Free the old acl_t without checking for error, we don't
154      * care right now */
155     if(self->acl != NULL)
156         acl_free(self->acl);
157
158     if(file != NULL)
159         self->acl = acl_get_file(file, ACL_TYPE_ACCESS);
160     else if(text != NULL)
161         self->acl = acl_from_text(text);
162     else if(fd != -1)
163         self->acl = acl_get_fd(fd);
164     else if(thesrc != NULL)
165         self->acl = acl_dup(thesrc->acl);
166     else if(filedef != NULL)
167         self->acl = acl_get_file(filedef, ACL_TYPE_DEFAULT);
168 #ifdef HAVE_LINUX
169     else if(mode != -1)
170         self->acl = acl_from_mode(mode);
171 #endif
172     else
173         self->acl = acl_init(0);
174
175     if(self->acl == NULL) {
176         PyErr_SetFromErrno(PyExc_IOError);
177         return -1;
178     }
179
180     return 0;
181 }
182
183 /* Standard type functions */
184 static void ACL_dealloc(PyObject* obj) {
185     ACL_Object *self = (ACL_Object*) obj;
186     PyObject *err_type, *err_value, *err_traceback;
187     int have_error = PyErr_Occurred() ? 1 : 0;
188
189     if (have_error)
190         PyErr_Fetch(&err_type, &err_value, &err_traceback);
191     if(self->acl != NULL && acl_free(self->acl) != 0)
192         PyErr_WriteUnraisable(obj);
193     if (have_error)
194         PyErr_Restore(err_type, err_value, err_traceback);
195     PyObject_DEL(self);
196 }
197
198 /* Converts the acl to a text format */
199 static PyObject* ACL_str(PyObject *obj) {
200     char *text;
201     ACL_Object *self = (ACL_Object*) obj;
202     PyObject *ret;
203
204     text = acl_to_text(self->acl, NULL);
205     if(text == NULL) {
206         return PyErr_SetFromErrno(PyExc_IOError);
207     }
208     ret = PyUnicode_FromString(text);
209     if(acl_free(text) != 0) {
210         Py_XDECREF(ret);
211         return PyErr_SetFromErrno(PyExc_IOError);
212     }
213     return ret;
214 }
215
216 #ifdef HAVE_LINUX
217 static char __to_any_text_doc__[] =
218   "to_any_text([prefix='', separator='n', options=0])\n"
219   "Convert the ACL to a custom text format.\n"
220   "\n"
221   "This method encapsulates the ``acl_to_any_text()`` function.\n"
222   "It allows a customized text format to be generated for the ACL. See\n"
223   ":manpage:`acl_to_any_text(3)` for more details.\n"
224   "\n"
225   ":param string prefix: if given, this string will be pre-pended to\n"
226   "   all lines\n"
227   ":param string separator: a single character (defaults to '\\n'); this will"
228     " be used to separate the entries in the ACL\n"
229   ":param options: a bitwise combination of:\n\n"
230   "    - :py:data:`TEXT_ABBREVIATE`: use 'u' instead of 'user', 'g' \n"
231   "      instead of 'group', etc.\n"
232   "    - :py:data:`TEXT_NUMERIC_IDS`: User and group IDs are included as\n"
233   "      decimal numbers instead of names\n"
234   "    - :py:data:`TEXT_SOME_EFFECTIVE`: Include comments denoting the\n"
235   "      effective permissions when some are masked\n"
236   "    - :py:data:`TEXT_ALL_EFFECTIVE`: Include comments after all ACL\n"
237   "      entries affected by an ACL_MASK entry\n"
238   "    - :py:data:`TEXT_SMART_INDENT`: Used in combination with the\n"
239   "      _EFFECTIVE options, this will ensure that comments are aligned\n"
240   "      to the fourth tab position (assuming one tab equals eight spaces)\n"
241   ":rtype: string\n"
242   ;
243
244 /* Converts the acl to a custom text format */
245 static PyObject* ACL_to_any_text(PyObject *obj, PyObject *args,
246                                  PyObject *kwds) {
247     char *text;
248     ACL_Object *self = (ACL_Object*) obj;
249     PyObject *ret;
250     const char *arg_prefix = NULL;
251     char arg_separator = '\n';
252     int arg_options = 0;
253     static char *kwlist[] = {"prefix", "separator", "options", NULL};
254
255     if (!PyArg_ParseTupleAndKeywords(args, kwds, "|sci", kwlist, &arg_prefix,
256                                      &arg_separator, &arg_options))
257       return NULL;
258
259     text = acl_to_any_text(self->acl, arg_prefix, arg_separator, arg_options);
260     if(text == NULL) {
261         return PyErr_SetFromErrno(PyExc_IOError);
262     }
263     ret = PyBytes_FromString(text);
264     if(acl_free(text) != 0) {
265         Py_XDECREF(ret);
266         return PyErr_SetFromErrno(PyExc_IOError);
267     }
268     return ret;
269 }
270
271 static char __check_doc__[] =
272     "Check the ACL validity.\n"
273     "\n"
274     "This is a non-portable, Linux specific extension that allow more\n"
275     "information to be retrieved in case an ACL is not valid than via the\n"
276     ":py:func:`valid` method.\n"
277     "\n"
278     "This method will return either False (the ACL is valid), or a tuple\n"
279     "with two elements. The first element is one of the following\n"
280     "constants:\n\n"
281     "  - :py:data:`ACL_MULTI_ERROR`: The ACL contains multiple entries that\n"
282     "    have a tag type that may occur at most once\n"
283     "  - :py:data:`ACL_DUPLICATE_ERROR`: The ACL contains multiple \n"
284     "    :py:data:`ACL_USER` or :py:data:`ACL_GROUP` entries with the\n"
285     "    same ID\n"
286     "  - :py:data:`ACL_MISS_ERROR`: A required entry is missing\n"
287     "  - :py:data:`ACL_ENTRY_ERROR`: The ACL contains an invalid entry\n"
288     "    tag type\n"
289     "\n"
290     "The second element of the tuple is the index of the entry that is\n"
291     "invalid (in the same order as by iterating over the ACL entry)\n"
292     ;
293
294 /* The acl_check method */
295 static PyObject* ACL_check(PyObject* obj, PyObject* args) {
296     ACL_Object *self = (ACL_Object*) obj;
297     int result;
298     int eindex;
299
300     if((result = acl_check(self->acl, &eindex)) == -1)
301         return PyErr_SetFromErrno(PyExc_IOError);
302     if(result == 0) {
303         Py_RETURN_FALSE;
304     }
305     return Py_BuildValue("(ii)", result, eindex);
306 }
307
308 /* Implementation of the rich compare for ACLs */
309 static PyObject* ACL_richcompare(PyObject* o1, PyObject* o2, int op) {
310     ACL_Object *acl1, *acl2;
311     int n;
312     PyObject *ret;
313
314     if(!PyObject_IsInstance(o2, (PyObject*)&ACL_Type)) {
315         if(op == Py_EQ)
316             Py_RETURN_FALSE;
317         if(op == Py_NE)
318             Py_RETURN_TRUE;
319         PyErr_SetString(PyExc_TypeError, "can only compare to an ACL");
320         return NULL;
321     }
322
323     acl1 = (ACL_Object*)o1;
324     acl2 = (ACL_Object*)o2;
325     if((n=acl_cmp(acl1->acl, acl2->acl))==-1)
326         return PyErr_SetFromErrno(PyExc_IOError);
327     switch(op) {
328     case Py_EQ:
329         ret = n == 0 ? Py_True : Py_False;
330         break;
331     case Py_NE:
332         ret = n == 1 ? Py_True : Py_False;
333         break;
334     default:
335         PyErr_SetString(PyExc_TypeError, "ACLs are not orderable");
336         return NULL;
337     }
338     Py_INCREF(ret);
339     return ret;
340 }
341
342 static char __equiv_mode_doc__[] =
343     "Return the octal mode the ACL is equivalent to.\n"
344     "\n"
345     "This is a non-portable, Linux specific extension that checks\n"
346     "if the ACL is a basic ACL and returns the corresponding mode.\n"
347     "\n"
348     ":rtype: integer\n"
349     ":raise IOError: An IOerror exception will be raised if the ACL is\n"
350     "    an extended ACL.\n"
351     ;
352
353 /* The acl_equiv_mode method */
354 static PyObject* ACL_equiv_mode(PyObject* obj, PyObject* args) {
355     ACL_Object *self = (ACL_Object*) obj;
356     mode_t mode;
357
358     if(acl_equiv_mode(self->acl, &mode) == -1)
359         return PyErr_SetFromErrno(PyExc_IOError);
360     return PyLong_FromLong(mode);
361 }
362 #endif
363
364 /* Custom methods */
365 static char __applyto_doc__[] =
366     "applyto(item[, flag=ACL_TYPE_ACCESS])\n"
367     "Apply the ACL to a file or filehandle.\n"
368     "\n"
369     ":param item: either a filename or a file-like object or an integer;\n"
370     "    this represents the filesystem object on which to act\n"
371     ":param flag: optional flag representing the type of ACL to set, either\n"
372     "    :py:data:`ACL_TYPE_ACCESS` (default) or :py:data:`ACL_TYPE_DEFAULT`\n"
373     ;
374
375 /* Applies the ACL to a file */
376 static PyObject* ACL_applyto(PyObject* obj, PyObject* args) {
377     ACL_Object *self = (ACL_Object*) obj;
378     PyObject *target, *tmp;
379     acl_type_t type = ACL_TYPE_ACCESS;
380     int nret;
381     int fd;
382
383     if (!PyArg_ParseTuple(args, "O|I", &target, &type))
384         return NULL;
385     if ((fd = PyObject_AsFileDescriptor(target)) != -1) {
386         if((nret = acl_set_fd(fd, self->acl)) == -1) {
387           PyErr_SetFromErrno(PyExc_IOError);
388         }
389     } else {
390       // PyObject_AsFileDescriptor sets an error when failing, so clear
391       // it such that further code works; some method lookups fail if an
392       // error already occured when called, which breaks at least
393       // PyOS_FSPath (called by FSConverter).
394       PyErr_Clear();
395       if(PyUnicode_FSConverter(target, &tmp)) {
396         char *filename = PyBytes_AS_STRING(tmp);
397         if ((nret = acl_set_file(filename, type, self->acl)) == -1) {
398             PyErr_SetFromErrnoWithFilename(PyExc_IOError, filename);
399         }
400         Py_DECREF(tmp);
401       } else {
402         nret = -1;
403       }
404     }
405     if (nret < 0) {
406         return NULL;
407     } else {
408         Py_INCREF(Py_None);
409         return Py_None;
410     }
411 }
412
413 static char __valid_doc__[] =
414     "Test the ACL for validity.\n"
415     "\n"
416     "This method tests the ACL to see if it is a valid ACL\n"
417     "in terms of the file-system. More precisely, it checks that:\n"
418     "\n"
419     "The ACL contains exactly one entry with each of the\n"
420     ":py:data:`ACL_USER_OBJ`, :py:data:`ACL_GROUP_OBJ`, and \n"
421     ":py:data:`ACL_OTHER` tag types. Entries\n"
422     "with :py:data:`ACL_USER` and :py:data:`ACL_GROUP` tag types may\n"
423     "appear zero or more\n"
424     "times in an ACL. An ACL that contains entries of :py:data:`ACL_USER` or\n"
425     ":py:data:`ACL_GROUP` tag types must contain exactly one entry of the \n"
426     ":py:data:`ACL_MASK` tag type. If an ACL contains no entries of\n"
427     ":py:data:`ACL_USER` or :py:data:`ACL_GROUP` tag types, the\n"
428     ":py:data:`ACL_MASK` entry is optional.\n"
429     "\n"
430     "All user ID qualifiers must be unique among all entries of\n"
431     "the :py:data:`ACL_USER` tag type, and all group IDs must be unique\n"
432     "among all entries of :py:data:`ACL_GROUP` tag type.\n"
433     "\n"
434     "The method will return 1 for a valid ACL and 0 for an invalid one.\n"
435     "This has been chosen because the specification for\n"
436     ":manpage:`acl_valid(3)`\n"
437     "in the POSIX.1e standard documents only one possible value for errno\n"
438     "in case of an invalid ACL, so we can't differentiate between\n"
439     "classes of errors. Other suggestions are welcome.\n"
440     "\n"
441     ":return: 0 or 1\n"
442     ":rtype: integer\n"
443     ;
444
445 /* Checks the ACL for validity */
446 static PyObject* ACL_valid(PyObject* obj, PyObject* args) {
447     ACL_Object *self = (ACL_Object*) obj;
448
449     if(acl_valid(self->acl) == -1) {
450         Py_RETURN_FALSE;
451     } else {
452         Py_RETURN_TRUE;
453     }
454 }
455
456 #ifdef HAVE_ACL_COPY_EXT
457 static PyObject* ACL_get_state(PyObject *obj, PyObject* args) {
458     ACL_Object *self = (ACL_Object*) obj;
459     PyObject *ret;
460     ssize_t size, nsize;
461     char *buf;
462
463     size = acl_size(self->acl);
464     if(size == -1)
465         return PyErr_SetFromErrno(PyExc_IOError);
466
467     if((ret = PyBytes_FromStringAndSize(NULL, size)) == NULL)
468         return NULL;
469     buf = PyBytes_AsString(ret);
470
471     if((nsize = acl_copy_ext(buf, self->acl, size)) == -1) {
472         Py_DECREF(ret);
473         return PyErr_SetFromErrno(PyExc_IOError);
474     }
475
476     return ret;
477 }
478
479 static PyObject* ACL_set_state(PyObject *obj, PyObject* args) {
480     ACL_Object *self = (ACL_Object*) obj;
481     const void *buf;
482     int bufsize;
483     acl_t ptr;
484
485     /* Parse the argument */
486     if (!PyArg_ParseTuple(args, "s#", &buf, &bufsize))
487         return NULL;
488
489     /* Try to import the external representation */
490     if((ptr = acl_copy_int(buf)) == NULL)
491         return PyErr_SetFromErrno(PyExc_IOError);
492
493     /* Free the old acl. Should we ignore errors here? */
494     if(self->acl != NULL) {
495         if(acl_free(self->acl) == -1)
496             return PyErr_SetFromErrno(PyExc_IOError);
497     }
498
499     self->acl = ptr;
500
501     /* Return the result */
502     Py_INCREF(Py_None);
503     return Py_None;
504 }
505 #endif
506
507 #ifdef HAVE_LEVEL2
508
509 /* tp_iter for the ACL type; since it can be iterated only
510  * destructively, the type is its iterator
511  */
512 static PyObject* ACL_iter(PyObject *obj) {
513     ACL_Object *self = (ACL_Object*)obj;
514     self->entry_id = ACL_FIRST_ENTRY;
515     Py_INCREF(obj);
516     return obj;
517 }
518
519 /* the tp_iternext function for the ACL type */
520 static PyObject* ACL_iternext(PyObject *obj) {
521     ACL_Object *self = (ACL_Object*)obj;
522     acl_entry_t the_entry_t;
523     Entry_Object *the_entry_obj;
524     int nerr;
525
526     nerr = acl_get_entry(self->acl, self->entry_id, &the_entry_t);
527     self->entry_id = ACL_NEXT_ENTRY;
528     if(nerr == -1)
529         return PyErr_SetFromErrno(PyExc_IOError);
530     else if(nerr == 0) {
531         /* Docs says this is not needed */
532         /*PyErr_SetObject(PyExc_StopIteration, Py_None);*/
533         return NULL;
534     }
535
536     the_entry_obj = (Entry_Object*) PyType_GenericNew(&Entry_Type, NULL, NULL);
537     if(the_entry_obj == NULL)
538         return NULL;
539
540     the_entry_obj->entry = the_entry_t;
541
542     the_entry_obj->parent_acl = obj;
543     Py_INCREF(obj); /* For the reference we have in entry->parent */
544
545     return (PyObject*)the_entry_obj;
546 }
547
548 static char __ACL_delete_entry_doc__[] =
549     "delete_entry(entry)\n"
550     "Deletes an entry from the ACL.\n"
551     "\n"
552     ".. note:: Only available with level 2.\n"
553     "\n"
554     ":param entry: the Entry object which should be deleted; note that after\n"
555     "    this function is called, that object is unusable any longer\n"
556     "    and should be deleted\n"
557     ;
558
559 /* Deletes an entry from the ACL */
560 static PyObject* ACL_delete_entry(PyObject *obj, PyObject *args) {
561     ACL_Object *self = (ACL_Object*)obj;
562     Entry_Object *e;
563
564     if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &e))
565         return NULL;
566
567     if(acl_delete_entry(self->acl, e->entry) == -1)
568         return PyErr_SetFromErrno(PyExc_IOError);
569
570     /* Return the result */
571     Py_INCREF(Py_None);
572     return Py_None;
573 }
574
575 static char __ACL_calc_mask_doc__[] =
576     "Compute the file group class mask.\n"
577     "\n"
578     "The calc_mask() method calculates and sets the permissions \n"
579     "associated with the :py:data:`ACL_MASK` Entry of the ACL.\n"
580     "The value of the new permissions is the union of the permissions \n"
581     "granted by all entries of tag type :py:data:`ACL_GROUP`, \n"
582     ":py:data:`ACL_GROUP_OBJ`, or \n"
583     ":py:data:`ACL_USER`. If the ACL already contains an :py:data:`ACL_MASK`\n"
584     "entry, its \n"
585     "permissions are overwritten; if it does not contain an \n"
586     ":py:data:`ACL_MASK` Entry, one is added.\n"
587     "\n"
588     "The order of existing entries in the ACL is undefined after this \n"
589     "function.\n"
590     ;
591
592 /* Updates the mask entry in the ACL */
593 static PyObject* ACL_calc_mask(PyObject *obj, PyObject *args) {
594     ACL_Object *self = (ACL_Object*)obj;
595
596     if(acl_calc_mask(&self->acl) == -1)
597         return PyErr_SetFromErrno(PyExc_IOError);
598
599     /* Return the result */
600     Py_INCREF(Py_None);
601     return Py_None;
602 }
603
604 static char __ACL_append_doc__[] =
605     "append([entry])\n"
606     "Append a new Entry to the ACL and return it.\n"
607     "\n"
608     "This is a convenience function to create a new Entry \n"
609     "and append it to the ACL.\n"
610     "If a parameter of type Entry instance is given, the \n"
611     "entry will be a copy of that one (as if copied with \n"
612     ":py:func:`Entry.copy`), otherwise, the new entry will be empty.\n"
613     "\n"
614     ":rtype: :py:class:`Entry`\n"
615     ":returns: the newly created entry\n"
616     ;
617
618 /* Convenience method to create a new Entry */
619 static PyObject* ACL_append(PyObject *obj, PyObject *args) {
620     ACL_Object* self = (ACL_Object*) obj;
621     Entry_Object* newentry;
622     Entry_Object* oldentry = NULL;
623     int nret;
624
625     newentry = (Entry_Object*)PyType_GenericNew(&Entry_Type, NULL, NULL);
626     if(newentry == NULL) {
627         return NULL;
628     }
629
630     if (!PyArg_ParseTuple(args, "|O!", &Entry_Type, &oldentry)) {
631         Py_DECREF(newentry);
632         return NULL;
633     }
634
635     nret = acl_create_entry(&self->acl, &newentry->entry);
636     if(nret == -1) {
637         Py_DECREF(newentry);
638         return PyErr_SetFromErrno(PyExc_IOError);
639     }
640
641     if(oldentry != NULL) {
642         nret = acl_copy_entry(newentry->entry, oldentry->entry);
643         if(nret == -1) {
644             Py_DECREF(newentry);
645             return PyErr_SetFromErrno(PyExc_IOError);
646         }
647     }
648
649     newentry->parent_acl = obj;
650     Py_INCREF(obj);
651
652     return (PyObject*)newentry;
653 }
654
655 /***** Entry type *****/
656
657 typedef struct {
658     acl_tag_t tag;
659     union {
660         uid_t uid;
661         gid_t gid;
662     };
663 } tag_qual;
664
665 /* Pre-declaring the function is more friendly to cpychecker, sigh. */
666 static int get_tag_qualifier(acl_entry_t entry, tag_qual *tq)
667   CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
668
669 /* Helper function to get the tag and qualifier of an Entry at the
670    same time. This is "needed" because the acl_get_qualifier function
671    returns a pointer to different types, based on the tag value, and
672    thus it's not straightforward to get the right type.
673
674    It sets a Python exception if an error occurs, and returns -1 in
675    this case. If successful, the tag is set to the tag type, the
676    qualifier (if any) to either the uid or the gid entry in the
677    tag_qual structure, and the return value is 0.
678 */
679 static int get_tag_qualifier(acl_entry_t entry, tag_qual *tq) {
680     void *p;
681
682     if(acl_get_tag_type(entry, &tq->tag) == -1) {
683         PyErr_SetFromErrno(PyExc_IOError);
684         return -1;
685     }
686     if (tq->tag == ACL_USER || tq->tag == ACL_GROUP) {
687         if((p = acl_get_qualifier(entry)) == NULL) {
688             PyErr_SetFromErrno(PyExc_IOError);
689             return -1;
690         }
691         if (tq->tag == ACL_USER) {
692             tq->uid = *(uid_t*)p;
693         } else {
694             tq->gid = *(gid_t*)p;
695         }
696         acl_free(p);
697     }
698     return 0;
699 }
700
701 #define ENTRY_SET_CHECK(self, attr, value)         \
702     if (value == NULL) { \
703         PyErr_SetString(PyExc_TypeError, \
704                         attr " deletion is not supported"); \
705         return -1; \
706     }
707
708 /* Creation of a new Entry instance */
709 static PyObject* Entry_new(PyTypeObject* type, PyObject* args,
710                            PyObject *keywds) {
711     PyObject* newentry;
712
713     newentry = PyType_GenericNew(type, args, keywds);
714
715     if(newentry != NULL) {
716         ((Entry_Object*)newentry)->entry = NULL;
717         ((Entry_Object*)newentry)->parent_acl = NULL;
718     }
719
720     return newentry;
721 }
722
723 /* Initialization of a new Entry instance */
724 static int Entry_init(PyObject* obj, PyObject* args, PyObject *keywds) {
725     Entry_Object* self = (Entry_Object*) obj;
726     ACL_Object* parent = NULL;
727
728     if (!PyArg_ParseTuple(args, "O!", &ACL_Type, &parent))
729         return -1;
730
731     if(acl_create_entry(&parent->acl, &self->entry) == -1) {
732         PyErr_SetFromErrno(PyExc_IOError);
733         return -1;
734     }
735
736     self->parent_acl = (PyObject*)parent;
737     Py_INCREF(parent);
738
739     return 0;
740 }
741
742 /* Free the Entry instance */
743 static void Entry_dealloc(PyObject* obj) {
744     Entry_Object *self = (Entry_Object*) obj;
745     PyObject *err_type, *err_value, *err_traceback;
746     int have_error = PyErr_Occurred() ? 1 : 0;
747
748     if (have_error)
749         PyErr_Fetch(&err_type, &err_value, &err_traceback);
750     if(self->parent_acl != NULL) {
751         Py_DECREF(self->parent_acl);
752         self->parent_acl = NULL;
753     }
754     if (have_error)
755         PyErr_Restore(err_type, err_value, err_traceback);
756     PyObject_DEL(self);
757 }
758
759 /* Converts the entry to a text format */
760 static PyObject* Entry_str(PyObject *obj) {
761     PyObject *format, *kind;
762     Entry_Object *self = (Entry_Object*) obj;
763     tag_qual tq;
764
765     if(get_tag_qualifier(self->entry, &tq) < 0) {
766         return NULL;
767     }
768
769     format = PyUnicode_FromString("ACL entry for ");
770     if(format == NULL)
771         return NULL;
772     switch(tq.tag) {
773     case ACL_UNDEFINED_TAG:
774         kind = PyUnicode_FromString("undefined type");
775         break;
776     case ACL_USER_OBJ:
777         kind = PyUnicode_FromString("the owner");
778         break;
779     case ACL_GROUP_OBJ:
780         kind = PyUnicode_FromString("the group");
781         break;
782     case ACL_OTHER:
783         kind = PyUnicode_FromString("the others");
784         break;
785     case ACL_USER:
786         /* FIXME: here and in the group case, we're formatting with
787            unsigned, because there's no way to automatically determine
788            the signed-ness of the types; on Linux(glibc) they're
789            unsigned, so we'll go along with that */
790         kind = PyUnicode_FromFormat("user with uid %u", tq.uid);
791         break;
792     case ACL_GROUP:
793         kind = PyUnicode_FromFormat("group with gid %u", tq.gid);
794         break;
795     case ACL_MASK:
796         kind = PyUnicode_FromString("the mask");
797         break;
798     default:
799         kind = PyUnicode_FromString("UNKNOWN_TAG_TYPE!");
800         break;
801     }
802     if (kind == NULL) {
803         Py_DECREF(format);
804         return NULL;
805     }
806     PyObject *ret = PyUnicode_Concat(format, kind);
807     Py_DECREF(format);
808     Py_DECREF(kind);
809     return ret;
810 }
811
812 /* Sets the tag type of the entry */
813 static int Entry_set_tag_type(PyObject* obj, PyObject* value, void* arg) {
814     Entry_Object *self = (Entry_Object*) obj;
815
816     ENTRY_SET_CHECK(self, "tag type", value);
817
818     if(!PyLong_Check(value)) {
819         PyErr_SetString(PyExc_TypeError,
820                         "tag type must be integer");
821         return -1;
822     }
823     if(acl_set_tag_type(self->entry, (acl_tag_t)PyLong_AsLong(value)) == -1) {
824         PyErr_SetFromErrno(PyExc_IOError);
825         return -1;
826     }
827
828     return 0;
829 }
830
831 /* Returns the tag type of the entry */
832 static PyObject* Entry_get_tag_type(PyObject *obj, void* arg) {
833     Entry_Object *self = (Entry_Object*) obj;
834     acl_tag_t value;
835
836     if (self->entry == NULL) {
837         PyErr_SetString(PyExc_AttributeError, "entry attribute");
838         return NULL;
839     }
840     if(acl_get_tag_type(self->entry, &value) == -1) {
841         PyErr_SetFromErrno(PyExc_IOError);
842         return NULL;
843     }
844
845     return PyLong_FromLong(value);
846 }
847
848 /* Sets the qualifier (either uid_t or gid_t) for the entry,
849  * usable only if the tag type if ACL_USER or ACL_GROUP
850  */
851 static int Entry_set_qualifier(PyObject* obj, PyObject* value, void* arg) {
852     Entry_Object *self = (Entry_Object*) obj;
853     long uidgid;
854     uid_t uid;
855     gid_t gid;
856     void *p;
857     acl_tag_t tag;
858
859     ENTRY_SET_CHECK(self, "qualifier", value);
860
861     if(!PyLong_Check(value)) {
862         PyErr_SetString(PyExc_TypeError,
863                         "qualifier must be integer");
864         return -1;
865     }
866     if((uidgid = PyLong_AsLong(value)) == -1) {
867         if(PyErr_Occurred() != NULL) {
868             return -1;
869         }
870     }
871     /* Due to how acl_set_qualifier takes its argument, we have to do
872        this ugly dance with two variables and a pointer that will
873        point to one of them. */
874     if(acl_get_tag_type(self->entry, &tag) == -1) {
875         PyErr_SetFromErrno(PyExc_IOError);
876         return -1;
877     }
878     uid = uidgid;
879     gid = uidgid;
880     switch(tag) {
881     case ACL_USER:
882       if((long)uid != uidgid) {
883         PyErr_SetString(PyExc_OverflowError, "cannot assign given qualifier");
884         return -1;
885       } else {
886         p = &uid;
887       }
888       break;
889     case ACL_GROUP:
890       if((long)gid != uidgid) {
891         PyErr_SetString(PyExc_OverflowError, "cannot assign given qualifier");
892         return -1;
893       } else {
894         p = &gid;
895       }
896       break;
897     default:
898       PyErr_SetString(PyExc_TypeError,
899                       "can only set qualifiers on ACL_USER or ACL_GROUP entries");
900       return -1;
901     }
902     if(acl_set_qualifier(self->entry, p) == -1) {
903         PyErr_SetFromErrno(PyExc_IOError);
904         return -1;
905     }
906
907     return 0;
908 }
909
910 /* Returns the qualifier of the entry */
911 static PyObject* Entry_get_qualifier(PyObject *obj, void* arg) {
912     Entry_Object *self = (Entry_Object*) obj;
913     long value;
914     tag_qual tq;
915
916     if (self->entry == NULL) {
917         PyErr_SetString(PyExc_AttributeError, "entry attribute");
918         return NULL;
919     }
920     if(get_tag_qualifier(self->entry, &tq) < 0) {
921         return NULL;
922     }
923     if (tq.tag == ACL_USER) {
924         value = tq.uid;
925     } else if (tq.tag == ACL_GROUP) {
926         value = tq.gid;
927     } else {
928         PyErr_SetString(PyExc_TypeError,
929                         "given entry doesn't have an user or"
930                         " group tag");
931         return NULL;
932     }
933     return PyLong_FromLong(value);
934 }
935
936 /* Returns the parent ACL of the entry */
937 static PyObject* Entry_get_parent(PyObject *obj, void* arg) {
938     Entry_Object *self = (Entry_Object*) obj;
939
940     Py_INCREF(self->parent_acl);
941     return self->parent_acl;
942 }
943
944 /* Returns the a new Permset representing the permset of the entry
945  * FIXME: Should return a new reference to the same object, which
946  * should be created at init time!
947  */
948 static PyObject* Entry_get_permset(PyObject *obj, void* arg) {
949     Entry_Object *self = (Entry_Object*)obj;
950     PyObject *p;
951     Permset_Object *ps;
952
953     p = Permset_new(&Permset_Type, NULL, NULL);
954     if(p == NULL)
955         return NULL;
956     ps = (Permset_Object*)p;
957     if(acl_get_permset(self->entry, &ps->permset) == -1) {
958         PyErr_SetFromErrno(PyExc_IOError);
959         Py_DECREF(p);
960         return NULL;
961     }
962     ps->parent_entry = obj;
963     Py_INCREF(obj);
964
965     return (PyObject*)p;
966 }
967
968 /* Sets the permset of the entry to the passed Permset */
969 static int Entry_set_permset(PyObject* obj, PyObject* value, void* arg) {
970     Entry_Object *self = (Entry_Object*)obj;
971     Permset_Object *p;
972
973     ENTRY_SET_CHECK(self, "permset", value);
974
975     if(!PyObject_IsInstance(value, (PyObject*)&Permset_Type)) {
976         PyErr_SetString(PyExc_TypeError, "argument 1 must be posix1e.Permset");
977         return -1;
978     }
979     p = (Permset_Object*)value;
980     if(acl_set_permset(self->entry, p->permset) == -1) {
981         PyErr_SetFromErrno(PyExc_IOError);
982         return -1;
983     }
984     return 0;
985 }
986
987 static char __Entry_copy_doc__[] =
988     "copy(src)\n"
989     "Copies an ACL entry.\n"
990     "\n"
991     "This method sets all the parameters to those of another\n"
992     "entry (either of the same ACL or belonging to another ACL).\n"
993     "\n"
994     ":param Entry src: instance of type Entry\n"
995     ;
996
997 /* Sets all the entry parameters to another entry */
998 static PyObject* Entry_copy(PyObject *obj, PyObject *args) {
999     Entry_Object *self = (Entry_Object*)obj;
1000     Entry_Object *other;
1001
1002     if(!PyArg_ParseTuple(args, "O!", &Entry_Type, &other))
1003         return NULL;
1004
1005     if(acl_copy_entry(self->entry, other->entry) == -1)
1006         return PyErr_SetFromErrno(PyExc_IOError);
1007
1008     Py_INCREF(Py_None);
1009     return Py_None;
1010 }
1011
1012 /**** Permset type *****/
1013
1014 /* Creation of a new Permset instance */
1015 static PyObject* Permset_new(PyTypeObject* type, PyObject* args,
1016                              PyObject *keywds) {
1017     PyObject* newpermset;
1018
1019     newpermset = PyType_GenericNew(type, args, keywds);
1020
1021     if(newpermset != NULL) {
1022         ((Permset_Object*)newpermset)->permset = NULL;
1023         ((Permset_Object*)newpermset)->parent_entry = NULL;
1024     }
1025
1026     return newpermset;
1027 }
1028
1029 /* Initialization of a new Permset instance */
1030 static int Permset_init(PyObject* obj, PyObject* args, PyObject *keywds) {
1031     Permset_Object* self = (Permset_Object*) obj;
1032     Entry_Object* parent = NULL;
1033
1034     if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &parent))
1035         return -1;
1036
1037     if(acl_get_permset(parent->entry, &self->permset) == -1) {
1038         PyErr_SetFromErrno(PyExc_IOError);
1039         return -1;
1040     }
1041
1042     self->parent_entry = (PyObject*)parent;
1043     Py_INCREF(parent);
1044
1045     return 0;
1046 }
1047
1048 /* Free the Permset instance */
1049 static void Permset_dealloc(PyObject* obj) {
1050     Permset_Object *self = (Permset_Object*) obj;
1051     PyObject *err_type, *err_value, *err_traceback;
1052     int have_error = PyErr_Occurred() ? 1 : 0;
1053
1054     if (have_error)
1055         PyErr_Fetch(&err_type, &err_value, &err_traceback);
1056     if(self->parent_entry != NULL) {
1057         Py_DECREF(self->parent_entry);
1058         self->parent_entry = NULL;
1059     }
1060     if (have_error)
1061         PyErr_Restore(err_type, err_value, err_traceback);
1062     PyObject_DEL(self);
1063 }
1064
1065 /* Permset string representation */
1066 static PyObject* Permset_str(PyObject *obj) {
1067     Permset_Object *self = (Permset_Object*) obj;
1068     char pstr[3];
1069
1070     pstr[0] = get_perm(self->permset, ACL_READ) ? 'r' : '-';
1071     pstr[1] = get_perm(self->permset, ACL_WRITE) ? 'w' : '-';
1072     pstr[2] = get_perm(self->permset, ACL_EXECUTE) ? 'x' : '-';
1073     return PyUnicode_FromStringAndSize(pstr, 3);
1074 }
1075
1076 static char __Permset_clear_doc__[] =
1077     "Clears all permissions from the permission set.\n"
1078     ;
1079
1080 /* Clears all permissions from the permset */
1081 static PyObject* Permset_clear(PyObject* obj, PyObject* args) {
1082     Permset_Object *self = (Permset_Object*) obj;
1083
1084     if(acl_clear_perms(self->permset) == -1)
1085         return PyErr_SetFromErrno(PyExc_IOError);
1086
1087     /* Return the result */
1088     Py_INCREF(Py_None);
1089     return Py_None;
1090 }
1091
1092 static PyObject* Permset_get_right(PyObject *obj, void* arg) {
1093     Permset_Object *self = (Permset_Object*) obj;
1094
1095     if(get_perm(self->permset, *(acl_perm_t*)arg)) {
1096         Py_RETURN_TRUE;
1097     } else {
1098         Py_RETURN_FALSE;
1099     }
1100 }
1101
1102 static int Permset_set_right(PyObject* obj, PyObject* value, void* arg) {
1103     Permset_Object *self = (Permset_Object*) obj;
1104     int on;
1105     int nerr;
1106
1107     if(!PyLong_Check(value)) {
1108         PyErr_SetString(PyExc_ValueError, "invalid argument, an integer"
1109                         " is expected");
1110         return -1;
1111     }
1112     on = PyLong_AsLong(value);
1113     if(on)
1114         nerr = acl_add_perm(self->permset, *(acl_perm_t*)arg);
1115     else
1116         nerr = acl_delete_perm(self->permset, *(acl_perm_t*)arg);
1117     if(nerr == -1) {
1118         PyErr_SetFromErrno(PyExc_IOError);
1119         return -1;
1120     }
1121     return 0;
1122 }
1123
1124 static char __Permset_add_doc__[] =
1125     "add(perm)\n"
1126     "Add a permission to the permission set.\n"
1127     "\n"
1128     "This function adds the permission contained in \n"
1129     "the argument perm to the permission set.  An attempt \n"
1130     "to add a permission that is already contained in the \n"
1131     "permission set is not considered an error.\n"
1132     "\n"
1133     ":param perm: a permission (:py:data:`ACL_WRITE`, :py:data:`ACL_READ`,\n"
1134     "   :py:data:`ACL_EXECUTE`, ...)\n"
1135     ":raises IOError: in case the argument is not a valid descriptor\n"
1136     ;
1137
1138 static PyObject* Permset_add(PyObject* obj, PyObject* args) {
1139     Permset_Object *self = (Permset_Object*) obj;
1140     int right;
1141
1142     if (!PyArg_ParseTuple(args, "i", &right))
1143         return NULL;
1144
1145     if(acl_add_perm(self->permset, (acl_perm_t) right) == -1)
1146         return PyErr_SetFromErrno(PyExc_IOError);
1147
1148     /* Return the result */
1149     Py_INCREF(Py_None);
1150     return Py_None;
1151 }
1152
1153 static char __Permset_delete_doc__[] =
1154     "delete(perm)\n"
1155     "Delete a permission from the permission set.\n"
1156     "\n"
1157     "This function deletes the permission contained in \n"
1158     "the argument perm from the permission set. An attempt \n"
1159     "to delete a permission that is not contained in the \n"
1160     "permission set is not considered an error.\n"
1161     "\n"
1162     ":param perm: a permission (:py:data:`ACL_WRITE`, :py:data:`ACL_READ`,\n"
1163     "   :py:data:`ACL_EXECUTE`, ...)\n"
1164     ":raises IOError: in case the argument is not a valid descriptor\n"
1165     ;
1166
1167 static PyObject* Permset_delete(PyObject* obj, PyObject* args) {
1168     Permset_Object *self = (Permset_Object*) obj;
1169     int right;
1170
1171     if (!PyArg_ParseTuple(args, "i", &right))
1172         return NULL;
1173
1174     if(acl_delete_perm(self->permset, (acl_perm_t) right) == -1)
1175         return PyErr_SetFromErrno(PyExc_IOError);
1176
1177     /* Return the result */
1178     Py_INCREF(Py_None);
1179     return Py_None;
1180 }
1181
1182 static char __Permset_test_doc__[] =
1183     "test(perm)\n"
1184     "Test if a permission exists in the permission set.\n"
1185     "\n"
1186     "The test() function tests if the permission represented by\n"
1187     "the argument perm exists in the permission set.\n"
1188     "\n"
1189     ":param perm: a permission (:py:data:`ACL_WRITE`, :py:data:`ACL_READ`,\n"
1190     "   :py:data:`ACL_EXECUTE`, ...)\n"
1191     ":rtype: Boolean\n"
1192     ":raises IOError: in case the argument is not a valid descriptor\n"
1193     ;
1194
1195 static PyObject* Permset_test(PyObject* obj, PyObject* args) {
1196     Permset_Object *self = (Permset_Object*) obj;
1197     int right;
1198     int ret;
1199
1200     if (!PyArg_ParseTuple(args, "i", &right))
1201         return NULL;
1202
1203     ret = get_perm(self->permset, (acl_perm_t) right);
1204     if(ret == -1)
1205         return PyErr_SetFromErrno(PyExc_IOError);
1206
1207     if(ret) {
1208         Py_RETURN_TRUE;
1209     } else {
1210         Py_RETURN_FALSE;
1211     }
1212 }
1213
1214 #endif
1215
1216 static char __ACL_Type_doc__[] =
1217     "Type which represents a POSIX ACL\n"
1218     "\n"
1219     ".. note:: only one keyword parameter should be provided\n"
1220     "\n"
1221     ":param string file: creates an ACL representing\n"
1222     "    the access ACL of the specified file.\n"
1223     ":param string filedef: creates an ACL representing\n"
1224     "    the default ACL of the given directory.\n"
1225     ":param int fd: creates an ACL representing\n"
1226     "    the access ACL of the given file descriptor.\n"
1227     ":param string text: creates an ACL from a \n"
1228     "    textual description; note the ACL must be valid, which\n"
1229     "    means including a mask for extended ACLs, similar to\n"
1230     "    ``setfacl --no-mask``\n"
1231     ":param ACL acl: creates a copy of an existing ACL instance.\n"
1232     ":param int mode: creates an ACL from a numeric mode\n"
1233     "    (e.g. ``mode=0644``); this is valid only when the C library\n"
1234     "    provides the ``acl_from_mode call``, and\n"
1235     "    note that no validation is done on the given value.\n"
1236     "\n"
1237     "If no parameters are passed, an empty ACL will be created; this\n"
1238     "makes sense only when your OS supports ACL modification\n"
1239     "(i.e. it implements full POSIX.1e support), otherwise the ACL won't\n"
1240     "be useful.\n"
1241     ;
1242
1243 /* ACL type methods */
1244 static PyMethodDef ACL_methods[] = {
1245     {"applyto", ACL_applyto, METH_VARARGS, __applyto_doc__},
1246     {"valid", ACL_valid, METH_NOARGS, __valid_doc__},
1247 #ifdef HAVE_LINUX
1248     {"to_any_text", (PyCFunction)ACL_to_any_text, METH_VARARGS | METH_KEYWORDS,
1249      __to_any_text_doc__},
1250     {"check", ACL_check, METH_NOARGS, __check_doc__},
1251     {"equiv_mode", ACL_equiv_mode, METH_NOARGS, __equiv_mode_doc__},
1252 #endif
1253 #ifdef HAVE_ACL_COPYEXT
1254     {"__getstate__", ACL_get_state, METH_NOARGS,
1255      "Dumps the ACL to an external format."},
1256     {"__setstate__", ACL_set_state, METH_VARARGS,
1257      "Loads the ACL from an external format."},
1258 #endif
1259 #ifdef HAVE_LEVEL2
1260     {"delete_entry", ACL_delete_entry, METH_VARARGS, __ACL_delete_entry_doc__},
1261     {"calc_mask", ACL_calc_mask, METH_NOARGS, __ACL_calc_mask_doc__},
1262     {"append", ACL_append, METH_VARARGS, __ACL_append_doc__},
1263 #endif
1264     {NULL, NULL, 0, NULL}
1265 };
1266
1267
1268 /* The definition of the ACL Type */
1269 static PyTypeObject ACL_Type = {
1270     PyVarObject_HEAD_INIT(NULL, 0)
1271     "posix1e.ACL",
1272     sizeof(ACL_Object),
1273     0,
1274     ACL_dealloc,        /* tp_dealloc */
1275     0,                  /* tp_print */
1276     0,                  /* tp_getattr */
1277     0,                  /* tp_setattr */
1278     0,                  /* formerly tp_compare, in 3.0 deprecated, in
1279                            3.5 tp_as_async */
1280     0,                  /* tp_repr */
1281     0,                  /* tp_as_number */
1282     0,                  /* tp_as_sequence */
1283     0,                  /* tp_as_mapping */
1284     0,                  /* tp_hash */
1285     0,                  /* tp_call */
1286     ACL_str,            /* tp_str */
1287     0,                  /* tp_getattro */
1288     0,                  /* tp_setattro */
1289     0,                  /* tp_as_buffer */
1290     Py_TPFLAGS_DEFAULT, /* tp_flags */
1291     __ACL_Type_doc__,   /* tp_doc */
1292     0,                  /* tp_traverse */
1293     0,                  /* tp_clear */
1294 #ifdef HAVE_LINUX
1295     ACL_richcompare,    /* tp_richcompare */
1296 #else
1297     0,                  /* tp_richcompare */
1298 #endif
1299     0,                  /* tp_weaklistoffset */
1300 #ifdef HAVE_LEVEL2
1301     ACL_iter,
1302     ACL_iternext,
1303 #else
1304     0,                  /* tp_iter */
1305     0,                  /* tp_iternext */
1306 #endif
1307     ACL_methods,        /* tp_methods */
1308     0,                  /* tp_members */
1309     0,                  /* tp_getset */
1310     0,                  /* tp_base */
1311     0,                  /* tp_dict */
1312     0,                  /* tp_descr_get */
1313     0,                  /* tp_descr_set */
1314     0,                  /* tp_dictoffset */
1315     ACL_init,           /* tp_init */
1316     0,                  /* tp_alloc */
1317     ACL_new,            /* tp_new */
1318 };
1319
1320 #ifdef HAVE_LEVEL2
1321
1322 /* Entry type methods */
1323 static PyMethodDef Entry_methods[] = {
1324     {"copy", Entry_copy, METH_VARARGS, __Entry_copy_doc__},
1325     {NULL, NULL, 0, NULL}
1326 };
1327
1328 static char __Entry_tagtype_doc__[] =
1329     "The tag type of the current entry\n"
1330     "\n"
1331     "This is one of:\n"
1332     " - :py:data:`ACL_UNDEFINED_TAG`\n"
1333     " - :py:data:`ACL_USER_OBJ`\n"
1334     " - :py:data:`ACL_USER`\n"
1335     " - :py:data:`ACL_GROUP_OBJ`\n"
1336     " - :py:data:`ACL_GROUP`\n"
1337     " - :py:data:`ACL_MASK`\n"
1338     " - :py:data:`ACL_OTHER`\n"
1339     ;
1340
1341 static char __Entry_qualifier_doc__[] =
1342     "The qualifier of the current entry\n"
1343     "\n"
1344     "If the tag type is :py:data:`ACL_USER`, this should be a user id.\n"
1345     "If the tag type if :py:data:`ACL_GROUP`, this should be a group id.\n"
1346     "Else it doesn't matter.\n"
1347     ;
1348
1349 static char __Entry_parent_doc__[] =
1350     "The parent ACL of this entry\n"
1351     ;
1352
1353 static char __Entry_permset_doc__[] =
1354     "The permission set of this ACL entry\n"
1355     ;
1356
1357 /* Entry getset */
1358 static PyGetSetDef Entry_getsets[] = {
1359     {"tag_type", Entry_get_tag_type, Entry_set_tag_type,
1360      __Entry_tagtype_doc__},
1361     {"qualifier", Entry_get_qualifier, Entry_set_qualifier,
1362      __Entry_qualifier_doc__},
1363     {"parent", Entry_get_parent, NULL, __Entry_parent_doc__},
1364     {"permset", Entry_get_permset, Entry_set_permset, __Entry_permset_doc__},
1365     {NULL}
1366 };
1367
1368 static char __Entry_Type_doc__[] =
1369     "Type which represents an entry in an ACL.\n"
1370     "\n"
1371     "The type exists only if the OS has full support for POSIX.1e\n"
1372     "Can be created either by:\n"
1373     "\n"
1374     "  >>> e = posix1e.Entry(myACL) # this creates a new entry in the ACL\n"
1375     "  >>> e = myACL.append() # another way for doing the same thing\n"
1376     "\n"
1377     "or by:\n"
1378     "\n"
1379     "  >>> for entry in myACL:\n"
1380     "  ...     print entry\n"
1381     "\n"
1382     "Note that the Entry keeps a reference to its ACL, so even if \n"
1383     "you delete the ACL, it won't be cleaned up and will continue to \n"
1384     "exist until its Entry(ies) will be deleted.\n"
1385     ;
1386 /* The definition of the Entry Type */
1387 static PyTypeObject Entry_Type = {
1388     PyVarObject_HEAD_INIT(NULL, 0)
1389     "posix1e.Entry",
1390     sizeof(Entry_Object),
1391     0,
1392     Entry_dealloc,      /* tp_dealloc */
1393     0,                  /* tp_print */
1394     0,                  /* tp_getattr */
1395     0,                  /* tp_setattr */
1396     0,                  /* tp_compare */
1397     0,                  /* tp_repr */
1398     0,                  /* tp_as_number */
1399     0,                  /* tp_as_sequence */
1400     0,                  /* tp_as_mapping */
1401     0,                  /* tp_hash */
1402     0,                  /* tp_call */
1403     Entry_str,          /* tp_str */
1404     0,                  /* tp_getattro */
1405     0,                  /* tp_setattro */
1406     0,                  /* tp_as_buffer */
1407     Py_TPFLAGS_DEFAULT, /* tp_flags */
1408     __Entry_Type_doc__, /* tp_doc */
1409     0,                  /* tp_traverse */
1410     0,                  /* tp_clear */
1411     0,                  /* tp_richcompare */
1412     0,                  /* tp_weaklistoffset */
1413     0,                  /* tp_iter */
1414     0,                  /* tp_iternext */
1415     Entry_methods,      /* tp_methods */
1416     0,                  /* tp_members */
1417     Entry_getsets,      /* tp_getset */
1418     0,                  /* tp_base */
1419     0,                  /* tp_dict */
1420     0,                  /* tp_descr_get */
1421     0,                  /* tp_descr_set */
1422     0,                  /* tp_dictoffset */
1423     Entry_init,         /* tp_init */
1424     0,                  /* tp_alloc */
1425     Entry_new,          /* tp_new */
1426 };
1427
1428 /* Permset type methods */
1429 static PyMethodDef Permset_methods[] = {
1430     {"clear", Permset_clear, METH_NOARGS, __Permset_clear_doc__, },
1431     {"add", Permset_add, METH_VARARGS, __Permset_add_doc__, },
1432     {"delete", Permset_delete, METH_VARARGS, __Permset_delete_doc__, },
1433     {"test", Permset_test, METH_VARARGS, __Permset_test_doc__, },
1434     {NULL, NULL, 0, NULL}
1435 };
1436
1437 static char __Permset_execute_doc__[] =
1438     "Execute permission property\n"
1439     "\n"
1440     "This is a convenience method of retrieving and setting the execute\n"
1441     "permission in the permission set; the \n"
1442     "same effect can be achieved using the functions\n"
1443     "add(), test(), delete(), and those can take any \n"
1444     "permission defined by your platform.\n"
1445     ;
1446
1447 static char __Permset_read_doc__[] =
1448     "Read permission property\n"
1449     "\n"
1450     "This is a convenience method of retrieving and setting the read\n"
1451     "permission in the permission set; the \n"
1452     "same effect can be achieved using the functions\n"
1453     "add(), test(), delete(), and those can take any \n"
1454     "permission defined by your platform.\n"
1455     ;
1456
1457 static char __Permset_write_doc__[] =
1458     "Write permission property\n"
1459     "\n"
1460     "This is a convenience method of retrieving and setting the write\n"
1461     "permission in the permission set; the \n"
1462     "same effect can be achieved using the functions\n"
1463     "add(), test(), delete(), and those can take any \n"
1464     "permission defined by your platform.\n"
1465     ;
1466
1467 /* Permset getset */
1468 static PyGetSetDef Permset_getsets[] = {
1469     {"execute", Permset_get_right, Permset_set_right,
1470      __Permset_execute_doc__, &holder_ACL_EXECUTE},
1471     {"read", Permset_get_right, Permset_set_right,
1472      __Permset_read_doc__, &holder_ACL_READ},
1473     {"write", Permset_get_right, Permset_set_right,
1474      __Permset_write_doc__, &holder_ACL_WRITE},
1475     {NULL}
1476 };
1477
1478 static char __Permset_Type_doc__[] =
1479     "Type which represents the permission set in an ACL entry\n"
1480     "\n"
1481     "The type exists only if the OS has full support for POSIX.1e\n"
1482     "Can be retrieved either by:\n\n"
1483     ">>> perms = myEntry.permset\n"
1484     "\n"
1485     "or by:\n\n"
1486     ">>> perms = posix1e.Permset(myEntry)\n"
1487     "\n"
1488     "Note that the Permset keeps a reference to its Entry, so even if \n"
1489     "you delete the entry, it won't be cleaned up and will continue to \n"
1490     "exist until its Permset will be deleted.\n"
1491     ;
1492
1493 /* The definition of the Permset Type */
1494 static PyTypeObject Permset_Type = {
1495     PyVarObject_HEAD_INIT(NULL, 0)
1496     "posix1e.Permset",
1497     sizeof(Permset_Object),
1498     0,
1499     Permset_dealloc,    /* tp_dealloc */
1500     0,                  /* tp_print */
1501     0,                  /* tp_getattr */
1502     0,                  /* tp_setattr */
1503     0,                  /* tp_compare */
1504     0,                  /* tp_repr */
1505     0,                  /* tp_as_number */
1506     0,                  /* tp_as_sequence */
1507     0,                  /* tp_as_mapping */
1508     0,                  /* tp_hash */
1509     0,                  /* tp_call */
1510     Permset_str,        /* tp_str */
1511     0,                  /* tp_getattro */
1512     0,                  /* tp_setattro */
1513     0,                  /* tp_as_buffer */
1514     Py_TPFLAGS_DEFAULT, /* tp_flags */
1515     __Permset_Type_doc__,/* tp_doc */
1516     0,                  /* tp_traverse */
1517     0,                  /* tp_clear */
1518     0,                  /* tp_richcompare */
1519     0,                  /* tp_weaklistoffset */
1520     0,                  /* tp_iter */
1521     0,                  /* tp_iternext */
1522     Permset_methods,    /* tp_methods */
1523     0,                  /* tp_members */
1524     Permset_getsets,    /* tp_getset */
1525     0,                  /* tp_base */
1526     0,                  /* tp_dict */
1527     0,                  /* tp_descr_get */
1528     0,                  /* tp_descr_set */
1529     0,                  /* tp_dictoffset */
1530     Permset_init,       /* tp_init */
1531     0,                  /* tp_alloc */
1532     Permset_new,        /* tp_new */
1533 };
1534
1535 #endif
1536
1537 /* Module methods */
1538
1539 static char __deletedef_doc__[] =
1540     "delete_default(path)\n"
1541     "Delete the default ACL from a directory.\n"
1542     "\n"
1543     "This function deletes the default ACL associated with\n"
1544     "a directory (the ACL which will be ANDed with the mode\n"
1545     "parameter to the open, creat functions).\n"
1546     "\n"
1547     ":param string path: the directory whose default ACL should be deleted\n"
1548     ;
1549
1550 /* Deletes the default ACL from a directory */
1551 static PyObject* aclmodule_delete_default(PyObject* obj, PyObject* args) {
1552     char *filename;
1553
1554     /* Parse the arguments */
1555     if (!PyArg_ParseTuple(args, "et", NULL, &filename))
1556         return NULL;
1557
1558     if(acl_delete_def_file(filename) == -1) {
1559         return PyErr_SetFromErrnoWithFilename(PyExc_IOError, filename);
1560     }
1561
1562     /* Return the result */
1563     Py_INCREF(Py_None);
1564     return Py_None;
1565 }
1566
1567 #ifdef HAVE_LINUX
1568 static char __has_extended_doc__[] =
1569     "has_extended(item)\n"
1570     "Check if a file or file handle has an extended ACL.\n"
1571     "\n"
1572     ":param item: either a file name or a file-like object or an integer;\n"
1573     "  it represents the file-system object on which to act\n"
1574     ;
1575
1576 /* Check for extended ACL a file or fd */
1577 static PyObject* aclmodule_has_extended(PyObject* obj, PyObject* args) {
1578     PyObject *item, *tmp;
1579     int nret;
1580     int fd;
1581
1582     if (!PyArg_ParseTuple(args, "O", &item))
1583         return NULL;
1584
1585     if((fd = PyObject_AsFileDescriptor(item)) != -1) {
1586         if((nret = acl_extended_fd(fd)) == -1) {
1587             PyErr_SetFromErrno(PyExc_IOError);
1588         }
1589     } else {
1590       // PyObject_AsFileDescriptor sets an error when failing, so clear
1591       // it such that further code works; some method lookups fail if an
1592       // error already occured when called, which breaks at least
1593       // PyOS_FSPath (called by FSConverter).
1594       PyErr_Clear();
1595       if(PyUnicode_FSConverter(item, &tmp)) {
1596         char *filename = PyBytes_AS_STRING(tmp);
1597         if ((nret = acl_extended_file(filename)) == -1) {
1598             PyErr_SetFromErrnoWithFilename(PyExc_IOError, filename);
1599         }
1600         Py_DECREF(tmp);
1601       } else {
1602           nret = -1;
1603       }
1604     }
1605
1606     if (nret < 0) {
1607         return NULL;
1608     } else {
1609         return PyBool_FromLong(nret);
1610     }
1611 }
1612 #endif
1613
1614 /* The module methods */
1615 static PyMethodDef aclmodule_methods[] = {
1616     {"delete_default", aclmodule_delete_default, METH_VARARGS,
1617      __deletedef_doc__},
1618 #ifdef HAVE_LINUX
1619     {"has_extended", aclmodule_has_extended, METH_VARARGS,
1620      __has_extended_doc__},
1621 #endif
1622     {NULL, NULL, 0, NULL}
1623 };
1624
1625 static char __posix1e_doc__[] =
1626     "POSIX.1e ACLs manipulation\n"
1627     "==========================\n"
1628     "\n"
1629     "This module provides support for manipulating POSIX.1e ACLS\n"
1630     "\n"
1631     "Depending on the operating system support for POSIX.1e, \n"
1632     "the ACL type will have more or less capabilities:\n\n"
1633     "  - level 1, only basic support, you can create\n"
1634     "    ACLs from files and text descriptions;\n"
1635     "    once created, the type is immutable\n"
1636     "  - level 2, complete support, you can alter\n"
1637     "    the ACL once it is created\n"
1638     "\n"
1639     "Also, in level 2, more types are available, corresponding\n"
1640     "to acl_entry_t (the Entry type), acl_permset_t (the Permset type).\n"
1641     "\n"
1642     "The existence of level 2 support and other extensions can be\n"
1643     "checked by the constants:\n\n"
1644     "  - :py:data:`HAS_ACL_ENTRY` for level 2 and the Entry/Permset classes\n"
1645     "  - :py:data:`HAS_ACL_FROM_MODE` for ``ACL(mode=...)`` usage\n"
1646     "  - :py:data:`HAS_ACL_CHECK` for the :py:func:`ACL.check` function\n"
1647     "  - :py:data:`HAS_EXTENDED_CHECK` for the module-level\n"
1648     "    :py:func:`has_extended` function\n"
1649     "  - :py:data:`HAS_EQUIV_MODE` for the :py:func:`ACL.equiv_mode` method\n"
1650     "\n"
1651     "Example:\n"
1652     "\n"
1653     ">>> import posix1e\n"
1654     ">>> acl1 = posix1e.ACL(file=\"file.txt\") \n"
1655     ">>> print acl1\n"
1656     "user::rw-\n"
1657     "group::rw-\n"
1658     "other::r--\n"
1659     ">>>\n"
1660     ">>> b = posix1e.ACL(text=\"u::rx,g::-,o::-\")\n"
1661     ">>> print b\n"
1662     "user::r-x\n"
1663     "group::---\n"
1664     "other::---\n"
1665     ">>>\n"
1666     ">>> b.applyto(\"file.txt\")\n"
1667     ">>> print posix1e.ACL(file=\"file.txt\")\n"
1668     "user::r-x\n"
1669     "group::---\n"
1670     "other::---\n"
1671     ">>>\n"
1672     "\n"
1673     ".. py:data:: ACL_USER\n\n"
1674     "   Denotes a specific user entry in an ACL.\n"
1675     "\n"
1676     ".. py:data:: ACL_USER_OBJ\n\n"
1677     "   Denotes the user owner entry in an ACL.\n"
1678     "\n"
1679     ".. py:data:: ACL_GROUP\n\n"
1680     "   Denotes the a group entry in an ACL.\n"
1681     "\n"
1682     ".. py:data:: ACL_GROUP_OBJ\n\n"
1683     "   Denotes the group owner entry in an ACL.\n"
1684     "\n"
1685     ".. py:data:: ACL_OTHER\n\n"
1686     "   Denotes the 'others' entry in an ACL.\n"
1687     "\n"
1688     ".. py:data:: ACL_MASK\n\n"
1689     "   Denotes the mask entry in an ACL, representing the maximum\n"
1690     "   access granted other users, the owner group and other groups.\n"
1691     "\n"
1692     ".. py:data:: ACL_UNDEFINED_TAG\n\n"
1693     "   An undefined tag in an ACL.\n"
1694     "\n"
1695     ".. py:data:: ACL_READ\n\n"
1696     "   Read permission in a permission set.\n"
1697     "\n"
1698     ".. py:data:: ACL_WRITE\n\n"
1699     "   Write permission in a permission set.\n"
1700     "\n"
1701     ".. py:data:: ACL_EXECUTE\n\n"
1702     "   Execute permission in a permission set.\n"
1703     "\n"
1704     ".. py:data:: HAS_ACL_ENTRY\n\n"
1705     "   denotes support for level 2 and the Entry/Permset classes\n"
1706     "\n"
1707     ".. py:data:: HAS_ACL_FROM_MODE\n\n"
1708     "   denotes support for building an ACL from an octal mode\n"
1709     "\n"
1710     ".. py:data:: HAS_ACL_CHECK\n\n"
1711     "   denotes support for extended checks of an ACL's validity\n"
1712     "\n"
1713     ".. py:data:: HAS_EXTENDED_CHECK\n\n"
1714     "   denotes support for checking whether an ACL is basic or extended\n"
1715     "\n"
1716     ".. py:data:: HAS_EQUIV_MODE\n\n"
1717     "   denotes support for the equiv_mode function\n"
1718     "\n"
1719     ;
1720
1721 static struct PyModuleDef posix1emodule = {
1722     PyModuleDef_HEAD_INIT,
1723     "posix1e",
1724     __posix1e_doc__,
1725     0,
1726     aclmodule_methods,
1727 };
1728
1729 PyMODINIT_FUNC
1730 PyInit_posix1e(void)
1731 {
1732     PyObject *m, *d;
1733
1734     Py_TYPE(&ACL_Type) = &PyType_Type;
1735     if(PyType_Ready(&ACL_Type) < 0)
1736         return NULL;
1737
1738 #ifdef HAVE_LEVEL2
1739     Py_TYPE(&Entry_Type) = &PyType_Type;
1740     if(PyType_Ready(&Entry_Type) < 0)
1741         return NULL;
1742
1743     Py_TYPE(&Permset_Type) = &PyType_Type;
1744     if(PyType_Ready(&Permset_Type) < 0)
1745         return NULL;
1746 #endif
1747
1748     m = PyModule_Create(&posix1emodule);
1749     if (m==NULL)
1750         return NULL;
1751
1752     d = PyModule_GetDict(m);
1753     if (d == NULL)
1754         return NULL;
1755
1756     Py_INCREF(&ACL_Type);
1757     if (PyDict_SetItemString(d, "ACL",
1758                              (PyObject *) &ACL_Type) < 0)
1759         return NULL;
1760
1761     /* 23.3.6 acl_type_t values */
1762     PyModule_AddIntConstant(m, "ACL_TYPE_ACCESS", ACL_TYPE_ACCESS);
1763     PyModule_AddIntConstant(m, "ACL_TYPE_DEFAULT", ACL_TYPE_DEFAULT);
1764
1765
1766 #ifdef HAVE_LEVEL2
1767     Py_INCREF(&Entry_Type);
1768     if (PyDict_SetItemString(d, "Entry",
1769                              (PyObject *) &Entry_Type) < 0)
1770         return NULL;
1771
1772     Py_INCREF(&Permset_Type);
1773     if (PyDict_SetItemString(d, "Permset",
1774                              (PyObject *) &Permset_Type) < 0)
1775         return NULL;
1776
1777     /* 23.2.2 acl_perm_t values */
1778     PyModule_AddIntConstant(m, "ACL_READ", ACL_READ);
1779     PyModule_AddIntConstant(m, "ACL_WRITE", ACL_WRITE);
1780     PyModule_AddIntConstant(m, "ACL_EXECUTE", ACL_EXECUTE);
1781
1782     /* 23.2.5 acl_tag_t values */
1783     PyModule_AddIntConstant(m, "ACL_UNDEFINED_TAG", ACL_UNDEFINED_TAG);
1784     PyModule_AddIntConstant(m, "ACL_USER_OBJ", ACL_USER_OBJ);
1785     PyModule_AddIntConstant(m, "ACL_USER", ACL_USER);
1786     PyModule_AddIntConstant(m, "ACL_GROUP_OBJ", ACL_GROUP_OBJ);
1787     PyModule_AddIntConstant(m, "ACL_GROUP", ACL_GROUP);
1788     PyModule_AddIntConstant(m, "ACL_MASK", ACL_MASK);
1789     PyModule_AddIntConstant(m, "ACL_OTHER", ACL_OTHER);
1790
1791     /* Document extended functionality via easy-to-use constants */
1792     PyModule_AddIntConstant(m, "HAS_ACL_ENTRY", 1);
1793 #else
1794     PyModule_AddIntConstant(m, "HAS_ACL_ENTRY", 0);
1795 #endif
1796
1797 #ifdef HAVE_LINUX
1798     /* Linux libacl specific acl_to_any_text constants */
1799     PyModule_AddIntConstant(m, "TEXT_ABBREVIATE", TEXT_ABBREVIATE);
1800     PyModule_AddIntConstant(m, "TEXT_NUMERIC_IDS", TEXT_NUMERIC_IDS);
1801     PyModule_AddIntConstant(m, "TEXT_SOME_EFFECTIVE", TEXT_SOME_EFFECTIVE);
1802     PyModule_AddIntConstant(m, "TEXT_ALL_EFFECTIVE", TEXT_ALL_EFFECTIVE);
1803     PyModule_AddIntConstant(m, "TEXT_SMART_INDENT", TEXT_SMART_INDENT);
1804
1805     /* Linux libacl specific acl_check constants */
1806     PyModule_AddIntConstant(m, "ACL_MULTI_ERROR", ACL_MULTI_ERROR);
1807     PyModule_AddIntConstant(m, "ACL_DUPLICATE_ERROR", ACL_DUPLICATE_ERROR);
1808     PyModule_AddIntConstant(m, "ACL_MISS_ERROR", ACL_MISS_ERROR);
1809     PyModule_AddIntConstant(m, "ACL_ENTRY_ERROR", ACL_ENTRY_ERROR);
1810
1811 #define LINUX_EXT_VAL 1
1812 #else
1813 #define LINUX_EXT_VAL 0
1814 #endif
1815     /* declare the Linux extensions */
1816     PyModule_AddIntConstant(m, "HAS_ACL_FROM_MODE", LINUX_EXT_VAL);
1817     PyModule_AddIntConstant(m, "HAS_ACL_CHECK", LINUX_EXT_VAL);
1818     PyModule_AddIntConstant(m, "HAS_EXTENDED_CHECK", LINUX_EXT_VAL);
1819     PyModule_AddIntConstant(m, "HAS_EQUIV_MODE", LINUX_EXT_VAL);
1820
1821     return m;
1822 }