doc/man7/EVP_PKEY-X25519.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_PKEY-X25519, EVP_PKEY-X448, EVP_PKEY-ED25519, EVP_PKEY-ED448,
   6 EVP_KEYMGMT-X25519, EVP_KEYMGMT-X448, EVP_KEYMGMT-ED25519, EVP_KEYMGMT-ED448
   7 - EVP_PKEY X25519, X448, ED25519 and ED448 keytype and algorithm support
   8
   9 =head1 DESCRIPTION
  10
  11 The B<X25519>, B<X448>, B<ED25519> and B<ED448> keytypes are
  12 implemented in OpenSSL's default and FIPS providers.  These implementations
  13 support the associated key, containing the public key I<pub> and the
  14 private key I<priv>.
  15
  16 In the FIPS provider they are non-approved algorithms and do not have the
  17 "fips=yes" property set.
  18 No additional parameters can be set during key generation.
  19
  20
  21 =head2 Common X25519, X448, ED25519 and ED448 parameters
  22
  23 In addition to the common parameters that all keytypes should support (see
  24 L<provider-keymgmt(7)/Common parameters>), the implementation of these keytypes
  25 support the following.
  26
  27 =over 4
  28
  29 =item "group" (B<OSSL_PKEY_PARAM_GROUP_NAME>) <UTF8 string>
  30
  31 This is only supported by X25519 and X448. The group name must be "x25519" or
  32 "x448" respectively for those algorithms. This is only present for consistency
  33 with other key exchange algorithms and is typically not needed.
  34
  35 =item "pub" (B<OSSL_PKEY_PARAM_PUB_KEY>) <octet string>
  36
  37 The public key value.
  38
  39 =item "priv" (B<OSSL_PKEY_PARAM_PRIV_KEY>) <octet string>
  40
  41 The private key value.
  42
  43 =item "encoded-pub-key" (B<OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY>) <octet string>
  44
  45 Used for getting and setting the encoding of a public key for the B<X25519> and
  46 B<X448> key types. Public keys are expected be encoded in a format as defined by
  47 RFC7748.
  48
  49 =back
  50
  51 =head2 ED25519 and ED448 parameters
  52
  53 =over 4
  54
  55 =item "mandatory-digest" (B<OSSL_PKEY_PARAM_MANDATORY_DIGEST>) <utf8 string>
  56
  57 The empty string, signifying that no digest may be specified.
  58
  59 =back
  60
  61 =head1 CONFORMING TO
  62
  63 =over 4
  64
  65 =item RFC 8032
  66
  67 =item RFC 8410
  68
  69 =back
  70
  71 =head1 EXAMPLES
  72
  73 An B<EVP_PKEY> context can be obtained by calling:
  74
  75     EVP_PKEY_CTX *pctx =
  76         EVP_PKEY_CTX_new_from_name(NULL, "X25519", NULL);
  77
  78     EVP_PKEY_CTX *pctx =
  79         EVP_PKEY_CTX_new_from_name(NULL, "X448", NULL);
  80
  81     EVP_PKEY_CTX *pctx =
  82         EVP_PKEY_CTX_new_from_name(NULL, "ED25519", NULL);
  83
  84     EVP_PKEY_CTX *pctx =
  85         EVP_PKEY_CTX_new_from_name(NULL, "ED448", NULL);
  86
  87 An B<ED25519> key can be generated like this:
  88
  89     EVP_PKEY *pkey = NULL;
  90     EVP_PKEY_CTX *pctx =
  91         EVP_PKEY_CTX_new_from_name(NULL, "ED25519", NULL);
  92
  93     EVP_PKEY_keygen_init(pctx);
  94     EVP_PKEY_gen(pctx, &pkey);
  95     EVP_PKEY_CTX_free(pctx);
  96
  97 An B<X25519> key can be generated in a similar way:
  98
  99     EVP_PKEY *pkey = NULL;
 100     EVP_PKEY_CTX *pctx =
 101         EVP_PKEY_CTX_new_from_name(NULL, "X25519", NULL);
 102
 103     EVP_PKEY_keygen_init(pctx);
 104     EVP_PKEY_gen(pctx, &pkey);
 105     EVP_PKEY_CTX_free(pctx);
 106
 107 =head1 SEE ALSO
 108
 109 L<EVP_KEYMGMT(3)>, L<EVP_PKEY(3)>, L<provider-keymgmt(7)>,
 110 L<EVP_KEYEXCH-X25519(7)>, L<EVP_KEYEXCH-X448(7)>,
 111 L<EVP_SIGNATURE-ED25519(7)>, L<EVP_SIGNATURE-ED448(7)>
 112
 113 =head1 COPYRIGHT
 114
 115 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
 116
 117 Licensed under the Apache License 2.0 (the "License").  You may not use
 118 this file except in compliance with the License.  You can obtain a copy
 119 in the file LICENSE in the source distribution or at
 120 L<https://www.openssl.org/source/license.html>.
 121
 122 =cut