diff options
author | Richard Levitte <levitte@openssl.org> | 2020-04-14 19:06:12 +0200 |
---|---|---|
committer | Pauli <paul.dale@oracle.com> | 2020-04-20 08:56:05 +1000 |
commit | 33df1cfdd54cb8dd35734e6d655cfc4c8b692589 (patch) | |
tree | e3c5351de26a117bbe1aa6a90748aa1d5df9d200 /doc/man7/EVP_PKEY-EC.pod | |
parent | 4114964865435edc475c9ba49a7fa2b78956ab76 (diff) |
DOC: Refactor provider-keymgmt(7) to give the keytypes their own pages
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/11546)
Diffstat (limited to 'doc/man7/EVP_PKEY-EC.pod')
-rw-r--r-- | doc/man7/EVP_PKEY-EC.pod | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/doc/man7/EVP_PKEY-EC.pod b/doc/man7/EVP_PKEY-EC.pod new file mode 100644 index 0000000000..88d0ebdd36 --- /dev/null +++ b/doc/man7/EVP_PKEY-EC.pod @@ -0,0 +1,64 @@ +=pod + +=head1 NAME + +EVP_PKEY-EC - EVP_PKEY EC keytype and algorithm support + +=head1 DESCRIPTION + +The B<EC> keytype is implemented in OpenSSL's default provider. + +=head2 Common EC parameters + +The following Import/Export types are available for the built-in EC algorithm: + +=over 4 + +=item "curve-name" (B<OSSL_PKEY_PARAM_EC_NAME>) <utf8 string> + +The EC curve name. + +=item "use-cofactor-flag" (B<OSSL_PKEY_PARAM_USE_COFACTOR_ECDH>) <integer> + +Enable Cofactor DH (ECC CDH) if this value is 1, otherwise it uses normal EC DH +if the value is zero. The cofactor variant multiplies the shared secret by the +EC curve's cofactor (note for some curves the cofactor is 1). + +=for comment The following link should become L<EVP_KEYEXCH-ECDH(7)> + +See also L<provider-keyexch(7)> for the related +B<OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE> parameter that can be set on a +per-operation basis. + +=item "pub" (B<OSSL_PKEY_PARAM_PUB_KEY>) <octet string> + +The public key value in EC point format. + +=item "priv" (B<OSSL_PKEY_PARAM_PRIV_KEY>) <unsigned integer> + +The private key value. + +=back + +=head1 EXAMPLES + +An B<EVP_PKEY> context can be obtained by calling: + + EVP_PKEY_CTX *pctx = + EVP_PKEY_CTX_new_from_name(NULL, "EC", NULL); + +=head1 SEE ALSO + +L<EVP_KEYMGMT(3)>, L<EVP_PKEY(3)>, L<provider-keymgmt(7)>, +L<EVP_SIGNATURE-ECDSA(7)>, L<EVP_KEYEXCH-ECDH(7)> + +=head1 COPYRIGHT + +Copyright 2020 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. + +=cut |