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