This repository has been archived by the owner on Feb 17, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 63
/
pdu.rb
409 lines (357 loc) · 11.8 KB
/
pdu.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
# frozen_string_literal: true
#
# Copyright (c) 2004-2014 David R. Halliday
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
require 'snmp/ber'
require 'snmp/varbind'
module SNMP
# Exceptions thrown during message/pdu decoding
class UnsupportedVersion < RuntimeError; end
class UnsupportedPduTag < RuntimeError; end
class InvalidPduTag < RuntimeError; end
class ParseError < RuntimeError; end
class InvalidErrorStatus < RuntimeError; end
class InvalidTrapVarbind < RuntimeError; end
class InvalidGenericTrap < RuntimeError; end
SYS_UP_TIME_OID = ObjectId.new("1.3.6.1.2.1.1.3.0")
SNMP_TRAP_OID_OID = ObjectId.new("1.3.6.1.6.3.1.1.4.1.0")
class Message
include SNMP::BER::Encode
extend SNMP::BER::Decode
attr_reader :version
attr_reader :community
attr_reader :pdu
class << self
def decode(data, mib=nil)
message_data, remainder = decode_sequence(data)
assert_no_remainder(remainder)
version, remainder = decode_version(message_data)
community, remainder = decode_octet_string(remainder)
pdu, remainder = decode_pdu(version, remainder, mib)
assert_no_remainder(remainder)
Message.new(version, community, pdu)
end
def decode_version(data)
version_data, remainder = decode_integer(data)
if version_data == BER::SNMP_V1
version = :SNMPv1
elsif version_data == BER::SNMP_V2C
version = :SNMPv2c
else
raise UnsupportedVersion, version_data.to_s
end
return version, remainder
end
def decode_pdu(version, data, mib=nil)
pdu_tag, pdu_data, remainder = decode_tlv(data)
case pdu_tag
when BER::GetRequest_PDU_TAG
pdu = PDU.decode(GetRequest, pdu_data, mib)
when BER::GetNextRequest_PDU_TAG
pdu = PDU.decode(GetNextRequest, pdu_data, mib)
when BER::Response_PDU_TAG
pdu = PDU.decode(Response, pdu_data, mib)
when BER::SetRequest_PDU_TAG
pdu = PDU.decode(SetRequest, pdu_data, mib)
when BER::SNMPv1_Trap_PDU_TAG
raise InvalidPduTag, "SNMPv1-trap not valid for #{version.to_s}" if version != :SNMPv1
pdu = SNMPv1_Trap.decode(pdu_data, mib)
when BER::GetBulkRequest_PDU_TAG
raise InvalidPduTag, "get-bulk not valid for #{version.to_s}" if version != :SNMPv2c
pdu = PDU.decode(GetBulkRequest, pdu_data, mib)
when BER::InformRequest_PDU_TAG
raise InvalidPduTag, "inform not valid for #{version.to_s}" if version != :SNMPv2c
pdu = PDU.decode(InformRequest, pdu_data, mib)
when BER::SNMPv2_Trap_PDU_TAG
raise InvalidPduTag, "SNMPv2c-trap not valid for #{version.to_s}" if version != :SNMPv2c
pdu = PDU.decode(SNMPv2_Trap, pdu_data, mib)
else
raise UnsupportedPduTag, pdu_tag.to_s
end
return pdu, remainder
end
end
def initialize(version, community, pdu)
@version = version
@community = community
@pdu = pdu
end
def response
Message.new(@version, @community, Response.from_pdu(@pdu))
end
def encode_version(version)
if version == :SNMPv1
encode_integer(BER::SNMP_V1)
elsif version == :SNMPv2c
encode_integer(BER::SNMP_V2C)
else
raise UnsupportedVersion, version.to_s
end
end
def encode
data = encode_version(@version)
data << encode_octet_string(@community)
data << @pdu.encode
encode_sequence(data)
end
end
class PDU
include SNMP::BER::Encode
extend SNMP::BER::Decode
attr_accessor :request_id
attr_accessor :error_index
attr_accessor :varbind_list
alias vb_list varbind_list
def self.decode(pdu_class, pdu_data, mib=nil)
request_id, remainder = decode_integer(pdu_data)
error_status, remainder = decode_integer(remainder)
error_index, remainder = decode_integer(remainder)
varbind_list, remainder = VarBindList.decode(remainder, mib)
assert_no_remainder(remainder)
pdu_class.new(request_id, varbind_list, error_status, error_index)
end
ERROR_STATUS_NAME = {
0 => :noError,
1 => :tooBig,
2 => :noSuchName,
3 => :badValue,
4 => :readOnly,
5 => :genErr,
6 => :noAccess,
7 => :wrongType,
8 => :wrongLength,
9 => :wrongEncoding,
10 => :wrongValue,
11 => :noCreation,
12 => :inconsistentValue,
13 => :resourceUnavailable,
14 => :commitFailed,
15 => :undoFailed,
16 => :authorizationError,
17 => :notWritable,
18 => :inconsistentName
}
ERROR_STATUS_CODE = ERROR_STATUS_NAME.invert
def initialize(request_id, varbind_list, error_status=0, error_index=0)
@request_id = request_id
self.error_status = error_status
@error_index = error_index.to_int
@varbind_list = varbind_list
end
def error_status=(status)
@error_status = ERROR_STATUS_CODE[status]
unless @error_status
if status.respond_to?(:to_int)
@error_status = status.to_int
else
raise InvalidErrorStatus, status.to_s
end
end
end
def error_status
ERROR_STATUS_NAME[@error_status] || @error_status
end
def encode_pdu(pdu_tag)
pdu_data = encode_integer(@request_id)
pdu_data << encode_integer(@error_status)
pdu_data << encode_integer(@error_index)
pdu_data << @varbind_list.encode
encode_tlv(pdu_tag, pdu_data)
end
def each_varbind(&block)
@varbind_list.each(&block)
end
end
class GetRequest < PDU
def encode
encode_pdu(BER::GetRequest_PDU_TAG)
end
end
class GetNextRequest < PDU
def encode
encode_pdu(BER::GetNextRequest_PDU_TAG)
end
end
class SetRequest < PDU
def encode
encode_pdu(BER::SetRequest_PDU_TAG)
end
end
class GetBulkRequest < PDU
alias max_repetitions error_index
alias max_repetitions= error_index=
def initialize(request_id, varbind_list, non_repeaters, max_repetitions)
super(request_id, varbind_list)
# Reuse attributes of superclass - same encoding
@error_status = non_repeaters
@error_index = max_repetitions
end
def encode
encode_pdu(BER::GetBulkRequest_PDU_TAG)
end
def non_repeaters=(number)
@error_status = number
end
def non_repeaters
@error_status
end
end
class Response < PDU
class << self
def from_pdu(request)
Response.new(request.request_id, request.varbind_list,
:noError, 0)
end
end
def encode
encode_pdu(BER::Response_PDU_TAG)
end
end
##
# The PDU class for traps in SNMPv2c. Methods are provided for retrieving
# the values of the mandatory varbinds: the system uptime and the OID of the
# trap. The complete varbind list is available through the usual varbind_list
# method. The first two varbinds in this list will always be the uptime
# and trap OID varbinds.
#
class SNMPv2_Trap < PDU
def encode
encode_pdu(BER::SNMPv2_Trap_PDU_TAG)
end
##
# Returns the source IP address for the trap, usually derived from the
# source IP address of the packet that delivered the trap.
#
attr_accessor :source_ip
##
# Returns the value of the mandatory sysUpTime varbind for this trap.
#
# Throws InvalidTrapVarbind if the sysUpTime varbind is not present.
#
def sys_up_time
varbind = @varbind_list[0]
if varbind && (varbind.name == SYS_UP_TIME_OID)
return varbind.value
else
raise InvalidTrapVarbind, "Expected sysUpTime.0, found " + varbind.to_s
end
end
##
# Returns the value of the mandatory snmpTrapOID varbind for this trap.
#
# Throws InvalidTrapVarbind if the snmpTrapOID varbind is not present.
#
def trap_oid
varbind = @varbind_list[1]
if varbind && (varbind.name == SNMP_TRAP_OID_OID)
return varbind.value
else
raise InvalidTrapVarbind, "Expected snmpTrapOID.0, found " + varbind.to_s
end
end
end
##
# The PDU class for SNMPv2 Inform notifications. This class is identical
# to SNMPv2_Trap.
#
class InformRequest < SNMPv2_Trap
def encode
encode_pdu(BER::InformRequest_PDU_TAG)
end
end
##
# The PDU class for traps in SNMPv1.
#
class SNMPv1_Trap
include SNMP::BER::Encode
extend SNMP::BER::Decode
##
# Returns the source IP address for the trap, usually derived from the
# source IP address of the packet that delivered the trap.
#
attr_accessor :source_ip
attr_accessor :enterprise
attr_accessor :agent_addr
attr_accessor :specific_trap
attr_accessor :timestamp
attr_accessor :varbind_list
alias :vb_list :varbind_list
def self.decode(pdu_data, mib=nil)
oid_data, remainder = decode_object_id(pdu_data)
enterprise = ObjectId.new(oid_data)
ip_data, remainder = decode_ip_address(remainder)
agent_addr = IpAddress.new(ip_data)
generic_trap, remainder = decode_integer(remainder)
specific_trap, remainder = decode_integer(remainder)
time_data, remainder = decode_timeticks(remainder)
timestamp = TimeTicks.new(time_data)
varbind_list, remainder = VarBindList.decode(remainder, mib)
assert_no_remainder(remainder)
SNMPv1_Trap.new(enterprise, agent_addr, generic_trap, specific_trap,
timestamp, varbind_list)
end
def initialize(enterprise, agent_addr, generic_trap, specific_trap, timestamp, varbind_list)
@enterprise = enterprise
@agent_addr = agent_addr
self.generic_trap = generic_trap
@specific_trap = specific_trap
@timestamp = timestamp
@varbind_list = varbind_list
end
# Name map for all of the generic traps defined in RFC 1157.
GENERIC_TRAP_NAME = {
0 => :coldStart,
1 => :warmStart,
2 => :linkDown,
3 => :linkUp,
4 => :authenticationFailure,
5 => :egpNeighborLoss,
6 => :enterpriseSpecific
}
# Code map for all of the generic traps defined in RFC 1157.
GENERIC_TRAP_CODE = GENERIC_TRAP_NAME.invert
def generic_trap=(trap)
@generic_trap = GENERIC_TRAP_CODE[trap]
unless @generic_trap
if trap.respond_to?(:to_i) && GENERIC_TRAP_NAME[trap.to_i]
@generic_trap = trap
else
raise InvalidGenericTrap, trap.to_s
end
end
end
def generic_trap
GENERIC_TRAP_NAME[@generic_trap]
end
def encode
pdu_data = @enterprise.encode <<
@agent_addr.encode <<
encode_integer(@generic_trap) <<
encode_integer(@specific_trap) <<
@timestamp.encode <<
@varbind_list.encode
encode_tlv(BER::SNMPv1_Trap_PDU_TAG, pdu_data)
end
def each_varbind(&block)
@varbind_list.each(&block)
end
end
end