[Python-checkins] r88512 - in python/branches/py3k: Doc/library/crypt.rst Lib/crypt.py Lib/test/test_crypt.py
brett.cannon
python-checkins at python.org
Tue Feb 22 22:48:06 CET 2011
Author: brett.cannon
Date: Tue Feb 22 22:48:06 2011
New Revision: 88512
Log:
Make Lib/crypt.py meet PEP 8 standards. This also led to a tweak in the new API
by making methods() into a module attribute as it is statically calculated.
Modified:
python/branches/py3k/Doc/library/crypt.rst
python/branches/py3k/Lib/crypt.py
python/branches/py3k/Lib/test/test_crypt.py
Modified: python/branches/py3k/Doc/library/crypt.rst
==============================================================================
--- python/branches/py3k/Doc/library/crypt.rst (original)
+++ python/branches/py3k/Doc/library/crypt.rst Tue Feb 22 22:48:06 2011
@@ -60,6 +60,20 @@
.. versionadded:: 3.3
+
+Module Attributes
+-----------------
+
+
+.. attribute:: methods
+
+ A list of available password hashing algorithms, as
+ ``crypt.METHOD_*`` objects. This list is sorted from strongest to
+ weakest, and is guaranteed to have at least ``crypt.METHOD_CRYPT``.
+
+.. versionadded:: 3.3
+
+
Module Functions
----------------
@@ -98,13 +112,6 @@
Before version 3.3, *salt* must be specified as a string and cannot
accept ``crypt.METHOD_*`` values (which don't exist anyway).
-.. function:: methods()
-
- Return a list of available password hashing algorithms, as
- ``crypt.METHOD_*`` objects. This list is sorted from strongest to
- weakest, and is guaranteed to have at least ``crypt.METHOD_CRYPT``.
-
-.. versionadded:: 3.3
.. function:: mksalt(method=None)
Modified: python/branches/py3k/Lib/crypt.py
==============================================================================
--- python/branches/py3k/Lib/crypt.py (original)
+++ python/branches/py3k/Lib/crypt.py Tue Feb 22 22:48:06 2011
@@ -1,61 +1,57 @@
-'''Wrapper to the POSIX crypt library call and associated functionality.
-'''
+"""Wrapper to the POSIX crypt library call and associated functionality."""
import _crypt
+import string
+from random import choice
+from collections import namedtuple
-saltchars = 'abcdefghijklmnopqrstuvwxyz'
-saltchars += saltchars.upper()
-saltchars += '0123456789./'
+_saltchars = string.ascii_letters + string.digits + './'
-class _MethodClass:
- '''Class representing a salt method per the Modular Crypt Format or the
- legacy 2-character crypt method.'''
- def __init__(self, name, ident, salt_chars, total_size):
- self.name = name
- self.ident = ident
- self.salt_chars = salt_chars
- self.total_size = total_size
+
+class _Method(namedtuple('_Method', 'name ident salt_chars total_size')):
+
+ """Class representing a salt method per the Modular Crypt Format or the
+ legacy 2-character crypt method."""
def __repr__(self):
- return '<crypt.METHOD_%s>' % self.name
+ return '<crypt.METHOD_{}>'.format(self.name)
-# available salting/crypto methods
-METHOD_CRYPT = _MethodClass('CRYPT', None, 2, 13)
-METHOD_MD5 = _MethodClass('MD5', '1', 8, 34)
-METHOD_SHA256 = _MethodClass('SHA256', '5', 16, 63)
-METHOD_SHA512 = _MethodClass('SHA512', '6', 16, 106)
-
-
-def methods():
- '''Return a list of methods that are available in the platform ``crypt()``
- library, sorted from strongest to weakest. This is guaranteed to always
- return at least ``[METHOD_CRYPT]``'''
- method_list = [ METHOD_SHA512, METHOD_SHA256, METHOD_MD5 ]
- ret = [ method for method in method_list
- if len(crypt('', method)) == method.total_size ]
- ret.append(METHOD_CRYPT)
- return ret
-
-
-def mksalt(method = None):
- '''Generate a salt for the specified method. If not specified, the
- strongest available method will be used.'''
- import random
-
- if method == None: method = methods()[0]
- s = '$%s$' % method.ident if method.ident else ''
- s += ''.join([ random.choice(saltchars) for x in range(method.salt_chars) ])
- return(s)
-
-
-def crypt(word, salt = None):
- '''Return a string representing the one-way hash of a password, preturbed
- by a salt. If ``salt`` is not specified or is ``None``, the strongest
+
+def mksalt(method=None):
+ """Generate a salt for the specified method.
+
+ If not specified, the strongest available method will be used.
+
+ """
+ if method is None:
+ method = methods[0]
+ s = '${}$'.format(method.ident) if method.ident else ''
+ s += ''.join(choice(_saltchars) for _ in range(method.salt_chars))
+ return s
+
+
+def crypt(word, salt=None):
+ """Return a string representing the one-way hash of a password, with a salt
+ prepended.
+
+ If ``salt`` is not specified or is ``None``, the strongest
available method will be selected and a salt generated. Otherwise,
``salt`` may be one of the ``crypt.METHOD_*`` values, or a string as
- returned by ``crypt.mksalt()``.'''
- if salt == None: salt = mksalt()
- elif isinstance(salt, _MethodClass): salt = mksalt(salt)
- return(_crypt.crypt(word, salt))
+ returned by ``crypt.mksalt()``.
+
+ """
+ if salt is None or isinstance(salt, _Method):
+ salt = mksalt(salt)
+ return _crypt.crypt(word, salt)
+
+
+# available salting/crypto methods
+METHOD_CRYPT = _Method('CRYPT', None, 2, 13)
+METHOD_MD5 = _Method('MD5', '1', 8, 34)
+METHOD_SHA256 = _Method('SHA256', '5', 16, 63)
+METHOD_SHA512 = _Method('SHA512', '6', 16, 106)
+
+methods = [METHOD_SHA512, METHOD_SHA256, METHOD_MD5, METHOD_CRYPT]
+methods[:-1] = [m for m in methods[:-1] if len(crypt('', m)) == m.total_size]
Modified: python/branches/py3k/Lib/test/test_crypt.py
==============================================================================
--- python/branches/py3k/Lib/test/test_crypt.py (original)
+++ python/branches/py3k/Lib/test/test_crypt.py Tue Feb 22 22:48:06 2011
@@ -11,24 +11,23 @@
print('Test encryption: ', c)
def test_salt(self):
- self.assertEqual(len(crypt.saltchars), 64)
- for method in crypt.methods():
+ self.assertEqual(len(crypt._saltchars), 64)
+ for method in crypt.methods:
salt = crypt.mksalt(method)
self.assertEqual(len(salt),
method.salt_chars + (3 if method.ident else 0))
def test_saltedcrypt(self):
- for method in crypt.methods():
+ for method in crypt.methods:
pw = crypt.crypt('assword', method)
self.assertEqual(len(pw), method.total_size)
pw = crypt.crypt('assword', crypt.mksalt(method))
self.assertEqual(len(pw), method.total_size)
def test_methods(self):
- # Gurantee that METHOD_CRYPT is the last method in crypt.methods().
- methods = crypt.methods()
- self.assertTrue(len(methods) >= 1)
- self.assertEqual(crypt.METHOD_CRYPT, methods[-1])
+ # Gurantee that METHOD_CRYPT is the last method in crypt.methods.
+ self.assertTrue(len(crypt.methods) >= 1)
+ self.assertEqual(crypt.METHOD_CRYPT, crypt.methods[-1])
def test_main():
support.run_unittest(CryptTestCase)
More information about the Python-checkins
mailing list