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

Comparing Convert-BER-XS/XS.pm (file contents):
Revision 1.22 by root, Sat Apr 20 14:50:08 2019 UTC vs.
Revision 1.48 by root, Sun Apr 21 12:00:42 2019 UTC

…		…
8		8
9	my $ber = ber_decode $buf, $Convert::BER::XS::SNMP_PROFILE	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, SNMP_IPADDRESS, 0, "10.0.0.1" ], # SNMP IpAddress	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, SNMP_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	[
…		…
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";
46		49
47	ber_is $msg->[0], ASN_UNIVERSAL, ASN_INTEGER32, 0	50	ber_is $msg->[0], ASN_UNIVERSAL, ASN_INTEGER, 0
48	or die "SNMP message does not start with snmp version\n";	51	or die "SNMP message does not start with snmp version\n";
49		52
50	# message is SNMP v1 or v2c?	53	# message is SNMP v1 or v2c?
51	if ($msg->[0][BER_DATA] == 0 \|\| $msg->[0][BER_DATA] == 1) {	54	if ($msg->[0][BER_DATA] == 0 \|\| $msg->[0][BER_DATA] == 1) {
52		55
…		…
55	my $trap = $msg->[2][BER_DATA];	58	my $trap = $msg->[2][BER_DATA];
56		59
57	# check whether trap is a cisco mac notification mac changed message	60	# check whether trap is a cisco mac notification mac changed message
58	if (	61	if (
59	(ber_is_oid $trap->[0], "1.3.6.1.4.1.9.9.215.2") # cmnInterfaceObjects	62	(ber_is_oid $trap->[0], "1.3.6.1.4.1.9.9.215.2") # cmnInterfaceObjects
60	and (ber_is_i32 $trap->[2], 6)	63	and (ber_is_int $trap->[2], 6)
61	and (ber_is_i32 $trap->[3], 1) # mac changed msg	64	and (ber_is_int $trap->[3], 1) # mac changed msg
62	) {	65	) {
63	... and so on	66	... and so on
64		67
65	# finally, let's encode it again and hope it results in the same bit pattern	68	# finally, let's encode it again and hope it results in the same bit pattern
66		69
…		…
76	level of user-friendlyness.	79	level of user-friendlyness.
77		80
78	=head2 EXPORT TAGS AND CONSTANTS	81	=head2 EXPORT TAGS AND CONSTANTS
79		82
80	By default this module doesn't export any symbols, but if you don't want	83	By default this module doesn't export any symbols, but if you don't want
81	to break your keyboard, editor or eyesigh with extreemly long names, I	84	to break your keyboard, editor or eyesight with extremely long names, I
82	recommend importing the C<:all> tag. Still, you can selectively import	85	recommend importing the C<:all> tag. Still, you can selectively import
83	things.	86	things.
84		87
85	=over	88	=over
86		89
87	=item C<:all>	90	=item C<:all>
88		91
89	All of the below. Really. Rcommended for at least first steps, or if you	92	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).	93	don't care about a few kilobytes of wasted memory (and namespace).
91		94
92	=item C<:const>	95	=item C<:const>
93		96
94	All of the stricly ASN.1-related constants defined by this module, the	97	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	98	same as C<:const_asn :const_index>. Notably, this does not contain
96	C<:const_ber_type> and C<:const_snmp>.	99	C<:const_ber_type> and C<:const_snmp>.
97		100
98	A good set to get everything you need to decode and match BER data would be	101	A good set to get everything you need to decode and match BER data would be
99	C<:decode :const>.	102	C<:decode :const>.
100		103
101	=item C<:const_index>	104	=item C<:const_index>
102		105
103	The BER tuple array index constants:	106	The BER tuple array index constants:
104		107
105	BER_CLASS BER_TAG BER_CONSTRUCTED BER_DATA	108	BER_CLASS BER_TAG BER_FLAGS BER_DATA
106		109
107	=item C<:const_asn>	110	=item C<:const_asn>
108		111
109	ASN class values (these are C<0>, C<1>, C<2> and C<3>, reespectively -	112	ASN class values (these are C<0>, C<1>, C<2> and C<3>, respectively -
110	exactly thw two topmost bits from the identifdier octet shifted 6 bits to	113	exactly thw two topmost bits from the identifier octet shifted 6 bits to
111	the right):	114	the right):
112		115
113	ASN_UNIVERSAL ASN_APPLICATION ASN_CONTEXT ASN_PRIVATE	116	ASN_UNIVERSAL ASN_APPLICATION ASN_CONTEXT ASN_PRIVATE
114		117
115	ASN tag values (some of which are aliases, such as C<ASN_OID>). Their	118	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.	119	numerical value corresponds exactly to the numbers used in BER/X.690.
117		120
118	ASN_BOOLEAN ASN_INTEGER32 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
…		…
134		137
135	Constants only relevant to SNMP. These are the tag values used by SNMP in	138	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	139	the C<ASN_APPLICATION> namespace and have the exact numerical value as in
137	BER/RFC 2578.	140	BER/RFC 2578.
138		141
139	SNMP_IPADDRESS SNMP_COUNTER32 SNMP_UNSIGNED32 SNMP_TIMETICKS SNMP_OPAQUE SNMP_COUNTER64	142	SNMP_IPADDRESS SNMP_COUNTER32 SNMP_UNSIGNED32 SNMP_GAUGE32
		143	SNMP_TIMETICKS SNMP_OPAQUE SNMP_COUNTER64
140		144
141	=item C<:decode>	145	=item C<:decode>
142		146
143	C<ber_decode> and the match helper functions:	147	C<ber_decode> and the match helper functions:
144		148
		149	ber_decode ber-decode_prefix
145	ber_decode ber_is ber_is_seq ber_is_i32 ber_is_oid	150	ber_is ber_is_seq ber_is_int ber_is_oid
		151	ber_dump
146		152
147	=item C<:encode>	153	=item C<:encode>
148		154
149	C<ber_encode> and the construction helper functions:	155	C<ber_encode> and the construction helper functions:
150		156
151	ber_encode ber_i32	157	ber_encode
		158	ber_int
152		159
153	=back	160	=back
154		161
155	=head2 ASN.1/BER/DER/... BASICS	162	=head2 ASN.1/BER/DER/... BASICS
156		163
157	ASN.1 is a strange language that can be used to describe protocols and	164	ASN.1 is a strange language that can be used to describe protocols and
158	data structures. It supports various mappings to JSON, XML, but most	165	data structures. It supports various mappings to JSON, XML, but most
159	importantly, to a various binary encodings such as BER, that is the topic	166	importantly, to a various binary encodings such as BER, that is the topic
160	of this module, and is used in SNMP or LDAP for example.	167	of this module, and is used in SNMP, LDAP or X.509 for example.
161		168
162	While ASN.1 defines a schema that is useful to interpret encoded data,	169	While ASN.1 defines a schema that is useful to interpret encoded data,
163	the BER encoding is actually somewhat self-describing: you might not know	170	the BER encoding is actually somewhat self-describing: you might not know
164	whether something is a string or a number or a sequence or something else,	171	whether something is a string or a number or a sequence or something else,
165	but you can nevertheless decode the overall structure, even if you end up	172	but you can nevertheless decode the overall structure, even if you end up
…		…
167		174
168	This works because BER values are tagged with a type and a namespace,	175	This works because BER values are tagged with a type and a namespace,
169	and also have a flag that says whether a value consists of subvalues (is	176	and also have a flag that says whether a value consists of subvalues (is
170	"constructed") or not (is "primitive").	177	"constructed") or not (is "primitive").
171		178
172	Tags are simple integers, and ASN.1 defines a somewhat weird assortment of	179	Tags are simple integers, and ASN.1 defines a somewhat weird assortment
173	those - for example, you have 32 bit signed integers and 16(!) different	180	of those - for example, you have one integers and 16(!) different
174	string types, but there is no unsigned32 type for example. Different	181	string types, but there is no Unsigned32 type for example. Different
175	applications work around this in different ways, for example, SNMP defines	182	applications work around this in different ways, for example, SNMP defines
176	application-specific Gauge32, Counter32 and Unsigned32, which are mapped	183	application-specific Gauge32, Counter32 and Unsigned32, which are mapped
177	to two different tags: you can distinguish between Counter32 and the	184	to two different tags: you can distinguish between Counter32 and the
178	others, but not between Gause32 and Unsigned32, without the ASN.1 schema.	185	others, but not between Gause32 and Unsigned32, without the ASN.1 schema.
179		186
…		…
182	=head2 DECODED BER REPRESENTATION	189	=head2 DECODED BER REPRESENTATION
183		190
184	This module represents every BER value as a 4-element tuple (actually an	191	This module represents every BER value as a 4-element tuple (actually an
185	array-reference):	192	array-reference):
186		193
187	[CLASS, TAG, CONSTRUCTED, DATA]	194	[CLASS, TAG, FLAGS, DATA]
		195
		196	For example:
		197
		198	[ASN_UNIVERSAL, ASN_INTEGER, 0, 177] # the integer 177
		199	[ASN_UNIVERSAL, ASN_OCTET_STRING, 0, "john"] # the string "john"
		200	[ASN_UNIVERSAL, ASN_OID, 0, "1.3.6.133"] # some OID
		201	[ASN_UNIVERSAL, ASN_SEQUENCE, 1, [ [ASN_UNIVERSAL... # a sequence
188		202
189	To avoid non-descriptive hardcoded array index numbers, this module	203	To avoid non-descriptive hardcoded array index numbers, this module
190	defines symbolic constants to access these members: C<BER_CLASS>,	204	defines symbolic constants to access these members: C<BER_CLASS>,
191	C<BER_TAG>, C<BER_CONSTRUCTED> and C<BER_DATA>.	205	C<BER_TAG>, C<BER_FLAGS> and C<BER_DATA>.
192		206
193	Also, the first three members are integers with a little caveat: for	207	Also, the first three members are integers with a little caveat: for
194	performance reasons, these are readonly and shared, so you must not modify	208	performance reasons, these are readonly and shared, so you must not modify
195	them (increment, assign to them etc.) in any way. You may modify the	209	them (increment, assign to them etc.) in any way. You may modify the
196	I<DATA> member, and you may re-assign the array itself, e.g.:	210	I<DATA> member, and you may re-assign the array itself, e.g.:
197		211
198	$ber = ber_decode $binbuf;	212	$ber = ber_decode $binbuf;
199		213
200	# the following is NOT legal:	214	# the following is NOT legal:
201	$ber->[BER_CLASS] = ASN_PRIVATE; # ERROR, CLASS/TAG/CONSTRUCTED are READ ONLY(!)	215	$ber->[BER_CLASS] = ASN_PRIVATE; # ERROR, CLASS/TAG/FLAGS are READ ONLY(!)
202		216
203	# but all of the following are fine:	217	# but all of the following are fine:
204	$ber->[BER_DATA] = "string";	218	$ber->[BER_DATA] = "string";
205	$ber->[BER_DATA] = [ASN_UNIVERSAL, ASN_INTEGER32, 0, 123];	219	$ber->[BER_DATA] = [ASN_UNIVERSAL, ASN_INTEGER, 0, 123];
206	@$ber = (ASN_APPLICATION, SNMP_TIMETICKS, 0, 1000);	220	@$ber = (ASN_APPLICATION, SNMP_TIMETICKS, 0, 1000);
207		221
208	I<CLASS> is something like a namespace for I<TAG>s - there is the	222	I<CLASS> is something like a namespace for I<TAG>s - there is the
209	C<ASN_UNIVERSAL> namespace which defines tags common to all ASN.1	223	C<ASN_UNIVERSAL> namespace which defines tags common to all ASN.1
210	implementations, the C<ASN_APPLICATION> namespace which defines tags for	224	implementations, the C<ASN_APPLICATION> namespace which defines tags for
211	specific applications (for example, the SNMP C<Unsigned32> type is in this	225	specific applications (for example, the SNMP C<Unsigned32> type is in this
212	namespace), a special-purpose context namespace (C<ASN_CONTEXT>, used e.g.	226	namespace), a special-purpose context namespace (C<ASN_CONTEXT>, used e.g.
213	for C<CHOICE>) and a private namespace (C<ASN_PRIVATE>).	227	for C<CHOICE>) and a private namespace (C<ASN_PRIVATE>).
214		228
215	The meaning of the I<TAG> depends on the namespace, and defines a	229	The meaning of the I<TAG> depends on the namespace, and defines a
216	(partial) interpretation of the data value. For example, right now, SNMP	230	(partial) interpretation of the data value. For example, SNMP defines
217	application namespace knowledge ix hardcoded into this module, so it	231	extra tags in the C<ASN_APPLICATION> namespace, and to take full advantage
218	knows that SNMP C<Unsigned32> values need to be decoded into actual perl	232	of these, you need to tell this module how to handle those via profiles.
219	integers.
220		233
221	The most common tags in the C<ASN_UNIVERSAL> namespace are	234	The most common tags in the C<ASN_UNIVERSAL> namespace are
222	C<ASN_INTEGER32>, C<ASN_BIT_STRING>, C<ASN_NULL>, C<ASN_OCTET_STRING>,	235	C<ASN_INTEGER>, C<ASN_BIT_STRING>, C<ASN_NULL>, C<ASN_OCTET_STRING>,
223	C<ASN_OBJECT_IDENTIFIER>, C<ASN_SEQUENCE>, C<ASN_SET> and	236	C<ASN_OBJECT_IDENTIFIER>, C<ASN_SEQUENCE>, C<ASN_SET> and
224	C<ASN_IA5_STRING>.	237	C<ASN_IA5_STRING>.
225		238
226	The most common tags in SNMP's C<ASN_APPLICATION> namespace	239	The most common tags in SNMP's C<ASN_APPLICATION> namespace are
227	are C<SNMP_IPADDRESS>, C<SNMP_COUNTER32>, C<SNMP_UNSIGNED32>,	240	C<SNMP_COUNTER32>, C<SNMP_UNSIGNED32>, C<SNMP_TIMETICKS> and
228	C<SNMP_TIMETICKS>, C<SNMP_OPAQUE> and C<SNMP_COUNTER64>.	241	C<SNMP_COUNTER64>.
229		242
230	The I<CONSTRUCTED> flag is really just a boolean - if it is false, the	243	The I<FLAGS> value is really just a boolean at this time (but might
231	the value is "primitive" and contains no subvalues, kind of like a	244	get extended) - if it is C<0>, the value is "primitive" and contains
232	non-reference perl scalar. IF it is true, then the value is "constructed"	245	no subvalues, kind of like a non-reference perl scalar. If it is C<1>,
233	which just means it contains a list of subvalues which this module will	246	then the value is "constructed" which just means it contains a list of
234	en-/decode as BER tuples themselves.	247	subvalues which this module will en-/decode as BER tuples themselves.
235		248
236	The I<DATA> value is either a reference to an array of further tuples (if	249	The I<DATA> value is either a reference to an array of further tuples
237	the value is I<CONSTRUCTED>), some decoded representation of the value,	250	(if the value is I<FLAGS>), some decoded representation of the value, if
238	if this module knows how to decode it (e.g. for the integer types above)	251	this module knows how to decode it (e.g. for the integer types above) or
239	or a binary string with the raw octets if this module doesn't know how to	252	a binary string with the raw octets if this module doesn't know how to
240	interpret the namespace/tag.	253	interpret the namespace/tag.
241		254
242	Thus, you can always decode a BER data structure and at worst you get a	255	Thus, you can always decode a BER data structure and at worst you get a
243	string in place of some nice decoded value.	256	string in place of some nice decoded value.
244		257
…		…
246		259
247	=head2 DECODING AND ENCODING	260	=head2 DECODING AND ENCODING
248		261
249	=over	262	=over
250		263
251	=item $tuple = ber_decoded $bindata	264	=item $tuple = ber_decode $bindata[, $profile]
252		265
253	Decodes binary BER data in C<$bindata> and returns the resulting BER	266	Decodes binary BER data in C<$bindata> and returns the resulting BER
254	tuple. Croaks on any decoding error, so the returned C<$tuple> is always	267	tuple. Croaks on any decoding error, so the returned C<$tuple> is always
255	valid.	268	valid.
256		269
		270	How tags are interpreted is defined by the second argument, which must
		271	be a C<Convert::BER::XS::Profile> object. If it is missing, the default
		272	profile will be used (C<$Convert::BER::XS::DEFAULT_PROFILE>).
		273
		274	In addition to rolling your own, this module provides a
		275	C<$Convert::BER::XS::SNMP_PROFILE> that knows about the additional SNMP
		276	types.
		277
		278	Example: decode a BER blob using the default profile - SNMP values will be
		279	decided as raw strings.
		280
		281	$tuple = ber_decode $data;
		282
		283	Example: as above, but use the provided SNMP profile.
		284
		285	$tuple = ber_encode $data, $Convert::BER::XS::SNMP_PROFILE;
		286
		287	=item ($tuple, $bytes) = ber_decode_prefix $bindata[, $profile]
		288
		289	Works like C<ber_decode>, except it doesn't croak when there is data after
		290	the BER data, but instead returns the decoded value and the number of
		291	bytes it decoded.
		292
		293	This is useful when you have BER data at the start of a buffer and other
		294	data after, and you need to find the length.
		295
		296	Also, since BER is self-delimited, this can be used to decode multiple BER
		297	values joined together.
		298
257	=item $bindata = ber_encode $tuple	299	=item $bindata = ber_encode $tuple[, $profile]
258		300
259	Encodes the BER tuple into a BER/DER data structure.	301	Encodes the BER tuple into a BER/DER data structure. AS with
		302	Cyber_decode>, an optional profile can be given.
		303
		304	The encoded data should be both BER and DER ("shortest form") compliant
		305	unless the input says otherwise (e.g. it uses constructed strings).
260		306
261	=back	307	=back
262		308
263	=head2 HELPER FUNCTIONS	309	=head2 HELPER FUNCTIONS
264		310
265	Working with a 4-tuple for every value can be annoying. Or, rather, I<is>	311	Working with a 4-tuple for every value can be annoying. Or, rather, I<is>
266	annoying. To reduce this a bit, this module defines a number of helper	312	annoying. To reduce this a bit, this module defines a number of helper
267	functions, both to match BER tuples and to conmstruct BER tuples:	313	functions, both to match BER tuples and to construct BER tuples:
268		314
269	=head3 MATCH HELPERS	315	=head3 MATCH HELPERS
270		316
271	Thse functions accept a BER tuple as first argument and either paertially	317	These functions accept a BER tuple as first argument and either partially
272	or fully match it. They often come in two forms, one which exactly matches	318	or fully match it. They often come in two forms, one which exactly matches
273	a value, and one which only matches the type and returns the value.	319	a value, and one which only matches the type and returns the value.
274		320
275	They do check whether valid tuples are passed in and croak otherwise. As	321	They do check whether valid tuples are passed in and croak otherwise. As
276	a ease-of-use exception, they usually also accept C<undef> instead of a	322	a ease-of-use exception, they usually also accept C<undef> instead of a
277	tuple reference. in which case they silently fail to match.	323	tuple reference, in which case they silently fail to match.
278		324
279	=over	325	=over
280		326
281	=item $bool = ber_is $tuple, $class, $tag, $constructed, $data	327	=item $bool = ber_is $tuple, $class, $tag, $flags, $data
282		328
283	This takes a BER C<$tuple> and matches its elements agains the privded	329	This takes a BER C<$tuple> and matches its elements against the provided
284	values, all of which are optional - values that are either missing or	330	values, all of which are optional - values that are either missing or
285	C<undef> will be ignored, the others will be matched exactly (e.g. as if	331	C<undef> will be ignored, the others will be matched exactly (e.g. as if
286	you used C<==> or C<eq> (for C<$data>)).	332	you used C<==> or C<eq> (for C<$data>)).
287		333
288	Some examples:	334	Some examples:
…		…
291	orf die "tuple is not an ASN SEQUENCE";	337	orf die "tuple is not an ASN SEQUENCE";
292		338
293	ber_is $tuple, ASN_UNIVERSAL, ASN_NULL	339	ber_is $tuple, ASN_UNIVERSAL, ASN_NULL
294	or die "tuple is not an ASN NULL value";	340	or die "tuple is not an ASN NULL value";
295		341
296	ber_is $tuple, ASN_UNIVERSAL, ASN_INTEGER32, 0, 50	342	ber_is $tuple, ASN_UNIVERSAL, ASN_INTEGER, 0, 50
297	or die "BER integer must be 50";	343	or die "BER integer must be 50";
298		344
299	=item $seq = ber_is_seq $tuple	345	=item $seq = ber_is_seq $tuple
300		346
301	Returns the sequence members (the array of subvalues) if the C<$tuple> is	347	Returns the sequence members (the array of subvalues) if the C<$tuple> is
…		…
308	my $snmp = ber_is_seq $ber	354	my $snmp = ber_is_seq $ber
309	or die "SNMP packet invalid: does not start with SEQUENCE";	355	or die "SNMP packet invalid: does not start with SEQUENCE";
310		356
311	# now we know $snmp is a sequence, so decode the SNMP version	357	# now we know $snmp is a sequence, so decode the SNMP version
312		358
313	my $version = ber_is_i32 $snmp->[0]	359	my $version = ber_is_int $snmp->[0]
314	or die "SNMP packet invalid: does not start with version number";	360	or die "SNMP packet invalid: does not start with version number";
315		361
316	=item $bool = ber_is_i32 $tuple, $i32	362	=item $bool = ber_is_int $tuple, $int
317		363
318	Returns a true value if the C<$tuple> represents an ASN INTEGER32 with	364	Returns a true value if the C<$tuple> represents an ASN INTEGER with
319	the value C<$i32>.	365	the value C<$int>.
320		366
321	=item $i32 = ber_is_i32 $tuple	367	=item $int = ber_is_int $tuple
322		368
323	Returns true (and extracts the integer value) if the C<$tuple> is an ASN	369	Returns true (and extracts the integer value) if the C<$tuple> is an
324	INTEGER32. For C<0>, this function returns a special value that is 0 but	370	C<ASN_INTEGER>. For C<0>, this function returns a special value that is 0
325	true.	371	but true.
326		372
327	=item $bool = ber_is_oid $tuple, $oid_string	373	=item $bool = ber_is_oid $tuple, $oid_string
328		374
329	Returns true if the C<$tuple> represents an ASN_OBJECT_IDENTIFIER	375	Returns true if the C<$tuple> represents an ASN_OBJECT_IDENTIFIER
330	that exactly matches C<$oid_string>. Example:	376	that exactly matches C<$oid_string>. Example:
…		…
341		387
342	=head3 CONSTRUCTION HELPERS	388	=head3 CONSTRUCTION HELPERS
343		389
344	=over	390	=over
345		391
346	=item $tuple = ber_i32 $value	392	=item $tuple = ber_int $value
347		393
348	Constructs a new C<ASN_INTEGER32> tuple.	394	Constructs a new C<ASN_INTEGER> tuple.
349		395
350	=back	396	=back
351		397
352	=head2 RELATIONSHIP TO L<Convert::BER> and L<Convert::ASN1>	398	=head2 RELATIONSHIP TO L<Convert::BER> and L<Convert::ASN1>
353		399
…		…
366	use Exporter qw(import);	412	use Exporter qw(import);
367		413
368	our $VERSION;	414	our $VERSION;
369		415
370	BEGIN {	416	BEGIN {
371	$VERSION = 0.8;	417	$VERSION = 1.1;
372	XSLoader::load __PACKAGE__, $VERSION;	418	XSLoader::load __PACKAGE__, $VERSION;
373	}	419	}
374		420
375	our %EXPORT_TAGS = (	421	our %EXPORT_TAGS = (
376	const_index => [qw(	422	const_index => [qw(
377	BER_CLASS BER_TAG BER_CONSTRUCTED BER_DATA	423	BER_CLASS BER_TAG BER_FLAGS BER_DATA
378	)],	424	)],
		425	const_asn_class => [qw(
		426	ASN_UNIVERSAL ASN_APPLICATION ASN_CONTEXT ASN_PRIVATE
		427	)],
379	const_asn => [qw(	428	const_asn_tag => [qw(
380	ASN_BOOLEAN ASN_INTEGER32 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
381	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
382	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
383	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
384	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
385	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
386
387	ASN_UNIVERSAL ASN_APPLICATION ASN_CONTEXT ASN_PRIVATE
388	)],	435	)],
389	const_ber_type => [qw(	436	const_ber_type => [qw(
390	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
391	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
392	BER_TYPE_IPADDRESS BER_TYPE_CROAK	439	BER_TYPE_IPADDRESS BER_TYPE_CROAK
393	)],	440	)],
394	const_snmp => [qw(	441	const_snmp => [qw(
395	SNMP_IPADDRESS SNMP_COUNTER32 SNMP_UNSIGNED32 SNMP_TIMETICKS SNMP_OPAQUE SNMP_COUNTER64	442	SNMP_IPADDRESS SNMP_COUNTER32 SNMP_GAUGE32 SNMP_UNSIGNED32
		443	SNMP_TIMETICKS SNMP_OPAQUE SNMP_COUNTER64
396	)],	444	)],
397	decode => [qw(	445	decode => [qw(
398	ber_decode	446	ber_decode ber_decode_prefix
399	ber_is ber_is_seq ber_is_i32 ber_is_oid	447	ber_is ber_is_seq ber_is_int ber_is_oid
		448	ber_dump
400	)],	449	)],
401	encode => [qw(	450	encode => [qw(
402	ber_encode	451	ber_encode
403	ber_i32	452	ber_int
404	)],	453	)],
405	);	454	);
406		455
407	our @EXPORT_OK = map @$_, values %EXPORT_TAGS;	456	our @EXPORT_OK = map @$_, values %EXPORT_TAGS;
408		457
409	$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)];
410	$EXPORT_TAGS{const} = [map @{ $EXPORT_TAGS{$_} }, qw(const_index const_asn)];	460	$EXPORT_TAGS{const} = [map @{ $EXPORT_TAGS{$_} }, qw(const_index const_asn)];
411	use Data::Dump; ddx \%EXPORT_TAGS;	461
		462	our $DEFAULT_PROFILE = new Convert::BER::XS::Profile;
		463
		464	$DEFAULT_PROFILE->_set_default;
		465
		466	# additional SNMP application types
		467	our $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
		477	To aid debugging, you cna call the C<ber_dump> function to print a "nice"
		478	representation to STDOUT.
		479
		480	=over
		481
		482	=item ber_dump $tuple[, $profile[, $prefix]]
		483
		484	In addition to specifying the BER C<$tuple> to dump, youc an also specify
		485	a C<$profile> and a C<$prefix> string that is printed in front of each line.
		486
		487	If C<$profile> is C<$Convert::BER::XS::SNMP_PROFILE>, then C<ber_dump>
		488	will try to improve its output for SNMP data.
		489
		490	The output usually contains three columns, the "human readable" tag, the
		491	BER type used to decode it, and the data value.
		492
		493	This function is somewhat slow and uses a number of heuristics and tricks,
		494	so it really is only suitable for debug prints.
		495
		496	Example 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	=back
		511
		512	=cut
		513
		514	# reverse enum, very slow and ugly hack
		515	sub _re {
		516	my ($export_tag, $value) = @_;
		517
		518	for my $symbol (@{ $EXPORT_TAGS{$export_tag} }) {
		519	$value == eval $symbol
		520	and return $symbol;
		521	}
		522
		523	"($value)"
		524	}
		525
		526	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER64 , BER_TYPE_INT);
		527
		528	sub _ber_dump {
		529	my ($ber, $profile, $indent) = @_;
		530
		531	if (my $seq = ber_is_seq $ber) {
		532	printf "%sSEQUENCE\n", $indent;
		533	&_ber_dump ($_, $profile, "$indent\| ")
		534	for @$seq;
		535	} else {
		536	my $asn = $ber->[BER_CLASS] == ASN_UNIVERSAL;
		537
		538	my $class = _re const_asn_class => $ber->[BER_CLASS];
		539	my $tag = $asn ? _re const_asn_tag => $ber->[BER_TAG] : $ber->[BER_TAG];
		540	my $type = _re const_ber_type => $profile->get ($ber->[BER_CLASS], $ber->[BER_TAG]);
		541	my $data = $ber->[BER_DATA];
		542
		543	if ($profile == $SNMP_PROFILE and $ber->[BER_CLASS] == ASN_APPLICATION) {
		544	$tag = _re const_snmp => $ber->[BER_TAG];
		545	} elsif (!$asn) {
		546	$tag = "$class ($tag)";
		547	}
		548
		549	$class =~ s/^ASN_//;
		550	$tag =~ s/^(ASN_\|SNMP_)//;
		551	$type =~ s/^BER_TYPE_//;
		552
		553	if ($ber->[BER_FLAGS]) {
		554	printf "$indent%-16.16s %-6.6s CONSTRUCTED\n", $tag, lc $type;
		555	&_ber_dump ($_, $profile, "$indent\| ")
		556	for @$data;
		557	} else {
		558	if ($data =~ y/\x20-\x7e//c / (length $data \|\| 1) > 0.2 or $data =~ /\x00./s) {
		559	# assume binary
		560	$data = unpack "H*", $data;
		561	} else {
		562	$data =~ s/[^\x20-\x7e]/./g;
		563	$data = "\"$data\"" if $type =~ /string/i \|\| !length $data;
		564	}
		565
		566	substr $data, 40, 1e9, "..." if 40 < length $data;
		567
		568	printf "$indent%-16.16s %-6.6s %s\n", $tag, lc $type, $data;
		569	}
		570	}
		571	}
		572
		573	sub ber_dump($;$$) {
		574	_ber_dump $_[0], $_[1] \|\| $DEFAULT_PROFILE, $_[2];
		575	}
412		576
413	=head1 PROFILES	577	=head1 PROFILES
414		578
415	While any BER data can be correctly encoded and decoded out of the box, it	579	While any BER data can be correctly encoded and decoded out of the box, it
416	can be inconvenient to have to manually decode some values into a "better"	580	can be inconvenient to have to manually decode some values into a "better"
…		…
477		641
478	Returns the BER type mapped to the given C<$class>/C<$tag> combination.	642	Returns the BER type mapped to the given C<$class>/C<$tag> combination.
479		643
480	=back	644	=back
481		645
482	=head2 BER TYPES	646	=head2 BER Types
483		647
484	This lists the predefined BER types - you can map any C<CLASS>/C<TAG>	648	This lists the predefined BER types. BER types are formatters used
485	combination to any C<BER_TYPE_*>.	649	internally to format and encode BER values. You can assign any C<BER_TYPE>
		650	to any C<CLASS>/C<TAG> combination tgo change how that tag is decoded or
		651	encoded.
486		652
487	=over	653	=over
488		654
489	=item C<BER_TYPE_BYTES>	655	=item C<BER_TYPE_BYTES>
490		656
…		…
556	C<BER_TYPE_BYTES>. When you don't want that but instead prefer a hard	722	C<BER_TYPE_BYTES>. When you don't want that but instead prefer a hard
557	error for some types, then C<BER_TYPE_CROAK> is for you.	723	error for some types, then C<BER_TYPE_CROAK> is for you.
558		724
559	=back	725	=back
560		726
561	=cut	727	=head2 Example Profile
562		728
563	our $DEFAULT_PROFILE = new Convert::BER::XS::Profile;	729	The following creates a profile suitable for SNMP - it's exactly identical
		730	to the C<$Convert::BER::XS::SNMP_PROFILE> profile.
		731
564	our $SNMP_PROFILE = new Convert::BER::XS::Profile;	732	our $SNMP_PROFILE = new Convert::BER::XS::Profile;
565		733
566	# additional SNMP application types
567	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_IPADDRESS , BER_TYPE_IPADDRESS);	734	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_IPADDRESS , BER_TYPE_IPADDRESS);
568	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER32 , BER_TYPE_INT);	735	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER32 , BER_TYPE_INT);
569	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_UNSIGNED32, BER_TYPE_INT);	736	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_UNSIGNED32, BER_TYPE_INT);
570	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_TIMETICKS , BER_TYPE_INT);	737	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_TIMETICKS , BER_TYPE_INT);
571	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_OPAQUE , BER_TYPE_IPADDRESS);	738	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_OPAQUE , BER_TYPE_IPADDRESS);
572	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER64 , BER_TYPE_INT);	739	$SNMP_PROFILE->set (ASN_APPLICATION, SNMP_COUNTER64 , BER_TYPE_INT);
573
574	$DEFAULT_PROFILE->_set_default;
575
576	1;
577		740
578	=head2 LIMITATIONS/NOTES	741	=head2 LIMITATIONS/NOTES
579		742
580	This module can only en-/decode 64 bit signed and unsigned integers, and	743	This module can only en-/decode 64 bit signed and unsigned integers, and
581	only when your perl supports those.	744	only when your perl supports those. So no UUID OIDs for now (unless you
		745	map the C<OBJECT IDENTIFIER> tag to something other than C<BER_TYPE_OID>).
582		746
583	This module does not generally care about ranges, i.e. it will happily	747	This module does not generally care about ranges, i.e. it will happily
584	de-/encode 64 bit integers into an C<ASN_INTEGER32> value, or a negative	748	de-/encode 64 bit integers into an C<ASN_INTEGER> value, or a negative
585	number into an C<SNMP_COUNTER64>.	749	number into an C<SNMP_COUNTER64>.
586		750
587	OBJECT IDENTIFIEERs cannot have unlimited length, although the limit is	751	OBJECT IDENTIFIEERs cannot have unlimited length, although the limit is
588	much larger than e.g. the one imposed by SNMP or other protocols,a nd is	752	much larger than e.g. the one imposed by SNMP or other protocols, and is
589	about 4kB.	753	about 4kB.
590		754
		755	Indefinite length encoding is not supported.
		756
		757	Constructed strings are decoded just fine, but there should be a way to
		758	join them for convenience.
		759
591	REAL values are not supported and will currently croak.	760	REAL values are not supported and will currently croak.
		761
		762	The encoder and decoder tend to accept more formats than should be
		763	strictly supported - security sensitive applications are strongly advised
		764	to review the code first.
592		765
593	This module has undergone little to no testing so far.	766	This module has undergone little to no testing so far.
594		767
595	=head2 ITHREADS SUPPORT	768	=head2 ITHREADS SUPPORT
596		769
…		…
602	Marc Lehmann <schmorp@schmorp.de>	775	Marc Lehmann <schmorp@schmorp.de>
603	http://software.schmorp.de/pkg/Convert-BER-XS	776	http://software.schmorp.de/pkg/Convert-BER-XS
604		777
605	=cut	778	=cut
606		779
		780	1;
		781

Diff Legend

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

Comparing Convert-BER-XS/XS.pm (file contents): Revision 1.22 by root, Sat Apr 20 14:50:08 2019 UTC vs. Revision 1.48 by root, Sun Apr 21 12:00:42 2019 UTC

Diff Legend

Comparing Convert-BER-XS/XS.pm (file contents):
Revision 1.22 by root, Sat Apr 20 14:50:08 2019 UTC vs.
Revision 1.48 by root, Sun Apr 21 12:00:42 2019 UTC