snmp_community_mib_module.c
Go to the documentation of this file.
1 /**
2  * @file snmp_community_mib_module.c
3  * @brief SNMP COMMUNITY 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-COMMUNITY-MIB describes managed objects for mapping between
30  * community strings and version-independent SNMP message parameters. Refer
31  * to RFC 3584 for more details
32  *
33  * @author Oryx Embedded SARL (www.oryx-embedded.com)
34  * @version 2.4.0
35  **/
36 
37 //Switch to the appropriate trace level
38 #define TRACE_LEVEL SNMP_TRACE_LEVEL
39 
40 //Dependencies
41 #include "core/net.h"
42 #include "mibs/mib_common.h"
43 #include "mibs/snmp_community_mib_module.h"
44 #include "mibs/snmp_community_mib_impl.h"
45 #include "core/crypto.h"
46 #include "encoding/asn1.h"
47 #include "encoding/oid.h"
48 #include "debug.h"
49 
50 //Check TCP/IP stack configuration
51 #if (SNMP_COMMUNITY_MIB_SUPPORT == ENABLED)
52 
53 
54 /**
55  * @brief SNMP COMMUNITY MIB base
56  **/
57 
58 SnmpCommunityMibBase snmpCommunityMibBase;
59 
60 
61 /**
62  * @brief SNMP COMMUNITY MIB objects
63  **/
64 
65 const MibObject snmpCommunityMibObjects[] =
66 {
67  //snmpCommunityName object (1.3.6.1.6.3.18.1.1.1.2)
68  {
69  "snmpCommunityName",
70  {43, 6, 1, 6, 3, 18, 1, 1, 1, 2},
71  10,
72  ASN1_CLASS_UNIVERSAL,
73  ASN1_TYPE_OCTET_STRING,
74  MIB_ACCESS_READ_CREATE,
75  NULL,
76  NULL,
77  0,
78  snmpCommunityMibSetCommunityEntry,
79  snmpCommunityMibGetCommunityEntry,
80  snmpCommunityMibGetNextCommunityEntry
81  },
82  //snmpCommunitySecurityName object (1.3.6.1.6.3.18.1.1.1.3)
83  {
84  "snmpCommunitySecurityName",
85  {43, 6, 1, 6, 3, 18, 1, 1, 1, 3},
86  10,
87  ASN1_CLASS_UNIVERSAL,
88  ASN1_TYPE_OCTET_STRING,
89  MIB_ACCESS_READ_CREATE,
90  NULL,
91  NULL,
92  0,
93  snmpCommunityMibSetCommunityEntry,
94  snmpCommunityMibGetCommunityEntry,
95  snmpCommunityMibGetNextCommunityEntry
96  },
97  //snmpCommunityContextEngineID object (1.3.6.1.6.3.18.1.1.1.4)
98  {
99  "snmpCommunityContextEngineID",
100  {43, 6, 1, 6, 3, 18, 1, 1, 1, 4},
101  10,
102  ASN1_CLASS_UNIVERSAL,
103  ASN1_TYPE_OCTET_STRING,
104  MIB_ACCESS_READ_CREATE,
105  NULL,
106  NULL,
107  0,
108  snmpCommunityMibSetCommunityEntry,
109  snmpCommunityMibGetCommunityEntry,
110  snmpCommunityMibGetNextCommunityEntry
111  },
112  //snmpCommunityContextName object (1.3.6.1.6.3.18.1.1.1.5)
113  {
114  "snmpCommunityContextName",
115  {43, 6, 1, 6, 3, 18, 1, 1, 1, 5},
116  10,
117  ASN1_CLASS_UNIVERSAL,
118  ASN1_TYPE_OCTET_STRING,
119  MIB_ACCESS_READ_CREATE,
120  NULL,
121  NULL,
122  0,
123  snmpCommunityMibSetCommunityEntry,
124  snmpCommunityMibGetCommunityEntry,
125  snmpCommunityMibGetNextCommunityEntry
126  },
127  //snmpCommunityTransportTag object (1.3.6.1.6.3.18.1.1.1.6)
128  {
129  "snmpCommunityTransportTag",
130  {43, 6, 1, 6, 3, 18, 1, 1, 1, 6},
131  10,
132  ASN1_CLASS_UNIVERSAL,
133  ASN1_TYPE_OCTET_STRING,
134  MIB_ACCESS_READ_CREATE,
135  NULL,
136  NULL,
137  0,
138  snmpCommunityMibSetCommunityEntry,
139  snmpCommunityMibGetCommunityEntry,
140  snmpCommunityMibGetNextCommunityEntry
141  },
142  //snmpCommunityStorageType object (1.3.6.1.6.3.18.1.1.1.7)
143  {
144  "snmpCommunityStorageType",
145  {43, 6, 1, 6, 3, 18, 1, 1, 1, 7},
146  10,
147  ASN1_CLASS_UNIVERSAL,
148  ASN1_TYPE_INTEGER,
149  MIB_ACCESS_READ_CREATE,
150  NULL,
151  NULL,
152  sizeof(int32_t),
153  snmpCommunityMibSetCommunityEntry,
154  snmpCommunityMibGetCommunityEntry,
155  snmpCommunityMibGetNextCommunityEntry
156  },
157  //snmpCommunityStatus object (1.3.6.1.6.3.18.1.1.1.8)
158  {
159  "snmpCommunityStatus",
160  {43, 6, 1, 6, 3, 18, 1, 1, 1, 8},
161  10,
162  ASN1_CLASS_UNIVERSAL,
163  ASN1_TYPE_INTEGER,
164  MIB_ACCESS_READ_CREATE,
165  NULL,
166  NULL,
167  sizeof(int32_t),
168  snmpCommunityMibSetCommunityEntry,
169  snmpCommunityMibGetCommunityEntry,
170  snmpCommunityMibGetNextCommunityEntry
171  },
172 };
173 
174 
175 /**
176  * @brief SNMP COMMUNITY MIB module
177  **/
178 
179 const MibModule snmpCommunityMibModule =
180 {
181  "SNMP-COMMUNITY-MIB",
182  {43, 6, 1, 6, 3, 18},
183  6,
184  snmpCommunityMibObjects,
185  arraysize(snmpCommunityMibObjects),
186  snmpCommunityMibInit,
187  snmpCommunityMibLoad,
188  snmpCommunityMibUnload,
189  snmpCommunityMibLock,
190  snmpCommunityMibUnlock
191 };
192 
193 #endif
asn1.h
ASN.1 (Abstract Syntax Notation One)
ASN1_TYPE_OCTET_STRING
@ ASN1_TYPE_OCTET_STRING
Definition: asn1.h:72
ASN1_TYPE_INTEGER
@ ASN1_TYPE_INTEGER
Definition: asn1.h:70
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_CREATE
@ MIB_ACCESS_READ_CREATE
Definition: mib_common.h:81
net.h
TCP/IP stack core.
oid.h
OID (Object Identifier)
arraysize
#define arraysize(a)
Definition: os_port.h:71
snmpCommunityMibInit
error_t snmpCommunityMibInit(void)
SNMP COMMUNITY MIB module initialization.
Definition: snmp_community_mib_impl.c:60
snmpCommunityMibUnload
void snmpCommunityMibUnload(void *context)
Unload SNMP COMMUNITY MIB module.
Definition: snmp_community_mib_impl.c:94
snmpCommunityMibGetNextCommunityEntry
error_t snmpCommunityMibGetNextCommunityEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, uint8_t *nextOid, size_t *nextOidLen)
Get next snmpCommunityEntry object.
Definition: snmp_community_mib_impl.c:528
snmpCommunityMibUnlock
void snmpCommunityMibUnlock(void)
Unlock SNMP COMMUNITY MIB base.
Definition: snmp_community_mib_impl.c:116
snmpCommunityMibSetCommunityEntry
error_t snmpCommunityMibSetCommunityEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
Set snmpCommunityEntry object value.
Definition: snmp_community_mib_impl.c:135
snmpCommunityMibLoad
error_t snmpCommunityMibLoad(void *context)
Load SNMP COMMUNITY MIB module.
Definition: snmp_community_mib_impl.c:79
snmpCommunityMibGetCommunityEntry
error_t snmpCommunityMibGetCommunityEntry(const MibObject *object, const uint8_t *oid, size_t oidLen, MibVariant *value, size_t *valueLen)
Get snmpCommunityEntry object value.
Definition: snmp_community_mib_impl.c:373
snmpCommunityMibLock
void snmpCommunityMibLock(void)
Lock SNMP COMMUNITY MIB base.
Definition: snmp_community_mib_impl.c:105
snmp_community_mib_impl.h
SNMP COMMUNITY MIB module implementation.
snmpCommunityMibBase
SnmpCommunityMibBase snmpCommunityMibBase
SNMP COMMUNITY MIB base.
Definition: snmp_community_mib_module.c:58
snmpCommunityMibModule
const MibModule snmpCommunityMibModule
SNMP COMMUNITY MIB module.
Definition: snmp_community_mib_module.c:179
snmpCommunityMibObjects
const MibObject snmpCommunityMibObjects[]
SNMP COMMUNITY MIB objects.
Definition: snmp_community_mib_module.c:65
snmp_community_mib_module.h
SNMP COMMUNITY MIB module.
MibModule
MIB module.
Definition: mib_common.h:292
SnmpCommunityMibBase
SNMP COMMUNITY MIB base.
Definition: snmp_community_mib_module.h:68