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
25 #include <sys/types.h>
29 #include <acl/libacl.h>
30 #define get_perm acl_get_perm
32 #define get_perm acl_get_perm_np
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)))
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)
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))
53 #define CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION
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);
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);
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,
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;
91 PyObject *parent_acl; /* The parent acl, so it won't run out on us */
97 PyObject *parent_entry; /* The parent entry, so it won't run out on us */
98 acl_permset_t permset;
103 /* Creation of a new ACL instance */
104 static PyObject* ACL_new(PyTypeObject* type, PyObject* args,
109 newacl = type->tp_alloc(type, 0);
114 acl = (ACL_Object*) newacl;
116 acl->acl = acl_init(0);
117 if (acl->acl == NULL) {
118 PyErr_SetFromErrno(PyExc_IOError);
123 acl->entry_id = ACL_FIRST_ENTRY;
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;
133 static char *kwlist[] = { "file", "fd", "text", "acl", "filedef",
135 char *format = "|etisO!si";
138 static char *kwlist[] = { "file", "fd", "text", "acl", "filedef", NULL };
139 char *format = "|etisO!s";
142 char *filedef = NULL;
145 ACL_Object* thesrc = NULL;
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"
153 if(!PyArg_ParseTupleAndKeywords(args, keywds, format, kwlist,
154 NULL, &file, &fd, &text, &ACL_Type,
162 /* Free the old acl_t without checking for error, we don't
164 if(self->acl != NULL)
168 self->acl = acl_get_file(file, ACL_TYPE_ACCESS);
169 else if(text != NULL)
170 self->acl = acl_from_text(text);
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);
179 self->acl = acl_from_mode(mode);
182 self->acl = acl_init(0);
184 if(self->acl == NULL) {
185 PyErr_SetFromErrno(PyExc_IOError);
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;
199 PyErr_Fetch(&err_type, &err_value, &err_traceback);
200 if(self->acl != NULL && acl_free(self->acl) != 0)
201 PyErr_WriteUnraisable(obj);
203 PyErr_Restore(err_type, err_value, err_traceback);
207 /* Converts the acl to a text format */
208 static PyObject* ACL_str(PyObject *obj) {
210 ACL_Object *self = (ACL_Object*) obj;
213 text = acl_to_text(self->acl, NULL);
215 return PyErr_SetFromErrno(PyExc_IOError);
217 ret = PyUnicode_FromString(text);
218 if(acl_free(text) != 0) {
220 return PyErr_SetFromErrno(PyExc_IOError);
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"
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"
234 ":param string prefix: if given, this string will be pre-pended to\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"
253 /* Converts the acl to a custom text format */
254 static PyObject* ACL_to_any_text(PyObject *obj, PyObject *args,
257 ACL_Object *self = (ACL_Object*) obj;
259 const char *arg_prefix = NULL;
260 char arg_separator = '\n';
262 static char *kwlist[] = {"prefix", "separator", "options", NULL};
264 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|sci", kwlist, &arg_prefix,
265 &arg_separator, &arg_options))
268 text = acl_to_any_text(self->acl, arg_prefix, arg_separator, arg_options);
270 return PyErr_SetFromErrno(PyExc_IOError);
272 ret = PyBytes_FromString(text);
273 if(acl_free(text) != 0) {
275 return PyErr_SetFromErrno(PyExc_IOError);
280 static char __check_doc__[] =
281 "Check the ACL validity.\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"
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"
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"
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"
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"
303 /* The acl_check method */
304 static PyObject* ACL_check(PyObject* obj, PyObject* args) {
305 ACL_Object *self = (ACL_Object*) obj;
309 if((result = acl_check(self->acl, &eindex)) == -1)
310 return PyErr_SetFromErrno(PyExc_IOError);
314 return Py_BuildValue("(ii)", result, eindex);
317 /* Implementation of the rich compare for ACLs */
318 static PyObject* ACL_richcompare(PyObject* o1, PyObject* o2, int op) {
319 ACL_Object *acl1, *acl2;
323 if(!PyObject_IsInstance(o2, (PyObject*)&ACL_Type)) {
328 PyErr_SetString(PyExc_TypeError, "can only compare to an ACL");
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);
338 ret = n == 0 ? Py_True : Py_False;
341 ret = n == 1 ? Py_True : Py_False;
344 PyErr_SetString(PyExc_TypeError, "ACLs are not orderable");
351 static char __equiv_mode_doc__[] =
352 "Return the octal mode the ACL is equivalent to.\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"
358 ":raise IOError: An IOerror exception will be raised if the ACL is\n"
359 " an extended ACL.\n"
362 /* The acl_equiv_mode method */
363 static PyObject* ACL_equiv_mode(PyObject* obj, PyObject* args) {
364 ACL_Object *self = (ACL_Object*) obj;
367 if(acl_equiv_mode(self->acl, &mode) == -1)
368 return PyErr_SetFromErrno(PyExc_IOError);
369 return PyLong_FromLong(mode);
374 static char __applyto_doc__[] =
375 "applyto(item[, flag=ACL_TYPE_ACCESS])\n"
376 "Apply the ACL to a file or filehandle.\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"
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;
392 if (!PyArg_ParseTuple(args, "O|I", &target, &type))
394 if ((fd = PyObject_AsFileDescriptor(target)) != -1) {
395 if((nret = acl_set_fd(fd, self->acl)) == -1) {
396 PyErr_SetFromErrno(PyExc_IOError);
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).
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);
421 static char __valid_doc__[] =
422 "Test the ACL for validity.\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"
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"
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"
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"
453 /* Checks the ACL for validity */
454 static PyObject* ACL_valid(PyObject* obj, PyObject* args) {
455 ACL_Object *self = (ACL_Object*) obj;
457 if(acl_valid(self->acl) == -1) {
464 #ifdef HAVE_ACL_COPY_EXT
465 static PyObject* ACL_get_state(PyObject *obj, PyObject* args) {
466 ACL_Object *self = (ACL_Object*) obj;
471 size = acl_size(self->acl);
473 return PyErr_SetFromErrno(PyExc_IOError);
475 if((ret = PyBytes_FromStringAndSize(NULL, size)) == NULL)
477 buf = PyBytes_AsString(ret);
479 if((nsize = acl_copy_ext(buf, self->acl, size)) == -1) {
481 return PyErr_SetFromErrno(PyExc_IOError);
487 static PyObject* ACL_set_state(PyObject *obj, PyObject* args) {
488 ACL_Object *self = (ACL_Object*) obj;
493 /* Parse the argument */
494 if (!PyArg_ParseTuple(args, "s#", &buf, &bufsize))
497 /* Try to import the external representation */
498 if((ptr = acl_copy_int(buf)) == NULL)
499 return PyErr_SetFromErrno(PyExc_IOError);
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);
515 /* tp_iter for the ACL type; since it can be iterated only
516 * destructively, the type is its iterator
518 static PyObject* ACL_iter(PyObject *obj) {
519 ACL_Object *self = (ACL_Object*)obj;
520 self->entry_id = ACL_FIRST_ENTRY;
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;
532 nerr = acl_get_entry(self->acl, self->entry_id, &the_entry_t);
533 self->entry_id = ACL_NEXT_ENTRY;
535 return PyErr_SetFromErrno(PyExc_IOError);
537 /* Docs says this is not needed */
538 /*PyErr_SetObject(PyExc_StopIteration, Py_None);*/
542 the_entry_obj = (Entry_Object*) PyType_GenericNew(&Entry_Type, NULL, NULL);
543 if(the_entry_obj == NULL)
546 the_entry_obj->entry = the_entry_t;
548 the_entry_obj->parent_acl = obj;
549 Py_INCREF(obj); /* For the reference we have in entry->parent */
551 return (PyObject*)the_entry_obj;
554 static char __ACL_delete_entry_doc__[] =
555 "delete_entry(entry)\n"
556 "Deletes an entry from the ACL.\n"
558 ".. note:: Only available with level 2.\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"
565 /* Deletes an entry from the ACL */
566 static PyObject* ACL_delete_entry(PyObject *obj, PyObject *args) {
567 ACL_Object *self = (ACL_Object*)obj;
570 if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &e))
573 if (e->parent_acl != obj) {
574 PyErr_SetString(PyExc_ValueError,
575 "Can't remove un-owned entry");
578 if(acl_delete_entry(self->acl, e->entry) == -1)
579 return PyErr_SetFromErrno(PyExc_IOError);
584 static char __ACL_calc_mask_doc__[] =
585 "Compute the file group class mask.\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"
594 "permissions are overwritten; if it does not contain an \n"
595 ":py:data:`ACL_MASK` Entry, one is added.\n"
597 "The order of existing entries in the ACL is undefined after this \n"
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;
605 if(acl_calc_mask(&self->acl) == -1)
606 return PyErr_SetFromErrno(PyExc_IOError);
611 static char __ACL_append_doc__[] =
613 "Append a new Entry to the ACL and return it.\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"
621 ":rtype: :py:class:`Entry`\n"
622 ":returns: the newly created entry\n"
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;
631 if (!PyArg_ParseTuple(args, "|O!", &Entry_Type, &oldentry)) {
635 PyObject *new_arglist = Py_BuildValue("(O)", obj);
636 if (new_arglist == NULL) {
639 newentry = (Entry_Object*) PyObject_CallObject((PyObject*)&Entry_Type, new_arglist);
640 Py_DECREF(new_arglist);
641 if(newentry == NULL) {
645 if(oldentry != NULL) {
646 nret = acl_copy_entry(newentry->entry, oldentry->entry);
649 return PyErr_SetFromErrno(PyExc_IOError);
653 return (PyObject*)newentry;
656 /***** Entry type *****/
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;
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.
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.
680 static int get_tag_qualifier(acl_entry_t entry, tag_qual *tq) {
683 if(acl_get_tag_type(entry, &tq->tag) == -1) {
684 PyErr_SetFromErrno(PyExc_IOError);
687 if (tq->tag == ACL_USER || tq->tag == ACL_GROUP) {
688 if((p = acl_get_qualifier(entry)) == NULL) {
689 PyErr_SetFromErrno(PyExc_IOError);
692 if (tq->tag == ACL_USER) {
693 tq->uid = *(uid_t*)p;
695 tq->gid = *(gid_t*)p;
702 #define ENTRY_SET_CHECK(self, attr, value) \
703 if (value == NULL) { \
704 PyErr_SetString(PyExc_TypeError, \
705 attr " deletion is not supported"); \
709 /* Creation of a new Entry instance */
710 static PyObject* Entry_new(PyTypeObject* type, PyObject* args,
714 ACL_Object* parent = NULL;
716 if (!PyArg_ParseTuple(args, "O!", &ACL_Type, &parent))
719 newentry = PyType_GenericNew(type, args, keywds);
721 if(newentry == NULL) {
725 entry = (Entry_Object*)newentry;
727 if(acl_create_entry(&parent->acl, &entry->entry) == -1) {
728 PyErr_SetFromErrno(PyExc_IOError);
733 entry->parent_acl = (PyObject*)parent;
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;
742 if (!PyArg_ParseTuple(args, "O!", &ACL_Type, &parent))
745 if ((PyObject*)parent != self->parent_acl) {
746 PyErr_SetString(PyExc_ValueError,
747 "Can't reinitialize with a different parent");
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;
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;
766 PyErr_Restore(err_type, err_value, err_traceback);
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;
776 if(get_tag_qualifier(self->entry, &tq) < 0) {
780 format = PyUnicode_FromString("ACL entry for ");
784 case ACL_UNDEFINED_TAG:
785 kind = PyUnicode_FromString("undefined type");
788 kind = PyUnicode_FromString("the owner");
791 kind = PyUnicode_FromString("the group");
794 kind = PyUnicode_FromString("the others");
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);
804 kind = PyUnicode_FromFormat("group with gid %u", tq.gid);
807 kind = PyUnicode_FromString("the mask");
810 kind = PyUnicode_FromString("UNKNOWN_TAG_TYPE!");
817 PyObject *ret = PyUnicode_Concat(format, kind);
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;
827 ENTRY_SET_CHECK(self, "tag type", value);
829 if(!PyLong_Check(value)) {
830 PyErr_SetString(PyExc_TypeError,
831 "tag type must be integer");
834 if(acl_set_tag_type(self->entry, (acl_tag_t)PyLong_AsLong(value)) == -1) {
835 PyErr_SetFromErrno(PyExc_IOError);
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;
847 if(acl_get_tag_type(self->entry, &value) == -1) {
848 PyErr_SetFromErrno(PyExc_IOError);
852 return PyLong_FromLong(value);
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
858 static int Entry_set_qualifier(PyObject* obj, PyObject* value, void* arg) {
859 Entry_Object *self = (Entry_Object*) obj;
866 ENTRY_SET_CHECK(self, "qualifier", value);
868 if(!PyLong_Check(value)) {
869 PyErr_SetString(PyExc_TypeError,
870 "qualifier must be integer");
873 if((uidgid = PyLong_AsLong(value)) == -1) {
874 if(PyErr_Occurred() != NULL) {
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);
889 if((long)uid != uidgid) {
890 PyErr_SetString(PyExc_OverflowError, "Can't assign given qualifier");
897 if((long)gid != uidgid) {
898 PyErr_SetString(PyExc_OverflowError, "Can't assign given qualifier");
905 PyErr_SetString(PyExc_TypeError,
906 "Can only set qualifiers on ACL_USER or ACL_GROUP entries");
909 if(acl_set_qualifier(self->entry, p) == -1) {
910 PyErr_SetFromErrno(PyExc_IOError);
917 /* Returns the qualifier of the entry */
918 static PyObject* Entry_get_qualifier(PyObject *obj, void* arg) {
919 Entry_Object *self = (Entry_Object*) obj;
923 if (self->entry == NULL) {
924 PyErr_SetString(PyExc_ValueError, "Can't get qualifier on uninitalized Entry object");
927 if(get_tag_qualifier(self->entry, &tq) < 0) {
930 if (tq.tag == ACL_USER) {
932 } else if (tq.tag == ACL_GROUP) {
935 PyErr_SetString(PyExc_TypeError,
936 "Given entry doesn't have an user or"
940 return PyLong_FromLong(value);
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;
947 Py_INCREF(self->parent_acl);
948 return self->parent_acl;
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!
955 static PyObject* Entry_get_permset(PyObject *obj, void* arg) {
958 PyObject *perm_arglist = Py_BuildValue("(O)", obj);
959 if (perm_arglist == NULL) {
962 p = PyObject_CallObject((PyObject*)&Permset_Type, perm_arglist);
963 Py_DECREF(perm_arglist);
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;
972 ENTRY_SET_CHECK(self, "permset", value);
974 if(!PyObject_IsInstance(value, (PyObject*)&Permset_Type)) {
975 PyErr_SetString(PyExc_TypeError, "argument 1 must be posix1e.Permset");
978 p = (Permset_Object*)value;
979 if(acl_set_permset(self->entry, p->permset) == -1) {
980 PyErr_SetFromErrno(PyExc_IOError);
986 static char __Entry_copy_doc__[] =
988 "Copies an ACL entry.\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"
993 ":param Entry src: instance of type Entry\n"
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;
1001 if(!PyArg_ParseTuple(args, "O!", &Entry_Type, &other))
1004 if(acl_copy_entry(self->entry, other->entry) == -1)
1005 return PyErr_SetFromErrno(PyExc_IOError);
1010 /**** Permset type *****/
1012 /* Creation of a new Permset instance */
1013 static PyObject* Permset_new(PyTypeObject* type, PyObject* args,
1015 PyObject* newpermset;
1016 Permset_Object* permset;
1017 Entry_Object* parent = NULL;
1019 if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &parent)) {
1023 newpermset = PyType_GenericNew(type, args, keywds);
1025 if(newpermset == NULL) {
1029 permset = (Permset_Object*)newpermset;
1031 if(acl_get_permset(parent->entry, &permset->permset) == -1) {
1032 PyErr_SetFromErrno(PyExc_IOError);
1033 Py_DECREF(newpermset);
1037 permset->parent_entry = (PyObject*)parent;
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;
1048 if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &parent))
1051 if ((PyObject*)parent != self->parent_entry) {
1052 PyErr_SetString(PyExc_ValueError,
1053 "Can't reinitialize with a different parent");
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;
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;
1073 PyErr_Restore(err_type, err_value, err_traceback);
1077 /* Permset string representation */
1078 static PyObject* Permset_str(PyObject *obj) {
1079 Permset_Object *self = (Permset_Object*) obj;
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);
1088 static char __Permset_clear_doc__[] =
1089 "Clears all permissions from the permission set.\n"
1092 /* Clears all permissions from the permset */
1093 static PyObject* Permset_clear(PyObject* obj, PyObject* args) {
1094 Permset_Object *self = (Permset_Object*) obj;
1096 if(acl_clear_perms(self->permset) == -1)
1097 return PyErr_SetFromErrno(PyExc_IOError);
1102 static PyObject* Permset_get_right(PyObject *obj, void* arg) {
1103 Permset_Object *self = (Permset_Object*) obj;
1105 if(get_perm(self->permset, *(acl_perm_t*)arg)) {
1112 static int Permset_set_right(PyObject* obj, PyObject* value, void* arg) {
1113 Permset_Object *self = (Permset_Object*) obj;
1117 if(!PyLong_Check(value)) {
1118 PyErr_SetString(PyExc_ValueError, "invalid argument, an integer"
1122 on = PyLong_AsLong(value);
1124 nerr = acl_add_perm(self->permset, *(acl_perm_t*)arg);
1126 nerr = acl_delete_perm(self->permset, *(acl_perm_t*)arg);
1128 PyErr_SetFromErrno(PyExc_IOError);
1134 static char __Permset_add_doc__[] =
1136 "Add a permission to the permission set.\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"
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"
1148 static PyObject* Permset_add(PyObject* obj, PyObject* args) {
1149 Permset_Object *self = (Permset_Object*) obj;
1152 if (!PyArg_ParseTuple(args, "i", &right))
1155 if(acl_add_perm(self->permset, (acl_perm_t) right) == -1)
1156 return PyErr_SetFromErrno(PyExc_IOError);
1161 static char __Permset_delete_doc__[] =
1163 "Delete a permission from the permission set.\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"
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"
1175 static PyObject* Permset_delete(PyObject* obj, PyObject* args) {
1176 Permset_Object *self = (Permset_Object*) obj;
1179 if (!PyArg_ParseTuple(args, "i", &right))
1182 if(acl_delete_perm(self->permset, (acl_perm_t) right) == -1)
1183 return PyErr_SetFromErrno(PyExc_IOError);
1188 static char __Permset_test_doc__[] =
1190 "Test if a permission exists in the permission set.\n"
1192 "The test() function tests if the permission represented by\n"
1193 "the argument perm exists in the permission set.\n"
1195 ":param perm: a permission (:py:data:`ACL_WRITE`, :py:data:`ACL_READ`,\n"
1196 " :py:data:`ACL_EXECUTE`, ...)\n"
1198 ":raises IOError: in case the argument is not a valid descriptor\n"
1201 static PyObject* Permset_test(PyObject* obj, PyObject* args) {
1202 Permset_Object *self = (Permset_Object*) obj;
1206 if (!PyArg_ParseTuple(args, "i", &right))
1209 ret = get_perm(self->permset, (acl_perm_t) right);
1211 return PyErr_SetFromErrno(PyExc_IOError);
1222 static char __ACL_Type_doc__[] =
1223 "Type which represents a POSIX ACL\n"
1225 ".. note:: only one keyword parameter should be provided\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"
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"
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__},
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__},
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."},
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__},
1270 {NULL, NULL, 0, NULL}
1274 /* The definition of the ACL Type */
1275 static PyTypeObject ACL_Type = {
1276 PyVarObject_HEAD_INIT(NULL, 0)
1280 ACL_dealloc, /* tp_dealloc */
1284 0, /* formerly tp_compare, in 3.0 deprecated, in
1287 0, /* tp_as_number */
1288 0, /* tp_as_sequence */
1289 0, /* tp_as_mapping */
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 */
1301 ACL_richcompare, /* tp_richcompare */
1303 0, /* tp_richcompare */
1305 0, /* tp_weaklistoffset */
1311 0, /* tp_iternext */
1313 ACL_methods, /* tp_methods */
1318 0, /* tp_descr_get */
1319 0, /* tp_descr_set */
1320 0, /* tp_dictoffset */
1321 ACL_init, /* tp_init */
1323 ACL_new, /* tp_new */
1328 /* Entry type methods */
1329 static PyMethodDef Entry_methods[] = {
1330 {"copy", Entry_copy, METH_VARARGS, __Entry_copy_doc__},
1331 {NULL, NULL, 0, NULL}
1334 static char __Entry_tagtype_doc__[] =
1335 "The tag type of the current entry\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"
1347 static char __Entry_qualifier_doc__[] =
1348 "The qualifier of the current entry\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"
1355 static char __Entry_parent_doc__[] =
1356 "The parent ACL of this entry\n"
1359 static char __Entry_permset_doc__[] =
1360 "The permission set of this ACL entry\n"
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__},
1374 static char __Entry_Type_doc__[] =
1375 "Type which represents an entry in an ACL.\n"
1377 "The type exists only if the OS has full support for POSIX.1e\n"
1378 "Can be created either by:\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"
1385 " >>> for entry in myACL:\n"
1386 " ... print entry\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"
1392 /* The definition of the Entry Type */
1393 static PyTypeObject Entry_Type = {
1394 PyVarObject_HEAD_INIT(NULL, 0)
1396 sizeof(Entry_Object),
1398 Entry_dealloc, /* tp_dealloc */
1404 0, /* tp_as_number */
1405 0, /* tp_as_sequence */
1406 0, /* tp_as_mapping */
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 */
1417 0, /* tp_richcompare */
1418 0, /* tp_weaklistoffset */
1420 0, /* tp_iternext */
1421 Entry_methods, /* tp_methods */
1423 Entry_getsets, /* tp_getset */
1426 0, /* tp_descr_get */
1427 0, /* tp_descr_set */
1428 0, /* tp_dictoffset */
1429 Entry_init, /* tp_init */
1431 Entry_new, /* tp_new */
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}
1443 static char __Permset_execute_doc__[] =
1444 "Execute permission property\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"
1453 static char __Permset_read_doc__[] =
1454 "Read permission property\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"
1463 static char __Permset_write_doc__[] =
1464 "Write permission property\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"
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},
1484 static char __Permset_Type_doc__[] =
1485 "Type which represents the permission set in an ACL entry\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"
1492 ">>> perms = posix1e.Permset(myEntry)\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"
1499 /* The definition of the Permset Type */
1500 static PyTypeObject Permset_Type = {
1501 PyVarObject_HEAD_INIT(NULL, 0)
1503 sizeof(Permset_Object),
1505 Permset_dealloc, /* tp_dealloc */
1511 0, /* tp_as_number */
1512 0, /* tp_as_sequence */
1513 0, /* tp_as_mapping */
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 */
1524 0, /* tp_richcompare */
1525 0, /* tp_weaklistoffset */
1527 0, /* tp_iternext */
1528 Permset_methods, /* tp_methods */
1530 Permset_getsets, /* tp_getset */
1533 0, /* tp_descr_get */
1534 0, /* tp_descr_set */
1535 0, /* tp_dictoffset */
1536 Permset_init, /* tp_init */
1538 Permset_new, /* tp_new */
1543 /* Module methods */
1545 static char __deletedef_doc__[] =
1546 "delete_default(path)\n"
1547 "Delete the default ACL from a directory.\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"
1553 ":param string path: the directory whose default ACL should be deleted\n"
1556 /* Deletes the default ACL from a directory */
1557 static PyObject* aclmodule_delete_default(PyObject* obj, PyObject* args) {
1560 /* Parse the arguments */
1561 if (!PyArg_ParseTuple(args, "et", NULL, &filename))
1564 if(acl_delete_def_file(filename) == -1) {
1565 return PyErr_SetFromErrnoWithFilename(PyExc_IOError, filename);
1572 static char __has_extended_doc__[] =
1573 "has_extended(item)\n"
1574 "Check if a file or file handle has an extended ACL.\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"
1580 /* Check for extended ACL a file or fd */
1581 static PyObject* aclmodule_has_extended(PyObject* obj, PyObject* args) {
1582 PyObject *item, *tmp;
1586 if (!PyArg_ParseTuple(args, "O", &item))
1589 if((fd = PyObject_AsFileDescriptor(item)) != -1) {
1590 if((nret = acl_extended_fd(fd)) == -1) {
1591 PyErr_SetFromErrno(PyExc_IOError);
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).
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);
1613 return PyBool_FromLong(nret);
1618 /* The module methods */
1619 static PyMethodDef aclmodule_methods[] = {
1620 {"delete_default", aclmodule_delete_default, METH_VARARGS,
1623 {"has_extended", aclmodule_has_extended, METH_VARARGS,
1624 __has_extended_doc__},
1626 {NULL, NULL, 0, NULL}
1629 static char __posix1e_doc__[] =
1630 "POSIX.1e ACLs manipulation\n"
1631 "==========================\n"
1633 "This module provides support for manipulating POSIX.1e ACLS\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"
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"
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"
1659 ">>> import posix1e\n"
1660 ">>> acl1 = posix1e.ACL(file=\"file.txt\") \n"
1666 ">>> b = posix1e.ACL(text=\"u::rx,g::-,o::-\")\n"
1672 ">>> b.applyto(\"file.txt\")\n"
1673 ">>> print posix1e.ACL(file=\"file.txt\")\n"
1679 ".. py:data:: ACL_USER\n\n"
1680 " Denotes a specific user entry in an ACL.\n"
1682 ".. py:data:: ACL_USER_OBJ\n\n"
1683 " Denotes the user owner entry in an ACL.\n"
1685 ".. py:data:: ACL_GROUP\n\n"
1686 " Denotes the a group entry in an ACL.\n"
1688 ".. py:data:: ACL_GROUP_OBJ\n\n"
1689 " Denotes the group owner entry in an ACL.\n"
1691 ".. py:data:: ACL_OTHER\n\n"
1692 " Denotes the 'others' entry in an ACL.\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"
1698 ".. py:data:: ACL_UNDEFINED_TAG\n\n"
1699 " An undefined tag in an ACL.\n"
1701 ".. py:data:: ACL_READ\n\n"
1702 " Read permission in a permission set.\n"
1704 ".. py:data:: ACL_WRITE\n\n"
1705 " Write permission in a permission set.\n"
1707 ".. py:data:: ACL_EXECUTE\n\n"
1708 " Execute permission in a permission set.\n"
1710 ".. py:data:: HAS_ACL_ENTRY\n\n"
1711 " denotes support for level 2 and the Entry/Permset classes\n"
1713 ".. py:data:: HAS_ACL_FROM_MODE\n\n"
1714 " denotes support for building an ACL from an octal mode\n"
1716 ".. py:data:: HAS_ACL_CHECK\n\n"
1717 " denotes support for extended checks of an ACL's validity\n"
1719 ".. py:data:: HAS_EXTENDED_CHECK\n\n"
1720 " denotes support for checking whether an ACL is basic or extended\n"
1722 ".. py:data:: HAS_EQUIV_MODE\n\n"
1723 " denotes support for the equiv_mode function\n"
1725 ".. py:data:: HAS_COPY_EXT\n\n"
1726 " denotes support for __getstate__()/__setstate__() on an ACL\n"
1730 static struct PyModuleDef posix1emodule = {
1731 PyModuleDef_HEAD_INIT,
1739 PyInit_posix1e(void)
1743 Py_TYPE(&ACL_Type) = &PyType_Type;
1744 if(PyType_Ready(&ACL_Type) < 0)
1748 Py_TYPE(&Entry_Type) = &PyType_Type;
1749 if(PyType_Ready(&Entry_Type) < 0)
1752 Py_TYPE(&Permset_Type) = &PyType_Type;
1753 if(PyType_Ready(&Permset_Type) < 0)
1757 m = PyModule_Create(&posix1emodule);
1761 d = PyModule_GetDict(m);
1765 Py_INCREF(&ACL_Type);
1766 if (PyDict_SetItemString(d, "ACL",
1767 (PyObject *) &ACL_Type) < 0)
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);
1776 Py_INCREF(&Entry_Type);
1777 if (PyDict_SetItemString(d, "Entry",
1778 (PyObject *) &Entry_Type) < 0)
1781 Py_INCREF(&Permset_Type);
1782 if (PyDict_SetItemString(d, "Permset",
1783 (PyObject *) &Permset_Type) < 0)
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);
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);
1800 /* Document extended functionality via easy-to-use constants */
1801 PyModule_AddIntConstant(m, "HAS_ACL_ENTRY", 1);
1803 PyModule_AddIntConstant(m, "HAS_ACL_ENTRY", 0);
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);
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);
1820 #define LINUX_EXT_VAL 1
1822 #define LINUX_EXT_VAL 0
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);
1830 PyModule_AddIntConstant(m, "HAS_COPY_EXT",
1831 #ifdef HAVE_ACL_COPY_EXT