add examples for ECC key sizes in documentation (#2952)

* add examples for ECC key sizes in documentation

Signed-off-by: Stefan Pietsch <mail.ipv4v6+gh@gmail.com>

* remove links to Go documentation
This commit is contained in:
IPv4v6 2019-08-14 16:08:41 +02:00 committed by Chris Hoffman
parent 522fa83568
commit 8fe861ec04

View file

@ -469,7 +469,7 @@ can be set in a CSR are supported.
or `ec`. or `ec`.
- `key_bits` `(int: 2048)`  Specifies the number of bits to use. This must be - `key_bits` `(int: 2048)`  Specifies the number of bits to use. This must be
changed to a valid value if the `key_type` is `ec`. changed to a valid value if the `key_type` is `ec`, e.g., 224 or 521.
- `exclude_cn_from_sans` `(bool: false)`  If true, the given `common_name` will - `exclude_cn_from_sans` `(bool: false)`  If true, the given `common_name` will
not be included in DNS or Email Subject Alternate Names (as appropriate). not be included in DNS or Email Subject Alternate Names (as appropriate).
@ -817,9 +817,7 @@ request is denied.
1024 bits for RSA keys). 1024 bits for RSA keys).
- `key_bits` `(int: 2048)`  Specifies the number of bits to use for the - `key_bits` `(int: 2048)`  Specifies the number of bits to use for the
generated keys. This will need to be changed for `ec` keys. See generated keys. This will need to be changed for `ec` keys, e.g., 224 or 521.
https://golang.org/pkg/crypto/elliptic/#Curve for an overview of allowed bit
lengths for `ec`.
- `key_usage` `(list: ["DigitalSignature", "KeyAgreement", "KeyEncipherment"])` - `key_usage` `(list: ["DigitalSignature", "KeyAgreement", "KeyEncipherment"])`
Specifies the allowed key usage constraint on issued certificates. Valid Specifies the allowed key usage constraint on issued certificates. Valid
@ -1084,8 +1082,8 @@ overwrite the existing cert/key with new values.
- `key_type` `(string: "rsa")`  Specifies the desired key type; must be `rsa` - `key_type` `(string: "rsa")`  Specifies the desired key type; must be `rsa`
or `ec`. or `ec`.
- `key_bits` `(int: 2048)`  Specifies the number of bits to use. Must be - `key_bits` `(int: 2048)`  Specifies the number of bits to use. This must be
changed to a valid value if the `key_type` is `ec`. changed to a valid value if the `key_type` is `ec`, e.g., 224 or 521.
- `max_path_length` `(int: -1)`  Specifies the maximum path length to encode in - `max_path_length` `(int: -1)`  Specifies the maximum path length to encode in
the generated certificate. `-1` means no limit. Unless the signing certificate the generated certificate. `-1` means no limit. Unless the signing certificate