annotate cutils/genpwd.py @ 236:939a8da6bc92

genpwd: change the current "-e" option to "-E"
author Franz Glasner <fzglas.hg@dom66.de>
date Fri, 07 Feb 2025 19:41:15 +0100
parents 11819361ea39
children d65a4d861dad
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
227
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 # -*- coding: utf-8 -*-
230
ccbb6905914e Change copyright and note genpwd in the READNE and make an official script
Franz Glasner <fzglas.hg@dom66.de>
parents: 229
diff changeset
2 # :-
ccbb6905914e Change copyright and note genpwd in the READNE and make an official script
Franz Glasner <fzglas.hg@dom66.de>
parents: 229
diff changeset
3 # :Copyright: (c) 2018 Franz Glasner
ccbb6905914e Change copyright and note genpwd in the READNE and make an official script
Franz Glasner <fzglas.hg@dom66.de>
parents: 229
diff changeset
4 # :Copyright: (c) 2025 Franz Glasner
ccbb6905914e Change copyright and note genpwd in the READNE and make an official script
Franz Glasner <fzglas.hg@dom66.de>
parents: 229
diff changeset
5 # :License: BSD-3-Clause
ccbb6905914e Change copyright and note genpwd in the READNE and make an official script
Franz Glasner <fzglas.hg@dom66.de>
parents: 229
diff changeset
6 # :-
227
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7 r"""Generate passwords.
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 Usage: genpwd.py [ Options ] required_length
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11 Options:
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13 --type, -t web, web-safe, web-safe2, base64, base32, ascii85
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15 :Author: Franz Glasner
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
16
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
17 """
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
18
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
19 from __future__ import (division, absolute_import, print_function)
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
20
231
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
21 import argparse
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
22 import base64
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
23 import os
227
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
24 import sys
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
25
230
ccbb6905914e Change copyright and note genpwd in the READNE and make an official script
Franz Glasner <fzglas.hg@dom66.de>
parents: 229
diff changeset
26 from . import (__version__, __revision__)
ccbb6905914e Change copyright and note genpwd in the READNE and make an official script
Franz Glasner <fzglas.hg@dom66.de>
parents: 229
diff changeset
27
227
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
28
231
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
29 WEB_CHARS = b"ABCDEFGHIJKLMNOPQRSTUVWYXZabcdefghijklmnopqrstuvwxyz" \
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
30 b"0123456789.,-_;!()[]{}*"
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
31 WEB_SAFE_CHARS = b"ABCDEFGHJKLMNPQRSTUVWYXZabcdefghijkmnopqrstuvwxyz" \
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
32 b"23456789.,-_;!"
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
33 WEB_SAFE2_CHARS = b".,-_;!" + WEB_SAFE_CHARS # prefer punctionation chars
227
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35 PY2 = sys.version_info[0] <= 2
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37
231
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
38 def main(argv=None):
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
39 aparser = argparse.ArgumentParser(
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
40 description="A simple password generator for password of a given"
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
41 " length within a character repertoire",
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
42 fromfile_prefix_chars='@')
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
43 aparser.add_argument(
235
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
44 "--version", "-v", action="version",
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
45 version="%s (rv:%s)" % (__version__, __revision__))
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
46 aparser.add_argument(
236
939a8da6bc92 genpwd: change the current "-e" option to "-E"
Franz Glasner <fzglas.hg@dom66.de>
parents: 235
diff changeset
47 "-E", dest="use_bin_length", action="store_true",
235
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
48 help="For some repertoires make OUTPUT-LENGTH the number of bytes"
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
49 " that is to be read from random sources instead of output bytes")
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
50 aparser.add_argument(
231
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
51 "--repertoire", "--type", "-t",
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
52 choices=("web", "web-safe", "web-safe2",
232
7ac8a2537bc9 Implement the urlsafe base64 character repertoire
Franz Glasner <fzglas.hg@dom66.de>
parents: 231
diff changeset
53 "base64", "urlsafe-base64", "urlsafe", "base32", "ascii85", ),
231
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
54 default="web-safe2",
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
55 help="Select the character repertoire. Default: web-safe2")
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
56 aparser.add_argument(
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
57 "req_length", metavar="OUTPUT-LENGTH", type=int,
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
58 help="The required length of the generated password")
227
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
59
231
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
60 opts = aparser.parse_args(args=argv)
227
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
61
231
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
62 if opts.repertoire == "web":
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
63 pwd = gen_web(opts.req_length, WEB_CHARS)
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
64 elif opts.repertoire == "web-safe":
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
65 pwd = gen_web(opts.req_length, WEB_SAFE_CHARS)
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
66 elif opts.repertoire == "web-safe2":
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
67 pwd = gen_web(opts.req_length, WEB_SAFE2_CHARS)
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
68 elif opts.repertoire == "base64":
227
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
69 encoder = base64.b64encode
235
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
70 pwd = gen_bin(opts.req_length, opts.use_bin_length, encoder,
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
71 rstrip_chars=b"=")
232
7ac8a2537bc9 Implement the urlsafe base64 character repertoire
Franz Glasner <fzglas.hg@dom66.de>
parents: 231
diff changeset
72 elif opts.repertoire in ("urlsafe-base64", "urlsafe"):
7ac8a2537bc9 Implement the urlsafe base64 character repertoire
Franz Glasner <fzglas.hg@dom66.de>
parents: 231
diff changeset
73 encoder = base64.urlsafe_b64encode
235
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
74 pwd = gen_bin(opts.req_length, opts.use_bin_length, encoder,
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
75 rstrip_chars=b"=")
231
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
76 elif opts.repertoire == "base32":
227
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
77 encoder = base64.b32encode
235
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
78 pwd = gen_bin(opts.req_length, opts.use_bin_length, encoder,
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
79 rstrip_chars=b"=")
231
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
80 elif opts.repertoire == "ascii85":
227
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
81 encoder = base64.a85encode
235
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
82 pwd = gen_bin(opts.req_length, opts.use_bin_length, encoder)
227
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
83 else:
231
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
84 raise NotImplementedError("type not yet implemented: %s"
6d8443878a00 Use argparse in genpwd.py now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 230
diff changeset
85 % opts.repertoire)
235
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
86 if opts.use_bin_length:
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
87 if len(pwd) < opts.req_length:
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
88 raise AssertionError("internal length mismatch")
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
89 else:
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
90 if len(pwd) != opts.req_length:
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
91 raise AssertionError("internal length mismatch")
234
c7dc57c44e8b FIX: For Python3: decode from ASCII before printing them: this removes the binary b'xxx' representation there
Franz Glasner <fzglas.hg@dom66.de>
parents: 233
diff changeset
92 if not PY2:
c7dc57c44e8b FIX: For Python3: decode from ASCII before printing them: this removes the binary b'xxx' representation there
Franz Glasner <fzglas.hg@dom66.de>
parents: 233
diff changeset
93 pwd = pwd.decode("ascii")
227
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
94 print(pwd)
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
95
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
96
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
97 def gen_web(length, chars):
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
98 mult = 256//len(chars)
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
99 repertoire = chars * mult
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
100 assert len(repertoire) <= 256
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
101 pwd = []
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
102 while len(pwd) < length:
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
103 c = os.urandom(1)
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
104 if PY2:
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
105 c = ord(c)
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
106 else:
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
107 c = c[0]
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
108 if c < len(repertoire):
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
109 pwd.append(repertoire[c])
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
110 if PY2:
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
111 pwd = b''.join(pwd)
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
112 else:
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
113 pwd = bytes(pwd)
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
114 return pwd
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
115
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
116
235
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
117 def gen_bin(length, use_bin_length, encoder, rstrip_chars=None):
227
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
118 pwd = encoder(os.urandom(length))
235
11819361ea39 Implement option "-e" for genpwd to require a binary length instead of the output length.
Franz Glasner <fzglas.hg@dom66.de>
parents: 234
diff changeset
119 return pwd.rstrip(rstrip_chars) if use_bin_length else pwd[:length]
227
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
120
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
121
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
122 if __name__ == "__main__":
4bb2d0975cfe imports: import genpwd,py from fmgbackup4.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
123 main()