diff options
author | Matt Caswell <matt@openssl.org> | 2018-02-27 17:28:48 +0000 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2018-03-02 10:14:31 +0000 |
commit | a2eecb5d2691d8a2e3481765683054f1edfcba36 (patch) | |
tree | 45407d2c8e00e8249f1616e37d36acd9642f5cdc /doc/man7 | |
parent | 13735cfef69dfac2d36229810ea0400e2bc6526d (diff) |
Update some documentation for X448/Ed448
Reviewed-by: Rich Salz <rsalz@openssl.org>
Reviewed-by: Kurt Roeckx <kurt@roeckx.be>
(Merged from https://github.com/openssl/openssl/pull/5481)
Diffstat (limited to 'doc/man7')
-rw-r--r-- | doc/man7/Ed25519.pod | 22 | ||||
-rw-r--r-- | doc/man7/X25519.pod | 18 |
2 files changed, 26 insertions, 14 deletions
diff --git a/doc/man7/Ed25519.pod b/doc/man7/Ed25519.pod index a75164a17c..da6cbc009c 100644 --- a/doc/man7/Ed25519.pod +++ b/doc/man7/Ed25519.pod @@ -2,16 +2,18 @@ =head1 NAME -Ed25519 - EVP_PKEY Ed25519 support +Ed25519, +Ed448 +- EVP_PKEY Ed25519 and Ed448 support =head1 DESCRIPTION -The B<Ed25519> EVP_PKEY implementation supports key generation, one shot -digest sign and digest verify using PureEdDSA and B<Ed25519> (see RFC8032). -It has associated private and public key formats compatible with +The B<Ed25519> and B<Ed448> EVP_PKEY implementation supports key generation, +one-shot digest sign and digest verify using PureEdDSA and B<Ed25519> or B<Ed448> +(see RFC8032). It has associated private and public key formats compatible with draft-ietf-curdle-pkix-04. -No additional parameters can be set during key generation one shot signing or +No additional parameters can be set during key generation one-shot signing or verification. In particular, because PureEdDSA is used, when signing or verifying a digest must B<NOT> be specified. @@ -19,20 +21,24 @@ verifying a digest must B<NOT> be specified. The PureEdDSA algorithm does not support the streaming mechanism of other signature algorithms using, for example, EVP_DigestUpdate(). -The message to sign or verify must be passed using the one shot +The message to sign or verify must be passed using the one-shot EVP_DigestSign() asn EVP_DigestVerify() functions. When calling EVP_DigestSignInit() or EVP_DigestSignUpdate() the digest parameter B<MUST> be set to B<NULL>. Applications wishing to sign certificates (or other structures such as -CRLs or certificate requests) using Ed25519 can either use X509_sign() +CRLs or certificate requests) using Ed25519 or Ed448 can either use X509_sign() or X509_sign_ctx() in the usual way. A context for the B<Ed25519> algorithm can be obtained by calling: EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_ED25519, NULL); +For the B<Ed448> algorithm a context can be obtained by calling: + + EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_ED448, NULL); + =head1 EXAMPLE This example generates an B<ED25519> private key and writes it to standard @@ -57,7 +63,7 @@ L<EVP_DigestVerifyInit(3)>, =head1 COPYRIGHT -Copyright 2017 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved. Licensed under the OpenSSL license (the "License"). You may not use this file except in compliance with the License. You can obtain a copy diff --git a/doc/man7/X25519.pod b/doc/man7/X25519.pod index 96522c5054..69ab0b4a3d 100644 --- a/doc/man7/X25519.pod +++ b/doc/man7/X25519.pod @@ -2,13 +2,15 @@ =head1 NAME -X25519 - EVP_PKEY X25519 support +X25519, +X448 +- EVP_PKEY X25519 and X448 support =head1 DESCRIPTION -The B<X25519> EVP_PKEY implementation supports key generation and key -derivation using B<X25519>. It has associated private and public key formats -compatible with draft-ietf-curdle-pkix-03. +The B<X25519> and B<X448> EVP_PKEY implementation supports key generation and +key derivation using B<X25519> and B<X448>. It has associated private and public +key formats compatible with draft-ietf-curdle-pkix-03. No additional parameters can be set during key generation. @@ -21,6 +23,10 @@ A context for the B<X25519> algorithm can be obtained by calling: EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_X25519, NULL); +For the B<X448> algorithm a context can be obtained by calling: + + EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_X448, NULL); + =head1 EXAMPLE This example generates an B<X25519> private key and writes it to standard @@ -37,7 +43,7 @@ output in PEM format: PEM_write_PrivateKey(stdout, pkey, NULL, NULL, 0, NULL, NULL); The key derivation example in L<EVP_PKEY_derive(3)> can be used with -B<X25519>. +B<X25519> and B<X448>. =head1 SEE ALSO @@ -48,7 +54,7 @@ L<EVP_PKEY_derive_set_peer(3)> =head1 COPYRIGHT -Copyright 2017 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved. Licensed under the OpenSSL license (the "License"). You may not use this file except in compliance with the License. You can obtain a copy |