qca/man/qcatool.1

0001 .TH QCATOOL "1" "August 2007" "qcatool 1.0.0" "Qt Cryptographic Architecture (QCA)"
0002
0003 .SH NAME
0004 qcatool \- command line tool for the Qt Cryptographic Architecture
0005
0006 .SH DESCRIPTION
0007 qcatool is a command line tool for performing various cryptographic
0008 operations with the Qt Cryptographic Architecture (QCA). qcatool can
0009 also be used for testing and debugging QCA.
0010
0011 .SH USAGE
0012 qcatool has a range of options and commands. You only ever get to
0013 use one command, but you may use several, one or no options.
0014
0015 .SH OPTIONS
0016 As noted above, these are all optional, and may be combined.
0017 .PP
0018 .TP
0019 \fB\-\-pass\fR=PASSWORD
0020 Specify the password to use. This is probably a bad idea except for
0021 testing, because anyone can read the arguments to a command line
0022 application.
0023 .TP
0024 \fB\-\-newpass\fR=PASSWORD
0025 Specify the new password to use for password change
0026 with the \fBkey changepass\fR and \fBkeybundle changepass\fR commands.
0027 This is probably a bad idea except for
0028 testing, because anyone can read the arguments to a command line
0029 application.
0030 .TP
0031 \fB\-\-nonroots\fR=CERTIFICATES
0032 Specify additional certificates, not trusted, but which may be used
0033 in the trust path if appropriate trust can be established.
0034 .TP
0035 \fB\-\-roots\fR=CERTIFICATES
0036 Specify additional certificates which can be used as trusted (root)
0037 certificates.
0038 .TP
0039 \fB\-\-nosys\fR
0040 Disable use of the standard root certificates that are provided by
0041 the operating system.
0042 .TP
0043 \fB\-\-noprompt\fR
0044 Disable prompting for passwords/passphrases. If you do not provide
0045 the passphrase on the command line (with \fB\-\-pass\fR or \fB\-\-newpass\fR)
0046 this will cause qcatool to abort the command if a password/passphrase is
0047 required.
0048 .TP
0049 \fB\-\-ordered\fR
0050 If outputting certificate information fields (Distinguished Name and Subject Alternative Name), show them in same the order that they are present in the certificate rather than in a friendly sorted order.
0051 .TP
0052 \fB\-\-debug\fR
0053 Enable additional output to aid debugging.
0054 .TP
0055 \fB\-\-log-file=FILENAME\fR
0056 Log to the specified file.
0057 .TP
0058 \fB\-\-log-level=LEVEL\fR
0059 Log at the specified level. The log level can be between 0 (none)
0060 and 8 (most).
0061 .TP
0062 \fB\-\-nobundle\fR
0063 When S/MIME signing, do not bundle the signer's certificate chain inside the signature.  This results in a smaller signature output, but requires the recipient to have all of the necessary certificates in order to verify it.
0064
0065 .SH COMMANDS
0066 .TP
0067 \fBhelp\fR, \fB\-\-help\fR, \fB\-h\fR
0068 Output usage (help) information.
0069 .TP
0070 \fBversion\fR, \fB\-\-version\fR, \fB\-v\fR
0071 Output version information.
0072 .TP
0073 \fBplugins\fR
0074 List available plugins. Use the \fB\-\-debug\fR option to get
0075 more information on plugins which are found and which ones actually
0076 loaded.
0077 .TP
0078 \fBconfig save \fI[provider]\fR
0079 Save provider configuration. Use this to have the provider's default configuration written to persistent storage, which you can then edit by hand.
0080 .TP
0081 \fBconfig edit \fI[provider]\fR
0082 Edit provider configuration. The changes are written to persistent storage.
0083 .TP
0084 \fBkey make rsa|dsa [bits]\fR
0085 Create a key pair
0086 .TP
0087 \fBkey changepass [K]
0088 Add/change/remove passphrase of a key
0089 .TP
0090 \fBcert makereq [K]\fR
0091 Create certificate request (CSR)
0092 .TP
0093 \fBcert makeself [K]\fR
0094 Create self-signed certificate
0095 .TP
0096 \fBcert makereqadv [K]\fR
0097 Advanced version of 'makereq'
0098 .TP
0099 \fBcert makeselfadv [K]\fR
0100 Advanced version of 'makeself'
0101 .TP
0102 \fBcert validate [C]\fR
0103 Validate certificate
0104 .TP
0105 \fBkeybundle make [K] [C]\fR
0106 Create a keybundle
0107 .TP
0108 \fBkeybundle extract [X]\fR
0109 Extract certificate(s) and key
0110 .TP
0111 \fBkeybundle changepass [X]\fR
0112 Change passphrase of a keybundle
0113 .TP
0114 \fBkeystore list-stores\fR
0115 List all available keystores
0116 .TP
0117 \fBkeystore list [storeName]\fR
0118 List content of a keystore
0119 .TP
0120 \fBkeystore monitor\fR
0121 Monitor for keystore availability
0122 .TP
0123 \fBkeystore export [E]\fR
0124 Export a keystore entry's content
0125 .TP
0126 \fBkeystore exportref [E]\fR
0127 Export a keystore entry reference
0128 .TP
0129 \fBkeystore addkb [storeName] [cert.p12]\fR
0130 Add a keybundle into a keystore
0131 .TP
0132 \fBkeystore addpgp [storeName] [key.asc]\fR
0133 Add a PGP key into a keystore
0134 .TP
0135 \fBkeystore remove [E]\fR
0136 Remove an object from a keystore
0137 .TP
0138 \fBshow cert [C]\fR
0139 Examine a certificate
0140 .TP
0141 \fBshow req [req.pem]\fR
0142 Examine a certificate request (CSR)
0143 .TP
0144 \fBshow crl [crl.pem]\fR
0145 Examine a certificate revocation list
0146 .TP
0147 \fBshow kb [X]\fR
0148 Examine a keybundle
0149 .TP
0150 \fBshow pgp [P|S]\fR
0151 Examine a PGP key
0152 .TP
0153 \fBmessage sign pgp|pgpdetach|smime [X|S]\fR
0154 Sign a message
0155 .TP
0156 \fBmessage encrypt pgp|smime [C|P]\fR
0157 Encrypt a message
0158 .TP
0159 \fBmessage signencrypt [S] [P]\fR
0160 PGP sign & encrypt a message
0161 .TP
0162 \fBmessage verify pgp|smime\fR
0163 Verify a message
0164 .TP
0165 \fBmessage decrypt pgp|smime ((X) ...)\fR
0166 Decrypt a message (S/MIME needs X)
0167 .TP
0168 \fBmessage exportcerts\fR
0169 Export certs from S/MIME message
0170
0171 .SH ARGUMENTS
0172 The arguments to the commands are as follows.
0173
0174 K = private key.
0175
0176 C = certificate.
0177
0178 X = key bundle.
0179
0180 P = PGP public key.
0181
0182 S = PGP secret key.
0183
0184 E = generic entry.
0185
0186 These must be identified by either a filename or a keystore reference ("store:obj").
0187
0188 .SH AUTHOR
0189 qcatool was written by Justin Karneges as part of QCA. This manual page
0190 was written by Brad Hards.
0191