acl.c

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