2 posix1e - a python module exposing the posix acl functions
4 Copyright (C) 2002-2009, 2012, 2014, 2015 Iustin Pop <iustin@k1024.org>
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.
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.
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
23 #define PY_SSIZE_T_CLEAN
26 #include <sys/types.h>
30 #include <acl/libacl.h>
31 #define get_perm acl_get_perm
33 #define get_perm acl_get_perm_np
36 /* Used for cpychecker: */
37 /* The checker automatically defines this preprocessor name when creating
38 the custom attribute: */
39 #if defined(WITH_CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF_ATTRIBUTE)
40 #define CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF(typename) \
41 __attribute__((cpychecker_type_object_for_typedef(typename)))
43 /* This handles the case where we're compiling with a "vanilla"
44 compiler that doesn't supply this attribute: */
45 #define CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF(typename)
48 /* The checker automatically defines this preprocessor name when creating
49 the custom attribute: */
50 #if defined(WITH_CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION_ATTRIBUTE)
51 #define CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION \
52 __attribute__((cpychecker_negative_result_sets_exception))
54 #define CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
57 static PyTypeObject ACL_Type
58 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF("ACL_Object");
59 static PyObject* ACL_applyto(PyObject* obj, PyObject* args);
60 static PyObject* ACL_valid(PyObject* obj, PyObject* args);
62 #ifdef HAVE_ACL_COPY_EXT
63 static PyObject* ACL_get_state(PyObject *obj, PyObject* args);
64 static PyObject* ACL_set_state(PyObject *obj, PyObject* args);
68 static PyTypeObject Entry_Type
69 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF("Entry_Object");
70 static PyTypeObject Permset_Type
71 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF("Permset_Object");
72 static PyObject* Permset_new(PyTypeObject* type, PyObject* args,
76 static acl_perm_t holder_ACL_EXECUTE = ACL_EXECUTE;
77 static acl_perm_t holder_ACL_READ = ACL_READ;
78 static acl_perm_t holder_ACL_WRITE = ACL_WRITE;
92 PyObject *parent_acl; /* The parent acl, so it won't run out on us */
98 PyObject *parent_entry; /* The parent entry, so it won't run out on us */
99 acl_permset_t permset;
104 /* Creation of a new ACL instance */
105 static PyObject* ACL_new(PyTypeObject* type, PyObject* args,
110 newacl = type->tp_alloc(type, 0);
115 acl = (ACL_Object*) newacl;
117 acl->acl = acl_init(0);
118 if (acl->acl == NULL) {
119 /* LCOV_EXCL_START */
120 PyErr_SetFromErrno(PyExc_IOError);
126 acl->entry_id = ACL_FIRST_ENTRY;
132 /* Initialization of a new ACL instance */
133 static int ACL_init(PyObject* obj, PyObject* args, PyObject *keywds) {
134 ACL_Object* self = (ACL_Object*) obj;
135 static char *kwlist[] = { "file", "fd", "text", "acl", "filedef",
139 #ifdef HAVE_ACL_COPY_EXT
143 char *format = "|O&OsO!O&"
147 #ifdef HAVE_ACL_COPY_EXT
155 PyObject *file = NULL;
156 PyObject *filedef = NULL;
159 ACL_Object* thesrc = NULL;
160 #ifdef HAVE_ACL_COPY_EXT
161 const void *buf = NULL;
166 if(!PyTuple_Check(args) || PyTuple_Size(args) != 0 ||
167 (keywds != NULL && PyDict_Check(keywds) && PyDict_Size(keywds) > 1)) {
168 PyErr_SetString(PyExc_ValueError, "a max of one keyword argument"
172 if(!PyArg_ParseTupleAndKeywords(args, keywds, format, kwlist,
173 PyUnicode_FSConverter, &file,
174 &fd, &text, &ACL_Type, &thesrc,
175 PyUnicode_FSConverter, &filedef
179 #ifdef HAVE_ACL_COPY_EXT
186 char *path = PyBytes_AS_STRING(file);
187 new = acl_get_file(path, ACL_TYPE_ACCESS);
188 // Set custom exception on this failure path which includes
191 PyErr_SetFromErrnoWithFilename(PyExc_IOError, path);
195 } else if(text != NULL)
196 new = acl_from_text(text);
197 else if(fd != NULL) {
199 if ((fdval = PyObject_AsFileDescriptor(fd)) != -1) {
200 new = acl_get_fd(fdval);
202 } else if(thesrc != NULL)
203 new = acl_dup(thesrc->acl);
204 else if(filedef != NULL) {
205 char *path = PyBytes_AS_STRING(filedef);
206 new = acl_get_file(path, ACL_TYPE_DEFAULT);
207 // Set custom exception on this failure path which includes
210 PyErr_SetFromErrnoWithFilename(PyExc_IOError, path);
217 new = acl_from_mode(mode);
219 #ifdef HAVE_ACL_COPY_EXT
220 else if(buf != NULL) {
221 new = acl_copy_int(buf);
229 PyErr_SetFromErrno(PyExc_IOError);
234 /* Free the old acl_t without checking for error, we don't
236 if(self->acl != NULL)
244 /* Standard type functions */
245 static void ACL_dealloc(PyObject* obj) {
246 ACL_Object *self = (ACL_Object*) obj;
247 PyObject *err_type, *err_value, *err_traceback;
248 int have_error = PyErr_Occurred() ? 1 : 0;
251 PyErr_Fetch(&err_type, &err_value, &err_traceback);
252 if(self->acl != NULL && acl_free(self->acl) != 0)
253 PyErr_WriteUnraisable(obj); /* LCOV_EXCL_LINE */
255 PyErr_Restore(err_type, err_value, err_traceback);
259 /* Converts the acl to a text format */
260 static PyObject* ACL_str(PyObject *obj) {
262 ACL_Object *self = (ACL_Object*) obj;
265 text = acl_to_text(self->acl, NULL);
267 /* LCOV_EXCL_START */
268 return PyErr_SetFromErrno(PyExc_IOError);
271 ret = PyUnicode_FromString(text);
272 if(acl_free(text) != 0) {
273 /* LCOV_EXCL_START */
275 return PyErr_SetFromErrno(PyExc_IOError);
282 static char __to_any_text_doc__[] =
283 "to_any_text([prefix='', separator='n', options=0])\n"
284 "Convert the ACL to a custom text format.\n"
286 "This method encapsulates the ``acl_to_any_text()`` function.\n"
287 "It allows a customized text format to be generated for the ACL. See\n"
288 ":manpage:`acl_to_any_text(3)` for more details.\n"
290 ":param string prefix: if given, this string will be pre-pended to\n"
292 ":param string separator: a single character (defaults to '\\n'); this will"
293 " be used to separate the entries in the ACL\n"
294 ":param options: a bitwise combination of:\n\n"
295 " - :py:data:`TEXT_ABBREVIATE`: use 'u' instead of 'user', 'g' \n"
296 " instead of 'group', etc.\n"
297 " - :py:data:`TEXT_NUMERIC_IDS`: User and group IDs are included as\n"
298 " decimal numbers instead of names\n"
299 " - :py:data:`TEXT_SOME_EFFECTIVE`: Include comments denoting the\n"
300 " effective permissions when some are masked\n"
301 " - :py:data:`TEXT_ALL_EFFECTIVE`: Include comments after all ACL\n"
302 " entries affected by an ACL_MASK entry\n"
303 " - :py:data:`TEXT_SMART_INDENT`: Used in combination with the\n"
304 " _EFFECTIVE options, this will ensure that comments are aligned\n"
305 " to the fourth tab position (assuming one tab equals eight spaces)\n"
309 /* Converts the acl to a custom text format */
310 static PyObject* ACL_to_any_text(PyObject *obj, PyObject *args,
313 ACL_Object *self = (ACL_Object*) obj;
315 const char *arg_prefix = NULL;
316 char arg_separator = '\n';
318 static char *kwlist[] = {"prefix", "separator", "options", NULL};
320 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|sci", kwlist, &arg_prefix,
321 &arg_separator, &arg_options))
324 text = acl_to_any_text(self->acl, arg_prefix, arg_separator, arg_options);
326 return PyErr_SetFromErrno(PyExc_IOError); /* LCOV_EXCL_LINE */
328 ret = PyBytes_FromString(text);
329 if(acl_free(text) != 0) {
330 /* LCOV_EXCL_START */
332 return PyErr_SetFromErrno(PyExc_IOError);
338 static char __check_doc__[] =
339 "Check the ACL validity.\n"
341 "This is a non-portable, Linux specific extension that allow more\n"
342 "information to be retrieved in case an ACL is not valid than via the\n"
343 ":py:func:`valid` method.\n"
345 "This method will return either False (the ACL is valid), or a tuple\n"
346 "with two elements. The first element is one of the following\n"
348 " - :py:data:`ACL_MULTI_ERROR`: The ACL contains multiple entries that\n"
349 " have a tag type that may occur at most once\n"
350 " - :py:data:`ACL_DUPLICATE_ERROR`: The ACL contains multiple \n"
351 " :py:data:`ACL_USER` or :py:data:`ACL_GROUP` entries with the\n"
353 " - :py:data:`ACL_MISS_ERROR`: A required entry is missing\n"
354 " - :py:data:`ACL_ENTRY_ERROR`: The ACL contains an invalid entry\n"
357 "The second element of the tuple is the index of the entry that is\n"
358 "invalid (in the same order as by iterating over the ACL entry)\n"
361 /* The acl_check method */
362 static PyObject* ACL_check(PyObject* obj, PyObject* args) {
363 ACL_Object *self = (ACL_Object*) obj;
367 if((result = acl_check(self->acl, &eindex)) == -1)
368 return PyErr_SetFromErrno(PyExc_IOError); /* LCOV_EXCL_LINE */
372 return Py_BuildValue("(ii)", result, eindex);
375 /* Implementation of the rich compare for ACLs */
376 static PyObject* ACL_richcompare(PyObject* o1, PyObject* o2, int op) {
377 ACL_Object *acl1, *acl2;
381 if(!PyObject_IsInstance(o2, (PyObject*)&ACL_Type)) {
386 PyErr_SetString(PyExc_TypeError, "can only compare to an ACL");
390 acl1 = (ACL_Object*)o1;
391 acl2 = (ACL_Object*)o2;
392 if((n=acl_cmp(acl1->acl, acl2->acl))==-1)
393 return PyErr_SetFromErrno(PyExc_IOError); /* LCOV_EXCL_LINE */
396 ret = n == 0 ? Py_True : Py_False;
399 ret = n == 1 ? Py_True : Py_False;
402 PyErr_SetString(PyExc_TypeError, "ACLs are not orderable");
409 static char __equiv_mode_doc__[] =
410 "Return the octal mode the ACL is equivalent to.\n"
412 "This is a non-portable, Linux specific extension that checks\n"
413 "if the ACL is a basic ACL and returns the corresponding mode.\n"
416 ":raise IOError: An IOerror exception will be raised if the ACL is\n"
417 " an extended ACL.\n"
420 /* The acl_equiv_mode method */
421 static PyObject* ACL_equiv_mode(PyObject* obj, PyObject* args) {
422 ACL_Object *self = (ACL_Object*) obj;
425 if(acl_equiv_mode(self->acl, &mode) == -1)
426 return PyErr_SetFromErrno(PyExc_IOError); /* LCOV_EXCL_LINE */
427 return PyLong_FromLong(mode);
432 static char __applyto_doc__[] =
433 "applyto(item[, flag=ACL_TYPE_ACCESS])\n"
434 "Apply the ACL to a file or filehandle.\n"
436 ":param item: either a filename or a file-like object or an integer;\n"
437 " this represents the filesystem object on which to act\n"
438 ":param flag: optional flag representing the type of ACL to set, either\n"
439 " :py:data:`ACL_TYPE_ACCESS` (default) or :py:data:`ACL_TYPE_DEFAULT`\n"
442 /* Applies the ACL to a file */
443 static PyObject* ACL_applyto(PyObject* obj, PyObject* args) {
444 ACL_Object *self = (ACL_Object*) obj;
445 PyObject *target, *tmp;
446 acl_type_t type = ACL_TYPE_ACCESS;
450 if (!PyArg_ParseTuple(args, "O|I", &target, &type))
452 if ((fd = PyObject_AsFileDescriptor(target)) != -1) {
453 if((nret = acl_set_fd(fd, self->acl)) == -1) {
454 PyErr_SetFromErrno(PyExc_IOError);
457 // PyObject_AsFileDescriptor sets an error when failing, so clear
458 // it such that further code works; some method lookups fail if an
459 // error already occured when called, which breaks at least
460 // PyOS_FSPath (called by FSConverter).
462 if(PyUnicode_FSConverter(target, &tmp)) {
463 char *filename = PyBytes_AS_STRING(tmp);
464 if ((nret = acl_set_file(filename, type, self->acl)) == -1) {
465 PyErr_SetFromErrnoWithFilename(PyExc_IOError, filename);
479 static char __valid_doc__[] =
480 "Test the ACL for validity.\n"
482 "This method tests the ACL to see if it is a valid ACL\n"
483 "in terms of the file-system. More precisely, it checks that:\n"
485 "The ACL contains exactly one entry with each of the\n"
486 ":py:data:`ACL_USER_OBJ`, :py:data:`ACL_GROUP_OBJ`, and \n"
487 ":py:data:`ACL_OTHER` tag types. Entries\n"
488 "with :py:data:`ACL_USER` and :py:data:`ACL_GROUP` tag types may\n"
489 "appear zero or more\n"
490 "times in an ACL. An ACL that contains entries of :py:data:`ACL_USER` or\n"
491 ":py:data:`ACL_GROUP` tag types must contain exactly one entry of the \n"
492 ":py:data:`ACL_MASK` tag type. If an ACL contains no entries of\n"
493 ":py:data:`ACL_USER` or :py:data:`ACL_GROUP` tag types, the\n"
494 ":py:data:`ACL_MASK` entry is optional.\n"
496 "All user ID qualifiers must be unique among all entries of\n"
497 "the :py:data:`ACL_USER` tag type, and all group IDs must be unique\n"
498 "among all entries of :py:data:`ACL_GROUP` tag type.\n"
500 "The method will return 1 for a valid ACL and 0 for an invalid one.\n"
501 "This has been chosen because the specification for\n"
502 ":manpage:`acl_valid(3)`\n"
503 "in the POSIX.1e standard documents only one possible value for errno\n"
504 "in case of an invalid ACL, so we can't differentiate between\n"
505 "classes of errors. Other suggestions are welcome.\n"
511 /* Checks the ACL for validity */
512 static PyObject* ACL_valid(PyObject* obj, PyObject* args) {
513 ACL_Object *self = (ACL_Object*) obj;
515 if(acl_valid(self->acl) == -1) {
522 #ifdef HAVE_ACL_COPY_EXT
523 static PyObject* ACL_get_state(PyObject *obj, PyObject* args) {
524 ACL_Object *self = (ACL_Object*) obj;
529 size = acl_size(self->acl);
531 return PyErr_SetFromErrno(PyExc_IOError); /* LCOV_EXCL_LINE */
533 if((ret = PyBytes_FromStringAndSize(NULL, size)) == NULL)
535 buf = PyBytes_AsString(ret);
537 if((nsize = acl_copy_ext(buf, self->acl, size)) == -1) {
538 /* LCOV_EXCL_START */
540 return PyErr_SetFromErrno(PyExc_IOError);
547 static PyObject* ACL_set_state(PyObject *obj, PyObject* args) {
548 ACL_Object *self = (ACL_Object*) obj;
553 /* Parse the argument */
554 if (!PyArg_ParseTuple(args, "y#", &buf, &bufsize))
557 /* Try to import the external representation */
558 if((ptr = acl_copy_int(buf)) == NULL)
559 return PyErr_SetFromErrno(PyExc_IOError);
561 if(self->acl != NULL) {
562 /* Ignore errors in freeing the previous acl. We already
563 allocated the new acl, and the state of the previous one is
564 suspect if freeing failed (in Linux's libacl, deallocating
565 a valid ACL can't actually happen, so this path is
567 acl_free(self->acl); /* LCOV_EXCL_LINE */
578 /* tp_iter for the ACL type; since it can be iterated only
579 * destructively, the type is its iterator
581 static PyObject* ACL_iter(PyObject *obj) {
582 ACL_Object *self = (ACL_Object*)obj;
583 self->entry_id = ACL_FIRST_ENTRY;
588 /* the tp_iternext function for the ACL type */
589 static PyObject* ACL_iternext(PyObject *obj) {
590 ACL_Object *self = (ACL_Object*)obj;
591 acl_entry_t the_entry_t;
592 Entry_Object *the_entry_obj;
595 nerr = acl_get_entry(self->acl, self->entry_id, &the_entry_t);
596 self->entry_id = ACL_NEXT_ENTRY;
598 return PyErr_SetFromErrno(PyExc_IOError); /* LCOV_EXCL_LINE */
600 /* Docs says this is not needed */
601 /*PyErr_SetObject(PyExc_StopIteration, Py_None);*/
605 the_entry_obj = (Entry_Object*) PyType_GenericNew(&Entry_Type, NULL, NULL);
606 if(the_entry_obj == NULL)
609 the_entry_obj->entry = the_entry_t;
611 the_entry_obj->parent_acl = obj;
612 Py_INCREF(obj); /* For the reference we have in entry->parent */
614 return (PyObject*)the_entry_obj;
617 static char __ACL_delete_entry_doc__[] =
618 "delete_entry(entry)\n"
619 "Deletes an entry from the ACL.\n"
621 ".. note:: Only available with level 2.\n"
623 ":param entry: the Entry object which should be deleted; note that after\n"
624 " this function is called, that object is unusable any longer\n"
625 " and should be deleted\n"
628 /* Deletes an entry from the ACL */
629 static PyObject* ACL_delete_entry(PyObject *obj, PyObject *args) {
630 ACL_Object *self = (ACL_Object*)obj;
633 if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &e))
636 if (e->parent_acl != obj) {
637 PyErr_SetString(PyExc_ValueError,
638 "Can't remove un-owned entry");
641 if(acl_delete_entry(self->acl, e->entry) == -1)
642 return PyErr_SetFromErrno(PyExc_IOError);
647 static char __ACL_calc_mask_doc__[] =
648 "Compute the file group class mask.\n"
650 "The calc_mask() method calculates and sets the permissions \n"
651 "associated with the :py:data:`ACL_MASK` Entry of the ACL.\n"
652 "The value of the new permissions is the union of the permissions \n"
653 "granted by all entries of tag type :py:data:`ACL_GROUP`, \n"
654 ":py:data:`ACL_GROUP_OBJ`, or \n"
655 ":py:data:`ACL_USER`. If the ACL already contains an :py:data:`ACL_MASK`\n"
657 "permissions are overwritten; if it does not contain an \n"
658 ":py:data:`ACL_MASK` Entry, one is added.\n"
660 "The order of existing entries in the ACL is undefined after this \n"
664 /* Updates the mask entry in the ACL */
665 static PyObject* ACL_calc_mask(PyObject *obj, PyObject *args) {
666 ACL_Object *self = (ACL_Object*)obj;
668 if(acl_calc_mask(&self->acl) == -1)
669 return PyErr_SetFromErrno(PyExc_IOError);
674 static char __ACL_append_doc__[] =
676 "Append a new Entry to the ACL and return it.\n"
678 "This is a convenience function to create a new Entry \n"
679 "and append it to the ACL.\n"
680 "If a parameter of type Entry instance is given, the \n"
681 "entry will be a copy of that one (as if copied with \n"
682 ":py:func:`Entry.copy`), otherwise, the new entry will be empty.\n"
684 ":rtype: :py:class:`Entry`\n"
685 ":returns: the newly created entry\n"
688 /* Convenience method to create a new Entry */
689 static PyObject* ACL_append(PyObject *obj, PyObject *args) {
690 Entry_Object* newentry;
691 Entry_Object* oldentry = NULL;
694 if (!PyArg_ParseTuple(args, "|O!", &Entry_Type, &oldentry)) {
698 PyObject *new_arglist = Py_BuildValue("(O)", obj);
699 if (new_arglist == NULL) {
702 newentry = (Entry_Object*) PyObject_CallObject((PyObject*)&Entry_Type, new_arglist);
703 Py_DECREF(new_arglist);
704 if(newentry == NULL) {
708 if(oldentry != NULL) {
709 nret = acl_copy_entry(newentry->entry, oldentry->entry);
711 /* LCOV_EXCL_START */
713 return PyErr_SetFromErrno(PyExc_IOError);
718 return (PyObject*)newentry;
721 /***** Entry type *****/
731 /* Pre-declaring the function is more friendly to cpychecker, sigh. */
732 static int get_tag_qualifier(acl_entry_t entry, tag_qual *tq)
733 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
735 /* Helper function to get the tag and qualifier of an Entry at the
736 same time. This is "needed" because the acl_get_qualifier function
737 returns a pointer to different types, based on the tag value, and
738 thus it's not straightforward to get the right type.
740 It sets a Python exception if an error occurs, and returns -1 in
741 this case. If successful, the tag is set to the tag type, the
742 qualifier (if any) to either the uid or the gid entry in the
743 tag_qual structure, and the return value is 0.
745 static int get_tag_qualifier(acl_entry_t entry, tag_qual *tq) {
748 if(acl_get_tag_type(entry, &tq->tag) == -1) {
749 /* LCOV_EXCL_START */
750 PyErr_SetFromErrno(PyExc_IOError);
754 if (tq->tag == ACL_USER || tq->tag == ACL_GROUP) {
755 if((p = acl_get_qualifier(entry)) == NULL) {
756 /* LCOV_EXCL_START */
757 PyErr_SetFromErrno(PyExc_IOError);
761 if (tq->tag == ACL_USER) {
762 tq->uid = *(uid_t*)p;
764 tq->gid = *(gid_t*)p;
771 #define ENTRY_SET_CHECK(self, attr, value) \
772 if (value == NULL) { \
773 PyErr_SetString(PyExc_TypeError, \
774 attr " deletion is not supported"); \
778 /* Creation of a new Entry instance */
779 static PyObject* Entry_new(PyTypeObject* type, PyObject* args,
783 ACL_Object* parent = NULL;
785 if (!PyArg_ParseTuple(args, "O!", &ACL_Type, &parent))
788 newentry = PyType_GenericNew(type, args, keywds);
790 if(newentry == NULL) {
794 entry = (Entry_Object*)newentry;
796 if(acl_create_entry(&parent->acl, &entry->entry) == -1) {
797 /* LCOV_EXCL_START */
798 PyErr_SetFromErrno(PyExc_IOError);
804 entry->parent_acl = (PyObject*)parent;
808 /* Initialization of a new Entry instance */
809 static int Entry_init(PyObject* obj, PyObject* args, PyObject *keywds) {
810 Entry_Object* self = (Entry_Object*) obj;
811 ACL_Object* parent = NULL;
813 if (!PyArg_ParseTuple(args, "O!", &ACL_Type, &parent))
816 if ((PyObject*)parent != self->parent_acl) {
817 PyErr_SetString(PyExc_ValueError,
818 "Can't reinitialize with a different parent");
824 /* Free the Entry instance */
825 static void Entry_dealloc(PyObject* obj) {
826 Entry_Object *self = (Entry_Object*) obj;
827 PyObject *err_type, *err_value, *err_traceback;
828 int have_error = PyErr_Occurred() ? 1 : 0;
831 PyErr_Fetch(&err_type, &err_value, &err_traceback);
832 if(self->parent_acl != NULL) {
833 Py_DECREF(self->parent_acl);
834 self->parent_acl = NULL;
837 PyErr_Restore(err_type, err_value, err_traceback);
841 /* Converts the entry to a text format */
842 static PyObject* Entry_str(PyObject *obj) {
843 PyObject *format, *kind;
844 Entry_Object *self = (Entry_Object*) obj;
847 if(get_tag_qualifier(self->entry, &tq) < 0) {
851 format = PyUnicode_FromString("ACL entry for ");
855 case ACL_UNDEFINED_TAG:
856 kind = PyUnicode_FromString("undefined type");
859 kind = PyUnicode_FromString("the owner");
862 kind = PyUnicode_FromString("the group");
865 kind = PyUnicode_FromString("the others");
868 /* FIXME: here and in the group case, we're formatting with
869 unsigned, because there's no way to automatically determine
870 the signed-ness of the types; on Linux(glibc) they're
871 unsigned, so we'll go along with that */
872 kind = PyUnicode_FromFormat("user with uid %u", tq.uid);
875 kind = PyUnicode_FromFormat("group with gid %u", tq.gid);
878 kind = PyUnicode_FromString("the mask");
880 default: /* LCOV_EXCL_START */
881 kind = PyUnicode_FromString("UNKNOWN_TAG_TYPE!");
886 /* LCOV_EXCL_START */
891 PyObject *ret = PyUnicode_Concat(format, kind);
897 /* Sets the tag type of the entry */
898 static int Entry_set_tag_type(PyObject* obj, PyObject* value, void* arg) {
899 Entry_Object *self = (Entry_Object*) obj;
901 ENTRY_SET_CHECK(self, "tag type", value);
903 if(!PyLong_Check(value)) {
904 PyErr_SetString(PyExc_TypeError,
905 "tag type must be integer");
908 if(acl_set_tag_type(self->entry, (acl_tag_t)PyLong_AsLong(value)) == -1) {
909 PyErr_SetFromErrno(PyExc_IOError);
916 /* Returns the tag type of the entry */
917 static PyObject* Entry_get_tag_type(PyObject *obj, void* arg) {
918 Entry_Object *self = (Entry_Object*) obj;
921 if(acl_get_tag_type(self->entry, &value) == -1) {
922 /* LCOV_EXCL_START */
923 PyErr_SetFromErrno(PyExc_IOError);
928 return PyLong_FromLong(value);
931 /* Sets the qualifier (either uid_t or gid_t) for the entry,
932 * usable only if the tag type if ACL_USER or ACL_GROUP
934 static int Entry_set_qualifier(PyObject* obj, PyObject* value, void* arg) {
935 Entry_Object *self = (Entry_Object*) obj;
936 unsigned long uidgid;
942 ENTRY_SET_CHECK(self, "qualifier", value);
944 if(!PyLong_Check(value)) {
945 PyErr_SetString(PyExc_TypeError,
946 "qualifier must be integer");
949 /* This is the negative value check, and larger than long
950 check. If uid_t/gid_t are long-sized, this is enough to check
951 for both over and underflow. */
952 if((uidgid = PyLong_AsUnsignedLong(value)) == (unsigned long) -1) {
953 if(PyErr_Occurred() != NULL) {
957 /* Due to how acl_set_qualifier takes its argument, we have to do
958 this ugly dance with two variables and a pointer that will
959 point to one of them. */
960 if(acl_get_tag_type(self->entry, &tag) == -1) {
961 /* LCOV_EXCL_START */
962 PyErr_SetFromErrno(PyExc_IOError);
968 /* This is an extra overflow check, in case uid_t/gid_t are
969 int-sized (and int size smaller than long size). */
972 if((unsigned long)uid != uidgid) {
973 PyErr_SetString(PyExc_OverflowError, "Can't assign given qualifier");
980 if((unsigned long)gid != uidgid) {
981 PyErr_SetString(PyExc_OverflowError, "Can't assign given qualifier");
988 PyErr_SetString(PyExc_TypeError,
989 "Can only set qualifiers on ACL_USER or ACL_GROUP entries");
992 if(acl_set_qualifier(self->entry, p) == -1) {
993 /* LCOV_EXCL_START */
994 PyErr_SetFromErrno(PyExc_IOError);
1002 /* Returns the qualifier of the entry */
1003 static PyObject* Entry_get_qualifier(PyObject *obj, void* arg) {
1004 Entry_Object *self = (Entry_Object*) obj;
1005 unsigned long value;
1008 if(get_tag_qualifier(self->entry, &tq) < 0) {
1011 if (tq.tag == ACL_USER) {
1013 } else if (tq.tag == ACL_GROUP) {
1016 PyErr_SetString(PyExc_TypeError,
1017 "Given entry doesn't have an user or"
1021 return PyLong_FromUnsignedLong(value);
1024 /* Returns the parent ACL of the entry */
1025 static PyObject* Entry_get_parent(PyObject *obj, void* arg) {
1026 Entry_Object *self = (Entry_Object*) obj;
1028 Py_INCREF(self->parent_acl);
1029 return self->parent_acl;
1032 /* Returns the a new Permset representing the permset of the entry
1033 * FIXME: Should return a new reference to the same object, which
1034 * should be created at init time!
1036 static PyObject* Entry_get_permset(PyObject *obj, void* arg) {
1039 PyObject *perm_arglist = Py_BuildValue("(O)", obj);
1040 if (perm_arglist == NULL) {
1043 p = PyObject_CallObject((PyObject*)&Permset_Type, perm_arglist);
1044 Py_DECREF(perm_arglist);
1048 /* Sets the permset of the entry to the passed Permset */
1049 static int Entry_set_permset(PyObject* obj, PyObject* value, void* arg) {
1050 Entry_Object *self = (Entry_Object*)obj;
1053 ENTRY_SET_CHECK(self, "permset", value);
1055 if(!PyObject_IsInstance(value, (PyObject*)&Permset_Type)) {
1056 PyErr_SetString(PyExc_TypeError, "argument 1 must be posix1e.Permset");
1059 p = (Permset_Object*)value;
1060 if(acl_set_permset(self->entry, p->permset) == -1) {
1061 /* LCOV_EXCL_START */
1062 PyErr_SetFromErrno(PyExc_IOError);
1064 /* LCOV_EXCL_STOP */
1069 static char __Entry_copy_doc__[] =
1071 "Copies an ACL entry.\n"
1073 "This method sets all the parameters to those of another\n"
1074 "entry (either of the same ACL or belonging to another ACL).\n"
1076 ":param Entry src: instance of type Entry\n"
1079 /* Sets all the entry parameters to another entry */
1080 static PyObject* Entry_copy(PyObject *obj, PyObject *args) {
1081 Entry_Object *self = (Entry_Object*)obj;
1082 Entry_Object *other;
1084 if(!PyArg_ParseTuple(args, "O!", &Entry_Type, &other))
1087 if(acl_copy_entry(self->entry, other->entry) == -1)
1088 return PyErr_SetFromErrno(PyExc_IOError); /* LCOV_EXCL_LINE */
1093 /**** Permset type *****/
1095 /* Creation of a new Permset instance */
1096 static PyObject* Permset_new(PyTypeObject* type, PyObject* args,
1098 PyObject* newpermset;
1099 Permset_Object* permset;
1100 Entry_Object* parent = NULL;
1102 if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &parent)) {
1106 newpermset = PyType_GenericNew(type, args, keywds);
1108 if(newpermset == NULL) {
1112 permset = (Permset_Object*)newpermset;
1114 if(acl_get_permset(parent->entry, &permset->permset) == -1) {
1115 PyErr_SetFromErrno(PyExc_IOError);
1116 Py_DECREF(newpermset);
1120 permset->parent_entry = (PyObject*)parent;
1126 /* Initialization of a new Permset instance */
1127 static int Permset_init(PyObject* obj, PyObject* args, PyObject *keywds) {
1128 Permset_Object* self = (Permset_Object*) obj;
1129 Entry_Object* parent = NULL;
1131 if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &parent))
1134 if ((PyObject*)parent != self->parent_entry) {
1135 PyErr_SetString(PyExc_ValueError,
1136 "Can't reinitialize with a different parent");
1143 /* Free the Permset instance */
1144 static void Permset_dealloc(PyObject* obj) {
1145 Permset_Object *self = (Permset_Object*) obj;
1146 PyObject *err_type, *err_value, *err_traceback;
1147 int have_error = PyErr_Occurred() ? 1 : 0;
1150 PyErr_Fetch(&err_type, &err_value, &err_traceback);
1151 if(self->parent_entry != NULL) {
1152 Py_DECREF(self->parent_entry);
1153 self->parent_entry = NULL;
1156 PyErr_Restore(err_type, err_value, err_traceback);
1160 /* Permset string representation */
1161 static PyObject* Permset_str(PyObject *obj) {
1162 Permset_Object *self = (Permset_Object*) obj;
1165 pstr[0] = get_perm(self->permset, ACL_READ) ? 'r' : '-';
1166 pstr[1] = get_perm(self->permset, ACL_WRITE) ? 'w' : '-';
1167 pstr[2] = get_perm(self->permset, ACL_EXECUTE) ? 'x' : '-';
1168 return PyUnicode_FromStringAndSize(pstr, 3);
1171 static char __Permset_clear_doc__[] =
1172 "Clears all permissions from the permission set.\n"
1175 /* Clears all permissions from the permset */
1176 static PyObject* Permset_clear(PyObject* obj, PyObject* args) {
1177 Permset_Object *self = (Permset_Object*) obj;
1179 if(acl_clear_perms(self->permset) == -1)
1180 return PyErr_SetFromErrno(PyExc_IOError); /* LCOV_EXCL_LINE */
1185 static PyObject* Permset_get_right(PyObject *obj, void* arg) {
1186 Permset_Object *self = (Permset_Object*) obj;
1188 if(get_perm(self->permset, *(acl_perm_t*)arg)) {
1195 static int Permset_set_right(PyObject* obj, PyObject* value, void* arg) {
1196 Permset_Object *self = (Permset_Object*) obj;
1200 if(!PyLong_Check(value)) {
1201 PyErr_SetString(PyExc_ValueError, "invalid argument, an integer"
1205 on = PyLong_AsLong(value);
1207 nerr = acl_add_perm(self->permset, *(acl_perm_t*)arg);
1209 nerr = acl_delete_perm(self->permset, *(acl_perm_t*)arg);
1211 /* LCOV_EXCL_START */
1212 PyErr_SetFromErrno(PyExc_IOError);
1214 /* LCOV_EXCL_STOP */
1219 static char __Permset_add_doc__[] =
1221 "Add a permission to the permission set.\n"
1223 "This function adds the permission contained in \n"
1224 "the argument perm to the permission set. An attempt \n"
1225 "to add a permission that is already contained in the \n"
1226 "permission set is not considered an error.\n"
1228 ":param perm: a permission (:py:data:`ACL_WRITE`, :py:data:`ACL_READ`,\n"
1229 " :py:data:`ACL_EXECUTE`, ...)\n"
1230 ":raises IOError: in case the argument is not a valid descriptor\n"
1233 static PyObject* Permset_add(PyObject* obj, PyObject* args) {
1234 Permset_Object *self = (Permset_Object*) obj;
1237 if (!PyArg_ParseTuple(args, "i", &right))
1240 if(acl_add_perm(self->permset, (acl_perm_t) right) == -1)
1241 return PyErr_SetFromErrno(PyExc_IOError); /* LCOV_EXCL_LINE */
1246 static char __Permset_delete_doc__[] =
1248 "Delete a permission from the permission set.\n"
1250 "This function deletes the permission contained in \n"
1251 "the argument perm from the permission set. An attempt \n"
1252 "to delete a permission that is not contained in the \n"
1253 "permission set is not considered an error.\n"
1255 ":param perm: a permission (:py:data:`ACL_WRITE`, :py:data:`ACL_READ`,\n"
1256 " :py:data:`ACL_EXECUTE`, ...)\n"
1257 ":raises IOError: in case the argument is not a valid descriptor\n"
1260 static PyObject* Permset_delete(PyObject* obj, PyObject* args) {
1261 Permset_Object *self = (Permset_Object*) obj;
1264 if (!PyArg_ParseTuple(args, "i", &right))
1267 if(acl_delete_perm(self->permset, (acl_perm_t) right) == -1)
1268 return PyErr_SetFromErrno(PyExc_IOError); /* LCOV_EXCL_LINE */
1273 static char __Permset_test_doc__[] =
1275 "Test if a permission exists in the permission set.\n"
1277 "The test() function tests if the permission represented by\n"
1278 "the argument perm exists in the permission set.\n"
1280 ":param perm: a permission (:py:data:`ACL_WRITE`, :py:data:`ACL_READ`,\n"
1281 " :py:data:`ACL_EXECUTE`, ...)\n"
1283 ":raises IOError: in case the argument is not a valid descriptor\n"
1286 static PyObject* Permset_test(PyObject* obj, PyObject* args) {
1287 Permset_Object *self = (Permset_Object*) obj;
1291 if (!PyArg_ParseTuple(args, "i", &right))
1294 ret = get_perm(self->permset, (acl_perm_t) right);
1296 return PyErr_SetFromErrno(PyExc_IOError); /* LCOV_EXCL_LINE */
1307 static char __ACL_Type_doc__[] =
1308 "Type which represents a POSIX ACL\n"
1310 ".. note:: only one keyword parameter should be provided\n"
1312 ":param string/bytes/path-like file: creates an ACL representing\n"
1313 " the access ACL of the specified file or directory.\n"
1314 ":param string/bytes/path-like filedef: creates an ACL representing\n"
1315 " the default ACL of the given directory.\n"
1316 ":param int/iostream fd: creates an ACL representing\n"
1317 " the access ACL of the given file descriptor.\n"
1318 ":param string text: creates an ACL from a \n"
1319 " textual description; note the ACL must be valid, which\n"
1320 " means including a mask for extended ACLs, similar to\n"
1321 " ``setfacl --no-mask``\n"
1322 ":param ACL acl: creates a copy of an existing ACL instance.\n"
1323 ":param int mode: creates an ACL from a numeric mode\n"
1324 " (e.g. ``mode=0644``); this is valid only when the C library\n"
1325 " provides the ``acl_from_mode call``, and\n"
1326 " note that no validation is done on the given value.\n"
1327 ":param bytes data: creates an ACL from a serialised form,\n"
1328 " as provided by calling ``__getstate__()`` on an existing ACL\n"
1330 "If no parameters are passed, an empty ACL will be created; this\n"
1331 "makes sense only when your OS supports ACL modification\n"
1332 "(i.e. it implements full POSIX.1e support), otherwise the ACL won't\n"
1336 /* ACL type methods */
1337 static PyMethodDef ACL_methods[] = {
1338 {"applyto", ACL_applyto, METH_VARARGS, __applyto_doc__},
1339 {"valid", ACL_valid, METH_NOARGS, __valid_doc__},
1341 {"to_any_text", (PyCFunction)ACL_to_any_text, METH_VARARGS | METH_KEYWORDS,
1342 __to_any_text_doc__},
1343 {"check", ACL_check, METH_NOARGS, __check_doc__},
1344 {"equiv_mode", ACL_equiv_mode, METH_NOARGS, __equiv_mode_doc__},
1346 #ifdef HAVE_ACL_COPY_EXT
1347 {"__getstate__", ACL_get_state, METH_NOARGS,
1348 "Dumps the ACL to an external format."},
1349 {"__setstate__", ACL_set_state, METH_VARARGS,
1350 "Loads the ACL from an external format."},
1353 {"delete_entry", ACL_delete_entry, METH_VARARGS, __ACL_delete_entry_doc__},
1354 {"calc_mask", ACL_calc_mask, METH_NOARGS, __ACL_calc_mask_doc__},
1355 {"append", ACL_append, METH_VARARGS, __ACL_append_doc__},
1357 {NULL, NULL, 0, NULL}
1361 /* The definition of the ACL Type */
1362 static PyTypeObject ACL_Type = {
1363 PyVarObject_HEAD_INIT(NULL, 0)
1364 .tp_name = "posix1e.ACL",
1365 .tp_basicsize = sizeof(ACL_Object),
1367 .tp_dealloc = ACL_dealloc,
1369 .tp_flags = Py_TPFLAGS_DEFAULT,
1370 .tp_doc = __ACL_Type_doc__,
1372 .tp_richcompare = ACL_richcompare,
1375 .tp_iter = ACL_iter,
1376 .tp_iternext = ACL_iternext,
1378 .tp_methods = ACL_methods,
1379 .tp_init = ACL_init,
1385 /* Entry type methods */
1386 static PyMethodDef Entry_methods[] = {
1387 {"copy", Entry_copy, METH_VARARGS, __Entry_copy_doc__},
1388 {NULL, NULL, 0, NULL}
1391 static char __Entry_tagtype_doc__[] =
1392 "The tag type of the current entry\n"
1395 " - :py:data:`ACL_UNDEFINED_TAG`\n"
1396 " - :py:data:`ACL_USER_OBJ`\n"
1397 " - :py:data:`ACL_USER`\n"
1398 " - :py:data:`ACL_GROUP_OBJ`\n"
1399 " - :py:data:`ACL_GROUP`\n"
1400 " - :py:data:`ACL_MASK`\n"
1401 " - :py:data:`ACL_OTHER`\n"
1404 static char __Entry_qualifier_doc__[] =
1405 "The qualifier of the current entry\n"
1407 "If the tag type is :py:data:`ACL_USER`, this should be a user id.\n"
1408 "If the tag type if :py:data:`ACL_GROUP`, this should be a group id.\n"
1409 "Else it doesn't matter.\n"
1412 static char __Entry_parent_doc__[] =
1413 "The parent ACL of this entry\n"
1416 static char __Entry_permset_doc__[] =
1417 "The permission set of this ACL entry\n"
1421 static PyGetSetDef Entry_getsets[] = {
1422 {"tag_type", Entry_get_tag_type, Entry_set_tag_type,
1423 __Entry_tagtype_doc__},
1424 {"qualifier", Entry_get_qualifier, Entry_set_qualifier,
1425 __Entry_qualifier_doc__},
1426 {"parent", Entry_get_parent, NULL, __Entry_parent_doc__},
1427 {"permset", Entry_get_permset, Entry_set_permset, __Entry_permset_doc__},
1431 static char __Entry_Type_doc__[] =
1432 "Type which represents an entry in an ACL.\n"
1434 "The type exists only if the OS has full support for POSIX.1e\n"
1435 "Can be created either by:\n"
1437 " >>> e = posix1e.Entry(myACL) # this creates a new entry in the ACL\n"
1438 " >>> e = myACL.append() # another way for doing the same thing\n"
1442 " >>> for entry in myACL:\n"
1443 " ... print entry\n"
1445 "Note that the Entry keeps a reference to its ACL, so even if \n"
1446 "you delete the ACL, it won't be cleaned up and will continue to \n"
1447 "exist until its Entry(ies) will be deleted.\n"
1449 /* The definition of the Entry Type */
1450 static PyTypeObject Entry_Type = {
1451 PyVarObject_HEAD_INIT(NULL, 0)
1452 .tp_name = "posix1e.Entry",
1453 .tp_basicsize = sizeof(Entry_Object),
1455 .tp_dealloc = Entry_dealloc,
1456 .tp_str = Entry_str,
1457 .tp_flags = Py_TPFLAGS_DEFAULT,
1458 .tp_doc = __Entry_Type_doc__,
1459 .tp_methods = Entry_methods,
1460 .tp_getset = Entry_getsets,
1461 .tp_init = Entry_init,
1465 /* Permset type methods */
1466 static PyMethodDef Permset_methods[] = {
1467 {"clear", Permset_clear, METH_NOARGS, __Permset_clear_doc__, },
1468 {"add", Permset_add, METH_VARARGS, __Permset_add_doc__, },
1469 {"delete", Permset_delete, METH_VARARGS, __Permset_delete_doc__, },
1470 {"test", Permset_test, METH_VARARGS, __Permset_test_doc__, },
1471 {NULL, NULL, 0, NULL}
1474 static char __Permset_execute_doc__[] =
1475 "Execute permission property\n"
1477 "This is a convenience method of retrieving and setting the execute\n"
1478 "permission in the permission set; the \n"
1479 "same effect can be achieved using the functions\n"
1480 "add(), test(), delete(), and those can take any \n"
1481 "permission defined by your platform.\n"
1484 static char __Permset_read_doc__[] =
1485 "Read permission property\n"
1487 "This is a convenience method of retrieving and setting the read\n"
1488 "permission in the permission set; the \n"
1489 "same effect can be achieved using the functions\n"
1490 "add(), test(), delete(), and those can take any \n"
1491 "permission defined by your platform.\n"
1494 static char __Permset_write_doc__[] =
1495 "Write permission property\n"
1497 "This is a convenience method of retrieving and setting the write\n"
1498 "permission in the permission set; the \n"
1499 "same effect can be achieved using the functions\n"
1500 "add(), test(), delete(), and those can take any \n"
1501 "permission defined by your platform.\n"
1504 /* Permset getset */
1505 static PyGetSetDef Permset_getsets[] = {
1506 {"execute", Permset_get_right, Permset_set_right,
1507 __Permset_execute_doc__, &holder_ACL_EXECUTE},
1508 {"read", Permset_get_right, Permset_set_right,
1509 __Permset_read_doc__, &holder_ACL_READ},
1510 {"write", Permset_get_right, Permset_set_right,
1511 __Permset_write_doc__, &holder_ACL_WRITE},
1515 static char __Permset_Type_doc__[] =
1516 "Type which represents the permission set in an ACL entry\n"
1518 "The type exists only if the OS has full support for POSIX.1e\n"
1519 "Can be retrieved either by:\n\n"
1520 ">>> perms = myEntry.permset\n"
1523 ">>> perms = posix1e.Permset(myEntry)\n"
1525 "Note that the Permset keeps a reference to its Entry, so even if \n"
1526 "you delete the entry, it won't be cleaned up and will continue to \n"
1527 "exist until its Permset will be deleted.\n"
1530 /* The definition of the Permset Type */
1531 static PyTypeObject Permset_Type = {
1532 PyVarObject_HEAD_INIT(NULL, 0)
1533 .tp_name = "posix1e.Permset",
1534 .tp_basicsize = sizeof(Permset_Object),
1536 .tp_dealloc = Permset_dealloc,
1537 .tp_str = Permset_str,
1538 .tp_flags = Py_TPFLAGS_DEFAULT,
1539 .tp_doc = __Permset_Type_doc__,
1540 .tp_methods = Permset_methods,
1541 .tp_getset = Permset_getsets,
1542 .tp_init = Permset_init,
1543 .tp_new = Permset_new,
1548 /* Module methods */
1550 static char __deletedef_doc__[] =
1551 "delete_default(path)\n"
1552 "Delete the default ACL from a directory.\n"
1554 "This function deletes the default ACL associated with\n"
1555 "a directory (the ACL which will be ANDed with the mode\n"
1556 "parameter to the open, creat functions).\n"
1558 ":param string path: the directory whose default ACL should be deleted\n"
1561 /* Deletes the default ACL from a directory */
1562 static PyObject* aclmodule_delete_default(PyObject* obj, PyObject* args) {
1565 /* Parse the arguments */
1566 if (!PyArg_ParseTuple(args, "et", NULL, &filename))
1569 if(acl_delete_def_file(filename) == -1) {
1570 return PyErr_SetFromErrnoWithFilename(PyExc_IOError, filename);
1577 static char __has_extended_doc__[] =
1578 "has_extended(item)\n"
1579 "Check if a file or file handle has an extended ACL.\n"
1581 ":param item: either a file name or a file-like object or an integer;\n"
1582 " it represents the file-system object on which to act\n"
1585 /* Check for extended ACL a file or fd */
1586 static PyObject* aclmodule_has_extended(PyObject* obj, PyObject* args) {
1587 PyObject *item, *tmp;
1591 if (!PyArg_ParseTuple(args, "O", &item))
1594 if((fd = PyObject_AsFileDescriptor(item)) != -1) {
1595 if((nret = acl_extended_fd(fd)) == -1) {
1596 PyErr_SetFromErrno(PyExc_IOError);
1599 // PyObject_AsFileDescriptor sets an error when failing, so clear
1600 // it such that further code works; some method lookups fail if an
1601 // error already occured when called, which breaks at least
1602 // PyOS_FSPath (called by FSConverter).
1604 if(PyUnicode_FSConverter(item, &tmp)) {
1605 char *filename = PyBytes_AS_STRING(tmp);
1606 if ((nret = acl_extended_file(filename)) == -1) {
1607 PyErr_SetFromErrnoWithFilename(PyExc_IOError, filename);
1618 return PyBool_FromLong(nret);
1623 /* The module methods */
1624 static PyMethodDef aclmodule_methods[] = {
1625 {"delete_default", aclmodule_delete_default, METH_VARARGS,
1628 {"has_extended", aclmodule_has_extended, METH_VARARGS,
1629 __has_extended_doc__},
1631 {NULL, NULL, 0, NULL}
1634 static char __posix1e_doc__[] =
1635 "POSIX.1e ACLs manipulation\n"
1636 "==========================\n"
1638 "This module provides support for manipulating POSIX.1e ACLS\n"
1640 "Depending on the operating system support for POSIX.1e, \n"
1641 "the ACL type will have more or less capabilities:\n\n"
1642 " - level 1, only basic support, you can create\n"
1643 " ACLs from files and text descriptions;\n"
1644 " once created, the type is immutable\n"
1645 " - level 2, complete support, you can alter\n"
1646 " the ACL once it is created\n"
1648 "Also, in level 2, more types are available, corresponding\n"
1649 "to acl_entry_t (the Entry type), acl_permset_t (the Permset type).\n"
1651 "The existence of level 2 support and other extensions can be\n"
1652 "checked by the constants:\n\n"
1653 " - :py:data:`HAS_ACL_ENTRY` for level 2 and the Entry/Permset classes\n"
1654 " - :py:data:`HAS_ACL_FROM_MODE` for ``ACL(mode=...)`` usage\n"
1655 " - :py:data:`HAS_ACL_CHECK` for the :py:func:`ACL.check` function\n"
1656 " - :py:data:`HAS_EXTENDED_CHECK` for the module-level\n"
1657 " :py:func:`has_extended` function\n"
1658 " - :py:data:`HAS_EQUIV_MODE` for the :py:func:`ACL.equiv_mode` method\n"
1659 " - :py:data:`HAS_COPY_EXT` for the :py:func:`ACL.__getstate__` and\n"
1660 " :py:func:`ACL.__setstate__` functions (pickle protocol)\n"
1664 ">>> import posix1e\n"
1665 ">>> acl1 = posix1e.ACL(file=\"file.txt\") \n"
1671 ">>> b = posix1e.ACL(text=\"u::rx,g::-,o::-\")\n"
1677 ">>> b.applyto(\"file.txt\")\n"
1678 ">>> print posix1e.ACL(file=\"file.txt\")\n"
1684 ".. py:data:: ACL_USER\n\n"
1685 " Denotes a specific user entry in an ACL.\n"
1687 ".. py:data:: ACL_USER_OBJ\n\n"
1688 " Denotes the user owner entry in an ACL.\n"
1690 ".. py:data:: ACL_GROUP\n\n"
1691 " Denotes the a group entry in an ACL.\n"
1693 ".. py:data:: ACL_GROUP_OBJ\n\n"
1694 " Denotes the group owner entry in an ACL.\n"
1696 ".. py:data:: ACL_OTHER\n\n"
1697 " Denotes the 'others' entry in an ACL.\n"
1699 ".. py:data:: ACL_MASK\n\n"
1700 " Denotes the mask entry in an ACL, representing the maximum\n"
1701 " access granted other users, the owner group and other groups.\n"
1703 ".. py:data:: ACL_UNDEFINED_TAG\n\n"
1704 " An undefined tag in an ACL.\n"
1706 ".. py:data:: ACL_READ\n\n"
1707 " Read permission in a permission set.\n"
1709 ".. py:data:: ACL_WRITE\n\n"
1710 " Write permission in a permission set.\n"
1712 ".. py:data:: ACL_EXECUTE\n\n"
1713 " Execute permission in a permission set.\n"
1715 ".. py:data:: HAS_ACL_ENTRY\n\n"
1716 " denotes support for level 2 and the Entry/Permset classes\n"
1718 ".. py:data:: HAS_ACL_FROM_MODE\n\n"
1719 " denotes support for building an ACL from an octal mode\n"
1721 ".. py:data:: HAS_ACL_CHECK\n\n"
1722 " denotes support for extended checks of an ACL's validity\n"
1724 ".. py:data:: HAS_EXTENDED_CHECK\n\n"
1725 " denotes support for checking whether an ACL is basic or extended\n"
1727 ".. py:data:: HAS_EQUIV_MODE\n\n"
1728 " denotes support for the equiv_mode function\n"
1730 ".. py:data:: HAS_COPY_EXT\n\n"
1731 " denotes support for __getstate__()/__setstate__() on an ACL\n"
1735 static struct PyModuleDef posix1emodule = {
1736 PyModuleDef_HEAD_INIT,
1737 .m_name = "posix1e",
1738 .m_doc = __posix1e_doc__,
1740 .m_methods = aclmodule_methods,
1744 PyInit_posix1e(void)
1748 if(PyType_Ready(&ACL_Type) < 0)
1752 if(PyType_Ready(&Entry_Type) < 0)
1755 if(PyType_Ready(&Permset_Type) < 0)
1759 m = PyModule_Create(&posix1emodule);
1763 d = PyModule_GetDict(m);
1767 Py_INCREF(&ACL_Type);
1768 if (PyDict_SetItemString(d, "ACL",
1769 (PyObject *) &ACL_Type) < 0)
1772 /* 23.3.6 acl_type_t values */
1773 PyModule_AddIntConstant(m, "ACL_TYPE_ACCESS", ACL_TYPE_ACCESS);
1774 PyModule_AddIntConstant(m, "ACL_TYPE_DEFAULT", ACL_TYPE_DEFAULT);
1778 Py_INCREF(&Entry_Type);
1779 if (PyDict_SetItemString(d, "Entry",
1780 (PyObject *) &Entry_Type) < 0)
1783 Py_INCREF(&Permset_Type);
1784 if (PyDict_SetItemString(d, "Permset",
1785 (PyObject *) &Permset_Type) < 0)
1788 /* 23.2.2 acl_perm_t values */
1789 PyModule_AddIntConstant(m, "ACL_READ", ACL_READ);
1790 PyModule_AddIntConstant(m, "ACL_WRITE", ACL_WRITE);
1791 PyModule_AddIntConstant(m, "ACL_EXECUTE", ACL_EXECUTE);
1793 /* 23.2.5 acl_tag_t values */
1794 PyModule_AddIntConstant(m, "ACL_UNDEFINED_TAG", ACL_UNDEFINED_TAG);
1795 PyModule_AddIntConstant(m, "ACL_USER_OBJ", ACL_USER_OBJ);
1796 PyModule_AddIntConstant(m, "ACL_USER", ACL_USER);
1797 PyModule_AddIntConstant(m, "ACL_GROUP_OBJ", ACL_GROUP_OBJ);
1798 PyModule_AddIntConstant(m, "ACL_GROUP", ACL_GROUP);
1799 PyModule_AddIntConstant(m, "ACL_MASK", ACL_MASK);
1800 PyModule_AddIntConstant(m, "ACL_OTHER", ACL_OTHER);
1802 /* Document extended functionality via easy-to-use constants */
1803 PyModule_AddIntConstant(m, "HAS_ACL_ENTRY", 1);
1805 PyModule_AddIntConstant(m, "HAS_ACL_ENTRY", 0);
1809 /* Linux libacl specific acl_to_any_text constants */
1810 PyModule_AddIntConstant(m, "TEXT_ABBREVIATE", TEXT_ABBREVIATE);
1811 PyModule_AddIntConstant(m, "TEXT_NUMERIC_IDS", TEXT_NUMERIC_IDS);
1812 PyModule_AddIntConstant(m, "TEXT_SOME_EFFECTIVE", TEXT_SOME_EFFECTIVE);
1813 PyModule_AddIntConstant(m, "TEXT_ALL_EFFECTIVE", TEXT_ALL_EFFECTIVE);
1814 PyModule_AddIntConstant(m, "TEXT_SMART_INDENT", TEXT_SMART_INDENT);
1816 /* Linux libacl specific acl_check constants */
1817 PyModule_AddIntConstant(m, "ACL_MULTI_ERROR", ACL_MULTI_ERROR);
1818 PyModule_AddIntConstant(m, "ACL_DUPLICATE_ERROR", ACL_DUPLICATE_ERROR);
1819 PyModule_AddIntConstant(m, "ACL_MISS_ERROR", ACL_MISS_ERROR);
1820 PyModule_AddIntConstant(m, "ACL_ENTRY_ERROR", ACL_ENTRY_ERROR);
1822 #define LINUX_EXT_VAL 1
1824 #define LINUX_EXT_VAL 0
1826 /* declare the Linux extensions */
1827 PyModule_AddIntConstant(m, "HAS_ACL_FROM_MODE", LINUX_EXT_VAL);
1828 PyModule_AddIntConstant(m, "HAS_ACL_CHECK", LINUX_EXT_VAL);
1829 PyModule_AddIntConstant(m, "HAS_EXTENDED_CHECK", LINUX_EXT_VAL);
1830 PyModule_AddIntConstant(m, "HAS_EQUIV_MODE", LINUX_EXT_VAL);
1832 PyModule_AddIntConstant(m, "HAS_COPY_EXT",
1833 #ifdef HAVE_ACL_COPY_EXT