File: snmp.rb

package info (click to toggle)
ruby-net-ldap 0.19.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 640 kB
  • sloc: ruby: 4,583; sh: 53; makefile: 4
file content (264 lines) | stat: -rw-r--r-- 7,271 bytes parent folder | download | duplicates (2)
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
# -*- ruby encoding: utf-8 -*-
require_relative 'ldap/version'

# :stopdoc:
module Net
  class SNMP
    VERSION = Net::LDAP::VERSION
    AsnSyntax = Net::BER.compile_syntax({
      :application => {
        :primitive => {
          1 => :integer,  # Counter32, (RFC2578 sec 2)
          2 => :integer,  # Gauge32 or Unsigned32, (RFC2578 sec 2)
          3 => :integer  # TimeTicks32, (RFC2578 sec 2)
        },
        :constructed => {},
      },
      :context_specific => {
        :primitive => {},
        :constructed => {
          0 => :array,  # GetRequest PDU (RFC1157 pgh 4.1.2)
          1 => :array,  # GetNextRequest PDU (RFC1157 pgh 4.1.3)
          2 => :array    # GetResponse PDU (RFC1157 pgh 4.1.4)
        },
      },
    })

    # SNMP 32-bit counter.
    # Defined in RFC1155 (Structure of Mangement Information), section 6.
    # A 32-bit counter is an ASN.1 application [1] implicit unsigned integer
    # with a range from 0 to 2^^32 - 1.
    class Counter32
      def initialize value
        @value = value
      end
      def to_ber
        @value.to_ber_application(1)
      end
    end

    # SNMP 32-bit gauge.
    # Defined in RFC1155 (Structure of Mangement Information), section 6.
    # A 32-bit counter is an ASN.1 application [2] implicit unsigned integer.
    # This is also indistinguishable from Unsigned32. (Need to alias them.)
    class Gauge32
      def initialize value
        @value = value
      end
      def to_ber
        @value.to_ber_application(2)
      end
    end

    # SNMP 32-bit timer-ticks.
    # Defined in RFC1155 (Structure of Mangement Information), section 6.
    # A 32-bit counter is an ASN.1 application [3] implicit unsigned integer.
    class TimeTicks32
      def initialize value
        @value = value
      end
      def to_ber
        @value.to_ber_application(3)
      end
    end
  end

  class SnmpPdu
    class Error < StandardError; end
    PduTypes = [
      :get_request,
      :get_next_request,
      :get_response,
      :set_request,
      :trap,
    ]
    ErrorStatusCodes = { # Per RFC1157, pgh 4.1.1
      0 => "noError",
      1 => "tooBig",
      2 => "noSuchName",
      3 => "badValue",
      4 => "readOnly",
      5 => "genErr",
    }

    class << self
      def parse ber_object
        n = new
        n.send :parse, ber_object
        n
      end
    end

    attr_reader :version, :community, :pdu_type, :variables, :error_status
    attr_accessor :request_id, :error_index

    def initialize args={}
      @version = args[:version] || 0
      @community = args[:community] || "public"
      @pdu_type = args[:pdu_type] # leave nil unless specified; there's no reasonable default value.
      @error_status = args[:error_status] || 0
      @error_index = args[:error_index] || 0
      @variables = args[:variables] || []
    end

    #--
    def parse ber_object
      begin
        parse_ber_object ber_object
      rescue Error
        # Pass through any SnmpPdu::Error instances
        raise $!
      rescue
        # Wrap any basic parsing error so it becomes a PDU-format error
        raise Error.new( "snmp-pdu format error" )
      end
    end
    private :parse

    def parse_ber_object ber_object
      send :version=, ber_object[0].to_i
      send :community=, ber_object[1].to_s

      data = ber_object[2]
      case (app_tag = data.ber_identifier & 31)
      when 0
        send :pdu_type=, :get_request
        parse_get_request data
      when 1
        send :pdu_type=, :get_next_request
        # This PDU is identical to get-request except for the type.
        parse_get_request data
      when 2
        send :pdu_type=, :get_response
        # This PDU is identical to get-request except for the type,
        # the error_status and error_index values are meaningful,
        # and the fact that the variable bindings will be non-null.
        parse_get_response data
      else
        raise Error.new( "unknown snmp-pdu type: #{app_tag}" )
      end
    end
    private :parse_ber_object

    #--
    # Defined in RFC1157, pgh 4.1.2.
    def parse_get_request data
      send :request_id=, data[0].to_i
      # data[1] is error_status, always zero.
      # data[2] is error_index, always zero.
      send :error_status=, 0
      send :error_index=, 0
      data[3].each do |n, v|
        # A variable-binding, of which there may be several,
        # consists of an OID and a BER null.
        # We're ignoring the null, we might want to verify it instead.
        unless v.is_a?(Net::BER::BerIdentifiedNull)
            raise Error.new(" invalid variable-binding in get-request" )
        end
        add_variable_binding n, nil
      end
    end
    private :parse_get_request

    #--
    # Defined in RFC1157, pgh 4.1.4
    def parse_get_response data
      send :request_id=, data[0].to_i
      send :error_status=, data[1].to_i
      send :error_index=, data[2].to_i
      data[3].each do |n, v|
        # A variable-binding, of which there may be several,
        # consists of an OID and a BER null.
        # We're ignoring the null, we might want to verify it instead.
        add_variable_binding n, v
      end
    end
    private :parse_get_response


    def version= ver
      unless [0, 2].include?(ver)
        raise Error.new("unknown snmp-version: #{ver}")
      end
      @version = ver
    end

    def pdu_type= t
      unless PduTypes.include?(t)
        raise Error.new("unknown pdu-type: #{t}")
      end
      @pdu_type = t
    end

    def error_status= es
      unless ErrorStatusCodes.key?(es)
        raise Error.new("unknown error-status: #{es}")
      end
      @error_status = es
    end

    def community= c
      @community = c.to_s
    end

    #--
    # Syntactic sugar
    def add_variable_binding name, value=nil
      @variables ||= []
      @variables << [name, value]
    end

    def to_ber_string
      [
        version.to_ber,
        community.to_ber,
        pdu_to_ber_string,
      ].to_ber_sequence
    end

    #--
    # Helper method that returns a PDU payload in BER form,
    # depending on the PDU type.
    def pdu_to_ber_string
      case pdu_type
      when :get_request
        [
          request_id.to_ber,
          error_status.to_ber,
          error_index.to_ber,
          [
            @variables.map do|n, v|
              [n.to_ber_oid, Net::BER::BerIdentifiedNull.new.to_ber].to_ber_sequence
            end,
          ].to_ber_sequence,
        ].to_ber_contextspecific(0)
      when :get_next_request
        [
          request_id.to_ber,
          error_status.to_ber,
          error_index.to_ber,
          [
            @variables.map do|n, v|
              [n.to_ber_oid, Net::BER::BerIdentifiedNull.new.to_ber].to_ber_sequence
            end,
          ].to_ber_sequence,
        ].to_ber_contextspecific(1)
      when :get_response
        [
          request_id.to_ber,
          error_status.to_ber,
          error_index.to_ber,
          [
            @variables.map do|n, v|
              [n.to_ber_oid, v.to_ber].to_ber_sequence
            end,
          ].to_ber_sequence,
        ].to_ber_contextspecific(2)
      else
        raise Error.new( "unknown pdu-type: #{pdu_type}" )
      end
    end
    private :pdu_to_ber_string
  end
end
# :startdoc: