ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Convert-BER-XS/XS.xs
Revision: 1.20
Committed: Sat Apr 20 17:04:35 2019 UTC (5 years, 1 month ago) by root
Branch: MAIN
Changes since 1.19: +25 -34 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 #include "EXTERN.h"
2 #include "perl.h"
3 #include "XSUB.h"
4
5 // C99 required!
6 // this is not just for comments, but also for
7 // integer constant semantics,
8 // sscanf format modifiers and more.
9
10 enum {
11 // ASN_TAG
12 ASN_BOOLEAN = 0x01,
13 ASN_INTEGER = 0x02,
14 ASN_BIT_STRING = 0x03,
15 ASN_OCTET_STRING = 0x04,
16 ASN_NULL = 0x05,
17 ASN_OBJECT_IDENTIFIER = 0x06,
18 ASN_OID = 0x06,
19 ASN_OBJECT_DESCRIPTOR = 0x07,
20 ASN_EXTERNAL = 0x08,
21 ASN_REAL = 0x09,
22 ASN_ENUMERATED = 0x0a,
23 ASN_EMBEDDED_PDV = 0x0b,
24 ASN_UTF8_STRING = 0x0c,
25 ASN_RELATIVE_OID = 0x0d,
26 ASN_SEQUENCE = 0x10,
27 ASN_SET = 0x11,
28 ASN_NUMERIC_STRING = 0x12,
29 ASN_PRINTABLE_STRING = 0x13,
30 ASN_TELETEX_STRING = 0x14,
31 ASN_T61_STRING = 0x14,
32 ASN_VIDEOTEX_STRING = 0x15,
33 ASN_IA5_STRING = 0x16,
34 ASN_ASCII_STRING = 0x16,
35 ASN_UTC_TIME = 0x17,
36 ASN_GENERALIZED_TIME = 0x18,
37 ASN_GRAPHIC_STRING = 0x19,
38 ASN_VISIBLE_STRING = 0x1a,
39 ASN_ISO646_STRING = 0x1a,
40 ASN_GENERAL_STRING = 0x1b,
41 ASN_UNIVERSAL_STRING = 0x1c,
42 ASN_CHARACTER_STRING = 0x1d,
43 ASN_BMP_STRING = 0x1e,
44
45 ASN_TAG_BER = 0x1f,
46 ASN_TAG_MASK = 0x1f,
47
48 // primitive/constructed
49 ASN_CONSTRUCTED = 0x20,
50
51 // ASN_CLASS
52 ASN_UNIVERSAL = 0x00,
53 ASN_APPLICATION = 0x01,
54 ASN_CONTEXT = 0x02,
55 ASN_PRIVATE = 0x03,
56
57 ASN_CLASS_MASK = 0xc0,
58 ASN_CLASS_SHIFT = 6,
59
60 // ASN_APPLICATION SNMP
61 SNMP_IPADDRESS = 0x00,
62 SNMP_COUNTER32 = 0x01,
63 SNMP_UNSIGNED32 = 0x02,
64 SNMP_TIMETICKS = 0x03,
65 SNMP_OPAQUE = 0x04,
66 SNMP_COUNTER64 = 0x06,
67 };
68
69 enum {
70 BER_TYPE_BYTES,
71 BER_TYPE_UTF8,
72 BER_TYPE_UCS2,
73 BER_TYPE_UCS4,
74 BER_TYPE_INT,
75 BER_TYPE_OID,
76 BER_TYPE_RELOID,
77 BER_TYPE_NULL,
78 BER_TYPE_BOOL,
79 BER_TYPE_REAL,
80 BER_TYPE_IPADDRESS,
81 BER_TYPE_CROAK,
82 };
83
84 enum {
85 BER_CLASS = 0,
86 BER_TAG = 1,
87 BER_FLAGS = 2,
88 BER_DATA = 3,
89 BER_ARRAYSIZE
90 };
91
92 #define MAX_OID_STRLEN 4096
93
94 typedef void profile_type;
95
96 static profile_type *cur_profile, *default_profile;
97 static SV *buf_sv; // encoding buffer
98 static U8 *buf, *cur, *end; // buffer start, current, end
99
100 #if PERL_VERSION < 18
101 # define utf8_to_uvchr_buf(s,e,l) utf8_to_uvchr (s, l)
102 #endif
103
104 #if __GNUC__ >= 3
105 # define expect(expr,value) __builtin_expect ((expr), (value))
106 # define INLINE static inline
107 #else
108 # define expect(expr,value) (expr)
109 # define INLINE static
110 #endif
111
112 #define expect_false(expr) expect ((expr) != 0, 0)
113 #define expect_true(expr) expect ((expr) != 0, 1)
114
115 /////////////////////////////////////////////////////////////////////////////
116
117 static SV *sviv_cache[32];
118
119 // for "small" integers, return a readonly sv, otherwise create a new one
120 static SV *newSVcacheint (int val)
121 {
122 if (expect_false (val < 0 || val >= sizeof (sviv_cache)))
123 return newSViv (val);
124
125 if (expect_false (!sviv_cache [val]))
126 {
127 sviv_cache [val] = newSVuv (val);
128 SvREADONLY_on (sviv_cache [val]);
129 }
130
131 return SvREFCNT_inc_NN (sviv_cache [val]);
132 }
133
134 /////////////////////////////////////////////////////////////////////////////
135
136 static HV *profile_stash;
137
138 static profile_type *
139 SvPROFILE (SV *profile)
140 {
141 if (!SvOK (profile))
142 return default_profile;
143
144 if (!SvROK (profile))
145 croak ("invalid profile");
146
147 profile = SvRV (profile);
148
149 if (SvSTASH (profile) != profile_stash)
150 croak ("invalid profile object");
151
152 return (void *)profile;
153 }
154
155 static int
156 profile_lookup (profile_type *profile, int klass, int tag)
157 {
158 SV *sv = (SV *)profile;
159 U32 idx = (tag << 2) + klass;
160
161 if (expect_false (idx >= SvCUR (sv)))
162 return BER_TYPE_BYTES;
163
164 return SvPVX (sv)[idx];
165 }
166
167 static void
168 profile_set (profile_type *profile, int klass, int tag, int type)
169 {
170 SV *sv = (SV *)profile;
171 U32 idx = (tag << 2) + klass;
172 STRLEN oldlen = SvCUR (sv);
173 STRLEN newlen = idx + 2;
174
175 if (idx >= oldlen)
176 {
177 sv_grow (sv, newlen);
178 memset (SvPVX (sv) + oldlen, BER_TYPE_BYTES, newlen - oldlen);
179 SvCUR_set (sv, newlen);
180 }
181
182 SvPVX (sv)[idx] = type;
183 }
184
185 static SV *
186 profile_new (void)
187 {
188 SV *sv = newSVpvn ("", 0);
189
190 static const struct {
191 int klass;
192 int tag;
193 int type;
194 } *celem, default_map[] = {
195 { ASN_UNIVERSAL, ASN_BOOLEAN , BER_TYPE_BOOL },
196 { ASN_UNIVERSAL, ASN_INTEGER , BER_TYPE_INT },
197 { ASN_UNIVERSAL, ASN_NULL , BER_TYPE_NULL },
198 { ASN_UNIVERSAL, ASN_OBJECT_IDENTIFIER, BER_TYPE_OID },
199 { ASN_UNIVERSAL, ASN_RELATIVE_OID , BER_TYPE_RELOID },
200 { ASN_UNIVERSAL, ASN_REAL , BER_TYPE_REAL },
201 { ASN_UNIVERSAL, ASN_ENUMERATED , BER_TYPE_INT },
202 { ASN_UNIVERSAL, ASN_UTF8_STRING , BER_TYPE_UTF8 },
203 { ASN_UNIVERSAL, ASN_BMP_STRING , BER_TYPE_UCS2 },
204 { ASN_UNIVERSAL, ASN_UNIVERSAL_STRING , BER_TYPE_UCS4 },
205 };
206
207 for (celem = default_map + sizeof (default_map) / sizeof (default_map [0]); celem-- > default_map; )
208 profile_set ((profile_type *)sv, celem->klass, celem->tag, celem->type);
209
210 return sv_bless (newRV_noinc (sv), profile_stash);
211 }
212
213 /////////////////////////////////////////////////////////////////////////////
214 // decoder
215
216 static void
217 error (const char *errmsg)
218 {
219 croak ("%s at offset 0x%04x", errmsg, cur - buf);
220 }
221
222 static void
223 want (UV count)
224 {
225 if (expect_false ((uintptr_t)(end - cur) < count))
226 error ("unexpected end of message buffer");
227 }
228
229 // get_* functions fetch something from the buffer
230 // decode_* functions use get_* fun ctions to decode ber values
231
232 // get n octets
233 static U8 *
234 get_n (UV count)
235 {
236 want (count);
237 U8 *res = cur;
238 cur += count;
239 return res;
240 }
241
242 // get single octet
243 static U8
244 get_u8 (void)
245 {
246 if (cur == end)
247 error ("unexpected end of message buffer");
248
249 return *cur++;
250 }
251
252 // get ber-encoded integer (i.e. pack "w")
253 static UV
254 get_w (void)
255 {
256 UV res = 0;
257 U8 c = get_u8 ();
258
259 if (expect_false (c == 0x80))
260 error ("illegal BER padding (X.690 8.1.2.4.2, 8.19.2)");
261
262 for (;;)
263 {
264 res = (res << 7) | (c & 0x7f);
265
266 if (!(c & 0x80))
267 return res;
268
269 c = get_u8 ();
270 }
271 }
272
273 static UV
274 get_length (void)
275 {
276 UV res = get_u8 ();
277
278 if (res & 0x80)
279 {
280 int cnt = res & 0x7f;
281 res = 0;
282
283 switch (cnt)
284 {
285 case 0:
286 error ("indefinite ASN.1 lengths not supported");
287
288 case 0x7f:
289 error ("ASN.1 reserved value in length (X.690 8.1.3.5)");
290
291 default:
292 error ("ASN.1 length too long (only up to 2**64 octets supported)");
293
294 case 8: res = (res << 8) | get_u8 ();
295 case 7: res = (res << 8) | get_u8 ();
296 case 6: res = (res << 8) | get_u8 ();
297 case 5: res = (res << 8) | get_u8 ();
298 case 4: res = (res << 8) | get_u8 ();
299 case 3: res = (res << 8) | get_u8 ();
300 case 2: res = (res << 8) | get_u8 ();
301 case 1: res = (res << 8) | get_u8 ();
302 }
303 }
304
305 return res;
306 }
307
308 static SV *
309 decode_int (void)
310 {
311 UV len = get_length ();
312
313 if (!len)
314 error ("invalid integer length equal to zero (X.690 8.3.1)");
315
316 U8 *data = get_n (len);
317
318 if (expect_false (len > 1))
319 {
320 U16 mask = (data [0] << 8) | data [1] & 0xff80;
321
322 if (expect_false (mask == 0xff80 || mask == 0x0000))
323 error ("illegal padding in integer (X.690 8.3.2)");
324 }
325
326 int negative = data [0] & 0x80;
327
328 UV val = negative ? -1 : 0; // copy signbit to all bits
329
330 do
331 val = (val << 8) | *data++;
332 while (--len);
333
334 // the cast to IV relies on implementation-defined behaviour (two's complement cast)
335 // but that's ok, as perl relies on it as well.
336 return negative ? newSViv ((IV)val) : newSVuv (val);
337 }
338
339 static SV *
340 decode_data (void)
341 {
342 UV len = get_length ();
343 return newSVpvn ((char *)get_n (len), len);
344 }
345
346 // helper for decode_object_identifier
347 static char *
348 write_uv (char *buf, UV u)
349 {
350 // the one-digit case is absolutely predominant, so this pays off (hopefully)
351 if (expect_true (u < 10))
352 *buf++ = u + '0';
353 else
354 {
355 // this *could* be done much faster using branchless fixed-point arithmetics
356 char *beg = buf;
357
358 do
359 {
360 *buf++ = u % 10 + '0';
361 u /= 10;
362 }
363 while (u);
364
365 // reverse digits
366 char *ptr = buf;
367 while (--ptr > beg)
368 {
369 char c = *ptr;
370 *ptr = *beg;
371 *beg = c;
372 ++beg;
373 }
374 }
375
376 return buf;
377 }
378
379 static SV *
380 decode_oid (int relative)
381 {
382 UV len = get_length ();
383
384 if (len <= 0)
385 {
386 error ("OBJECT IDENTIFIER length equal to zero");
387 return &PL_sv_undef;
388 }
389
390 U8 *end = cur + len;
391 UV w = get_w ();
392
393 static char oid[MAX_OID_STRLEN]; // static, becaueds too large for stack
394 char *app = oid;
395
396 if (relative)
397 app = write_uv (app, w);
398 else if (w < 2 * 40)
399 {
400 app = write_uv (app, (U8)w / 40);
401 *app++ = '.';
402 app = write_uv (app, (U8)w % 40);
403 }
404 else
405 {
406 app = write_uv (app, 2);
407 *app++ = '.';
408 app = write_uv (app, w - 2 * 40);
409 }
410
411 while (cur < end)
412 {
413 // we assume an oid component is never > 64 digits
414 if (oid + sizeof (oid) - app < 64)
415 croak ("BER_TYPE_OID to long to decode");
416
417 w = get_w ();
418 *app++ = '.';
419 app = write_uv (app, w);
420 }
421
422 return newSVpvn (oid, app - oid);
423 }
424
425 // TODO: this is unacceptably slow
426 static SV *
427 decode_ucs (int chrsize)
428 {
429 SV *res = NEWSV (0, 0);
430
431 UV len = get_length ();
432
433 if (len & (chrsize - 1))
434 croak ("BER_TYPE_UCS has an invalid number of octets (%d)", len);
435
436 while (len)
437 {
438 U8 b1 = get_u8 ();
439 U8 b2 = get_u8 ();
440 U32 chr = (b1 << 8) | b2;
441
442 if (chrsize == 4)
443 {
444 U8 b3 = get_u8 ();
445 U8 b4 = get_u8 ();
446 chr = (chr << 16) | (b3 << 8) | b4;
447 }
448
449 U8 uchr [UTF8_MAXBYTES];
450 int uclen = uvuni_to_utf8 (uchr, chr) - uchr;
451
452 sv_catpvn (res, (const char *)uchr, uclen);
453 len -= chrsize;
454 }
455
456 SvUTF8_on (res);
457
458 return res;
459 }
460
461 static SV *
462 decode_ber (void)
463 {
464 int identifier = get_u8 ();
465
466 SV *res;
467
468 int constructed = identifier & ASN_CONSTRUCTED;
469 int klass = (identifier & ASN_CLASS_MASK) >> ASN_CLASS_SHIFT;
470 int tag = identifier & ASN_TAG_MASK;
471
472 if (tag == ASN_TAG_BER)
473 tag = get_w ();
474
475 if (constructed)
476 {
477 UV len = get_length ();
478 UV seqend = (cur - buf) + len;
479 AV *av = (AV *)sv_2mortal ((SV *)newAV ());
480
481 while (cur < buf + seqend)
482 av_push (av, decode_ber ());
483
484 if (cur > buf + seqend)
485 croak ("constructed type %02x length overflow (0x%x 0x%x)\n", identifier, (int)(cur - buf), (int)seqend);
486
487 res = newRV_inc ((SV *)av);
488 }
489 else
490 switch (profile_lookup (cur_profile, klass, tag))
491 {
492 case BER_TYPE_NULL:
493 {
494 UV len = get_length ();
495
496 if (len)
497 croak ("BER_TYPE_NULL value with non-zero length %d encountered (X.690 8.8.2)", len);
498
499 res = &PL_sv_undef;
500 }
501 break;
502
503 case BER_TYPE_BOOL:
504 {
505 UV len = get_length ();
506
507 if (len != 1)
508 croak ("BER_TYPE_BOOLEAN value with invalid length %d encountered (X.690 8.2.1)", len);
509
510 res = newSVcacheint (!!get_u8 ());
511 }
512 break;
513
514 case BER_TYPE_OID:
515 res = decode_oid (0);
516 break;
517
518 case BER_TYPE_RELOID:
519 res = decode_oid (1);
520 break;
521
522 case BER_TYPE_INT:
523 res = decode_int ();
524 break;
525
526 case BER_TYPE_UTF8:
527 res = decode_data ();
528 SvUTF8_on (res);
529 break;
530
531 case BER_TYPE_BYTES:
532 res = decode_data ();
533 break;
534
535 case BER_TYPE_IPADDRESS:
536 {
537 UV len = get_length ();
538
539 if (len != 4)
540 croak ("BER_TYPE_IPADDRESS type with invalid length %d encountered (RFC 2578 7.1.5)", len);
541
542 U8 c1 = get_u8 ();
543 U8 c2 = get_u8 ();
544 U8 c3 = get_u8 ();
545 U8 c4 = get_u8 ();
546
547 res = newSVpvf ("%d.%d.%d.%d", c1, c2, c3, c4);
548 }
549 break;
550
551 case BER_TYPE_UCS2:
552 res = decode_ucs (2);
553 break;
554
555 case BER_TYPE_UCS4:
556 res = decode_ucs (4);
557 break;
558
559 case BER_TYPE_REAL:
560 case BER_TYPE_CROAK:
561 default:
562 croak ("unconfigured/unsupported class/tag %d/%d", klass, tag);
563 }
564
565 AV *av = newAV ();
566 av_fill (av, BER_ARRAYSIZE - 1);
567 AvARRAY (av)[BER_CLASS] = newSVcacheint (klass);
568 AvARRAY (av)[BER_TAG ] = newSVcacheint (tag);
569 AvARRAY (av)[BER_FLAGS] = newSVcacheint (constructed ? 1 : 0);
570 AvARRAY (av)[BER_DATA ] = res;
571
572 return newRV_noinc ((SV *)av);
573 }
574
575 /////////////////////////////////////////////////////////////////////////////
576 // encoder
577
578 /* adds two STRLENs together, slow, and with paranoia */
579 static STRLEN
580 strlen_sum (STRLEN l1, STRLEN l2)
581 {
582 size_t sum = l1 + l2;
583
584 if (sum < (size_t)l2 || sum != (size_t)(STRLEN)sum)
585 croak ("Convert::BER::XS: string size overflow");
586
587 return sum;
588 }
589
590 static void
591 set_buf (SV *sv)
592 {
593 STRLEN len;
594 buf_sv = sv;
595 buf = (U8 *)SvPVbyte (buf_sv, len);
596 cur = buf;
597 end = buf + len;
598 }
599
600 /* similar to SvGROW, but somewhat safer and guarantees exponential realloc strategy */
601 static char *
602 my_sv_grow (SV *sv, size_t len1, size_t len2)
603 {
604 len1 = strlen_sum (len1, len2);
605 len1 = strlen_sum (len1, len1 >> 1);
606
607 if (len1 > 4096 - 24)
608 len1 = (len1 | 4095) - 24;
609
610 return SvGROW (sv, len1);
611 }
612
613 static void
614 need (STRLEN len)
615 {
616 if (expect_false ((uintptr_t)(end - cur) < len))
617 {
618 STRLEN pos = cur - buf;
619 buf = (U8 *)my_sv_grow (buf_sv, pos, len);
620 cur = buf + pos;
621 end = buf + SvLEN (buf_sv) - 1;
622 }
623 }
624
625 static void
626 put_u8 (int val)
627 {
628 need (1);
629 *cur++ = val;
630 }
631
632 static void
633 put_w_nocheck (UV val)
634 {
635 #if UVSIZE > 4
636 *cur = (val >> 7 * 9) | 0x80; cur += val >= ((UV)1 << (7 * 9));
637 *cur = (val >> 7 * 8) | 0x80; cur += val >= ((UV)1 << (7 * 8));
638 *cur = (val >> 7 * 7) | 0x80; cur += val >= ((UV)1 << (7 * 7));
639 *cur = (val >> 7 * 6) | 0x80; cur += val >= ((UV)1 << (7 * 6));
640 *cur = (val >> 7 * 5) | 0x80; cur += val >= ((UV)1 << (7 * 5));
641 #endif
642 *cur = (val >> 7 * 4) | 0x80; cur += val >= ((UV)1 << (7 * 4));
643 *cur = (val >> 7 * 3) | 0x80; cur += val >= ((UV)1 << (7 * 3));
644 *cur = (val >> 7 * 2) | 0x80; cur += val >= ((UV)1 << (7 * 2));
645 *cur = (val >> 7 * 1) | 0x80; cur += val >= ((UV)1 << (7 * 1));
646 *cur = val & 0x7f; cur += 1;
647 }
648
649 static void
650 put_w (UV val)
651 {
652 need (5); // we only handle up to 5 bytes
653
654 put_w_nocheck (val);
655 }
656
657 static U8 *
658 put_length_at (UV val, U8 *cur)
659 {
660 if (val < 0x7fU)
661 *cur++ = val;
662 else
663 {
664 U8 *lenb = cur++;
665
666 #if UVSIZE > 4
667 *cur = val >> 56; cur += *cur > 0;
668 *cur = val >> 48; cur += *cur > 0;
669 *cur = val >> 40; cur += *cur > 0;
670 *cur = val >> 32; cur += *cur > 0;
671 #endif
672 *cur = val >> 24; cur += *cur > 0;
673 *cur = val >> 16; cur += *cur > 0;
674 *cur = val >> 8; cur += *cur > 0;
675 *cur = val ; cur += 1;
676
677 *lenb = 0x80 + cur - lenb - 1;
678 }
679
680 return cur;
681 }
682
683 static void
684 put_length (UV val)
685 {
686 need (5 + val);
687 cur = put_length_at (val, cur);
688 }
689
690 // return how many bytes the encoded length requires
691 static int length_length (UV val)
692 {
693 return val < 0x7fU
694 ? 1
695 : 2
696 + (val > 0xffU)
697 + (val > 0xffffU)
698 + (val > 0xffffffU)
699 #if UVSIZE > 4
700 + (val > 0xffffffffU)
701 + (val > 0xffffffffffU)
702 + (val > 0xffffffffffffU)
703 + (val > 0xffffffffffffffU)
704 #endif
705 ;
706 }
707
708 static void
709 encode_data (const char *ptr, STRLEN len)
710 {
711 put_length (len);
712 memcpy (cur, ptr, len);
713 cur += len;
714 }
715
716 static void
717 encode_uv (UV uv)
718 {
719 }
720
721 static void
722 encode_int (SV *sv)
723 {
724 need (8 + 1 + 1); // 64 bit + length + extra 0
725
726 if (expect_false (!SvIOK (sv)))
727 sv_2iv_flags (sv, 0);
728
729 U8 *lenb = cur++;
730
731 if (SvIOK_notUV (sv))
732 {
733 IV iv = SvIVX (sv);
734
735 if (expect_false (iv < 0))
736 {
737 // get two's complement bit pattern - works even on hypothetical non-2c machines
738 UV uv = iv;
739
740 #if UVSIZE > 4
741 *cur = uv >> 56; cur += !!(~uv & 0xff80000000000000U);
742 *cur = uv >> 48; cur += !!(~uv & 0xffff800000000000U);
743 *cur = uv >> 40; cur += !!(~uv & 0xffffff8000000000U);
744 *cur = uv >> 32; cur += !!(~uv & 0xffffffff80000000U);
745 #endif
746 *cur = uv >> 24; cur += !!(~uv & 0xffffffffff800000U);
747 *cur = uv >> 16; cur += !!(~uv & 0xffffffffffff8000U);
748 *cur = uv >> 8; cur += !!(~uv & 0xffffffffffffff80U);
749 *cur = uv ; cur += 1;
750
751 *lenb = cur - lenb - 1;
752
753 return;
754 }
755 }
756
757 UV uv = SvUV (sv);
758
759 // prepend an extra 0 if the high bit is 1
760 *cur = 0; cur += !!(uv & ((UV)1 << (UVSIZE * 8 - 1)));
761
762 #if UVSIZE > 4
763 *cur = uv >> 56; cur += !!(uv & 0xff80000000000000U);
764 *cur = uv >> 48; cur += !!(uv & 0xffff800000000000U);
765 *cur = uv >> 40; cur += !!(uv & 0xffffff8000000000U);
766 *cur = uv >> 32; cur += !!(uv & 0xffffffff80000000U);
767 #endif
768 *cur = uv >> 24; cur += !!(uv & 0xffffffffff800000U);
769 *cur = uv >> 16; cur += !!(uv & 0xffffffffffff8000U);
770 *cur = uv >> 8; cur += !!(uv & 0xffffffffffffff80U);
771 *cur = uv ; cur += 1;
772
773 *lenb = cur - lenb - 1;
774 }
775
776 // we don't know the length yet, so we optimistically
777 // assume the length will need one octet later. If that
778 // turns out to be wrong, we memmove as needed.
779 // mark the beginning
780 static STRLEN
781 len_fixup_mark (void)
782 {
783 return cur++ - buf;
784 }
785
786 // patch up the length
787 static void
788 len_fixup (STRLEN mark)
789 {
790 STRLEN reallen = (cur - buf) - mark - 1;
791 int lenlen = length_length (reallen);
792
793 if (expect_false (lenlen > 1))
794 {
795 // bad luck, we have to shift the bytes to make room for the length
796 need (5);
797 memmove (buf + mark + lenlen, buf + mark + 1, reallen);
798 cur += lenlen - 1;
799 }
800
801 put_length_at (reallen, buf + mark);
802 }
803
804 static char *
805 read_uv (char *str, UV *uv)
806 {
807 UV r = 0;
808
809 while (*str >= '0')
810 r = r * 10 + *str++ - '0';
811
812 *uv = r;
813
814 str += !!*str; // advance over any non-zero byte
815
816 return str;
817 }
818
819 static void
820 encode_oid (SV *oid, int relative)
821 {
822 STRLEN len;
823 char *ptr = SvPV (oid, len); // utf8 vs. bytes does not matter
824
825 // we need at most as many octets as the string form
826 need (len + 1);
827 STRLEN mark = len_fixup_mark ();
828
829 UV w1, w2;
830
831 if (!relative)
832 {
833 ptr = read_uv (ptr, &w1);
834 ptr = read_uv (ptr, &w2);
835
836 put_w_nocheck (w1 * 40 + w2);
837 }
838
839 while (*ptr)
840 {
841 ptr = read_uv (ptr, &w1);
842 put_w_nocheck (w1);
843 }
844
845 len_fixup (mark);
846 }
847
848 // check whether an SV is a BER tuple and returns its AV *
849 static AV *
850 ber_tuple (SV *tuple)
851 {
852 SV *rv;
853
854 if (expect_false (!SvROK (tuple) || SvTYPE ((rv = SvRV (tuple))) != SVt_PVAV))
855 croak ("BER tuple must be array-reference");
856
857 if (expect_false (SvRMAGICAL (rv)))
858 croak ("BER tuple must not be tied");
859
860 if (expect_false (AvFILL ((AV *)rv) != BER_ARRAYSIZE - 1))
861 croak ("BER tuple must contain exactly %d elements, not %d", BER_ARRAYSIZE, AvFILL ((AV *)rv) + 1);
862
863 return (AV *)rv;
864 }
865
866 static void
867 encode_ucs (SV *data, int chrsize)
868 {
869 STRLEN uchars = sv_len_utf8 (data);
870 STRLEN len;;
871 char *ptr = SvPVutf8 (data, len);
872
873 put_length (uchars * chrsize);
874
875 while (uchars--)
876 {
877 STRLEN uclen;
878 UV uchr = utf8_to_uvchr_buf ((U8 *)ptr, (U8 *)ptr + len, &uclen);
879
880 ptr += uclen;
881 len -= uclen;
882
883 if (chrsize == 4)
884 {
885 *cur++ = uchr >> 24;
886 *cur++ = uchr >> 16;
887 }
888
889 *cur++ = uchr >> 8;
890 *cur++ = uchr;
891 }
892 }
893 static void
894 encode_ber (SV *tuple)
895 {
896 AV *av = ber_tuple (tuple);
897
898 int klass = SvIV (AvARRAY (av)[BER_CLASS]);
899 int tag = SvIV (AvARRAY (av)[BER_TAG]);
900 int constructed = SvIV (AvARRAY (av)[BER_FLAGS]) & 1 ? ASN_CONSTRUCTED : 0;
901 SV *data = AvARRAY (av)[BER_DATA];
902
903 int identifier = (klass << ASN_CLASS_SHIFT) | constructed;
904
905 if (expect_false (tag >= ASN_TAG_BER))
906 {
907 put_u8 (identifier | ASN_TAG_BER);
908 put_w (tag);
909 }
910 else
911 put_u8 (identifier | tag);
912
913 if (constructed)
914 {
915 // we optimistically assume that only one length byte is needed
916 // and adjust later
917 need (1);
918 STRLEN mark = len_fixup_mark ();
919
920 if (expect_false (!SvROK (data) || SvTYPE (SvRV (data)) != SVt_PVAV))
921 croak ("BER constructed data must be array-reference");
922
923 AV *av = (AV *)SvRV (data);
924 int fill = AvFILL (av);
925
926 if (expect_false (SvRMAGICAL (av)))
927 croak ("BER constructed data must not be tied");
928
929 int i;
930 for (i = 0; i <= fill; ++i)
931 encode_ber (AvARRAY (av)[i]);
932
933 len_fixup (mark);
934 }
935 else
936 switch (profile_lookup (cur_profile, klass, tag))
937 {
938 case BER_TYPE_NULL:
939 put_length (0);
940 break;
941
942 case BER_TYPE_BOOL:
943 put_length (1);
944 *cur++ = SvTRUE (data) ? 0xff : 0x00; // 0xff = DER/CER
945 break;
946
947 case BER_TYPE_OID:
948 encode_oid (data, 0);
949 break;
950
951 case BER_TYPE_RELOID:
952 encode_oid (data, 1);
953 break;
954
955 case BER_TYPE_INT:
956 encode_int (data);
957 break;
958
959 case BER_TYPE_BYTES:
960 {
961 STRLEN len;
962 const char *ptr = SvPVbyte (data, len);
963 encode_data (ptr, len);
964 }
965 break;
966
967 case BER_TYPE_UTF8:
968 {
969 STRLEN len;
970 const char *ptr = SvPVutf8 (data, len);
971 encode_data (ptr, len);
972 }
973 break;
974
975 case BER_TYPE_IPADDRESS:
976 {
977 U8 ip[4];
978 sscanf (SvPV_nolen (data), "%hhu.%hhu.%hhu.%hhu", ip + 0, ip + 1, ip + 2, ip + 3);
979 encode_data ((const char *)ip, sizeof (ip));
980 }
981 break;
982
983 case BER_TYPE_UCS2:
984 encode_ucs (data, 2);
985 break;
986
987 case BER_TYPE_UCS4:
988 encode_ucs (data, 4);
989 break;
990
991 case BER_TYPE_REAL:
992 case BER_TYPE_CROAK:
993 default:
994 croak ("unconfigured/unsupported class/tag %d/%d", klass, tag);
995 }
996
997 }
998
999 /////////////////////////////////////////////////////////////////////////////
1000
1001 MODULE = Convert::BER::XS PACKAGE = Convert::BER::XS
1002
1003 PROTOTYPES: ENABLE
1004
1005 BOOT:
1006 {
1007 HV *stash = gv_stashpv ("Convert::BER::XS", 1);
1008
1009 profile_stash = gv_stashpv ("Convert::BER::XS::Profile", 1);
1010
1011 static const struct {
1012 const char *name;
1013 IV iv;
1014 } *civ, const_iv[] = {
1015 #define const_iv(name) { # name, name },
1016 const_iv (ASN_BOOLEAN)
1017 const_iv (ASN_INTEGER)
1018 const_iv (ASN_BIT_STRING)
1019 const_iv (ASN_OCTET_STRING)
1020 const_iv (ASN_NULL)
1021 const_iv (ASN_OBJECT_IDENTIFIER)
1022 const_iv (ASN_OBJECT_DESCRIPTOR)
1023 const_iv (ASN_OID)
1024 const_iv (ASN_EXTERNAL)
1025 const_iv (ASN_REAL)
1026 const_iv (ASN_SEQUENCE)
1027 const_iv (ASN_ENUMERATED)
1028 const_iv (ASN_EMBEDDED_PDV)
1029 const_iv (ASN_UTF8_STRING)
1030 const_iv (ASN_RELATIVE_OID)
1031 const_iv (ASN_SET)
1032 const_iv (ASN_NUMERIC_STRING)
1033 const_iv (ASN_PRINTABLE_STRING)
1034 const_iv (ASN_TELETEX_STRING)
1035 const_iv (ASN_T61_STRING)
1036 const_iv (ASN_VIDEOTEX_STRING)
1037 const_iv (ASN_IA5_STRING)
1038 const_iv (ASN_ASCII_STRING)
1039 const_iv (ASN_UTC_TIME)
1040 const_iv (ASN_GENERALIZED_TIME)
1041 const_iv (ASN_GRAPHIC_STRING)
1042 const_iv (ASN_VISIBLE_STRING)
1043 const_iv (ASN_ISO646_STRING)
1044 const_iv (ASN_GENERAL_STRING)
1045 const_iv (ASN_UNIVERSAL_STRING)
1046 const_iv (ASN_CHARACTER_STRING)
1047 const_iv (ASN_BMP_STRING)
1048
1049 const_iv (ASN_UNIVERSAL)
1050 const_iv (ASN_APPLICATION)
1051 const_iv (ASN_CONTEXT)
1052 const_iv (ASN_PRIVATE)
1053
1054 const_iv (BER_CLASS)
1055 const_iv (BER_TAG)
1056 const_iv (BER_FLAGS)
1057 const_iv (BER_DATA)
1058
1059 const_iv (BER_TYPE_BYTES)
1060 const_iv (BER_TYPE_UTF8)
1061 const_iv (BER_TYPE_UCS2)
1062 const_iv (BER_TYPE_UCS4)
1063 const_iv (BER_TYPE_INT)
1064 const_iv (BER_TYPE_OID)
1065 const_iv (BER_TYPE_RELOID)
1066 const_iv (BER_TYPE_NULL)
1067 const_iv (BER_TYPE_BOOL)
1068 const_iv (BER_TYPE_REAL)
1069 const_iv (BER_TYPE_IPADDRESS)
1070 const_iv (BER_TYPE_CROAK)
1071
1072 const_iv (SNMP_IPADDRESS)
1073 const_iv (SNMP_COUNTER32)
1074 const_iv (SNMP_UNSIGNED32)
1075 const_iv (SNMP_TIMETICKS)
1076 const_iv (SNMP_OPAQUE)
1077 const_iv (SNMP_COUNTER64)
1078 };
1079
1080 for (civ = const_iv + sizeof (const_iv) / sizeof (const_iv [0]); civ > const_iv; civ--)
1081 newCONSTSUB (stash, (char *)civ[-1].name, newSViv (civ[-1].iv));
1082 }
1083
1084 SV *
1085 ber_decode (SV *ber, SV *profile = &PL_sv_undef)
1086 CODE:
1087 {
1088 cur_profile = SvPROFILE (profile);
1089 STRLEN len;
1090 buf = (U8 *)SvPVbyte (ber, len);
1091 cur = buf;
1092 end = buf + len;
1093
1094 RETVAL = decode_ber ();
1095 }
1096 OUTPUT: RETVAL
1097
1098 void
1099 ber_is (SV *tuple, SV *klass = &PL_sv_undef, SV *tag = &PL_sv_undef, SV *flags = &PL_sv_undef, SV *data = &PL_sv_undef)
1100 PPCODE:
1101 {
1102 if (!SvOK (tuple))
1103 XSRETURN_NO;
1104
1105 if (!SvROK (tuple) || SvTYPE (SvRV (tuple)) != SVt_PVAV)
1106 croak ("ber_is: tuple must be BER tuple (array-ref)");
1107
1108 AV *av = (AV *)SvRV (tuple);
1109
1110 XPUSHs (
1111 (!SvOK (klass) || SvIV (AvARRAY (av)[BER_CLASS]) == SvIV (klass))
1112 && (!SvOK (tag) || SvIV (AvARRAY (av)[BER_TAG ]) == SvIV (tag))
1113 && (!SvOK (flags) || !SvIV (AvARRAY (av)[BER_FLAGS]) == !SvIV (flags))
1114 && (!SvOK (data) || sv_eq (AvARRAY (av)[BER_DATA ], data))
1115 ? &PL_sv_yes : &PL_sv_undef);
1116 }
1117
1118 void
1119 ber_is_seq (SV *tuple)
1120 PPCODE:
1121 {
1122 if (!SvOK (tuple))
1123 XSRETURN_UNDEF;
1124
1125 AV *av = ber_tuple (tuple);
1126
1127 XPUSHs (
1128 SvIV (AvARRAY (av)[BER_CLASS]) == ASN_UNIVERSAL
1129 && SvIV (AvARRAY (av)[BER_TAG ]) == ASN_SEQUENCE
1130 && SvIV (AvARRAY (av)[BER_FLAGS])
1131 ? AvARRAY (av)[BER_DATA] : &PL_sv_undef);
1132 }
1133
1134 void
1135 ber_is_int (SV *tuple, SV *value = &PL_sv_undef)
1136 PPCODE:
1137 {
1138 if (!SvOK (tuple))
1139 XSRETURN_NO;
1140
1141 AV *av = ber_tuple (tuple);
1142
1143 UV data = SvUV (AvARRAY (av)[BER_DATA]);
1144
1145 XPUSHs (
1146 SvIV (AvARRAY (av)[BER_CLASS]) == ASN_UNIVERSAL
1147 && SvIV (AvARRAY (av)[BER_TAG ]) == ASN_INTEGER
1148 && !SvIV (AvARRAY (av)[BER_FLAGS])
1149 && (!SvOK (value) || data == SvUV (value))
1150 ? sv_2mortal (data ? newSVsv (AvARRAY (av)[BER_DATA]) : newSVpv ("0 but true", 0))
1151 : &PL_sv_undef);
1152 }
1153
1154 void
1155 ber_is_oid (SV *tuple, SV *oid = &PL_sv_undef)
1156 PPCODE:
1157 {
1158 if (!SvOK (tuple))
1159 XSRETURN_NO;
1160
1161 AV *av = ber_tuple (tuple);
1162
1163 XPUSHs (
1164 SvIV (AvARRAY (av)[BER_CLASS]) == ASN_UNIVERSAL
1165 && SvIV (AvARRAY (av)[BER_TAG ]) == ASN_OBJECT_IDENTIFIER
1166 && !SvIV (AvARRAY (av)[BER_FLAGS])
1167 && (!SvOK (oid) || sv_eq (AvARRAY (av)[BER_DATA], oid))
1168 ? newSVsv (AvARRAY (av)[BER_DATA]) : &PL_sv_undef);
1169 }
1170
1171 #############################################################################
1172
1173 void
1174 ber_encode (SV *tuple, SV *profile = &PL_sv_undef)
1175 PPCODE:
1176 {
1177 cur_profile = SvPROFILE (profile);
1178 buf_sv = sv_2mortal (NEWSV (0, 256));
1179 SvPOK_only (buf_sv);
1180 set_buf (buf_sv);
1181
1182 encode_ber (tuple);
1183
1184 SvCUR_set (buf_sv, cur - buf);
1185 XPUSHs (buf_sv);
1186 }
1187
1188 SV *
1189 ber_int (SV *sv)
1190 CODE:
1191 {
1192 AV *av = newAV ();
1193 av_fill (av, BER_ARRAYSIZE - 1);
1194 AvARRAY (av)[BER_CLASS] = newSVcacheint (ASN_UNIVERSAL);
1195 AvARRAY (av)[BER_TAG ] = newSVcacheint (ASN_INTEGER);
1196 AvARRAY (av)[BER_FLAGS] = newSVcacheint (0);
1197 AvARRAY (av)[BER_DATA ] = newSVsv (sv);
1198 RETVAL = newRV_noinc ((SV *)av);
1199 }
1200 OUTPUT: RETVAL
1201
1202 # TODO: not arrayref, but elements?
1203 SV *
1204 ber_seq (SV *arrayref)
1205 CODE:
1206 {
1207 AV *av = newAV ();
1208 av_fill (av, BER_ARRAYSIZE - 1);
1209 AvARRAY (av)[BER_CLASS] = newSVcacheint (ASN_UNIVERSAL);
1210 AvARRAY (av)[BER_TAG ] = newSVcacheint (ASN_SEQUENCE);
1211 AvARRAY (av)[BER_FLAGS] = newSVcacheint (1);
1212 AvARRAY (av)[BER_DATA ] = newSVsv (arrayref);
1213 RETVAL = newRV_noinc ((SV *)av);
1214 }
1215 OUTPUT: RETVAL
1216
1217 MODULE = Convert::BER::XS PACKAGE = Convert::BER::XS::Profile
1218
1219 SV *
1220 new (SV *klass)
1221 CODE:
1222 RETVAL = profile_new ();
1223 OUTPUT: RETVAL
1224
1225 void
1226 set (SV *profile, int klass, int tag, int type)
1227 CODE:
1228 profile_set (SvPROFILE (profile), klass, tag, type);
1229
1230 IV
1231 get (SV *profile, int klass, int tag)
1232 CODE:
1233 RETVAL = profile_lookup (SvPROFILE (profile), klass, tag);
1234 OUTPUT: RETVAL
1235
1236 void
1237 _set_default (SV *profile)
1238 CODE:
1239 default_profile = SvPROFILE (profile);
1240
1241