From 2fcde165befa91df7657b58cb027b24c92501198 Mon Sep 17 00:00:00 2001 From: Gibheer Date: Mon, 19 Jan 2015 20:42:29 +0100 Subject: rename readme --- README | 66 ------------------------------------------------------------------ 1 file changed, 66 deletions(-) delete mode 100644 README (limited to 'README') diff --git a/README b/README deleted file mode 100644 index 1df46e8..0000000 --- a/README +++ /dev/null @@ -1,66 +0,0 @@ -pkictl -====== - -Pkictl can be used to manage the lifecycle of keys and certificates. - -Its main purpose is the creation of certificates and control through rules of the -certification process. But it can also be used to sign and verify messages based -on private/public keys. - -The focus is on easy commands with clear error messages to make work for the admin -or user as easy as possible. But it can also be used in scripts to implement -automated workflows. - -features --------- - -The following commnds will be implemented: - -* create private key (RSA or ECDSA) -* create public key based on private key -* sign a message using a private key -* verify a message using a public key -* create a certificate sign request using a private key (WIP) -* create a certificate using a CSR (not implemented) -* show information about a CSR/private key/... (not implemented) -* verify certificate against rules and CSR (not implemented) - -Installation ------------- - -The project can be built with - - go build - -from the main directory. This will create the binary `pkictl`. - -Usage ------ - -### print all commands - -To print all commands, use - - # ./pkictl - Usage: pkictl command args - where 'command' is one of: - create-private create a new private key - create-public create a public key from a private one - create-cert-sign create a new certificate sign request - help show this help - info get info on a file - sign sign a certificate request - sign-input sign a message with a private key - verify-signature verify a signature - -Print the help for a command: - - ./pkictl create-public --help - Usage of create-public: - -output="STDOUT": path where the generated public key should be stored - -private-key="": path to the private key file - -Contributing ------------- - -The best way to contribute is to use [github.com/gibheer/pkictl](https://github.com/gibheer/pkictl). -- cgit v1.2.3-70-g09d2