snmp_mib_module.c
Go to the documentation of this file.
1 /**
2  * @file snmp_mib_module.c
3  * @brief SNMP MIB module
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @section Description
28  *
29  * The SNMP-MIB describes managed objects which describe the behavior
30  * of an SNMP entity. Refer to RFC 3418 for more details
31  *
32  * @author Oryx Embedded SARL (www.oryx-embedded.com)
33  * @version 2.4.0
34  **/
35 
36 //Switch to the appropriate trace level
37 #define TRACE_LEVEL SNMP_TRACE_LEVEL
38 
39 //Dependencies
40 #include "core/net.h"
41 #include "mibs/mib_common.h"
42 #include "mibs/snmp_mib_module.h"
43 #include "mibs/snmp_mib_impl.h"
44 #include "core/crypto.h"
45 #include "encoding/asn1.h"
46 #include "encoding/oid.h"
47 #include "debug.h"
48 
49 //Check TCP/IP stack configuration
50 #if (SNMP_MIB_SUPPORT == ENABLED)
51 
52 
53 /**
54  * @brief SNMP MIB base
55  **/
56 
57 SnmpMibBase snmpMibBase;
58 
59 
60 /**
61  * @brief SNMP MIB objects
62  **/
63 
64 const MibObject snmpMibObjects[] =
65 {
66  //sysDescr object (1.3.6.1.2.1.1.1)
67  {
68  "sysDescr",
69  {43, 6, 1, 2, 1, 1, 1},
70  7,
71  ASN1_CLASS_UNIVERSAL,
72  ASN1_TYPE_OCTET_STRING,
73  MIB_ACCESS_READ_ONLY,
74 #if (SNMP_MIB_SYS_DESCR_SIZE > 0)
75  &snmpMibBase.sysGroup.sysDescr,
76  &snmpMibBase.sysGroup.sysDescrLen,
77  SNMP_MIB_SYS_DESCR_SIZE,
78  NULL,
79  NULL,
80  NULL
81 #else
82  NULL,
83  NULL,
84  0,
85  NULL,
86  snmpMibGetSysDescr,
87  NULL
88 #endif
89  },
90  //sysObjectID object (1.3.6.1.2.1.1.2)
91  {
92  "sysObjectID",
93  {43, 6, 1, 2, 1, 1, 2},
94  7,
95  ASN1_CLASS_UNIVERSAL,
96  ASN1_TYPE_OBJECT_IDENTIFIER,
97  MIB_ACCESS_READ_ONLY,
98 #if (SNMP_MIB_SYS_OBJECT_ID_SIZE > 0)
99  &snmpMibBase.sysGroup.sysObjectID,
100  &snmpMibBase.sysGroup.sysObjectIDLen,
101  SNMP_MIB_SYS_OBJECT_ID_SIZE,
102  NULL,
103  NULL,
104  NULL
105 #else
106  NULL,
107  NULL,
108  0,
109  NULL,
110  snmpMibGetSysObjectID,
111  NULL
112 #endif
113  },
114  //sysUpTime object (1.3.6.1.2.1.1.3)
115  {
116  "sysUpTime",
117  {43, 6, 1, 2, 1, 1, 3},
118  7,
119  ASN1_CLASS_APPLICATION,
120  MIB_TYPE_TIME_TICKS,
121  MIB_ACCESS_READ_ONLY,
122  NULL,
123  NULL,
124  sizeof(uint32_t),
125  NULL,
126  snmpMibGetSysUpTime,
127  NULL
128  },
129  //sysContact object (1.3.6.1.2.1.1.4)
130  {
131  "sysContact",
132  {43, 6, 1, 2, 1, 1, 4},
133  7,
134  ASN1_CLASS_UNIVERSAL,
135  ASN1_TYPE_OCTET_STRING,
136  MIB_ACCESS_READ_WRITE,
137 #if (SNMP_MIB_SYS_CONTACT_SIZE > 0)
138  &snmpMibBase.sysGroup.sysContact,
139  &snmpMibBase.sysGroup.sysContactLen,
140  SNMP_MIB_SYS_CONTACT_SIZE,
141  NULL,
142  NULL,
143  NULL
144 #else
145  NULL,
146  NULL,
147  0,
148  snmpMibSetSysContact,
149  snmpMibGetSysContact,
150  NULL
151 #endif
152  },
153  //sysName object (1.3.6.1.2.1.1.5)
154  {
155  "sysName",
156  {43, 6, 1, 2, 1, 1, 5},
157  7,
158  ASN1_CLASS_UNIVERSAL,
159  ASN1_TYPE_OCTET_STRING,
160  MIB_ACCESS_READ_WRITE,
161 #if (SNMP_MIB_SYS_NAME_SIZE > 0)
162  &snmpMibBase.sysGroup.sysName,
163  &snmpMibBase.sysGroup.sysNameLen,
164  SNMP_MIB_SYS_NAME_SIZE,
165  NULL,
166  NULL,
167  NULL
168 #else
169  NULL,
170  NULL,
171  0,
172  snmpMibSetSysName,
173  snmpMibGetSysName,
174  NULL
175 #endif
176  },
177  //sysLocation object (1.3.6.1.2.1.1.6)
178  {
179  "sysLocation",
180  {43, 6, 1, 2, 1, 1, 6},
181  7,
182  ASN1_CLASS_UNIVERSAL,
183  ASN1_TYPE_OCTET_STRING,
184  MIB_ACCESS_READ_WRITE,
185 #if (SNMP_MIB_SYS_LOCATION_SIZE > 0)
186  &snmpMibBase.sysGroup.sysLocation,
187  &snmpMibBase.sysGroup.sysLocationLen,
188  SNMP_MIB_SYS_LOCATION_SIZE,
189  NULL,
190  NULL,
191  NULL
192 #else
193  NULL,
194  NULL,
195  0,
196  snmpMibSetSysLocation,
197  snmpMibGetSysLocation,
198  NULL
199 #endif
200  },
201  //sysServices object (1.3.6.1.2.1.1.7)
202  {
203  "sysServices",
204  {43, 6, 1, 2, 1, 1, 7},
205  7,
206  ASN1_CLASS_UNIVERSAL,
207  ASN1_TYPE_INTEGER,
208  MIB_ACCESS_READ_ONLY,
209  &snmpMibBase.sysGroup.sysServices,
210  NULL,
211  sizeof(int32_t),
212  NULL,
213  NULL,
214  NULL
215  },
216  //sysORLastChange object (1.3.6.1.2.1.1.8)
217  {
218  "sysORLastChange",
219  {43, 6, 1, 2, 1, 1, 8},
220  7,
221  ASN1_CLASS_APPLICATION,
222  MIB_TYPE_TIME_TICKS,
223  MIB_ACCESS_READ_ONLY,
224  &snmpMibBase.sysGroup.sysORLastChange,
225  NULL,
226  sizeof(uint32_t),
227  NULL,
228  NULL,
229  NULL
230  },
231  //sysORID object (1.3.6.1.2.1.1.9.1.2)
232  {
233  "sysORID",
234  {43, 6, 1, 2, 1, 1, 9, 1, 2},
235  9,
236  ASN1_CLASS_UNIVERSAL,
237  ASN1_TYPE_OBJECT_IDENTIFIER,
238  MIB_ACCESS_READ_ONLY,
239  NULL,
240  NULL,
241  0,
242  NULL,
243  snmpMibGetSysOREntry,
244  snmpMibGetNextSysOREntry
245  },
246  //sysORDescr object (1.3.6.1.2.1.1.9.1.3)
247  {
248  "sysORDescr",
249  {43, 6, 1, 2, 1, 1, 9, 1, 3},
250  9,
251  ASN1_CLASS_UNIVERSAL,
252  ASN1_TYPE_OCTET_STRING,
253  MIB_ACCESS_READ_ONLY,
254  NULL,
255  NULL,
256  0,
257  NULL,
258  snmpMibGetSysOREntry,
259  snmpMibGetNextSysOREntry
260  },
261  //sysORUpTime object (1.3.6.1.2.1.1.9.1.4)
262  {
263  "sysORUpTime",
264  {43, 6, 1, 2, 1, 1, 9, 1, 4},
265  9,
266  ASN1_CLASS_APPLICATION,
267  MIB_TYPE_TIME_TICKS,
268  MIB_ACCESS_READ_ONLY,
269  NULL,
270  NULL,
271  sizeof(uint32_t),
272  NULL,
273  snmpMibGetSysOREntry,
274  snmpMibGetNextSysOREntry
275  },
276  //snmpInPkts object (1.3.6.1.2.1.11.1)
277  {
278  "snmpInPkts",
279  {43, 6, 1, 2, 1, 11, 1},
280  7,
281  ASN1_CLASS_APPLICATION,
282  MIB_TYPE_COUNTER32,
283  MIB_ACCESS_READ_ONLY,
284  &snmpMibBase.snmpGroup.snmpInPkts,
285  NULL,
286  sizeof(uint32_t),
287  NULL,
288  NULL,
289  NULL
290  },
291  //snmpInBadVersions object (1.3.6.1.2.1.11.3)
292  {
293  "snmpInBadVersions",
294  {43, 6, 1, 2, 1, 11, 3},
295  7,
296  ASN1_CLASS_APPLICATION,
297  MIB_TYPE_COUNTER32,
298  MIB_ACCESS_READ_ONLY,
299  &snmpMibBase.snmpGroup.snmpInBadVersions,
300  NULL,
301  sizeof(uint32_t),
302  NULL,
303  NULL,
304  NULL
305  },
306  //snmpInBadCommunityNames object (1.3.6.1.2.1.11.4)
307  {
308  "snmpInBadCommunityNames",
309  {43, 6, 1, 2, 1, 11, 4},
310  7,
311  ASN1_CLASS_APPLICATION,
312  MIB_TYPE_COUNTER32,
313  MIB_ACCESS_READ_ONLY,
314  &snmpMibBase.snmpGroup.snmpInBadCommunityNames,
315  NULL,
316  sizeof(uint32_t),
317  NULL,
318  NULL,
319  NULL
320  },
321  //snmpInBadCommunityUses object (1.3.6.1.2.1.11.5)
322  {
323  "snmpInBadCommunityUses",
324  {43, 6, 1, 2, 1, 11, 5},
325  7,
326  ASN1_CLASS_APPLICATION,
327  MIB_TYPE_COUNTER32,
328  MIB_ACCESS_READ_ONLY,
329  &snmpMibBase.snmpGroup.snmpInBadCommunityUses,
330  NULL,
331  sizeof(uint32_t),
332  NULL,
333  NULL,
334  NULL
335  },
336  //snmpInASNParseErrs object (1.3.6.1.2.1.11.6)
337  {
338  "snmpInASNParseErrs",
339  {43, 6, 1, 2, 1, 11, 6},
340  7,
341  ASN1_CLASS_APPLICATION,
342  MIB_TYPE_COUNTER32,
343  MIB_ACCESS_READ_ONLY,
344  &snmpMibBase.snmpGroup.snmpInASNParseErrs,
345  NULL,
346  sizeof(uint32_t),
347  NULL,
348  NULL,
349  NULL
350  },
351  //snmpEnableAuthenTraps object (1.3.6.1.2.1.11.30)
352  {
353  "snmpEnableAuthenTraps",
354  {43, 6, 1, 2, 1, 11, 30},
355  7,
356  ASN1_CLASS_UNIVERSAL,
357  ASN1_TYPE_INTEGER,
358  MIB_ACCESS_READ_WRITE,
359  &snmpMibBase.snmpGroup.snmpEnableAuthenTraps,
360  NULL,
361  sizeof(int32_t),
362  NULL,
363  NULL,
364  NULL
365  },
366  //snmpSilentDrops object (1.3.6.1.2.1.11.31)
367  {
368  "snmpSilentDrops",
369  {43, 6, 1, 2, 1, 11, 31},
370  7,
371  ASN1_CLASS_APPLICATION,
372  MIB_TYPE_COUNTER32,
373  MIB_ACCESS_READ_ONLY,
374  &snmpMibBase.snmpGroup.snmpSilentDrops,
375  NULL,
376  sizeof(uint32_t),
377  NULL,
378  NULL,
379  NULL
380  },
381  //snmpProxyDrops object (1.3.6.1.2.1.11.32)
382  {
383  "snmpProxyDrops",
384  {43, 6, 1, 2, 1, 11, 32},
385  7,
386  ASN1_CLASS_APPLICATION,
387  MIB_TYPE_COUNTER32,
388  MIB_ACCESS_READ_ONLY,
389  &snmpMibBase.snmpGroup.snmpProxyDrops,
390  NULL,
391  sizeof(uint32_t),
392  NULL,
393  NULL,
394  NULL
395  },
396  //snmpTrapOID object (1.3.6.1.6.3.1.1.4.1)
397  {
398  "snmpTrapOID",
399  {43, 6, 1, 6, 3, 1, 1, 4, 1},
400  9,
401  ASN1_CLASS_UNIVERSAL,
402  ASN1_TYPE_OBJECT_IDENTIFIER,
403  MIB_ACCESS_FOR_NOTIFY,
404  NULL,
405  NULL,
406  0,
407  NULL,
408  snmpv2MibGetSnmpTrapOID,
409  NULL
410  },
411  //snmpTrapEnterprise object (1.3.6.1.6.3.1.1.4.3)
412  {
413  "snmpTrapEnterprise",
414  {43, 6, 1, 6, 3, 1, 1, 4, 3},
415  9,
416  ASN1_CLASS_UNIVERSAL,
417  ASN1_TYPE_OBJECT_IDENTIFIER,
418  MIB_ACCESS_FOR_NOTIFY,
419  NULL,
420  NULL,
421  0,
422  NULL,
423  snmpv2MibGetSnmpTrapEnterprise,
424  NULL
425  },
426  //snmpSetSerialNo object (1.3.6.1.6.3.1.1.6.1)
427  {
428  "snmpSetSerialNo",
429  {43, 6, 1, 6, 3, 1, 1, 6, 1},
430  9,
431  ASN1_CLASS_UNIVERSAL,
432  ASN1_TYPE_INTEGER,
433  MIB_ACCESS_READ_WRITE,
434  NULL,
435  NULL,
436  sizeof(int32_t),
437  snmpMibSetSnmpSetSerialNo,
438  snmpMibGetSnmpSetSerialNo,
439  NULL
440  }
441 };
442 
443 
444 /**
445  * @brief SNMP MIB module
446  **/
447 
448 const MibModule snmpMibModule =
449 {
450  "SNMPv2-MIB",
451  {43, 6, 1, 6, 3, 1},
452  6,
453  snmpMibObjects,
454  arraysize(snmpMibObjects),
455  snmpMibInit,
456  snmpMibLoad,
457  snmpMibUnload,
458  snmpMibLock,
459  snmpMibUnlock
460 };
461 
462 #endif
asn1.h
ASN.1 (Abstract Syntax Notation One)
ASN1_TYPE_OBJECT_IDENTIFIER
@ ASN1_TYPE_OBJECT_IDENTIFIER
Definition: asn1.h:74
ASN1_TYPE_OCTET_STRING
@ ASN1_TYPE_OCTET_STRING
Definition: asn1.h:72
ASN1_TYPE_INTEGER
@ ASN1_TYPE_INTEGER
Definition: asn1.h:70
ASN1_CLASS_APPLICATION
#define ASN1_CLASS_APPLICATION
Definition: asn1.h:53
ASN1_CLASS_UNIVERSAL
#define ASN1_CLASS_UNIVERSAL
Definition: asn1.h:52
crypto.h
General definitions for cryptographic algorithms.
debug.h
Debugging facilities.
mib_common.h
Common definitions for MIB modules.
MibObject
#define MibObject
Definition: mib_common.h:46
MIB_ACCESS_READ_ONLY
@ MIB_ACCESS_READ_ONLY
Definition: mib_common.h:79
MIB_ACCESS_READ_WRITE
@ MIB_ACCESS_READ_WRITE
Definition: mib_common.h:80
MIB_ACCESS_FOR_NOTIFY
@ MIB_ACCESS_FOR_NOTIFY
Definition: mib_common.h:77
MIB_TYPE_TIME_TICKS
@ MIB_TYPE_TIME_TICKS
Definition: mib_common.h:64
MIB_TYPE_COUNTER32
@ MIB_TYPE_COUNTER32
Definition: mib_common.h:61
net.h
TCP/IP stack core.
oid.h
OID (Object Identifier)
arraysize
#define arraysize(a)
Definition: os_port.h:71
snmpMibGetSysOREntry
error_t snmpMibGetSysOREntry(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get sysOREntry object value.
Definition: snmp_mib_impl.c:194
snmpv2MibGetSnmpTrapOID
error_t snmpv2MibGetSnmpTrapOID(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get snmpTrapOID object value.
Definition: snmp_mib_impl.c:361
snmpv2MibGetSnmpTrapEnterprise
error_t snmpv2MibGetSnmpTrapEnterprise(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get snmpTrapEnterprise object value.
Definition: snmp_mib_impl.c:382
snmpMibInit
error_t snmpMibInit(void)
SNMP MIB module initialization.
Definition: snmp_mib_impl.c:54
snmpMibLoad
error_t snmpMibLoad(void *context)
Load SNMP MIB module.
Definition: snmp_mib_impl.c:123
snmpMibUnload
void snmpMibUnload(void *context)
Unload SNMP MIB module.
Definition: snmp_mib_impl.c:138
snmpMibLock
void snmpMibLock(void)
Lock SNMP MIB base.
Definition: snmp_mib_impl.c:149
snmpMibGetSnmpSetSerialNo
error_t snmpMibGetSnmpSetSerialNo(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get snmpSetSerialNo object value.
Definition: snmp_mib_impl.c:440
snmpMibGetNextSysOREntry
error_t snmpMibGetNextSysOREntry(const MibObject *object, const uint8_t *oid, size_t oidLen, uint8_t *nextOid, size_t *nextOidLen)
Get next sysOREntry object.
Definition: snmp_mib_impl.c:297
snmpMibSetSnmpSetSerialNo
error_t snmpMibSetSnmpSetSerialNo(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
Set snmpSetSerialNo object value.
Definition: snmp_mib_impl.c:421
snmpMibUnlock
void snmpMibUnlock(void)
Unlock SNMP MIB base.
Definition: snmp_mib_impl.c:158
snmpMibGetSysUpTime
error_t snmpMibGetSysUpTime(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get sysUpTime object value.
Definition: snmp_mib_impl.c:173
snmp_mib_impl.h
SNMP MIB module implementation.
snmpMibGetSysDescr
error_t snmpMibGetSysDescr(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
snmpMibGetSysContact
error_t snmpMibGetSysContact(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
snmpMibGetSysLocation
error_t snmpMibGetSysLocation(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
snmpMibSetSysName
error_t snmpMibSetSysName(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
snmpMibGetSysName
error_t snmpMibGetSysName(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
snmpMibSetSysContact
error_t snmpMibSetSysContact(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
snmpMibSetSysLocation
error_t snmpMibSetSysLocation(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
snmpMibGetSysObjectID
error_t snmpMibGetSysObjectID(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
snmpMibModule
const MibModule snmpMibModule
SNMP MIB module.
Definition: snmp_mib_module.c:448
snmpMibObjects
const MibObject snmpMibObjects[]
SNMP MIB objects.
Definition: snmp_mib_module.c:64
snmpMibBase
SnmpMibBase snmpMibBase
SNMP MIB base.
Definition: snmp_mib_module.c:57
snmp_mib_module.h
SNMP MIB module.
SNMP_MIB_SYS_OBJECT_ID_SIZE
#define SNMP_MIB_SYS_OBJECT_ID_SIZE
Definition: snmp_mib_module.h:54
SNMP_MIB_SYS_LOCATION_SIZE
#define SNMP_MIB_SYS_LOCATION_SIZE
Definition: snmp_mib_module.h:75
SNMP_MIB_SYS_DESCR_SIZE
#define SNMP_MIB_SYS_DESCR_SIZE
Definition: snmp_mib_module.h:47
SNMP_MIB_SYS_CONTACT_SIZE
#define SNMP_MIB_SYS_CONTACT_SIZE
Definition: snmp_mib_module.h:61
SNMP_MIB_SYS_NAME_SIZE
#define SNMP_MIB_SYS_NAME_SIZE
Definition: snmp_mib_module.h:68
MibModule
MIB module.
Definition: mib_common.h:292
SnmpMibBase
SNMP MIB base.
Definition: snmp_mib_module.h:182
SnmpMibBase::sysGroup
SnmpMibSysGroup sysGroup
Definition: snmp_mib_module.h:184
SnmpMibBase::snmpGroup
SnmpMibSnmpGroup snmpGroup
Definition: snmp_mib_module.h:185
SnmpMibSnmpGroup::snmpInBadCommunityUses
uint32_t snmpInBadCommunityUses
Definition: snmp_mib_module.h:159
SnmpMibSnmpGroup::snmpInASNParseErrs
uint32_t snmpInASNParseErrs
Definition: snmp_mib_module.h:160
SnmpMibSnmpGroup::snmpInBadVersions
uint32_t snmpInBadVersions
Definition: snmp_mib_module.h:157
SnmpMibSnmpGroup::snmpInBadCommunityNames
uint32_t snmpInBadCommunityNames
Definition: snmp_mib_module.h:158
SnmpMibSnmpGroup::snmpEnableAuthenTraps
int32_t snmpEnableAuthenTraps
Definition: snmp_mib_module.h:161
SnmpMibSnmpGroup::snmpSilentDrops
uint32_t snmpSilentDrops
Definition: snmp_mib_module.h:162
SnmpMibSysGroup::sysContact
char_t sysContact[SNMP_MIB_SYS_CONTACT_SIZE]
Definition: snmp_mib_module.h:134
SnmpMibSysGroup::sysORLastChange
uint32_t sysORLastChange
Definition: snmp_mib_module.h:146
SnmpMibSysGroup::sysLocation
char_t sysLocation[SNMP_MIB_SYS_LOCATION_SIZE]
Definition: snmp_mib_module.h:142
SnmpMibSysGroup::sysName
char_t sysName[SNMP_MIB_SYS_NAME_SIZE]
Definition: snmp_mib_module.h:138
SnmpMibSysGroup::sysObjectID
uint8_t sysObjectID[SNMP_MIB_SYS_OBJECT_ID_SIZE]
Definition: snmp_mib_module.h:129
SnmpMibSysGroup::sysDescr
char_t sysDescr[SNMP_MIB_SYS_DESCR_SIZE]
Definition: snmp_mib_module.h:125