Return 2 from X509_NAME printing routine to add newline.
[openssl.git] / crypto / asn1 / x_name.c
1 /* crypto/asn1/x_name.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #include <stdio.h>
60 #include "cryptlib.h"
61 #include <openssl/asn1t.h>
62 #include <openssl/x509.h>
63 #include "asn1_locl.h"
64
65 static int x509_name_ex_d2i(ASN1_VALUE **val, const unsigned char **in, long len, const ASN1_ITEM *it,
66                                         int tag, int aclass, char opt, ASN1_TLC *ctx);
67
68 static int x509_name_ex_i2d(ASN1_VALUE **val, unsigned char **out, const ASN1_ITEM *it, int tag, int aclass);
69 static int x509_name_ex_new(ASN1_VALUE **val, const ASN1_ITEM *it);
70 static void x509_name_ex_free(ASN1_VALUE **val, const ASN1_ITEM *it);
71
72 static int x509_name_encode(X509_NAME *a);
73
74
75 static int x509_name_ex_print(BIO *out, ASN1_VALUE **pval,
76                                                 int indent,
77                                                 const char *fname, 
78                                                 const ASN1_PCTX *pctx);
79
80 ASN1_SEQUENCE(X509_NAME_ENTRY) = {
81         ASN1_SIMPLE(X509_NAME_ENTRY, object, ASN1_OBJECT),
82         ASN1_SIMPLE(X509_NAME_ENTRY, value, ASN1_PRINTABLE)
83 } ASN1_SEQUENCE_END(X509_NAME_ENTRY)
84
85 IMPLEMENT_ASN1_FUNCTIONS(X509_NAME_ENTRY)
86 IMPLEMENT_ASN1_DUP_FUNCTION(X509_NAME_ENTRY)
87
88 /* For the "Name" type we need a SEQUENCE OF { SET OF X509_NAME_ENTRY }
89  * so declare two template wrappers for this
90  */
91
92 ASN1_ITEM_TEMPLATE(X509_NAME_ENTRIES) =
93         ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SET_OF, 0, RDNS, X509_NAME_ENTRY)
94 ASN1_ITEM_TEMPLATE_END(X509_NAME_ENTRIES)
95
96 ASN1_ITEM_TEMPLATE(X509_NAME_INTERNAL) =
97         ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SEQUENCE_OF, 0, Name, X509_NAME_ENTRIES)
98 ASN1_ITEM_TEMPLATE_END(X509_NAME_INTERNAL)
99
100 /* Normally that's where it would end: we'd have two nested STACK structures
101  * representing the ASN1. Unfortunately X509_NAME uses a completely different
102  * form and caches encodings so we have to process the internal form and convert
103  * to the external form.
104  */
105
106 const ASN1_EXTERN_FUNCS x509_name_ff = {
107         NULL,
108         x509_name_ex_new,
109         x509_name_ex_free,
110         0,      /* Default clear behaviour is OK */
111         x509_name_ex_d2i,
112         x509_name_ex_i2d,
113         x509_name_ex_print
114 };
115
116 IMPLEMENT_EXTERN_ASN1(X509_NAME, V_ASN1_SEQUENCE, x509_name_ff) 
117
118 IMPLEMENT_ASN1_FUNCTIONS(X509_NAME)
119 IMPLEMENT_ASN1_DUP_FUNCTION(X509_NAME)
120
121 static int x509_name_ex_new(ASN1_VALUE **val, const ASN1_ITEM *it)
122 {
123         X509_NAME *ret = NULL;
124         ret = OPENSSL_malloc(sizeof(X509_NAME));
125         if(!ret) goto memerr;
126         if ((ret->entries=sk_X509_NAME_ENTRY_new_null()) == NULL)
127                 goto memerr;
128         if((ret->bytes = BUF_MEM_new()) == NULL) goto memerr;
129         ret->modified=1;
130         *val = (ASN1_VALUE *)ret;
131         return 1;
132
133  memerr:
134         ASN1err(ASN1_F_X509_NAME_EX_NEW, ERR_R_MALLOC_FAILURE);
135         if (ret)
136                 {
137                 if (ret->entries)
138                         sk_X509_NAME_ENTRY_free(ret->entries);
139                 OPENSSL_free(ret);
140                 }
141         return 0;
142 }
143
144 static void x509_name_ex_free(ASN1_VALUE **pval, const ASN1_ITEM *it)
145 {
146         X509_NAME *a;
147         if(!pval || !*pval)
148             return;
149         a = (X509_NAME *)*pval;
150
151         BUF_MEM_free(a->bytes);
152         sk_X509_NAME_ENTRY_pop_free(a->entries,X509_NAME_ENTRY_free);
153         OPENSSL_free(a);
154         *pval = NULL;
155 }
156
157 /* Used with sk_pop_free() to free up the internal representation.
158  * NB: we only free the STACK and not its contents because it is
159  * already present in the X509_NAME structure.
160  */
161
162 static void sk_internal_free(void *a)
163 {
164         sk_free(a);
165 }
166
167 static int x509_name_ex_d2i(ASN1_VALUE **val, const unsigned char **in, long len, const ASN1_ITEM *it,
168                                         int tag, int aclass, char opt, ASN1_TLC *ctx)
169 {
170         const unsigned char *p = *in, *q;
171         STACK *intname = NULL, **intname_pp = &intname;
172         int i, j, ret;
173         X509_NAME *nm = NULL, **nm_pp = &nm;
174         STACK_OF(X509_NAME_ENTRY) *entries;
175         X509_NAME_ENTRY *entry;
176         q = p;
177
178         /* Get internal representation of Name */
179         ret = ASN1_item_ex_d2i((ASN1_VALUE **)intname_pp,
180                                &p, len, ASN1_ITEM_rptr(X509_NAME_INTERNAL),
181                                tag, aclass, opt, ctx);
182         
183         if(ret <= 0) return ret;
184
185         if(*val) x509_name_ex_free(val, NULL);
186         if(!x509_name_ex_new((ASN1_VALUE **)nm_pp, NULL)) goto err;
187         /* We've decoded it: now cache encoding */
188         if(!BUF_MEM_grow(nm->bytes, p - q)) goto err;
189         memcpy(nm->bytes->data, q, p - q);
190
191         /* Convert internal representation to X509_NAME structure */
192         for(i = 0; i < sk_num(intname); i++) {
193                 entries = (STACK_OF(X509_NAME_ENTRY) *)sk_value(intname, i);
194                 for(j = 0; j < sk_X509_NAME_ENTRY_num(entries); j++) {
195                         entry = sk_X509_NAME_ENTRY_value(entries, j);
196                         entry->set = i;
197                         if(!sk_X509_NAME_ENTRY_push(nm->entries, entry))
198                                 goto err;
199                 }
200                 sk_X509_NAME_ENTRY_free(entries);
201         }
202         sk_free(intname);
203         nm->modified = 0;
204         *val = (ASN1_VALUE *)nm;
205         *in = p;
206         return ret;
207         err:
208         ASN1err(ASN1_F_X509_NAME_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
209         return 0;
210 }
211
212 static int x509_name_ex_i2d(ASN1_VALUE **val, unsigned char **out, const ASN1_ITEM *it, int tag, int aclass)
213 {
214         int ret;
215         X509_NAME *a = (X509_NAME *)*val;
216         if(a->modified) {
217                 ret = x509_name_encode((X509_NAME *)a);
218                 if(ret < 0) return ret;
219         }
220         ret = a->bytes->length;
221         if(out != NULL) {
222                 memcpy(*out,a->bytes->data,ret);
223                 *out+=ret;
224         }
225         return ret;
226 }
227
228 static int x509_name_encode(X509_NAME *a)
229 {
230         STACK *intname = NULL, **intname_pp = &intname;
231         int len;
232         unsigned char *p;
233         STACK_OF(X509_NAME_ENTRY) *entries = NULL;
234         X509_NAME_ENTRY *entry;
235         int i, set = -1;
236         intname = sk_new_null();
237         if(!intname) goto memerr;
238         for(i = 0; i < sk_X509_NAME_ENTRY_num(a->entries); i++) {
239                 entry = sk_X509_NAME_ENTRY_value(a->entries, i);
240                 if(entry->set != set) {
241                         entries = sk_X509_NAME_ENTRY_new_null();
242                         if(!entries) goto memerr;
243                         if(!sk_push(intname, (char *)entries)) goto memerr;
244                         set = entry->set;
245                 }
246                 if(!sk_X509_NAME_ENTRY_push(entries, entry)) goto memerr;
247         }
248         len = ASN1_item_ex_i2d((ASN1_VALUE **)intname_pp, NULL,
249                                ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
250         if (!BUF_MEM_grow(a->bytes,len)) goto memerr;
251         p=(unsigned char *)a->bytes->data;
252         ASN1_item_ex_i2d((ASN1_VALUE **)intname_pp,
253                          &p, ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
254         sk_pop_free(intname, sk_internal_free);
255         a->modified = 0;
256         return len;
257         memerr:
258         sk_pop_free(intname, sk_internal_free);
259         ASN1err(ASN1_F_X509_NAME_ENCODE, ERR_R_MALLOC_FAILURE);
260         return -1;
261 }
262
263 static int x509_name_ex_print(BIO *out, ASN1_VALUE **pval,
264                                                 int indent,
265                                                 const char *fname, 
266                                                 const ASN1_PCTX *pctx)
267         {
268         if (X509_NAME_print_ex(out, (X509_NAME *)*pval,
269                                         indent, pctx->nm_flags) <= 0)
270                 return 0;
271         return 2;
272         }
273
274
275 int X509_NAME_set(X509_NAME **xn, X509_NAME *name)
276         {
277         X509_NAME *in;
278
279         if (!xn || !name) return(0);
280
281         if (*xn != name)
282                 {
283                 in=X509_NAME_dup(name);
284                 if (in != NULL)
285                         {
286                         X509_NAME_free(*xn);
287                         *xn=in;
288                         }
289                 }
290         return(*xn != NULL);
291         }
292         
293 IMPLEMENT_STACK_OF(X509_NAME_ENTRY)
294 IMPLEMENT_ASN1_SET_OF(X509_NAME_ENTRY)