Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
andyone committed Jun 8, 2024
1 parent 0a3b3d0 commit f7a3f25
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 43 deletions.
89 changes: 89 additions & 0 deletions .github/images/usage.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 1 addition & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,49 +58,7 @@ docker run --rm -it -v "$(pwd):/data" ghcr.io/essentialkaos/web-utils:latest # p

### Usage

```
Usage: web-utils command args…
Commands
┌ csr-gen host Generate key and a certificate signing request
└ csr-gen config Generate key and a certificate signing request from OpenSSL configuration file
csr-info csr Print info from certificate signing request
csr-config-gen host Generate OpenSSL configuration file for certificate signing request generation
crt-info crt Print info from certificate
┌ hpkp-gen csr backup Generate HTTP public key pinning (HPKP) header from CSR file
│ hpkp-gen key backup Generate HTTP public key pinning (HPKP) header from KEY file
└ hpkp-gen crt backup Generate HTTP public key pinning (HPKP) header from CRT file
┌ ocsp-gen server-cert issuer-cert Generate OCSP stapling file from server certificate
└ ocsp-gen cert-chain Generate OCSP stapling file from server certificate chain
ocsp-check host server-name Check OCSP response status for some host
0rtt-check host server-name Check 0-RTT support
htpasswd user password Generate record with MD5 password hash for .htpasswd files
Options
--ecc, -E Generate ECC certificate signing request
--size, -s size Key size (ECC: 256-384 / RSA: 2048-8192)
--help, -h Show this help message
--version, -v Show information about version
Examples
web-utils csr-gen domain.com
Generate RSA key and a certificate signing request for domain.com
web-utils hpkp-gen domain.com.csr domain.com.backup.key
Generate HTTP public key pinning (HPKP) header with server and backup pins
web-utils ocsp-gen sever.crt issuer.crt
Generate OCSP stapling file using server and issuer certificates
web-utils ocsp-gen sever-chain.crt
Generate OCSP stapling file using certificate chain
web-utils ocsp-check essentialkaos.com
Check OCSP response status for essentialkaos.com
```
<img src=".github/images/usage.svg" />

### Build Status

Expand Down

0 comments on commit f7a3f25

Please sign in to comment.