diff options
author | Richard Levitte <levitte@openssl.org> | 2019-10-30 18:03:07 +0100 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2019-11-05 22:20:06 +0100 |
commit | c0e0984f125ee30820520829c4c112b1e166f871 (patch) | |
tree | fbc23f98d35454a4b83bd08b11dea17acd0e8460 /doc | |
parent | 677c4a012a7e72b5f2dd239639034f01fad850bf (diff) |
EVP: Make the KEYEXCH implementation leaner
Because the algorithm to use is decided already when creating an
EVP_PKEY_CTX regardless of how it was created, it turns out that it's
unnecessary to provide the KEYEXCH method explicitly, and rather
always have it be fetched implicitly.
This means fewer changes for applications that want to use new key
exchange algorithms / implementations.
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10305)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/EVP_PKEY_derive.pod | 39 |
1 files changed, 15 insertions, 24 deletions
diff --git a/doc/man3/EVP_PKEY_derive.pod b/doc/man3/EVP_PKEY_derive.pod index 832498ba76..954a3501e8 100644 --- a/doc/man3/EVP_PKEY_derive.pod +++ b/doc/man3/EVP_PKEY_derive.pod @@ -2,43 +2,34 @@ =head1 NAME -EVP_PKEY_derive_init, EVP_PKEY_derive_init_ex, EVP_PKEY_derive_set_peer, -EVP_PKEY_derive - derive public key algorithm shared secret +EVP_PKEY_derive_init, EVP_PKEY_derive_set_peer, EVP_PKEY_derive +- derive public key algorithm shared secret =head1 SYNOPSIS #include <openssl/evp.h> - int EVP_PKEY_derive_init_ex(EVP_PKEY_CTX *ctx, EVP_KEYEXCH *exchange); int EVP_PKEY_derive_init(EVP_PKEY_CTX *ctx); int EVP_PKEY_derive_set_peer(EVP_PKEY_CTX *ctx, EVP_PKEY *peer); int EVP_PKEY_derive(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen); =head1 DESCRIPTION -The EVP_PKEY_derive_init_ex() function initializes a public key algorithm -context for shared secret derivation using the key exchange algorithm -B<exchange>. -The key exchange algorithm B<exchange> should be fetched using a call to -L<EVP_KEYEXCH_fetch(3)>. -The EVP_PKEY object associated with B<ctx> must be compatible with that -algorithm. -B<exchange> may be NULL in which case the EVP_KEYEXCH algorithm is fetched -implicitly based on the type of EVP_PKEY associated with B<ctx>. -See L<provider(7)/Implicit fetch> for more information about implict fetches. - -The EVP_PKEY_derive_init() function is the same as EVP_PKEY_derive_init_ex() -except that the EVP_KEYEXCH algorithm is always implicitly fetched. - -The EVP_PKEY_derive_set_peer() function sets the peer key: this will normally +EVP_PKEY_derive_init() initializes a public key algorithm context I<ctx> for +shared secret derivation using the algorithm given when the context was created +using L<EVP_PKEY_CTX_new(3)> or variants thereof. The algorithm is used to +fetch a B<EVP_KEYEXCH> method implicitly, see L<provider(7)/Implicit fetch> for +more information about implict fetches. + +EVP_PKEY_derive_set_peer() sets the peer key: this will normally be a public key. -The EVP_PKEY_derive() derives a shared secret using B<ctx>. -If B<key> is B<NULL> then the maximum size of the output buffer is written to -the B<keylen> parameter. If B<key> is not B<NULL> then before the call the -B<keylen> parameter should contain the length of the B<key> buffer, if the call -is successful the shared secret is written to B<key> and the amount of data -written to B<keylen>. +EVP_PKEY_derive() derives a shared secret using I<ctx>. +If I<key> is NULL then the maximum size of the output buffer is written to the +I<keylen> parameter. If I<key> is not NULL then before the call the I<keylen> +parameter should contain the length of the I<key> buffer, if the call is +successful the shared secret is written to I<key> and the amount of data +written to I<keylen>. =head1 NOTES |