Ruby: ext/openssl/ossl_asn1.c Source File

Ruby 3.0.5p211 (2022-11-24 revision ba5cf0f7c52d4d35cc6a173c89eda98ceffa2dcf)

ossl_asn1.c
Go to the documentation of this file.
1/*
2 * 'OpenSSL for Ruby' team members
3 * Copyright (C) 2003
4 * All rights reserved.
5 */
6/*
7 * This program is licensed under the same licence as Ruby.
8 * (See the file 'LICENCE'.)
9 */
10#include "ossl.h"
11
12static VALUE ossl_asn1_decode0(unsigned char **pp, long length, long *offset,
13 int depth, int yield, long *num_read);
14static VALUE ossl_asn1_initialize(int argc, VALUE *argv, VALUE self);
15
16/*
17 * DATE conversion
18 */
19 VALUE
20asn1time_to_time(const ASN1_TIME *time)
21{
22 struct tm tm;
23 VALUE argv[6];
24 int count;
25
26 memset(&tm, 0, sizeof(struct tm));
27
28 switch (time->type) {
29 case V_ASN1_UTCTIME:
30 count = sscanf((const char *)time->data, "%2d%2d%2d%2d%2d%2dZ",
31 &tm.tm_year, &tm.tm_mon, &tm.tm_mday, &tm.tm_hour, &tm.tm_min,
32 &tm.tm_sec);
33
34 if (count == 5) {
35 tm.tm_sec = 0;
36 } else if (count != 6) {
37 ossl_raise(rb_eTypeError, "bad UTCTIME format: \"%s\"",
38 time->data);
39 }
40 if (tm.tm_year < 69) {
41 tm.tm_year += 2000;
42 } else {
43 tm.tm_year += 1900;
44 }
45 break;
46 case V_ASN1_GENERALIZEDTIME:
47 count = sscanf((const char *)time->data, "%4d%2d%2d%2d%2d%2dZ",
48 &tm.tm_year, &tm.tm_mon, &tm.tm_mday, &tm.tm_hour, &tm.tm_min,
49 &tm.tm_sec);
50 if (count == 5) {
51 tm.tm_sec = 0;
52 }
53 else if (count != 6) {
54 ossl_raise(rb_eTypeError, "bad GENERALIZEDTIME format: \"%s\"",
55 time->data);
56 }
57 break;
58 default:
59 rb_warning("unknown time format");
60 return Qnil;
61 }
62 argv[0] = INT2NUM(tm.tm_year);
63 argv[1] = INT2NUM(tm.tm_mon);
64 argv[2] = INT2NUM(tm.tm_mday);
65 argv[3] = INT2NUM(tm.tm_hour);
66 argv[4] = INT2NUM(tm.tm_min);
67 argv[5] = INT2NUM(tm.tm_sec);
68
69 return rb_funcall2(rb_cTime, rb_intern("utc"), 6, argv);
70}
71
72void
73ossl_time_split(VALUE time, time_t *sec, int *days)
74{
75 VALUE num = rb_Integer(time);
76
77 if (FIXNUM_P(num)) {
78 time_t t = FIX2LONG(num);
79 *sec = t % 86400;
80 *days = rb_long2int(t / 86400);
81 }
82 else {
83 *days = NUM2INT(rb_funcall(num, rb_intern("/"), 1, INT2FIX(86400)));
84 *sec = NUM2TIMET(rb_funcall(num, rb_intern("%"), 1, INT2FIX(86400)));
85 }
86}
87
88/*
89 * STRING conversion
90 */
91 VALUE
92asn1str_to_str(const ASN1_STRING *str)
93{
94 return rb_str_new((const char *)str->data, str->length);
95}
96
97/*
98 * ASN1_INTEGER conversions
99 */
100 VALUE
101asn1integer_to_num(const ASN1_INTEGER *ai)
102{
103 BIGNUM *bn;
104 VALUE num;
105
106 if (!ai) {
107 ossl_raise(rb_eTypeError, "ASN1_INTEGER is NULL!");
108 }
109 if (ai->type == V_ASN1_ENUMERATED)
110 /* const_cast: workaround for old OpenSSL */
111 bn = ASN1_ENUMERATED_to_BN((ASN1_ENUMERATED *)ai, NULL);
112 else
113 bn = ASN1_INTEGER_to_BN(ai, NULL);
114
115 if (!bn)
116 ossl_raise(eOSSLError, NULL);
117 num = ossl_bn_new(bn);
118 BN_free(bn);
119
120 return num;
121}
122
123ASN1_INTEGER *
124num_to_asn1integer(VALUE obj, ASN1_INTEGER *ai)
125{
126 BIGNUM *bn;
127
128 if (NIL_P(obj))
129 ossl_raise(rb_eTypeError, "Can't convert nil into Integer");
130
131 bn = GetBNPtr(obj);
132
133 if (!(ai = BN_to_ASN1_INTEGER(bn, ai)))
134 ossl_raise(eOSSLError, NULL);
135
136 return ai;
137}
138
139/********/
140/*
141 * ASN1 module
142 */
143#define ossl_asn1_get_value(o) rb_attr_get((o),sivVALUE)
144#define ossl_asn1_get_tag(o) rb_attr_get((o),sivTAG)
145#define ossl_asn1_get_tagging(o) rb_attr_get((o),sivTAGGING)
146#define ossl_asn1_get_tag_class(o) rb_attr_get((o),sivTAG_CLASS)
147#define ossl_asn1_get_indefinite_length(o) rb_attr_get((o),sivINDEFINITE_LENGTH)
148
149#define ossl_asn1_set_value(o,v) rb_ivar_set((o),sivVALUE,(v))
150#define ossl_asn1_set_tag(o,v) rb_ivar_set((o),sivTAG,(v))
151#define ossl_asn1_set_tagging(o,v) rb_ivar_set((o),sivTAGGING,(v))
152#define ossl_asn1_set_tag_class(o,v) rb_ivar_set((o),sivTAG_CLASS,(v))
153#define ossl_asn1_set_indefinite_length(o,v) rb_ivar_set((o),sivINDEFINITE_LENGTH,(v))
154
155 VALUE mASN1;
156 VALUE eASN1Error;
157
158 VALUE cASN1Data;
159 VALUE cASN1Primitive;
160 VALUE cASN1Constructive;
161
162 VALUE cASN1EndOfContent;
163 VALUE cASN1Boolean; /* BOOLEAN */
164 VALUE cASN1Integer, cASN1Enumerated; /* INTEGER */
165 VALUE cASN1BitString; /* BIT STRING */
166 VALUE cASN1OctetString, cASN1UTF8String; /* STRINGs */
167 VALUE cASN1NumericString, cASN1PrintableString;
168 VALUE cASN1T61String, cASN1VideotexString;
169 VALUE cASN1IA5String, cASN1GraphicString;
170 VALUE cASN1ISO64String, cASN1GeneralString;
171 VALUE cASN1UniversalString, cASN1BMPString;
172 VALUE cASN1Null; /* NULL */
173 VALUE cASN1ObjectId; /* OBJECT IDENTIFIER */
174 VALUE cASN1UTCTime, cASN1GeneralizedTime; /* TIME */
175 VALUE cASN1Sequence, cASN1Set; /* CONSTRUCTIVE */
176
177static VALUE sym_IMPLICIT, sym_EXPLICIT;
178static VALUE sym_UNIVERSAL, sym_APPLICATION, sym_CONTEXT_SPECIFIC, sym_PRIVATE;
179static ID sivVALUE, sivTAG, sivTAG_CLASS, sivTAGGING, sivINDEFINITE_LENGTH, sivUNUSED_BITS;
180static ID id_each;
181
182/*
183 * Ruby to ASN1 converters
184 */
185static ASN1_BOOLEAN
186obj_to_asn1bool(VALUE obj)
187{
188 if (NIL_P(obj))
189 ossl_raise(rb_eTypeError, "Can't convert nil into Boolean");
190
191 return RTEST(obj) ? 0xff : 0x0;
192}
193
194static ASN1_INTEGER*
195obj_to_asn1int(VALUE obj)
196{
197 return num_to_asn1integer(obj, NULL);
198}
199
200static ASN1_BIT_STRING*
201obj_to_asn1bstr(VALUE obj, long unused_bits)
202{
203 ASN1_BIT_STRING *bstr;
204
205 if (unused_bits < 0 || unused_bits > 7)
206 ossl_raise(eASN1Error, "unused_bits for a bitstring value must be in "\
207 "the range 0 to 7");
208 StringValue(obj);
209 if(!(bstr = ASN1_BIT_STRING_new()))
210 ossl_raise(eASN1Error, NULL);
211 ASN1_BIT_STRING_set(bstr, (unsigned char *)RSTRING_PTR(obj), RSTRING_LENINT(obj));
212 bstr->flags &= ~(ASN1_STRING_FLAG_BITS_LEFT|0x07); /* clear */
213 bstr->flags |= ASN1_STRING_FLAG_BITS_LEFT | unused_bits;
214
215 return bstr;
216}
217
218static ASN1_STRING*
219obj_to_asn1str(VALUE obj)
220{
221 ASN1_STRING *str;
222
223 StringValue(obj);
224 if(!(str = ASN1_STRING_new()))
225 ossl_raise(eASN1Error, NULL);
226 ASN1_STRING_set(str, RSTRING_PTR(obj), RSTRING_LENINT(obj));
227
228 return str;
229}
230
231static ASN1_NULL*
232obj_to_asn1null(VALUE obj)
233{
234 ASN1_NULL *null;
235
236 if(!NIL_P(obj))
237 ossl_raise(eASN1Error, "nil expected");
238 if(!(null = ASN1_NULL_new()))
239 ossl_raise(eASN1Error, NULL);
240
241 return null;
242}
243
244static ASN1_OBJECT*
245obj_to_asn1obj(VALUE obj)
246{
247 ASN1_OBJECT *a1obj;
248
249 StringValueCStr(obj);
250 a1obj = OBJ_txt2obj(RSTRING_PTR(obj), 0);
251 if(!a1obj) a1obj = OBJ_txt2obj(RSTRING_PTR(obj), 1);
252 if(!a1obj) ossl_raise(eASN1Error, "invalid OBJECT ID %"PRIsVALUE, obj);
253
254 return a1obj;
255}
256
257static ASN1_UTCTIME *
258obj_to_asn1utime(VALUE time)
259{
260 time_t sec;
261 ASN1_UTCTIME *t;
262
263 int off_days;
264
265 ossl_time_split(time, &sec, &off_days);
266 if (!(t = ASN1_UTCTIME_adj(NULL, sec, off_days, 0)))
267 ossl_raise(eASN1Error, NULL);
268
269 return t;
270}
271
272static ASN1_GENERALIZEDTIME *
273obj_to_asn1gtime(VALUE time)
274{
275 time_t sec;
276 ASN1_GENERALIZEDTIME *t;
277
278 int off_days;
279
280 ossl_time_split(time, &sec, &off_days);
281 if (!(t = ASN1_GENERALIZEDTIME_adj(NULL, sec, off_days, 0)))
282 ossl_raise(eASN1Error, NULL);
283
284 return t;
285}
286
287static ASN1_STRING*
288obj_to_asn1derstr(VALUE obj)
289{
290 ASN1_STRING *a1str;
291 VALUE str;
292
293 str = ossl_to_der(obj);
294 if(!(a1str = ASN1_STRING_new()))
295 ossl_raise(eASN1Error, NULL);
296 ASN1_STRING_set(a1str, RSTRING_PTR(str), RSTRING_LENINT(str));
297
298 return a1str;
299}
300
301/*
302 * DER to Ruby converters
303 */
304static VALUE
305decode_bool(unsigned char* der, long length)
306{
307 const unsigned char *p = der;
308
309 if (length != 3)
310 ossl_raise(eASN1Error, "invalid length for BOOLEAN");
311 if (p[0] != 1 || p[1] != 1)
312 ossl_raise(eASN1Error, "invalid BOOLEAN");
313
314 return p[2] ? Qtrue : Qfalse;
315}
316
317static VALUE
318decode_int(unsigned char* der, long length)
319{
320 ASN1_INTEGER *ai;
321 const unsigned char *p;
322 VALUE ret;
323 int status = 0;
324
325 p = der;
326 if(!(ai = d2i_ASN1_INTEGER(NULL, &p, length)))
327 ossl_raise(eASN1Error, NULL);
328 ret = rb_protect((VALUE (*)(VALUE))asn1integer_to_num,
329 (VALUE)ai, &status);
330 ASN1_INTEGER_free(ai);
331 if(status) rb_jump_tag(status);
332
333 return ret;
334}
335
336static VALUE
337decode_bstr(unsigned char* der, long length, long *unused_bits)
338{
339 ASN1_BIT_STRING *bstr;
340 const unsigned char *p;
341 long len;
342 VALUE ret;
343
344 p = der;
345 if(!(bstr = d2i_ASN1_BIT_STRING(NULL, &p, length)))
346 ossl_raise(eASN1Error, NULL);
347 len = bstr->length;
348 *unused_bits = 0;
349 if(bstr->flags & ASN1_STRING_FLAG_BITS_LEFT)
350 *unused_bits = bstr->flags & 0x07;
351 ret = rb_str_new((const char *)bstr->data, len);
352 ASN1_BIT_STRING_free(bstr);
353
354 return ret;
355}
356
357static VALUE
358decode_enum(unsigned char* der, long length)
359{
360 ASN1_ENUMERATED *ai;
361 const unsigned char *p;
362 VALUE ret;
363 int status = 0;
364
365 p = der;
366 if(!(ai = d2i_ASN1_ENUMERATED(NULL, &p, length)))
367 ossl_raise(eASN1Error, NULL);
368 ret = rb_protect((VALUE (*)(VALUE))asn1integer_to_num,
369 (VALUE)ai, &status);
370 ASN1_ENUMERATED_free(ai);
371 if(status) rb_jump_tag(status);
372
373 return ret;
374}
375
376static VALUE
377decode_null(unsigned char* der, long length)
378{
379 ASN1_NULL *null;
380 const unsigned char *p;
381
382 p = der;
383 if(!(null = d2i_ASN1_NULL(NULL, &p, length)))
384 ossl_raise(eASN1Error, NULL);
385 ASN1_NULL_free(null);
386
387 return Qnil;
388}
389
390static VALUE
391decode_obj(unsigned char* der, long length)
392{
393 ASN1_OBJECT *obj;
394 const unsigned char *p;
395 VALUE ret;
396 int nid;
397 BIO *bio;
398
399 p = der;
400 if(!(obj = d2i_ASN1_OBJECT(NULL, &p, length)))
401 ossl_raise(eASN1Error, NULL);
402 if((nid = OBJ_obj2nid(obj)) != NID_undef){
403 ASN1_OBJECT_free(obj);
404 ret = rb_str_new2(OBJ_nid2sn(nid));
405 }
406 else{
407 if(!(bio = BIO_new(BIO_s_mem()))){
408 ASN1_OBJECT_free(obj);
409 ossl_raise(eASN1Error, NULL);
410 }
411 i2a_ASN1_OBJECT(bio, obj);
412 ASN1_OBJECT_free(obj);
413 ret = ossl_membio2str(bio);
414 }
415
416 return ret;
417}
418
419static VALUE
420decode_time(unsigned char* der, long length)
421{
422 ASN1_TIME *time;
423 const unsigned char *p;
424 VALUE ret;
425 int status = 0;
426
427 p = der;
428 if(!(time = d2i_ASN1_TIME(NULL, &p, length)))
429 ossl_raise(eASN1Error, NULL);
430 ret = rb_protect((VALUE (*)(VALUE))asn1time_to_time,
431 (VALUE)time, &status);
432 ASN1_TIME_free(time);
433 if(status) rb_jump_tag(status);
434
435 return ret;
436}
437
438static VALUE
439decode_eoc(unsigned char *der, long length)
440{
441 if (length != 2 || !(der[0] == 0x00 && der[1] == 0x00))
442 ossl_raise(eASN1Error, NULL);
443
444 return rb_str_new("", 0);
445}
446
447/********/
448
449 typedef struct {
450 const char *name;
451 VALUE *klass;
452} ossl_asn1_info_t;
453
454static const ossl_asn1_info_t ossl_asn1_info[] = {
455 { "EOC", &cASN1EndOfContent, }, /* 0 */
456 { "BOOLEAN", &cASN1Boolean, }, /* 1 */
457 { "INTEGER", &cASN1Integer, }, /* 2 */
458 { "BIT_STRING", &cASN1BitString, }, /* 3 */
459 { "OCTET_STRING", &cASN1OctetString, }, /* 4 */
460 { "NULL", &cASN1Null, }, /* 5 */
461 { "OBJECT", &cASN1ObjectId, }, /* 6 */
462 { "OBJECT_DESCRIPTOR", NULL, }, /* 7 */
463 { "EXTERNAL", NULL, }, /* 8 */
464 { "REAL", NULL, }, /* 9 */
465 { "ENUMERATED", &cASN1Enumerated, }, /* 10 */
466 { "EMBEDDED_PDV", NULL, }, /* 11 */
467 { "UTF8STRING", &cASN1UTF8String, }, /* 12 */
468 { "RELATIVE_OID", NULL, }, /* 13 */
469 { "[UNIVERSAL 14]", NULL, }, /* 14 */
470 { "[UNIVERSAL 15]", NULL, }, /* 15 */
471 { "SEQUENCE", &cASN1Sequence, }, /* 16 */
472 { "SET", &cASN1Set, }, /* 17 */
473 { "NUMERICSTRING", &cASN1NumericString, }, /* 18 */
474 { "PRINTABLESTRING", &cASN1PrintableString, }, /* 19 */
475 { "T61STRING", &cASN1T61String, }, /* 20 */
476 { "VIDEOTEXSTRING", &cASN1VideotexString, }, /* 21 */
477 { "IA5STRING", &cASN1IA5String, }, /* 22 */
478 { "UTCTIME", &cASN1UTCTime, }, /* 23 */
479 { "GENERALIZEDTIME", &cASN1GeneralizedTime, }, /* 24 */
480 { "GRAPHICSTRING", &cASN1GraphicString, }, /* 25 */
481 { "ISO64STRING", &cASN1ISO64String, }, /* 26 */
482 { "GENERALSTRING", &cASN1GeneralString, }, /* 27 */
483 { "UNIVERSALSTRING", &cASN1UniversalString, }, /* 28 */
484 { "CHARACTER_STRING", NULL, }, /* 29 */
485 { "BMPSTRING", &cASN1BMPString, }, /* 30 */
486};
487
488 enum {ossl_asn1_info_size = (sizeof(ossl_asn1_info)/sizeof(ossl_asn1_info[0]))};
489
490static VALUE class_tag_map;
491
492static int ossl_asn1_default_tag(VALUE obj);
493
494ASN1_TYPE*
495ossl_asn1_get_asn1type(VALUE obj)
496{
497 ASN1_TYPE *ret;
498 VALUE value, rflag;
499 void *ptr;
500 void (*free_func)();
501 int tag;
502
503 tag = ossl_asn1_default_tag(obj);
504 value = ossl_asn1_get_value(obj);
505 switch(tag){
506 case V_ASN1_BOOLEAN:
507 ptr = (void*)(VALUE)obj_to_asn1bool(value);
508 free_func = NULL;
509 break;
510 case V_ASN1_INTEGER: /* FALLTHROUGH */
511 case V_ASN1_ENUMERATED:
512 ptr = obj_to_asn1int(value);
513 free_func = ASN1_INTEGER_free;
514 break;
515 case V_ASN1_BIT_STRING:
516 rflag = rb_attr_get(obj, sivUNUSED_BITS);
517 ptr = obj_to_asn1bstr(value, NUM2INT(rflag));
518 free_func = ASN1_BIT_STRING_free;
519 break;
520 case V_ASN1_NULL:
521 ptr = obj_to_asn1null(value);
522 free_func = ASN1_NULL_free;
523 break;
524 case V_ASN1_OCTET_STRING: /* FALLTHROUGH */
525 case V_ASN1_UTF8STRING: /* FALLTHROUGH */
526 case V_ASN1_NUMERICSTRING: /* FALLTHROUGH */
527 case V_ASN1_PRINTABLESTRING: /* FALLTHROUGH */
528 case V_ASN1_T61STRING: /* FALLTHROUGH */
529 case V_ASN1_VIDEOTEXSTRING: /* FALLTHROUGH */
530 case V_ASN1_IA5STRING: /* FALLTHROUGH */
531 case V_ASN1_GRAPHICSTRING: /* FALLTHROUGH */
532 case V_ASN1_ISO64STRING: /* FALLTHROUGH */
533 case V_ASN1_GENERALSTRING: /* FALLTHROUGH */
534 case V_ASN1_UNIVERSALSTRING: /* FALLTHROUGH */
535 case V_ASN1_BMPSTRING:
536 ptr = obj_to_asn1str(value);
537 free_func = ASN1_STRING_free;
538 break;
539 case V_ASN1_OBJECT:
540 ptr = obj_to_asn1obj(value);
541 free_func = ASN1_OBJECT_free;
542 break;
543 case V_ASN1_UTCTIME:
544 ptr = obj_to_asn1utime(value);
545 free_func = ASN1_TIME_free;
546 break;
547 case V_ASN1_GENERALIZEDTIME:
548 ptr = obj_to_asn1gtime(value);
549 free_func = ASN1_TIME_free;
550 break;
551 case V_ASN1_SET: /* FALLTHROUGH */
552 case V_ASN1_SEQUENCE:
553 ptr = obj_to_asn1derstr(obj);
554 free_func = ASN1_STRING_free;
555 break;
556 default:
557 ossl_raise(eASN1Error, "unsupported ASN.1 type");
558 }
559 if(!(ret = OPENSSL_malloc(sizeof(ASN1_TYPE)))){
560 if(free_func) free_func(ptr);
561 ossl_raise(eASN1Error, "ASN1_TYPE alloc failure");
562 }
563 memset(ret, 0, sizeof(ASN1_TYPE));
564 ASN1_TYPE_set(ret, tag, ptr);
565
566 return ret;
567}
568
569static int
570ossl_asn1_default_tag(VALUE obj)
571{
572 VALUE tmp_class, tag;
573
574 tmp_class = CLASS_OF(obj);
575 while (!NIL_P(tmp_class)) {
576 tag = rb_hash_lookup(class_tag_map, tmp_class);
577 if (tag != Qnil)
578 return NUM2INT(tag);
579 tmp_class = rb_class_superclass(tmp_class);
580 }
581
582 return -1;
583}
584
585static int
586ossl_asn1_tag(VALUE obj)
587{
588 VALUE tag;
589
590 tag = ossl_asn1_get_tag(obj);
591 if(NIL_P(tag))
592 ossl_raise(eASN1Error, "tag number not specified");
593
594 return NUM2INT(tag);
595}
596
597static int
598ossl_asn1_tag_class(VALUE obj)
599{
600 VALUE s;
601
602 s = ossl_asn1_get_tag_class(obj);
603 if (NIL_P(s) || s == sym_UNIVERSAL)
604 return V_ASN1_UNIVERSAL;
605 else if (s == sym_APPLICATION)
606 return V_ASN1_APPLICATION;
607 else if (s == sym_CONTEXT_SPECIFIC)
608 return V_ASN1_CONTEXT_SPECIFIC;
609 else if (s == sym_PRIVATE)
610 return V_ASN1_PRIVATE;
611 else
612 ossl_raise(eASN1Error, "invalid tag class");
613}
614
615static VALUE
616ossl_asn1_class2sym(int tc)
617{
618 if((tc & V_ASN1_PRIVATE) == V_ASN1_PRIVATE)
619 return sym_PRIVATE;
620 else if((tc & V_ASN1_CONTEXT_SPECIFIC) == V_ASN1_CONTEXT_SPECIFIC)
621 return sym_CONTEXT_SPECIFIC;
622 else if((tc & V_ASN1_APPLICATION) == V_ASN1_APPLICATION)
623 return sym_APPLICATION;
624 else
625 return sym_UNIVERSAL;
626}
627
628/*
629 * call-seq:
630 * OpenSSL::ASN1::ASN1Data.new(value, tag, tag_class) => ASN1Data
631 *
632 * _value_: Please have a look at Constructive and Primitive to see how Ruby
633 * types are mapped to ASN.1 types and vice versa.
634 *
635 * _tag_: An Integer indicating the tag number.
636 *
637 * _tag_class_: A Symbol indicating the tag class. Please cf. ASN1 for
638 * possible values.
639 *
640 * == Example
641 * asn1_int = OpenSSL::ASN1Data.new(42, 2, :UNIVERSAL) # => Same as OpenSSL::ASN1::Integer.new(42)
642 * tagged_int = OpenSSL::ASN1Data.new(42, 0, :CONTEXT_SPECIFIC) # implicitly 0-tagged INTEGER
643 */
644static VALUE
645ossl_asn1data_initialize(VALUE self, VALUE value, VALUE tag, VALUE tag_class)
646{
647 if(!SYMBOL_P(tag_class))
648 ossl_raise(eASN1Error, "invalid tag class");
649 ossl_asn1_set_tag(self, tag);
650 ossl_asn1_set_value(self, value);
651 ossl_asn1_set_tag_class(self, tag_class);
652 ossl_asn1_set_indefinite_length(self, Qfalse);
653
654 return self;
655}
656
657static VALUE
658to_der_internal(VALUE self, int constructed, int indef_len, VALUE body)
659{
660 int encoding = constructed ? indef_len ? 2 : 1 : 0;
661 int tag_class = ossl_asn1_tag_class(self);
662 int tag_number = ossl_asn1_tag(self);
663 int default_tag_number = ossl_asn1_default_tag(self);
664 int body_length, total_length;
665 VALUE str;
666 unsigned char *p;
667
668 body_length = RSTRING_LENINT(body);
669 if (ossl_asn1_get_tagging(self) == sym_EXPLICIT) {
670 int inner_length, e_encoding = indef_len ? 2 : 1;
671
672 if (default_tag_number == -1)
673 ossl_raise(eASN1Error, "explicit tagging of unknown tag");
674
675 inner_length = ASN1_object_size(encoding, body_length, default_tag_number);
676 total_length = ASN1_object_size(e_encoding, inner_length, tag_number);
677 str = rb_str_new(NULL, total_length);
678 p = (unsigned char *)RSTRING_PTR(str);
679 /* Put explicit tag */
680 ASN1_put_object(&p, e_encoding, inner_length, tag_number, tag_class);
681 /* Append inner object */
682 ASN1_put_object(&p, encoding, body_length, default_tag_number, V_ASN1_UNIVERSAL);
683 memcpy(p, RSTRING_PTR(body), body_length);
684 p += body_length;
685 if (indef_len) {
686 ASN1_put_eoc(&p); /* For inner object */
687 ASN1_put_eoc(&p); /* For wrapper object */
688 }
689 }
690 else {
691 total_length = ASN1_object_size(encoding, body_length, tag_number);
692 str = rb_str_new(NULL, total_length);
693 p = (unsigned char *)RSTRING_PTR(str);
694 ASN1_put_object(&p, encoding, body_length, tag_number, tag_class);
695 memcpy(p, RSTRING_PTR(body), body_length);
696 p += body_length;
697 if (indef_len)
698 ASN1_put_eoc(&p);
699 }
700 assert(p - (unsigned char *)RSTRING_PTR(str) == total_length);
701 return str;
702}
703
704static VALUE ossl_asn1prim_to_der(VALUE);
705static VALUE ossl_asn1cons_to_der(VALUE);
706/*
707 * call-seq:
708 * asn1.to_der => DER-encoded String
709 *
710 * Encodes this ASN1Data into a DER-encoded String value. The result is
711 * DER-encoded except for the possibility of indefinite length forms.
712 * Indefinite length forms are not allowed in strict DER, so strictly speaking
713 * the result of such an encoding would be a BER-encoding.
714 */
715static VALUE
716ossl_asn1data_to_der(VALUE self)
717{
718 VALUE value = ossl_asn1_get_value(self);
719
720 if (rb_obj_is_kind_of(value, rb_cArray))
721 return ossl_asn1cons_to_der(self);
722 else {
723 if (RTEST(ossl_asn1_get_indefinite_length(self)))
724 ossl_raise(eASN1Error, "indefinite length form cannot be used " \
725 "with primitive encoding");
726 return ossl_asn1prim_to_der(self);
727 }
728}
729
730static VALUE
731int_ossl_asn1_decode0_prim(unsigned char **pp, long length, long hlen, int tag,
732 VALUE tc, long *num_read)
733{
734 VALUE value, asn1data;
735 unsigned char *p;
736 long flag = 0;
737
738 p = *pp;
739
740 if(tc == sym_UNIVERSAL && tag < ossl_asn1_info_size) {
741 switch(tag){
742 case V_ASN1_EOC:
743 value = decode_eoc(p, hlen+length);
744 break;
745 case V_ASN1_BOOLEAN:
746 value = decode_bool(p, hlen+length);
747 break;
748 case V_ASN1_INTEGER:
749 value = decode_int(p, hlen+length);
750 break;
751 case V_ASN1_BIT_STRING:
752 value = decode_bstr(p, hlen+length, &flag);
753 break;
754 case V_ASN1_NULL:
755 value = decode_null(p, hlen+length);
756 break;
757 case V_ASN1_ENUMERATED:
758 value = decode_enum(p, hlen+length);
759 break;
760 case V_ASN1_OBJECT:
761 value = decode_obj(p, hlen+length);
762 break;
763 case V_ASN1_UTCTIME: /* FALLTHROUGH */
764 case V_ASN1_GENERALIZEDTIME:
765 value = decode_time(p, hlen+length);
766 break;
767 default:
768 /* use original value */
769 p += hlen;
770 value = rb_str_new((const char *)p, length);
771 break;
772 }
773 }
774 else {
775 p += hlen;
776 value = rb_str_new((const char *)p, length);
777 }
778
779 *pp += hlen + length;
780 *num_read = hlen + length;
781
782 if (tc == sym_UNIVERSAL &&
783 tag < ossl_asn1_info_size && ossl_asn1_info[tag].klass) {
784 VALUE klass = *ossl_asn1_info[tag].klass;
785 VALUE args[4];
786 args[0] = value;
787 args[1] = INT2NUM(tag);
788 args[2] = Qnil;
789 args[3] = tc;
790 asn1data = rb_obj_alloc(klass);
791 ossl_asn1_initialize(4, args, asn1data);
792 if(tag == V_ASN1_BIT_STRING){
793 rb_ivar_set(asn1data, sivUNUSED_BITS, LONG2NUM(flag));
794 }
795 }
796 else {
797 asn1data = rb_obj_alloc(cASN1Data);
798 ossl_asn1data_initialize(asn1data, value, INT2NUM(tag), tc);
799 }
800
801 return asn1data;
802}
803
804static VALUE
805int_ossl_asn1_decode0_cons(unsigned char **pp, long max_len, long length,
806 long *offset, int depth, int yield, int j,
807 int tag, VALUE tc, long *num_read)
808{
809 VALUE value, asn1data, ary;
810 int indefinite;
811 long available_len, off = *offset;
812
813 indefinite = (j == 0x21);
814 ary = rb_ary_new();
815
816 available_len = indefinite ? max_len : length;
817 while (available_len > 0) {
818 long inner_read = 0;
819 value = ossl_asn1_decode0(pp, available_len, &off, depth + 1, yield, &inner_read);
820 *num_read += inner_read;
821 available_len -= inner_read;
822
823 if (indefinite &&
824 ossl_asn1_tag(value) == V_ASN1_EOC &&
825 ossl_asn1_get_tag_class(value) == sym_UNIVERSAL) {
826 break;
827 }
828 rb_ary_push(ary, value);
829 }
830
831 if (tc == sym_UNIVERSAL) {
832 VALUE args[4];
833 if (tag == V_ASN1_SEQUENCE || tag == V_ASN1_SET)
834 asn1data = rb_obj_alloc(*ossl_asn1_info[tag].klass);
835 else
836 asn1data = rb_obj_alloc(cASN1Constructive);
837 args[0] = ary;
838 args[1] = INT2NUM(tag);
839 args[2] = Qnil;
840 args[3] = tc;
841 ossl_asn1_initialize(4, args, asn1data);
842 }
843 else {
844 asn1data = rb_obj_alloc(cASN1Data);
845 ossl_asn1data_initialize(asn1data, ary, INT2NUM(tag), tc);
846 }
847
848 if (indefinite)
849 ossl_asn1_set_indefinite_length(asn1data, Qtrue);
850 else
851 ossl_asn1_set_indefinite_length(asn1data, Qfalse);
852
853 *offset = off;
854 return asn1data;
855}
856
857static VALUE
858ossl_asn1_decode0(unsigned char **pp, long length, long *offset, int depth,
859 int yield, long *num_read)
860{
861 unsigned char *start, *p;
862 const unsigned char *p0;
863 long len = 0, inner_read = 0, off = *offset, hlen;
864 int tag, tc, j;
865 VALUE asn1data, tag_class;
866
867 p = *pp;
868 start = p;
869 p0 = p;
870 j = ASN1_get_object(&p0, &len, &tag, &tc, length);
871 p = (unsigned char *)p0;
872 if(j & 0x80) ossl_raise(eASN1Error, NULL);
873 if(len > length) ossl_raise(eASN1Error, "value is too short");
874 if((tc & V_ASN1_PRIVATE) == V_ASN1_PRIVATE)
875 tag_class = sym_PRIVATE;
876 else if((tc & V_ASN1_CONTEXT_SPECIFIC) == V_ASN1_CONTEXT_SPECIFIC)
877 tag_class = sym_CONTEXT_SPECIFIC;
878 else if((tc & V_ASN1_APPLICATION) == V_ASN1_APPLICATION)
879 tag_class = sym_APPLICATION;
880 else
881 tag_class = sym_UNIVERSAL;
882
883 hlen = p - start;
884
885 if(yield) {
886 VALUE arg = rb_ary_new();
887 rb_ary_push(arg, LONG2NUM(depth));
888 rb_ary_push(arg, LONG2NUM(*offset));
889 rb_ary_push(arg, LONG2NUM(hlen));
890 rb_ary_push(arg, LONG2NUM(len));
891 rb_ary_push(arg, (j & V_ASN1_CONSTRUCTED) ? Qtrue : Qfalse);
892 rb_ary_push(arg, ossl_asn1_class2sym(tc));
893 rb_ary_push(arg, INT2NUM(tag));
894 rb_yield(arg);
895 }
896
897 if(j & V_ASN1_CONSTRUCTED) {
898 *pp += hlen;
899 off += hlen;
900 asn1data = int_ossl_asn1_decode0_cons(pp, length - hlen, len, &off, depth, yield, j, tag, tag_class, &inner_read);
901 inner_read += hlen;
902 }
903 else {
904 if ((j & 0x01) && (len == 0))
905 ossl_raise(eASN1Error, "indefinite length for primitive value");
906 asn1data = int_ossl_asn1_decode0_prim(pp, len, hlen, tag, tag_class, &inner_read);
907 off += hlen + len;
908 }
909 if (num_read)
910 *num_read = inner_read;
911 if (len != 0 && inner_read != hlen + len) {
912 ossl_raise(eASN1Error,
913 "Type mismatch. Bytes read: %ld Bytes available: %ld",
914 inner_read, hlen + len);
915 }
916
917 *offset = off;
918 return asn1data;
919}
920
921static void
922int_ossl_decode_sanity_check(long len, long read, long offset)
923{
924 if (len != 0 && (read != len || offset != len)) {
925 ossl_raise(eASN1Error,
926 "Type mismatch. Total bytes read: %ld Bytes available: %ld Offset: %ld",
927 read, len, offset);
928 }
929}
930
931/*
932 * call-seq:
933 * OpenSSL::ASN1.traverse(asn1) -> nil
934 *
935 * If a block is given, it prints out each of the elements encountered.
936 * Block parameters are (in that order):
937 * * depth: The recursion depth, plus one with each constructed value being encountered (Integer)
938 * * offset: Current byte offset (Integer)
939 * * header length: Combined length in bytes of the Tag and Length headers. (Integer)
940 * * length: The overall remaining length of the entire data (Integer)
941 * * constructed: Whether this value is constructed or not (Boolean)
942 * * tag_class: Current tag class (Symbol)
943 * * tag: The current tag number (Integer)
944 *
945 * == Example
946 * der = File.binread('asn1data.der')
947 * OpenSSL::ASN1.traverse(der) do | depth, offset, header_len, length, constructed, tag_class, tag|
948 * puts "Depth: #{depth} Offset: #{offset} Length: #{length}"
949 * puts "Header length: #{header_len} Tag: #{tag} Tag class: #{tag_class} Constructed: #{constructed}"
950 * end
951 */
952static VALUE
953ossl_asn1_traverse(VALUE self, VALUE obj)
954{
955 unsigned char *p;
956 VALUE tmp;
957 long len, read = 0, offset = 0;
958
959 obj = ossl_to_der_if_possible(obj);
960 tmp = rb_str_new4(StringValue(obj));
961 p = (unsigned char *)RSTRING_PTR(tmp);
962 len = RSTRING_LEN(tmp);
963 ossl_asn1_decode0(&p, len, &offset, 0, 1, &read);
964 RB_GC_GUARD(tmp);
965 int_ossl_decode_sanity_check(len, read, offset);
966 return Qnil;
967}
968
969/*
970 * call-seq:
971 * OpenSSL::ASN1.decode(der) -> ASN1Data
972 *
973 * Decodes a BER- or DER-encoded value and creates an ASN1Data instance. _der_
974 * may be a String or any object that features a +.to_der+ method transforming
975 * it into a BER-/DER-encoded String+
976 *
977 * == Example
978 * der = File.binread('asn1data')
979 * asn1 = OpenSSL::ASN1.decode(der)
980 */
981static VALUE
982ossl_asn1_decode(VALUE self, VALUE obj)
983{
984 VALUE ret;
985 unsigned char *p;
986 VALUE tmp;
987 long len, read = 0, offset = 0;
988
989 obj = ossl_to_der_if_possible(obj);
990 tmp = rb_str_new4(StringValue(obj));
991 p = (unsigned char *)RSTRING_PTR(tmp);
992 len = RSTRING_LEN(tmp);
993 ret = ossl_asn1_decode0(&p, len, &offset, 0, 0, &read);
994 RB_GC_GUARD(tmp);
995 int_ossl_decode_sanity_check(len, read, offset);
996 return ret;
997}
998
999/*
1000 * call-seq:
1001 * OpenSSL::ASN1.decode_all(der) -> Array of ASN1Data
1002 *
1003 * Similar to #decode with the difference that #decode expects one
1004 * distinct value represented in _der_. #decode_all on the contrary
1005 * decodes a sequence of sequential BER/DER values lined up in _der_
1006 * and returns them as an array.
1007 *
1008 * == Example
1009 * ders = File.binread('asn1data_seq')
1010 * asn1_ary = OpenSSL::ASN1.decode_all(ders)
1011 */
1012static VALUE
1013ossl_asn1_decode_all(VALUE self, VALUE obj)
1014{
1015 VALUE ary, val;
1016 unsigned char *p;
1017 long len, tmp_len = 0, read = 0, offset = 0;
1018 VALUE tmp;
1019
1020 obj = ossl_to_der_if_possible(obj);
1021 tmp = rb_str_new4(StringValue(obj));
1022 p = (unsigned char *)RSTRING_PTR(tmp);
1023 len = RSTRING_LEN(tmp);
1024 tmp_len = len;
1025 ary = rb_ary_new();
1026 while (tmp_len > 0) {
1027 long tmp_read = 0;
1028 val = ossl_asn1_decode0(&p, tmp_len, &offset, 0, 0, &tmp_read);
1029 rb_ary_push(ary, val);
1030 read += tmp_read;
1031 tmp_len -= tmp_read;
1032 }
1033 RB_GC_GUARD(tmp);
1034 int_ossl_decode_sanity_check(len, read, offset);
1035 return ary;
1036}
1037
1038/*
1039 * call-seq:
1040 * OpenSSL::ASN1::Primitive.new(value [, tag, tagging, tag_class ]) => Primitive
1041 *
1042 * _value_: is mandatory.
1043 *
1044 * _tag_: optional, may be specified for tagged values. If no _tag_ is
1045 * specified, the UNIVERSAL tag corresponding to the Primitive sub-class
1046 * is used by default.
1047 *
1048 * _tagging_: may be used as an encoding hint to encode a value either
1049 * explicitly or implicitly, see ASN1 for possible values.
1050 *
1051 * _tag_class_: if _tag_ and _tagging_ are +nil+ then this is set to
1052 * +:UNIVERSAL+ by default. If either _tag_ or _tagging_ are set then
1053 * +:CONTEXT_SPECIFIC+ is used as the default. For possible values please
1054 * cf. ASN1.
1055 *
1056 * == Example
1057 * int = OpenSSL::ASN1::Integer.new(42)
1058 * zero_tagged_int = OpenSSL::ASN1::Integer.new(42, 0, :IMPLICIT)
1059 * private_explicit_zero_tagged_int = OpenSSL::ASN1::Integer.new(42, 0, :EXPLICIT, :PRIVATE)
1060 */
1061static VALUE
1062ossl_asn1_initialize(int argc, VALUE *argv, VALUE self)
1063{
1064 VALUE value, tag, tagging, tag_class;
1065 int default_tag;
1066
1067 rb_scan_args(argc, argv, "13", &value, &tag, &tagging, &tag_class);
1068 default_tag = ossl_asn1_default_tag(self);
1069
1070 if (default_tag == -1 || argc > 1) {
1071 if(NIL_P(tag))
1072 ossl_raise(eASN1Error, "must specify tag number");
1073 if(!NIL_P(tagging) && !SYMBOL_P(tagging))
1074 ossl_raise(eASN1Error, "invalid tagging method");
1075 if(NIL_P(tag_class)) {
1076 if (NIL_P(tagging))
1077 tag_class = sym_UNIVERSAL;
1078 else
1079 tag_class = sym_CONTEXT_SPECIFIC;
1080 }
1081 if(!SYMBOL_P(tag_class))
1082 ossl_raise(eASN1Error, "invalid tag class");
1083 }
1084 else{
1085 tag = INT2NUM(default_tag);
1086 tagging = Qnil;
1087 tag_class = sym_UNIVERSAL;
1088 }
1089 ossl_asn1_set_tag(self, tag);
1090 ossl_asn1_set_value(self, value);
1091 ossl_asn1_set_tagging(self, tagging);
1092 ossl_asn1_set_tag_class(self, tag_class);
1093 ossl_asn1_set_indefinite_length(self, Qfalse);
1094 if (default_tag == V_ASN1_BIT_STRING)
1095 rb_ivar_set(self, sivUNUSED_BITS, INT2FIX(0));
1096
1097 return self;
1098}
1099
1100static VALUE
1101ossl_asn1eoc_initialize(VALUE self) {
1102 VALUE tag, tagging, tag_class, value;
1103 tag = INT2FIX(0);
1104 tagging = Qnil;
1105 tag_class = sym_UNIVERSAL;
1106 value = rb_str_new("", 0);
1107 ossl_asn1_set_tag(self, tag);
1108 ossl_asn1_set_value(self, value);
1109 ossl_asn1_set_tagging(self, tagging);
1110 ossl_asn1_set_tag_class(self, tag_class);
1111 ossl_asn1_set_indefinite_length(self, Qfalse);
1112 return self;
1113}
1114
1115static VALUE
1116ossl_asn1eoc_to_der(VALUE self)
1117{
1118 return rb_str_new("\0\0", 2);
1119}
1120
1121/*
1122 * call-seq:
1123 * asn1.to_der => DER-encoded String
1124 *
1125 * See ASN1Data#to_der for details.
1126 */
1127static VALUE
1128ossl_asn1prim_to_der(VALUE self)
1129{
1130 ASN1_TYPE *asn1;
1131 long alllen, bodylen;
1132 unsigned char *p0, *p1;
1133 int j, tag, tc, state;
1134 VALUE str;
1135
1136 if (ossl_asn1_default_tag(self) == -1) {
1137 str = ossl_asn1_get_value(self);
1138 return to_der_internal(self, 0, 0, StringValue(str));
1139 }
1140
1141 asn1 = ossl_asn1_get_asn1type(self);
1142 alllen = i2d_ASN1_TYPE(asn1, NULL);
1143 if (alllen < 0) {
1144 ASN1_TYPE_free(asn1);
1145 ossl_raise(eASN1Error, "i2d_ASN1_TYPE");
1146 }
1147 str = ossl_str_new(NULL, alllen, &state);
1148 if (state) {
1149 ASN1_TYPE_free(asn1);
1150 rb_jump_tag(state);
1151 }
1152 p0 = p1 = (unsigned char *)RSTRING_PTR(str);
1153 i2d_ASN1_TYPE(asn1, &p0);
1154 ASN1_TYPE_free(asn1);
1155 assert(p0 - p1 == alllen);
1156
1157 /* Strip header since to_der_internal() wants only the payload */
1158 j = ASN1_get_object((const unsigned char **)&p1, &bodylen, &tag, &tc, alllen);
1159 if (j & 0x80)
1160 ossl_raise(eASN1Error, "ASN1_get_object"); /* should not happen */
1161
1162 return to_der_internal(self, 0, 0, rb_str_drop_bytes(str, alllen - bodylen));
1163}
1164
1165/*
1166 * call-seq:
1167 * asn1.to_der => DER-encoded String
1168 *
1169 * See ASN1Data#to_der for details.
1170 */
1171static VALUE
1172ossl_asn1cons_to_der(VALUE self)
1173{
1174 VALUE ary, str;
1175 long i;
1176 int indef_len;
1177
1178 indef_len = RTEST(ossl_asn1_get_indefinite_length(self));
1179 ary = rb_convert_type(ossl_asn1_get_value(self), T_ARRAY, "Array", "to_a");
1180 str = rb_str_new(NULL, 0);
1181 for (i = 0; i < RARRAY_LEN(ary); i++) {
1182 VALUE item = RARRAY_AREF(ary, i);
1183
1184 if (indef_len && rb_obj_is_kind_of(item, cASN1EndOfContent)) {
1185 if (i != RARRAY_LEN(ary) - 1)
1186 ossl_raise(eASN1Error, "illegal EOC octets in value");
1187
1188 /*
1189 * EOC is not really part of the content, but we required to add one
1190 * at the end in the past.
1191 */
1192 break;
1193 }
1194
1195 item = ossl_to_der_if_possible(item);
1196 StringValue(item);
1197 rb_str_append(str, item);
1198 }
1199
1200 return to_der_internal(self, 1, indef_len, str);
1201}
1202
1203/*
1204 * call-seq:
1205 * asn1_ary.each { |asn1| block } => asn1_ary
1206 *
1207 * Calls the given block once for each element in self, passing that element
1208 * as parameter _asn1_. If no block is given, an enumerator is returned
1209 * instead.
1210 *
1211 * == Example
1212 * asn1_ary.each do |asn1|
1213 * puts asn1
1214 * end
1215 */
1216static VALUE
1217ossl_asn1cons_each(VALUE self)
1218{
1219 rb_block_call(ossl_asn1_get_value(self), id_each, 0, 0, 0, 0);
1220
1221 return self;
1222}
1223
1224/*
1225 * call-seq:
1226 * OpenSSL::ASN1::ObjectId.register(object_id, short_name, long_name)
1227 *
1228 * This adds a new ObjectId to the internal tables. Where _object_id_ is the
1229 * numerical form, _short_name_ is the short name, and _long_name_ is the long
1230 * name.
1231 *
1232 * Returns +true+ if successful. Raises an OpenSSL::ASN1::ASN1Error if it fails.
1233 *
1234 */
1235static VALUE
1236ossl_asn1obj_s_register(VALUE self, VALUE oid, VALUE sn, VALUE ln)
1237{
1238 StringValueCStr(oid);
1239 StringValueCStr(sn);
1240 StringValueCStr(ln);
1241
1242 if(!OBJ_create(RSTRING_PTR(oid), RSTRING_PTR(sn), RSTRING_PTR(ln)))
1243 ossl_raise(eASN1Error, NULL);
1244
1245 return Qtrue;
1246}
1247
1248/*
1249 * call-seq:
1250 * oid.sn -> string
1251 * oid.short_name -> string
1252 *
1253 * The short name of the ObjectId, as defined in <openssl/objects.h>.
1254 */
1255static VALUE
1256ossl_asn1obj_get_sn(VALUE self)
1257{
1258 VALUE val, ret = Qnil;
1259 int nid;
1260
1261 val = ossl_asn1_get_value(self);
1262 if ((nid = OBJ_txt2nid(StringValueCStr(val))) != NID_undef)
1263 ret = rb_str_new2(OBJ_nid2sn(nid));
1264
1265 return ret;
1266}
1267
1268/*
1269 * call-seq:
1270 * oid.ln -> string
1271 * oid.long_name -> string
1272 *
1273 * The long name of the ObjectId, as defined in <openssl/objects.h>.
1274 */
1275static VALUE
1276ossl_asn1obj_get_ln(VALUE self)
1277{
1278 VALUE val, ret = Qnil;
1279 int nid;
1280
1281 val = ossl_asn1_get_value(self);
1282 if ((nid = OBJ_txt2nid(StringValueCStr(val))) != NID_undef)
1283 ret = rb_str_new2(OBJ_nid2ln(nid));
1284
1285 return ret;
1286}
1287
1288/*
1289 * call-seq:
1290 * oid == other_oid => true or false
1291 *
1292 * Returns +true+ if _other_oid_ is the same as _oid_
1293 */
1294static VALUE
1295ossl_asn1obj_eq(VALUE self, VALUE other)
1296{
1297 VALUE valSelf, valOther;
1298 int nidSelf, nidOther;
1299
1300 valSelf = ossl_asn1_get_value(self);
1301 valOther = ossl_asn1_get_value(other);
1302
1303 if ((nidSelf = OBJ_txt2nid(StringValueCStr(valSelf))) == NID_undef)
1304 ossl_raise(eASN1Error, "OBJ_txt2nid");
1305
1306 if ((nidOther = OBJ_txt2nid(StringValueCStr(valOther))) == NID_undef)
1307 ossl_raise(eASN1Error, "OBJ_txt2nid");
1308
1309 return nidSelf == nidOther ? Qtrue : Qfalse;
1310}
1311
1312static VALUE
1313asn1obj_get_oid_i(VALUE vobj)
1314{
1315 ASN1_OBJECT *a1obj = (void *)vobj;
1316 VALUE str;
1317 int len;
1318
1319 str = rb_usascii_str_new(NULL, 127);
1320 len = OBJ_obj2txt(RSTRING_PTR(str), RSTRING_LENINT(str), a1obj, 1);
1321 if (len <= 0 || len == INT_MAX)
1322 ossl_raise(eASN1Error, "OBJ_obj2txt");
1323 if (len > RSTRING_LEN(str)) {
1324 /* +1 is for the \0 terminator added by OBJ_obj2txt() */
1325 rb_str_resize(str, len + 1);
1326 len = OBJ_obj2txt(RSTRING_PTR(str), len + 1, a1obj, 1);
1327 if (len <= 0)
1328 ossl_raise(eASN1Error, "OBJ_obj2txt");
1329 }
1330 rb_str_set_len(str, len);
1331 return str;
1332}
1333
1334/*
1335 * call-seq:
1336 * oid.oid -> string
1337 *
1338 * Returns a String representing the Object Identifier in the dot notation,
1339 * e.g. "1.2.3.4.5"
1340 */
1341static VALUE
1342ossl_asn1obj_get_oid(VALUE self)
1343{
1344 VALUE str;
1345 ASN1_OBJECT *a1obj;
1346 int state;
1347
1348 a1obj = obj_to_asn1obj(ossl_asn1_get_value(self));
1349 str = rb_protect(asn1obj_get_oid_i, (VALUE)a1obj, &state);
1350 ASN1_OBJECT_free(a1obj);
1351 if (state)
1352 rb_jump_tag(state);
1353 return str;
1354}
1355
1356#define OSSL_ASN1_IMPL_FACTORY_METHOD(klass) \
1357static VALUE ossl_asn1_##klass(int argc, VALUE *argv, VALUE self)\
1358{ return rb_funcall3(cASN1##klass, rb_intern("new"), argc, argv); }
1359
1360 OSSL_ASN1_IMPL_FACTORY_METHOD(Boolean)
1361 OSSL_ASN1_IMPL_FACTORY_METHOD(Integer)
1362 OSSL_ASN1_IMPL_FACTORY_METHOD(Enumerated)
1363 OSSL_ASN1_IMPL_FACTORY_METHOD(BitString)
1364 OSSL_ASN1_IMPL_FACTORY_METHOD(OctetString)
1365 OSSL_ASN1_IMPL_FACTORY_METHOD(UTF8String)
1366 OSSL_ASN1_IMPL_FACTORY_METHOD(NumericString)
1367 OSSL_ASN1_IMPL_FACTORY_METHOD(PrintableString)
1368 OSSL_ASN1_IMPL_FACTORY_METHOD(T61String)
1369 OSSL_ASN1_IMPL_FACTORY_METHOD(VideotexString)
1370 OSSL_ASN1_IMPL_FACTORY_METHOD(IA5String)
1371 OSSL_ASN1_IMPL_FACTORY_METHOD(GraphicString)
1372 OSSL_ASN1_IMPL_FACTORY_METHOD(ISO64String)
1373 OSSL_ASN1_IMPL_FACTORY_METHOD(GeneralString)
1374 OSSL_ASN1_IMPL_FACTORY_METHOD(UniversalString)
1375 OSSL_ASN1_IMPL_FACTORY_METHOD(BMPString)
1376 OSSL_ASN1_IMPL_FACTORY_METHOD(Null)
1377 OSSL_ASN1_IMPL_FACTORY_METHOD(ObjectId)
1378 OSSL_ASN1_IMPL_FACTORY_METHOD(UTCTime)
1379 OSSL_ASN1_IMPL_FACTORY_METHOD(GeneralizedTime)
1380 OSSL_ASN1_IMPL_FACTORY_METHOD(Sequence)
1381 OSSL_ASN1_IMPL_FACTORY_METHOD(Set)
1382 OSSL_ASN1_IMPL_FACTORY_METHOD(EndOfContent)
1383
1384void
1385Init_ossl_asn1(void)
1386{
1387#undef rb_intern
1388 VALUE ary;
1389 int i;
1390
1391#if 0
1392 mOSSL = rb_define_module("OpenSSL");
1393 eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
1394#endif
1395
1396 sym_UNIVERSAL = ID2SYM(rb_intern_const("UNIVERSAL"));
1397 sym_CONTEXT_SPECIFIC = ID2SYM(rb_intern_const("CONTEXT_SPECIFIC"));
1398 sym_APPLICATION = ID2SYM(rb_intern_const("APPLICATION"));
1399 sym_PRIVATE = ID2SYM(rb_intern_const("PRIVATE"));
1400 sym_EXPLICIT = ID2SYM(rb_intern_const("EXPLICIT"));
1401 sym_IMPLICIT = ID2SYM(rb_intern_const("IMPLICIT"));
1402
1403 sivVALUE = rb_intern("@value");
1404 sivTAG = rb_intern("@tag");
1405 sivTAGGING = rb_intern("@tagging");
1406 sivTAG_CLASS = rb_intern("@tag_class");
1407 sivINDEFINITE_LENGTH = rb_intern("@indefinite_length");
1408 sivUNUSED_BITS = rb_intern("@unused_bits");
1409
1410 /*
1411 * Document-module: OpenSSL::ASN1
1412 *
1413 * Abstract Syntax Notation One (or ASN.1) is a notation syntax to
1414 * describe data structures and is defined in ITU-T X.680. ASN.1 itself
1415 * does not mandate any encoding or parsing rules, but usually ASN.1 data
1416 * structures are encoded using the Distinguished Encoding Rules (DER) or
1417 * less often the Basic Encoding Rules (BER) described in ITU-T X.690. DER
1418 * and BER encodings are binary Tag-Length-Value (TLV) encodings that are
1419 * quite concise compared to other popular data description formats such
1420 * as XML, JSON etc.
1421 * ASN.1 data structures are very common in cryptographic applications,
1422 * e.g. X.509 public key certificates or certificate revocation lists
1423 * (CRLs) are all defined in ASN.1 and DER-encoded. ASN.1, DER and BER are
1424 * the building blocks of applied cryptography.
1425 * The ASN1 module provides the necessary classes that allow generation
1426 * of ASN.1 data structures and the methods to encode them using a DER
1427 * encoding. The decode method allows parsing arbitrary BER-/DER-encoded
1428 * data to a Ruby object that can then be modified and re-encoded at will.
1429 *
1430 * == ASN.1 class hierarchy
1431 *
1432 * The base class representing ASN.1 structures is ASN1Data. ASN1Data offers
1433 * attributes to read and set the _tag_, the _tag_class_ and finally the
1434 * _value_ of a particular ASN.1 item. Upon parsing, any tagged values
1435 * (implicit or explicit) will be represented by ASN1Data instances because
1436 * their "real type" can only be determined using out-of-band information
1437 * from the ASN.1 type declaration. Since this information is normally
1438 * known when encoding a type, all sub-classes of ASN1Data offer an
1439 * additional attribute _tagging_ that allows to encode a value implicitly
1440 * (+:IMPLICIT+) or explicitly (+:EXPLICIT+).
1441 *
1442 * === Constructive
1443 *
1444 * Constructive is, as its name implies, the base class for all
1445 * constructed encodings, i.e. those that consist of several values,
1446 * opposed to "primitive" encodings with just one single value. The value of
1447 * an Constructive is always an Array.
1448 *
1449 * ==== ASN1::Set and ASN1::Sequence
1450 *
1451 * The most common constructive encodings are SETs and SEQUENCEs, which is
1452 * why there are two sub-classes of Constructive representing each of
1453 * them.
1454 *
1455 * === Primitive
1456 *
1457 * This is the super class of all primitive values. Primitive
1458 * itself is not used when parsing ASN.1 data, all values are either
1459 * instances of a corresponding sub-class of Primitive or they are
1460 * instances of ASN1Data if the value was tagged implicitly or explicitly.
1461 * Please cf. Primitive documentation for details on sub-classes and
1462 * their respective mappings of ASN.1 data types to Ruby objects.
1463 *
1464 * == Possible values for _tagging_
1465 *
1466 * When constructing an ASN1Data object the ASN.1 type definition may
1467 * require certain elements to be either implicitly or explicitly tagged.
1468 * This can be achieved by setting the _tagging_ attribute manually for
1469 * sub-classes of ASN1Data. Use the symbol +:IMPLICIT+ for implicit
1470 * tagging and +:EXPLICIT+ if the element requires explicit tagging.
1471 *
1472 * == Possible values for _tag_class_
1473 *
1474 * It is possible to create arbitrary ASN1Data objects that also support
1475 * a PRIVATE or APPLICATION tag class. Possible values for the _tag_class_
1476 * attribute are:
1477 * * +:UNIVERSAL+ (the default for untagged values)
1478 * * +:CONTEXT_SPECIFIC+ (the default for tagged values)
1479 * * +:APPLICATION+
1480 * * +:PRIVATE+
1481 *
1482 * == Tag constants
1483 *
1484 * There is a constant defined for each universal tag:
1485 * * OpenSSL::ASN1::EOC (0)
1486 * * OpenSSL::ASN1::BOOLEAN (1)
1487 * * OpenSSL::ASN1::INTEGER (2)
1488 * * OpenSSL::ASN1::BIT_STRING (3)
1489 * * OpenSSL::ASN1::OCTET_STRING (4)
1490 * * OpenSSL::ASN1::NULL (5)
1491 * * OpenSSL::ASN1::OBJECT (6)
1492 * * OpenSSL::ASN1::ENUMERATED (10)
1493 * * OpenSSL::ASN1::UTF8STRING (12)
1494 * * OpenSSL::ASN1::SEQUENCE (16)
1495 * * OpenSSL::ASN1::SET (17)
1496 * * OpenSSL::ASN1::NUMERICSTRING (18)
1497 * * OpenSSL::ASN1::PRINTABLESTRING (19)
1498 * * OpenSSL::ASN1::T61STRING (20)
1499 * * OpenSSL::ASN1::VIDEOTEXSTRING (21)
1500 * * OpenSSL::ASN1::IA5STRING (22)
1501 * * OpenSSL::ASN1::UTCTIME (23)
1502 * * OpenSSL::ASN1::GENERALIZEDTIME (24)
1503 * * OpenSSL::ASN1::GRAPHICSTRING (25)
1504 * * OpenSSL::ASN1::ISO64STRING (26)
1505 * * OpenSSL::ASN1::GENERALSTRING (27)
1506 * * OpenSSL::ASN1::UNIVERSALSTRING (28)
1507 * * OpenSSL::ASN1::BMPSTRING (30)
1508 *
1509 * == UNIVERSAL_TAG_NAME constant
1510 *
1511 * An Array that stores the name of a given tag number. These names are
1512 * the same as the name of the tag constant that is additionally defined,
1513 * e.g. UNIVERSAL_TAG_NAME[2] = "INTEGER" and OpenSSL::ASN1::INTEGER = 2.
1514 *
1515 * == Example usage
1516 *
1517 * === Decoding and viewing a DER-encoded file
1518 * require 'openssl'
1519 * require 'pp'
1520 * der = File.binread('data.der')
1521 * asn1 = OpenSSL::ASN1.decode(der)
1522 * pp der
1523 *
1524 * === Creating an ASN.1 structure and DER-encoding it
1525 * require 'openssl'
1526 * version = OpenSSL::ASN1::Integer.new(1)
1527 * # Explicitly 0-tagged implies context-specific tag class
1528 * serial = OpenSSL::ASN1::Integer.new(12345, 0, :EXPLICIT, :CONTEXT_SPECIFIC)
1529 * name = OpenSSL::ASN1::PrintableString.new('Data 1')
1530 * sequence = OpenSSL::ASN1::Sequence.new( [ version, serial, name ] )
1531 * der = sequence.to_der
1532 */
1533 mASN1 = rb_define_module_under(mOSSL, "ASN1");
1534
1535 /* Document-class: OpenSSL::ASN1::ASN1Error
1536 *
1537 * Generic error class for all errors raised in ASN1 and any of the
1538 * classes defined in it.
1539 */
1540 eASN1Error = rb_define_class_under(mASN1, "ASN1Error", eOSSLError);
1541 rb_define_module_function(mASN1, "traverse", ossl_asn1_traverse, 1);
1542 rb_define_module_function(mASN1, "decode", ossl_asn1_decode, 1);
1543 rb_define_module_function(mASN1, "decode_all", ossl_asn1_decode_all, 1);
1544 ary = rb_ary_new();
1545
1546 /*
1547 * Array storing tag names at the tag's index.
1548 */
1549 rb_define_const(mASN1, "UNIVERSAL_TAG_NAME", ary);
1550 for(i = 0; i < ossl_asn1_info_size; i++){
1551 if(ossl_asn1_info[i].name[0] == '[') continue;
1552 rb_define_const(mASN1, ossl_asn1_info[i].name, INT2NUM(i));
1553 rb_ary_store(ary, i, rb_str_new2(ossl_asn1_info[i].name));
1554 }
1555
1556 /* Document-class: OpenSSL::ASN1::ASN1Data
1557 *
1558 * The top-level class representing any ASN.1 object. When parsed by
1559 * ASN1.decode, tagged values are always represented by an instance
1560 * of ASN1Data.
1561 *
1562 * == The role of ASN1Data for parsing tagged values
1563 *
1564 * When encoding an ASN.1 type it is inherently clear what original
1565 * type (e.g. INTEGER, OCTET STRING etc.) this value has, regardless
1566 * of its tagging.
1567 * But opposed to the time an ASN.1 type is to be encoded, when parsing
1568 * them it is not possible to deduce the "real type" of tagged
1569 * values. This is why tagged values are generally parsed into ASN1Data
1570 * instances, but with a different outcome for implicit and explicit
1571 * tagging.
1572 *
1573 * === Example of a parsed implicitly tagged value
1574 *
1575 * An implicitly 1-tagged INTEGER value will be parsed as an
1576 * ASN1Data with
1577 * * _tag_ equal to 1
1578 * * _tag_class_ equal to +:CONTEXT_SPECIFIC+
1579 * * _value_ equal to a String that carries the raw encoding
1580 * of the INTEGER.
1581 * This implies that a subsequent decoding step is required to
1582 * completely decode implicitly tagged values.
1583 *
1584 * === Example of a parsed explicitly tagged value
1585 *
1586 * An explicitly 1-tagged INTEGER value will be parsed as an
1587 * ASN1Data with
1588 * * _tag_ equal to 1
1589 * * _tag_class_ equal to +:CONTEXT_SPECIFIC+
1590 * * _value_ equal to an Array with one single element, an
1591 * instance of OpenSSL::ASN1::Integer, i.e. the inner element
1592 * is the non-tagged primitive value, and the tagging is represented
1593 * in the outer ASN1Data
1594 *
1595 * == Example - Decoding an implicitly tagged INTEGER
1596 * int = OpenSSL::ASN1::Integer.new(1, 0, :IMPLICIT) # implicit 0-tagged
1597 * seq = OpenSSL::ASN1::Sequence.new( [int] )
1598 * der = seq.to_der
1599 * asn1 = OpenSSL::ASN1.decode(der)
1600 * # pp asn1 => #<OpenSSL::ASN1::Sequence:0x87326e0
1601 * # @indefinite_length=false,
1602 * # @tag=16,
1603 * # @tag_class=:UNIVERSAL,
1604 * # @tagging=nil,
1605 * # @value=
1606 * # [#<OpenSSL::ASN1::ASN1Data:0x87326f4
1607 * # @indefinite_length=false,
1608 * # @tag=0,
1609 * # @tag_class=:CONTEXT_SPECIFIC,
1610 * # @value="\x01">]>
1611 * raw_int = asn1.value[0]
1612 * # manually rewrite tag and tag class to make it an UNIVERSAL value
1613 * raw_int.tag = OpenSSL::ASN1::INTEGER
1614 * raw_int.tag_class = :UNIVERSAL
1615 * int2 = OpenSSL::ASN1.decode(raw_int)
1616 * puts int2.value # => 1
1617 *
1618 * == Example - Decoding an explicitly tagged INTEGER
1619 * int = OpenSSL::ASN1::Integer.new(1, 0, :EXPLICIT) # explicit 0-tagged
1620 * seq = OpenSSL::ASN1::Sequence.new( [int] )
1621 * der = seq.to_der
1622 * asn1 = OpenSSL::ASN1.decode(der)
1623 * # pp asn1 => #<OpenSSL::ASN1::Sequence:0x87326e0
1624 * # @indefinite_length=false,
1625 * # @tag=16,
1626 * # @tag_class=:UNIVERSAL,
1627 * # @tagging=nil,
1628 * # @value=
1629 * # [#<OpenSSL::ASN1::ASN1Data:0x87326f4
1630 * # @indefinite_length=false,
1631 * # @tag=0,
1632 * # @tag_class=:CONTEXT_SPECIFIC,
1633 * # @value=
1634 * # [#<OpenSSL::ASN1::Integer:0x85bf308
1635 * # @indefinite_length=false,
1636 * # @tag=2,
1637 * # @tag_class=:UNIVERSAL
1638 * # @tagging=nil,
1639 * # @value=1>]>]>
1640 * int2 = asn1.value[0].value[0]
1641 * puts int2.value # => 1
1642 */
1643 cASN1Data = rb_define_class_under(mASN1, "ASN1Data", rb_cObject);
1644 /*
1645 * Carries the value of a ASN.1 type.
1646 * Please confer Constructive and Primitive for the mappings between
1647 * ASN.1 data types and Ruby classes.
1648 */
1649 rb_attr(cASN1Data, rb_intern("value"), 1, 1, 0);
1650 /*
1651 * An Integer representing the tag number of this ASN1Data. Never +nil+.
1652 */
1653 rb_attr(cASN1Data, rb_intern("tag"), 1, 1, 0);
1654 /*
1655 * A Symbol representing the tag class of this ASN1Data. Never +nil+.
1656 * See ASN1Data for possible values.
1657 */
1658 rb_attr(cASN1Data, rb_intern("tag_class"), 1, 1, 0);
1659 /*
1660 * Never +nil+. A boolean value indicating whether the encoding uses
1661 * indefinite length (in the case of parsing) or whether an indefinite
1662 * length form shall be used (in the encoding case).
1663 * In DER, every value uses definite length form. But in scenarios where
1664 * large amounts of data need to be transferred it might be desirable to
1665 * have some kind of streaming support available.
1666 * For example, huge OCTET STRINGs are preferably sent in smaller-sized
1667 * chunks, each at a time.
1668 * This is possible in BER by setting the length bytes of an encoding
1669 * to zero and by this indicating that the following value will be
1670 * sent in chunks. Indefinite length encodings are always constructed.
1671 * The end of such a stream of chunks is indicated by sending a EOC
1672 * (End of Content) tag. SETs and SEQUENCEs may use an indefinite length
1673 * encoding, but also primitive types such as e.g. OCTET STRINGS or
1674 * BIT STRINGS may leverage this functionality (cf. ITU-T X.690).
1675 */
1676 rb_attr(cASN1Data, rb_intern("indefinite_length"), 1, 1, 0);
1677 rb_define_alias(cASN1Data, "infinite_length", "indefinite_length");
1678 rb_define_alias(cASN1Data, "infinite_length=", "indefinite_length=");
1679 rb_define_method(cASN1Data, "initialize", ossl_asn1data_initialize, 3);
1680 rb_define_method(cASN1Data, "to_der", ossl_asn1data_to_der, 0);
1681
1682 /* Document-class: OpenSSL::ASN1::Primitive
1683 *
1684 * The parent class for all primitive encodings. Attributes are the same as
1685 * for ASN1Data, with the addition of _tagging_.
1686 * Primitive values can never be encoded with indefinite length form, thus
1687 * it is not possible to set the _indefinite_length_ attribute for Primitive
1688 * and its sub-classes.
1689 *
1690 * == Primitive sub-classes and their mapping to Ruby classes
1691 * * OpenSSL::ASN1::EndOfContent <=> _value_ is always +nil+
1692 * * OpenSSL::ASN1::Boolean <=> _value_ is +true+ or +false+
1693 * * OpenSSL::ASN1::Integer <=> _value_ is an OpenSSL::BN
1694 * * OpenSSL::ASN1::BitString <=> _value_ is a String
1695 * * OpenSSL::ASN1::OctetString <=> _value_ is a String
1696 * * OpenSSL::ASN1::Null <=> _value_ is always +nil+
1697 * * OpenSSL::ASN1::Object <=> _value_ is a String
1698 * * OpenSSL::ASN1::Enumerated <=> _value_ is an OpenSSL::BN
1699 * * OpenSSL::ASN1::UTF8String <=> _value_ is a String
1700 * * OpenSSL::ASN1::NumericString <=> _value_ is a String
1701 * * OpenSSL::ASN1::PrintableString <=> _value_ is a String
1702 * * OpenSSL::ASN1::T61String <=> _value_ is a String
1703 * * OpenSSL::ASN1::VideotexString <=> _value_ is a String
1704 * * OpenSSL::ASN1::IA5String <=> _value_ is a String
1705 * * OpenSSL::ASN1::UTCTime <=> _value_ is a Time
1706 * * OpenSSL::ASN1::GeneralizedTime <=> _value_ is a Time
1707 * * OpenSSL::ASN1::GraphicString <=> _value_ is a String
1708 * * OpenSSL::ASN1::ISO64String <=> _value_ is a String
1709 * * OpenSSL::ASN1::GeneralString <=> _value_ is a String
1710 * * OpenSSL::ASN1::UniversalString <=> _value_ is a String
1711 * * OpenSSL::ASN1::BMPString <=> _value_ is a String
1712 *
1713 * == OpenSSL::ASN1::BitString
1714 *
1715 * === Additional attributes
1716 * _unused_bits_: if the underlying BIT STRING's
1717 * length is a multiple of 8 then _unused_bits_ is 0. Otherwise
1718 * _unused_bits_ indicates the number of bits that are to be ignored in
1719 * the final octet of the BitString's _value_.
1720 *
1721 * == OpenSSL::ASN1::ObjectId
1722 *
1723 * NOTE: While OpenSSL::ASN1::ObjectId.new will allocate a new ObjectId,
1724 * it is not typically allocated this way, but rather that are received from
1725 * parsed ASN1 encodings.
1726 *
1727 * === Additional attributes
1728 * * _sn_: the short name as defined in <openssl/objects.h>.
1729 * * _ln_: the long name as defined in <openssl/objects.h>.
1730 * * _oid_: the object identifier as a String, e.g. "1.2.3.4.5"
1731 * * _short_name_: alias for _sn_.
1732 * * _long_name_: alias for _ln_.
1733 *
1734 * == Examples
1735 * With the Exception of OpenSSL::ASN1::EndOfContent, each Primitive class
1736 * constructor takes at least one parameter, the _value_.
1737 *
1738 * === Creating EndOfContent
1739 * eoc = OpenSSL::ASN1::EndOfContent.new
1740 *
1741 * === Creating any other Primitive
1742 * prim = <class>.new(value) # <class> being one of the sub-classes except EndOfContent
1743 * prim_zero_tagged_implicit = <class>.new(value, 0, :IMPLICIT)
1744 * prim_zero_tagged_explicit = <class>.new(value, 0, :EXPLICIT)
1745 */
1746 cASN1Primitive = rb_define_class_under(mASN1, "Primitive", cASN1Data);
1747 /*
1748 * May be used as a hint for encoding a value either implicitly or
1749 * explicitly by setting it either to +:IMPLICIT+ or to +:EXPLICIT+.
1750 * _tagging_ is not set when a ASN.1 structure is parsed using
1751 * OpenSSL::ASN1.decode.
1752 */
1753 rb_attr(cASN1Primitive, rb_intern("tagging"), 1, 1, Qtrue);
1754 rb_undef_method(cASN1Primitive, "indefinite_length=");
1755 rb_undef_method(cASN1Primitive, "infinite_length=");
1756 rb_define_method(cASN1Primitive, "initialize", ossl_asn1_initialize, -1);
1757 rb_define_method(cASN1Primitive, "to_der", ossl_asn1prim_to_der, 0);
1758
1759 /* Document-class: OpenSSL::ASN1::Constructive
1760 *
1761 * The parent class for all constructed encodings. The _value_ attribute
1762 * of a Constructive is always an Array. Attributes are the same as
1763 * for ASN1Data, with the addition of _tagging_.
1764 *
1765 * == SET and SEQUENCE
1766 *
1767 * Most constructed encodings come in the form of a SET or a SEQUENCE.
1768 * These encodings are represented by one of the two sub-classes of
1769 * Constructive:
1770 * * OpenSSL::ASN1::Set
1771 * * OpenSSL::ASN1::Sequence
1772 * Please note that tagged sequences and sets are still parsed as
1773 * instances of ASN1Data. Find further details on tagged values
1774 * there.
1775 *
1776 * === Example - constructing a SEQUENCE
1777 * int = OpenSSL::ASN1::Integer.new(1)
1778 * str = OpenSSL::ASN1::PrintableString.new('abc')
1779 * sequence = OpenSSL::ASN1::Sequence.new( [ int, str ] )
1780 *
1781 * === Example - constructing a SET
1782 * int = OpenSSL::ASN1::Integer.new(1)
1783 * str = OpenSSL::ASN1::PrintableString.new('abc')
1784 * set = OpenSSL::ASN1::Set.new( [ int, str ] )
1785 */
1786 cASN1Constructive = rb_define_class_under(mASN1,"Constructive", cASN1Data);
1787 rb_include_module(cASN1Constructive, rb_mEnumerable);
1788 /*
1789 * May be used as a hint for encoding a value either implicitly or
1790 * explicitly by setting it either to +:IMPLICIT+ or to +:EXPLICIT+.
1791 * _tagging_ is not set when a ASN.1 structure is parsed using
1792 * OpenSSL::ASN1.decode.
1793 */
1794 rb_attr(cASN1Constructive, rb_intern("tagging"), 1, 1, Qtrue);
1795 rb_define_method(cASN1Constructive, "initialize", ossl_asn1_initialize, -1);
1796 rb_define_method(cASN1Constructive, "to_der", ossl_asn1cons_to_der, 0);
1797 rb_define_method(cASN1Constructive, "each", ossl_asn1cons_each, 0);
1798
1799#define OSSL_ASN1_DEFINE_CLASS(name, super) \
1800do{\
1801 cASN1##name = rb_define_class_under(mASN1, #name, cASN1##super);\
1802 rb_define_module_function(mASN1, #name, ossl_asn1_##name, -1);\
1803}while(0)
1804
1805 OSSL_ASN1_DEFINE_CLASS(Boolean, Primitive);
1806 OSSL_ASN1_DEFINE_CLASS(Integer, Primitive);
1807 OSSL_ASN1_DEFINE_CLASS(Enumerated, Primitive);
1808 OSSL_ASN1_DEFINE_CLASS(BitString, Primitive);
1809 OSSL_ASN1_DEFINE_CLASS(OctetString, Primitive);
1810 OSSL_ASN1_DEFINE_CLASS(UTF8String, Primitive);
1811 OSSL_ASN1_DEFINE_CLASS(NumericString, Primitive);
1812 OSSL_ASN1_DEFINE_CLASS(PrintableString, Primitive);
1813 OSSL_ASN1_DEFINE_CLASS(T61String, Primitive);
1814 OSSL_ASN1_DEFINE_CLASS(VideotexString, Primitive);
1815 OSSL_ASN1_DEFINE_CLASS(IA5String, Primitive);
1816 OSSL_ASN1_DEFINE_CLASS(GraphicString, Primitive);
1817 OSSL_ASN1_DEFINE_CLASS(ISO64String, Primitive);
1818 OSSL_ASN1_DEFINE_CLASS(GeneralString, Primitive);
1819 OSSL_ASN1_DEFINE_CLASS(UniversalString, Primitive);
1820 OSSL_ASN1_DEFINE_CLASS(BMPString, Primitive);
1821 OSSL_ASN1_DEFINE_CLASS(Null, Primitive);
1822 OSSL_ASN1_DEFINE_CLASS(ObjectId, Primitive);
1823 OSSL_ASN1_DEFINE_CLASS(UTCTime, Primitive);
1824 OSSL_ASN1_DEFINE_CLASS(GeneralizedTime, Primitive);
1825
1826 OSSL_ASN1_DEFINE_CLASS(Sequence, Constructive);
1827 OSSL_ASN1_DEFINE_CLASS(Set, Constructive);
1828
1829 OSSL_ASN1_DEFINE_CLASS(EndOfContent, Data);
1830
1831
1832 /* Document-class: OpenSSL::ASN1::ObjectId
1833 *
1834 * Represents the primitive object id for OpenSSL::ASN1
1835 */
1836#if 0
1837 cASN1ObjectId = rb_define_class_under(mASN1, "ObjectId", cASN1Primitive); /* let rdoc know */
1838#endif
1839 rb_define_singleton_method(cASN1ObjectId, "register", ossl_asn1obj_s_register, 3);
1840 rb_define_method(cASN1ObjectId, "sn", ossl_asn1obj_get_sn, 0);
1841 rb_define_method(cASN1ObjectId, "ln", ossl_asn1obj_get_ln, 0);
1842 rb_define_method(cASN1ObjectId, "oid", ossl_asn1obj_get_oid, 0);
1843 rb_define_alias(cASN1ObjectId, "short_name", "sn");
1844 rb_define_alias(cASN1ObjectId, "long_name", "ln");
1845 rb_define_method(cASN1ObjectId, "==", ossl_asn1obj_eq, 1);
1846 rb_attr(cASN1BitString, rb_intern("unused_bits"), 1, 1, 0);
1847
1848 rb_define_method(cASN1EndOfContent, "initialize", ossl_asn1eoc_initialize, 0);
1849 rb_define_method(cASN1EndOfContent, "to_der", ossl_asn1eoc_to_der, 0);
1850
1851 class_tag_map = rb_hash_new();
1852 rb_gc_register_mark_object(class_tag_map);
1853 rb_hash_aset(class_tag_map, cASN1EndOfContent, INT2NUM(V_ASN1_EOC));
1854 rb_hash_aset(class_tag_map, cASN1Boolean, INT2NUM(V_ASN1_BOOLEAN));
1855 rb_hash_aset(class_tag_map, cASN1Integer, INT2NUM(V_ASN1_INTEGER));
1856 rb_hash_aset(class_tag_map, cASN1BitString, INT2NUM(V_ASN1_BIT_STRING));
1857 rb_hash_aset(class_tag_map, cASN1OctetString, INT2NUM(V_ASN1_OCTET_STRING));
1858 rb_hash_aset(class_tag_map, cASN1Null, INT2NUM(V_ASN1_NULL));
1859 rb_hash_aset(class_tag_map, cASN1ObjectId, INT2NUM(V_ASN1_OBJECT));
1860 rb_hash_aset(class_tag_map, cASN1Enumerated, INT2NUM(V_ASN1_ENUMERATED));
1861 rb_hash_aset(class_tag_map, cASN1UTF8String, INT2NUM(V_ASN1_UTF8STRING));
1862 rb_hash_aset(class_tag_map, cASN1Sequence, INT2NUM(V_ASN1_SEQUENCE));
1863 rb_hash_aset(class_tag_map, cASN1Set, INT2NUM(V_ASN1_SET));
1864 rb_hash_aset(class_tag_map, cASN1NumericString, INT2NUM(V_ASN1_NUMERICSTRING));
1865 rb_hash_aset(class_tag_map, cASN1PrintableString, INT2NUM(V_ASN1_PRINTABLESTRING));
1866 rb_hash_aset(class_tag_map, cASN1T61String, INT2NUM(V_ASN1_T61STRING));
1867 rb_hash_aset(class_tag_map, cASN1VideotexString, INT2NUM(V_ASN1_VIDEOTEXSTRING));
1868 rb_hash_aset(class_tag_map, cASN1IA5String, INT2NUM(V_ASN1_IA5STRING));
1869 rb_hash_aset(class_tag_map, cASN1UTCTime, INT2NUM(V_ASN1_UTCTIME));
1870 rb_hash_aset(class_tag_map, cASN1GeneralizedTime, INT2NUM(V_ASN1_GENERALIZEDTIME));
1871 rb_hash_aset(class_tag_map, cASN1GraphicString, INT2NUM(V_ASN1_GRAPHICSTRING));
1872 rb_hash_aset(class_tag_map, cASN1ISO64String, INT2NUM(V_ASN1_ISO64STRING));
1873 rb_hash_aset(class_tag_map, cASN1GeneralString, INT2NUM(V_ASN1_GENERALSTRING));
1874 rb_hash_aset(class_tag_map, cASN1UniversalString, INT2NUM(V_ASN1_UNIVERSALSTRING));
1875 rb_hash_aset(class_tag_map, cASN1BMPString, INT2NUM(V_ASN1_BMPSTRING));
1876
1877 id_each = rb_intern_const("each");
1878}
rb_ary_store
void rb_ary_store(VALUE ary, long idx, VALUE val)
Definition: array.c:1141
rb_cArray
VALUE rb_cArray
Definition: array.c:40
rb_ary_push
VALUE rb_ary_push(VALUE ary, VALUE item)
Definition: array.c:1301
rb_ary_new
VALUE rb_ary_new(void)
Definition: array.c:749
rb_define_method
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
Definition: cxxanyargs.hpp:653
rb_define_singleton_method
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
Definition: cxxanyargs.hpp:668
rb_define_module_function
#define rb_define_module_function(klass, mid, func, arity)
Defines klass#mid and makes it a module function.
Definition: cxxanyargs.hpp:672
ptr
struct RIMemo * ptr
Definition: debug.c:88
assert
#define assert(x)
Definition: dlmalloc.c:1176
num
big_t * num
Definition: enough.c:232
rb_mEnumerable
VALUE rb_mEnumerable
Definition: enum.c:27
id_each
#define id_each
Definition: enum.c:32
len
uint8_t len
Definition: escape.c:17
str
char str[HTML_ESCAPE_MAX_LEN+1]
Definition: escape.c:18
RSTRING_LEN
#define RSTRING_LEN(string)
Definition: fbuffer.h:22
RSTRING_PTR
#define RSTRING_PTR(string)
Definition: fbuffer.h:19
memcpy
#define memcpy(d, s, n)
Definition: ffi_common.h:55
PRIsVALUE
#define PRIsVALUE
Definition: function.c:10
rb_gc_register_mark_object
void rb_gc_register_mark_object(VALUE obj)
Inform the garbage collector that object is a live Ruby object that should not be moved.
Definition: gc.c:8022
rb_cTime
VALUE rb_cTime
Definition: time.c:645
CLASS_OF
#define CLASS_OF
Definition: globals.h:153
rb_include_module
void rb_include_module(VALUE klass, VALUE module)
Definition: class.c:962
rb_define_class_under
VALUE rb_define_class_under(VALUE outer, const char *name, VALUE super)
Defines a class under the namespace of outer.
Definition: class.c:797
rb_define_module
VALUE rb_define_module(const char *name)
Definition: class.c:871
rb_define_module_under
VALUE rb_define_module_under(VALUE outer, const char *name)
Definition: class.c:895
rb_undef_method
void rb_undef_method(VALUE klass, const char *name)
Definition: class.c:1777
rb_define_alias
void rb_define_alias(VALUE klass, const char *name1, const char *name2)
Defines an alias of a method.
Definition: class.c:1999
rb_scan_args
int rb_scan_args(int argc, const VALUE *argv, const char *fmt,...)
Definition: class.c:2296
rb_eStandardError
VALUE rb_eStandardError
Definition: error.c:1054
rb_eTypeError
VALUE rb_eTypeError
Definition: error.c:1057
rb_protect
VALUE rb_protect(VALUE(*proc)(VALUE), VALUE data, int *pstate)
Protects a function call from potential global escapes from the function.
Definition: eval.c:1105
rb_jump_tag
void rb_jump_tag(int tag)
Continues the exception caught by rb_protect() and rb_eval_string_protect().
Definition: eval.c:921
rb_warning
void rb_warning(const char *fmt,...)
Definition: error.c:439
rb_class_superclass
VALUE rb_class_superclass(VALUE)
Returns the superclass of klass.
Definition: object.c:1974
rb_convert_type
VALUE rb_convert_type(VALUE, int, const char *, const char *)
Converts an object into another type.
Definition: object.c:2930
rb_cObject
VALUE rb_cObject
Object class.
Definition: object.c:49
rb_obj_alloc
VALUE rb_obj_alloc(VALUE)
Allocates an instance of klass.
Definition: object.c:1900
rb_Integer
VALUE rb_Integer(VALUE)
Equivalent to Kernel#Integer in Ruby.
Definition: object.c:3138
rb_obj_is_kind_of
VALUE rb_obj_is_kind_of(VALUE, VALUE)
Determines if obj is a kind of c.
Definition: object.c:724
rb_hash_aset
VALUE rb_hash_aset(VALUE hash, VALUE key, VALUE val)
Definition: hash.c:2901
rb_hash_lookup
VALUE rb_hash_lookup(VALUE hash, VALUE key)
Definition: hash.c:2072
rb_hash_new
VALUE rb_hash_new(void)
Definition: hash.c:1538
rb_funcall2
#define rb_funcall2
Definition: eval.h:36
rb_funcall
VALUE rb_funcall(VALUE, ID, int,...)
Calls a method.
Definition: vm_eval.c:1077
rb_str_new2
#define rb_str_new2
Definition: string.h:276
rb_str_resize
VALUE rb_str_resize(VALUE, long)
Definition: string.c:2859
rb_str_new
#define rb_str_new(str, len)
Definition: string.h:213
rb_usascii_str_new
#define rb_usascii_str_new(str, len)
Definition: string.h:224
rb_str_set_len
void rb_str_set_len(VALUE, long)
Definition: string.c:2842
rb_str_append
VALUE rb_str_append(VALUE, VALUE)
Definition: string.c:3118
rb_str_drop_bytes
VALUE rb_str_drop_bytes(VALUE, long)
Definition: string.c:4795
rb_str_new4
#define rb_str_new4
Definition: string.h:278
rb_attr_get
VALUE rb_attr_get(VALUE, ID)
Definition: variable.c:1242
rb_ivar_set
VALUE rb_ivar_set(VALUE, ID, VALUE)
Definition: variable.c:1493
rb_attr
void rb_attr(VALUE, ID, int, int, int)
Definition: vm_method.c:1508
ID2SYM
#define ID2SYM
Definition: symbol.h:44
rb_intern
ID rb_intern(const char *)
Definition: symbol.c:785
rb_define_const
void rb_define_const(VALUE, const char *, VALUE)
Definition: variable.c:3150
NUM2INT
#define NUM2INT
Definition: int.h:44
INT2NUM
#define INT2NUM
Definition: int.h:43
offset
voidpf uLong offset
Definition: ioapi.h:144
rb_yield
VALUE rb_yield(VALUE)
Definition: vm_eval.c:1341
INT2FIX
#define INT2FIX
Definition: long.h:48
LONG2NUM
#define LONG2NUM
Definition: long.h:50
rb_long2int
#define rb_long2int
Definition: long.h:62
FIX2LONG
#define FIX2LONG
Definition: long.h:46
RB_GC_GUARD
#define RB_GC_GUARD(v)
Definition: memory.h:91
ruby::backward::cxxanyargs::rb_block_call
VALUE rb_block_call(VALUE q, ID w, int e, const VALUE *r, type *t, VALUE y)
Call a method with a block.
Definition: cxxanyargs.hpp:230
name
const char * name
Definition: nkf.c:208
count
int count
Definition: nkf.c:5055
nid
int nid
Definition: openssl_missing.c:28
mOSSL
VALUE mOSSL
Definition: ossl.c:231
ossl_str_new
VALUE ossl_str_new(const char *ptr, long len, int *pstate)
Definition: ossl.c:101
ossl_to_der
VALUE ossl_to_der(VALUE obj)
Definition: ossl.c:244
ossl_to_der_if_possible
VALUE ossl_to_der_if_possible(VALUE obj)
Definition: ossl.c:255
ossl_raise
void ossl_raise(VALUE exc, const char *fmt,...)
Definition: ossl.c:293
eOSSLError
VALUE eOSSLError
Definition: ossl.c:236
ossl.h
asn1integer_to_num
VALUE asn1integer_to_num(const ASN1_INTEGER *ai)
Definition: ossl_asn1.c:101
cASN1Boolean
VALUE cASN1Boolean
Definition: ossl_asn1.c:163
cASN1ObjectId
VALUE cASN1ObjectId
Definition: ossl_asn1.c:173
cASN1VideotexString
VALUE cASN1VideotexString
Definition: ossl_asn1.c:168
cASN1OctetString
VALUE cASN1OctetString
Definition: ossl_asn1.c:166
OSSL_ASN1_DEFINE_CLASS
#define OSSL_ASN1_DEFINE_CLASS(name, super)
OSSL_ASN1_IMPL_FACTORY_METHOD
#define OSSL_ASN1_IMPL_FACTORY_METHOD(klass)
Definition: ossl_asn1.c:1356
ossl_asn1_set_tag_class
#define ossl_asn1_set_tag_class(o, v)
Definition: ossl_asn1.c:152
cASN1GeneralString
VALUE cASN1GeneralString
Definition: ossl_asn1.c:170
ossl_asn1_set_indefinite_length
#define ossl_asn1_set_indefinite_length(o, v)
Definition: ossl_asn1.c:153
asn1time_to_time
VALUE asn1time_to_time(const ASN1_TIME *time)
Definition: ossl_asn1.c:20
ossl_asn1_set_tagging
#define ossl_asn1_set_tagging(o, v)
Definition: ossl_asn1.c:151
cASN1GeneralizedTime
VALUE cASN1GeneralizedTime
Definition: ossl_asn1.c:174
cASN1Data
VALUE cASN1Data
Definition: ossl_asn1.c:158
cASN1Primitive
VALUE cASN1Primitive
Definition: ossl_asn1.c:159
cASN1IA5String
VALUE cASN1IA5String
Definition: ossl_asn1.c:169
mASN1
VALUE mASN1
Definition: ossl_asn1.c:155
cASN1Sequence
VALUE cASN1Sequence
Definition: ossl_asn1.c:175
cASN1UTCTime
VALUE cASN1UTCTime
Definition: ossl_asn1.c:174
cASN1Enumerated
VALUE cASN1Enumerated
Definition: ossl_asn1.c:164
num_to_asn1integer
ASN1_INTEGER * num_to_asn1integer(VALUE obj, ASN1_INTEGER *ai)
Definition: ossl_asn1.c:124
eASN1Error
VALUE eASN1Error
Definition: ossl_asn1.c:156
cASN1BMPString
VALUE cASN1BMPString
Definition: ossl_asn1.c:171
ossl_asn1_get_asn1type
ASN1_TYPE * ossl_asn1_get_asn1type(VALUE obj)
Definition: ossl_asn1.c:495
cASN1Null
VALUE cASN1Null
Definition: ossl_asn1.c:172
cASN1UniversalString
VALUE cASN1UniversalString
Definition: ossl_asn1.c:171
cASN1Constructive
VALUE cASN1Constructive
Definition: ossl_asn1.c:160
ossl_asn1_info_size
@ ossl_asn1_info_size
Definition: ossl_asn1.c:488
cASN1Integer
VALUE cASN1Integer
Definition: ossl_asn1.c:164
cASN1EndOfContent
VALUE cASN1EndOfContent
Definition: ossl_asn1.c:162
cASN1GraphicString
VALUE cASN1GraphicString
Definition: ossl_asn1.c:169
ossl_asn1_get_tag_class
#define ossl_asn1_get_tag_class(o)
Definition: ossl_asn1.c:146
cASN1UTF8String
VALUE cASN1UTF8String
Definition: ossl_asn1.c:166
ossl_asn1_set_value
#define ossl_asn1_set_value(o, v)
Definition: ossl_asn1.c:149
ossl_asn1_get_indefinite_length
#define ossl_asn1_get_indefinite_length(o)
Definition: ossl_asn1.c:147
cASN1PrintableString
VALUE cASN1PrintableString
Definition: ossl_asn1.c:167
cASN1T61String
VALUE cASN1T61String
Definition: ossl_asn1.c:168
cASN1ISO64String
VALUE cASN1ISO64String
Definition: ossl_asn1.c:170
ossl_asn1_get_tag
#define ossl_asn1_get_tag(o)
Definition: ossl_asn1.c:144
asn1str_to_str
VALUE asn1str_to_str(const ASN1_STRING *str)
Definition: ossl_asn1.c:92
cASN1NumericString
VALUE cASN1NumericString
Definition: ossl_asn1.c:167
ossl_asn1_get_value
#define ossl_asn1_get_value(o)
Definition: ossl_asn1.c:143
cASN1BitString
VALUE cASN1BitString
Definition: ossl_asn1.c:165
ossl_time_split
void ossl_time_split(VALUE time, time_t *sec, int *days)
Definition: ossl_asn1.c:73
cASN1Set
VALUE cASN1Set
Definition: ossl_asn1.c:175
ossl_asn1_set_tag
#define ossl_asn1_set_tag(o, v)
Definition: ossl_asn1.c:150
Init_ossl_asn1
void Init_ossl_asn1(void)
Definition: ossl_asn1.c:1385
ossl_asn1_get_tagging
#define ossl_asn1_get_tagging(o)
Definition: ossl_asn1.c:145
ossl_membio2str
VALUE ossl_membio2str(BIO *bio)
Definition: ossl_bio.c:29
ossl_bn_new
VALUE ossl_bn_new(const BIGNUM *bn)
Definition: ossl_bn.c:62
GetBNPtr
#define GetBNPtr(obj)
Definition: ossl_bn.h:19
RARRAY_AREF
#define RARRAY_AREF(a, i)
Definition: psych_emitter.c:7
RARRAY_LEN
#define RARRAY_LEN
Definition: rarray.h:52
NULL
#define NULL
Definition: regenc.h:69
StringValue
#define StringValue(v)
Definition: rstring.h:50
StringValueCStr
#define StringValueCStr(v)
Definition: rstring.h:52
argc
int argc
Definition: ruby.c:240
argv
char ** argv
Definition: ruby.c:241
Qtrue
#define Qtrue
Definition: special_consts.h:52
RTEST
#define RTEST
Definition: special_consts.h:42
Qnil
#define Qnil
Definition: special_consts.h:51
Qfalse
#define Qfalse
Definition: special_consts.h:50
NIL_P
#define NIL_P
Definition: special_consts.h:46
FIXNUM_P
#define FIXNUM_P
Definition: special_consts.h:44
ossl_asn1_info_t
Definition: ossl_asn1.c:449
ossl_asn1_info_t::klass
VALUE * klass
Definition: ossl_asn1.c:451
ossl_asn1_info_t::name
const char * name
Definition: ossl_asn1.c:450
state
Definition: blast.c:41
t
#define t
Definition: symbol.c:253
VALUE
unsigned long VALUE
Definition: value.h:38
ID
unsigned long ID
Definition: value.h:39
T_ARRAY
#define T_ARRAY
Definition: value_type.h:55
SYMBOL_P
#define SYMBOL_P
Definition: value_type.h:87
read
int read(izstream &zs, T *x, Items items)
Definition: zstream.h:115