3 * Copyright (c) 2003, 2004 Lev Walkin <vlm@lionet.info>. All rights reserved.
4 * Redistribution and modifications are permitted subject to BSD license.
6 #include <asn_internal.h>
8 #include <OBJECT_IDENTIFIER.h>
9 #include <OCTET_STRING.h>
10 #include <limits.h> /* for CHAR_BIT */
14 * OBJECT IDENTIFIER basic type description.
16 static const ber_tlv_tag_t asn_DEF_OBJECT_IDENTIFIER_tags[] = {
17 (ASN_TAG_CLASS_UNIVERSAL | (6 << 2))
19 asn_TYPE_operation_t asn_OP_OBJECT_IDENTIFIER = {
20 ASN__PRIMITIVE_TYPE_free,
21 OBJECT_IDENTIFIER_print,
22 OCTET_STRING_compare, /* Implemented in terms of a string comparison */
25 OBJECT_IDENTIFIER_decode_xer,
26 OBJECT_IDENTIFIER_encode_xer,
27 #ifdef ASN_DISABLE_OER_SUPPORT
31 OBJECT_IDENTIFIER_decode_oer,
32 OBJECT_IDENTIFIER_encode_oer,
33 #endif /* ASN_DISABLE_OER_SUPPORT */
34 #ifdef ASN_DISABLE_PER_SUPPORT
40 OCTET_STRING_decode_uper,
41 OCTET_STRING_encode_uper,
42 OCTET_STRING_decode_aper,
43 OCTET_STRING_encode_aper,
44 #endif /* ASN_DISABLE_PER_SUPPORT */
45 OBJECT_IDENTIFIER_random_fill,
46 0 /* Use generic outmost tag fetcher */
48 asn_TYPE_descriptor_t asn_DEF_OBJECT_IDENTIFIER = {
51 &asn_OP_OBJECT_IDENTIFIER,
52 asn_DEF_OBJECT_IDENTIFIER_tags,
53 sizeof(asn_DEF_OBJECT_IDENTIFIER_tags)
54 / sizeof(asn_DEF_OBJECT_IDENTIFIER_tags[0]),
55 asn_DEF_OBJECT_IDENTIFIER_tags, /* Same as above */
56 sizeof(asn_DEF_OBJECT_IDENTIFIER_tags)
57 / sizeof(asn_DEF_OBJECT_IDENTIFIER_tags[0]),
58 { 0, 0, OBJECT_IDENTIFIER_constraint },
59 0, 0, /* No members */
64 OBJECT_IDENTIFIER_constraint(const asn_TYPE_descriptor_t *td, const void *sptr,
65 asn_app_constraint_failed_f *ctfailcb,
67 const OBJECT_IDENTIFIER_t *st = (const OBJECT_IDENTIFIER_t *)sptr;
71 ASN__CTFAIL(app_key, td, sptr,
72 "%s: at least one numerical value "
74 td->name, __FILE__, __LINE__);
78 ASN__CTFAIL(app_key, td, sptr,
79 "%s: value not given (%s:%d)",
80 td->name, __FILE__, __LINE__);
88 OBJECT_IDENTIFIER_get_first_arcs(const uint8_t *arcbuf, size_t arcbuf_len,
89 asn_oid_arc_t *arc0, asn_oid_arc_t *arc1) {
92 ssize_t rd = OBJECT_IDENTIFIER_get_single_arc(arcbuf, arcbuf_len, &value);
93 if(rd <= 0) return rd;
98 } else if(value >= 40) {
110 OBJECT_IDENTIFIER_get_single_arc(const uint8_t *arcbuf, size_t arcbuf_len,
111 asn_oid_arc_t *ret_value) {
112 const uint8_t *b = arcbuf;
113 const uint8_t *arcend = arcbuf + arcbuf_len; /* End of arc */
115 if(arcbuf == arcend) {
119 asn_oid_arc_t upper_limit = (ASN_OID_ARC_MAX >> 7);
120 /* When the value reaches "upper_limit", it can take */
121 /* at most one more digit. If it exceeds "upper_limit" */
122 /* but there are more digits - it's an Overflow condition */
123 /* Gather all bits into the accumulator */
124 for(accum = 0; b < arcend; b++) {
125 accum = (accum << 7) | (*b & ~0x80);
126 if((*b & 0x80) == 0) { // no more digits
127 if(accum <= ASN_OID_ARC_MAX) {
129 return 1 + (b - arcbuf);
131 errno = ERANGE; /* Overflow */
134 } else { // to make sure we aren't wrapping around
135 if(accum > upper_limit) {
136 errno = ERANGE; /* Overflow */
148 OBJECT_IDENTIFIER__dump_body(const OBJECT_IDENTIFIER_t *st,
149 asn_app_consume_bytes_f *cb, void *app_key) {
151 asn_oid_arc_t arc0, arc1;
157 rd = OBJECT_IDENTIFIER_get_first_arcs(st->buf, st->size, &arc0, &arc1);
162 ret = snprintf(scratch, sizeof(scratch), "%"PRIu32".%"PRIu32, arc0, arc1);
163 if(ret >= (ssize_t)sizeof(scratch)) {
167 if(cb(scratch, ret, app_key) < 0)
172 rd = OBJECT_IDENTIFIER_get_single_arc(st->buf + off, st->size - off,
181 assert(off <= st->size);
182 ret = snprintf(scratch, sizeof(scratch), ".%" PRIu32, arc);
183 if(ret >= (ssize_t)sizeof(scratch)) {
187 if(cb(scratch, ret, app_key) < 0) return -1;
191 if(off != st->size) {
192 ASN_DEBUG("Could not scan to the end of Object Identifier");
199 static enum xer_pbd_rval
200 OBJECT_IDENTIFIER__xer_body_decode(const asn_TYPE_descriptor_t *td, void *sptr,
201 const void *chunk_buf, size_t chunk_size) {
202 OBJECT_IDENTIFIER_t *st = (OBJECT_IDENTIFIER_t *)sptr;
203 const char *chunk_end = (const char *)chunk_buf + chunk_size;
205 asn_oid_arc_t s_arcs[10];
206 asn_oid_arc_t *arcs = s_arcs;
212 num_arcs = OBJECT_IDENTIFIER_parse_arcs(
213 (const char *)chunk_buf, chunk_size, arcs,
214 sizeof(s_arcs) / sizeof(s_arcs[0]), &endptr);
216 /* Expecting more than zero arcs */
217 return XPBD_BROKEN_ENCODING;
218 } else if(num_arcs == 0) {
219 return XPBD_NOT_BODY_IGNORE;
221 assert(endptr == chunk_end);
223 if((size_t)num_arcs > sizeof(s_arcs)/sizeof(s_arcs[0])) {
224 arcs = (asn_oid_arc_t *)MALLOC(num_arcs * sizeof(asn_oid_arc_t));
225 if(!arcs) return XPBD_SYSTEM_FAILURE;
226 ret = OBJECT_IDENTIFIER_parse_arcs((const char *)chunk_buf, chunk_size,
227 arcs, num_arcs, &endptr);
229 return XPBD_SYSTEM_FAILURE; /* assert?.. */
233 * Convert arcs into BER representation.
235 ret = OBJECT_IDENTIFIER_set_arcs(st, arcs, num_arcs);
236 if(arcs != s_arcs) FREEMEM(arcs);
238 return ret ? XPBD_SYSTEM_FAILURE : XPBD_BODY_CONSUMED;
242 OBJECT_IDENTIFIER_decode_xer(const asn_codec_ctx_t *opt_codec_ctx,
243 const asn_TYPE_descriptor_t *td, void **sptr,
244 const char *opt_mname, const void *buf_ptr,
246 return xer_decode_primitive(opt_codec_ctx, td,
247 sptr, sizeof(OBJECT_IDENTIFIER_t), opt_mname,
248 buf_ptr, size, OBJECT_IDENTIFIER__xer_body_decode);
252 OBJECT_IDENTIFIER_encode_xer(const asn_TYPE_descriptor_t *td, const void *sptr,
253 int ilevel, enum xer_encoder_flags_e flags,
254 asn_app_consume_bytes_f *cb, void *app_key) {
255 const OBJECT_IDENTIFIER_t *st = (const OBJECT_IDENTIFIER_t *)sptr;
256 asn_enc_rval_t er = {0,0,0};
261 if(!st || !st->buf) {
265 er.encoded = OBJECT_IDENTIFIER__dump_body(st, cb, app_key);
266 if(er.encoded < 0) ASN__ENCODE_FAILED;
272 OBJECT_IDENTIFIER_print(const asn_TYPE_descriptor_t *td, const void *sptr,
273 int ilevel, asn_app_consume_bytes_f *cb,
275 const OBJECT_IDENTIFIER_t *st = (const OBJECT_IDENTIFIER_t *)sptr;
277 (void)td; /* Unused argument */
278 (void)ilevel; /* Unused argument */
281 return (cb("<absent>", 8, app_key) < 0) ? -1 : 0;
284 if(cb("{ ", 2, app_key) < 0)
287 if(OBJECT_IDENTIFIER__dump_body(st, cb, app_key) < 0) {
291 return (cb(" }", 2, app_key) < 0) ? -1 : 0;
295 OBJECT_IDENTIFIER_get_arcs(const OBJECT_IDENTIFIER_t *st, asn_oid_arc_t *arcs,
297 asn_oid_arc_t arc0, arc1;
302 if(!st || !st->buf) {
307 rd = OBJECT_IDENTIFIER_get_first_arcs(st->buf, st->size, &arc0, &arc1);
326 rd = OBJECT_IDENTIFIER_get_single_arc(st->buf + off, st->size - off,
335 if(num_arcs < arc_slots) {
336 arcs[num_arcs] = arc;
342 if(off != st->size) {
351 * Save the single value as an object identifier arc.
354 OBJECT_IDENTIFIER_set_single_arc(uint8_t *arcbuf, size_t arcbuf_len,
355 asn_oid_arc_t value) {
357 * The following conditions must hold:
360 uint8_t scratch[((sizeof(value) * CHAR_BIT + 6) / 7)];
361 uint8_t *scratch_end = &scratch[sizeof(scratch)-1];
366 for(b = scratch_end, mask = 0; ; mask = 0x80, b--) {
367 *b = mask | (value & 0x7f);
374 result_len = (scratch_end - b) + 1;
376 if(result_len > arcbuf_len) {
380 memcpy(arcbuf, b, result_len);
386 OBJECT_IDENTIFIER_set_arcs(OBJECT_IDENTIFIER_t *st, const asn_oid_arc_t *arcs,
396 if(!st || !arcs || arc_slots < 2) {
406 /* 8.19.4: At most 39 subsequent values (including 0) */
410 } else if(arc0 == 2) {
411 if(arc1 > ASN_OID_ARC_MAX - 80) {
415 } else if(arc0 > 2) {
416 /* 8.19.4: Only three values are allocated from the root node */
422 * After above tests it is known that the value of arc0 is completely
423 * trustworthy (0..2). However, the arc1's value is still meaningless.
427 * Roughly estimate the maximum size necessary to encode these arcs.
428 * This estimation implicitly takes in account the following facts,
429 * that cancel each other:
430 * * the first two arcs are encoded in a single value.
431 * * the first value may require more space (+1 byte)
432 * * the value of the first arc which is in range (0..2)
434 size = ((sizeof(asn_oid_arc_t) * CHAR_BIT + 6) / 7) * arc_slots;
435 bp = buf = (uint8_t *)MALLOC(size + 1);
441 wrote = OBJECT_IDENTIFIER_set_single_arc(bp, size, arc0 * 40 + arc1);
446 assert((size_t)wrote <= size);
450 for(i = 2; i < arc_slots; i++) {
451 wrote = OBJECT_IDENTIFIER_set_single_arc(bp, size, arcs[i]);
456 assert((size_t)wrote <= size);
467 st->buf[st->size] = '\0';
474 OBJECT_IDENTIFIER_parse_arcs(const char *oid_text, ssize_t oid_txt_length,
475 asn_oid_arc_t *arcs, size_t arcs_count,
476 const char **opt_oid_text_end) {
482 ST_AFTERVALUE, /* Next character ought to be '.' or a space */
483 ST_WAITDIGITS /* Next character is expected to be a digit */
484 } state = ST_LEADSPACE;
486 if(!oid_text || oid_txt_length < -1 || (arcs_count && !arcs)) {
487 if(opt_oid_text_end) *opt_oid_text_end = oid_text;
492 if(oid_txt_length == -1)
493 oid_txt_length = strlen(oid_text);
495 #define _OID_CAPTURE_ARC(oid_text, oid_end) \
497 const char *endp = oid_end; \
498 unsigned long value; \
499 switch(asn_strtoul_lim(oid_text, &endp, &value)) { \
500 case ASN_STRTOX_EXTRA_DATA: \
501 case ASN_STRTOX_OK: \
502 if(value <= ASN_OID_ARC_MAX) { \
503 if(num_arcs < arcs_count) arcs[num_arcs] = value; \
505 oid_text = endp - 1; \
509 case ASN_STRTOX_ERROR_RANGE: \
510 if(opt_oid_text_end) *opt_oid_text_end = oid_text; \
513 case ASN_STRTOX_ERROR_INVAL: \
514 case ASN_STRTOX_EXPECT_MORE: \
515 if(opt_oid_text_end) *opt_oid_text_end = oid_text; \
521 for(oid_end = oid_text + oid_txt_length; oid_text<oid_end; oid_text++) {
523 case 0x09: case 0x0a: case 0x0d: case 0x20: /* whitespace */
529 state = ST_TAILSPACE;
532 break; /* Digits expected after ".", got whitespace */
541 *opt_oid_text_end = oid_text;
542 errno = EINVAL; /* Broken OID */
546 state = ST_WAITDIGITS;
550 case 0x30: case 0x31: case 0x32: case 0x33: case 0x34:
551 case 0x35: case 0x36: case 0x37: case 0x38: case 0x39:
556 *opt_oid_text_end = oid_text;
557 errno = EINVAL; /* "1. 1" => broken OID */
561 _OID_CAPTURE_ARC(oid_text, oid_end);
562 state = ST_AFTERVALUE;
567 /* Unexpected symbols */
568 state = ST_WAITDIGITS;
575 if(opt_oid_text_end) *opt_oid_text_end = oid_text;
577 /* Finalize last arc */
580 return 0; /* No OID found in input data */
582 errno = EINVAL; /* Broken OID */
589 errno = EINVAL; /* Broken OID */
594 * Generate values from the list of interesting values, or just a random
595 * value up to the upper limit.
598 OBJECT_IDENTIFIER__biased_random_arc(asn_oid_arc_t upper_bound) {
599 const asn_oid_arc_t values[] = {0, 1, 127, 128, 129, 254, 255, 256};
602 switch(asn_random_between(0, 2)) {
604 idx = asn_random_between(0, sizeof(values) / sizeof(values[0]) - 1);
605 if(values[idx] < upper_bound) {
610 return asn_random_between(0, upper_bound);
617 asn_random_fill_result_t
618 OBJECT_IDENTIFIER_random_fill(const asn_TYPE_descriptor_t *td, void **sptr,
619 const asn_encoding_constraints_t *constraints,
621 asn_random_fill_result_t result_ok = {ARFILL_OK, 1};
622 asn_random_fill_result_t result_failed = {ARFILL_FAILED, 0};
623 asn_random_fill_result_t result_skipped = {ARFILL_SKIPPED, 0};
624 OBJECT_IDENTIFIER_t *st;
625 asn_oid_arc_t arcs[5];
626 size_t arcs_len = asn_random_between(2, 5);
631 if(max_length < arcs_len) return result_skipped;
636 st = CALLOC(1, sizeof(*st));
639 arcs[0] = asn_random_between(0, 2);
640 arcs[1] = OBJECT_IDENTIFIER__biased_random_arc(
641 arcs[0] <= 1 ? 39 : (ASN_OID_ARC_MAX - 80));
642 for(i = 2; i < arcs_len; i++) {
643 arcs[i] = OBJECT_IDENTIFIER__biased_random_arc(ASN_OID_ARC_MAX);
646 if(OBJECT_IDENTIFIER_set_arcs(st, arcs, arcs_len)) {
648 ASN_STRUCT_FREE(*td, st);
650 return result_failed;
655 result_ok.length = st->size;