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