90595d696e9d9333c79cd44dfed995023b3bd7dc
[openssl.git] / doc / crypto / EVP_PKEY_set1_RSA.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_PKEY_set1_RSA, EVP_PKEY_set1_DSA, EVP_PKEY_set1_DH, EVP_PKEY_set1_EC_KEY,
6 EVP_PKEY_get1_RSA, EVP_PKEY_get1_DSA, EVP_PKEY_get1_DH, EVP_PKEY_get1_EC_KEY,
7 EVP_PKEY_get0_RSA, EVP_PKEY_get0_DSA, EVP_PKEY_get0_DH, EVP_PKEY_get0_EC_KEY,
8 EVP_PKEY_assign_RSA, EVP_PKEY_assign_DSA, EVP_PKEY_assign_DH, EVP_PKEY_assign_EC_KEY,
9 EVP_PKEY_type, EVP_PKEY_id, EVP_PKEY_base_id - EVP_PKEY assignment functions
10
11 =head1 SYNOPSIS
12
13  #include <openssl/evp.h>
14
15  int EVP_PKEY_set1_RSA(EVP_PKEY *pkey,RSA *key);
16  int EVP_PKEY_set1_DSA(EVP_PKEY *pkey,DSA *key);
17  int EVP_PKEY_set1_DH(EVP_PKEY *pkey,DH *key);
18  int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey,EC_KEY *key);
19
20  RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey);
21  DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey);
22  DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey);
23  EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey);
24
25  const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len);
26  RSA *EVP_PKEY_get0_RSA(EVP_PKEY *pkey);
27  DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey);
28  DH *EVP_PKEY_get0_DH(EVP_PKEY *pkey);
29  EC_KEY *EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey);
30
31  int EVP_PKEY_assign_RSA(EVP_PKEY *pkey,RSA *key);
32  int EVP_PKEY_assign_DSA(EVP_PKEY *pkey,DSA *key);
33  int EVP_PKEY_assign_DH(EVP_PKEY *pkey,DH *key);
34  int EVP_PKEY_assign_EC_KEY(EVP_PKEY *pkey,EC_KEY *key);
35
36  int EVP_PKEY_id(const EVP_PKEY *pkey);
37  int EVP_PKEY_base_id(const EVP_PKEY *pkey);
38  int EVP_PKEY_type(int type);
39
40 =head1 DESCRIPTION
41
42 EVP_PKEY_set1_RSA(), EVP_PKEY_set1_DSA(), EVP_PKEY_set1_DH() and
43 EVP_PKEY_set1_EC_KEY() set the key referenced by B<pkey> to B<key>.
44
45 EVP_PKEY_get1_RSA(), EVP_PKEY_get1_DSA(), EVP_PKEY_get1_DH() and
46 EVP_PKEY_get1_EC_KEY() return the referenced key in B<pkey> or
47 B<NULL> if the key is not of the correct type.
48
49 EVP_PKEY_get0_hmac(), EVP_PKEY_get0_RSA(), EVP_PKEY_get0_DSA(),
50 EVP_PKEY_get0_DH() and EVP_PKEY_get0_EC_KEY() also return the
51 referenced key in B<pkey> or B<NULL> if the key is not of the
52 correct type but the reference count of the returned key is
53 B<not> incremented and so must not be freed up after use.
54
55 EVP_PKEY_assign_RSA(), EVP_PKEY_assign_DSA(), EVP_PKEY_assign_DH()
56 and EVP_PKEY_assign_EC_KEY() also set the referenced key to B<key>
57 however these use the supplied B<key> internally and so B<key>
58 will be freed when the parent B<pkey> is freed.
59
60 EVP_PKEY_base_id() returns the type of B<pkey>. For example
61 an RSA key will return B<EVP_PKEY_RSA>.
62
63 EVP_PKEY_id() returns the actual OID associated with B<pkey>. Historically keys
64 using the same algorithm could use different OIDs. For example an RSA key could
65 use the OIDs corresponding to the NIDs B<NID_rsaEncryption> (equivalent to
66 B<EVP_PKEY_RSA>) or B<NID_rsa> (equivalent to B<EVP_PKEY_RSA2>). The use of
67 alternative non-standard OIDs is now rare so B<EVP_PKEY_RSA2> et al are not
68 often seen in practice.
69
70 EVP_PKEY_type() returns the underlying type of the NID B<type>. For example
71 EVP_PKEY_type(EVP_PKEY_RSA2) will return B<EVP_PKEY_RSA>.
72
73 =head1 NOTES
74
75 In accordance with the OpenSSL naming convention the key obtained
76 from or assigned to the B<pkey> using the B<1> functions must be
77 freed as well as B<pkey>.
78
79 EVP_PKEY_assign_RSA(), EVP_PKEY_assign_DSA(), EVP_PKEY_assign_DH()
80 and EVP_PKEY_assign_EC_KEY() are implemented as macros.
81
82 Most applications wishing to know a key type will simply call
83 EVP_PKEY_base_id() and will not care about the actual type:
84 which will be identical in almost all cases.
85
86 Previous versions of this document suggested using EVP_PKEY_type(pkey->type)
87 to determine the type of a key. Since B<EVP_PKEY> is now opaque this
88 is no longer possible: the equivalent is EVP_PKEY_base_id(pkey).
89
90 =head1 RETURN VALUES
91
92 EVP_PKEY_set1_RSA(), EVP_PKEY_set1_DSA(), EVP_PKEY_set1_DH() and
93 EVP_PKEY_set1_EC_KEY() return 1 for success or 0 for failure.
94
95 EVP_PKEY_get1_RSA(), EVP_PKEY_get1_DSA(), EVP_PKEY_get1_DH() and
96 EVP_PKEY_get1_EC_KEY() return the referenced key or B<NULL> if
97 an error occurred.
98
99 EVP_PKEY_assign_RSA(), EVP_PKEY_assign_DSA(), EVP_PKEY_assign_DH()
100 and EVP_PKEY_assign_EC_KEY() return 1 for success and 0 for failure.
101
102 EVP_PKEY_base_id(), EVP_PKEY_id() and EVP_PKEY_type() return a key
103 type or B<NID_undef> (equivalently B<EVP_PKEY_NONE>) on error.
104
105 =head1 SEE ALSO
106
107 L<EVP_PKEY_new(3)>
108
109 =head1 COPYRIGHT
110
111 Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.
112
113 Licensed under the OpenSSL license (the "License").  You may not use
114 this file except in compliance with the License.  You can obtain a copy
115 in the file LICENSE in the source distribution or at
116 L<https://www.openssl.org/source/license.html>.
117
118 =cut