summaryrefslogtreecommitdiff
path: root/MIBS/dlink/DLINKSW-DHCP-FILTER-MIB
blob: c869cf9f6488860be7751a1d55cff98f61772ec4 (plain)
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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
--  *****************************************************************
--  DLINKSW-DHCP-FILTER-MIB.mib : DHCP Filter MIB
-- 
--  Copyright (c) 2013 D-Link Corporation, all rights reserved.
--   
--  *****************************************************************
DLINKSW-DHCP-FILTER-MIB DEFINITIONS ::= BEGIN

    IMPORTS
        MODULE-COMPLIANCE,
        OBJECT-GROUP
            FROM SNMPv2-CONF
        MODULE-IDENTITY,
        OBJECT-TYPE,
        IpAddress,
        Unsigned32
            FROM SNMPv2-SMI
        DisplayString,
        MacAddress,
        DateAndTime,
        TruthValue,
        RowStatus        
            FROM SNMPv2-TC
        ifIndex
            FROM IF-MIB
        VlanId
            FROM Q-BRIDGE-MIB
        dlinkIndustrialCommon                     
            FROM DLINK-ID-REC-MIB;


    dlinkSwDhcpFilterMIB MODULE-IDENTITY
        LAST-UPDATED "201307190000Z"
        ORGANIZATION "D-Link Corp."
        CONTACT-INFO
            "        D-Link Corporation

             Postal: No. 289, Sinhu 3rd Rd., Neihu District,
                     Taipei City 114, Taiwan, R.O.C
             Tel:     +886-2-66000123
             E-mail: tsd@dlink.com.tw
            "
        DESCRIPTION
            "This MIB module defines objects for filtering DHCP packet to 
            implement the feature of DHCP Server Screening."
            
        REVISION "201307190000Z"
        DESCRIPTION
            "This is the first version of the MIB file."             
        ::= { dlinkIndustrialCommon 133 }

-- -----------------------------------------------------------------------------
    dDhcpFilterMIBNotifications    OBJECT IDENTIFIER ::= { dlinkSwDhcpFilterMIB 0 }
    dDhcpFilterMIBObjects          OBJECT IDENTIFIER ::= { dlinkSwDhcpFilterMIB 1 }
    dDhcpFilterMIBConformance      OBJECT IDENTIFIER ::= { dlinkSwDhcpFilterMIB 2 }

-- -----------------------------------------------------------------------------
    dDhcpFilterGlobalObjects       OBJECT IDENTIFIER ::= { dDhcpFilterMIBObjects 1 }

    dDhcpFilterLogBufferSize OBJECT-TYPE
        SYNTAX          Unsigned32 (0..1024)
        MAX-ACCESS      read-write
        STATUS          current
        DESCRIPTION
            "This object indicates the log buffer size for storing the 
             illegal server information.

             The special value of 0 indicates logging buffer is disabled."             
        DEFVAL          { 32 } 
        ::= { dDhcpFilterGlobalObjects 1 }

    dDhcpFilterClearLogBuffer OBJECT-TYPE
        SYNTAX          INTEGER {
            clear(1),
            noOp(2)
        }
        MAX-ACCESS      read-write
        STATUS          current
        DESCRIPTION
            "This object triggers clearing the log buffer of DHCP Server Screen 
            information when set to 'clear'.

            No action is taken if this object is set to 'noOp'.
            When read, the value 'noOp' is returned."            
        ::= { dDhcpFilterGlobalObjects 2 }

    dDhcpFilterGlobalNotifsEnabled  OBJECT-TYPE
        SYNTAX          TruthValue
        MAX-ACCESS      read-write
        STATUS          current
        DESCRIPTION   
            "Set to 'true' to enable global SNMP notification
            for DHCP Server Screen feature.  Setting the object to
            'false' will disable SNMP notifications."
        DEFVAL      { false }              
        ::= { dDhcpFilterGlobalObjects 3}

-- -----------------------------------------------------------------------------
    dDhcpFilterProfileObjects          OBJECT IDENTIFIER ::= { dDhcpFilterMIBObjects 2 }
    
    dDhcpFilterProfileTable OBJECT-TYPE
        SYNTAX          SEQUENCE OF DDhcpFilterProfileEntry
        MAX-ACCESS      not-accessible
        STATUS          current
        DESCRIPTION
            "A table provides the configuration of DHCP Server Screen profile."
        ::= { dDhcpFilterProfileObjects 1 }

    dDhcpFilterProfileEntry OBJECT-TYPE
        SYNTAX          DDhcpFilterProfileEntry
        MAX-ACCESS      not-accessible
        STATUS          current
        DESCRIPTION
            "A row instance contains the configuration of DHCP Server Screen profile."
        INDEX           { dDhcpFilterProfileName} 
        ::= { dDhcpFilterProfileTable 1 }

    DDhcpFilterProfileEntry ::= SEQUENCE {
        dDhcpFilterProfileName             DisplayString,
        dDhcpFilterProfileStatus           RowStatus
    }

    dDhcpFilterProfileName OBJECT-TYPE
        SYNTAX          DisplayString (SIZE  (1..32))
        MAX-ACCESS      not-accessible
        STATUS  current        
        DESCRIPTION
            "This object indicates the profile name of the corresponding entry."   
        ::= { dDhcpFilterProfileEntry 1 }

    dDhcpFilterProfileStatus OBJECT-TYPE
        SYNTAX          RowStatus
        MAX-ACCESS      read-create
        STATUS          current
        DESCRIPTION
            "This object is used to manage the creation and deletion
             of rows in this table. 
            " 
        ::= { dDhcpFilterProfileEntry 99 }

-- ----------------------------------------------------------------------------- 
    dDhcpFilterProfileClientTable OBJECT-TYPE
        SYNTAX          SEQUENCE OF DDhcpFilterProfileClientEntry
        MAX-ACCESS      not-accessible
        STATUS          current
        DESCRIPTION
            "A table provides a list of client MAC addresses for profiles."
        ::= { dDhcpFilterProfileObjects 2 }

    dDhcpFilterProfileClientEntry OBJECT-TYPE
        SYNTAX          DDhcpFilterProfileClientEntry
        MAX-ACCESS      not-accessible
        STATUS          current
        DESCRIPTION
            "An entry contains a client MAC address on a profile. The first 
            index element value identifies the profile (dDhcpFilterProfileEntry) 
            that a client MAC address (dDhcpFilterProfileClientEntry) belongs 
            to. An entry is removed from this table when its corresponding 
            dDhcpFilterProfileEntry is deleted."
        INDEX           { 
            dDhcpFilterProfileName,
            dDhcpFilterClientMacAddress
            } 
        ::= { dDhcpFilterProfileClientTable 1 }

    DDhcpFilterProfileClientEntry ::= SEQUENCE {
        dDhcpFilterClientMacAddress             MacAddress,
        dDhcpFilterClientRowStatus              RowStatus
        }

    dDhcpFilterClientMacAddress OBJECT-TYPE
        SYNTAX          MacAddress
        MAX-ACCESS      read-only
        STATUS          current
        DESCRIPTION
            "This object indicates the MAC address of a DHCP Client." 
        ::= { dDhcpFilterProfileClientEntry 1 }  

    dDhcpFilterClientRowStatus OBJECT-TYPE
        SYNTAX          RowStatus
        MAX-ACCESS      read-create
        STATUS          current
        DESCRIPTION
            "This object is used to manage the creation and deletion
             of rows in this table. 
            " 
        ::= { dDhcpFilterProfileClientEntry 99 }

-- -----------------------------------------------------------------------------
    dDhcpFilterIfObjects          OBJECT IDENTIFIER ::= { dDhcpFilterMIBObjects 3 }
 
 -- -----------------------------------------------------------------------------
    dDhcpFilterIfStateTable OBJECT-TYPE
        SYNTAX          SEQUENCE OF DDhcpFilterIfStateEntry
        MAX-ACCESS      not-accessible
        STATUS          current
        DESCRIPTION
            "A table provides the mechanism to control the state of DHCP Server Screen
            per interface."
        ::= { dDhcpFilterIfObjects 1 }

    dDhcpFilterIfStateEntry OBJECT-TYPE
        SYNTAX          DDhcpFilterIfStateEntry
        MAX-ACCESS      not-accessible
        STATUS          current
        DESCRIPTION
            "An entry contains the configuration to enable or disable DHCP Server
            Screen on an interface."
        INDEX           { ifIndex } 
        ::= { dDhcpFilterIfStateTable 1 }

    DDhcpFilterIfStateEntry ::= SEQUENCE {
        dDhcpFilterIfStateEnabled            TruthValue
    }

    dDhcpFilterIfStateEnabled OBJECT-TYPE
        SYNTAX          TruthValue
        MAX-ACCESS      read-write
        STATUS          current
        DESCRIPTION
            "This object indicates whether the DHCP Server Screen is enabled on
            the interface." 
        ::= { dDhcpFilterIfStateEntry 1 }

 -- -----------------------------------------------------------------------------  
    dDhcpFilterIfTrustServerTable OBJECT-TYPE
        SYNTAX          SEQUENCE OF DDhcpFilterIfTrustServerEntry
        MAX-ACCESS      not-accessible
        STATUS          current
        DESCRIPTION
            "A table provides the mechanism to configure trusted DHCP servers 
            on a per interface basis."
        ::= { dDhcpFilterIfObjects 2 }

    dDhcpFilterIfTrustServerEntry OBJECT-TYPE
        SYNTAX          DDhcpFilterIfTrustServerEntry
        MAX-ACCESS      not-accessible
        STATUS          current
        DESCRIPTION
            "An entry contains the configuration to specify trusted DHCP server
            on an interface.
            "
        INDEX           { 
            ifIndex,
            dDhcpFilterTrustServerIpAddress
        } 
        ::= { dDhcpFilterIfTrustServerTable 1 }

    DDhcpFilterIfTrustServerEntry ::= SEQUENCE {
        dDhcpFilterTrustServerIpAddress     IpAddress,
        dDhcpFilterTrustProfileName         DisplayString,
        dDhcpFilterTrustRowStatus           RowStatus
    }

    dDhcpFilterTrustServerIpAddress OBJECT-TYPE
        SYNTAX      IpAddress
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
            "This object indicates the DHCP Server IP address of the entry."
        ::= { dDhcpFilterIfTrustServerEntry 1 }

    dDhcpFilterTrustProfileName OBJECT-TYPE
        SYNTAX          DisplayString (SIZE  (0..32))
        MAX-ACCESS      read-create
        STATUS  current        
        DESCRIPTION
            "This object indicates the profile which contains a list of client
            MAC addresses.
            A zero length string indicates the profile is not specified, and
            the server message with the specified server IP address is forwarded.
            "
        ::= { dDhcpFilterIfTrustServerEntry 2 }

    dDhcpFilterTrustRowStatus OBJECT-TYPE
        SYNTAX          RowStatus
        MAX-ACCESS      read-create
        STATUS          current
        DESCRIPTION
            "This object is used to manage the creation and deletion
            of rows in this table." 
        ::= { dDhcpFilterIfTrustServerEntry 99 }

-- -----------------------------------------------------------------------------      
    dDhcpFilterLogBufferObjects          OBJECT IDENTIFIER ::= { dDhcpFilterMIBObjects 4 }
 
    dDhcpFilterLogBufferTable OBJECT-TYPE
        SYNTAX          SEQUENCE OF DDhcpFilterLogBufferEntry
        MAX-ACCESS      not-accessible
        STATUS          current
        DESCRIPTION
            "A table provides the log for illegal DHCP Servers."
        ::= { dDhcpFilterLogBufferObjects 1 }

    dDhcpFilterLogBufferEntry OBJECT-TYPE
        SYNTAX          DDhcpFilterLogBufferEntry
        MAX-ACCESS      not-accessible
        STATUS          current
        DESCRIPTION
            "A row instance contains the information of an illegal DHCP Server."
        INDEX           { 
            dDhcpFilterLogBufferIndex
        } 
        ::= { dDhcpFilterLogBufferTable 1 }

    DDhcpFilterLogBufferEntry ::= SEQUENCE {
        dDhcpFilterLogBufferIndex           Unsigned32,
        dDhcpFilterLogBufServerIpAddr       IpAddress,
        dDhcpFilterLogBufClientMacAddr      MacAddress,
        dDhcpFilterLogBufferVlanId          VlanId,
        dDhcpFilterLogBufferOccurrence      Unsigned32,
        dDhcpFilterLogBufferOccurTime       DateAndTime
        }

    dDhcpFilterLogBufferIndex OBJECT-TYPE
        SYNTAX      Unsigned32 (1..1024)
        MAX-ACCESS  not-accessible
        STATUS      current
        DESCRIPTION
            "This object uniquely identifies an item of the logged illegal
            DHCP Server information in the buffer."
        ::= { dDhcpFilterLogBufferEntry 1 }

    dDhcpFilterLogBufServerIpAddr OBJECT-TYPE
        SYNTAX      IpAddress
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
            "This object indicates the DHCP Server Internet address"
        ::= { dDhcpFilterLogBufferEntry 2 }

    dDhcpFilterLogBufClientMacAddr OBJECT-TYPE
        SYNTAX      MacAddress
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
            "This object indicates the DHCP Client MAC address."
        ::= { dDhcpFilterLogBufferEntry 3 }

    dDhcpFilterLogBufferVlanId OBJECT-TYPE
        SYNTAX      VlanId
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
            "This object indicates the VLAN number which the logged
             server belongs to."
        ::= { dDhcpFilterLogBufferEntry 4 }

    dDhcpFilterLogBufferOccurrence OBJECT-TYPE
        SYNTAX      Unsigned32 
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
            "This object counts the number of received DHCP packet originated
            from the illegal DHCP Server."
        ::= { dDhcpFilterLogBufferEntry 5 }

    dDhcpFilterLogBufferOccurTime OBJECT-TYPE
        SYNTAX      DateAndTime
        MAX-ACCESS  read-only
        STATUS      current
        DESCRIPTION
            "This object indicates the timestamp when the illegal DHCP 
             Server packet arriving."
        ::= { dDhcpFilterLogBufferEntry 6 }
 
--  ***************************************************************************	
--  Notifications
--  ***************************************************************************               
     dDhcpFilterAttackDetected NOTIFICATION-TYPE
        OBJECTS { 
                  dDhcpFilterLogBufServerIpAddr,
                  dDhcpFilterLogBufClientMacAddr, 
                  dDhcpFilterLogBufferVlanId,
                  dDhcpFilterLogBufferOccurTime
                }
        STATUS  current
        DESCRIPTION
            "This trap is sent when dDhcpFilterGlobalNotifsEnabled is 'true' and 
            the DHCP Server Sceen occurs to detect the dropped attack packets."
        ::= { dDhcpFilterMIBNotifications 1 }                                    
        
--  ***************************************************************************	
--  Conformance
--  ***************************************************************************
    dDhcpFilterCompliances OBJECT IDENTIFIER ::= { dDhcpFilterMIBConformance 1 }
    dDhcpFilterGroups OBJECT IDENTIFIER ::= { dDhcpFilterMIBConformance 2 }

    dDhcpFilterCompliance MODULE-COMPLIANCE
        STATUS current
        DESCRIPTION 
        "The compliance statement for entities which implement the 
        DLINKSW-DHCP-FILTER-MIB."
        MODULE -- this module
        MANDATORY-GROUPS { 
            dDhcpFilterTrustSrvCfgGroup,
            dDhcpFilterIfStateGroup
        }

    GROUP          dDhcpFilterLogGroup
    DESCRIPTION
        "This group is mandatory only for the platform which supports
        logging illegal DHCP server for DHCP Server Screen feature."

    ::= { dDhcpFilterCompliances 1 }

    dDhcpFilterTrustSrvCfgGroup OBJECT-GROUP
        OBJECTS { 
            dDhcpFilterProfileStatus,
            dDhcpFilterClientMacAddress,
            dDhcpFilterClientRowStatus,
            dDhcpFilterTrustServerIpAddress,
            dDhcpFilterTrustProfileName,
            dDhcpFilterTrustRowStatus
        }
        STATUS current
        DESCRIPTION 
            "A collection of objects which are used to configure as
             well as show information regarding the trust DHCP Server Screen."
        ::= { dDhcpFilterGroups 1 }

    dDhcpFilterIfStateGroup OBJECT-GROUP
        OBJECTS { 
            dDhcpFilterIfStateEnabled
        }
        STATUS current
        DESCRIPTION 
            "A collection of objects which are used to configure as
             well as show information regarding the state of DHCP Server Screen
             on the interface."
        ::= { dDhcpFilterGroups 2 }

    dDhcpFilterLogGroup OBJECT-GROUP
        OBJECTS { 
            dDhcpFilterLogBufferSize,
            dDhcpFilterClearLogBuffer,
            dDhcpFilterLogBufServerIpAddr,
            dDhcpFilterLogBufClientMacAddr,
            dDhcpFilterLogBufferVlanId,
            dDhcpFilterLogBufferOccurrence,
            dDhcpFilterLogBufferOccurTime            
        }
        STATUS current
        DESCRIPTION 
            "A collection of objects which are used to configure as
             well as show information regarding the DHCP Server Screen logging feature."
        ::= { dDhcpFilterGroups 3 }
END