Make X509_PUBKEY opaque
[openssl.git] / crypto / x509 / x_pubkey.c
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57
58 #include <stdio.h>
59 #include "internal/cryptlib.h"
60 #include <openssl/asn1t.h>
61 #include <openssl/x509.h>
62 #include "internal/asn1_int.h"
63 #include "internal/evp_int.h"
64 #include "internal/x509_int.h"
65 #include <openssl/rsa.h>
66 #include <openssl/dsa.h>
67
68 struct X509_pubkey_st {
69     X509_ALGOR *algor;
70     ASN1_BIT_STRING *public_key;
71     EVP_PKEY *pkey;
72     CRYPTO_RWLOCK *lock;
73 };
74
75 /* Minor tweak to operation: free up EVP_PKEY */
76 static int pubkey_cb(int operation, ASN1_VALUE **pval, const ASN1_ITEM *it,
77                      void *exarg)
78 {
79     if (operation == ASN1_OP_NEW_POST) {
80         X509_PUBKEY *pubkey = (X509_PUBKEY *)*pval;
81         pubkey->lock = CRYPTO_THREAD_lock_new();
82         if (pubkey->lock == NULL)
83             return 0;
84     }
85     if (operation == ASN1_OP_FREE_POST) {
86         X509_PUBKEY *pubkey = (X509_PUBKEY *)*pval;
87         CRYPTO_THREAD_lock_free(pubkey->lock);
88         EVP_PKEY_free(pubkey->pkey);
89     }
90     return 1;
91 }
92
93 ASN1_SEQUENCE_cb(X509_PUBKEY, pubkey_cb) = {
94         ASN1_SIMPLE(X509_PUBKEY, algor, X509_ALGOR),
95         ASN1_SIMPLE(X509_PUBKEY, public_key, ASN1_BIT_STRING)
96 } ASN1_SEQUENCE_END_cb(X509_PUBKEY, X509_PUBKEY)
97
98 IMPLEMENT_ASN1_FUNCTIONS(X509_PUBKEY)
99
100 int X509_PUBKEY_set(X509_PUBKEY **x, EVP_PKEY *pkey)
101 {
102     X509_PUBKEY *pk = NULL;
103
104     if (x == NULL)
105         return (0);
106
107     if ((pk = X509_PUBKEY_new()) == NULL)
108         goto error;
109
110     if (pkey->ameth) {
111         if (pkey->ameth->pub_encode) {
112             if (!pkey->ameth->pub_encode(pk, pkey)) {
113                 X509err(X509_F_X509_PUBKEY_SET,
114                         X509_R_PUBLIC_KEY_ENCODE_ERROR);
115                 goto error;
116             }
117         } else {
118             X509err(X509_F_X509_PUBKEY_SET, X509_R_METHOD_NOT_SUPPORTED);
119             goto error;
120         }
121     } else {
122         X509err(X509_F_X509_PUBKEY_SET, X509_R_UNSUPPORTED_ALGORITHM);
123         goto error;
124     }
125
126     X509_PUBKEY_free(*x);
127     *x = pk;
128     return 1;
129
130  error:
131     X509_PUBKEY_free(pk);
132     return 0;
133 }
134
135 EVP_PKEY *X509_PUBKEY_get0(X509_PUBKEY *key)
136 {
137     EVP_PKEY *ret = NULL;
138
139     if (key == NULL)
140         goto error;
141
142     if (key->pkey != NULL)
143         return key->pkey;
144
145     if (key->public_key == NULL)
146         goto error;
147
148     if ((ret = EVP_PKEY_new()) == NULL) {
149         X509err(X509_F_X509_PUBKEY_GET0, ERR_R_MALLOC_FAILURE);
150         goto error;
151     }
152
153     if (!EVP_PKEY_set_type(ret, OBJ_obj2nid(key->algor->algorithm))) {
154         X509err(X509_F_X509_PUBKEY_GET0, X509_R_UNSUPPORTED_ALGORITHM);
155         goto error;
156     }
157
158     if (ret->ameth->pub_decode) {
159         if (!ret->ameth->pub_decode(ret, key)) {
160             X509err(X509_F_X509_PUBKEY_GET0, X509_R_PUBLIC_KEY_DECODE_ERROR);
161             goto error;
162         }
163     } else {
164         X509err(X509_F_X509_PUBKEY_GET0, X509_R_METHOD_NOT_SUPPORTED);
165         goto error;
166     }
167
168     /* Check to see if another thread set key->pkey first */
169     CRYPTO_THREAD_write_lock(key->lock);
170     if (key->pkey) {
171         CRYPTO_THREAD_unlock(key->lock);
172         EVP_PKEY_free(ret);
173         ret = key->pkey;
174     } else {
175         key->pkey = ret;
176         CRYPTO_THREAD_unlock(key->lock);
177     }
178
179     return ret;
180
181  error:
182     EVP_PKEY_free(ret);
183     return (NULL);
184 }
185
186 EVP_PKEY *X509_PUBKEY_get(X509_PUBKEY *key)
187 {
188     EVP_PKEY *ret = X509_PUBKEY_get0(key);
189     if (ret != NULL)
190         EVP_PKEY_up_ref(ret);
191     return ret;
192 }
193
194 /*
195  * Now two pseudo ASN1 routines that take an EVP_PKEY structure and encode or
196  * decode as X509_PUBKEY
197  */
198
199 EVP_PKEY *d2i_PUBKEY(EVP_PKEY **a, const unsigned char **pp, long length)
200 {
201     X509_PUBKEY *xpk;
202     EVP_PKEY *pktmp;
203     const unsigned char *q;
204     q = *pp;
205     xpk = d2i_X509_PUBKEY(NULL, &q, length);
206     if (!xpk)
207         return NULL;
208     pktmp = X509_PUBKEY_get(xpk);
209     X509_PUBKEY_free(xpk);
210     if (!pktmp)
211         return NULL;
212     *pp = q;
213     if (a) {
214         EVP_PKEY_free(*a);
215         *a = pktmp;
216     }
217     return pktmp;
218 }
219
220 int i2d_PUBKEY(EVP_PKEY *a, unsigned char **pp)
221 {
222     X509_PUBKEY *xpk = NULL;
223     int ret;
224     if (!a)
225         return 0;
226     if (!X509_PUBKEY_set(&xpk, a))
227         return 0;
228     ret = i2d_X509_PUBKEY(xpk, pp);
229     X509_PUBKEY_free(xpk);
230     return ret;
231 }
232
233 /*
234  * The following are equivalents but which return RSA and DSA keys
235  */
236 #ifndef OPENSSL_NO_RSA
237 RSA *d2i_RSA_PUBKEY(RSA **a, const unsigned char **pp, long length)
238 {
239     EVP_PKEY *pkey;
240     RSA *key;
241     const unsigned char *q;
242     q = *pp;
243     pkey = d2i_PUBKEY(NULL, &q, length);
244     if (!pkey)
245         return NULL;
246     key = EVP_PKEY_get1_RSA(pkey);
247     EVP_PKEY_free(pkey);
248     if (!key)
249         return NULL;
250     *pp = q;
251     if (a) {
252         RSA_free(*a);
253         *a = key;
254     }
255     return key;
256 }
257
258 int i2d_RSA_PUBKEY(RSA *a, unsigned char **pp)
259 {
260     EVP_PKEY *pktmp;
261     int ret;
262     if (!a)
263         return 0;
264     pktmp = EVP_PKEY_new();
265     if (pktmp == NULL) {
266         ASN1err(ASN1_F_I2D_RSA_PUBKEY, ERR_R_MALLOC_FAILURE);
267         return 0;
268     }
269     EVP_PKEY_set1_RSA(pktmp, a);
270     ret = i2d_PUBKEY(pktmp, pp);
271     EVP_PKEY_free(pktmp);
272     return ret;
273 }
274 #endif
275
276 #ifndef OPENSSL_NO_DSA
277 DSA *d2i_DSA_PUBKEY(DSA **a, const unsigned char **pp, long length)
278 {
279     EVP_PKEY *pkey;
280     DSA *key;
281     const unsigned char *q;
282     q = *pp;
283     pkey = d2i_PUBKEY(NULL, &q, length);
284     if (!pkey)
285         return NULL;
286     key = EVP_PKEY_get1_DSA(pkey);
287     EVP_PKEY_free(pkey);
288     if (!key)
289         return NULL;
290     *pp = q;
291     if (a) {
292         DSA_free(*a);
293         *a = key;
294     }
295     return key;
296 }
297
298 int i2d_DSA_PUBKEY(DSA *a, unsigned char **pp)
299 {
300     EVP_PKEY *pktmp;
301     int ret;
302     if (!a)
303         return 0;
304     pktmp = EVP_PKEY_new();
305     if (pktmp == NULL) {
306         ASN1err(ASN1_F_I2D_DSA_PUBKEY, ERR_R_MALLOC_FAILURE);
307         return 0;
308     }
309     EVP_PKEY_set1_DSA(pktmp, a);
310     ret = i2d_PUBKEY(pktmp, pp);
311     EVP_PKEY_free(pktmp);
312     return ret;
313 }
314 #endif
315
316 #ifndef OPENSSL_NO_EC
317 EC_KEY *d2i_EC_PUBKEY(EC_KEY **a, const unsigned char **pp, long length)
318 {
319     EVP_PKEY *pkey;
320     EC_KEY *key;
321     const unsigned char *q;
322     q = *pp;
323     pkey = d2i_PUBKEY(NULL, &q, length);
324     if (!pkey)
325         return (NULL);
326     key = EVP_PKEY_get1_EC_KEY(pkey);
327     EVP_PKEY_free(pkey);
328     if (!key)
329         return (NULL);
330     *pp = q;
331     if (a) {
332         EC_KEY_free(*a);
333         *a = key;
334     }
335     return (key);
336 }
337
338 int i2d_EC_PUBKEY(EC_KEY *a, unsigned char **pp)
339 {
340     EVP_PKEY *pktmp;
341     int ret;
342     if (!a)
343         return (0);
344     if ((pktmp = EVP_PKEY_new()) == NULL) {
345         ASN1err(ASN1_F_I2D_EC_PUBKEY, ERR_R_MALLOC_FAILURE);
346         return (0);
347     }
348     EVP_PKEY_set1_EC_KEY(pktmp, a);
349     ret = i2d_PUBKEY(pktmp, pp);
350     EVP_PKEY_free(pktmp);
351     return (ret);
352 }
353 #endif
354
355 int X509_PUBKEY_set0_param(X509_PUBKEY *pub, ASN1_OBJECT *aobj,
356                            int ptype, void *pval,
357                            unsigned char *penc, int penclen)
358 {
359     if (!X509_ALGOR_set0(pub->algor, aobj, ptype, pval))
360         return 0;
361     if (penc) {
362         OPENSSL_free(pub->public_key->data);
363         pub->public_key->data = penc;
364         pub->public_key->length = penclen;
365         /* Set number of unused bits to zero */
366         pub->public_key->flags &= ~(ASN1_STRING_FLAG_BITS_LEFT | 0x07);
367         pub->public_key->flags |= ASN1_STRING_FLAG_BITS_LEFT;
368     }
369     return 1;
370 }
371
372 int X509_PUBKEY_get0_param(ASN1_OBJECT **ppkalg,
373                            const unsigned char **pk, int *ppklen,
374                            X509_ALGOR **pa, X509_PUBKEY *pub)
375 {
376     if (ppkalg)
377         *ppkalg = pub->algor->algorithm;
378     if (pk) {
379         *pk = pub->public_key->data;
380         *ppklen = pub->public_key->length;
381     }
382     if (pa)
383         *pa = pub->algor;
384     return 1;
385 }
386
387 ASN1_BIT_STRING *X509_get0_pubkey_bitstr(const X509 *x)
388 {
389     if (x == NULL)
390         return NULL;
391     return x->cert_info.key->public_key;
392 }