acl.c

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