support python >= 3.6 only; update readme

fix unmunching
Merge pull request #3 from fsoderblom/master
2021-07-04 16:17:16 +02:00 · 2021-07-04 16:16:30 +02:00 · 2020-05-03 17:08:15 +02:00 · 2020-05-03 10:49:46 +02:00 · 2020-05-02 10:31:03 +02:00 · 2020-04-30 17:05:25 +02:00
4 changed files with 57 additions and 51 deletions
--- a/README.md
+++ b/README.md
@ -6,11 +6,10 @@ The functionality is heavily inspired by [HSXKPasswd](https://github.com/bbussch
 # Why
 Because Randall Munroe says so.

-![alt text][xkcd]
-[xkcd]: http://imgs.xkcd.com/comics/password_strength.png
+![xkcd](https://imgs.xkcd.com/comics/password_strength.png "XKCD")

 # Requirements
-Python 2 or 3 as well as myspell-dictionaries for the language(s) you want to use.
+Python 3 as well as my-/hunspell-dictionaries for the language(s) you want to use.

 # What
 A password/passphrase generator. See below for some example usage.
@ -21,25 +20,27 @@ $ sudo python3 setup.py install
 ...

 $ pwgen --help
-usage: pwgen [-h] [--generate-config] [--config-file CONFIG_FILE]
-             [--myspell-dir MYSPELL_DIR] [--lang LANG]
-             [--word-min-char WORD_MIN_CHAR] [--word-max-char WORD_MAX_CHAR]
-             [--words WORDS] [--capitalize {true,false,random}]
-             [--separators SEPARATORS] [--trailing-digits TRAILING_DIGITS]
-             [--leading-digits LEADING_DIGITS] [--special-chars SPECIAL_CHARS]
-             [--trailing-chars TRAILING_CHARS] [--leading-chars LEADING_CHARS]
-             [--passwords PASSWORDS] [--max-length MAX_LENGTH]
+usage: pwgen [-h] [--quiet] [--generate-config] [--config-file CONFIG_FILE] [--myspell-dir MYSPELL_DIR] [--encoding ENCODING]
+             [--unmunch-bin UNMUNCH_BIN] [--lang LANG] [--word-min-char WORD_MIN_CHAR] [--word-max-char WORD_MAX_CHAR] [--words WORDS]
+             [--capitalize {true,false,random}] [--separators SEPARATORS] [--trailing-digits TRAILING_DIGITS]
+             [--leading-digits LEADING_DIGITS] [--special-chars SPECIAL_CHARS] [--trailing-chars TRAILING_CHARS]
+             [--leading-chars LEADING_CHARS] [--passwords PASSWORDS] [--max-length MAX_LENGTH]

 Generate passwords

 optional arguments:
  -h, --help            show this help message and exit
+  --quiet, -q           Only echo the generated passwords.
  --generate-config, -g
                        Generate configuration file and then exit
  --config-file CONFIG_FILE, -c CONFIG_FILE
                        Configuration file to use
  --myspell-dir MYSPELL_DIR, -i MYSPELL_DIR
                        Directory containing myspell dictionaries
+  --encoding ENCODING, -e ENCODING
+                        Character encoding of the directory
+  --unmunch-bin UNMUNCH_BIN, -u UNMUNCH_BIN
+                        Path to my/hunspell unmunch binary
  --lang LANG, -l LANG  Dictionary language to use
  --word-min-char WORD_MIN_CHAR, -m WORD_MIN_CHAR
                        Minimum number of characters in a word
@ -58,17 +59,13 @@ optional arguments:
  --special-chars SPECIAL_CHARS, -S SPECIAL_CHARS
                        Possible characters to use as extra special characters
  --trailing-chars TRAILING_CHARS, -p TRAILING_CHARS
-                        Number of special characters to add at the end of the
-                        passphrase
+                        Number of special characters to add at the end of the passphrase
  --leading-chars LEADING_CHARS, -P LEADING_CHARS
-                        Number of special characters to add at the start of
-                        the passphrase
+                        Number of special characters to add at the start of the passphrase
  --passwords PASSWORDS, -n PASSWORDS
                        Number of passwords to generate
  --max-length MAX_LENGTH, -L MAX_LENGTH
-                        Maximum length of the generated passwords. Full-
-                        knowledge entropy calculation doesn't work when this
-                        is set.
+                        Maximum length of the generated passwords. Full-knowledge entropy calculation doesn't work when this is set.

 $ pwgen -g --myspell-dir /usr/share/hunspell --lang sv_SE
 Missing configuration file; generating a new at /home/user/.pwgen.cfg
@ -87,7 +84,3 @@ Blind entropy	Password
 ========================

 ```
-
-# TODO
-* documentation
-* webservice
--- a/bin/pwgen
+++ b/bin/pwgen
@ -10,6 +10,10 @@ default_config_file=os.path.expanduser('~/.pwgen.cfg')
 def main():

    parser = argparse.ArgumentParser(description='Generate passwords')
+    parser.add_argument(
+            '--quiet', '-q',
+            action='store_true',
+            help='Only echo the generated passwords.')
    parser.add_argument(
            '--generate-config', '-g',
            action='store_true',
@ -22,6 +26,12 @@ def main():
    parser.add_argument(
            '--myspell-dir', '-i',
            help='Directory containing myspell dictionaries')
+    parser.add_argument(
+            '--encoding', '-e',
+            help="Character encoding of the directory")
+    parser.add_argument(
+            '--unmunch-bin', '-u',
+            help="Path to my/hunspell unmunch binary")

    parser.add_argument(
            '--lang', '-l',
@ -79,6 +89,9 @@ def main():

    args = vars(parser.parse_args())

+    quiet = args['quiet']
+    del args['quiet']
+
    config_file = args['config_file']
    del args['config_file']

@ -100,16 +113,20 @@ def main():

    pwds, seen_entropy = pwgen.generate_passwords(conf)

-    print("Generated {} passwords".format(len(pwds)))
-    if seen_entropy:
-        print("Full-knowledge entropy is {0:.2g}".format(seen_entropy))
+    if (quiet):
+      for pw in pwds.keys():
+        print(pw)
    else:
-        print("Unable to calculate full-knowledge entropy since max_length is used")
-    print("Blind entropy\tPassword")
-    print("========================")
-    for pw in pwds.keys():
-        print("{:.5n}\t\t{}".format(pwds[pw]['entropy'], pw))
-    print("========================")
+      print("Generated {} passwords".format(len(pwds)))
+      if seen_entropy:
+          print("Full-knowledge entropy is {0:.2g}".format(seen_entropy))
+      else:
+          print("Unable to calculate full-knowledge entropy since max_length is used")
+      print("Blind entropy\tPassword")
+      print("========================")
+      for pw in pwds.keys():
+          print("{:.5n}\t\t{}".format(pwds[pw]['entropy'], pw))
+      print("========================")

 if __name__ == '__main__':
    main()
--- a/pwgen/init.py
+++ b/pwgen/init.py
@ -1,21 +1,13 @@
 #!/usr/bin/python3

+import configparser
+import locale
 import math
 import os
 import sys
 import subprocess

-if sys.version_info[0] < 3:
-    import ConfigParser as configparser
-else:
-    import configparser
-
-if sys.version_info >= (3, 6):
-    do_seed = False
-    import secrets as random
-else:
-    do_seed = True
-    import random
+import secrets as random

 class DictReadError(Exception):
    pass
@ -35,6 +27,8 @@ def update_config(
        lang='en_US',
        word_min_char=2,
        word_max_char=0,
+        unmunch_bin='',
+        encoding='',

        words=4,
        capitalize='random',
@ -63,6 +57,8 @@ def update_config(
    set_if_defined(conf, 'dictionary', 'lang', lang)
    set_if_defined(conf, 'dictionary', 'word_min_char', word_min_char)
    set_if_defined(conf, 'dictionary', 'word_max_char', word_max_char)
+    set_if_defined(conf, 'dictionary', 'unmunch_bin', unmunch_bin)
+    set_if_defined(conf, 'dictionary', 'encoding', encoding)

    if not conf.has_section('passwords'):
        conf.add_section('passwords')
@ -91,6 +87,9 @@ def _read_dictionary(conf):
    dict_file = os.path.join(conf.get('dictionary', 'myspell_dir'), '{}.dic'.format(conf.get('dictionary', 'lang')))
    aff_file = os.path.join(conf.get('dictionary', 'myspell_dir'), '{}.aff'.format(conf.get('dictionary', 'lang')))
    unmunch_bin = conf.get('dictionary', 'unmunch_bin')
+    encoding = conf.get('dictionary', 'encoding')
+    if not encoding:
+        encoding =  locale.getpreferredencoding(False)
    words = set()
    chars = 0
    if os.path.exists(aff_file) and unmunch_bin:
@ -104,7 +103,7 @@ def _read_dictionary(conf):
        if proc.returncode != 0:
            raise DictReadError('Unmunching dictionaries failed')
        for word in out.splitlines():
-            save = word.strip().decode('utf-8')
+            save = word.strip().decode(encoding)
            if not save:
                continue
            first_char = save[:1]
@ -120,7 +119,7 @@ def _read_dictionary(conf):
            words.add(save)
            chars += len(save)
    else:
-        with open(dict_file, 'r') as f:
+        with open(dict_file, encoding=encoding, mode='r') as f:
            for line in f:
                if not line:
                    continue
@ -153,8 +152,6 @@ def generate_passwords(conf):
    capitalize = conf.get('passwords', 'capitalize')
    max_len = conf.getint('passwords', 'max_length')

-    if do_seed:
-        random.seed()
    res = {}
    dict_data = _read_dictionary(conf)

--- a/setup.py
+++ b/setup.py
@ -8,24 +8,23 @@ except ImportError:

 import pwgen

-version = '0.1'
+version = '1.0'

 setup(
        name='pwgen',
        version=str(version),
        description="Passphrase generator",
        author="Fredrik Eriksson",
-        author_email="pwgen@wb9.se",
-        url="https://github.com/fredrik-eriksson/pwgen",
+        author_email="feffe@fulh.ax",
+        url="https://gitea.fulh.ax/feffe/pwgen",
        platforms=['any'],
        license='BSD',
        packages=['pwgen'],
        classifiers=[
-            'Development Status :: 1 - Planning',
+            'Development Status :: 5 - Production/Stable'
            'Environment :: Console',
            'Intended Audience :: System Administrators',
            'License :: OSI Approved :: BSD License',
-            'Programming Language :: Python :: 2',
            'Programming Language :: Python :: 3',
            'Topic :: Utilities',
            ],
Author	SHA1	Message	Date
Fredrik Eriksson	1c49155955	support python >= 3.6 only; update readme	2021-07-04 16:17:16 +02:00
Fredrik Eriksson	a69deb4a5d	fix unmunching	2021-07-04 16:16:30 +02:00
Fredrik Eriksson	8df520e6c8	Merge pull request #3 from fsoderblom/master Add --quiet option, only output the generated passwords.	2020-05-03 17:08:15 +02:00
Fredrik Soderblom	4596fc38ee	Add --quiet option, only output the generated passwords.	2020-05-03 10:49:46 +02:00
Fredrik Eriksson	6795454af1	fix #1 - UTF-8 decode problems when using en_US. Apparently the en_US dictionary in ubuntu cannot be decoded with utf-8, but works fine with iso-8859-1. As a workaround this adds another configuration and command line option: encoding. If left empty it autodetects from the environment, otherwise it should be an encoding definition that python should use to read the dictionary.	2020-05-02 10:31:03 +02:00
Fredrik Eriksson	b34c41281a	Merge PR#2 - add missing entry in dictionary section for the unmunch binary	2020-04-30 17:05:25 +02:00
Fredrik Eriksson	ff4f93a232	set unmunch_bin to an empty value by default	2020-04-30 17:04:17 +02:00
Fredrik Soderblom	240e41712c	add missing entry in dictionary section for the unmunch binary.	2020-04-30 15:46:30 +02:00