Update README and setup for 1.7.0
authorSteven Tobin <steventtobin (at) gmail.com>
Wed, 13 Jul 2016 16:42:51 +0000 (17:42 +0100)
committerSteven Tobin <steventtobin (at) gmail.com>
Wed, 13 Jul 2016 16:42:51 +0000 (17:42 +0100)
README.rst
setup.py

index 4d8316689221a11a16228948640b1967c8c4f537..20a5cbb29291af6f7dc7811850235412d4ba9471 100644 (file)
@@ -142,6 +142,17 @@ While `generate_xkcdpassword()` takes::
     delimiter=" "
 
 
+Insecure random number generators
+=================================
+`xkcdpass` uses crytographically strong random number generators where possible (provided by `random.SystemRandom()` on most modern operating systems). From version 1.7.0 falling back to an insecure RNG must be explicitly enabled, either by using a new command line variable before running the script::
+
+    xkcdpass --allow-weak-rng
+
+or setting the appropriate environment variable::
+
+    export XKCDPASS_ALLOW_WEAKRNG=1
+
+
 Filtered word list
 ===================
 While we recommend the standard word list for most purposes, we note that this list is uncensored and, as such, generated passwords could offend. For this reason, `a filtered word list can be found in the github repo <https://github.com/redacted/XKCD-password-generator/tree/master/contrib/office-safe.txt>`_ (filtered by Twig Nyugen and included here with permission).
@@ -151,6 +162,7 @@ An important caveat: due to the significant reduction in the size of the filtere
 
 Changelog
 =========
+- **1.7.0** require explicit permission to fall back to insecure PRNG
 - **1.6.4** fix broken link in README
 - **1.6.3** ensure deduplication of wordlist
 - **1.6.2** move contributors to stand-alone CONTRIBUTORS file
index 89be3209269ef2f7e2d4a9219727fcc24c10558a..93c73921c7d165e8428bf961c095b616b6cbc66e 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -3,7 +3,7 @@ from setuptools import setup
 
 setup(
     name='xkcdpass',
-    version='1.6.4',
+    version='1.7.0',
     author='Steven Tobin',
     author_email='steventtobin@gmail.com',
     url='https://github.com/redacted/XKCD-password-generator',
git clone https://git.99rst.org/PROJECT