OpenBSD manual page server

Manual Page Search Parameters

EVP_PKEY_SET1_RSA(3) Library Functions Manual EVP_PKEY_SET1_RSA(3)

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_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

#include <openssl/evp.h>

EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key);

EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key);

EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key);

EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key);

EVP_PKEY_get1_RSA(EVP_PKEY *pkey);

EVP_PKEY_get1_DSA(EVP_PKEY *pkey);

DH *
EVP_PKEY_get1_DH(EVP_PKEY *pkey);


EVP_PKEY_assign_RSA(EVP_PKEY *pkey, RSA *key);

EVP_PKEY_assign_DSA(EVP_PKEY *pkey, DSA *key);

EVP_PKEY_assign_DH(EVP_PKEY *pkey, DH *key);

EVP_PKEY_assign_EC_KEY(EVP_PKEY *pkey, EC_KEY *key);

EVP_PKEY_id(EVP_PKEY *pkey);

EVP_PKEY_base_id(EVP_PKEY *pkey);

EVP_PKEY_type(int type);

(), (), (), and () set the key referenced by pkey to key.

(), (), (), and () return the key referenced in pkey or NULL if the key is not of the correct type.

(), (), (), and () 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.

() returns the type of pkey. For example, an RSA key will return EVP_PKEY_RSA.

() 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.

() 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 () 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 functions must be freed as well as pkey.

(), (), (), and () are implemented as macros.

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(), and EVP_PKEY_get1_EC_KEY() 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.

EVP_PKEY_new(3), RSA_new(3)

December 11, 2016 OpenBSD-6.1