Skip to content

Commit 1bd729f

Browse files
vabvab
committed
docs update; license change
Summary of changes: * Documentation updates * README.md addd (for Github) * Spelling corrections * License changed to Unlicense (to make code easier to find with Github's search engine
1 parent 51dbc80 commit 1bd729f

File tree

7 files changed

+132
-11
lines changed

7 files changed

+132
-11
lines changed

‎COPYING

+24-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
1-
This program is public domain. It is not copyrighted. You may do as you
2-
wish with it.
1+
This is free and unencumbered software released into the public domain.
2+
3+
Anyone is free to copy, modify, publish, use, compile, sell, or
4+
distribute this software, either in source code form or as a compiled
5+
binary, for any purpose, commercial or non-commercial, and by any
6+
means.
7+
8+
In jurisdictions that recognize copyright laws, the author or authors
9+
of this software dedicate any and all copyright interest in the
10+
software to the public domain. We make this dedication for the benefit
11+
of the public at large and to the detriment of our heirs and
12+
successors. We intend this dedication to be an overt act of
13+
relinquishment in perpetuity of all present and future rights to this
14+
software under copyright law.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20+
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21+
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22+
OTHER DEALINGS IN THE SOFTWARE.
23+
24+
For more information, please refer to <http://unlicense.org>

‎ChangeLog

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Autotools updates
44
Config memcmp call updates
55
Removal of user defined config file location
66
File comment header updates
7+
Add README.md file
8+
Spelling corrections
9+
License set to Unlicense
10+
Documentation updates
711

812
Version 1.2.0
913
-------------
@@ -22,4 +26,3 @@ A minor argument processing bug was corrected
2226
Version 1.0.0
2327
-------------
2428
Initial Release
25-

‎Makefile.am

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
SUBDIRS = src etc doc
22

3-
EXTRA_DIST = BUGS doc/passgen.1 doc/passgen.conf.5 etc/passgen.conf.in
3+
EXTRA_DIST = BUGS README.md doc/passgen.1 doc/passgen.conf.5 etc/passgen.conf.in

‎README

+49-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,50 @@
1-
This program provides password candidates based on mapping data read from pseudorandom devices on your computer.
1+
CryptNET Password Generator
2+
===========================
23

4+
Overview
5+
--------
6+
This program provides password candidates. It maps data read from pseudorandom devices on your computer to arrays of characters.
7+
8+
A configuration file or command line flags can be used control the control the program. The number of candidates presented to the user can be configured. The length, level of randomness password candidates generated can be set. The exclusion of numbers, upper case letters, lower case letters, symbolic characters, and homoglyphs can be controlled.
9+
10+
License
11+
-------
12+
Public Domain
13+
14+
Installation
15+
------------
16+
This program's build process is based on GNU Autotools. To install the program, run the following commands:
17+
18+
bash$ ./configure
19+
bash$ make
20+
bash$ make install
21+
22+
Usage
23+
-----
24+
passgen [-aAChHlLNrsuUv] [--help] [--version]
25+
26+
Command Line Arguments
27+
----------------------
28+
Arg Description
29+
--- -----------
30+
-a Alpha numeric characters only.
31+
-A Alphabetic characters only.
32+
-C Suppress config file not found messages.
33+
-h Print help text.
34+
-H Homoglyph suppression level (0-2).
35+
0 - No suppression.
36+
1 - Suppress font homoglyphs such as zero, capital 'o' (oscar), one, and lowercase 'l'
37+
(lima).
38+
2 - Suppress font homoglyphs and potential character homoglyphs such as backtick,
39+
apostrophe, double quote, space, and underbar.
40+
-l The length of the password.
41+
-L For any letters, use lowercase only.
42+
-n Number of passwords to provide.
43+
-N Numeric characters only.
44+
-r Use /dev/random for password generation.
45+
-s Exclude the space character.
46+
-u Use /dev/urandom rather than /dev/random. This will speed password generation.
47+
-U For any letters, user uppercase only.
48+
-v Display version information.
49+
--help Display help text.
50+
--version Display version information.

‎README.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# CryptNET Password Generator
2+
3+
## Overview
4+
5+
This program provides password candidates. It maps data read from pseudorandom devices on your computer to arrays of characters.
6+
7+
A configuration file or command line flags can be used control the control the program. The number of candidates presented to the user can be configured. The length, level of randomness password candidates generated can be set. The exclusion of numbers, upper case letters, lower case letters, symbolic characters, and homoglyphs can be controlled.
8+
9+
## License
10+
11+
Public Domain
12+
13+
## Installation
14+
15+
This program's build process is based on GNU Autotools. To install the program, run the following commands:
16+
```
17+
bash$ ./configure
18+
bash$ make
19+
bash$ make install
20+
```
21+
22+
## Usage
23+
24+
**passgen** [-aAChHlLNrsuUv] [--help] [--version]
25+
26+
### Command Line Arguments
27+
28+
| Arg | Description |
29+
|-----|-------------|
30+
|-a| Alpha numeric characters only.|
31+
|-A| Alphabetic characters only.|
32+
|-C| Suppress config file not found messages.|
33+
|-h| Print help text.|
34+
|-H| Homoglyph suppression level (0-2).|
35+
||0 - No homoglyph suppression.|
36+
||1 - Suppress font homoglyphs such as zero, capital 'o' (oscar), one, and lowercase 'l' (lima).|
37+
||2 - Suppress font homoglyphs and potential character homoglyphs such as backtick, apostrophe, double quote, space, and underbar.|
38+
|-l|The length of the password.|
39+
|-L|For any letters, use lowercase only.|
40+
|-n|Number of passwords to provide.|
41+
|-N|Numeric characters only.|
42+
|-r|Use /dev/random for password generation.|
43+
|-s|Exclude the space character.|
44+
|-u|Use /dev/urandom rather than /dev/random. This will speed password generation.|
45+
|-U|For any letters, user uppercase only.|
46+
|-v|Display version information.|
47+
|--help|Display help text.|
48+
|--version|Display version information.|

‎doc/passgen.1

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ options: [-aAChHlLNrsuUv] [--help] [--version]
1010
.B passgen
1111
generates a list of password candidates for the user to choose from by mapping operating system sources of pseudorandomness into printable character arrays with a mod operation.
1212

13-
By default, /dev/random is used as the source for entropy. If a large number of password candidates are being generated the process may be slowed while the device blocks. This can avoided by using the -u flag, which will cause the nonblocking urandom device as the entropy source.
13+
By default, /dev/random is used as the source for entropy. If a large number of password candidates are being generated the process may be slowed while the device blocks. This can avoided by using the -u flag, which will cause the non-blocking urandom device as the entropy source.
1414
.SH OPTIONS
1515
.TP
1616
.B \-a
@@ -31,7 +31,7 @@ Homoglyph suppression level (0-2)
3131
0 \- No homoglyph suppression.
3232
.RE
3333
.RS
34-
1 \- Suppress font homoglyphs such as zero, capital 'o' (oscar), one, and lowercase 'l' (lema).
34+
1 \- Suppress font homoglyphs such as zero, capital 'o' (oscar), one, and lowercase 'l' (lima).
3535
.RE
3636
.RS
3737
2 \- Suppress font homoglyphs and potential character homoglyphs such as backtick, apostrophe, double
@@ -48,7 +48,7 @@ For any letters, use lowercase only.
4848
Specifies the number of passwords to be generated.
4949
.TP
5050
.B \-N
51-
Generate password candidates using numeric charaters only.
51+
Generate password candidates using numeric characters only.
5252
.TP
5353
.B \-r
5454
Use the blocking /dev/random device for password candidate generation.

‎doc/passgen.conf.5

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The
99
.B passgen.conf
1010
configuration file is read when the
1111
.B passgen
12-
program is executed, if in exists. Usually, it is stored in the /etc directory, but could be stored elsewere. If the file is stored in a location other than the default, that location must be explicitly defined at compile time.
12+
program is executed, if in exists. Usually, it is stored in the /etc directory, but could also be stored in /usr/local/etc.
1313

1414
All of the options that
1515
.B passgen
@@ -59,13 +59,13 @@ For alphabetic characters, force the characters to a specific case.
5959
2 - Force all alphabetic characters to uppercase.
6060
.RE
6161
.TP
62-
.B homoglyph_supression_level
62+
.B homoglyph_suppression_level
6363
The level homoglyphs (similar looking characters) should be suppressed.
6464
.RS
6565
0 \- No homoglyph suppression.
6666
.RE
6767
.RS
68-
1 \- Suppress font homoglyphs such as zero, capital 'o' (Oscar), one, and lowercase 'l' (Lema).
68+
1 \- Suppress font homoglyphs such as zero, capital 'o' (Oscar), one, and lowercase 'l' (Lima).
6969
.RE
7070
.RS
7171
2 \- Suppress font homoglyphs and potential character homoglyphs such as backtick, apostrophe,

0 commit comments

Comments
 (0)