EVP_PKEY-X25519(7ossl)

NAME
EVP_PKEY-X25519, EVP_PKEY-X448, EVP_PKEY-ED25519, EVP_PKEY-ED448, EVP_KEYMGMT-X25519, EVP_KEYMGMT-X448, EVP_KEYMGMT-ED25519, EVP_KEYMGMT-ED448 - EVP_PKEY X25519, X448, ED25519 and ED448 keytype and algorithm support

DESCRIPTION
The X25519, X448, ED25519 and ED448 keytypes are implemented in OpenSSL's default and FIPS providers. These implementations support the associated key, containing the public key pub and the private key priv.

  Common Keygen Parameters for X25519, X448, ED25519 and ED448
The following parameters can be used during key generation by calling EVP_PKEY_CTX_set_params() after calling EVP_PKEY_keygen_init().

"properties" (OSSL_PKEY_PARAM_PROPERTIES) <octet string>
    The property query to use when fetching algorithms during the key generation operation.

  Keygen Parameters for X25519 and X448

"dhkem-ikm" (OSSL_PKEY_PARAM_DHKEM_IKM) <octet string>
    DHKEM requires the generation of a keypair using an input key material (seed). Use this to specify the key material used for generation of the private key. This value should not be reused for other purposes. It should have a length of at least 32 for X25519, and 56 for X448.

"group" (OSSL_PKEY_PARAM_GROUP_NAME) <UTF8 string>
    The group name must be "x25519" or "x448" respectively for those algorithms. This is only present for consistency with other key exchange algorithms and is typically not needed.

  Common Parameters for X25519, X448, ED25519 and ED448
In addition to the common parameters that all keytypes should support (see "Common parameters" in provider-keymgmt(7)), the implementation of these keytypes support the following.

"pub" (OSSL_PKEY_PARAM_PUB_KEY) <octet string>
    The public key value.

"priv" (OSSL_PKEY_PARAM_PRIV_KEY) <octet string>
    The private key value.

  Parameters for X25519 and X448

"encoded-pub-key" (OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY) <octet string>
    Used for getting and setting the encoding of a public key for the X25519 and X448 key types. Public keys are expected be encoded in a format as defined by RFC7748.

"fips-indicator" (OSSL_PKEY_PARAM_FIPS_APPROVED_INDICATOR) <integer>
    This getter is only supported by X25519 and X448 OpenSSL FIPS provider. Since X25519 and X448 are unapproved in FIPS 140-3 this getter returns 0.

  Parameters for ED25519 and ED448

"mandatory-digest" (OSSL_PKEY_PARAM_MANDATORY_DIGEST) <UTF8 string>
    The empty string, signifying that no digest may be specified.

CONFORMING TO

RFC 8032
RFC 8410

EXAMPLES
An EVP_PKEY context can be obtained by calling:

    EVP_PKEY_CTX *pctx =
        EVP_PKEY_CTX_new_from_name(NULL, "X25519", NULL);

    EVP_PKEY_CTX *pctx =
        EVP_PKEY_CTX_new_from_name(NULL, "X448", NULL);

    EVP_PKEY_CTX *pctx =
        EVP_PKEY_CTX_new_from_name(NULL, "ED25519", NULL);

    EVP_PKEY_CTX *pctx =
        EVP_PKEY_CTX_new_from_name(NULL, "ED448", NULL);

An X25519 key can be generated like this:

    pkey = EVP_PKEY_Q_keygen(NULL, NULL, "X25519");

An X448, ED25519, or ED448 key can be generated likewise.

SEE ALSO
EVP_KEYMGMT(3), EVP_PKEY(3), provider-keymgmt(7), EVP_KEYEXCH-X25519(7), EVP_KEYEXCH-X448(7), EVP_SIGNATURE-ED25519(7), EVP_SIGNATURE-ED448(7)

COPYRIGHT
Copyright 2020-2025 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 <https://www.openssl.org/source/license.html>.