NEWS.md

   1 # News
   2
   3 ## Version 0.7.1
   4
   5 *released Fri, 14 Feb 2025*
   6
   7 Minor version, with a few test improvements, and updated documentation
   8 building dependencies. No user-visible changes otherwise.
   9
  10 Tested with CPython versions 3.7-3.13, and PyPy 3.7-3.10.
  11
  12 ## Version 0.7.0
  13
  14 *released Sun, 23 Apr 2023*
  15
  16 Important: Python 3.7 is the minimum supported version, due to
  17 difficulty of testing old releases, and the fact that everything older
  18 has been deprecated a long time ago (e.g. 3.6 at the end of 2021).
  19
  20 Otherwise, a minor release:
  21
  22 - Improve error handling in some corner cases (not expected to have
  23   any real-life impact, but who knows).
  24 - Improved testing coverage and test infrastructure.
  25 - Modernise parts of the C code based on recent Python version
  26   guidelines.
  27 - Add a simple security policy and contribution guidelines.
  28
  29 ## Version 0.6.0
  30
  31 *released Sun, 29 Nov 2020*
  32
  33 Major release removing Python 2 support. This allow both code cleanup
  34 and new features, such as:
  35
  36 - Support for pathlib objects in `apply_to` and `has_extended`
  37   functions when running with Python 3.6 and newer.
  38 - Use of built-in C API functions for bytes/unicode/pathlib conversion
  39   when dealing with file names, removing custom code (with the
  40   associated benefits).
  41
  42 Important API changes/bug fixes:
  43
  44 - Initialisation protocol has been changed, to disallow uninitialised
  45   objects; this means that `__new__` will always create valid objects,
  46   to prevent the need for checking initialisation status in all code
  47   paths; this also (implicitly) fixes memory leaks on re-initialisation
  48   (calling `__init__(…)` on an existing object) and segfaults (!) on
  49   non-initialised object attribute access. Note ACL re-initialisation is
  50   tricky and (still) leads to undefined behaviour of existing Entry
  51   objects pointing to it.
  52 - Fix another bug in ACL re-initialisation where failures would result
  53   in invalid objects; now failed re-initialisation does not touch the
  54   original object.
  55 - Restore `__setstate__`/`__getstate__` support on Linux; this was
  56   inadvertently removed due a typo(!) when adding support for it in
  57   FreeBSD. Pickle should work again for ACL instances, although not sure
  58   how stable this serialisation format actually is.
  59 - Additionally, slightly change `__setstate__()` input to not allow
  60   Unicode, since the serialisation format is an opaque binary format.
  61 - Fix (and change) entry qualifier (which is a user/group ID) behaviour:
  62   assume/require that uid_t/gid_t are unsigned types (they are with
  63   glibc, MacOS and FreeBSD at least; the standard doesn't document the
  64   signedness), and convert parsing and returning the qualifier to behave
  65   accordingly. The breakage was most apparent on 32-bit architectures,
  66   in which context the problem was originally reported (see issue #13).
  67
  68 Minor improvements:
  69
  70 - Added a `data` keyword argument to `ACL()`, which allows restoring an
  71   ACL directly from a serialised form (as given by `__getstate__()`),
  72   which should simplify some uses cases (`a = ACL(); a.__set
  73   state__(…)`).
  74 - When available, add the file path to I/O error messages, which should
  75   lead to easier debugging.
  76 - The test suite has changed to `pytest`, which allows increased
  77   coverage via parameterisation.
  78
  79 ## Version 0.5.4
  80
  81 *released Thu, 14 Nov 2019*
  82
  83 Maintenance release:
  84
  85 - Switch build system to Python 3 by default (can be overridden if
  86   needed).
  87 - Internal improvements for better cpychecker support.
  88 - Fix compatibility with PyPy.
  89 - Test improvements (both local and on Travis), testing more variations
  90   (debug, PyPy).
  91 - Improve test coverage, and allow gathering test coverage results.
  92 - Drop support (well, drop testing) for Python lower than 2.7.
  93 - Minor documentation improvements (closes #9, #12).
  94
  95 ## Version 0.5.3
  96
  97 *released Thu, 30 Apr 2015*
  98
  99 FreeBSD fixes:
 100
 101 - Enable all FreeBSD versions after 7.x at level 2 (thanks to Garrett
 102   Cooper).
 103 - Make test suite pass under FreeBSD, which has a stricter behaviour
 104   with regards to invalid ACLs (which we do exercise in the test suite),
 105   thanks again to Garret for the bug reports.
 106
 107 ## Version 0.5.2
 108
 109 *released Sat, 24 May 2014*
 110
 111 No visible changes release: just fix tests when running under pypy.
 112
 113 ## Version 0.5.1
 114
 115 *released Sun, 13 May 2012*
 116
 117 A bug-fix only release. Critical bugs (memory leaks and possible
 118 segmentation faults) have been fixed thanks to Dave Malcolm and his
 119 ``cpychecker`` tool. Additionally, some compatibility issues with Python
 120 3.x have been fixed (str() methods returning bytes).
 121
 122 The documentation has been improved and changed from epydoc to sphinx;
 123 note however that the documentation is still auto-generated from the
 124 docstrings.
 125
 126 Project reorganisation: the project home page has been moved from
 127 SourceForge to GitHub.
 128
 129 ## Version 0.5
 130
 131 *released Sun, 27 Dec 2009*
 132
 133 Added support for Python 3.x and improved support for Unicode filenames.
 134
 135 ## Version 0.4
 136
 137 *released Sat, 28 Jun 2008*
 138
 139 ### License
 140
 141
 142 Starting with this version, pylibacl is licensed under LGPL 2.1,
 143 Febryary 1999 or any later versions (see README.rst and COPYING).
 144
 145 ### Linux support
 146
 147 A few more Linux-specific functions:
 148
 149 - add the ACL.equiv_mode() method, which will return the equivalent
 150   octal mode if this is a basic ACL and raise an IOError exception
 151   otherwise
 152
 153 - add the acl_extended(...) function, which will check if an fd or path
 154   has an extended ACL
 155
 156 ### FreeBSD support
 157
 158 FreeBSD 7.x will have almost all the acl manipulation functions that
 159 Linux has, with the exception of __getstate__/__setstate__. As a
 160 workaround, use the str() and ACL(text=...) methods to pass around
 161 textual representations.
 162
 163 ### Interface
 164
 165 At module level there are now a few constants exported for easy-checking
 166 at runtime what features have been compiled in:
 167
 168 - `HAS_ACL_FROM_MODE`, denoting whether the ACL constructor supports
 169   the `mode=0xxx` parameter
 170
 171 - `HAS_ACL_CHECK`, denoting whether ACL instances support the
 172   `check()` method
 173
 174 - `HAS_ACL_ENTRY`, denoting whether ACL manipulation is possible and
 175   the Entry and Permset classes are available
 176
 177 - `HAS_EXTENEDED_CHECK`, denoting whether the `acl_extended()`
 178   function is supported
 179
 180 - `HAS_EQUIV_MODE`, denoting whether ACL instances support the
 181   `equiv_mode()` method
 182
 183 ### Internals
 184
 185 Many functions have now unittests, which is a good thing.
 186
 187
 188 ## Version 0.3
 189
 190 *released Sun, 21 Oct 2007*
 191
 192 ### Linux support
 193
 194 Under Linux, implement more functions from libacl:
 195
 196 - add `ACL(mode=...)`, implementing `acl_from_mode`.
 197 - add `ACL.to_any_text()`, implementing `acl_to_any_text`.
 198 - add ACL comparison, using `acl_cmp`.
 199 - add `ACL.check()`, which is a more descriptive function than
 200   validate.