.\" $OpenBSD: EVP_PKEY_set1_RSA.3,v 1.5 2016/12/11 12:21:48 schwarze Exp $ .\" OpenSSL 9b86974e Aug 17 15:21:33 2015 -0400 .\" .\" This file was written by Dr. Stephen Henson . .\" Copyright (c) 2002, 2014, 2016 The OpenSSL Project. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in .\" the documentation and/or other materials provided with the .\" distribution. .\" .\" 3. All advertising materials mentioning features or use of this .\" software must display the following acknowledgment: .\" "This product includes software developed by the OpenSSL Project .\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" .\" .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to .\" endorse or promote products derived from this software without .\" prior written permission. For written permission, please contact .\" openssl-core@openssl.org. .\" .\" 5. Products derived from this software may not be called "OpenSSL" .\" nor may "OpenSSL" appear in their names without prior written .\" permission of the OpenSSL Project. .\" .\" 6. Redistributions of any form whatsoever must retain the following .\" acknowledgment: .\" "This product includes software developed by the OpenSSL Project .\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" .\" .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED .\" OF THE POSSIBILITY OF SUCH DAMAGE. .\" .Dd $Mdocdate: December 11 2016 $ .Dt EVP_PKEY_SET1_RSA 3 .Os .Sh NAME .Nm EVP_PKEY_set1_RSA , .Nm EVP_PKEY_set1_DSA , .Nm EVP_PKEY_set1_DH , .Nm EVP_PKEY_set1_EC_KEY , .Nm EVP_PKEY_get1_RSA , .Nm EVP_PKEY_get1_DSA , .Nm EVP_PKEY_get1_DH , .Nm EVP_PKEY_get1_EC_KEY , .Nm EVP_PKEY_assign_RSA , .Nm EVP_PKEY_assign_DSA , .Nm EVP_PKEY_assign_DH , .Nm EVP_PKEY_assign_EC_KEY , .Nm EVP_PKEY_id , .Nm EVP_PKEY_base_id , .Nm EVP_PKEY_type .Nd EVP_PKEY assignment functions .Sh SYNOPSIS .In openssl/evp.h .Ft int .Fo EVP_PKEY_set1_RSA .Fa "EVP_PKEY *pkey" .Fa "RSA *key" .Fc .Ft int .Fo EVP_PKEY_set1_DSA .Fa "EVP_PKEY *pkey" .Fa "DSA *key" .Fc .Ft int .Fo EVP_PKEY_set1_DH .Fa "EVP_PKEY *pkey" .Fa "DH *key" .Fc .Ft int .Fo EVP_PKEY_set1_EC_KEY .Fa "EVP_PKEY *pkey" .Fa "EC_KEY *key" .Fc .Ft RSA * .Fo EVP_PKEY_get1_RSA .Fa "EVP_PKEY *pkey" .Fc .Ft DSA * .Fo EVP_PKEY_get1_DSA .Fa "EVP_PKEY *pkey" .Fc .Ft DH * .Fo EVP_PKEY_get1_DH .Fa "EVP_PKEY *pkey" .Fc .Ft EC_KEY * .Fo EVP_PKEY_get1_EC_KEY .Fa "EVP_PKEY *pkey" .Fc .Ft int .Fo EVP_PKEY_assign_RSA .Fa "EVP_PKEY *pkey" .Fa "RSA *key" .Fc .Ft int .Fo EVP_PKEY_assign_DSA .Fa "EVP_PKEY *pkey" .Fa "DSA *key" .Fc .Ft int .Fo EVP_PKEY_assign_DH .Fa "EVP_PKEY *pkey" .Fa "DH *key" .Fc .Ft int .Fo EVP_PKEY_assign_EC_KEY .Fa "EVP_PKEY *pkey" .Fa "EC_KEY *key" .Fc .Ft int .Fo EVP_PKEY_id .Fa "EVP_PKEY *pkey" .Fc .Ft int .Fo EVP_PKEY_base_id .Fa "EVP_PKEY *pkey" .Fc .Ft int .Fo EVP_PKEY_type .Fa "int type" .Fc .Sh DESCRIPTION .Fn EVP_PKEY_set1_RSA , .Fn EVP_PKEY_set1_DSA , .Fn EVP_PKEY_set1_DH , and .Fn EVP_PKEY_set1_EC_KEY set the key referenced by .Fa pkey to .Fa key . .Pp .Fn EVP_PKEY_get1_RSA , .Fn EVP_PKEY_get1_DSA , .Fn EVP_PKEY_get1_DH , and .Fn EVP_PKEY_get1_EC_KEY return the key referenced in .Fa pkey or .Dv NULL if the key is not of the correct type. .Pp .Fn EVP_PKEY_assign_RSA , .Fn EVP_PKEY_assign_DSA , .Fn EVP_PKEY_assign_DH , and .Fn EVP_PKEY_assign_EC_KEY also set the referenced key to .Fa key ; however these use the supplied .Fa key internally and so .Fa key will be freed when the parent .Fa pkey is freed. .Pp .Fn EVP_PKEY_base_id returns the type of .Fa pkey . For example, an RSA key will return .Dv EVP_PKEY_RSA . .Pp .Fn EVP_PKEY_id returns the actual OID associated with .Fa pkey . Historically keys using the same algorithm could use different OIDs. For example, an RSA key could use the OIDs corresponding to the NIDs .Dv NID_rsaEncryption (equivalent to .Dv EVP_PKEY_RSA ) or .Dv NID_rsa (equivalent to .Dv EVP_PKEY_RSA2 ) . The use of alternative non-standard OIDs is now rare, so .Dv EVP_PKEY_RSA2 et al. are not often seen in practice. .Pp .Fn EVP_PKEY_type returns the underlying type of the NID .Fa type . For example, .Fn EVP_PKEY_type EVP_PKEY_RSA2 will return .Dv EVP_PKEY_RSA . .Pp Most applications wishing to know a key type will simply call .Fn EVP_PKEY_base_id and will not care about the actual type, which will be identical in almost all cases. .Pp In accordance with the OpenSSL naming convention, the key obtained from or assigned to .Fa pkey using the .Sy 1 functions must be freed as well as .Fa pkey . .Pp .Fn EVP_PKEY_assign_RSA , .Fn EVP_PKEY_assign_DSA , .Fn EVP_PKEY_assign_DH , and .Fn EVP_PKEY_assign_EC_KEY are implemented as macros. .Sh RETURN VALUES .Fn EVP_PKEY_set1_RSA , .Fn EVP_PKEY_set1_DSA , .Fn EVP_PKEY_set1_DH , and .Fn EVP_PKEY_set1_EC_KEY return 1 for success or 0 for failure. .Pp .Fn EVP_PKEY_get1_RSA , .Fn EVP_PKEY_get1_DSA , .Fn EVP_PKEY_get1_DH , and .Fn EVP_PKEY_get1_EC_KEY return the referenced key or .Dv NULL if an error occurred. .Pp .Fn EVP_PKEY_assign_RSA , .Fn EVP_PKEY_assign_DSA , .Fn EVP_PKEY_assign_DH , and .Fn EVP_PKEY_assign_EC_KEY return 1 for success and 0 for failure. .Pp .Fn EVP_PKEY_base_id , .Fn EVP_PKEY_id , and .Fn EVP_PKEY_type return a key type or .Dv NID_undef (equivalently .Dv EVP_PKEY_NONE ) on error. .Sh SEE ALSO .Xr EVP_PKEY_new 3 , .Xr RSA_new 3