# Passlib 1.6

## 1.6.5 (2015-08-04)

> Fixed some minor bugs in the test suite which were causing erroneous test failures (:issue:`57` and :issue:`58`). The passlib library itself is unchanged.

> System Message: ERROR/3 (/build/python-passlib-EzVFOb/python-passlib-1.9.3/docs/history/1.6.rst, line 8); backlink

> Unknown interpreted text role “issue”.

> System Message: ERROR/3 (/build/python-passlib-EzVFOb/python-passlib-1.9.3/docs/history/1.6.rst, line 8); backlink

> Unknown interpreted text role “issue”.

## 1.6.3 (2015-07-25)

> This was relabeled as 1.6.4 due to PyPI upload issues.

## 1.6.2 (2013-12-26)

> Minor changes & compatibility fixes

> - Re-tuned the `default_rounds` values for all of the hashes.

> - Added the new bcrypt_sha256 hash, which wraps BCrypt using SHA256 in order to work around BCrypt’s password size limitations (:issue:`43`).

>   System Message: ERROR/3 (/build/python-passlib-EzVFOb/python-passlib-1.9.3/docs/history/1.6.rst, line 73); backlink

>   Unknown interpreted text role “issue”.

> - passlib.hash.bcrypt: Added support for the bcrypt library as one of the possible bcrypt backends that will be used if available. (:issue:`49`)

>   System Message: ERROR/3 (/build/python-passlib-EzVFOb/python-passlib-1.9.3/docs/history/1.6.rst, line 77); backlink

>   Unknown interpreted text role “issue”.

> - `passlib.ext.django`: Passlib’s Django extension (and it’s related hashes and unittests) have been updated to handle some minor API changes in Django 1.5-1.6. They should now be compatible with Django 1.2 and up. (:issue:`50`)

>   System Message: ERROR/3 (/build/python-passlib-EzVFOb/python-passlib-1.9.3/docs/history/1.6.rst, line 82); backlink

>   Unknown interpreted text role “issue”.

## 1.6.1 (2012-08-02)

> Minor bugfix release

> - bugfix: Various `CryptContext` methods would incorrectly raise `TypeError` if passed a `unicode` user category under Python 2. For consistency, `unicode` user category values are now encoded to `utf-8` `bytes` under Python 2.

> - bugfix: Reworked internals of the `CryptContext` config compiler to fix a couple of border cases (:issue:`39`):

>   System Message: ERROR/3 (/build/python-passlib-EzVFOb/python-passlib-1.9.3/docs/history/1.6.rst, line 97); backlink

>   Unknown interpreted text role “issue”.

>   > - It will now throw a `ValueError` if the default scheme is marked as deprecated.

>   > - If no default scheme is specified, it will use the first non-deprecated scheme.

>   > - Finally, it will now throw a `ValueError` if all schemes are marked as deprecated.

> - bugfix: FreeBSD 8.3 added native support for `sha256_crypt` – updated Passlib’s unittests and documentation accordingly (:issue:`35`).

>   System Message: ERROR/3 (/build/python-passlib-EzVFOb/python-passlib-1.9.3/docs/history/1.6.rst, line 108); backlink

>   Unknown interpreted text role “issue”.

> - bugfix: Fixed bug which caused some `passlib.apache` unittests to fail if mtime resolution >= 1 second (:issue:`35`).

>   System Message: ERROR/3 (/build/python-passlib-EzVFOb/python-passlib-1.9.3/docs/history/1.6.rst, line 111); backlink

>   Unknown interpreted text role “issue”.

> - bugfix: Fixed minor bug in `passlib.registry`, should now work correctly under Python 3.3.

> - Various documentation updates and corrections.

## 1.6.0 (2012-05-01)

### Overview

> Welcome to Passlib 1.6.

> The main goal of this release was to clean up the codebase, tighten input validation, and simplify the publically exposed interfaces. This release also brings a number of other improvements: 10 or so new hash algorithms, additional security precautions for the existing algorithms, a number of speed improvements, and updated documentation.

#### Deprecated APIs

> In order to improve the publically exposed interface, some of the more cumbersome and less-used functions in Passlib have been deprecated / renamed. This should not affect 99% of applications. That said, all the deprecated interfaces are still present, and will continue to be supported for at least one more major release. To help with migration, all deprecated functions should issue an informative `DeprecationWarning` when they are invoked, detailing their suggested replacement. The following interfaces have changed:

> - The semi-internal `CryptPolicy` class has been deprecated in its entirety. All functionality has been rolled into the parent `CryptContext` class (see below for more).

> - The interface of the `passlib.apache` classes has been improved: some confusing methods and options have been renamed, some new constructors and other functions have been added.

> - The (undocumented) `passlib.win32` module has been deprecated, all of its functionality is now offered through the lmhash and nthash algorithms.

### New Hashes

> The release adds support for a number of hash algorithms:

> cisco_pix, cisco_type7

>   Two hash formats frequently found on various Cisco devices (for Cisco Type 5 hashes, see md5_crypt ).

> django_pbkdf2_sha256, django_pbkdf2_sha1, django_bcrypt

>   All three of the new hash schemes introduced in Django 1.4.

> lmhash, nthash

>   Microsoft’s legacy “Lan Manager” hash, and the replacement NT password hash. (the old `nthash` algorithm in Passlib 1.5 has been renamed to `bsd_nthash` , to reflect its lineage).

> msdcc, msdcc2

>   Microsoft Windows’ Domain Cached Credentials, versions 1 and 2. These algorithms also go by the names “DCC”, “MSCache”, and “MSCash”.

> mssql2000, mssql2005

>   Hash algorithms used by MS SQL Server 2000 and later.

> scram

>   A hash format added specifically for storing the complex digest information needed to authenticate a user via the SCRAM protocol (RFC 5802). It can also be used in the same way as any other password hash in Passlib.

### Existing Hashes

> Additionally, the following new features have been added to the existing hashes:

> Password Size Limit

>   All hashes in Passlib will now throw `PasswordSizeError` if handed a password that’s larger than 4096 characters.

>   This limit should be larger than any reasonable password size, and prevents various things including DOS abuses, and exploitation of OSes with a buggy `crypt()` implementation. See `PasswordSizeError` for how to change this limit.

> Constant Time Comparison

>   All hash comparisons in Passlib now use the “constant time” [1] comparison function `consteq()`, instead of `==`.

>   This change is motivated a well-known hmac timing attack which exploits short-circuit string comparisons. While this attack is not currently feasible against most password hashes, some of the weaker unsalted hashes supported by Passlib may be vulnerable; and this change has been made preventatively to all of them.

>   [1]

>   “constant time” is a misnomer, it actually takes `THETA(len(righthand_value))` time.

> Strict Parameters

>   Previous releases of Passlib would silently correct any invalid values (such as `rounds` parameters that were out of range). This is was deemed undesirable, as it leaves developers unaware they are requesting an incorrect (and potentially insecure) value.

>   Starting with this release, providing invalid values to `PasswordHash.encrypt` will result in a `ValueError`. However, most hashes now accept an optional `relaxed=True` keyword, which causes Passlib to try and correct invalid values, and if successful, issue a `PasslibHashWarning` instead. These warnings can then be filtered if desired.

> bcrypt

>   The BCrypt hash now supports the crypt_blowfish project’s `$2y$` hash prefix.

>   On an unrelated note, Passlib now offers an (experimental) pure-python implementation of BCrypt. Unfortunately, it’s still WAY too slow to be suitable for production use; and is disabled by default. If you really need it, see the BCrypt documentation for how to enable it.

> bsdi_crypt

>   BSDi-Crypt will now issue a `PasslibSecurityWarning` if an application requests an even number of rounds, due to a known weakness in DES. Existing hashes with an even number of rounds will now be flagged by `CryptContext.needs_update()`.

> ldap_salted_{digest}

>   The LDAP salted digests now support salts of any size from 4-16 bytes, though they still default to 4 (:issue:`30`).

>   System Message: ERROR/3 (/build/python-passlib-EzVFOb/python-passlib-1.9.3/docs/history/1.6.rst, line 250); backlink

>   Unknown interpreted text role “issue”.

> md5_crypt, sha256_crypt, sha512_crypt

>   The builtin implementation of these hashes has been sped up by about 25%, using an additional pre-computation step.

> unix_disabled

>   The `unix_fallback` handler has been deprecated, and will be removed in Passlib 1.8. Applications should use the stricter-but-equivalent `unix_disabled` handler instead.

>   This most likely only affects internal Passlib code.

### CryptContext

> The CryptContext class has had a thorough internal overhaul. While the primary interface has not changed at all, the internals are much stricter about input validation, common methods have shorter code-paths, and the construction and introspection of `CryptContext` objects has been greatly simplified. Changes include:

> - All new (and hopefully clearer) tutorial and reference documentation.

> - The `CryptPolicy` class and the `CryptContext.policy` attribute have been deprecated.

>   This was a semi-internal class, which most applications were not involved with at all, but to be conservative about breaking things, the existing CryptPolicy interface will remain in-place and supported until Passlib 1.8.

>   All of the functionality of this class has been rolled into `CryptContext` itself, so there’s one less class to remember. Many of the methods provided by `CryptPolicy` are now `CryptContext` methods, most with the same name and call syntax. Information on migrating existing code can be found in the deprecation warnings issued by the class itself, and in the `CryptPolicy` documentation.

> - Two new class constructors have been added (`CryptContext.from_path()` and `CryptContext.from_string()`) to aid in loading CryptContext objects directly from a configuration file.

> - The deprecated keyword can now be set to the special string `"auto"`; which will automatically deprecate all schemes except for the default one.

> - The `min_verify_time` keyword has been deprecated, will be ignored in release 1.7, and will be removed in release 1.8. It was never very useful, and now complicates the internal code needlessly.

> - All string parsing now uses stdlib’s `SafeConfigParser`.

>   Previous releases used the original `ConfigParser` interpolation; which was deprecated in Passlib 1.5, and has now been removed. This should only affect strings which contained raw `%` characters, they will now need to be escaped via `%%`.

### Other Modules

> - The api for the `passlib.apache` module has been updated to add more flexibility, and to fix some ambiguous method and keyword names. The old interface is still supported, but deprecated, and will be removed in Passlib 1.8.

> - Added the `django14_context` preset to the the `passlib.apps` module. this preconfigured CryptContext object should support all the hashes found in a typical Django 1.4 deployment.

> - new: Added `passlib.ext.django`, a Django plugin which can be used to override Django’s password hashing framework with a custom Passlib policy (an undocumented beta version of this was present in the 1.5 release).

> - new: The `passlib.utils.saslprep()` function may be useful for applications which need to normalize the unicode representation of passwords before they are hashed.

### Bugfixes

> - Handle platform-specific error strings that may be returned by the `crypt()` methods of some OSes.

> - Fixed rare `'NoneType' object has no attribute 'decode'` error that sometimes occurred on platforms with a deviant implementation of `crypt()`.

### Internal Changes

> The following changes should not affect most end users, and have been documented just to keep track of them:

> - Passlib is now source-compatible with Python 2.5+ and Python 3.x. It no longer requires the use of the 2to3 command to translate it for Python 3.

> - The unittest suite has been rewritten. It handles a number of additional border cases, enforcing uniform behavior across all hashes, and even features the addition of some simplistic fuzz testing. It will take a bit longer to run though. While not perfect, statement coverage is at about 95%. Additionally, the hash test suite has been enhanced with many more test vectors across the board, including 8-bit test vectors.

> - The internal framework used to construct the hash classes (`passlib.utils.handlers`) was rewritten drastically. The new version provides stricter input checking, reduction in boilerplate code. These changes should not affect any publically exposed routines.

>   > - `GenericHandler`’s `strict` keyword was removed, `strict=True` is now the class’s default behavior: all values must be specified, and be within the correct bounds. The new keywords `use_defaults` and `relaxed` can be used to disable these two requirements.

>   > - Most of the private methods of `GenericHandler` were renamed to begin with an underscore, to clarify their status; and turned into instance methods, to simplify the internals. (for example, `norm_salt` was renamed to `_norm_salt`).

>   > - `StaticHandler` now derives from `GenericHandler`, and requires `_calc_checksum()` be implemented instead of `encrypt()`. The old style is supported but deprecated, and support will be removed in Passlib 1.8.

>   > - Calls to `HasManyBackends.set_backend()` should now use the string `"any"` instead of the value `None`. `None` was deprecated in release 1.5, and is no longer supported.

> - `passlib.utils.h64` has been replaced by an instance of the new `Base64Engine` class. This instance is imported under the same name, and has (mostly) the same interface; but should be faster, more flexible, and better unit-tested.

> - deprecated some unused support functions within `passlib.utils`, they will be removed in release 1.7.