48 lines
1.5 KiB
Markdown
48 lines
1.5 KiB
Markdown
# ft_ssl
|
|
|
|
## Code Style
|
|
|
|
- Allman braces: opening and closing braces each on their own line
|
|
- Yoda conditions: constant on the left (e.g. 0 == val, NULL != ptr)
|
|
- C99 compliant
|
|
- Tabs only, width 4
|
|
- snake_case for functions and variables, SCREAMING_SNAKE_CASE for macros
|
|
- System includes, then a blank line, then local includes
|
|
- Variable declarations aligned with tabs within the function body
|
|
- Static helper functions are forward-declared at the top of the file and
|
|
defined after the main public function
|
|
- Function definitions (not forward declarations or prototypes) have a newline
|
|
between the return type and the function name
|
|
- Line continuations are indented 2 tabs past the base scope indentation
|
|
|
|
## Dependencies
|
|
|
|
- clang
|
|
- make
|
|
- autotools
|
|
- POSIX-compliant OS
|
|
- libc
|
|
- [libcli](https://git.lohic.dev/loic/libcli)
|
|
- [libft_ssl](https://git.lohic.dev/loic/libft_ssl)
|
|
|
|
## Usage
|
|
|
|
```
|
|
ft_ssl {md5|sha256|whirlpool} [-pqr] [-s string] [file...]
|
|
|
|
Options:
|
|
-h, --help Display this help and exit
|
|
-V, --version Display version information and exit
|
|
-p, --stdin Echo stdin to stdout and append checksum to output
|
|
-q, --quiet Quiet mode: only print the digest
|
|
-r, --reverse Reverse the output format (digest then filename)
|
|
-s, --string <STR> Hash a string
|
|
```
|
|
|
|
## License
|
|
|
|
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
|
|
|
|
## Authors
|
|
|
|
- **lohhiiccc** - [git](https://git.lohic.dev)
|