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