https://github.com/offa/keygen
KeyGen is a generator for keys and passwords.
https://github.com/offa/keygen
c c11 cmake key-generator openssl password-generator security
Last synced: 8 months ago
JSON representation
KeyGen is a generator for keys and passwords.
- Host: GitHub
- URL: https://github.com/offa/keygen
- Owner: offa
- License: gpl-3.0
- Created: 2014-10-21T17:08:01.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-11-15T15:09:28.000Z (about 1 year ago)
- Last Synced: 2024-11-15T16:21:59.514Z (about 1 year ago)
- Topics: c, c11, cmake, key-generator, openssl, password-generator, security
- Language: C
- Homepage:
- Size: 772 KB
- Stars: 17
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# [KeyGen](https://github.com/offa/keygen)
[](https://github.com/offa/keygen/actions)
[](https://github.com/offa/keygen/releases)
[](LICENSE)
KeyGen is a generator for keys and passwords. It's usable as standalone application and library.
The cryptography behind is provided by *OpenSSL*.
## Requirements
- [**OpenSSL**](https://www.openssl.org/)
## Building
Building the library and application:
mkdir build
cd build
cmake ..
make
## Testing
After building, the tests are executed within the build directory using:
ctest
or running `make` with one of these targets:
make | < target >
----------- | -------------------------------
`test` | Runs ctest (same as `ctest`)
`unittest` | Builds and runs all test
`coverage` | Coverage (requires [gcovr](https://github.com/gcovr/gcovr))
## Usage
The unit of length are (ascii-) characters (1 char = 1 byte). So a length of 20 means 20 (ascii-) char's = 20 Byte.
### Application
The application is used with commandline arguments. Run `keygen -h` to print the help.
#### Arguments:
```
Usage: keygen [Options]
--ascii -a : Generates a key of ASCII characters, ranging from '!' to'~' (default)
--ascii-blank -w : Generates a key of ASCII characters, ranging from ' ' to'~';
same as --ascii, but includes blanks
--ascii-reduced -r : Generates a key of reduced ASCII
--alphanum -p : Generates a key of alphanumeric characters
--length -l : Generates a key of bytes length
--short -s : Shows only the key
--help -h : Shows the help
--version -v : Shows version informations and license.
```
**Note:** For generating, the `--length` / `-l` parameter is *always* necessary.
#### Examples
Key of 24 length:
$ keygen -l 20
Generated key:
----------
amZ5QiX>9Z-=4U.XP;bD
----------
Length : 20 / 20
this is equal to `keygen --ascii -l 20` and `keygen -a -l 20`.
The same key size, but with short (key only) output:
$ keygen -s -l 20
ZI^fD{dX example.key
*(Use `--short` / `-s` to write key only)*
### Library
```c
const int KEY_LENGTH = 100000; // Key length
uint8_t* buffer = malloc(KEY_LENGTH * sizeof(uint8_t)); // allocate buffer
if( buffer == NULL )
{
// Error - malloc() failed
}
else
{
KeyGenError err = keygen_createKey(buffer, KEY_LENGTH, ASCII);
if( err == KG_ERR_SUCCESS )
{
// Key generated, do something
}
else
{
// Error - handle that case
}
// Finally clean and free the buffer
keygen_cleanAndFreeBuffer(buffer, length);
}
```
## Notes
- The keylength is set to a minimum of 8 - lesser length is not allowed
- Using parameter `-s` / `--short` will reduce the output to key only
## Documentation
- [OpenSSL](https://www.openssl.org/)
- [OpenSSL Wiki](http://wiki.openssl.org/index.php/Main_Page)
## License
**GNU General Public License (GPL)**
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .