ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Convert-BER-XS/XS.xs
Revision: 1.27
Committed: Mon Apr 22 11:01:49 2019 UTC (5 years, 1 month ago) by root
Branch: MAIN
Changes since 1.26: +9 -8 lines
Log Message:
*** empty log message ***

File Contents

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