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