2 * Copyright (c) 2003, 2004 Lev Walkin <vlm@lionet.info>. All rights reserved.
3 * Redistribution and modifications are permitted subject to BSD license.
5 #include <asn_internal.h>
7 #include <OBJECT_IDENTIFIER.h>
8 #include <OCTET_STRING.h>
9 #include <limits.h> /* for CHAR_BIT */
13 * OBJECT IDENTIFIER basic type description.
15 static const ber_tlv_tag_t asn_DEF_OBJECT_IDENTIFIER_tags[] = {
16 (ASN_TAG_CLASS_UNIVERSAL | (6 << 2))
18 asn_TYPE_operation_t asn_OP_OBJECT_IDENTIFIER = {
19 ASN__PRIMITIVE_TYPE_free,
20 OBJECT_IDENTIFIER_print,
21 OCTET_STRING_compare, /* Implemented in terms of a string comparison */
24 OBJECT_IDENTIFIER_decode_xer,
25 OBJECT_IDENTIFIER_encode_xer,
26 #ifdef ASN_DISABLE_OER_SUPPORT
30 OBJECT_IDENTIFIER_decode_oer,
31 OBJECT_IDENTIFIER_encode_oer,
32 #endif /* ASN_DISABLE_OER_SUPPORT */
33 #ifdef ASN_DISABLE_PER_SUPPORT
39 OCTET_STRING_decode_uper,
40 OCTET_STRING_encode_uper,
41 OCTET_STRING_decode_aper,
42 OCTET_STRING_encode_aper,
43 #endif /* ASN_DISABLE_PER_SUPPORT */
44 OBJECT_IDENTIFIER_random_fill,
45 0 /* Use generic outmost tag fetcher */
47 asn_TYPE_descriptor_t asn_DEF_OBJECT_IDENTIFIER = {
50 &asn_OP_OBJECT_IDENTIFIER,
51 asn_DEF_OBJECT_IDENTIFIER_tags,
52 sizeof(asn_DEF_OBJECT_IDENTIFIER_tags)
53 / sizeof(asn_DEF_OBJECT_IDENTIFIER_tags[0]),
54 asn_DEF_OBJECT_IDENTIFIER_tags, /* Same as above */
55 sizeof(asn_DEF_OBJECT_IDENTIFIER_tags)
56 / sizeof(asn_DEF_OBJECT_IDENTIFIER_tags[0]),
57 { 0, 0, OBJECT_IDENTIFIER_constraint },
58 0, 0, /* No members */
63 OBJECT_IDENTIFIER_constraint(const asn_TYPE_descriptor_t *td, const void *sptr,
64 asn_app_constraint_failed_f *ctfailcb,
66 const OBJECT_IDENTIFIER_t *st = (const OBJECT_IDENTIFIER_t *)sptr;
70 ASN__CTFAIL(app_key, td, sptr,
71 "%s: at least one numerical value "
73 td->name, __FILE__, __LINE__);
77 ASN__CTFAIL(app_key, td, sptr,
78 "%s: value not given (%s:%d)",
79 td->name, __FILE__, __LINE__);
87 OBJECT_IDENTIFIER_get_first_arcs(const uint8_t *arcbuf, size_t arcbuf_len,
88 asn_oid_arc_t *arc0, asn_oid_arc_t *arc1) {
91 ssize_t rd = OBJECT_IDENTIFIER_get_single_arc(arcbuf, arcbuf_len, &value);
92 if(rd <= 0) return rd;
97 } else if(value >= 40) {
109 OBJECT_IDENTIFIER_get_single_arc(const uint8_t *arcbuf, size_t arcbuf_len,
110 asn_oid_arc_t *ret_value) {
111 const uint8_t *b = arcbuf;
112 const uint8_t *arcend = arcbuf + arcbuf_len; /* End of arc */
114 if(arcbuf == arcend) {
118 asn_oid_arc_t upper_limit = (ASN_OID_ARC_MAX >> 7);
119 /* When the value reaches "upper_limit", it can take */
120 /* at most one more digit. If it exceeds "upper_limit" */
121 /* but there are more digits - it's an Overflow condition */
122 /* Gather all bits into the accumulator */
123 for(accum = 0; b < arcend; b++) {
124 accum = (accum << 7) | (*b & ~0x80);
125 if((*b & 0x80) == 0) { // no more digits
126 if(accum <= ASN_OID_ARC_MAX) {
128 return 1 + (b - arcbuf);
130 errno = ERANGE; /* Overflow */
133 } else { // to make sure we aren't wrapping around
134 if(accum > upper_limit) {
135 errno = ERANGE; /* Overflow */
147 OBJECT_IDENTIFIER__dump_body(const OBJECT_IDENTIFIER_t *st,
148 asn_app_consume_bytes_f *cb, void *app_key) {
150 asn_oid_arc_t arc0, arc1;
156 rd = OBJECT_IDENTIFIER_get_first_arcs(st->buf, st->size, &arc0, &arc1);
161 ret = snprintf(scratch, sizeof(scratch), "%"PRIu32".%"PRIu32, arc0, arc1);
162 if(ret >= (ssize_t)sizeof(scratch)) {
166 if(cb(scratch, ret, app_key) < 0)
171 rd = OBJECT_IDENTIFIER_get_single_arc(st->buf + off, st->size - off,
180 assert(off <= st->size);
181 ret = snprintf(scratch, sizeof(scratch), ".%" PRIu32, arc);
182 if(ret >= (ssize_t)sizeof(scratch)) {
186 if(cb(scratch, ret, app_key) < 0) return -1;
190 if(off != st->size) {
191 ASN_DEBUG("Could not scan to the end of Object Identifier");
198 static enum xer_pbd_rval
199 OBJECT_IDENTIFIER__xer_body_decode(const asn_TYPE_descriptor_t *td, void *sptr,
200 const void *chunk_buf, size_t chunk_size) {
201 OBJECT_IDENTIFIER_t *st = (OBJECT_IDENTIFIER_t *)sptr;
202 const char *chunk_end = (const char *)chunk_buf + chunk_size;
204 asn_oid_arc_t s_arcs[10];
205 asn_oid_arc_t *arcs = s_arcs;
211 num_arcs = OBJECT_IDENTIFIER_parse_arcs(
212 (const char *)chunk_buf, chunk_size, arcs,
213 sizeof(s_arcs) / sizeof(s_arcs[0]), &endptr);
215 /* Expecting more than zero arcs */
216 return XPBD_BROKEN_ENCODING;
217 } else if(num_arcs == 0) {
218 return XPBD_NOT_BODY_IGNORE;
220 assert(endptr == chunk_end);
222 if((size_t)num_arcs > sizeof(s_arcs)/sizeof(s_arcs[0])) {
223 arcs = (asn_oid_arc_t *)MALLOC(num_arcs * sizeof(asn_oid_arc_t));
224 if(!arcs) return XPBD_SYSTEM_FAILURE;
225 ret = OBJECT_IDENTIFIER_parse_arcs((const char *)chunk_buf, chunk_size,
226 arcs, num_arcs, &endptr);
228 return XPBD_SYSTEM_FAILURE; /* assert?.. */
232 * Convert arcs into BER representation.
234 ret = OBJECT_IDENTIFIER_set_arcs(st, arcs, num_arcs);
235 if(arcs != s_arcs) FREEMEM(arcs);
237 return ret ? XPBD_SYSTEM_FAILURE : XPBD_BODY_CONSUMED;
241 OBJECT_IDENTIFIER_decode_xer(const asn_codec_ctx_t *opt_codec_ctx,
242 const asn_TYPE_descriptor_t *td, void **sptr,
243 const char *opt_mname, const void *buf_ptr,
245 return xer_decode_primitive(opt_codec_ctx, td,
246 sptr, sizeof(OBJECT_IDENTIFIER_t), opt_mname,
247 buf_ptr, size, OBJECT_IDENTIFIER__xer_body_decode);
251 OBJECT_IDENTIFIER_encode_xer(const asn_TYPE_descriptor_t *td, const void *sptr,
252 int ilevel, enum xer_encoder_flags_e flags,
253 asn_app_consume_bytes_f *cb, void *app_key) {
254 const OBJECT_IDENTIFIER_t *st = (const OBJECT_IDENTIFIER_t *)sptr;
255 asn_enc_rval_t er = {0,0,0};
260 if(!st || !st->buf) {
264 er.encoded = OBJECT_IDENTIFIER__dump_body(st, cb, app_key);
265 if(er.encoded < 0) ASN__ENCODE_FAILED;
271 OBJECT_IDENTIFIER_print(const asn_TYPE_descriptor_t *td, const void *sptr,
272 int ilevel, asn_app_consume_bytes_f *cb,
274 const OBJECT_IDENTIFIER_t *st = (const OBJECT_IDENTIFIER_t *)sptr;
276 (void)td; /* Unused argument */
277 (void)ilevel; /* Unused argument */
280 return (cb("<absent>", 8, app_key) < 0) ? -1 : 0;
283 if(cb("{ ", 2, app_key) < 0)
286 if(OBJECT_IDENTIFIER__dump_body(st, cb, app_key) < 0) {
290 return (cb(" }", 2, app_key) < 0) ? -1 : 0;
294 OBJECT_IDENTIFIER_get_arcs(const OBJECT_IDENTIFIER_t *st, asn_oid_arc_t *arcs,
296 asn_oid_arc_t arc0, arc1;
301 if(!st || !st->buf) {
306 rd = OBJECT_IDENTIFIER_get_first_arcs(st->buf, st->size, &arc0, &arc1);
325 rd = OBJECT_IDENTIFIER_get_single_arc(st->buf + off, st->size - off,
334 if(num_arcs < arc_slots) {
335 arcs[num_arcs] = arc;
341 if(off != st->size) {
350 * Save the single value as an object identifier arc.
353 OBJECT_IDENTIFIER_set_single_arc(uint8_t *arcbuf, size_t arcbuf_len,
354 asn_oid_arc_t value) {
356 * The following conditions must hold:
359 uint8_t scratch[((sizeof(value) * CHAR_BIT + 6) / 7)];
360 uint8_t *scratch_end = &scratch[sizeof(scratch)-1];
365 for(b = scratch_end, mask = 0; ; mask = 0x80, b--) {
366 *b = mask | (value & 0x7f);
373 result_len = (scratch_end - b) + 1;
375 if(result_len > arcbuf_len) {
379 memcpy(arcbuf, b, result_len);
385 OBJECT_IDENTIFIER_set_arcs(OBJECT_IDENTIFIER_t *st, const asn_oid_arc_t *arcs,
395 if(!st || !arcs || arc_slots < 2) {
405 /* 8.19.4: At most 39 subsequent values (including 0) */
409 } else if(arc0 == 2) {
410 if(arc1 > ASN_OID_ARC_MAX - 80) {
414 } else if(arc0 > 2) {
415 /* 8.19.4: Only three values are allocated from the root node */
421 * After above tests it is known that the value of arc0 is completely
422 * trustworthy (0..2). However, the arc1's value is still meaningless.
426 * Roughly estimate the maximum size necessary to encode these arcs.
427 * This estimation implicitly takes in account the following facts,
428 * that cancel each other:
429 * * the first two arcs are encoded in a single value.
430 * * the first value may require more space (+1 byte)
431 * * the value of the first arc which is in range (0..2)
433 size = ((sizeof(asn_oid_arc_t) * CHAR_BIT + 6) / 7) * arc_slots;
434 bp = buf = (uint8_t *)MALLOC(size + 1);
440 wrote = OBJECT_IDENTIFIER_set_single_arc(bp, size, arc0 * 40 + arc1);
445 assert((size_t)wrote <= size);
449 for(i = 2; i < arc_slots; i++) {
450 wrote = OBJECT_IDENTIFIER_set_single_arc(bp, size, arcs[i]);
455 assert((size_t)wrote <= size);
466 st->buf[st->size] = '\0';
473 OBJECT_IDENTIFIER_parse_arcs(const char *oid_text, ssize_t oid_txt_length,
474 asn_oid_arc_t *arcs, size_t arcs_count,
475 const char **opt_oid_text_end) {
481 ST_AFTERVALUE, /* Next character ought to be '.' or a space */
482 ST_WAITDIGITS /* Next character is expected to be a digit */
483 } state = ST_LEADSPACE;
485 if(!oid_text || oid_txt_length < -1 || (arcs_count && !arcs)) {
486 if(opt_oid_text_end) *opt_oid_text_end = oid_text;
491 if(oid_txt_length == -1)
492 oid_txt_length = strlen(oid_text);
494 #define _OID_CAPTURE_ARC(oid_text, oid_end) \
496 const char *endp = oid_end; \
497 unsigned long value; \
498 switch(asn_strtoul_lim(oid_text, &endp, &value)) { \
499 case ASN_STRTOX_EXTRA_DATA: \
500 case ASN_STRTOX_OK: \
501 if(value <= ASN_OID_ARC_MAX) { \
502 if(num_arcs < arcs_count) arcs[num_arcs] = value; \
504 oid_text = endp - 1; \
508 case ASN_STRTOX_ERROR_RANGE: \
509 if(opt_oid_text_end) *opt_oid_text_end = oid_text; \
512 case ASN_STRTOX_ERROR_INVAL: \
513 case ASN_STRTOX_EXPECT_MORE: \
514 if(opt_oid_text_end) *opt_oid_text_end = oid_text; \
520 for(oid_end = oid_text + oid_txt_length; oid_text<oid_end; oid_text++) {
522 case 0x09: case 0x0a: case 0x0d: case 0x20: /* whitespace */
528 state = ST_TAILSPACE;
531 break; /* Digits expected after ".", got whitespace */
540 *opt_oid_text_end = oid_text;
541 errno = EINVAL; /* Broken OID */
545 state = ST_WAITDIGITS;
549 case 0x30: case 0x31: case 0x32: case 0x33: case 0x34:
550 case 0x35: case 0x36: case 0x37: case 0x38: case 0x39:
555 *opt_oid_text_end = oid_text;
556 errno = EINVAL; /* "1. 1" => broken OID */
560 _OID_CAPTURE_ARC(oid_text, oid_end);
561 state = ST_AFTERVALUE;
566 /* Unexpected symbols */
567 state = ST_WAITDIGITS;
574 if(opt_oid_text_end) *opt_oid_text_end = oid_text;
576 /* Finalize last arc */
579 return 0; /* No OID found in input data */
581 errno = EINVAL; /* Broken OID */
588 errno = EINVAL; /* Broken OID */
593 * Generate values from the list of interesting values, or just a random
594 * value up to the upper limit.
597 OBJECT_IDENTIFIER__biased_random_arc(asn_oid_arc_t upper_bound) {
598 const asn_oid_arc_t values[] = {0, 1, 127, 128, 129, 254, 255, 256};
601 switch(asn_random_between(0, 2)) {
603 idx = asn_random_between(0, sizeof(values) / sizeof(values[0]) - 1);
604 if(values[idx] < upper_bound) {
609 return asn_random_between(0, upper_bound);
616 asn_random_fill_result_t
617 OBJECT_IDENTIFIER_random_fill(const asn_TYPE_descriptor_t *td, void **sptr,
618 const asn_encoding_constraints_t *constraints,
620 asn_random_fill_result_t result_ok = {ARFILL_OK, 1};
621 asn_random_fill_result_t result_failed = {ARFILL_FAILED, 0};
622 asn_random_fill_result_t result_skipped = {ARFILL_SKIPPED, 0};
623 OBJECT_IDENTIFIER_t *st;
624 asn_oid_arc_t arcs[5];
625 size_t arcs_len = asn_random_between(2, 5);
630 if(max_length < arcs_len) return result_skipped;
635 st = CALLOC(1, sizeof(*st));
638 arcs[0] = asn_random_between(0, 2);
639 arcs[1] = OBJECT_IDENTIFIER__biased_random_arc(
640 arcs[0] <= 1 ? 39 : (ASN_OID_ARC_MAX - 80));
641 for(i = 2; i < arcs_len; i++) {
642 arcs[i] = OBJECT_IDENTIFIER__biased_random_arc(ASN_OID_ARC_MAX);
645 if(OBJECT_IDENTIFIER_set_arcs(st, arcs, arcs_len)) {
647 ASN_STRUCT_FREE(*td, st);
649 return result_failed;
654 result_ok.length = st->size;