Utility attribute function to retrieve attribute data from an expected
[openssl.git] / crypto / x509 / x509_att.c
1 /* crypto/x509/x509_att.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 <openssl/stack.h>
61 #include "cryptlib.h"
62 #include <openssl/asn1.h>
63 #include <openssl/objects.h>
64 #include <openssl/evp.h>
65 #include <openssl/x509.h>
66 #include <openssl/x509v3.h>
67
68 int X509at_get_attr_count(const STACK_OF(X509_ATTRIBUTE) *x)
69 {
70         if (!x) return 0;
71         return(sk_X509_ATTRIBUTE_num(x));
72 }
73
74 int X509at_get_attr_by_NID(const STACK_OF(X509_ATTRIBUTE) *x, int nid,
75                           int lastpos)
76 {
77         ASN1_OBJECT *obj;
78
79         obj=OBJ_nid2obj(nid);
80         if (obj == NULL) return(-2);
81         return(X509at_get_attr_by_OBJ(x,obj,lastpos));
82 }
83
84 int X509at_get_attr_by_OBJ(const STACK_OF(X509_ATTRIBUTE) *sk, ASN1_OBJECT *obj,
85                           int lastpos)
86 {
87         int n;
88         X509_ATTRIBUTE *ex;
89
90         if (sk == NULL) return(-1);
91         lastpos++;
92         if (lastpos < 0)
93                 lastpos=0;
94         n=sk_X509_ATTRIBUTE_num(sk);
95         for ( ; lastpos < n; lastpos++)
96                 {
97                 ex=sk_X509_ATTRIBUTE_value(sk,lastpos);
98                 if (OBJ_cmp(ex->object,obj) == 0)
99                         return(lastpos);
100                 }
101         return(-1);
102 }
103
104 X509_ATTRIBUTE *X509at_get_attr(const STACK_OF(X509_ATTRIBUTE) *x, int loc)
105 {
106         if (x == NULL || sk_X509_ATTRIBUTE_num(x) <= loc || loc < 0)
107                 return NULL;
108         else
109                 return sk_X509_ATTRIBUTE_value(x,loc);
110 }
111
112 X509_ATTRIBUTE *X509at_delete_attr(STACK_OF(X509_ATTRIBUTE) *x, int loc)
113 {
114         X509_ATTRIBUTE *ret;
115
116         if (x == NULL || sk_X509_ATTRIBUTE_num(x) <= loc || loc < 0)
117                 return(NULL);
118         ret=sk_X509_ATTRIBUTE_delete(x,loc);
119         return(ret);
120 }
121
122 STACK_OF(X509_ATTRIBUTE) *X509at_add1_attr(STACK_OF(X509_ATTRIBUTE) **x,
123                                          X509_ATTRIBUTE *attr)
124 {
125         X509_ATTRIBUTE *new_attr=NULL;
126         STACK_OF(X509_ATTRIBUTE) *sk=NULL;
127
128         if (x == NULL)
129                 {
130                 X509err(X509_F_X509AT_ADD1_ATTR, ERR_R_PASSED_NULL_PARAMETER);
131                 goto err2;
132                 } 
133
134         if (*x == NULL)
135                 {
136                 if ((sk=sk_X509_ATTRIBUTE_new_null()) == NULL)
137                         goto err;
138                 }
139         else
140                 sk= *x;
141
142         if ((new_attr=X509_ATTRIBUTE_dup(attr)) == NULL)
143                 goto err2;
144         if (!sk_X509_ATTRIBUTE_push(sk,new_attr))
145                 goto err;
146         if (*x == NULL)
147                 *x=sk;
148         return(sk);
149 err:
150         X509err(X509_F_X509AT_ADD1_ATTR,ERR_R_MALLOC_FAILURE);
151 err2:
152         if (new_attr != NULL) X509_ATTRIBUTE_free(new_attr);
153         if (sk != NULL) sk_X509_ATTRIBUTE_free(sk);
154         return(NULL);
155 }
156
157 STACK_OF(X509_ATTRIBUTE) *X509at_add1_attr_by_OBJ(STACK_OF(X509_ATTRIBUTE) **x,
158                         const ASN1_OBJECT *obj, int type,
159                         const unsigned char *bytes, int len)
160 {
161         X509_ATTRIBUTE *attr;
162         STACK_OF(X509_ATTRIBUTE) *ret;
163         attr = X509_ATTRIBUTE_create_by_OBJ(NULL, obj, type, bytes, len);
164         if(!attr) return 0;
165         ret = X509at_add1_attr(x, attr);
166         X509_ATTRIBUTE_free(attr);
167         return ret;
168 }
169
170 STACK_OF(X509_ATTRIBUTE) *X509at_add1_attr_by_NID(STACK_OF(X509_ATTRIBUTE) **x,
171                         int nid, int type,
172                         const unsigned char *bytes, int len)
173 {
174         X509_ATTRIBUTE *attr;
175         STACK_OF(X509_ATTRIBUTE) *ret;
176         attr = X509_ATTRIBUTE_create_by_NID(NULL, nid, type, bytes, len);
177         if(!attr) return 0;
178         ret = X509at_add1_attr(x, attr);
179         X509_ATTRIBUTE_free(attr);
180         return ret;
181 }
182
183 STACK_OF(X509_ATTRIBUTE) *X509at_add1_attr_by_txt(STACK_OF(X509_ATTRIBUTE) **x,
184                         const char *attrname, int type,
185                         const unsigned char *bytes, int len)
186 {
187         X509_ATTRIBUTE *attr;
188         STACK_OF(X509_ATTRIBUTE) *ret;
189         attr = X509_ATTRIBUTE_create_by_txt(NULL, attrname, type, bytes, len);
190         if(!attr) return 0;
191         ret = X509at_add1_attr(x, attr);
192         X509_ATTRIBUTE_free(attr);
193         return ret;
194 }
195
196 void *X509at_get0_data_by_OBJ(STACK_OF(X509_ATTRIBUTE) *x,
197                                 ASN1_OBJECT *obj, int lastpos, int type)
198 {
199         int i;
200         X509_ATTRIBUTE *at;
201         i = X509at_get_attr_by_OBJ(x, obj, lastpos);
202         if (i == -1)
203                 return NULL;
204         if ((lastpos <= -2) && (X509at_get_attr_by_OBJ(x, obj, i) != -1))
205                 return NULL;
206         at = X509at_get_attr(x, i);
207         if (lastpos <= -3 && (X509_ATTRIBUTE_count(at) != 1))
208                 return NULL;
209         return X509_ATTRIBUTE_get0_data(at, type, 0, NULL);
210 }
211
212 X509_ATTRIBUTE *X509_ATTRIBUTE_create_by_NID(X509_ATTRIBUTE **attr, int nid,
213              int atrtype, const void *data, int len)
214 {
215         ASN1_OBJECT *obj;
216         X509_ATTRIBUTE *ret;
217
218         obj=OBJ_nid2obj(nid);
219         if (obj == NULL)
220                 {
221                 X509err(X509_F_X509_ATTRIBUTE_CREATE_BY_NID,X509_R_UNKNOWN_NID);
222                 return(NULL);
223                 }
224         ret=X509_ATTRIBUTE_create_by_OBJ(attr,obj,atrtype,data,len);
225         if (ret == NULL) ASN1_OBJECT_free(obj);
226         return(ret);
227 }
228
229 X509_ATTRIBUTE *X509_ATTRIBUTE_create_by_OBJ(X509_ATTRIBUTE **attr,
230              const ASN1_OBJECT *obj, int atrtype, const void *data, int len)
231 {
232         X509_ATTRIBUTE *ret;
233
234         if ((attr == NULL) || (*attr == NULL))
235                 {
236                 if ((ret=X509_ATTRIBUTE_new()) == NULL)
237                         {
238                         X509err(X509_F_X509_ATTRIBUTE_CREATE_BY_OBJ,ERR_R_MALLOC_FAILURE);
239                         return(NULL);
240                         }
241                 }
242         else
243                 ret= *attr;
244
245         if (!X509_ATTRIBUTE_set1_object(ret,obj))
246                 goto err;
247         if (!X509_ATTRIBUTE_set1_data(ret,atrtype,data,len))
248                 goto err;
249         
250         if ((attr != NULL) && (*attr == NULL)) *attr=ret;
251         return(ret);
252 err:
253         if ((attr == NULL) || (ret != *attr))
254                 X509_ATTRIBUTE_free(ret);
255         return(NULL);
256 }
257
258 X509_ATTRIBUTE *X509_ATTRIBUTE_create_by_txt(X509_ATTRIBUTE **attr,
259                 const char *atrname, int type, const unsigned char *bytes, int len)
260         {
261         ASN1_OBJECT *obj;
262         X509_ATTRIBUTE *nattr;
263
264         obj=OBJ_txt2obj(atrname, 0);
265         if (obj == NULL)
266                 {
267                 X509err(X509_F_X509_ATTRIBUTE_CREATE_BY_TXT,
268                                                 X509_R_INVALID_FIELD_NAME);
269                 ERR_add_error_data(2, "name=", atrname);
270                 return(NULL);
271                 }
272         nattr = X509_ATTRIBUTE_create_by_OBJ(attr,obj,type,bytes,len);
273         ASN1_OBJECT_free(obj);
274         return nattr;
275         }
276
277 int X509_ATTRIBUTE_set1_object(X509_ATTRIBUTE *attr, const ASN1_OBJECT *obj)
278 {
279         if ((attr == NULL) || (obj == NULL))
280                 return(0);
281         ASN1_OBJECT_free(attr->object);
282         attr->object=OBJ_dup(obj);
283         return(1);
284 }
285
286 int X509_ATTRIBUTE_set1_data(X509_ATTRIBUTE *attr, int attrtype, const void *data, int len)
287 {
288         ASN1_TYPE *ttmp;
289         ASN1_STRING *stmp;
290         int atype;
291         if (!attr) return 0;
292         if(attrtype & MBSTRING_FLAG) {
293                 stmp = ASN1_STRING_set_by_NID(NULL, data, len, attrtype,
294                                                 OBJ_obj2nid(attr->object));
295                 if(!stmp) {
296                         X509err(X509_F_X509_ATTRIBUTE_SET1_DATA, ERR_R_ASN1_LIB);
297                         return 0;
298                 }
299                 atype = stmp->type;
300         } else if (len != -1){
301                 if(!(stmp = ASN1_STRING_type_new(attrtype))) goto err;
302                 if(!ASN1_STRING_set(stmp, data, len)) goto err;
303                 atype = attrtype;
304         }
305         if(!(attr->value.set = sk_ASN1_TYPE_new_null())) goto err;
306         if(!(ttmp = ASN1_TYPE_new())) goto err;
307         if (len == -1)
308                 {
309                 if (!ASN1_TYPE_set1(ttmp, attrtype, data))
310                         goto err;
311                 }
312         else
313                 ASN1_TYPE_set(ttmp, atype, stmp);
314         if(!sk_ASN1_TYPE_push(attr->value.set, ttmp)) goto err;
315         attr->single = 0;
316         return 1;
317         err:
318         X509err(X509_F_X509_ATTRIBUTE_SET1_DATA, ERR_R_MALLOC_FAILURE);
319         return 0;
320 }
321
322 int X509_ATTRIBUTE_count(X509_ATTRIBUTE *attr)
323 {
324         if(!attr->single) return sk_ASN1_TYPE_num(attr->value.set);
325         if(attr->value.single) return 1;
326         return 0;
327 }
328
329 ASN1_OBJECT *X509_ATTRIBUTE_get0_object(X509_ATTRIBUTE *attr)
330 {
331         if (attr == NULL) return(NULL);
332         return(attr->object);
333 }
334
335 void *X509_ATTRIBUTE_get0_data(X509_ATTRIBUTE *attr, int idx,
336                                         int atrtype, void *data)
337 {
338         ASN1_TYPE *ttmp;
339         ttmp = X509_ATTRIBUTE_get0_type(attr, idx);
340         if(!ttmp) return NULL;
341         if(atrtype != ASN1_TYPE_get(ttmp)){
342                 X509err(X509_F_X509_ATTRIBUTE_GET0_DATA, X509_R_WRONG_TYPE);
343                 return NULL;
344         }
345         return ttmp->value.ptr;
346 }
347
348 ASN1_TYPE *X509_ATTRIBUTE_get0_type(X509_ATTRIBUTE *attr, int idx)
349 {
350         if (attr == NULL) return(NULL);
351         if(idx >= X509_ATTRIBUTE_count(attr)) return NULL;
352         if(!attr->single) return sk_ASN1_TYPE_value(attr->value.set, idx);
353         else return attr->value.single;
354 }