removed incorrect description

[gnutls.git] / src / certtool-args.def

AutoGen Definitions options;
prog-name     = certtool;
prog-title    = "GnuTLS certificate tool";
prog-desc     = "Manipulate certificates and private keys.";
detail    = "Tool to parse and generate X.509 certificates, requests and private keys.
It can be used interactively or non interactively by
specifying the template command line option.";
short-usage   = "certtool [options]\ncerttool --help for usage instructions.\n";
explain       = "";

#define  INFILE_OPT    1
#define  OUTFILE_OPT   1
#define  VERBOSE_OPT 1
#include args-std.def

flag = {
    name      = generate-self-signed;
    value     = s;
    descrip   = "Generate a self-signed certificate";
    doc = "";
};

flag = {
    name      = generate-certificate;
    value     = c;
    descrip   = "Generate a signed certificate";
    doc = "";
};

flag = {
    name      = generate-proxy;
    descrip   = "Generates a proxy certificate";
    doc = "";
};

flag = {
    name      = generate-crl;
    descrip   = "Generate a CRL";
    doc = "";
};

flag = {
    name      = update-certificate;
    value     = u;
    descrip   = "Update a signed certificate";
    doc = "";
};

flag = {
    name      = generate-privkey;
    value     = p;
    descrip   = "Generate a private key";
    doc = "";
};

flag = {
    name      = generate-request;
    value     = q;
    descrip   = "Generate a PKCS #10 certificate request";
    doc = "";
};

flag = {
    name      = verify-chain;
    value     = e;
    descrip   = "Verify a PEM encoded certificate chain.";
    doc = "The last certificate in the chain must be a self signed one.";
};

flag = {
    name      = verify;
    descrip   = "Verify a PEM encoded certificate chain using a trusted list.";
    doc = "The trusted certificate list must be loaded with --load-ca-certificate.";
    flags-must = load-ca-certificate;
};

flag = {
    name      = verify-crl;
    descrip   = "Verify a CRL using a trusted list.";
    doc = "The trusted certificate list must be loaded with --load-ca-certificate.";
    flags-must = load-ca-certificate;
};

flag = {
    name      = generate-dh-params;
    descrip   = "Generate PKCS #3 encoded Diffie-Hellman parameters.";
    doc = "";
};

flag = {
    name      = get-dh-params;
    descrip   = "Get the included PKCS #3 encoded Diffie-Hellman parameters.";
    doc = "Returns stored DH parameters in GnuTLS. Those parameters are used in the SRP protocol. The parameters returned by fresh generation
are more efficient since GnuTLS 3.0.9.";
};

flag = {
    name      = dh-info;
    descrip   = "Print information PKCS #3 encoded Diffie-Hellman parameters";
    doc = "";
};

flag = {
    name      = load-privkey;
    descrip   = "Loads a private key file";
    arg-type  = string;
    doc = "This can be either a file or a PKCS #11 URL";
};

flag = {
    name      = load-pubkey;
    descrip   = "Loads a public key file";
    arg-type  = string;
    doc = "This can be either a file or a PKCS #11 URL";
};

flag = {
    name      = load-request;
    descrip   = "Loads a certificate request file";
    arg-type  = file;
    file-exists = yes;
    doc = "";
};

flag = {
    name      = load-certificate;
    descrip   = "Loads a certificate file";
    arg-type  = string;
    doc = "This can be either a file or a PKCS #11 URL";
};

flag = {
    name      = load-ca-privkey;
    descrip   = "Loads the certificate authority's private key file";
    arg-type  = string;
    doc = "This can be either a file or a PKCS #11 URL";
};

flag = {
    name      = load-ca-certificate;
    descrip   = "Loads the certificate authority's certificate file";
    arg-type  = string;
    doc = "This can be either a file or a PKCS #11 URL";
};

flag = {
    name      = password;
    arg-type  = string;
    descrip   = "Password to use";
    doc   = "";
};

flag = {
    name      = null-password;
    descrip   = "Enforce a NULL password";
    doc   = "This option enforces a NULL password. This may be different than the empty password in some schemas.";
};

flag = {
    name      = certificate-info;
    value     = i;
    descrip   = "Print information on the given certificate";
    doc       = "";
};

flag = {
    name      = certificate-pubkey;
    descrip   = "Print certificate's public key";
    doc       = "";
};

flag = {
    name      = pgp-certificate-info;
    descrip   = "Print information on the given OpenPGP certificate";
    doc       = "";
};

flag = {
    name      = pgp-ring-info;
    descrip   = "Print information on the given OpenPGP keyring structure";
    doc       = "";
};

flag = {
    name      = crl-info;
    value     = l;
    descrip   = "Print information on the given CRL structure";
    doc       = "";
};

flag = {
    name      = crq-info;
    descrip   = "Print information on the given certificate request";
    doc       = "";
};


flag = {
    name      = no-crq-extensions;
    descrip   = "Do not use extensions in certificate requests";
    doc       = "";
};

flag = {
    name      = p12-info;
    descrip   = "Print information on a PKCS #12 structure";
    doc       = "";
};

flag = {
    name      = p7-info;
    descrip   = "Print information on a PKCS #7 structure";
    doc       = "";
};

flag = {
    name      = smime-to-p7;
    descrip   = "Convert S/MIME to PKCS #7 structure";
    doc       = "";
};

flag = {
    name      = key-info;
    value     = k;
    descrip   = "Print information on a private key";
    doc = "";
};

flag = {
    name      = pgp-key-info;
    descrip   = "Print information on an OpenPGP private key";
    doc = "";
};

flag = {
    name      = pubkey-info;
    descrip   = "Print information on a public key";
    doc = "";
};

flag = {
    name      = v1;
    descrip   = "Generate an X.509 version 1 certificate (with no extensions)";
    doc = "";
};

flag = {
    name      = to-p12;
    descrip   = "Generate a PKCS #12 structure";
    doc = "It requires a certificate, a private key and possibly a CA certificate to be specified.";
    flags-must = load-certificate;
};

flag = {
    name      = to-p8;
    descrip   = "Generate a PKCS #8 structure";
    doc = "";
};

flag = {
    name      = pkcs8;
    value     = 8;
    descrip   = "Use PKCS #8 format for private keys";
    doc = "";
};

flag = {
    name      = rsa;
    descrip   = "Generate RSA key";
    doc = "";
};

flag = {
    name      = dsa;
    descrip   = "Generate DSA key";
    doc = "";
};

flag = {
    name      = ecc;
    descrip   = "Generate ECC (ECDSA) key";
    doc = "";
};

flag = {
    name      = hash;
    arg-type  = string;
    descrip   = "Hash algorithm to use for signing.";
    doc = "Available hash functions are SHA1, RMD160, SHA256, SHA384, SHA512.";
};

flag = {
    name      = inder;
    descrip   = "Use DER format for input certificates and private keys.";
    disabled;
    disable   = "no";
    doc       = "The input files will be assumed to be in DER or RAW format. 
Unlike options that in PEM input would allow multiple input data (e.g. multiple 
certificates), when reading in DER format a single data structure is read.";
};

flag = {
    name      = inraw;
    aliases   = inder;
};

flag = {
    name      = outder;
    descrip   = "Use DER format for output certificates and private keys";
    disabled;
    disable   = "no";
    doc       = "The output will be in DER or RAW format.";
};

flag = {
    name      = outraw;
    aliases   = outder;
};

flag = {
    name      = bits;
    arg-type  = number;
    descrip   = "Specify the number of bits for key generate";
    doc      = "";
};

flag = {
    name      = sec-param;
    arg-type  = string;
    arg-name  = "Security parameter";
    descrip   = "Specify the security level [low, legacy, normal, high, ultra].";
    doc      = "This is alternative to the bits option.";
};

flag = {
    name      = disable-quick-random;
    descrip   = "No effect";
    doc      = "";
};

flag = {
    name      = template;
    arg-type  = file;
    file-exists = yes;
    descrip   = "Template file to use for non-interactive operation";
    doc   = "";
};

flag = {
    name      = pkcs-cipher;
    arg-type  = string;
    arg-name  = "Cipher";
    descrip   = "Cipher to use for PKCS #8 and #12 operations";
    doc   = "Cipher may be one of 3des, 3des-pkcs12, aes-128, aes-192, aes-256, rc2-40, arcfour.";
};

doc-section = {
  ds-type = 'SEE ALSO';
  ds-format = 'texi';
  ds-text   = <<-_EOT_
    p11tool (1)
_EOT_;
};

doc-section = {
  ds-type = 'EXAMPLES';
  ds-format = 'texi';
  ds-text   = <<-_EOT_
@subheading Generating private keys
To create an RSA private key, run:
@example
$ certtool --generate-privkey --outfile key.pem --rsa
@end example

To create a DSA or elliptic curves (ECDSA) private key use the
above command combined with 'dsa' or 'ecc' options.

@subheading Generating certificate requests
To create a certificate request (needed when the certificate is  issued  by
another party), run:
@example
certtool --generate-request --load-privkey key.pem \
   --outfile request.pem
@end example

If the private key is stored in a smart card you can generate
a request by specifying the private key object URL.
@example
$ ./certtool --generate-request --load-privkey "pkcs11:..." \
  --load-pubkey "pkcs11:..." --outfile request.pem
@end example


@subheading Generating a self-signed certificate
To create a self signed certificate, use the command:
@example
$ certtool --generate-privkey --outfile ca-key.pem
$ certtool --generate-self-signed --load-privkey ca-key.pem \
   --outfile ca-cert.pem
@end example

Note that a self-signed certificate usually belongs to a certificate
authority, that signs other certificates.

@subheading Generating a certificate
To generate a certificate using the previous request, use the command:
@example
$ certtool --generate-certificate --load-request request.pem \
   --outfile cert.pem --load-ca-certificate ca-cert.pem \
   --load-ca-privkey ca-key.pem
@end example

To generate a certificate using the private key only, use the command:
@example
$ certtool --generate-certificate --load-privkey key.pem \
   --outfile cert.pem --load-ca-certificate ca-cert.pem \
   --load-ca-privkey ca-key.pem
@end example

@subheading Certificate information
To view the certificate information, use:
@example
$ certtool --certificate-info --infile cert.pem
@end example

@subheading PKCS #12 structure generation
To generate a PKCS #12 structure using the previous key and certificate,
use the command:
@example
$ certtool --load-certificate cert.pem --load-privkey key.pem \
   --to-p12 --outder --outfile key.p12
@end example

Some tools (reportedly web browsers) have problems with that file
because it does not contain the CA certificate for the certificate.
To work around that problem in the tool, you can use the
--load-ca-certificate parameter as follows:

@example
$ certtool --load-ca-certificate ca.pem \
  --load-certificate cert.pem --load-privkey key.pem \
  --to-p12 --outder --outfile key.p12
@end example

@subheading Diffie-Hellman parameter generation
To generate parameters for Diffie-Hellman key exchange, use the command:
@example
$ certtool --generate-dh-params --outfile dh.pem --sec-param normal
@end example

@subheading Proxy certificate generation
Proxy certificate can be used to delegate your credential to a
temporary, typically short-lived, certificate.  To create one from the
previously created certificate, first create a temporary key and then
generate a proxy certificate for it, using the commands:

@example
$ certtool --generate-privkey > proxy-key.pem
$ certtool --generate-proxy --load-ca-privkey key.pem \
  --load-privkey proxy-key.pem --load-certificate cert.pem \
  --outfile proxy-cert.pem
@end example

@subheading Certificate revocation list generation
To create an empty Certificate Revocation List (CRL) do:

@example
$ certtool --generate-crl --load-ca-privkey x509-ca-key.pem \
           --load-ca-certificate x509-ca.pem
@end example

To create a CRL that contains some revoked certificates, place the
certificates in a file and use @code{--load-certificate} as follows:

@example
$ certtool --generate-crl --load-ca-privkey x509-ca-key.pem \
  --load-ca-certificate x509-ca.pem --load-certificate revoked-certs.pem
@end example

To verify a Certificate Revocation List (CRL) do:

@example
$ certtool --verify-crl --load-ca-certificate x509-ca.pem < crl.pem
@end example
_EOT_;
};


doc-section = {
  ds-type = 'FILES';
  ds-format = 'texi';
  ds-text   = <<-_EOT_
@subheading Certtool's template file format
A template file can be used to avoid the interactive questions of
certtool. Initially create a file named 'cert.cfg' that contains the information
about the certificate. The template can be used as below:

@example
$ certtool --generate-certificate cert.pem --load-privkey key.pem  \
   --template cert.cfg \
   --load-ca-certificate ca-cert.pem --load-ca-privkey ca-key.pem
@end example

An example certtool template file that can be used to generate a certificate
request or a self signed certificate follows.

@example
# X.509 Certificate options
#
# DN options

# The organization of the subject.
organization = "Koko inc."

# The organizational unit of the subject.
unit = "sleeping dept."

# The locality of the subject.
# locality =

# The state of the certificate owner.
state = "Attiki"

# The country of the subject. Two letter code.
country = GR

# The common name of the certificate owner.
cn = "Cindy Lauper"

# A user id of the certificate owner.
#uid = "clauper"

# Set domain components
#dc = "name"
#dc = "domain"

# If the supported DN OIDs are not adequate you can set
# any OID here.
# For example set the X.520 Title and the X.520 Pseudonym
# by using OID and string pairs.
#dn_oid = 2.5.4.12 Dr. 
#dn_oid = 2.5.4.65 jackal

# This is deprecated and should not be used in new
# certificates.
# pkcs9_email = "none@@none.org"

# The serial number of the certificate
serial = 007

# In how many days, counting from today, this certificate will expire.
expiration_days = 700

# X.509 v3 extensions

# A dnsname in case of a WWW server.
#dns_name = "www.none.org"
#dns_name = "www.morethanone.org"

# A subject alternative name URI
#uri = "http://www.example.com"

# An IP address in case of a server.
#ip_address = "192.168.1.1"

# An email in case of a person
email = "none@@none.org"

# Challenge password used in certificate requests
challenge_passwd = 123456

# An URL that has CRLs (certificate revocation lists)
# available. Needed in CA certificates.
#crl_dist_points = "http://www.getcrl.crl/getcrl/"

# Whether this is a CA certificate or not
#ca

# for microsoft smart card logon
# key_purpose_oid = 1.3.6.1.4.1.311.20.2.2

### Other predefined key purpose OIDs

# Whether this certificate will be used for a TLS client
#tls_www_client

# Whether this certificate will be used for a TLS server
#tls_www_server

# Whether this certificate will be used to sign data (needed
# in TLS DHE ciphersuites).
signing_key

# Whether this certificate will be used to encrypt data (needed
# in TLS RSA ciphersuites). Note that it is preferred to use different
# keys for encryption and signing.
#encryption_key

# Whether this key will be used to sign other certificates.
#cert_signing_key

# Whether this key will be used to sign CRLs.
#crl_signing_key

# Whether this key will be used to sign code.
#code_signing_key

# Whether this key will be used to sign OCSP data.
#ocsp_signing_key

# Whether this key will be used for time stamping.
#time_stamping_key

# Whether this key will be used for IPsec IKE operations.
#ipsec_ike_key

### end of key purpose OIDs

# When generating a certificate from a certificate
# request, then honor the extensions stored in the request
# and store them in the real certificate.
#honor_crq_extensions

# Path length contraint. Sets the maximum number of
# certificates that can be used to certify this certificate.
# (i.e. the certificate chain length)
#path_len = -1
#path_len = 2

# OCSP URI
# ocsp_uri = http://my.ocsp.server/ocsp

# CA issuers URI
# ca_issuers_uri = http://my.ca.issuer

# Options for proxy certificates
# proxy_policy_language = 1.3.6.1.5.5.7.21.1

# Options for generating a CRL

# next CRL update will be in 43 days (wow)
#crl_next_update = 43

# this is the 5th CRL by this CA
#crl_number = 5

@end example

_EOT_;
};