[ViewVC] Diff of: cvs/Convert-BER-XS/XS.pm

Comparing Convert-BER-XS/XS.pm (file contents):
Revision 1.16 by root, Sat Apr 20 02:07:45 2019 UTC vs.
Revision 1.33 by root, Sat Apr 20 17:23:21 2019 UTC

…		…
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use Convert::BER::XS ':all';	7	use Convert::BER::XS ':all';
8		8
9	my $ber = ber_decode $buf	9	my $ber = ber_decode $buf, $Convert::BER::XS::SNMP_PROFILE
10	or die "unable to decode SNMP message";	10	or die "unable to decode SNMP message";
11		11
12	# The above results in a data structure consisting of	12	# The above results in a data structure consisting of
13	# (class, tag, # constructed, data)	13	# (class, tag, flags, data)
14	# tuples. Below is such a message, SNMPv1 trap	14	# tuples. Below is such a message, SNMPv1 trap
15	# with a Cisco mac change notification.	15	# with a Cisco mac change notification.
16	# Did you know that Cisco is in the news almost	16	# Did you know that Cisco is in the news almost
17	# every week because # of some backdoor password	17	# every week because of some backdoor password
18	# or other extremely stupid security bug?	18	# or other extremely stupid security bug?
19		19
20	[ ASN_UNIVERSAL, ASN_SEQUENCE, 1,	20	[ ASN_UNIVERSAL, ASN_SEQUENCE, 1,
21	[	21	[
22	[ ASN_UNIVERSAL, ASN_INTEGER32, 0, 0 ], # snmp version 1	22	[ ASN_UNIVERSAL, ASN_INTEGER, 0, 0 ], # snmp version 1
23	[ ASN_UNIVERSAL, 4, 0, "public" ], # community	23	[ ASN_UNIVERSAL, 4, 0, "public" ], # community
24	[ ASN_CONTEXT, 4, 1, # CHOICE, constructed - trap PDU	24	[ ASN_CONTEXT, 4, 1, # CHOICE, constructed - trap PDU
25	[	25	[
26	[ ASN_UNIVERSAL, ASN_OBJECT_IDENTIFIER, 0, "1.3.6.1.4.1.9.9.215.2" ], # enterprise oid	26	[ ASN_UNIVERSAL, ASN_OBJECT_IDENTIFIER, 0, "1.3.6.1.4.1.9.9.215.2" ], # enterprise oid
27	[ ASN_APPLICATION, 0, 0, "\x0a\x00\x00\x01" ], # SNMP IpAddress, 10.0.0.1	27	[ ASN_APPLICATION, SNMP_IPADDRESS, 0, "10.0.0.1" ], # SNMP IpAddress
28	[ ASN_UNIVERSAL, ASN_INTEGER32, 0, 6 ], # generic trap	28	[ ASN_UNIVERSAL, ASN_INTEGER, 0, 6 ], # generic trap
29	[ ASN_UNIVERSAL, ASN_INTEGER32, 0, 1 ], # specific trap	29	[ ASN_UNIVERSAL, ASN_INTEGER, 0, 1 ], # specific trap
30	[ ASN_APPLICATION, ASN_TIMETICKS, 0, 1817903850 ], # SNMP TimeTicks	30	[ ASN_APPLICATION, SNMP_TIMETICKS, 0, 1817903850 ], # SNMP TimeTicks
31	[ ASN_UNIVERSAL, ASN_SEQUENCE, 1, # the varbindlist	31	[ ASN_UNIVERSAL, ASN_SEQUENCE, 1, # the varbindlist
32	[	32	[
33	[ ASN_UNIVERSAL, ASN_SEQUENCE, 1, # a single varbind, "key value" pair	33	[ ASN_UNIVERSAL, ASN_SEQUENCE, 1, # a single varbind, "key value" pair
34	[	34	[
35	[ ASN_UNIVERSAL, ASN_OBJECT_IDENTIFIER, 0, "1.3.6.1.4.1.9.9.215.1.1.8.1.2.1" ],	35	[ ASN_UNIVERSAL, ASN_OBJECT_IDENTIFIER, 0, "1.3.6.1.4.1.9.9.215.1.1.8.1.2.1" ],
…		…
42	# let's decode it a bit with some helper functions	42	# let's decode it a bit with some helper functions
43		43
44	my $msg = ber_is_seq $ber	44	my $msg = ber_is_seq $ber
45	or die "SNMP message does not start with a sequence";	45	or die "SNMP message does not start with a sequence";
46		46
47	ber_is $msg->[0], ASN_UNIVERSAL, ASN_INTEGER32, 0	47	ber_is $msg->[0], ASN_UNIVERSAL, ASN_INTEGER, 0
48	or die "SNMP message does not start with snmp version\n";	48	or die "SNMP message does not start with snmp version\n";
49		49
50	# message is SNMP v1 or v2c?	50	# message is SNMP v1 or v2c?
51	if ($msg->[0][BER_DATA] == 0 \|\| $msg->[0][BER_DATA] == 1) {	51	if ($msg->[0][BER_DATA] == 0 \|\| $msg->[0][BER_DATA] == 1) {
52		52
…		…
55	my $trap = $msg->[2][BER_DATA];	55	my $trap = $msg->[2][BER_DATA];
56		56
57	# check whether trap is a cisco mac notification mac changed message	57	# check whether trap is a cisco mac notification mac changed message
58	if (	58	if (
59	(ber_is_oid $trap->[0], "1.3.6.1.4.1.9.9.215.2") # cmnInterfaceObjects	59	(ber_is_oid $trap->[0], "1.3.6.1.4.1.9.9.215.2") # cmnInterfaceObjects
60	and (ber_is_i32 $trap->[2], 6)	60	and (ber_is_int $trap->[2], 6)
61	and (ber_is_i32 $trap->[3], 1) # mac changed msg	61	and (ber_is_int $trap->[3], 1) # mac changed msg
62	) {	62	) {
63	... and so on	63	... and so on
64		64
65	# finally, let's encode it again and hope it results in the same bit pattern	65	# finally, let's encode it again and hope it results in the same bit pattern
66		66
67	my $buf = ber_encode $ber;	67	my $buf = ber_encode $ber, $Convert::BER::XS::SNMP_PROFILE;
68		68
69	=head1 DESCRIPTION	69	=head1 DESCRIPTION
70		70
71	WARNING: Before release 1.0, the API is not considered stable in any way.	71	WARNING: Before release 1.0, the API is not considered stable in any way.
72		72
73	This module implements a I<very> low level BER/DER en-/decoder.	73	This module implements a I<very> low level BER/DER en-/decoder.
74		74
75	If is tuned for low memory and high speed, while still maintaining some	75	It is tuned for low memory and high speed, while still maintaining some
76	level of user-friendlyness.	76	level of user-friendlyness.
		77
		78	=head2 EXPORT TAGS AND CONSTANTS
		79
		80	By default this module doesn't export any symbols, but if you don't want
		81	to break your keyboard, editor or eyesight with extremely long names, I
		82	recommend importing the C<:all> tag. Still, you can selectively import
		83	things.
		84
		85	=over
		86
		87	=item C<:all>
		88
		89	All of the below. Really. Recommended for at least first steps, or if you
		90	don't care about a few kilobytes of wasted memory (and namespace).
		91
		92	=item C<:const>
		93
		94	All of the strictly ASN.1-related constants defined by this module, the
		95	same as C<:const_asn :const_index>. Notably, this does not contain
		96	C<:const_ber_type> and C<:const_snmp>.
		97
		98	A good set to get everything you need to decode and match BER data would be
		99	C<:decode :const>.
		100
		101	=item C<:const_index>
		102
		103	The BER tuple array index constants:
		104
		105	BER_CLASS BER_TAG BER_FLAGS BER_DATA
		106
		107	=item C<:const_asn>
		108
		109	ASN class values (these are C<0>, C<1>, C<2> and C<3>, respectively -
		110	exactly thw two topmost bits from the identifier octet shifted 6 bits to
		111	the right):
		112
		113	ASN_UNIVERSAL ASN_APPLICATION ASN_CONTEXT ASN_PRIVATE
		114
		115	ASN tag values (some of which are aliases, such as C<ASN_OID>). Their
		116	numerical value corresponds exactly to the numbers used in BER/X.690.
		117
		118	ASN_BOOLEAN ASN_INTEGER ASN_BIT_STRING ASN_OCTET_STRING ASN_NULL ASN_OBJECT_IDENTIFIER
		119	ASN_OBJECT_DESCRIPTOR ASN_OID ASN_EXTERNAL ASN_REAL ASN_SEQUENCE ASN_ENUMERATED
		120	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
		122	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
		124
		125	=item C<:const_ber_type>
		126
		127	The BER type constants, explained in the PROFILES section.
		128
		129	BER_TYPE_BYTES BER_TYPE_UTF8 BER_TYPE_UCS2 BER_TYPE_UCS4 BER_TYPE_INT
		130	BER_TYPE_OID BER_TYPE_RELOID BER_TYPE_NULL BER_TYPE_BOOL BER_TYPE_REAL
		131	BER_TYPE_IPADDRESS BER_TYPE_CROAK
		132
		133	=item C<:const_snmp>
		134
		135	Constants only relevant to SNMP. These are the tag values used by SNMP in
		136	the C<ASN_APPLICATION> namespace and have the exact numerical value as in
		137	BER/RFC 2578.
		138
		139	SNMP_IPADDRESS SNMP_COUNTER32 SNMP_UNSIGNED32 SNMP_GAUGE32
		140	SNMP_TIMETICKS SNMP_OPAQUE SNMP_COUNTER64
		141
		142	=item C<:decode>
		143
		144	C<ber_decode> and the match helper functions:
		145
		146	ber_decode ber_is ber_is_seq ber_is_int ber_is_oid
		147
		148	=item C<:encode>
		149
		150	C<ber_encode> and the construction helper functions:
		151
		152	ber_encode ber_int
		153
		154	=back
77		155
78	=head2 ASN.1/BER/DER/... BASICS	156	=head2 ASN.1/BER/DER/... BASICS
79		157
80	ASN.1 is a strange language that can be used to describe protocols and	158	ASN.1 is a strange language that can be used to describe protocols and
81	data structures. It supports various mappings to JSON, XML, but most	159	data structures. It supports various mappings to JSON, XML, but most
82	importantly, to a various binary encodings such as BER, that is the topic	160	importantly, to a various binary encodings such as BER, that is the topic
83	of this module, and is used in SNMP or LDAP for example.	161	of this module, and is used in SNMP, LDAP or X.509 for example.
84		162
85	While ASN.1 defines a schema that is useful to interpret encoded data,	163	While ASN.1 defines a schema that is useful to interpret encoded data,
86	the BER encoding is actually somewhat self-describing: you might not know	164	the BER encoding is actually somewhat self-describing: you might not know
87	whether something is a string or a number or a sequence or something else,	165	whether something is a string or a number or a sequence or something else,
88	but you can nevertheless decode the overall structure, even if you end up	166	but you can nevertheless decode the overall structure, even if you end up
…		…
90		168
91	This works because BER values are tagged with a type and a namespace,	169	This works because BER values are tagged with a type and a namespace,
92	and also have a flag that says whether a value consists of subvalues (is	170	and also have a flag that says whether a value consists of subvalues (is
93	"constructed") or not (is "primitive").	171	"constructed") or not (is "primitive").
94		172
95	Tags are simple integers, and ASN.1 defines a somewhat weird assortment of	173	Tags are simple integers, and ASN.1 defines a somewhat weird assortment
96	those - for example, you have 32 bit signed integers and 16(!) different	174	of those - for example, you have one integers and 16(!) different
97	string types, but there is no unsigned32 type for example. Different	175	string types, but there is no Unsigned32 type for example. Different
98	applications work around this in different ways, for example, SNMP defines	176	applications work around this in different ways, for example, SNMP defines
99	application-specific Gauge32, Counter32 and Unsigned32, which are mapped	177	application-specific Gauge32, Counter32 and Unsigned32, which are mapped
100	to two different tags: you can distinguish between Counter32 and the	178	to two different tags: you can distinguish between Counter32 and the
101	others, but not between Gause32 and Unsigned32, without the ASN.1 schema.	179	others, but not between Gause32 and Unsigned32, without the ASN.1 schema.
102		180
…		…
105	=head2 DECODED BER REPRESENTATION	183	=head2 DECODED BER REPRESENTATION
106		184
107	This module represents every BER value as a 4-element tuple (actually an	185	This module represents every BER value as a 4-element tuple (actually an
108	array-reference):	186	array-reference):
109		187
110	[CLASS, TAG, CONSTRUCTED, DATA]	188	[CLASS, TAG, FLAGS, DATA]
		189
		190	For example:
		191
		192	[ASN_UNIVERSAL, ASN_INTEGER, 0, 177] # the integer 177
		193	[ASN_UNIVERSAL, ASN_OCTET_STRING, 0, "john"] # the string "john"
		194	[ASN_UNIVERSAL, ASN_OID, 0, "1.3.6.133"] # some OID
		195	[ASN_UNIVERSAL, ASN_SEQUENCE, 1, [ [ASN_UNIVERSAL... # a sequence
111		196
112	To avoid non-descriptive hardcoded array index numbers, this module	197	To avoid non-descriptive hardcoded array index numbers, this module
113	defines symbolic constants to access these members: C<BER_CLASS>,	198	defines symbolic constants to access these members: C<BER_CLASS>,
114	C<BER_TAG>, C<BER_CONSTRUCTED> and C<BER_DATA>.	199	C<BER_TAG>, C<BER_FLAGS> and C<BER_DATA>.
115		200
116	Also, the first three members are integers with a little caveat: for	201	Also, the first three members are integers with a little caveat: for
117	performance reasons, these are readonly and shared, so you must not modify	202	performance reasons, these are readonly and shared, so you must not modify
118	them (increment, assign to them etc.) in any way. You may modify the	203	them (increment, assign to them etc.) in any way. You may modify the
119	I<DATA> member, and you may re-assign the array itself, e.g.:	204	I<DATA> member, and you may re-assign the array itself, e.g.:
120		205
121	$ber = ber_decode $binbuf;	206	$ber = ber_decode $binbuf;
122		207
123	# the following is NOT legal:	208	# the following is NOT legal:
124	$ber->[BER_CLASS] = ASN_PRIVATE; # ERROR, CLASS/TAG/CONSTRUCTED are READ ONLY(!)	209	$ber->[BER_CLASS] = ASN_PRIVATE; # ERROR, CLASS/TAG/FLAGS are READ ONLY(!)
125		210
126	# but all of the following are fine:	211	# but all of the following are fine:
127	$ber->[BER_DATA] = "string";	212	$ber->[BER_DATA] = "string";
128	$ber->[BER_DATA] = [ASN_UNIVERSAL, ASN_INTEGER32, 0, 123];	213	$ber->[BER_DATA] = [ASN_UNIVERSAL, ASN_INTEGER, 0, 123];
129	@$ber = (ASN_APPLICATION, SNMP_TIMETICKS, 0, 1000);	214	@$ber = (ASN_APPLICATION, SNMP_TIMETICKS, 0, 1000);
130		215
131	I<CLASS> is something like a namespace for I<TAG>s - there is the	216	I<CLASS> is something like a namespace for I<TAG>s - there is the
132	C<ASN_UNIVERSAL> namespace which defines tags common to all ASN.1	217	C<ASN_UNIVERSAL> namespace which defines tags common to all ASN.1
133	implementations, the C<ASN_APPLICATION> namespace which defines tags for	218	implementations, the C<ASN_APPLICATION> namespace which defines tags for
134	specific applications (for example, the SNMP C<Unsigned32> type is in this	219	specific applications (for example, the SNMP C<Unsigned32> type is in this
135	namespace), a special-purpose context namespace (C<ASN_CONTEXT>, used e.g.	220	namespace), a special-purpose context namespace (C<ASN_CONTEXT>, used e.g.
136	for C<CHOICE>) and a private namespace (C<ASN_PRIVATE>).	221	for C<CHOICE>) and a private namespace (C<ASN_PRIVATE>).
137		222
138	The meaning of the I<TAG> depends on the namespace, and defines a	223	The meaning of the I<TAG> depends on the namespace, and defines a
139	(partial) interpretation of the data value. For example, right now, SNMP	224	(partial) interpretation of the data value. For example, SNMP defines
140	application namespace knowledge ix hardcoded into this module, so it	225	extra tags in the C<ASN_APPLICATION> namespace, and to take full advantage
141	knows that SNMP C<Unsigned32> values need to be decoded into actual perl	226	of these, you need to tell this module how to handle those via profiles.
142	integers.
143		227
144	The most common tags in the C<ASN_UNIVERSAL> namespace are	228	The most common tags in the C<ASN_UNIVERSAL> namespace are
145	C<ASN_INTEGER32>, C<ASN_BIT_STRING>, C<ASN_NULL>, C<ASN_OCTET_STRING>,	229	C<ASN_INTEGER>, C<ASN_BIT_STRING>, C<ASN_NULL>, C<ASN_OCTET_STRING>,
146	C<ASN_OBJECT_IDENTIFIER>, C<ASN_SEQUENCE>, C<ASN_SET> and	230	C<ASN_OBJECT_IDENTIFIER>, C<ASN_SEQUENCE>, C<ASN_SET> and
147	C<ASN_IA5_STRING>.	231	C<ASN_IA5_STRING>.
148		232
149	The most common tags in SNMP's C<ASN_APPLICATION> namespace	233	The most common tags in SNMP's C<ASN_APPLICATION> namespace are
150	are C<SNMP_IPADDRESS>, C<SNMP_COUNTER32>, C<SNMP_UNSIGNED32>,	234	C<SNMP_COUNTER32>, C<SNMP_UNSIGNED32>, C<SNMP_TIMETICKS> and
151	C<SNMP_TIMETICKS>, C<SNMP_OPAQUE> and C<SNMP_COUNTER64>.	235	C<SNMP_COUNTER64>.
152		236
153	The I<CONSTRUCTED> flag is really just a boolean - if it is false, the	237	The I<FLAGS> value is really just a boolean at this time (but might
154	the value is "primitive" and contains no subvalues, kind of like a	238	get extended) - if it is C<0>, the value is "primitive" and contains
155	non-reference perl scalar. IF it is true, then the value is "constructed"	239	no subvalues, kind of like a non-reference perl scalar. If it is C<1>,
156	which just means it contains a list of subvalues which this module will	240	then the value is "constructed" which just means it contains a list of
157	en-/decode as BER tuples themselves.	241	subvalues which this module will en-/decode as BER tuples themselves.
158		242
159	The I<DATA> value is either a reference to an array of further tuples (if	243	The I<DATA> value is either a reference to an array of further tuples
160	the value is I<CONSTRUCTED>), some decoded representation of the value,	244	(if the value is I<FLAGS>), some decoded representation of the value, if
161	if this module knows how to decode it (e.g. for the integer types above)	245	this module knows how to decode it (e.g. for the integer types above) or
162	or a binary string with the raw octets if this module doesn't know how to	246	a binary string with the raw octets if this module doesn't know how to
163	interpret the namespace/tag.	247	interpret the namespace/tag.
164		248
165	Thus, you can always decode a BER data structure and at worst you get a	249	Thus, you can always decode a BER data structure and at worst you get a
166	string in place of some nice decoded value.	250	string in place of some nice decoded value.
167		251
…		…
169		253
170	=head2 DECODING AND ENCODING	254	=head2 DECODING AND ENCODING
171		255
172	=over	256	=over
173		257
174	=item $tuple = ber_decoded $bindata	258	=item $tuple = ber_decoded $bindata[, $profile]
175		259
176	Decodes binary BER data in C<$bindata> and returns the resulting BER	260	Decodes binary BER data in C<$bindata> and returns the resulting BER
177	tuple. Croaks on any decoding error, so the returned C<$tuple> is always	261	tuple. Croaks on any decoding error, so the returned C<$tuple> is always
178	valid.	262	valid.
179		263
		264	How tags are interpreted is defined by the second argument, which must
		265	be a C<Convert::BER::XS::Profile> object. If it is missing, the default
		266	profile will be used (C<$Convert::BER::XS::DEFAULT_PROFILE>).
		267
		268	In addition to rolling your own, this module provides a
		269	C<$Convert::BER::XS::SNMP_PROFILE> that knows about the additional SNMP
		270	types.
		271
		272	Example: decode a BER blob using the default profile - SNMP values will be
		273	decided as raw strings.
		274
		275	$tuple = ber_decode $data;
		276
		277	Example: as above, but use the provided SNMP profile.
		278
		279	$tuple = ber_encode $data, $Convert::BER::XS::SNMP_PROFILE;
		280
180	=item $bindata = ber_encode $tuple	281	=item $bindata = ber_encode $tuple[, $profile]
181		282
182	Encodes the BER tuple into a BER/DER data structure.	283	Encodes the BER tuple into a BER/DER data structure. AS with
		284	Cyber_decode>, an optional profile can be given.
		285
		286	The encoded data should be both BER and DER ("shortest form") compliant
		287	unless the input says otherwise (e.g. it uses constructed strings).
183		288
184	=back	289	=back
185		290
186	=head2 HELPER FUNCTIONS	291	=head2 HELPER FUNCTIONS
187		292
188	Working with a 4-tuple for every value can be annoying. Or, rather, I<is>	293	Working with a 4-tuple for every value can be annoying. Or, rather, I<is>
189	annoying. To reduce this a bit, this module defines a number of helper	294	annoying. To reduce this a bit, this module defines a number of helper
190	functions, both to match BER tuples and to conmstruct BER tuples:	295	functions, both to match BER tuples and to construct BER tuples:
191		296
192	=head3 MATCH HELPERS	297	=head3 MATCH HELPERS
193		298
194	Thse functions accept a BER tuple as first argument and either paertially	299	These functions accept a BER tuple as first argument and either partially
195	or fully match it. They often come in two forms, one which exactly matches	300	or fully match it. They often come in two forms, one which exactly matches
196	a value, and one which only matches the type and returns the value.	301	a value, and one which only matches the type and returns the value.
197		302
198	They do check whether valid tuples are passed in and croak otherwise. As	303	They do check whether valid tuples are passed in and croak otherwise. As
199	a ease-of-use exception, they usually also accept C<undef> instead of a	304	a ease-of-use exception, they usually also accept C<undef> instead of a
200	tuple reference. in which case they silently fail to match.	305	tuple reference, in which case they silently fail to match.
201		306
202	=over	307	=over
203		308
204	=item $bool = ber_is $tuple, $class, $tag, $constructed, $data	309	=item $bool = ber_is $tuple, $class, $tag, $flags, $data
205		310
206	This takes a BER C<$tuple> and matches its elements agains the privded	311	This takes a BER C<$tuple> and matches its elements against the provided
207	values, all of which are optional - values that are either missing or	312	values, all of which are optional - values that are either missing or
208	C<undef> will be ignored, the others will be matched exactly (e.g. as if	313	C<undef> will be ignored, the others will be matched exactly (e.g. as if
209	you used C<==> or C<eq> (for C<$data>)).	314	you used C<==> or C<eq> (for C<$data>)).
210		315
211	Some examples:	316	Some examples:
…		…
214	orf die "tuple is not an ASN SEQUENCE";	319	orf die "tuple is not an ASN SEQUENCE";
215		320
216	ber_is $tuple, ASN_UNIVERSAL, ASN_NULL	321	ber_is $tuple, ASN_UNIVERSAL, ASN_NULL
217	or die "tuple is not an ASN NULL value";	322	or die "tuple is not an ASN NULL value";
218		323
219	ber_is $tuple, ASN_UNIVERSAL, ASN_INTEGER32, 0, 50	324	ber_is $tuple, ASN_UNIVERSAL, ASN_INTEGER, 0, 50
220	or die "BER integer must be 50";	325	or die "BER integer must be 50";
221		326
222	=item $seq = ber_is_seq $tuple	327	=item $seq = ber_is_seq $tuple
223		328
224	Returns the sequence members (the array of subvalues) if the C<$tuple> is	329	Returns the sequence members (the array of subvalues) if the C<$tuple> is
…		…
231	my $snmp = ber_is_seq $ber	336	my $snmp = ber_is_seq $ber
232	or die "SNMP packet invalid: does not start with SEQUENCE";	337	or die "SNMP packet invalid: does not start with SEQUENCE";
233		338
234	# now we know $snmp is a sequence, so decode the SNMP version	339	# now we know $snmp is a sequence, so decode the SNMP version
235		340
236	my $version = ber_is_i32 $snmp->[0]	341	my $version = ber_is_int $snmp->[0]
237	or die "SNMP packet invalid: does not start with version number";	342	or die "SNMP packet invalid: does not start with version number";
238		343
239	=item $bool = ber_is_i32 $tuple, $i32	344	=item $bool = ber_is_int $tuple, $int
240		345
241	Returns a true value if the C<$tuple> represents an ASN INTEGER32 with	346	Returns a true value if the C<$tuple> represents an ASN INTEGER with
242	the value C<$i32>.	347	the value C<$int>.
243		348
244	=item $i32 = ber_is_i32 $tuple	349	=item $int = ber_is_int $tuple
245		350
246	Returns true (and extracts the integer value) if the C<$tuple> is an ASN	351	Returns true (and extracts the integer value) if the C<$tuple> is an
247	INTEGER32. For C<0>, this function returns a special value that is 0 but	352	C<ASN_INTEGER>. For C<0>, this function returns a special value that is 0
248	true.	353	but true.
249		354
250	=item $bool = ber_is_oid $tuple, $oid_string	355	=item $bool = ber_is_oid $tuple, $oid_string
251		356
252	Returns true if the C<$tuple> represents an ASN_OBJECT_IDENTIFIER	357	Returns true if the C<$tuple> represents an ASN_OBJECT_IDENTIFIER
253	that exactly matches C<$oid_string>. Example:	358	that exactly matches C<$oid_string>. Example:
…		…
264		369
265	=head3 CONSTRUCTION HELPERS	370	=head3 CONSTRUCTION HELPERS
266		371
267	=over	372	=over
268		373
269	=item $tuple = ber_i32 $value	374	=item $tuple = ber_int $value
270		375
271	Constructs a new C<ASN_INTEGER32> tuple.	376	Constructs a new C<ASN_INTEGER> tuple.
272		377
273	=back	378	=back
274		379
275	=head2 RELATIONSHIP TO L<Convert::BER> and L<Convert::ASN1>	380	=head2 RELATIONSHIP TO L<Convert::BER> and L<Convert::ASN1>
276		381
…		…
289	use Exporter qw(import);	394	use Exporter qw(import);
290		395
291	our $VERSION;	396	our $VERSION;
292		397
293	BEGIN {	398	BEGIN {
294	$VERSION = 0.7;	399	$VERSION = 0.9;
295	XSLoader::load __PACKAGE__, $VERSION;	400	XSLoader::load __PACKAGE__, $VERSION;
296	}	401	}
297		402
298	our %EXPORT_TAGS = (	403	our %EXPORT_TAGS = (
		404	const_index => [qw(
		405	BER_CLASS BER_TAG BER_FLAGS BER_DATA
		406	)],
299	const => [qw(	407	const_asn => [qw(
300	BER_CLASS BER_TAG BER_CONSTRUCTED BER_DATA
301
302	ASN_BOOLEAN ASN_INTEGER32 ASN_BIT_STRING ASN_OCTET_STRING ASN_NULL ASN_OBJECT_IDENTIFIER	408	ASN_BOOLEAN ASN_INTEGER ASN_BIT_STRING ASN_OCTET_STRING ASN_NULL ASN_OBJECT_IDENTIFIER
303	ASN_OBJECT_DESCRIPTOR ASN_OID ASN_EXTERNAL ASN_REAL ASN_SEQUENCE ASN_ENUMERATED	409	ASN_OBJECT_DESCRIPTOR ASN_OID ASN_EXTERNAL ASN_REAL ASN_SEQUENCE ASN_ENUMERATED
304	ASN_EMBEDDED_PDV ASN_UTF8_STRING ASN_RELATIVE_OID ASN_SET ASN_NUMERIC_STRING	410	ASN_EMBEDDED_PDV ASN_UTF8_STRING ASN_RELATIVE_OID ASN_SET ASN_NUMERIC_STRING
305	ASN_PRINTABLE_STRING ASN_TELETEX_STRING ASN_T61_STRING ASN_VIDEOTEX_STRING ASN_IA5_STRING	411	ASN_PRINTABLE_STRING ASN_TELETEX_STRING ASN_T61_STRING ASN_VIDEOTEX_STRING ASN_IA5_STRING
306	ASN_ASCII_STRING ASN_UTC_TIME ASN_GENERALIZED_TIME ASN_GRAPHIC_STRING ASN_VISIBLE_STRING	412	ASN_ASCII_STRING ASN_UTC_TIME ASN_GENERALIZED_TIME ASN_GRAPHIC_STRING ASN_VISIBLE_STRING
307	ASN_ISO646_STRING ASN_GENERAL_STRING ASN_UNIVERSAL_STRING ASN_CHARACTER_STRING ASN_BMP_STRING	413	ASN_ISO646_STRING ASN_GENERAL_STRING ASN_UNIVERSAL_STRING ASN_CHARACTER_STRING ASN_BMP_STRING
308		414
309	ASN_UNIVERSAL ASN_APPLICATION ASN_CONTEXT ASN_PRIVATE	415	ASN_UNIVERSAL ASN_APPLICATION ASN_CONTEXT ASN_PRIVATE
310		416	)],
		417	const_ber_type => [qw(
311	BER_TYPE_BYTES BER_TYPE_UTF8 BER_TYPE_UCS2 BER_TYPE_UCS4 BER_TYPE_INT	418	BER_TYPE_BYTES BER_TYPE_UTF8 BER_TYPE_UCS2 BER_TYPE_UCS4 BER_TYPE_INT
312	BER_TYPE_OID BER_TYPE_RELOID BER_TYPE_NULL BER_TYPE_BOOL BER_TYPE_REAL	419	BER_TYPE_OID BER_TYPE_RELOID BER_TYPE_NULL BER_TYPE_BOOL BER_TYPE_REAL
313	BER_TYPE_IPADDRESS BER_TYPE_CROAK	420	BER_TYPE_IPADDRESS BER_TYPE_CROAK
314	)],	421	)],
315	const_snmp => [qw(	422	const_snmp => [qw(
316	SNMP_IPADDRESS SNMP_COUNTER32 SNMP_UNSIGNED32 SNMP_TIMETICKS SNMP_OPAQUE SNMP_COUNTER64	423	SNMP_IPADDRESS SNMP_COUNTER32 SNMP_GAUGE32 SNMP_UNSIGNED32
		424	SNMP_TIMETICKS SNMP_OPAQUE SNMP_COUNTER64
		425	)],
		426	decode => [qw(
		427	ber_decode
		428	ber_is ber_is_seq ber_is_int ber_is_oid
317	)],	429	)],
318	encode => [qw(	430	encode => [qw(
319	ber_decode
320	ber_is ber_is_seq ber_is_i32 ber_is_oid
321	)],
322	decode => [qw(
323	ber_encode	431	ber_encode
324	ber_i32	432	ber_int
325	)],	433	)],
326	);	434	);
327		435
328	our @EXPORT_OK = map @$_, values %EXPORT_TAGS;	436	our @EXPORT_OK = map @$_, values %EXPORT_TAGS;
329		437
330	$EXPORT_TAGS{all} = \@EXPORT_OK;	438	$EXPORT_TAGS{all} = \@EXPORT_OK;
		439	$EXPORT_TAGS{const} = [map @{ $EXPORT_TAGS{$_} }, qw(const_index const_asn)];
331		440
332	=head1 PROFILES	441	=head1 PROFILES
333		442
334	While any BER data can be correctly encoded and decoded out of the box, it	443	While any BER data can be correctly encoded and decoded out of the box, it
335	can be inconvenient to have to manually decode some values into a "better"	444	can be inconvenient to have to manually decode some values into a "better"
…		…
475	C<BER_TYPE_BYTES>. When you don't want that but instead prefer a hard	584	C<BER_TYPE_BYTES>. When you don't want that but instead prefer a hard
476	error for some types, then C<BER_TYPE_CROAK> is for you.	585	error for some types, then C<BER_TYPE_CROAK> is for you.
477		586
478	=back	587	=back
479		588
		589	=head2 Example Profile
		590
		591	The following creates a profile suitable for SNMP - it's exactly identical
		592	to the C<$Convert::BER::XS::SNMP_PROFILE> profile.
		593
		594	our $SNMP_PROFILE = new Convert::BER::XS::Profile;
		595
		596	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_IPADDRESS , BER_TYPE_IPADDRESS);
		597	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER32 , BER_TYPE_INT);
		598	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_UNSIGNED32, BER_TYPE_INT);
		599	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_TIMETICKS , BER_TYPE_INT);
		600	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_OPAQUE , BER_TYPE_IPADDRESS);
		601	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER64 , BER_TYPE_INT);
		602
480	=cut	603	=cut
481		604
482	our $DEFAULT_PROFILE = new Convert::BER::XS::Profile;	605	our $DEFAULT_PROFILE = new Convert::BER::XS::Profile;
		606
		607	$DEFAULT_PROFILE->_set_default;
		608
		609	# additional SNMP application types
483	our $SNMP_PROFILE = new Convert::BER::XS::Profile;	610	our $SNMP_PROFILE = new Convert::BER::XS::Profile;
484		611
485	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_IPADDRESS , BER_TYPE_IPADDRESS);	612	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_IPADDRESS , BER_TYPE_IPADDRESS);
486	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER32 , BER_TYPE_INT);	613	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER32 , BER_TYPE_INT);
487	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_UNSIGNED32, BER_TYPE_INT);	614	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_UNSIGNED32, BER_TYPE_INT);
488	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_TIMETICKS , BER_TYPE_INT);	615	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_TIMETICKS , BER_TYPE_INT);
489	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_OPAQUE , BER_TYPE_IPADDRESS);	616	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_OPAQUE , BER_TYPE_IPADDRESS);
490	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER64 , BER_TYPE_INT);	617	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER64 , BER_TYPE_INT);
491		618
492	$DEFAULT_PROFILE->_set_default;
493
494	1;	619	1;
495		620
496	=head2 LIMITATIONS	621	=head2 LIMITATIONS/NOTES
497		622
498	This module can only en-/decode 64 bit signed and unsigned integers, and	623	This module can only en-/decode 64 bit signed and unsigned integers, and
499	only when your perl supports those.	624	only when your perl supports those.
500		625
		626	This module does not generally care about ranges, i.e. it will happily
		627	de-/encode 64 bit integers into an C<ASN_INTEGER> value, or a negative
		628	number into an C<SNMP_COUNTER64>.
		629
501	OBJECT IDENTIFIEERs cannot have unlimited length, although the limit is	630	OBJECT IDENTIFIEERs cannot have unlimited length, although the limit is
502	much larger than e.g. the one imposed by SNMP or other protocols.	631	much larger than e.g. the one imposed by SNMP or other protocols,a nd is
		632	about 4kB.
503		633
		634	Indefinite length encoding is not supported.
		635
		636	Constructed strings are decoded just fine, but there should be a way to
		637	join them for convenience.
		638
504	REAL values are not supported and will croak.	639	REAL values are not supported and will currently croak.
		640
		641	The encoder and decoder tend to accept more formats than should be
		642	strictly supported.
505		643
506	This module has undergone little to no testing so far.	644	This module has undergone little to no testing so far.
		645
		646	=head2 ITHREADS SUPPORT
		647
		648	This module is unlikely to work when the (officially discouraged) ithreads
		649	are in use.
507		650
508	=head1 AUTHOR	651	=head1 AUTHOR
509		652
510	Marc Lehmann <schmorp@schmorp.de>	653	Marc Lehmann <schmorp@schmorp.de>
511	http://software.schmorp.de/pkg/Convert-BER-XS	654	http://software.schmorp.de/pkg/Convert-BER-XS

Diff Legend

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

Comparing Convert-BER-XS/XS.pm (file contents): Revision 1.16 by root, Sat Apr 20 02:07:45 2019 UTC vs. Revision 1.33 by root, Sat Apr 20 17:23:21 2019 UTC

Diff Legend

Comparing Convert-BER-XS/XS.pm (file contents):
Revision 1.16 by root, Sat Apr 20 02:07:45 2019 UTC vs.
Revision 1.33 by root, Sat Apr 20 17:23:21 2019 UTC