blob: 75f235e409e61364ad0e0377a96e4df76c29c2c0 [file] [log] [blame]
vlmfa67ddc2004-06-03 03:38:44 +00001/*-
vlm72425de2004-09-13 08:31:01 +00002 * Copyright (c) 2003, 2004 Lev Walkin <vlm@lionet.info>. All rights reserved.
vlmfa67ddc2004-06-03 03:38:44 +00003 * Redistribution and modifications are permitted subject to BSD license.
4 */
vlm39ba4c42004-09-22 16:06:28 +00005#include <asn_internal.h>
vlmfa67ddc2004-06-03 03:38:44 +00006#include <OCTET_STRING.h>
7#include <assert.h>
8#include <errno.h>
9
10/*
11 * OCTET STRING basic type description.
12 */
vlm7b75d982004-09-29 13:20:14 +000013static ber_tlv_tag_t asn_DEF_OCTET_STRING_tags[] = {
vlmfa67ddc2004-06-03 03:38:44 +000014 (ASN_TAG_CLASS_UNIVERSAL | (4 << 2))
15};
vlm7b75d982004-09-29 13:20:14 +000016asn_TYPE_descriptor_t asn_DEF_OCTET_STRING = {
vlmfa67ddc2004-06-03 03:38:44 +000017 "OCTET STRING",
vlm39ba4c42004-09-22 16:06:28 +000018 OCTET_STRING_free,
19 OCTET_STRING_print, /* non-ascii stuff, generally */
vlmfa67ddc2004-06-03 03:38:44 +000020 asn_generic_no_constraint,
21 OCTET_STRING_decode_ber,
22 OCTET_STRING_encode_der,
vlm39ba4c42004-09-22 16:06:28 +000023 0, /* Not implemented yet */
24 OCTET_STRING_encode_xer,
vlmfa67ddc2004-06-03 03:38:44 +000025 0, /* Use generic outmost tag fetcher */
vlm7b75d982004-09-29 13:20:14 +000026 asn_DEF_OCTET_STRING_tags,
27 sizeof(asn_DEF_OCTET_STRING_tags)
28 / sizeof(asn_DEF_OCTET_STRING_tags[0]),
29 asn_DEF_OCTET_STRING_tags, /* Same as above */
30 sizeof(asn_DEF_OCTET_STRING_tags)
31 / sizeof(asn_DEF_OCTET_STRING_tags[0]),
vlme413c122004-08-20 13:23:42 +000032 0, 0, /* No members */
vlmb42843a2004-06-05 08:17:50 +000033 0 /* No specifics */
vlmfa67ddc2004-06-03 03:38:44 +000034};
35
vlmef1b4c02004-09-23 22:06:26 +000036#undef _CH_PHASE
37#undef NEXT_PHASE
38#undef PREV_PHASE
vlmfa67ddc2004-06-03 03:38:44 +000039#define _CH_PHASE(ctx, inc) do { \
40 if(ctx->phase == 0) \
41 ctx->step = 0; \
42 ctx->phase += inc; \
43 } while(0)
44#define NEXT_PHASE(ctx) _CH_PHASE(ctx, +1)
45#define PREV_PHASE(ctx) _CH_PHASE(ctx, -1)
46
vlmef1b4c02004-09-23 22:06:26 +000047#undef ADVANCE
vlmd86c9252004-08-25 01:34:11 +000048#define ADVANCE(num_bytes) do { \
vlmb33ed682004-09-24 20:57:41 +000049 size_t num = (num_bytes); \
vlmd86c9252004-08-25 01:34:11 +000050 buf_ptr = ((char *)buf_ptr) + num; \
51 size -= num; \
52 consumed_myself += num; \
vlmfa67ddc2004-06-03 03:38:44 +000053 } while(0)
54
vlmef1b4c02004-09-23 22:06:26 +000055#undef RETURN
vlmfa67ddc2004-06-03 03:38:44 +000056#define RETURN(_code) do { \
57 rval.code = _code; \
58 rval.consumed = consumed_myself;\
59 return rval; \
60 } while(0)
61
vlmef1b4c02004-09-23 22:06:26 +000062#undef APPEND
vlmb42843a2004-06-05 08:17:50 +000063#define APPEND(bufptr, bufsize) do { \
vlmcdfdb722004-09-04 04:44:50 +000064 size_t _bs = (bufsize); \
vlmb42843a2004-06-05 08:17:50 +000065 size_t _ns = ctx->step; /* Allocated */ \
vlmcdfdb722004-09-04 04:44:50 +000066 if(_ns <= (size_t)(st->size + _bs)) { \
vlmb42843a2004-06-05 08:17:50 +000067 void *ptr; \
vlm72425de2004-09-13 08:31:01 +000068 /* Be nice and round to the memory allocator */ \
vlmb42843a2004-06-05 08:17:50 +000069 do { _ns = _ns ? _ns<<2 : 16; } \
vlmcdfdb722004-09-04 04:44:50 +000070 while(_ns <= (size_t)(st->size + _bs)); \
vlmb42843a2004-06-05 08:17:50 +000071 ptr = REALLOC(st->buf, _ns); \
72 if(ptr) { \
vlmda674682004-08-11 09:07:36 +000073 st->buf = (uint8_t *)ptr; \
vlmb42843a2004-06-05 08:17:50 +000074 ctx->step = _ns; \
75 } else { \
76 RETURN(RC_FAIL); \
77 } \
78 } \
vlmcdfdb722004-09-04 04:44:50 +000079 memcpy(st->buf + st->size, bufptr, _bs); \
80 st->size += _bs; \
vlmb42843a2004-06-05 08:17:50 +000081 if(st->size < 0) \
82 /* Why even care?.. JIC */ \
83 RETURN(RC_FAIL); \
84 /* Convenient nul-termination */ \
85 st->buf[st->size] = '\0'; \
vlmfa67ddc2004-06-03 03:38:44 +000086 } while(0)
87
88/*
89 * The main reason why ASN.1 is still alive is that too much time and effort
90 * is necessary for learning it more or less adequately, thus creating a gut
91 * necessity to demonstrate that aquired skill everywhere afterwards.
92 * No, I am not going to explain what the following stuff is.
93 */
94struct _stack_el {
vlmb33ed682004-09-24 20:57:41 +000095 ber_tlv_len_t left; /* What's left to read (or -1) */
vlmdb6b2902004-09-27 20:54:06 +000096 ber_tlv_len_t got; /* What was actually processed */
vlm72425de2004-09-13 08:31:01 +000097 int cont_level; /* Depth of subcontainment */
vlmfa67ddc2004-06-03 03:38:44 +000098 int want_nulls; /* Want null "end of content" octets? */
99 int bits_chopped; /* Flag in BIT STRING mode */
vlmdb6b2902004-09-27 20:54:06 +0000100 ber_tlv_tag_t tag; /* For debugging purposes */
vlmfa67ddc2004-06-03 03:38:44 +0000101 struct _stack_el *prev;
102 struct _stack_el *next;
103};
104struct _stack {
105 struct _stack_el *tail;
106 struct _stack_el *cur_ptr;
107};
108
109static struct _stack_el *
vlmb33ed682004-09-24 20:57:41 +0000110OS__add_stack_el(struct _stack *st) {
vlmfa67ddc2004-06-03 03:38:44 +0000111 struct _stack_el *nel;
112
vlm72425de2004-09-13 08:31:01 +0000113 /*
114 * Reuse the old stack frame or allocate a new one.
115 */
vlmfa67ddc2004-06-03 03:38:44 +0000116 if(st->cur_ptr && st->cur_ptr->next) {
117 nel = st->cur_ptr->next;
vlmfa67ddc2004-06-03 03:38:44 +0000118 nel->bits_chopped = 0;
vlmdb6b2902004-09-27 20:54:06 +0000119 nel->got = 0;
120 /* Retain the nel->cont_level, it's correct. */
vlmfa67ddc2004-06-03 03:38:44 +0000121 } else {
vlmda674682004-08-11 09:07:36 +0000122 (void *)nel = CALLOC(1, sizeof(struct _stack_el));
vlmfa67ddc2004-06-03 03:38:44 +0000123 if(nel == NULL)
124 return NULL;
125
126 if(st->tail) {
vlm72425de2004-09-13 08:31:01 +0000127 /* Increase a subcontainment depth */
128 nel->cont_level = st->tail->cont_level + 1;
vlmfa67ddc2004-06-03 03:38:44 +0000129 st->tail->next = nel;
130 }
131 nel->prev = st->tail;
132 st->tail = nel;
133 }
134
135 st->cur_ptr = nel;
136
137 return nel;
138}
139
140static struct _stack *
141_new_stack() {
142 struct _stack *st;
vlmda674682004-08-11 09:07:36 +0000143 (void *)st = CALLOC(1, sizeof(struct _stack));
vlmfa67ddc2004-06-03 03:38:44 +0000144 if(st == NULL)
145 return NULL;
146
vlmfa67ddc2004-06-03 03:38:44 +0000147 return st;
148}
149
150/*
151 * Decode OCTET STRING type.
152 */
153ber_dec_rval_t
vlm7b75d982004-09-29 13:20:14 +0000154OCTET_STRING_decode_ber(asn_codec_ctx_t *opt_codec_ctx,
155 asn_TYPE_descriptor_t *td,
vlmfa67ddc2004-06-03 03:38:44 +0000156 void **os_structure, void *buf_ptr, size_t size, int tag_mode) {
vlmda674682004-08-11 09:07:36 +0000157 OCTET_STRING_t *st = (OCTET_STRING_t *)*os_structure;
vlmfa67ddc2004-06-03 03:38:44 +0000158 ber_dec_rval_t rval;
vlm7b75d982004-09-29 13:20:14 +0000159 asn_struct_ctx_t *ctx;
vlmfa67ddc2004-06-03 03:38:44 +0000160 ssize_t consumed_myself = 0;
161 struct _stack *stck; /* A stack structure */
vlmdb6b2902004-09-27 20:54:06 +0000162 struct _stack_el *sel = 0; /* Stack element */
vlmfa67ddc2004-06-03 03:38:44 +0000163 int tlv_constr;
vlm72425de2004-09-13 08:31:01 +0000164 enum type_type_e {
165 _TT_GENERIC = 0, /* Just a random OCTET STRING */
vlm6678cb12004-09-26 13:10:40 +0000166 _TT_BIT_STRING = 1, /* BIT STRING type, a special case */
167 _TT_ANY = 2, /* ANY type, a special case too */
168 } type_type = (enum type_type_e)(int)td->specifics;
vlmfa67ddc2004-06-03 03:38:44 +0000169
vlmef1b4c02004-09-23 22:06:26 +0000170 ASN_DEBUG("Decoding %s as %s (frame %ld)",
171 td->name,
172 (type_type == _TT_GENERIC) ? "OCTET STRING" : "OS-SpecialCase",
173 (long)size);
vlmfa67ddc2004-06-03 03:38:44 +0000174
175 /*
176 * Create the string if does not exist.
177 */
178 if(st == NULL) {
vlmda674682004-08-11 09:07:36 +0000179 (void *)st = *os_structure = CALLOC(1, sizeof(*st));
vlmfa67ddc2004-06-03 03:38:44 +0000180 if(st == NULL)
181 RETURN(RC_FAIL);
182 }
183
184 /* Restore parsing context */
vlm7b75d982004-09-29 13:20:14 +0000185 ctx = &st->_asn_ctx;
vlmfa67ddc2004-06-03 03:38:44 +0000186
187 switch(ctx->phase) {
188 case 0:
189 /*
190 * Check tags.
191 */
vlm7b75d982004-09-29 13:20:14 +0000192 rval = ber_check_tags(opt_codec_ctx, td, ctx,
vlm6678cb12004-09-26 13:10:40 +0000193 buf_ptr, size, tag_mode, -1,
vlmfa67ddc2004-06-03 03:38:44 +0000194 &ctx->left, &tlv_constr);
vlmd7c2ef32004-10-05 06:35:31 +0000195 if(rval.code != RC_OK)
196 return rval;
vlmfa67ddc2004-06-03 03:38:44 +0000197
vlmfa67ddc2004-06-03 03:38:44 +0000198 if(tlv_constr) {
199 /*
200 * Complex operation, requires stack of expectations.
201 */
202 ctx->ptr = _new_stack();
203 if(ctx->ptr) {
vlmda674682004-08-11 09:07:36 +0000204 (void *)stck = ctx->ptr;
vlm72425de2004-09-13 08:31:01 +0000205 if(type_type == _TT_BIT_STRING) {
vlmcdfdb722004-09-04 04:44:50 +0000206 /* Number of meaningless tail bits */
vlmfa67ddc2004-06-03 03:38:44 +0000207 APPEND("\0", 1);
208 }
209 } else {
210 RETURN(RC_FAIL);
211 }
212 } else {
213 /*
214 * Jump into stackless primitive decoding.
215 */
216 _CH_PHASE(ctx, 3);
vlm72425de2004-09-13 08:31:01 +0000217 if(type_type == _TT_ANY)
218 APPEND(buf_ptr, rval.consumed);
vlmfa67ddc2004-06-03 03:38:44 +0000219 ADVANCE(rval.consumed);
220 goto phase3;
221 }
222
vlmfa67ddc2004-06-03 03:38:44 +0000223 NEXT_PHASE(ctx);
224 /* Fall through */
225 case 1:
226 phase1:
227 /*
228 * Fill the stack with expectations.
229 */
vlmda674682004-08-11 09:07:36 +0000230 (void *)stck = ctx->ptr;
vlmfa67ddc2004-06-03 03:38:44 +0000231 sel = stck->cur_ptr;
232 do {
233 ber_tlv_tag_t tlv_tag;
234 ber_tlv_len_t tlv_len;
vlm72425de2004-09-13 08:31:01 +0000235 ber_tlv_tag_t expected_tag;
vlmdb6b2902004-09-27 20:54:06 +0000236 ssize_t tl, ll, tlvl;
vlm6678cb12004-09-26 13:10:40 +0000237 /* This one works even if (sel->left == -1) */
238 ssize_t Left = ((!sel||(size_t)sel->left >= size)
vlmdb6b2902004-09-27 20:54:06 +0000239 ?(ssize_t)size:sel->left);
vlmfa67ddc2004-06-03 03:38:44 +0000240
vlmb33ed682004-09-24 20:57:41 +0000241
vlmdb6b2902004-09-27 20:54:06 +0000242 ASN_DEBUG("%p, s->l=%d, s->wn=%d, s->g=%d\n", sel,
243 sel?sel->left:0,
244 sel?sel->want_nulls:0,
245 sel?sel->got:0
246 );
247 if(sel && sel->left <= 0 && sel->want_nulls == 0) {
248 if(sel->prev) {
249 struct _stack_el *prev = sel->prev;
250 if(prev->left != -1) {
251 if(prev->left < sel->got)
252 RETURN(RC_FAIL);
253 prev->left -= sel->got;
254 }
255 prev->got += sel->got;
256 sel = stck->cur_ptr = prev;
257 if(!sel) break;
258 tlv_constr = 1;
259 continue;
260 } else {
261 sel = stck->cur_ptr = 0;
262 break; /* Nothing to wait */
263 }
264 }
265
vlmb33ed682004-09-24 20:57:41 +0000266 tl = ber_fetch_tag(buf_ptr, Left, &tlv_tag);
vlmdb6b2902004-09-27 20:54:06 +0000267 ASN_DEBUG("fetch tag(size=%d,L=%d), %sstack, left=%d, wn=%d, tl=%d",
268 (int)size, Left, sel?"":"!",
269 sel?sel->left:0, sel?sel->want_nulls:0, tl);
vlmfa67ddc2004-06-03 03:38:44 +0000270 switch(tl) {
271 case -1: RETURN(RC_FAIL);
272 case 0: RETURN(RC_WMORE);
273 }
274
275 tlv_constr = BER_TLV_CONSTRUCTED(buf_ptr);
276
277 ll = ber_fetch_length(tlv_constr,
vlmb33ed682004-09-24 20:57:41 +0000278 (char *)buf_ptr + tl, Left - tl, &tlv_len);
vlmdb6b2902004-09-27 20:54:06 +0000279 ASN_DEBUG("Got tag=%s, tc=%d, left=%ld, tl=%d, len=%d, ll=%d",
vlmcdfdb722004-09-04 04:44:50 +0000280 ber_tlv_tag_string(tlv_tag), tlv_constr,
vlmdb6b2902004-09-27 20:54:06 +0000281 (long)Left, tl, tlv_len, ll);
vlmfa67ddc2004-06-03 03:38:44 +0000282 switch(ll) {
283 case -1: RETURN(RC_FAIL);
284 case 0: RETURN(RC_WMORE);
285 }
286
vlmcdfdb722004-09-04 04:44:50 +0000287 if(sel && sel->want_nulls
vlmfa67ddc2004-06-03 03:38:44 +0000288 && ((uint8_t *)buf_ptr)[0] == 0
289 && ((uint8_t *)buf_ptr)[1] == 0)
290 {
vlmcdfdb722004-09-04 04:44:50 +0000291
292 ASN_DEBUG("Eat EOC; wn=%d--", sel->want_nulls);
293
vlmdb6b2902004-09-27 20:54:06 +0000294 if(type_type == _TT_ANY) APPEND("\0\0", 2);
295
296 ADVANCE(2);
297 sel->got += 2;
298 if(sel->left != -1) {
299 sel->left -= 2; /* assert(sel->left >= 2) */
300 }
301
vlmfa67ddc2004-06-03 03:38:44 +0000302 sel->want_nulls--;
303 if(sel->want_nulls == 0) {
304 /* Move to the next expectation */
vlmdb6b2902004-09-27 20:54:06 +0000305 sel->left = 0;
vlmfa67ddc2004-06-03 03:38:44 +0000306 tlv_constr = 1;
vlmfa67ddc2004-06-03 03:38:44 +0000307 }
vlmcdfdb722004-09-04 04:44:50 +0000308
309 continue;
vlm72425de2004-09-13 08:31:01 +0000310 }
311
312 /*
313 * Set up expected tags,
314 * depending on ASN.1 type being decoded.
315 */
316 switch(type_type) {
317 case _TT_BIT_STRING:
318 /* X.690: 8.6.4.1, NOTE 2 */
319 /* Fall through */
320 case _TT_GENERIC:
321 default:
322 if(sel) {
323 int level = sel->cont_level;
324 if(level < td->all_tags_count) {
325 expected_tag = td->all_tags[level];
326 break;
327 } else if(td->all_tags_count) {
328 expected_tag = td->all_tags
329 [td->all_tags_count - 1];
330 break;
331 }
332 /* else, Fall through */
333 }
334 /* Fall through */
335 case _TT_ANY:
336 expected_tag = tlv_tag;
337 break;
338 }
339
340
341 if(tlv_tag != expected_tag) {
vlmfa67ddc2004-06-03 03:38:44 +0000342 char buf[2][32];
343 ber_tlv_tag_snprint(tlv_tag,
344 buf[0], sizeof(buf[0]));
345 ber_tlv_tag_snprint(td->tags[td->tags_count-1],
346 buf[1], sizeof(buf[1]));
347 ASN_DEBUG("Tag does not match expectation: %s != %s",
348 buf[0], buf[1]);
349 RETURN(RC_FAIL);
350 }
351
vlm7b75d982004-09-29 13:20:14 +0000352 tlvl = tl + ll; /* Combined length of T and L encoding */
353 if((tlv_len + tlvl) < 0) {
354 /* tlv_len value is too big */
355 ASN_DEBUG("TLV encoding + length (%ld) is too big",
356 (long)tlv_len);
357 RETURN(RC_FAIL);
358 }
359
vlmfa67ddc2004-06-03 03:38:44 +0000360 /*
361 * Append a new expectation.
362 */
vlmb33ed682004-09-24 20:57:41 +0000363 sel = OS__add_stack_el(stck);
vlmdb6b2902004-09-27 20:54:06 +0000364 if(!sel) RETURN(RC_FAIL);
vlmfa67ddc2004-06-03 03:38:44 +0000365
vlmdb6b2902004-09-27 20:54:06 +0000366 sel->tag = tlv_tag;
367
368 sel->want_nulls = (tlv_len==-1);
369 if(sel->prev && sel->prev->left != -1) {
370 /* Check that the parent frame is big enough */
371 if(sel->prev->left < tlvl + (tlv_len==-1?0:tlv_len))
372 RETURN(RC_FAIL);
373 if(tlv_len == -1)
374 sel->left = sel->prev->left - tlvl;
375 else
376 sel->left = tlv_len;
377 } else {
378 sel->left = tlv_len;
379 }
380 if(type_type == _TT_ANY) APPEND(buf_ptr, tlvl);
381 sel->got += tlvl;
382 ADVANCE(tlvl);
383
384 ASN_DEBUG("+EXPECT2 got=%d left=%d, wn=%d, clvl=%d",
385 sel->got, sel->left, sel->want_nulls, sel->cont_level);
386
vlmfa67ddc2004-06-03 03:38:44 +0000387 } while(tlv_constr);
388 if(sel == NULL) {
389 /* Finished operation, "phase out" */
vlm72425de2004-09-13 08:31:01 +0000390 ASN_DEBUG("Phase out");
vlmfa67ddc2004-06-03 03:38:44 +0000391 _CH_PHASE(ctx, +3);
392 break;
393 }
394
395 NEXT_PHASE(ctx);
396 /* Fall through */
397 case 2:
vlmda674682004-08-11 09:07:36 +0000398 (void *)stck = ctx->ptr;
vlmfa67ddc2004-06-03 03:38:44 +0000399 sel = stck->cur_ptr;
vlmdb6b2902004-09-27 20:54:06 +0000400 ASN_DEBUG("Phase 2: Need %ld bytes, size=%ld, alrg=%ld, wn=%d",
401 (long)sel->left, (long)size, (long)sel->got,
402 sel->want_nulls);
vlmfa67ddc2004-06-03 03:38:44 +0000403 {
404 ber_tlv_len_t len;
405
406 assert(sel->left >= 0);
407
vlmc5190612004-08-18 04:53:32 +0000408 len = ((ber_tlv_len_t)size < sel->left)
409 ? (ber_tlv_len_t)size : sel->left;
vlmfa67ddc2004-06-03 03:38:44 +0000410 if(len > 0) {
vlm72425de2004-09-13 08:31:01 +0000411 if(type_type == _TT_BIT_STRING
412 && sel->bits_chopped == 0) {
vlmfa67ddc2004-06-03 03:38:44 +0000413 /*
414 * Finalize the previous chunk:
415 * strip down unused bits.
416 */
417 st->buf[st->size-1] &= 0xff << st->buf[0];
418
vlm1ff928d2004-08-11 08:10:13 +0000419 APPEND(((char *)buf_ptr+1), (len - 1));
vlmfa67ddc2004-06-03 03:38:44 +0000420 st->buf[0] = *(uint8_t *)buf_ptr;
421 sel->bits_chopped = 1;
422 } else {
423 APPEND(buf_ptr, len);
424 }
425 ADVANCE(len);
426 sel->left -= len;
vlmdb6b2902004-09-27 20:54:06 +0000427 sel->got += len;
vlmfa67ddc2004-06-03 03:38:44 +0000428 }
429
vlmdb6b2902004-09-27 20:54:06 +0000430 if(sel->left) {
431 ASN_DEBUG("OS left %ld, size = %ld, wn=%d\n",
432 (long)sel->left, (long)size, sel->want_nulls);
vlmfa67ddc2004-06-03 03:38:44 +0000433 RETURN(RC_WMORE);
vlmfa67ddc2004-06-03 03:38:44 +0000434 }
vlmdb6b2902004-09-27 20:54:06 +0000435
436 PREV_PHASE(ctx);
437 goto phase1;
vlmfa67ddc2004-06-03 03:38:44 +0000438 }
439 break;
440 case 3:
441 phase3:
442 /*
443 * Primitive form, no stack required.
444 */
vlmb42843a2004-06-05 08:17:50 +0000445 if(size < (size_t)ctx->left) {
vlmfa67ddc2004-06-03 03:38:44 +0000446 APPEND(buf_ptr, size);
447 ctx->left -= size;
448 ADVANCE(size);
449 RETURN(RC_WMORE);
450 } else {
451 APPEND(buf_ptr, ctx->left);
452 ADVANCE(ctx->left);
453 ctx->left = 0;
454
455 NEXT_PHASE(ctx);
456 }
457 break;
458 }
459
vlmdb6b2902004-09-27 20:54:06 +0000460 if(sel) {
461 ASN_DEBUG("3sel p=%p, wn=%d, l=%ld, g=%ld, size=%ld",
462 sel->prev, sel->want_nulls,
463 (long)sel->left, (long)sel->got, (long)size);
464 if(sel->prev || sel->want_nulls > 1 || sel->left > 0) {
465 RETURN(RC_WMORE);
466 }
467 }
468
vlmfa67ddc2004-06-03 03:38:44 +0000469 /*
470 * BIT STRING-specific processing.
471 */
vlm72425de2004-09-13 08:31:01 +0000472 if(type_type == _TT_BIT_STRING && st->size >= 2) {
vlmfa67ddc2004-06-03 03:38:44 +0000473 /* Finalize BIT STRING: zero out unused bits. */
474 st->buf[st->size-1] &= 0xff << st->buf[0];
475 }
476
477 ASN_DEBUG("Took %d bytes to encode %s: [%s]:%d",
vlmb33ed682004-09-24 20:57:41 +0000478 consumed_myself, td->name,
479 (type_type == _TT_GENERIC) ? (char *)st->buf : "", st->size);
vlmfa67ddc2004-06-03 03:38:44 +0000480
vlmfa67ddc2004-06-03 03:38:44 +0000481
vlmdb6b2902004-09-27 20:54:06 +0000482 RETURN(RC_OK);
vlmfa67ddc2004-06-03 03:38:44 +0000483}
484
485/*
486 * Encode OCTET STRING type using DER.
487 */
vlm39ba4c42004-09-22 16:06:28 +0000488asn_enc_rval_t
vlm7b75d982004-09-29 13:20:14 +0000489OCTET_STRING_encode_der(asn_TYPE_descriptor_t *td, void *ptr,
vlmfa67ddc2004-06-03 03:38:44 +0000490 int tag_mode, ber_tlv_tag_t tag,
491 asn_app_consume_bytes_f *cb, void *app_key) {
vlm39ba4c42004-09-22 16:06:28 +0000492 asn_enc_rval_t erval;
vlmda674682004-08-11 09:07:36 +0000493 OCTET_STRING_t *st = (OCTET_STRING_t *)ptr;
vlmfa67ddc2004-06-03 03:38:44 +0000494 int add_byte = 0;
vlm6678cb12004-09-26 13:10:40 +0000495 int is_bit_str = (td->specifics == (void *)1);
496 int is_ANY_type = (td->specifics == (void *)2);
vlmfa67ddc2004-06-03 03:38:44 +0000497
498 ASN_DEBUG("%s %s as OCTET STRING",
vlm3e693022004-09-02 12:57:25 +0000499 cb?"Estimating":"Encoding", td->name);
vlmfa67ddc2004-06-03 03:38:44 +0000500
501 /*
502 * Canonicalize BIT STRING.
503 */
vlm7e66aa82004-09-02 12:11:47 +0000504 if(is_bit_str && st->buf) {
vlmfa67ddc2004-06-03 03:38:44 +0000505 switch(st->size) {
506 case 0: add_byte = 1; break;
507 case 1: st->buf[0] = 0; break;
508 default:
509 /* Finalize BIT STRING: zero out unused bits. */
510 st->buf[st->size-1] &= 0xff << st->buf[0];
511 }
512 }
513
vlm7e66aa82004-09-02 12:11:47 +0000514 if(is_ANY_type) {
515 erval.encoded = 0;
516 } else {
vlm3e693022004-09-02 12:57:25 +0000517 erval.encoded = der_write_tags(td, st->size + add_byte,
vlm6678cb12004-09-26 13:10:40 +0000518 tag_mode, 0, tag, cb, app_key);
vlm7e66aa82004-09-02 12:11:47 +0000519 if(erval.encoded == -1) {
vlm3e693022004-09-02 12:57:25 +0000520 erval.failed_type = td;
vlm7e66aa82004-09-02 12:11:47 +0000521 erval.structure_ptr = ptr;
522 return erval;
523 }
vlmfa67ddc2004-06-03 03:38:44 +0000524 }
525
526 if(cb) {
527 uint8_t zero;
528 uint8_t *buf;
529 int size;
vlmfa67ddc2004-06-03 03:38:44 +0000530
531 /* BIT STRING-aware handling */
532 if(add_byte) {
533 zero = 0;
534 buf = &zero;
535 size = 1;
536 } else if(st->buf) {
537 buf = st->buf;
538 size = st->size;
539 } else {
540 assert(st->size == 0);
541 buf = 0; /* Not used */
542 size = 0;
543 }
544
545 if(size) {
vlm6678cb12004-09-26 13:10:40 +0000546 if(cb(buf, size, app_key) < 0) {
vlmfa67ddc2004-06-03 03:38:44 +0000547 erval.encoded = -1;
vlm3e693022004-09-02 12:57:25 +0000548 erval.failed_type = td;
vlmfa67ddc2004-06-03 03:38:44 +0000549 erval.structure_ptr = ptr;
550 return erval;
551 }
552 }
553 }
554
555 erval.encoded += st->size + add_byte;
556
557 return erval;
558}
559
vlm39ba4c42004-09-22 16:06:28 +0000560asn_enc_rval_t
vlm7b75d982004-09-29 13:20:14 +0000561OCTET_STRING_encode_xer(asn_TYPE_descriptor_t *td, void *sptr,
vlm39ba4c42004-09-22 16:06:28 +0000562 int ilevel, enum xer_encoder_flags_e flags,
563 asn_app_consume_bytes_f *cb, void *app_key) {
564 static const char *h2c = "0123456789ABCDEF";
565 const OCTET_STRING_t *st = (const OCTET_STRING_t *)sptr;
566 asn_enc_rval_t er;
567 char scratch[16 * 3 + 4];
568 char *p = scratch;
569 uint8_t *buf;
570 uint8_t *end;
571 size_t i;
572
vlm84d551b2004-10-03 09:13:02 +0000573 if(!st || !st->buf)
574 _ASN_ENCODE_FAILED;
vlm39ba4c42004-09-22 16:06:28 +0000575
576 er.encoded = 0;
577
578 /*
579 * Dump the contents of the buffer in hexadecimal.
580 */
581 buf = st->buf;
582 end = buf + st->size;
583 if(flags & XER_F_CANONICAL) {
584 char *scend = scratch + (sizeof(scratch) - 2);
585 for(; buf < end; buf++) {
586 if(p >= scend) {
587 _ASN_CALLBACK(scratch, p - scratch);
588 er.encoded += p - scratch;
589 p = scratch;
590 }
591 *p++ = h2c[(*buf >> 4) & 0x0F];
592 *p++ = h2c[*buf & 0x0F];
593 }
vlmef1b4c02004-09-23 22:06:26 +0000594
595 _ASN_CALLBACK(scratch, p-scratch); /* Dump the rest */
596 er.encoded += p - scratch;
vlm39ba4c42004-09-22 16:06:28 +0000597 } else {
598 for(i = 0; buf < end; buf++, i++) {
599 if(!(i % 16) && (i || st->size > 16)) {
600 _ASN_CALLBACK(scratch, p-scratch);
601 er.encoded += (p-scratch);
602 p = scratch;
603 _i_ASN_TEXT_INDENT(1, ilevel);
604 }
605 *p++ = h2c[(*buf >> 4) & 0x0F];
606 *p++ = h2c[*buf & 0x0F];
607 *p++ = 0x20;
608 }
vlmef1b4c02004-09-23 22:06:26 +0000609 if(p - scratch) {
610 p--; /* Remove the tail space */
611 _ASN_CALLBACK(scratch, p-scratch); /* Dump the rest */
612 er.encoded += p - scratch;
613 if(st->size > 16)
614 _i_ASN_TEXT_INDENT(1, ilevel-1);
615 }
vlm39ba4c42004-09-22 16:06:28 +0000616 }
617
vlm39ba4c42004-09-22 16:06:28 +0000618 return er;
vlm84d551b2004-10-03 09:13:02 +0000619cb_failed:
620 _ASN_ENCODE_FAILED;
vlm39ba4c42004-09-22 16:06:28 +0000621}
622
vlm393a57a2004-10-03 10:54:25 +0000623static struct OCTET_STRING__xer_escape_table_s {
624 char *string;
625 int size;
626} OCTET_STRING__xer_escape_table[] = {
627#define OSXET(s) { s, sizeof(s) - 1 }
628 OSXET("\074\156\165\154\057\076"), /* <nul/> */
629 OSXET("\074\163\157\150\057\076"), /* <soh/> */
630 OSXET("\074\163\164\170\057\076"), /* <stx/> */
631 OSXET("\074\145\164\170\057\076"), /* <etx/> */
632 OSXET("\074\145\157\164\057\076"), /* <eot/> */
633 OSXET("\074\145\156\161\057\076"), /* <enq/> */
634 OSXET("\074\141\143\153\057\076"), /* <ack/> */
635 OSXET("\074\142\145\154\057\076"), /* <bel/> */
636 OSXET("\074\142\163\057\076"), /* <bs/> */
637 OSXET("\011"), /* \t */
638 OSXET("\012"), /* \n */
639 OSXET("\074\166\164\057\076"), /* <vt/> */
640 OSXET("\074\146\146\057\076"), /* <ff/> */
641 OSXET("\015"), /* \r */
642 OSXET("\074\163\157\057\076"), /* <so/> */
643 OSXET("\074\163\151\057\076"), /* <si/> */
644 OSXET("\074\144\154\145\057\076"), /* <dle/> */
645 OSXET("\074\144\143\061\057\076"), /* <de1/> */
646 OSXET("\074\144\143\062\057\076"), /* <de2/> */
647 OSXET("\074\144\143\063\057\076"), /* <de3/> */
648 OSXET("\074\144\143\064\057\076"), /* <de4/> */
649 OSXET("\074\156\141\153\057\076"), /* <nak/> */
650 OSXET("\074\163\171\156\057\076"), /* <syn/> */
651 OSXET("\074\145\164\142\057\076"), /* <etb/> */
652 OSXET("\074\143\141\156\057\076"), /* <can/> */
653 OSXET("\074\145\155\057\076"), /* <em/> */
654 OSXET("\074\163\165\142\057\076"), /* <sub/> */
655 OSXET("\074\145\163\143\057\076"), /* <esc/> */
656 OSXET("\074\151\163\064\057\076"), /* <is4/> */
657 OSXET("\074\151\163\063\057\076"), /* <is3/> */
658 OSXET("\074\151\163\062\057\076"), /* <is2/> */
659 OSXET("\074\151\163\061\057\076"), /* <is1/> */
660 { 0, 0 }, /* " " */
661 { 0, 0 }, /* ! */
662 { 0, 0 }, /* \" */
663 { 0, 0 }, /* # */
664 { 0, 0 }, /* $ */
665 { 0, 0 }, /* % */
666 OSXET("\046\141\155\160\073"), /* &amp; */
667 { 0, 0 }, /* ' */
668 {0,0},{0,0},{0,0},{0,0},{0,0},{0,0},{0,0},{0,0}, /* ()*+,-./ */
669 {0,0},{0,0},{0,0},{0,0},{0,0},{0,0},{0,0},{0,0}, /* 01234567 */
670 {0,0},{0,0},{0,0},{0,0}, /* 89:; */
671 OSXET("\046\154\164\073"), /* &lt; */
672 { 0, 0 }, /* = */
673 OSXET("\046\147\164\073"), /* &gt; */
674};
675
vlm39ba4c42004-09-22 16:06:28 +0000676asn_enc_rval_t
vlm7b75d982004-09-29 13:20:14 +0000677OCTET_STRING_encode_xer_ascii(asn_TYPE_descriptor_t *td, void *sptr,
vlm39ba4c42004-09-22 16:06:28 +0000678 int ilevel, enum xer_encoder_flags_e flags,
679 asn_app_consume_bytes_f *cb, void *app_key) {
680 const OCTET_STRING_t *st = (const OCTET_STRING_t *)sptr;
681 asn_enc_rval_t er;
vlm393a57a2004-10-03 10:54:25 +0000682 uint8_t *buf, *end;
683 uint8_t *ss; /* Sequence start */
684 ssize_t encoded_len = 0;
vlm39ba4c42004-09-22 16:06:28 +0000685
686 (void)ilevel; /* Unused argument */
687 (void)flags; /* Unused argument */
688
689 if(!st || !st->buf)
690 _ASN_ENCODE_FAILED;
691
vlm393a57a2004-10-03 10:54:25 +0000692 buf = st->buf;
693 end = buf + st->size;
694 for(ss = buf; buf < end; buf++) {
vlmd7c2ef32004-10-05 06:35:31 +0000695 unsigned int ch = *buf;
vlm393a57a2004-10-03 10:54:25 +0000696 int s_len; /* Special encoding sequence length */
vlm39ba4c42004-09-22 16:06:28 +0000697
vlm393a57a2004-10-03 10:54:25 +0000698 /*
699 * Escape certain characters: X.680/11.15
700 */
701 if(ch < sizeof(OCTET_STRING__xer_escape_table)
702 /sizeof(OCTET_STRING__xer_escape_table[0])
703 && (s_len = OCTET_STRING__xer_escape_table[ch].size)) {
704 if(((buf - ss) && cb(ss, buf - ss, app_key) < 0)
705 || cb(OCTET_STRING__xer_escape_table[ch].string, s_len,
706 app_key) < 0)
707 _ASN_ENCODE_FAILED;
708 encoded_len += (buf - ss) + s_len;
709 ss = buf + 1;
710 }
711 }
712
713 encoded_len += (buf - ss);
714 if((buf - ss) && cb(ss, buf - ss, app_key) < 0)
715 _ASN_ENCODE_FAILED;
716
717 er.encoded = encoded_len;
vlm39ba4c42004-09-22 16:06:28 +0000718 return er;
719}
720
vlmfa67ddc2004-06-03 03:38:44 +0000721int
vlm7b75d982004-09-29 13:20:14 +0000722OCTET_STRING_print(asn_TYPE_descriptor_t *td, const void *sptr, int ilevel,
vlmfa67ddc2004-06-03 03:38:44 +0000723 asn_app_consume_bytes_f *cb, void *app_key) {
vlm1ff928d2004-08-11 08:10:13 +0000724 static const char *h2c = "0123456789ABCDEF";
vlmda674682004-08-11 09:07:36 +0000725 const OCTET_STRING_t *st = (const OCTET_STRING_t *)sptr;
vlmfa67ddc2004-06-03 03:38:44 +0000726 char scratch[16 * 3 + 4];
727 char *p = scratch;
728 uint8_t *buf;
729 uint8_t *end;
730 size_t i;
vlmfa67ddc2004-06-03 03:38:44 +0000731
vlmb42843a2004-06-05 08:17:50 +0000732 (void)td; /* Unused argument */
733
vlm6678cb12004-09-26 13:10:40 +0000734 if(!st || !st->buf) return (cb("<absent>", 8, app_key) < 0) ? -1 : 0;
vlmfa67ddc2004-06-03 03:38:44 +0000735
736 /*
737 * Dump the contents of the buffer in hexadecimal.
738 */
739 buf = st->buf;
740 end = buf + st->size;
741 for(i = 0; buf < end; buf++, i++) {
742 if(!(i % 16) && (i || st->size > 16)) {
vlm6678cb12004-09-26 13:10:40 +0000743 if(cb(scratch, p - scratch, app_key) < 0)
vlmfa67ddc2004-06-03 03:38:44 +0000744 return -1;
vlm6678cb12004-09-26 13:10:40 +0000745 _i_INDENT(1);
vlmfa67ddc2004-06-03 03:38:44 +0000746 p = scratch;
747 }
748 *p++ = h2c[(*buf >> 4) & 0x0F];
749 *p++ = h2c[*buf & 0x0F];
vlm39ba4c42004-09-22 16:06:28 +0000750 *p++ = 0x20;
vlmfa67ddc2004-06-03 03:38:44 +0000751 }
752
vlmef1b4c02004-09-23 22:06:26 +0000753 if(p > scratch) {
754 p--; /* Remove the tail space */
vlm6678cb12004-09-26 13:10:40 +0000755 if(cb(scratch, p - scratch, app_key) < 0)
vlmef1b4c02004-09-23 22:06:26 +0000756 return -1;
757 }
758
759 return 0;
vlmfa67ddc2004-06-03 03:38:44 +0000760}
761
762int
vlm7b75d982004-09-29 13:20:14 +0000763OCTET_STRING_print_ascii(asn_TYPE_descriptor_t *td, const void *sptr,
vlmfa67ddc2004-06-03 03:38:44 +0000764 int ilevel, asn_app_consume_bytes_f *cb, void *app_key) {
vlmda674682004-08-11 09:07:36 +0000765 const OCTET_STRING_t *st = (const OCTET_STRING_t *)sptr;
vlmfa67ddc2004-06-03 03:38:44 +0000766
vlmb42843a2004-06-05 08:17:50 +0000767 (void)td; /* Unused argument */
768 (void)ilevel; /* Unused argument */
769
vlmfa67ddc2004-06-03 03:38:44 +0000770 if(st && st->buf) {
vlm6678cb12004-09-26 13:10:40 +0000771 return (cb(st->buf, st->size, app_key) < 0) ? -1 : 0;
vlmfa67ddc2004-06-03 03:38:44 +0000772 } else {
vlm6678cb12004-09-26 13:10:40 +0000773 return (cb("<absent>", 8, app_key) < 0) ? -1 : 0;
vlmfa67ddc2004-06-03 03:38:44 +0000774 }
775}
776
777void
vlm7b75d982004-09-29 13:20:14 +0000778OCTET_STRING_free(asn_TYPE_descriptor_t *td, void *sptr, int contents_only) {
vlmda674682004-08-11 09:07:36 +0000779 OCTET_STRING_t *st = (OCTET_STRING_t *)sptr;
vlm7b75d982004-09-29 13:20:14 +0000780 struct _stack *stck = (struct _stack *)st->_asn_ctx.ptr;
vlmfa67ddc2004-06-03 03:38:44 +0000781
782 if(!td || !st)
783 return;
784
785 ASN_DEBUG("Freeing %s as OCTET STRING", td->name);
786
787 if(st->buf) {
788 FREEMEM(st->buf);
789 }
790
791 /*
792 * Remove decode-time stack.
793 */
794 if(stck) {
795 while(stck->tail) {
796 struct _stack_el *sel = stck->tail;
797 stck->tail = sel->prev;
798 FREEMEM(sel);
799 }
800 FREEMEM(stck);
801 }
802
803 if(!contents_only) {
804 FREEMEM(st);
805 }
806}
807
808/*
809 * Conversion routines.
810 */
811int
812OCTET_STRING_fromBuf(OCTET_STRING_t *st, const char *str, int len) {
813 void *buf;
814
815 if(st == 0 || (str == 0 && len)) {
816 errno = EINVAL;
817 return -1;
818 }
819
820 /*
821 * Clear the OCTET STRING.
822 */
823 if(str == NULL) {
824 if(st->buf)
825 FREEMEM(st->buf);
826 st->size = 0;
827 return 0;
828 }
829
830 /* Determine the original string size, if not explicitly given */
831 if(len < 0)
832 len = strlen(str);
833
834 /* Allocate and fill the memory */
835 buf = MALLOC(len + 1);
836 if(buf == NULL) {
837 return -1;
838 } else {
vlmda674682004-08-11 09:07:36 +0000839 st->buf = (uint8_t *)buf;
vlmfa67ddc2004-06-03 03:38:44 +0000840 st->size = len;
841 }
842
843 memcpy(buf, str, len);
844 st->buf[st->size] = '\0'; /* Couldn't use memcpy(len+1)! */
845
846 return 0;
847}
848
849OCTET_STRING_t *
850OCTET_STRING_new_fromBuf(const char *str, int len) {
851 OCTET_STRING_t *st;
852
vlmda674682004-08-11 09:07:36 +0000853 (void *)st = CALLOC(1, sizeof(*st));
vlmfa67ddc2004-06-03 03:38:44 +0000854 if(st && str && OCTET_STRING_fromBuf(st, str, len)) {
855 free(st);
856 st = NULL;
857 }
858
859 return st;
860}
861