[OpenBSD]

Manual Page Search Parameters

EVP_PKEY_SET1_RSA(3) Library Functions Manual EVP_PKEY_SET1_RSA(3)

NAME

EVP_PKEY_set1_RSA, EVP_PKEY_set1_DSA, EVP_PKEY_set1_DH, EVP_PKEY_set1_EC_KEY, EVP_PKEY_get1_RSA, EVP_PKEY_get1_DSA, EVP_PKEY_get1_DH, EVP_PKEY_get1_EC_KEY, EVP_PKEY_get0_RSA, EVP_PKEY_get0_DSA, EVP_PKEY_get0_DH, EVP_PKEY_assign_RSA, EVP_PKEY_assign_DSA, EVP_PKEY_assign_DH, EVP_PKEY_assign_EC_KEY, EVP_PKEY_id, EVP_PKEY_base_id, EVP_PKEY_typeEVP_PKEY assignment functions

SYNOPSIS

#include <openssl/evp.h>
int
EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key);
int
EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key);
int
EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key);
int
EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key);
RSA *
EVP_PKEY_get1_RSA(EVP_PKEY *pkey);
DSA *
EVP_PKEY_get1_DSA(EVP_PKEY *pkey);
DH *
EVP_PKEY_get1_DH(EVP_PKEY *pkey);
EC_KEY *
EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey);
RSA *
EVP_PKEY_get0_RSA(EVP_PKEY *pkey);
DSA *
EVP_PKEY_get0_DSA(EVP_PKEY *pkey);
DH *
EVP_PKEY_get0_DH(EVP_PKEY *pkey);
int
EVP_PKEY_assign_RSA(EVP_PKEY *pkey, RSA *key);
int
EVP_PKEY_assign_DSA(EVP_PKEY *pkey, DSA *key);
int
EVP_PKEY_assign_DH(EVP_PKEY *pkey, DH *key);
int
EVP_PKEY_assign_EC_KEY(EVP_PKEY *pkey, EC_KEY *key);
int
EVP_PKEY_id(EVP_PKEY *pkey);
int
EVP_PKEY_base_id(EVP_PKEY *pkey);
int
EVP_PKEY_type(int type);

DESCRIPTION

EVP_PKEY_set1_RSA(), EVP_PKEY_set1_DSA(), EVP_PKEY_set1_DH(), and EVP_PKEY_set1_EC_KEY() set the key referenced by pkey to key.
EVP_PKEY_get1_RSA(), EVP_PKEY_get1_DSA(), EVP_PKEY_get1_DH(), and EVP_PKEY_get1_EC_KEY() return the key referenced in pkey, incrementing its reference count by 1, or NULL if the key is not of the correct type.
EVP_PKEY_get0_RSA(), EVP_PKEY_get0_DSA(), and EVP_PKEY_get0_DH() are identical except that they do not increment the reference count. Consequently, the returned key must not be freed by the caller.
EVP_PKEY_assign_RSA(), EVP_PKEY_assign_DSA(), EVP_PKEY_assign_DH(), and EVP_PKEY_assign_EC_KEY() also set the referenced key to key; however these use the supplied key internally and so key will be freed when the parent pkey is freed.
EVP_PKEY_base_id() returns the type of pkey. For example, an RSA key will return EVP_PKEY_RSA.
EVP_PKEY_id() returns the actual OID associated with pkey. Historically keys using the same algorithm could use different OIDs. For example, an RSA key could use the OIDs corresponding to the NIDs NID_rsaEncryption (equivalent to EVP_PKEY_RSA) or NID_rsa (equivalent to EVP_PKEY_RSA2). The use of alternative non-standard OIDs is now rare, so EVP_PKEY_RSA2 et al. are not often seen in practice.
EVP_PKEY_type() returns the underlying type of the NID type. For example, EVP_PKEY_type(EVP_PKEY_RSA2) will return EVP_PKEY_RSA.
Most applications wishing to know a key type will simply call EVP_PKEY_base_id() and will not care about the actual type, which will be identical in almost all cases.
In accordance with the OpenSSL naming convention, the key obtained from or assigned to pkey using the 1 functions must be freed as well as pkey.
EVP_PKEY_assign_RSA(), EVP_PKEY_assign_DSA(), EVP_PKEY_assign_DH(), and EVP_PKEY_assign_EC_KEY() are implemented as macros.

RETURN VALUES

EVP_PKEY_set1_RSA(), EVP_PKEY_set1_DSA(), EVP_PKEY_set1_DH(), and EVP_PKEY_set1_EC_KEY() return 1 for success or 0 for failure.
EVP_PKEY_get1_RSA(), EVP_PKEY_get1_DSA(), EVP_PKEY_get1_DH(), EVP_PKEY_get1_EC_KEY(), EVP_PKEY_get0_RSA(), EVP_PKEY_get0_DSA(), and EVP_PKEY_get0_DH() return the referenced key or NULL if an error occurred.
EVP_PKEY_assign_RSA(), EVP_PKEY_assign_DSA(), EVP_PKEY_assign_DH(), and EVP_PKEY_assign_EC_KEY() return 1 for success and 0 for failure.
EVP_PKEY_base_id(), EVP_PKEY_id(), and EVP_PKEY_type() return a key type or NID_undef (equivalently EVP_PKEY_NONE) on error.

SEE ALSO

DH_new(3), DSA_new(3), EC_KEY_new(3), EVP_PKEY_new(3), RSA_new(3)
February 17, 2018 OpenBSD-current