evolix/shellpki
21
0
Fork 0
Code Issues Pull requests Releases 3 Wiki Activity

Improve README and show_usage

Browse source
This commit is contained in:
Jérémy Dubois 2022-03-29 18:10:47 +02:00
parent 5f27702f17
commit 047c6e334a
2 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -67,7 +67,7 @@ Usage: shellpki <subcommand> [options] [CommonName]
Initialize PKI (create CA key and self-signed certificate) : Initialize PKI (create CA key and self-signed certificate) :
~~~ ~~~
shellpki init <commonName_for_CA> shellpki init [options] <commonName_for_CA>
Options Options
--non-interactive do not prompt the user, and exit if an error occurs --non-interactive do not prompt the user, and exit if an error occurs
@ -76,14 +76,14 @@ Options
Create a client certificate with key and CSR directly generated on server : Create a client certificate with key and CSR directly generated on server :
~~~ ~~~
shellpki create <commonName> shellpki create [options] <commonName>
Options Options
-f, --file, --csr-file create a client certificate from a CSR (doesn't need key) -f, --file, --csr-file create a client certificate from a CSR (doesn't need key)
-p, --password prompt the user for a password to set on the client key -p, --password prompt the user for a password to set on the client key
--password-file if provided with a path to a readable file, the first line is read and set as password on the client key --password-file if provided with a path to a readable file, the first line is read and set as password on the client key
--days specify how many days the certificate should be valid --days specify how many days the certificate should be valid
--end-date specify until which date the certificate should be valid, in MM/DD/[YY]YY [hh:mm:ss] format --end-date specify until which date the certificate should be valid, in MM/DD/YYYY hh:mm:ss format
--non-interactive do not prompt the user, and exit if an error occurs --non-interactive do not prompt the user, and exit if an error occurs
--replace-existing if the certificate already exists, revoke it before creating a new one --replace-existing if the certificate already exists, revoke it before creating a new one
~~~ ~~~
@ -91,7 +91,7 @@ Options
Revoke a client certificate : Revoke a client certificate :
~~~ ~~~
shellpki revoke <commonName> shellpki revoke [options] <commonName>
Options Options
--non-interactive do not prompt the user, and exit if an error occurs --non-interactive do not prompt the user, and exit if an error occurs

7
shellpki
View file

@ -31,17 +31,18 @@ END
show_usage() { show_usage() {
cat <<EOF cat <<EOF
Usage: ${0} <subcommand> [options] [CommonName] Usage: ${0} <subcommand> [options] [CommonName]
Warning: [options] always must be before [CommonName] and after <subcommand>
Initialize PKI (create CA key and self-signed certificate) : Initialize PKI (create CA key and self-signed certificate) :
${0} init <commonName_for_CA> ${0} init [options] <commonName_for_CA>
Options Options
--non-interactive do not prompt the user, and exit if an error occurs --non-interactive do not prompt the user, and exit if an error occurs
Create a client certificate with key and CSR directly generated on server : Create a client certificate with key and CSR directly generated on server :
${0} create <commonName> ${0} create [options] <commonName>
Options Options
-f, --file, --csr-file create a client certificate from a CSR (doesn't need key) -f, --file, --csr-file create a client certificate from a CSR (doesn't need key)
@ -54,7 +55,7 @@ Create a client certificate with key and CSR directly generated on server :
Revoke a client certificate : Revoke a client certificate :
${0} revoke <commonName> ${0} revoke [options] <commonName>
Options Options
--non-interactive do not prompt the user, and exit if an error occurs --non-interactive do not prompt the user, and exit if an error occurs