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);
422 static char __valid_doc__[] =
423 "Test the ACL for validity.\n"
425 "This method tests the ACL to see if it is a valid ACL\n"
426 "in terms of the file-system. More precisely, it checks that:\n"
428 "The ACL contains exactly one entry with each of the\n"
429 ":py:data:`ACL_USER_OBJ`, :py:data:`ACL_GROUP_OBJ`, and \n"
430 ":py:data:`ACL_OTHER` tag types. Entries\n"
431 "with :py:data:`ACL_USER` and :py:data:`ACL_GROUP` tag types may\n"
432 "appear zero or more\n"
433 "times in an ACL. An ACL that contains entries of :py:data:`ACL_USER` or\n"
434 ":py:data:`ACL_GROUP` tag types must contain exactly one entry of the \n"
435 ":py:data:`ACL_MASK` tag type. If an ACL contains no entries of\n"
436 ":py:data:`ACL_USER` or :py:data:`ACL_GROUP` tag types, the\n"
437 ":py:data:`ACL_MASK` entry is optional.\n"
439 "All user ID qualifiers must be unique among all entries of\n"
440 "the :py:data:`ACL_USER` tag type, and all group IDs must be unique\n"
441 "among all entries of :py:data:`ACL_GROUP` tag type.\n"
443 "The method will return 1 for a valid ACL and 0 for an invalid one.\n"
444 "This has been chosen because the specification for\n"
445 ":manpage:`acl_valid(3)`\n"
446 "in the POSIX.1e standard documents only one possible value for errno\n"
447 "in case of an invalid ACL, so we can't differentiate between\n"
448 "classes of errors. Other suggestions are welcome.\n"
454 /* Checks the ACL for validity */
455 static PyObject* ACL_valid(PyObject* obj, PyObject* args) {
456 ACL_Object *self = (ACL_Object*) obj;
458 if(acl_valid(self->acl) == -1) {
465 #ifdef HAVE_ACL_COPY_EXT
466 static PyObject* ACL_get_state(PyObject *obj, PyObject* args) {
467 ACL_Object *self = (ACL_Object*) obj;
472 size = acl_size(self->acl);
474 return PyErr_SetFromErrno(PyExc_IOError);
476 if((ret = PyBytes_FromStringAndSize(NULL, size)) == NULL)
478 buf = PyBytes_AsString(ret);
480 if((nsize = acl_copy_ext(buf, self->acl, size)) == -1) {
482 return PyErr_SetFromErrno(PyExc_IOError);
488 static PyObject* ACL_set_state(PyObject *obj, PyObject* args) {
489 ACL_Object *self = (ACL_Object*) obj;
494 /* Parse the argument */
495 if (!PyArg_ParseTuple(args, "s#", &buf, &bufsize))
498 /* Try to import the external representation */
499 if((ptr = acl_copy_int(buf)) == NULL)
500 return PyErr_SetFromErrno(PyExc_IOError);
502 /* Free the old acl. Should we ignore errors here? */
503 if(self->acl != NULL) {
504 if(acl_free(self->acl) == -1)
505 return PyErr_SetFromErrno(PyExc_IOError);
510 /* Return the result */
518 /* tp_iter for the ACL type; since it can be iterated only
519 * destructively, the type is its iterator
521 static PyObject* ACL_iter(PyObject *obj) {
522 ACL_Object *self = (ACL_Object*)obj;
523 self->entry_id = ACL_FIRST_ENTRY;
528 /* the tp_iternext function for the ACL type */
529 static PyObject* ACL_iternext(PyObject *obj) {
530 ACL_Object *self = (ACL_Object*)obj;
531 acl_entry_t the_entry_t;
532 Entry_Object *the_entry_obj;
535 nerr = acl_get_entry(self->acl, self->entry_id, &the_entry_t);
536 self->entry_id = ACL_NEXT_ENTRY;
538 return PyErr_SetFromErrno(PyExc_IOError);
540 /* Docs says this is not needed */
541 /*PyErr_SetObject(PyExc_StopIteration, Py_None);*/
545 the_entry_obj = (Entry_Object*) PyType_GenericNew(&Entry_Type, NULL, NULL);
546 if(the_entry_obj == NULL)
549 the_entry_obj->entry = the_entry_t;
551 the_entry_obj->parent_acl = obj;
552 Py_INCREF(obj); /* For the reference we have in entry->parent */
554 return (PyObject*)the_entry_obj;
557 static char __ACL_delete_entry_doc__[] =
558 "delete_entry(entry)\n"
559 "Deletes an entry from the ACL.\n"
561 ".. note:: Only available with level 2.\n"
563 ":param entry: the Entry object which should be deleted; note that after\n"
564 " this function is called, that object is unusable any longer\n"
565 " and should be deleted\n"
568 /* Deletes an entry from the ACL */
569 static PyObject* ACL_delete_entry(PyObject *obj, PyObject *args) {
570 ACL_Object *self = (ACL_Object*)obj;
573 if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &e))
576 if(acl_delete_entry(self->acl, e->entry) == -1)
577 return PyErr_SetFromErrno(PyExc_IOError);
579 /* Return the result */
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);
608 /* Return the result */
613 static char __ACL_append_doc__[] =
615 "Append a new Entry to the ACL and return it.\n"
617 "This is a convenience function to create a new Entry \n"
618 "and append it to the ACL.\n"
619 "If a parameter of type Entry instance is given, the \n"
620 "entry will be a copy of that one (as if copied with \n"
621 ":py:func:`Entry.copy`), otherwise, the new entry will be empty.\n"
623 ":rtype: :py:class:`Entry`\n"
624 ":returns: the newly created entry\n"
627 /* Convenience method to create a new Entry */
628 static PyObject* ACL_append(PyObject *obj, PyObject *args) {
629 ACL_Object* self = (ACL_Object*) obj;
630 Entry_Object* newentry;
631 Entry_Object* oldentry = NULL;
634 newentry = (Entry_Object*)PyType_GenericNew(&Entry_Type, NULL, NULL);
635 if(newentry == NULL) {
639 if (!PyArg_ParseTuple(args, "|O!", &Entry_Type, &oldentry)) {
644 nret = acl_create_entry(&self->acl, &newentry->entry);
647 return PyErr_SetFromErrno(PyExc_IOError);
650 if(oldentry != NULL) {
651 nret = acl_copy_entry(newentry->entry, oldentry->entry);
654 return PyErr_SetFromErrno(PyExc_IOError);
658 newentry->parent_acl = obj;
661 return (PyObject*)newentry;
664 /***** Entry type *****/
674 /* Pre-declaring the function is more friendly to cpychecker, sigh. */
675 static int get_tag_qualifier(acl_entry_t entry, tag_qual *tq)
676 CPYCHECKER_NEGATIVE_RESULT_SETS_EXCEPTION;
678 /* Helper function to get the tag and qualifier of an Entry at the
679 same time. This is "needed" because the acl_get_qualifier function
680 returns a pointer to different types, based on the tag value, and
681 thus it's not straightforward to get the right type.
683 It sets a Python exception if an error occurs, and returns -1 in
684 this case. If successful, the tag is set to the tag type, the
685 qualifier (if any) to either the uid or the gid entry in the
686 tag_qual structure, and the return value is 0.
688 static int get_tag_qualifier(acl_entry_t entry, tag_qual *tq) {
691 if(acl_get_tag_type(entry, &tq->tag) == -1) {
692 PyErr_SetFromErrno(PyExc_IOError);
695 if (tq->tag == ACL_USER || tq->tag == ACL_GROUP) {
696 if((p = acl_get_qualifier(entry)) == NULL) {
697 PyErr_SetFromErrno(PyExc_IOError);
700 if (tq->tag == ACL_USER) {
701 tq->uid = *(uid_t*)p;
703 tq->gid = *(gid_t*)p;
710 #define ENTRY_SET_CHECK(self, attr, value) \
711 if (value == NULL) { \
712 PyErr_SetString(PyExc_TypeError, \
713 attr " deletion is not supported"); \
717 /* Creation of a new Entry instance */
718 static PyObject* Entry_new(PyTypeObject* type, PyObject* args,
722 ACL_Object* parent = NULL;
724 if (!PyArg_ParseTuple(args, "O!", &ACL_Type, &parent))
727 newentry = PyType_GenericNew(type, args, keywds);
729 if(newentry == NULL) {
733 entry = (Entry_Object*)newentry;
735 if(acl_create_entry(&parent->acl, &entry->entry) == -1) {
736 PyErr_SetFromErrno(PyExc_IOError);
741 entry->parent_acl = (PyObject*)parent;
745 /* Initialization of a new Entry instance */
746 static int Entry_init(PyObject* obj, PyObject* args, PyObject *keywds) {
747 Entry_Object* self = (Entry_Object*) obj;
748 ACL_Object* parent = NULL;
750 if (!PyArg_ParseTuple(args, "O!", &ACL_Type, &parent))
753 if ((PyObject*)parent != self->parent_acl) {
754 PyErr_SetString(PyExc_ValueError,
755 "Can't reinitialize with a different parent");
761 /* Free the Entry instance */
762 static void Entry_dealloc(PyObject* obj) {
763 Entry_Object *self = (Entry_Object*) obj;
764 PyObject *err_type, *err_value, *err_traceback;
765 int have_error = PyErr_Occurred() ? 1 : 0;
768 PyErr_Fetch(&err_type, &err_value, &err_traceback);
769 if(self->parent_acl != NULL) {
770 Py_DECREF(self->parent_acl);
771 self->parent_acl = NULL;
774 PyErr_Restore(err_type, err_value, err_traceback);
778 /* Converts the entry to a text format */
779 static PyObject* Entry_str(PyObject *obj) {
780 PyObject *format, *kind;
781 Entry_Object *self = (Entry_Object*) obj;
784 if(get_tag_qualifier(self->entry, &tq) < 0) {
788 format = PyUnicode_FromString("ACL entry for ");
792 case ACL_UNDEFINED_TAG:
793 kind = PyUnicode_FromString("undefined type");
796 kind = PyUnicode_FromString("the owner");
799 kind = PyUnicode_FromString("the group");
802 kind = PyUnicode_FromString("the others");
805 /* FIXME: here and in the group case, we're formatting with
806 unsigned, because there's no way to automatically determine
807 the signed-ness of the types; on Linux(glibc) they're
808 unsigned, so we'll go along with that */
809 kind = PyUnicode_FromFormat("user with uid %u", tq.uid);
812 kind = PyUnicode_FromFormat("group with gid %u", tq.gid);
815 kind = PyUnicode_FromString("the mask");
818 kind = PyUnicode_FromString("UNKNOWN_TAG_TYPE!");
825 PyObject *ret = PyUnicode_Concat(format, kind);
831 /* Sets the tag type of the entry */
832 static int Entry_set_tag_type(PyObject* obj, PyObject* value, void* arg) {
833 Entry_Object *self = (Entry_Object*) obj;
835 ENTRY_SET_CHECK(self, "tag type", value);
837 if(!PyLong_Check(value)) {
838 PyErr_SetString(PyExc_TypeError,
839 "tag type must be integer");
842 if(acl_set_tag_type(self->entry, (acl_tag_t)PyLong_AsLong(value)) == -1) {
843 PyErr_SetFromErrno(PyExc_IOError);
850 /* Returns the tag type of the entry */
851 static PyObject* Entry_get_tag_type(PyObject *obj, void* arg) {
852 Entry_Object *self = (Entry_Object*) obj;
855 if(acl_get_tag_type(self->entry, &value) == -1) {
856 PyErr_SetFromErrno(PyExc_IOError);
860 return PyLong_FromLong(value);
863 /* Sets the qualifier (either uid_t or gid_t) for the entry,
864 * usable only if the tag type if ACL_USER or ACL_GROUP
866 static int Entry_set_qualifier(PyObject* obj, PyObject* value, void* arg) {
867 Entry_Object *self = (Entry_Object*) obj;
874 ENTRY_SET_CHECK(self, "qualifier", value);
876 if(!PyLong_Check(value)) {
877 PyErr_SetString(PyExc_TypeError,
878 "qualifier must be integer");
881 if((uidgid = PyLong_AsLong(value)) == -1) {
882 if(PyErr_Occurred() != NULL) {
886 /* Due to how acl_set_qualifier takes its argument, we have to do
887 this ugly dance with two variables and a pointer that will
888 point to one of them. */
889 if(acl_get_tag_type(self->entry, &tag) == -1) {
890 PyErr_SetFromErrno(PyExc_IOError);
897 if((long)uid != uidgid) {
898 PyErr_SetString(PyExc_OverflowError, "Can't assign given qualifier");
905 if((long)gid != uidgid) {
906 PyErr_SetString(PyExc_OverflowError, "Can't assign given qualifier");
913 PyErr_SetString(PyExc_TypeError,
914 "Can only set qualifiers on ACL_USER or ACL_GROUP entries");
917 if(acl_set_qualifier(self->entry, p) == -1) {
918 PyErr_SetFromErrno(PyExc_IOError);
925 /* Returns the qualifier of the entry */
926 static PyObject* Entry_get_qualifier(PyObject *obj, void* arg) {
927 Entry_Object *self = (Entry_Object*) obj;
931 if (self->entry == NULL) {
932 PyErr_SetString(PyExc_ValueError, "Can't get qualifier on uninitalized Entry object");
935 if(get_tag_qualifier(self->entry, &tq) < 0) {
938 if (tq.tag == ACL_USER) {
940 } else if (tq.tag == ACL_GROUP) {
943 PyErr_SetString(PyExc_TypeError,
944 "Given entry doesn't have an user or"
948 return PyLong_FromLong(value);
951 /* Returns the parent ACL of the entry */
952 static PyObject* Entry_get_parent(PyObject *obj, void* arg) {
953 Entry_Object *self = (Entry_Object*) obj;
955 Py_INCREF(self->parent_acl);
956 return self->parent_acl;
959 /* Returns the a new Permset representing the permset of the entry
960 * FIXME: Should return a new reference to the same object, which
961 * should be created at init time!
963 static PyObject* Entry_get_permset(PyObject *obj, void* arg) {
966 PyObject *perm_arglist = Py_BuildValue("(O)", obj);
967 if (perm_arglist == NULL) {
970 p = PyObject_CallObject((PyObject*)&Permset_Type, perm_arglist);
971 Py_DECREF(perm_arglist);
975 /* Sets the permset of the entry to the passed Permset */
976 static int Entry_set_permset(PyObject* obj, PyObject* value, void* arg) {
977 Entry_Object *self = (Entry_Object*)obj;
980 ENTRY_SET_CHECK(self, "permset", value);
982 if(!PyObject_IsInstance(value, (PyObject*)&Permset_Type)) {
983 PyErr_SetString(PyExc_TypeError, "argument 1 must be posix1e.Permset");
986 p = (Permset_Object*)value;
987 if(acl_set_permset(self->entry, p->permset) == -1) {
988 PyErr_SetFromErrno(PyExc_IOError);
994 static char __Entry_copy_doc__[] =
996 "Copies an ACL entry.\n"
998 "This method sets all the parameters to those of another\n"
999 "entry (either of the same ACL or belonging to another ACL).\n"
1001 ":param Entry src: instance of type Entry\n"
1004 /* Sets all the entry parameters to another entry */
1005 static PyObject* Entry_copy(PyObject *obj, PyObject *args) {
1006 Entry_Object *self = (Entry_Object*)obj;
1007 Entry_Object *other;
1009 if(!PyArg_ParseTuple(args, "O!", &Entry_Type, &other))
1012 if(acl_copy_entry(self->entry, other->entry) == -1)
1013 return PyErr_SetFromErrno(PyExc_IOError);
1019 /**** Permset type *****/
1021 /* Creation of a new Permset instance */
1022 static PyObject* Permset_new(PyTypeObject* type, PyObject* args,
1024 PyObject* newpermset;
1025 Permset_Object* permset;
1026 Entry_Object* parent = NULL;
1028 if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &parent)) {
1032 newpermset = PyType_GenericNew(type, args, keywds);
1034 if(newpermset == NULL) {
1038 permset = (Permset_Object*)newpermset;
1040 if(acl_get_permset(parent->entry, &permset->permset) == -1) {
1041 PyErr_SetFromErrno(PyExc_IOError);
1042 Py_DECREF(newpermset);
1046 permset->parent_entry = (PyObject*)parent;
1052 /* Initialization of a new Permset instance */
1053 static int Permset_init(PyObject* obj, PyObject* args, PyObject *keywds) {
1054 Permset_Object* self = (Permset_Object*) obj;
1055 Entry_Object* parent = NULL;
1057 if (!PyArg_ParseTuple(args, "O!", &Entry_Type, &parent))
1060 if ((PyObject*)parent != self->parent_entry) {
1061 PyErr_SetString(PyExc_ValueError,
1062 "Can't reinitialize with a different parent");
1069 /* Free the Permset instance */
1070 static void Permset_dealloc(PyObject* obj) {
1071 Permset_Object *self = (Permset_Object*) obj;
1072 PyObject *err_type, *err_value, *err_traceback;
1073 int have_error = PyErr_Occurred() ? 1 : 0;
1076 PyErr_Fetch(&err_type, &err_value, &err_traceback);
1077 if(self->parent_entry != NULL) {
1078 Py_DECREF(self->parent_entry);
1079 self->parent_entry = NULL;
1082 PyErr_Restore(err_type, err_value, err_traceback);
1086 /* Permset string representation */
1087 static PyObject* Permset_str(PyObject *obj) {
1088 Permset_Object *self = (Permset_Object*) obj;
1091 pstr[0] = get_perm(self->permset, ACL_READ) ? 'r' : '-';
1092 pstr[1] = get_perm(self->permset, ACL_WRITE) ? 'w' : '-';
1093 pstr[2] = get_perm(self->permset, ACL_EXECUTE) ? 'x' : '-';
1094 return PyUnicode_FromStringAndSize(pstr, 3);
1097 static char __Permset_clear_doc__[] =
1098 "Clears all permissions from the permission set.\n"
1101 /* Clears all permissions from the permset */
1102 static PyObject* Permset_clear(PyObject* obj, PyObject* args) {
1103 Permset_Object *self = (Permset_Object*) obj;
1105 if(acl_clear_perms(self->permset) == -1)
1106 return PyErr_SetFromErrno(PyExc_IOError);
1108 /* Return the result */
1113 static PyObject* Permset_get_right(PyObject *obj, void* arg) {
1114 Permset_Object *self = (Permset_Object*) obj;
1116 if(get_perm(self->permset, *(acl_perm_t*)arg)) {
1123 static int Permset_set_right(PyObject* obj, PyObject* value, void* arg) {
1124 Permset_Object *self = (Permset_Object*) obj;
1128 if(!PyLong_Check(value)) {
1129 PyErr_SetString(PyExc_ValueError, "invalid argument, an integer"
1133 on = PyLong_AsLong(value);
1135 nerr = acl_add_perm(self->permset, *(acl_perm_t*)arg);
1137 nerr = acl_delete_perm(self->permset, *(acl_perm_t*)arg);
1139 PyErr_SetFromErrno(PyExc_IOError);
1145 static char __Permset_add_doc__[] =
1147 "Add a permission to the permission set.\n"
1149 "This function adds the permission contained in \n"
1150 "the argument perm to the permission set. An attempt \n"
1151 "to add a permission that is already contained in the \n"
1152 "permission set is not considered an error.\n"
1154 ":param perm: a permission (:py:data:`ACL_WRITE`, :py:data:`ACL_READ`,\n"
1155 " :py:data:`ACL_EXECUTE`, ...)\n"
1156 ":raises IOError: in case the argument is not a valid descriptor\n"
1159 static PyObject* Permset_add(PyObject* obj, PyObject* args) {
1160 Permset_Object *self = (Permset_Object*) obj;
1163 if (!PyArg_ParseTuple(args, "i", &right))
1166 if(acl_add_perm(self->permset, (acl_perm_t) right) == -1)
1167 return PyErr_SetFromErrno(PyExc_IOError);
1169 /* Return the result */
1174 static char __Permset_delete_doc__[] =
1176 "Delete a permission from the permission set.\n"
1178 "This function deletes the permission contained in \n"
1179 "the argument perm from the permission set. An attempt \n"
1180 "to delete a permission that is not contained in the \n"
1181 "permission set is not considered an error.\n"
1183 ":param perm: a permission (:py:data:`ACL_WRITE`, :py:data:`ACL_READ`,\n"
1184 " :py:data:`ACL_EXECUTE`, ...)\n"
1185 ":raises IOError: in case the argument is not a valid descriptor\n"
1188 static PyObject* Permset_delete(PyObject* obj, PyObject* args) {
1189 Permset_Object *self = (Permset_Object*) obj;
1192 if (!PyArg_ParseTuple(args, "i", &right))
1195 if(acl_delete_perm(self->permset, (acl_perm_t) right) == -1)
1196 return PyErr_SetFromErrno(PyExc_IOError);
1198 /* Return the result */
1203 static char __Permset_test_doc__[] =
1205 "Test if a permission exists in the permission set.\n"
1207 "The test() function tests if the permission represented by\n"
1208 "the argument perm exists in the permission set.\n"
1210 ":param perm: a permission (:py:data:`ACL_WRITE`, :py:data:`ACL_READ`,\n"
1211 " :py:data:`ACL_EXECUTE`, ...)\n"
1213 ":raises IOError: in case the argument is not a valid descriptor\n"
1216 static PyObject* Permset_test(PyObject* obj, PyObject* args) {
1217 Permset_Object *self = (Permset_Object*) obj;
1221 if (!PyArg_ParseTuple(args, "i", &right))
1224 ret = get_perm(self->permset, (acl_perm_t) right);
1226 return PyErr_SetFromErrno(PyExc_IOError);
1237 static char __ACL_Type_doc__[] =
1238 "Type which represents a POSIX ACL\n"
1240 ".. note:: only one keyword parameter should be provided\n"
1242 ":param string file: creates an ACL representing\n"
1243 " the access ACL of the specified file.\n"
1244 ":param string filedef: creates an ACL representing\n"
1245 " the default ACL of the given directory.\n"
1246 ":param int fd: creates an ACL representing\n"
1247 " the access ACL of the given file descriptor.\n"
1248 ":param string text: creates an ACL from a \n"
1249 " textual description; note the ACL must be valid, which\n"
1250 " means including a mask for extended ACLs, similar to\n"
1251 " ``setfacl --no-mask``\n"
1252 ":param ACL acl: creates a copy of an existing ACL instance.\n"
1253 ":param int mode: creates an ACL from a numeric mode\n"
1254 " (e.g. ``mode=0644``); this is valid only when the C library\n"
1255 " provides the ``acl_from_mode call``, and\n"
1256 " note that no validation is done on the given value.\n"
1258 "If no parameters are passed, an empty ACL will be created; this\n"
1259 "makes sense only when your OS supports ACL modification\n"
1260 "(i.e. it implements full POSIX.1e support), otherwise the ACL won't\n"
1264 /* ACL type methods */
1265 static PyMethodDef ACL_methods[] = {
1266 {"applyto", ACL_applyto, METH_VARARGS, __applyto_doc__},
1267 {"valid", ACL_valid, METH_NOARGS, __valid_doc__},
1269 {"to_any_text", (PyCFunction)ACL_to_any_text, METH_VARARGS | METH_KEYWORDS,
1270 __to_any_text_doc__},
1271 {"check", ACL_check, METH_NOARGS, __check_doc__},
1272 {"equiv_mode", ACL_equiv_mode, METH_NOARGS, __equiv_mode_doc__},
1274 #ifdef HAVE_ACL_COPY_EXT
1275 {"__getstate__", ACL_get_state, METH_NOARGS,
1276 "Dumps the ACL to an external format."},
1277 {"__setstate__", ACL_set_state, METH_VARARGS,
1278 "Loads the ACL from an external format."},
1281 {"delete_entry", ACL_delete_entry, METH_VARARGS, __ACL_delete_entry_doc__},
1282 {"calc_mask", ACL_calc_mask, METH_NOARGS, __ACL_calc_mask_doc__},
1283 {"append", ACL_append, METH_VARARGS, __ACL_append_doc__},
1285 {NULL, NULL, 0, NULL}
1289 /* The definition of the ACL Type */
1290 static PyTypeObject ACL_Type = {
1291 PyVarObject_HEAD_INIT(NULL, 0)
1295 ACL_dealloc, /* tp_dealloc */
1299 0, /* formerly tp_compare, in 3.0 deprecated, in
1302 0, /* tp_as_number */
1303 0, /* tp_as_sequence */
1304 0, /* tp_as_mapping */
1307 ACL_str, /* tp_str */
1308 0, /* tp_getattro */
1309 0, /* tp_setattro */
1310 0, /* tp_as_buffer */
1311 Py_TPFLAGS_DEFAULT, /* tp_flags */
1312 __ACL_Type_doc__, /* tp_doc */
1313 0, /* tp_traverse */
1316 ACL_richcompare, /* tp_richcompare */
1318 0, /* tp_richcompare */
1320 0, /* tp_weaklistoffset */
1326 0, /* tp_iternext */
1328 ACL_methods, /* tp_methods */
1333 0, /* tp_descr_get */
1334 0, /* tp_descr_set */
1335 0, /* tp_dictoffset */
1336 ACL_init, /* tp_init */
1338 ACL_new, /* tp_new */
1343 /* Entry type methods */
1344 static PyMethodDef Entry_methods[] = {
1345 {"copy", Entry_copy, METH_VARARGS, __Entry_copy_doc__},
1346 {NULL, NULL, 0, NULL}
1349 static char __Entry_tagtype_doc__[] =
1350 "The tag type of the current entry\n"
1353 " - :py:data:`ACL_UNDEFINED_TAG`\n"
1354 " - :py:data:`ACL_USER_OBJ`\n"
1355 " - :py:data:`ACL_USER`\n"
1356 " - :py:data:`ACL_GROUP_OBJ`\n"
1357 " - :py:data:`ACL_GROUP`\n"
1358 " - :py:data:`ACL_MASK`\n"
1359 " - :py:data:`ACL_OTHER`\n"
1362 static char __Entry_qualifier_doc__[] =
1363 "The qualifier of the current entry\n"
1365 "If the tag type is :py:data:`ACL_USER`, this should be a user id.\n"
1366 "If the tag type if :py:data:`ACL_GROUP`, this should be a group id.\n"
1367 "Else it doesn't matter.\n"
1370 static char __Entry_parent_doc__[] =
1371 "The parent ACL of this entry\n"
1374 static char __Entry_permset_doc__[] =
1375 "The permission set of this ACL entry\n"
1379 static PyGetSetDef Entry_getsets[] = {
1380 {"tag_type", Entry_get_tag_type, Entry_set_tag_type,
1381 __Entry_tagtype_doc__},
1382 {"qualifier", Entry_get_qualifier, Entry_set_qualifier,
1383 __Entry_qualifier_doc__},
1384 {"parent", Entry_get_parent, NULL, __Entry_parent_doc__},
1385 {"permset", Entry_get_permset, Entry_set_permset, __Entry_permset_doc__},
1389 static char __Entry_Type_doc__[] =
1390 "Type which represents an entry in an ACL.\n"
1392 "The type exists only if the OS has full support for POSIX.1e\n"
1393 "Can be created either by:\n"
1395 " >>> e = posix1e.Entry(myACL) # this creates a new entry in the ACL\n"
1396 " >>> e = myACL.append() # another way for doing the same thing\n"
1400 " >>> for entry in myACL:\n"
1401 " ... print entry\n"
1403 "Note that the Entry keeps a reference to its ACL, so even if \n"
1404 "you delete the ACL, it won't be cleaned up and will continue to \n"
1405 "exist until its Entry(ies) will be deleted.\n"
1407 /* The definition of the Entry Type */
1408 static PyTypeObject Entry_Type = {
1409 PyVarObject_HEAD_INIT(NULL, 0)
1411 sizeof(Entry_Object),
1413 Entry_dealloc, /* tp_dealloc */
1419 0, /* tp_as_number */
1420 0, /* tp_as_sequence */
1421 0, /* tp_as_mapping */
1424 Entry_str, /* tp_str */
1425 0, /* tp_getattro */
1426 0, /* tp_setattro */
1427 0, /* tp_as_buffer */
1428 Py_TPFLAGS_DEFAULT, /* tp_flags */
1429 __Entry_Type_doc__, /* tp_doc */
1430 0, /* tp_traverse */
1432 0, /* tp_richcompare */
1433 0, /* tp_weaklistoffset */
1435 0, /* tp_iternext */
1436 Entry_methods, /* tp_methods */
1438 Entry_getsets, /* tp_getset */
1441 0, /* tp_descr_get */
1442 0, /* tp_descr_set */
1443 0, /* tp_dictoffset */
1444 Entry_init, /* tp_init */
1446 Entry_new, /* tp_new */
1449 /* Permset type methods */
1450 static PyMethodDef Permset_methods[] = {
1451 {"clear", Permset_clear, METH_NOARGS, __Permset_clear_doc__, },
1452 {"add", Permset_add, METH_VARARGS, __Permset_add_doc__, },
1453 {"delete", Permset_delete, METH_VARARGS, __Permset_delete_doc__, },
1454 {"test", Permset_test, METH_VARARGS, __Permset_test_doc__, },
1455 {NULL, NULL, 0, NULL}
1458 static char __Permset_execute_doc__[] =
1459 "Execute permission property\n"
1461 "This is a convenience method of retrieving and setting the execute\n"
1462 "permission in the permission set; the \n"
1463 "same effect can be achieved using the functions\n"
1464 "add(), test(), delete(), and those can take any \n"
1465 "permission defined by your platform.\n"
1468 static char __Permset_read_doc__[] =
1469 "Read permission property\n"
1471 "This is a convenience method of retrieving and setting the read\n"
1472 "permission in the permission set; the \n"
1473 "same effect can be achieved using the functions\n"
1474 "add(), test(), delete(), and those can take any \n"
1475 "permission defined by your platform.\n"
1478 static char __Permset_write_doc__[] =
1479 "Write permission property\n"
1481 "This is a convenience method of retrieving and setting the write\n"
1482 "permission in the permission set; the \n"
1483 "same effect can be achieved using the functions\n"
1484 "add(), test(), delete(), and those can take any \n"
1485 "permission defined by your platform.\n"
1488 /* Permset getset */
1489 static PyGetSetDef Permset_getsets[] = {
1490 {"execute", Permset_get_right, Permset_set_right,
1491 __Permset_execute_doc__, &holder_ACL_EXECUTE},
1492 {"read", Permset_get_right, Permset_set_right,
1493 __Permset_read_doc__, &holder_ACL_READ},
1494 {"write", Permset_get_right, Permset_set_right,
1495 __Permset_write_doc__, &holder_ACL_WRITE},
1499 static char __Permset_Type_doc__[] =
1500 "Type which represents the permission set in an ACL entry\n"
1502 "The type exists only if the OS has full support for POSIX.1e\n"
1503 "Can be retrieved either by:\n\n"
1504 ">>> perms = myEntry.permset\n"
1507 ">>> perms = posix1e.Permset(myEntry)\n"
1509 "Note that the Permset keeps a reference to its Entry, so even if \n"
1510 "you delete the entry, it won't be cleaned up and will continue to \n"
1511 "exist until its Permset will be deleted.\n"
1514 /* The definition of the Permset Type */
1515 static PyTypeObject Permset_Type = {
1516 PyVarObject_HEAD_INIT(NULL, 0)
1518 sizeof(Permset_Object),
1520 Permset_dealloc, /* tp_dealloc */
1526 0, /* tp_as_number */
1527 0, /* tp_as_sequence */
1528 0, /* tp_as_mapping */
1531 Permset_str, /* tp_str */
1532 0, /* tp_getattro */
1533 0, /* tp_setattro */
1534 0, /* tp_as_buffer */
1535 Py_TPFLAGS_DEFAULT, /* tp_flags */
1536 __Permset_Type_doc__,/* tp_doc */
1537 0, /* tp_traverse */
1539 0, /* tp_richcompare */
1540 0, /* tp_weaklistoffset */
1542 0, /* tp_iternext */
1543 Permset_methods, /* tp_methods */
1545 Permset_getsets, /* tp_getset */
1548 0, /* tp_descr_get */
1549 0, /* tp_descr_set */
1550 0, /* tp_dictoffset */
1551 Permset_init, /* tp_init */
1553 Permset_new, /* tp_new */
1558 /* Module methods */
1560 static char __deletedef_doc__[] =
1561 "delete_default(path)\n"
1562 "Delete the default ACL from a directory.\n"
1564 "This function deletes the default ACL associated with\n"
1565 "a directory (the ACL which will be ANDed with the mode\n"
1566 "parameter to the open, creat functions).\n"
1568 ":param string path: the directory whose default ACL should be deleted\n"
1571 /* Deletes the default ACL from a directory */
1572 static PyObject* aclmodule_delete_default(PyObject* obj, PyObject* args) {
1575 /* Parse the arguments */
1576 if (!PyArg_ParseTuple(args, "et", NULL, &filename))
1579 if(acl_delete_def_file(filename) == -1) {
1580 return PyErr_SetFromErrnoWithFilename(PyExc_IOError, filename);
1583 /* Return the result */
1589 static char __has_extended_doc__[] =
1590 "has_extended(item)\n"
1591 "Check if a file or file handle has an extended ACL.\n"
1593 ":param item: either a file name or a file-like object or an integer;\n"
1594 " it represents the file-system object on which to act\n"
1597 /* Check for extended ACL a file or fd */
1598 static PyObject* aclmodule_has_extended(PyObject* obj, PyObject* args) {
1599 PyObject *item, *tmp;
1603 if (!PyArg_ParseTuple(args, "O", &item))
1606 if((fd = PyObject_AsFileDescriptor(item)) != -1) {
1607 if((nret = acl_extended_fd(fd)) == -1) {
1608 PyErr_SetFromErrno(PyExc_IOError);
1611 // PyObject_AsFileDescriptor sets an error when failing, so clear
1612 // it such that further code works; some method lookups fail if an
1613 // error already occured when called, which breaks at least
1614 // PyOS_FSPath (called by FSConverter).
1616 if(PyUnicode_FSConverter(item, &tmp)) {
1617 char *filename = PyBytes_AS_STRING(tmp);
1618 if ((nret = acl_extended_file(filename)) == -1) {
1619 PyErr_SetFromErrnoWithFilename(PyExc_IOError, filename);
1630 return PyBool_FromLong(nret);
1635 /* The module methods */
1636 static PyMethodDef aclmodule_methods[] = {
1637 {"delete_default", aclmodule_delete_default, METH_VARARGS,
1640 {"has_extended", aclmodule_has_extended, METH_VARARGS,
1641 __has_extended_doc__},
1643 {NULL, NULL, 0, NULL}
1646 static char __posix1e_doc__[] =
1647 "POSIX.1e ACLs manipulation\n"
1648 "==========================\n"
1650 "This module provides support for manipulating POSIX.1e ACLS\n"
1652 "Depending on the operating system support for POSIX.1e, \n"
1653 "the ACL type will have more or less capabilities:\n\n"
1654 " - level 1, only basic support, you can create\n"
1655 " ACLs from files and text descriptions;\n"
1656 " once created, the type is immutable\n"
1657 " - level 2, complete support, you can alter\n"
1658 " the ACL once it is created\n"
1660 "Also, in level 2, more types are available, corresponding\n"
1661 "to acl_entry_t (the Entry type), acl_permset_t (the Permset type).\n"
1663 "The existence of level 2 support and other extensions can be\n"
1664 "checked by the constants:\n\n"
1665 " - :py:data:`HAS_ACL_ENTRY` for level 2 and the Entry/Permset classes\n"
1666 " - :py:data:`HAS_ACL_FROM_MODE` for ``ACL(mode=...)`` usage\n"
1667 " - :py:data:`HAS_ACL_CHECK` for the :py:func:`ACL.check` function\n"
1668 " - :py:data:`HAS_EXTENDED_CHECK` for the module-level\n"
1669 " :py:func:`has_extended` function\n"
1670 " - :py:data:`HAS_EQUIV_MODE` for the :py:func:`ACL.equiv_mode` method\n"
1671 " - :py:data:`HAS_COPY_EXT` for the :py:func:`ACL.__getstate__` and\n"
1672 " :py:func:`ACL.__setstate__` functions (pickle protocol)\n"
1676 ">>> import posix1e\n"
1677 ">>> acl1 = posix1e.ACL(file=\"file.txt\") \n"
1683 ">>> b = posix1e.ACL(text=\"u::rx,g::-,o::-\")\n"
1689 ">>> b.applyto(\"file.txt\")\n"
1690 ">>> print posix1e.ACL(file=\"file.txt\")\n"
1696 ".. py:data:: ACL_USER\n\n"
1697 " Denotes a specific user entry in an ACL.\n"
1699 ".. py:data:: ACL_USER_OBJ\n\n"
1700 " Denotes the user owner entry in an ACL.\n"
1702 ".. py:data:: ACL_GROUP\n\n"
1703 " Denotes the a group entry in an ACL.\n"
1705 ".. py:data:: ACL_GROUP_OBJ\n\n"
1706 " Denotes the group owner entry in an ACL.\n"
1708 ".. py:data:: ACL_OTHER\n\n"
1709 " Denotes the 'others' entry in an ACL.\n"
1711 ".. py:data:: ACL_MASK\n\n"
1712 " Denotes the mask entry in an ACL, representing the maximum\n"
1713 " access granted other users, the owner group and other groups.\n"
1715 ".. py:data:: ACL_UNDEFINED_TAG\n\n"
1716 " An undefined tag in an ACL.\n"
1718 ".. py:data:: ACL_READ\n\n"
1719 " Read permission in a permission set.\n"
1721 ".. py:data:: ACL_WRITE\n\n"
1722 " Write permission in a permission set.\n"
1724 ".. py:data:: ACL_EXECUTE\n\n"
1725 " Execute permission in a permission set.\n"
1727 ".. py:data:: HAS_ACL_ENTRY\n\n"
1728 " denotes support for level 2 and the Entry/Permset classes\n"
1730 ".. py:data:: HAS_ACL_FROM_MODE\n\n"
1731 " denotes support for building an ACL from an octal mode\n"
1733 ".. py:data:: HAS_ACL_CHECK\n\n"
1734 " denotes support for extended checks of an ACL's validity\n"
1736 ".. py:data:: HAS_EXTENDED_CHECK\n\n"
1737 " denotes support for checking whether an ACL is basic or extended\n"
1739 ".. py:data:: HAS_EQUIV_MODE\n\n"
1740 " denotes support for the equiv_mode function\n"
1742 ".. py:data:: HAS_COPY_EXT\n\n"
1743 " denotes support for __getstate__()/__setstate__() on an ACL\n"
1747 static struct PyModuleDef posix1emodule = {
1748 PyModuleDef_HEAD_INIT,
1756 PyInit_posix1e(void)
1760 Py_TYPE(&ACL_Type) = &PyType_Type;
1761 if(PyType_Ready(&ACL_Type) < 0)
1765 Py_TYPE(&Entry_Type) = &PyType_Type;
1766 if(PyType_Ready(&Entry_Type) < 0)
1769 Py_TYPE(&Permset_Type) = &PyType_Type;
1770 if(PyType_Ready(&Permset_Type) < 0)
1774 m = PyModule_Create(&posix1emodule);
1778 d = PyModule_GetDict(m);
1782 Py_INCREF(&ACL_Type);
1783 if (PyDict_SetItemString(d, "ACL",
1784 (PyObject *) &ACL_Type) < 0)
1787 /* 23.3.6 acl_type_t values */
1788 PyModule_AddIntConstant(m, "ACL_TYPE_ACCESS", ACL_TYPE_ACCESS);
1789 PyModule_AddIntConstant(m, "ACL_TYPE_DEFAULT", ACL_TYPE_DEFAULT);
1793 Py_INCREF(&Entry_Type);
1794 if (PyDict_SetItemString(d, "Entry",
1795 (PyObject *) &Entry_Type) < 0)
1798 Py_INCREF(&Permset_Type);
1799 if (PyDict_SetItemString(d, "Permset",
1800 (PyObject *) &Permset_Type) < 0)
1803 /* 23.2.2 acl_perm_t values */
1804 PyModule_AddIntConstant(m, "ACL_READ", ACL_READ);
1805 PyModule_AddIntConstant(m, "ACL_WRITE", ACL_WRITE);
1806 PyModule_AddIntConstant(m, "ACL_EXECUTE", ACL_EXECUTE);
1808 /* 23.2.5 acl_tag_t values */
1809 PyModule_AddIntConstant(m, "ACL_UNDEFINED_TAG", ACL_UNDEFINED_TAG);
1810 PyModule_AddIntConstant(m, "ACL_USER_OBJ", ACL_USER_OBJ);
1811 PyModule_AddIntConstant(m, "ACL_USER", ACL_USER);
1812 PyModule_AddIntConstant(m, "ACL_GROUP_OBJ", ACL_GROUP_OBJ);
1813 PyModule_AddIntConstant(m, "ACL_GROUP", ACL_GROUP);
1814 PyModule_AddIntConstant(m, "ACL_MASK", ACL_MASK);
1815 PyModule_AddIntConstant(m, "ACL_OTHER", ACL_OTHER);
1817 /* Document extended functionality via easy-to-use constants */
1818 PyModule_AddIntConstant(m, "HAS_ACL_ENTRY", 1);
1820 PyModule_AddIntConstant(m, "HAS_ACL_ENTRY", 0);
1824 /* Linux libacl specific acl_to_any_text constants */
1825 PyModule_AddIntConstant(m, "TEXT_ABBREVIATE", TEXT_ABBREVIATE);
1826 PyModule_AddIntConstant(m, "TEXT_NUMERIC_IDS", TEXT_NUMERIC_IDS);
1827 PyModule_AddIntConstant(m, "TEXT_SOME_EFFECTIVE", TEXT_SOME_EFFECTIVE);
1828 PyModule_AddIntConstant(m, "TEXT_ALL_EFFECTIVE", TEXT_ALL_EFFECTIVE);
1829 PyModule_AddIntConstant(m, "TEXT_SMART_INDENT", TEXT_SMART_INDENT);
1831 /* Linux libacl specific acl_check constants */
1832 PyModule_AddIntConstant(m, "ACL_MULTI_ERROR", ACL_MULTI_ERROR);
1833 PyModule_AddIntConstant(m, "ACL_DUPLICATE_ERROR", ACL_DUPLICATE_ERROR);
1834 PyModule_AddIntConstant(m, "ACL_MISS_ERROR", ACL_MISS_ERROR);
1835 PyModule_AddIntConstant(m, "ACL_ENTRY_ERROR", ACL_ENTRY_ERROR);
1837 #define LINUX_EXT_VAL 1
1839 #define LINUX_EXT_VAL 0
1841 /* declare the Linux extensions */
1842 PyModule_AddIntConstant(m, "HAS_ACL_FROM_MODE", LINUX_EXT_VAL);
1843 PyModule_AddIntConstant(m, "HAS_ACL_CHECK", LINUX_EXT_VAL);
1844 PyModule_AddIntConstant(m, "HAS_EXTENDED_CHECK", LINUX_EXT_VAL);
1845 PyModule_AddIntConstant(m, "HAS_EQUIV_MODE", LINUX_EXT_VAL);
1847 PyModule_AddIntConstant(m, "HAS_COPY_EXT",
1848 #ifdef HAVE_ACL_COPY_EXT