ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Convert-BER-XS/XS.pm
(Generate patch)

Comparing Convert-BER-XS/XS.pm (file contents):
Revision 1.35 by root, Sat Apr 20 21:51:40 2019 UTC vs.
Revision 1.36 by root, Sun Apr 21 00:36:11 2019 UTC

… …
36 [ ASN_UNIVERSAL, ASN_OCTET_STRING, 0, "...data..." # the value 36 [ ASN_UNIVERSAL, ASN_OCTET_STRING, 0, "...data..." # the value
37 ] 37 ]
38 ] 38 ]
39 ], 39 ],
40 ... 40 ...
41 # let's dump it, for debugging
42
43 ber_dump $ber, $Convert::BER::XS::SNMP_PROFILE;
41 44
42 # let's decode it a bit with some helper functions 45 # let's decode it a bit with some helper functions
43 46
44 my $msg = ber_is_seq $ber 47 my $msg = ber_is_seq $ber
45 or die "SNMP message does not start with a sequence"; 48 or die "SNMP message does not start with a sequence";
… …
113 ASN_UNIVERSAL ASN_APPLICATION ASN_CONTEXT ASN_PRIVATE 116 ASN_UNIVERSAL ASN_APPLICATION ASN_CONTEXT ASN_PRIVATE
114 117
115ASN tag values (some of which are aliases, such as C<ASN_OID>). Their 118ASN tag values (some of which are aliases, such as C<ASN_OID>). Their
116numerical value corresponds exactly to the numbers used in BER/X.690. 119numerical value corresponds exactly to the numbers used in BER/X.690.
117 120
118 ASN_BOOLEAN ASN_INTEGER ASN_BIT_STRING ASN_OCTET_STRING ASN_NULL ASN_OBJECT_IDENTIFIER 121 ASN_BOOLEAN ASN_INTEGER ASN_BIT_STRING ASN_OCTET_STRING ASN_NULL ASN_OID
119 ASN_OBJECT_DESCRIPTOR ASN_OID ASN_EXTERNAL ASN_REAL ASN_SEQUENCE ASN_ENUMERATED 122 ASN_OBJECT_IDENTIFIER ASN_OBJECT_DESCRIPTOR ASN_EXTERNAL ASN_REAL ASN_SEQUENCE ASN_ENUMERATED
120 ASN_EMBEDDED_PDV ASN_UTF8_STRING ASN_RELATIVE_OID ASN_SET ASN_NUMERIC_STRING 123 ASN_EMBEDDED_PDV ASN_UTF8_STRING ASN_RELATIVE_OID ASN_SET ASN_NUMERIC_STRING
121 ASN_PRINTABLE_STRING ASN_TELETEX_STRING ASN_T61_STRING ASN_VIDEOTEX_STRING ASN_IA5_STRING 124 ASN_PRINTABLE_STRING ASN_TELETEX_STRING ASN_T61_STRING ASN_VIDEOTEX_STRING ASN_IA5_STRING
122 ASN_ASCII_STRING ASN_UTC_TIME ASN_GENERALIZED_TIME ASN_GRAPHIC_STRING ASN_VISIBLE_STRING 125 ASN_ASCII_STRING ASN_UTC_TIME ASN_GENERALIZED_TIME ASN_GRAPHIC_STRING ASN_VISIBLE_STRING
123 ASN_ISO646_STRING ASN_GENERAL_STRING ASN_UNIVERSAL_STRING ASN_CHARACTER_STRING ASN_BMP_STRING 126 ASN_ISO646_STRING ASN_GENERAL_STRING ASN_UNIVERSAL_STRING ASN_CHARACTER_STRING ASN_BMP_STRING
124 127
… …
143 146
144C<ber_decode> and the match helper functions: 147C<ber_decode> and the match helper functions:
145 148
146 ber_decode ber-decode_prefix 149 ber_decode ber-decode_prefix
147 ber_is ber_is_seq ber_is_int ber_is_oid 150 ber_is ber_is_seq ber_is_int ber_is_oid
151 ber_dump
148 152
149=item C<:encode> 153=item C<:encode>
150 154
151C<ber_encode> and the construction helper functions: 155C<ber_encode> and the construction helper functions:
152 156
… …
416 420
417our %EXPORT_TAGS = ( 421our %EXPORT_TAGS = (
418 const_index => [qw( 422 const_index => [qw(
419 BER_CLASS BER_TAG BER_FLAGS BER_DATA 423 BER_CLASS BER_TAG BER_FLAGS BER_DATA
420 )], 424 )],
425 const_asn_class => [qw(
426 ASN_UNIVERSAL ASN_APPLICATION ASN_CONTEXT ASN_PRIVATE
427 )],
421 const_asn => [qw( 428 const_asn_tag => [qw(
422 ASN_BOOLEAN ASN_INTEGER ASN_BIT_STRING ASN_OCTET_STRING ASN_NULL ASN_OBJECT_IDENTIFIER 429 ASN_BOOLEAN ASN_INTEGER ASN_BIT_STRING ASN_OCTET_STRING ASN_NULL ASN_OID ASN_OBJECT_IDENTIFIER
423 ASN_OBJECT_DESCRIPTOR ASN_OID ASN_EXTERNAL ASN_REAL ASN_SEQUENCE ASN_ENUMERATED 430 ASN_OBJECT_DESCRIPTOR ASN_EXTERNAL ASN_REAL ASN_SEQUENCE ASN_ENUMERATED
424 ASN_EMBEDDED_PDV ASN_UTF8_STRING ASN_RELATIVE_OID ASN_SET ASN_NUMERIC_STRING 431 ASN_EMBEDDED_PDV ASN_UTF8_STRING ASN_RELATIVE_OID ASN_SET ASN_NUMERIC_STRING
425 ASN_PRINTABLE_STRING ASN_TELETEX_STRING ASN_T61_STRING ASN_VIDEOTEX_STRING ASN_IA5_STRING 432 ASN_PRINTABLE_STRING ASN_TELETEX_STRING ASN_T61_STRING ASN_VIDEOTEX_STRING ASN_IA5_STRING
426 ASN_ASCII_STRING ASN_UTC_TIME ASN_GENERALIZED_TIME ASN_GRAPHIC_STRING ASN_VISIBLE_STRING 433 ASN_ASCII_STRING ASN_UTC_TIME ASN_GENERALIZED_TIME ASN_GRAPHIC_STRING ASN_VISIBLE_STRING
427 ASN_ISO646_STRING ASN_GENERAL_STRING ASN_UNIVERSAL_STRING ASN_CHARACTER_STRING ASN_BMP_STRING 434 ASN_ISO646_STRING ASN_GENERAL_STRING ASN_UNIVERSAL_STRING ASN_CHARACTER_STRING ASN_BMP_STRING
428
429 ASN_UNIVERSAL ASN_APPLICATION ASN_CONTEXT ASN_PRIVATE
430 )], 435 )],
431 const_ber_type => [qw( 436 const_ber_type => [qw(
432 BER_TYPE_BYTES BER_TYPE_UTF8 BER_TYPE_UCS2 BER_TYPE_UCS4 BER_TYPE_INT 437 BER_TYPE_BYTES BER_TYPE_UTF8 BER_TYPE_UCS2 BER_TYPE_UCS4 BER_TYPE_INT
433 BER_TYPE_OID BER_TYPE_RELOID BER_TYPE_NULL BER_TYPE_BOOL BER_TYPE_REAL 438 BER_TYPE_OID BER_TYPE_RELOID BER_TYPE_NULL BER_TYPE_BOOL BER_TYPE_REAL
434 BER_TYPE_IPADDRESS BER_TYPE_CROAK 439 BER_TYPE_IPADDRESS BER_TYPE_CROAK
… …
438 SNMP_TIMETICKS SNMP_OPAQUE SNMP_COUNTER64 443 SNMP_TIMETICKS SNMP_OPAQUE SNMP_COUNTER64
439 )], 444 )],
440 decode => [qw( 445 decode => [qw(
441 ber_decode ber_decode_prefix 446 ber_decode ber_decode_prefix
442 ber_is ber_is_seq ber_is_int ber_is_oid 447 ber_is ber_is_seq ber_is_int ber_is_oid
448 ber_dump
443 )], 449 )],
444 encode => [qw( 450 encode => [qw(
445 ber_encode 451 ber_encode
446 ber_int 452 ber_int
447 )], 453 )],
448); 454);
449 455
450our @EXPORT_OK = map @$_, values %EXPORT_TAGS; 456our @EXPORT_OK = map @$_, values %EXPORT_TAGS;
451 457
452$EXPORT_TAGS{all} = \@EXPORT_OK; 458$EXPORT_TAGS{all} = \@EXPORT_OK;
459$EXPORT_TAGS{const_asn} = [map @{ $EXPORT_TAGS{$_} }, qw(const_asn_class const_asn_tag)];
453$EXPORT_TAGS{const} = [map @{ $EXPORT_TAGS{$_} }, qw(const_index const_asn)]; 460$EXPORT_TAGS{const} = [map @{ $EXPORT_TAGS{$_} }, qw(const_index const_asn)];
461
462our $DEFAULT_PROFILE = new Convert::BER::XS::Profile;
463
464$DEFAULT_PROFILE->_set_default;
465
466# additional SNMP application types
467our $SNMP_PROFILE = new Convert::BER::XS::Profile;
468
469$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_IPADDRESS , BER_TYPE_IPADDRESS);
470$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER32 , BER_TYPE_INT);
471$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_UNSIGNED32, BER_TYPE_INT);
472$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_TIMETICKS , BER_TYPE_INT);
473$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_OPAQUE , BER_TYPE_IPADDRESS);
474
475=head2 DEBUGGING
476
477To aid debugging, you cna call the C<ber_dump> function to print a "nice"
478representation to STDOUT.
479
480=over
481
482=item Convert::BER::XS::ber_dump $tuple[, $profile[, $prefix]]
483
484In addition to specifying the BER C<$tuple> to dump, youc an also specify
485a C<$profile> and a C<$prefix> string that is printed in front of each line.
486
487If C<$profile> is C<$Convert::BER::XS::SNMP_PROFILE>, then C<ber_dump>
488will try to improve its output for SNMP data.
489
490The output usually contains three columns, the "human readable" tag, the
491BER type used to decode it, and the data value.
492
493This function is somewhat slow and uses a number of heuristics and tricks,
494so it really is only suitable for debug prints.
495
496Example output:
497
498 SEQUENCE
499 | OCTET_STRING bytes 800063784300454045045400000001
500 | OCTET_STRING bytes
501 | CONTEXT (7) bytes CONSTRUCTED
502 | | INTEGER int 1058588941
503 | | INTEGER int 0
504 | | INTEGER int 0
505 | | SEQUENCE
506 | | | SEQUENCE
507 | | | | OID oid 1.3.6.1.2.1.1.3.0
508 | | | | TIMETICKS int 638085796
509
510=cut
511
512# reverse enum, very slow and ugly hack
513sub _re {
514 my ($export_tag, $value) = @_;
515
516 for my $symbol (@{ $EXPORT_TAGS{$export_tag} }) {
517 $value == eval $symbol
518 and return $symbol;
519 }
520
521 "($value)"
522}
523
524$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER64 , BER_TYPE_INT);
525
526sub _ber_dump {
527 my ($ber, $profile, $indent) = @_;
528
529 if (my $seq = ber_is_seq $ber) {
530 printf "%sSEQUENCE\n", $indent;
531 &_ber_dump ($_, $profile, "$indent| ")
532 for @$seq;
533 } else {
534 my $asn = $ber->[BER_CLASS] == ASN_UNIVERSAL;
535
536 my $class = _re const_asn_class => $ber->[BER_CLASS];
537 my $tag = $asn ? _re const_asn_tag => $ber->[BER_TAG] : $ber->[BER_TAG];
538 my $type = _re const_ber_type => $profile->get ($ber->[BER_CLASS], $ber->[BER_TAG]);
539 my $data = $ber->[BER_DATA];
540
541 if ($profile == $SNMP_PROFILE and $ber->[BER_CLASS] == ASN_APPLICATION) {
542 $tag = _re const_snmp => $ber->[BER_TAG];
543 $asn = 1;
544 }
545
546 $asn or $tag = "$class ($tag)";
547
548 $class =~ s/^ASN_//;
549 $tag =~ s/^(ASN_|SNMP_)//;
550 $type =~ s/^BER_TYPE_//;
551
552 if ($ber->[BER_FLAGS]) {
553 printf "$indent%-16.16s %-6.6s CONSTRUCTED\n", $tag, lc $type;
554 &_ber_dump ($_, $profile, "$indent| ")
555 for @$data;
556 } else {
557 if ($data =~ y/\x20-\x7e//c > 10 or $data =~ /\x00./s) {
558 # assume binary
559 $data = unpack "H*", $data;
560 substr $data, 40, 1e9, "..." if 40 < length $data;
561 } else {
562 $data =~ s/[^\x20-\x7e]/./g;
563 $data = "\"$data\"" if $type =~ /string/i;
564 substr $data, 40, 1e9, "..." if 40 < length $data;
565 }
566
567 printf "$indent%-16.16s %-6.6s %s\n", $tag, lc $type, $data;
568 }
569 }
570}
571
572sub ber_dump($;$$) {
573 _ber_dump $_[0], $_[1] || $DEFAULT_PROFILE, $_[2];
574}
454 575
455=head1 PROFILES 576=head1 PROFILES
456 577
457While any BER data can be correctly encoded and decoded out of the box, it 578While any BER data can be correctly encoded and decoded out of the box, it
458can be inconvenient to have to manually decode some values into a "better" 579can be inconvenient to have to manually decode some values into a "better"
… …
612 $SNMP_PROFILE->set (ASN_APPLICATION, SNMP_UNSIGNED32, BER_TYPE_INT); 733 $SNMP_PROFILE->set (ASN_APPLICATION, SNMP_UNSIGNED32, BER_TYPE_INT);
613 $SNMP_PROFILE->set (ASN_APPLICATION, SNMP_TIMETICKS , BER_TYPE_INT); 734 $SNMP_PROFILE->set (ASN_APPLICATION, SNMP_TIMETICKS , BER_TYPE_INT);
614 $SNMP_PROFILE->set (ASN_APPLICATION, SNMP_OPAQUE , BER_TYPE_IPADDRESS); 735 $SNMP_PROFILE->set (ASN_APPLICATION, SNMP_OPAQUE , BER_TYPE_IPADDRESS);
615 $SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER64 , BER_TYPE_INT); 736 $SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER64 , BER_TYPE_INT);
616 737
617=cut
618
619our $DEFAULT_PROFILE = new Convert::BER::XS::Profile;
620
621$DEFAULT_PROFILE->_set_default;
622
623# additional SNMP application types
624our $SNMP_PROFILE = new Convert::BER::XS::Profile;
625
626$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_IPADDRESS , BER_TYPE_IPADDRESS);
627$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER32 , BER_TYPE_INT);
628$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_UNSIGNED32, BER_TYPE_INT);
629$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_TIMETICKS , BER_TYPE_INT);
630$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_OPAQUE , BER_TYPE_IPADDRESS);
631$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER64 , BER_TYPE_INT);
632
6331;
634
635=head2 LIMITATIONS/NOTES 738=head2 LIMITATIONS/NOTES
636 739
637This module can only en-/decode 64 bit signed and unsigned integers, and 740This module can only en-/decode 64 bit signed and unsigned integers, and
638only when your perl supports those. 741only when your perl supports those.
639 742
… …
667 Marc Lehmann <schmorp@schmorp.de> 770 Marc Lehmann <schmorp@schmorp.de>
668 http://software.schmorp.de/pkg/Convert-BER-XS 771 http://software.schmorp.de/pkg/Convert-BER-XS
669 772
670=cut 773=cut
671 774
7751;
776

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines