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