Lev Walkin | 20696a4 | 2017-10-17 21:27:33 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2003-2017 Lev Walkin <vlm@lionet.info>. All rights reserved. |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 3 | * Redistribution and modifications are permitted subject to BSD license. |
| 4 | */ |
| 5 | #ifndef _OBJECT_IDENTIFIER_H_ |
| 6 | #define _OBJECT_IDENTIFIER_H_ |
| 7 | |
Lev Walkin | 8e8078a | 2004-09-26 13:10:40 +0000 | [diff] [blame] | 8 | #include <asn_application.h> |
Lev Walkin | 3256d6f | 2004-10-21 11:22:12 +0000 | [diff] [blame] | 9 | #include <asn_codecs_prim.h> |
Bi-Ruei, Chiu | e1bf219 | 2017-08-19 00:55:25 +0800 | [diff] [blame] | 10 | #include <OCTET_STRING.h> |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 11 | |
Lev Walkin | 21b41ac | 2005-07-24 09:03:44 +0000 | [diff] [blame] | 12 | #ifdef __cplusplus |
| 13 | extern "C" { |
| 14 | #endif |
| 15 | |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 16 | typedef uint32_t asn_oid_arc_t; |
| 17 | #define ASN_OID_ARC_MAX (~((asn_oid_arc_t)0)) |
| 18 | |
Lev Walkin | 8e8078a | 2004-09-26 13:10:40 +0000 | [diff] [blame] | 19 | typedef ASN__PRIMITIVE_TYPE_t OBJECT_IDENTIFIER_t; |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 20 | |
Lev Walkin | 5e03376 | 2004-09-29 13:26:15 +0000 | [diff] [blame] | 21 | extern asn_TYPE_descriptor_t asn_DEF_OBJECT_IDENTIFIER; |
Bi-Ruei, Chiu | 1f87ac0 | 2017-08-20 01:25:45 +0800 | [diff] [blame] | 22 | extern asn_TYPE_operation_t asn_OP_OBJECT_IDENTIFIER; |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 23 | |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 24 | asn_struct_print_f OBJECT_IDENTIFIER_print; |
Lev Walkin | a9cc46e | 2004-09-22 16:06:28 +0000 | [diff] [blame] | 25 | asn_constr_check_f OBJECT_IDENTIFIER_constraint; |
| 26 | der_type_encoder_f OBJECT_IDENTIFIER_encode_der; |
Lev Walkin | 9230225 | 2004-10-23 10:16:51 +0000 | [diff] [blame] | 27 | xer_type_decoder_f OBJECT_IDENTIFIER_decode_xer; |
Lev Walkin | a9cc46e | 2004-09-22 16:06:28 +0000 | [diff] [blame] | 28 | xer_type_encoder_f OBJECT_IDENTIFIER_encode_xer; |
Lev Walkin | a5972be | 2017-09-29 23:15:58 -0700 | [diff] [blame] | 29 | asn_random_fill_f OBJECT_IDENTIFIER_random_fill; |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 30 | |
Bi-Ruei, Chiu | 1fa31c9 | 2016-05-16 13:50:09 +0800 | [diff] [blame] | 31 | #define OBJECT_IDENTIFIER_free ASN__PRIMITIVE_TYPE_free |
Bi-Ruei, Chiu | e1bf219 | 2017-08-19 00:55:25 +0800 | [diff] [blame] | 32 | #define OBJECT_IDENTIFIER_compare OCTET_STRING_compare |
Bi-Ruei, Chiu | 1fa31c9 | 2016-05-16 13:50:09 +0800 | [diff] [blame] | 33 | #define OBJECT_IDENTIFIER_decode_ber ber_decode_primitive |
| 34 | #define OBJECT_IDENTIFIER_encode_der der_encode_primitive |
Lev Walkin | b5b524b | 2017-10-13 03:14:03 -0700 | [diff] [blame] | 35 | #define OBJECT_IDENTIFIER_decode_oer oer_decode_primitive |
| 36 | #define OBJECT_IDENTIFIER_encode_oer oer_encode_primitive |
Bi-Ruei, Chiu | 1fa31c9 | 2016-05-16 13:50:09 +0800 | [diff] [blame] | 37 | #define OBJECT_IDENTIFIER_decode_uper OCTET_STRING_decode_uper |
| 38 | #define OBJECT_IDENTIFIER_encode_uper OCTET_STRING_encode_uper |
| 39 | |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 40 | /********************************** |
| 41 | * Some handy conversion routines * |
| 42 | **********************************/ |
| 43 | |
| 44 | /* |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 45 | * This function fills an (arcs) array with OBJECT IDENTIFIER arcs |
| 46 | * up to specified (arc_slots) elements. |
| 47 | * |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 48 | * EXAMPLE: |
| 49 | * void print_arcs(OBJECT_IDENTIFIER_t *oid) { |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 50 | * asn_oid_arc_t fixed_arcs[10]; // Try with fixed space first |
| 51 | * asn_oid_arc_t *arcs = fixed_arcs; |
| 52 | * size_t arc_slots = sizeof(fixed_arcs)/sizeof(fixed_arcs[0]); // 10 |
| 53 | * ssize_t count; // Real number of arcs. |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 54 | * int i; |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 55 | * |
| 56 | * count = OBJECT_IDENTIFIER_get_arcs(oid, arcs, arc_slots); |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 57 | * // If necessary, reallocate arcs array and try again. |
Lev Walkin | 29a044b | 2004-06-14 07:24:36 +0000 | [diff] [blame] | 58 | * if(count > arc_slots) { |
| 59 | * arc_slots = count; |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 60 | * arcs = malloc(sizeof(asn_oid_arc_t) * arc_slots); |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 61 | * if(!arcs) return; |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 62 | * count = OBJECT_IDENTIFIER_get_arcs(oid, arcs, arc_slots); |
Lev Walkin | 29a044b | 2004-06-14 07:24:36 +0000 | [diff] [blame] | 63 | * assert(count == arc_slots); |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 64 | * } |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 65 | * |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 66 | * // Print the contents of the arcs array. |
| 67 | * for(i = 0; i < count; i++) |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 68 | * printf("%"PRIu32"\n", arcs[i]); |
| 69 | * |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 70 | * // Avoid memory leak. |
| 71 | * if(arcs != fixed_arcs) free(arcs); |
| 72 | * } |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 73 | * |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 74 | * RETURN VALUES: |
| 75 | * -1/EINVAL: Invalid arguments (oid is missing) |
| 76 | * -1/ERANGE: One or more arcs have value out of array cell type range. |
| 77 | * >=0: Number of arcs contained in the OBJECT IDENTIFIER |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 78 | * |
| 79 | * WARNING: The function always returns the actual number of arcs, |
| 80 | * even if there is no sufficient (arc_slots) provided. |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 81 | */ |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 82 | ssize_t OBJECT_IDENTIFIER_get_arcs(const OBJECT_IDENTIFIER_t *oid, |
| 83 | asn_oid_arc_t *arcs, size_t arc_slots); |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 84 | |
| 85 | /* |
| 86 | * This functions initializes the OBJECT IDENTIFIER object with |
| 87 | * the given set of arcs. |
| 88 | * The minimum of two arcs must be present; some restrictions apply. |
| 89 | * RETURN VALUES: |
| 90 | * -1/EINVAL: Invalid arguments |
| 91 | * -1/ERANGE: The first two arcs do not conform to ASN.1 restrictions. |
| 92 | * -1/ENOMEM: Memory allocation failed |
| 93 | * 0: The object was initialized with new arcs. |
| 94 | */ |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 95 | int OBJECT_IDENTIFIER_set_arcs(OBJECT_IDENTIFIER_t *oid, |
| 96 | const asn_oid_arc_t *arcs, size_t arcs_count); |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 97 | |
Lev Walkin | 9230225 | 2004-10-23 10:16:51 +0000 | [diff] [blame] | 98 | |
| 99 | /* |
| 100 | * Parse the OBJECT IDENTIFIER textual representation ("1.3.6.1.4.1.9363"). |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 101 | * No arc can exceed the (0..ASN_OID_ARC_MAX, which is the same as UINT32_MAX). |
Lev Walkin | 9230225 | 2004-10-23 10:16:51 +0000 | [diff] [blame] | 102 | * This function is not specific to OBJECT IDENTIFIER, it may be used to parse |
| 103 | * the RELATIVE-OID data, or any other data consisting of dot-separated |
| 104 | * series of numeric values. |
| 105 | * |
| 106 | * If (oid_txt_length == -1), the strlen() will be invoked to determine the |
| 107 | * size of the (oid_text) string. |
| 108 | * |
Lev Walkin | 093ba2e | 2005-04-04 21:10:06 +0000 | [diff] [blame] | 109 | * After return, the optional (opt_oid_text_end) is set to the character after |
| 110 | * the last parsed one. (opt_oid_text_end) is never less than (oid_text). |
Lev Walkin | 9230225 | 2004-10-23 10:16:51 +0000 | [diff] [blame] | 111 | * |
| 112 | * RETURN VALUES: |
| 113 | * -1: Parse error. |
| 114 | * >= 0: Number of arcs contained in the OBJECT IDENTIFIER. |
| 115 | * |
| 116 | * WARNING: The function always returns the real number of arcs, |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 117 | * even if there is no sufficient (arc_slots) provided. |
| 118 | * This is useful for (arc_slots) value estimation. |
Lev Walkin | 9230225 | 2004-10-23 10:16:51 +0000 | [diff] [blame] | 119 | */ |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 120 | ssize_t OBJECT_IDENTIFIER_parse_arcs(const char *oid_text, |
| 121 | ssize_t oid_txt_length, |
| 122 | asn_oid_arc_t *arcs, size_t arcs_count, |
| 123 | const char **opt_oid_text_end); |
Lev Walkin | 9230225 | 2004-10-23 10:16:51 +0000 | [diff] [blame] | 124 | |
| 125 | /* |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 126 | * Internal functions. |
Lev Walkin | 0787ff0 | 2004-06-17 23:43:39 +0000 | [diff] [blame] | 127 | * Used by RELATIVE-OID implementation in particular. |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 128 | */ |
Lev Walkin | 588bf0f | 2017-10-13 23:51:16 -0700 | [diff] [blame] | 129 | |
| 130 | /* |
| 131 | * Retrieve a single arc of size from the (arcbuf) buffer. |
| 132 | * RETURN VALUES: |
| 133 | * -1: Failed to retrieve the value from the (arcbuf). |
| 134 | * >0: Number of bytes consumed from the (arcbuf), <= (arcbuf_len). |
| 135 | */ |
| 136 | ssize_t OBJECT_IDENTIFIER_get_single_arc(const uint8_t *arcbuf, |
| 137 | size_t arcbuf_len, |
| 138 | asn_oid_arc_t *ret_value); |
| 139 | |
| 140 | /* |
| 141 | * Write the unterminated arc value into the (arcbuf) which has the size at |
| 142 | * least (arcbuf_len). |
| 143 | * RETURN VALUES: |
| 144 | * -1: (arcbuf_len) size is not sufficient to write the value. |
| 145 | * <n>: Number of bytes appended to the arcbuf (<= arcbuf_len). |
| 146 | */ |
| 147 | ssize_t OBJECT_IDENTIFIER_set_single_arc(uint8_t *arcbuf, size_t arcbuf_len, |
| 148 | asn_oid_arc_t arc_value); |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 149 | |
Lev Walkin | 21b41ac | 2005-07-24 09:03:44 +0000 | [diff] [blame] | 150 | #ifdef __cplusplus |
| 151 | } |
| 152 | #endif |
| 153 | |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 154 | #endif /* _OBJECT_IDENTIFIER_H_ */ |