1 /*
2 Generated by LwipMibCompiler
3 */
4
5 #include "lwip/apps/snmp_opts.h"
6 #if LWIP_SNMP && LWIP_SNMP_V3
7
8 #include "lwip/apps/snmp_snmpv2_usm.h"
9 #include "lwip/apps/snmp.h"
10 #include "lwip/apps/snmp_core.h"
11 #include "lwip/apps/snmp_scalar.h"
12 #include "lwip/apps/snmp_table.h"
13 #include "lwip/apps/snmpv3.h"
14 #include "snmpv3_priv.h"
15
16 #include "lwip/apps/snmp_snmpv2_framework.h"
17
18 #include <string.h>
19
20 /* --- usmUser 1.3.6.1.6.3.15.1.2 ----------------------------------------------------- */
21
22 static const struct snmp_oid_range usmUserTable_oid_ranges[] = {
23 { 0, 0xff }, { 0, 0xff }, { 0, 0xff }, { 0, 0xff },
24 { 0, 0xff }, { 0, 0xff }, { 0, 0xff }, { 0, 0xff },
25 { 0, 0xff }, { 0, 0xff }, { 0, 0xff }, { 0, 0xff },
26 { 0, 0xff }, { 0, 0xff }, { 0, 0xff }, { 0, 0xff },
27 { 0, 0xff }, { 0, 0xff }, { 0, 0xff }, { 0, 0xff },
28 { 0, 0xff }, { 0, 0xff }, { 0, 0xff }, { 0, 0xff },
29 { 0, 0xff }, { 0, 0xff }, { 0, 0xff }, { 0, 0xff },
30 { 0, 0xff }, { 0, 0xff }, { 0, 0xff }, { 0, 0xff }
31 };
32
snmp_engineid_to_oid(const char * engineid,u32_t * oid,u32_t len)33 static void snmp_engineid_to_oid(const char *engineid, u32_t *oid, u32_t len)
34 {
35 u8_t i;
36
37 for (i = 0; i < len; i++) {
38 oid[i] = engineid[i];
39 }
40 }
41
snmp_oid_to_name(char * name,const u32_t * oid,size_t len)42 static void snmp_oid_to_name(char *name, const u32_t *oid, size_t len)
43 {
44 u8_t i;
45
46 for (i = 0; i < len; i++) {
47 name[i] = (char)oid[i];
48 }
49 }
50
snmp_name_to_oid(const char * name,u32_t * oid,size_t len)51 static void snmp_name_to_oid(const char *name, u32_t *oid, size_t len)
52 {
53 u8_t i;
54
55 for (i = 0; i < len; i++) {
56 oid[i] = name[i];
57 }
58 }
59
snmp_auth_algo_to_oid(snmpv3_auth_algo_t algo)60 static const struct snmp_obj_id *snmp_auth_algo_to_oid(snmpv3_auth_algo_t algo)
61 {
62 if (algo == SNMP_V3_AUTH_ALGO_MD5) {
63 return &usmHMACMD5AuthProtocol;
64 }
65 else if (algo == SNMP_V3_AUTH_ALGO_SHA) {
66 return &usmHMACMD5AuthProtocol;
67 }
68
69 return &usmNoAuthProtocol;
70 }
71
snmp_priv_algo_to_oid(snmpv3_priv_algo_t algo)72 static const struct snmp_obj_id *snmp_priv_algo_to_oid(snmpv3_priv_algo_t algo)
73 {
74 if (algo == SNMP_V3_PRIV_ALGO_DES) {
75 return &usmDESPrivProtocol;
76 }
77 else if (algo == SNMP_V3_PRIV_ALGO_AES) {
78 return &usmAESPrivProtocol;
79 }
80
81 return &usmNoPrivProtocol;
82 }
83
84 char username[32];
85
usmusertable_get_instance(const u32_t * column,const u32_t * row_oid,u8_t row_oid_len,struct snmp_node_instance * cell_instance)86 static snmp_err_t usmusertable_get_instance(const u32_t *column, const u32_t *row_oid, u8_t row_oid_len, struct snmp_node_instance *cell_instance)
87 {
88 const char *engineid;
89 u8_t eid_len;
90
91 u32_t engineid_oid[SNMP_V3_MAX_ENGINE_ID_LENGTH];
92
93 u8_t name_len;
94 u8_t engineid_len;
95
96 u8_t name_start;
97 u8_t engineid_start;
98
99 LWIP_UNUSED_ARG(column);
100
101 snmpv3_get_engine_id(&engineid, &eid_len);
102
103 engineid_len = (u8_t)row_oid[0];
104 engineid_start = 1;
105
106 if (engineid_len != eid_len) {
107 /* EngineID length does not match! */
108 return SNMP_ERR_NOSUCHINSTANCE;
109 }
110
111 if (engineid_len > row_oid_len) {
112 /* row OID doesn't contain enough data according to engineid_len.*/
113 return SNMP_ERR_NOSUCHINSTANCE;
114 }
115
116 /* check if incoming OID length and if values are in plausible range */
117 if (!snmp_oid_in_range(&row_oid[engineid_start], engineid_len, usmUserTable_oid_ranges, engineid_len)) {
118 return SNMP_ERR_NOSUCHINSTANCE;
119 }
120
121 snmp_engineid_to_oid(engineid, engineid_oid, engineid_len);
122
123 /* Verify EngineID */
124 if (snmp_oid_equal(&row_oid[engineid_start], engineid_len, engineid_oid, engineid_len)) {
125 return SNMP_ERR_NOSUCHINSTANCE;
126 }
127
128 name_len = (u8_t)row_oid[engineid_start + engineid_len];
129 name_start = engineid_start + engineid_len + 1;
130
131 if (name_len > SNMP_V3_MAX_USER_LENGTH) {
132 /* specified name is too long */
133 return SNMP_ERR_NOSUCHINSTANCE;
134 }
135
136 if (1 + engineid_len + 1 + name_len != row_oid_len) {
137 /* Length of EngineID and name does not match row oid length. (+2 for length fields)*/
138 return SNMP_ERR_NOSUCHINSTANCE;
139 }
140
141 /* check if incoming OID length and if values are in plausible range */
142 if (!snmp_oid_in_range(&row_oid[name_start], name_len, usmUserTable_oid_ranges, name_len)) {
143 return SNMP_ERR_NOSUCHINSTANCE;
144 }
145
146 /* Verify if user exists */
147 memset(username, 0, sizeof(username));
148 snmp_oid_to_name(username, &row_oid[name_start], name_len);
149 if (snmpv3_get_user(username, NULL, NULL, NULL, NULL) != ERR_OK) {
150 return SNMP_ERR_NOSUCHINSTANCE;
151 }
152
153 /* Save name in reference pointer to make it easier to handle later on */
154 cell_instance->reference.ptr = username;
155 cell_instance->reference_len = name_len;
156
157 /* user was found */
158 return SNMP_ERR_NOERROR;
159 }
160
161 /*
162 * valid oid options
163 * <oid>
164 * <oid>.<EngineID length>
165 * <oid>.<EngineID length>.<partial EngineID>
166 * <oid>.<EngineID length>.<EngineID>
167 * <oid>.<EngineID length>.<EngineID>.<UserName length>
168 * <oid>.<EngineID length>.<EngineID>.<UserName length>.<partial UserName>
169 * <oid>.<EngineID length>.<EngineID>.<UserName length>.<UserName>
170 *
171 */
usmusertable_get_next_instance(const u32_t * column,struct snmp_obj_id * row_oid,struct snmp_node_instance * cell_instance)172 static snmp_err_t usmusertable_get_next_instance(const u32_t *column, struct snmp_obj_id *row_oid, struct snmp_node_instance *cell_instance)
173 {
174 const char *engineid;
175 u8_t eid_len;
176
177 u32_t engineid_oid[SNMP_V3_MAX_ENGINE_ID_LENGTH];
178
179 u8_t name_len;
180 u8_t engineid_len;
181
182 u8_t name_start;
183 u8_t engineid_start = 1;
184 u8_t i;
185
186 struct snmp_next_oid_state state;
187
188 u32_t result_temp[LWIP_ARRAYSIZE(usmUserTable_oid_ranges)];
189
190 LWIP_UNUSED_ARG(column);
191
192 snmpv3_get_engine_id(&engineid, &eid_len);
193
194 /* If EngineID might be given */
195 if (row_oid->len > 0) {
196 engineid_len = (u8_t)row_oid->id[0];
197 engineid_start = 1;
198
199 if (engineid_len != eid_len) {
200 /* EngineID length does not match! */
201 return SNMP_ERR_NOSUCHINSTANCE;
202 }
203
204 if (engineid_len > row_oid->len) {
205 /* Verify partial EngineID */
206 snmp_engineid_to_oid(engineid, engineid_oid, row_oid->len - 1);
207 if (!snmp_oid_equal(&row_oid->id[engineid_start], row_oid->len - 1, engineid_oid, row_oid->len - 1)) {
208 return SNMP_ERR_NOSUCHINSTANCE;
209 }
210 }
211 else {
212 /* Verify complete EngineID */
213 snmp_engineid_to_oid(engineid, engineid_oid, engineid_len);
214 if (!snmp_oid_equal(&row_oid->id[engineid_start], engineid_len, engineid_oid, engineid_len)) {
215 return SNMP_ERR_NOSUCHINSTANCE;
216 }
217 }
218
219 /* At this point, the given EngineID (partially) matches the local EngineID.*/
220
221 /* If name might also be given */
222 if (row_oid->len > engineid_start + engineid_len) {
223 name_len = (u8_t)row_oid->id[engineid_start + engineid_len];
224 name_start = engineid_start + engineid_len + 1;
225
226 if (name_len > SNMP_V3_MAX_USER_LENGTH) {
227 /* specified name is too long, max length is 32 according to mib file.*/
228 return SNMP_ERR_NOSUCHINSTANCE;
229 }
230
231 if (row_oid->len < engineid_len + name_len + 2) {
232 /* Partial name given according to oid.*/
233 u8_t tmplen = row_oid->len - engineid_len - 2;
234 if (!snmp_oid_in_range(&row_oid->id[name_start], tmplen, usmUserTable_oid_ranges, tmplen)) {
235 return SNMP_ERR_NOSUCHINSTANCE;
236 }
237 }
238 else {
239 /* Full name given according to oid. Also test for too much data.*/
240 u8_t tmplen = row_oid->len - engineid_len - 2;
241 if (!snmp_oid_in_range(&row_oid->id[name_start], name_len, usmUserTable_oid_ranges, tmplen)) {
242 return SNMP_ERR_NOSUCHINSTANCE;
243 }
244 }
245
246 /* At this point the EngineID and (partial) UserName match the local EngineID and UserName.*/
247 }
248 }
249
250 /* init struct to search next oid */
251 snmp_next_oid_init(&state, row_oid->id, row_oid->len, result_temp, LWIP_ARRAYSIZE(usmUserTable_oid_ranges));
252
253 for (i = 0; i < snmpv3_get_amount_of_users(); i++) {
254 u32_t test_oid[LWIP_ARRAYSIZE(usmUserTable_oid_ranges)];
255
256 test_oid[0] = eid_len;
257 snmp_engineid_to_oid(engineid, &test_oid[1], eid_len);
258
259 snmpv3_get_username(username, i);
260
261 test_oid[1 + eid_len] = strlen(username);
262 snmp_name_to_oid(username, &test_oid[2 + eid_len], strlen(username));
263
264 /* check generated OID: is it a candidate for the next one? */
265 snmp_next_oid_check(&state, test_oid, (u8_t)(1 + eid_len + 1 + strlen(username)), LWIP_PTR_NUMERIC_CAST(void*, i));
266 }
267
268 /* did we find a next one? */
269 if (state.status == SNMP_NEXT_OID_STATUS_SUCCESS) {
270 snmp_oid_assign(row_oid, state.next_oid, state.next_oid_len);
271 /* store username for subsequent operations (get/test/set) */
272 memset(username, 0, sizeof(username));
273 snmpv3_get_username(username, LWIP_PTR_NUMERIC_CAST(u8_t, state.reference));
274 cell_instance->reference.ptr = username;
275 cell_instance->reference_len = strlen(username);
276 return SNMP_ERR_NOERROR;
277 }
278
279 /* not found */
280 return SNMP_ERR_NOSUCHINSTANCE;
281 }
282
usmusertable_get_value(struct snmp_node_instance * cell_instance,void * value)283 static s16_t usmusertable_get_value(struct snmp_node_instance *cell_instance, void *value)
284 {
285 snmpv3_user_storagetype_t storage_type;
286
287 switch (SNMP_TABLE_GET_COLUMN_FROM_OID(cell_instance->instance_oid.id)) {
288 case 3: /* usmUserSecurityName */
289 MEMCPY(value, cell_instance->reference.ptr, cell_instance->reference_len);
290 return (s16_t)cell_instance->reference_len;
291 break;
292 case 4: /* usmUserCloneFrom */
293 MEMCPY(value, snmp_zero_dot_zero.id, snmp_zero_dot_zero.len * sizeof(u32_t));
294 return snmp_zero_dot_zero.len * sizeof(u32_t);
295 case 5: /* usmUserAuthProtocol */
296 {
297 const struct snmp_obj_id *auth_algo;
298 snmpv3_auth_algo_t auth_algo_val;
299 snmpv3_get_user((const char*)cell_instance->reference.ptr, &auth_algo_val, NULL, NULL, NULL);
300 auth_algo = snmp_auth_algo_to_oid(auth_algo_val);
301 MEMCPY(value, auth_algo->id, auth_algo->len * sizeof(u32_t));
302 return auth_algo->len * sizeof(u32_t);
303 }
304 case 6: /* usmUserAuthKeyChange */
305 return 0;
306 case 7: /* usmUserOwnAuthKeyChange */
307 return 0;
308 case 8: /* usmUserPrivProtocol */
309 {
310 const struct snmp_obj_id *priv_algo;
311 snmpv3_priv_algo_t priv_algo_val;
312 snmpv3_get_user((const char*)cell_instance->reference.ptr, NULL, NULL, &priv_algo_val, NULL);
313 priv_algo = snmp_priv_algo_to_oid(priv_algo_val);
314 MEMCPY(value, priv_algo->id, priv_algo->len * sizeof(u32_t));
315 return priv_algo->len * sizeof(u32_t);
316 }
317 case 9: /* usmUserPrivKeyChange */
318 return 0;
319 case 10: /* usmUserOwnPrivKeyChange */
320 return 0;
321 case 11: /* usmUserPublic */
322 /* TODO: Implement usmUserPublic */
323 return 0;
324 case 12: /* usmUserStorageType */
325 snmpv3_get_user_storagetype((const char*)cell_instance->reference.ptr, &storage_type);
326 *(s32_t*)value = storage_type;
327 return sizeof(s32_t);
328 case 13: /* usmUserStatus */
329 *(s32_t*)value = 1; /* active */
330 return sizeof(s32_t);
331 default:
332 LWIP_DEBUGF(SNMP_MIB_DEBUG,("usmusertable_get_value(): unknown id: %"S32_F"\n", SNMP_TABLE_GET_COLUMN_FROM_OID(cell_instance->instance_oid.id)));
333 return 0;
334 }
335 }
336
337 /* --- usmMIBObjects 1.3.6.1.6.3.15.1 ----------------------------------------------------- */
usmstats_scalars_get_value(const struct snmp_scalar_array_node_def * node,void * value)338 static s16_t usmstats_scalars_get_value(const struct snmp_scalar_array_node_def *node, void *value)
339 {
340 u32_t *uint_ptr = (u32_t*)value;
341 switch (node->oid) {
342 case 1: /* usmStatsUnsupportedSecLevels */
343 *uint_ptr = snmp_stats.unsupportedseclevels;
344 break;
345 case 2: /* usmStatsNotInTimeWindows */
346 *uint_ptr = snmp_stats.notintimewindows;
347 break;
348 case 3: /* usmStatsUnknownUserNames */
349 *uint_ptr = snmp_stats.unknownusernames;
350 break;
351 case 4: /* usmStatsUnknownEngineIDs */
352 *uint_ptr = snmp_stats.unknownengineids;
353 break;
354 case 5: /* usmStatsWrongDigests */
355 *uint_ptr = snmp_stats.wrongdigests;
356 break;
357 case 6: /* usmStatsDecryptionErrors */
358 *uint_ptr = snmp_stats.decryptionerrors;
359 break;
360 default:
361 LWIP_DEBUGF(SNMP_MIB_DEBUG,("usmstats_scalars_get_value(): unknown id: %"S32_F"\n", node->oid));
362 return 0;
363 }
364
365 return sizeof(*uint_ptr);
366 }
367
368 /* --- snmpUsmMIB ----------------------------------------------------- */
369
370 /* --- usmUser 1.3.6.1.6.3.15.1.2 ----------------------------------------------------- */
371
372 static const struct snmp_table_col_def usmusertable_columns[] = {
373 {3, SNMP_ASN1_TYPE_OCTET_STRING, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmUserSecurityName */
374 {4, SNMP_ASN1_TYPE_OBJECT_ID, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmUserCloneFrom */
375 {5, SNMP_ASN1_TYPE_OBJECT_ID, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmUserAuthProtocol */
376 {6, SNMP_ASN1_TYPE_OCTET_STRING, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmUserAuthKeyChange */
377 {7, SNMP_ASN1_TYPE_OCTET_STRING, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmUserOwnAuthKeyChange */
378 {8, SNMP_ASN1_TYPE_OBJECT_ID, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmUserPrivProtocol */
379 {9, SNMP_ASN1_TYPE_OCTET_STRING, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmUserPrivKeyChange */
380 {10, SNMP_ASN1_TYPE_OCTET_STRING, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmUserOwnPrivKeyChange */
381 {11, SNMP_ASN1_TYPE_OCTET_STRING, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmUserPublic */
382 {12, SNMP_ASN1_TYPE_INTEGER, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmUserStorageType */
383 {13, SNMP_ASN1_TYPE_INTEGER, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmUserStatus */
384 };
385 static const struct snmp_table_node usmusertable = SNMP_TABLE_CREATE(2, usmusertable_columns, usmusertable_get_instance, usmusertable_get_next_instance, usmusertable_get_value, NULL, NULL);
386
387 static const struct snmp_node *const usmuser_subnodes[] = {
388 &usmusertable.node.node
389 };
390 static const struct snmp_tree_node usmuser_treenode = SNMP_CREATE_TREE_NODE(2, usmuser_subnodes);
391
392 /* --- usmMIBObjects 1.3.6.1.6.3.15.1 ----------------------------------------------------- */
393 static const struct snmp_scalar_array_node_def usmstats_scalars_nodes[] = {
394 {1, SNMP_ASN1_TYPE_COUNTER, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmStatsUnsupportedSecLevels */
395 {2, SNMP_ASN1_TYPE_COUNTER, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmStatsNotInTimeWindows */
396 {3, SNMP_ASN1_TYPE_COUNTER, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmStatsUnknownUserNames */
397 {4, SNMP_ASN1_TYPE_COUNTER, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmStatsUnknownEngineIDs */
398 {5, SNMP_ASN1_TYPE_COUNTER, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmStatsWrongDigests */
399 {6, SNMP_ASN1_TYPE_COUNTER, SNMP_NODE_INSTANCE_READ_ONLY}, /* usmStatsDecryptionErrors */
400 };
401 static const struct snmp_scalar_array_node usmstats_scalars = SNMP_SCALAR_CREATE_ARRAY_NODE(1, usmstats_scalars_nodes, usmstats_scalars_get_value, NULL, NULL);
402
403 static const struct snmp_node *const usmmibobjects_subnodes[] = {
404 &usmstats_scalars.node.node,
405 &usmuser_treenode.node
406 };
407 static const struct snmp_tree_node usmmibobjects_treenode = SNMP_CREATE_TREE_NODE(1, usmmibobjects_subnodes);
408
409 /* --- snmpUsmMIB ----------------------------------------------------- */
410 static const struct snmp_node *const snmpusmmib_subnodes[] = {
411 &usmmibobjects_treenode.node
412 };
413 static const struct snmp_tree_node snmpusmmib_root = SNMP_CREATE_TREE_NODE(15, snmpusmmib_subnodes);
414 static const u32_t snmpusmmib_base_oid[] = {1,3,6,1,6,3,15};
415 const struct snmp_mib snmpusmmib = {snmpusmmib_base_oid, LWIP_ARRAYSIZE(snmpusmmib_base_oid), &snmpusmmib_root.node};
416
417 #endif /* LWIP_SNMP */
418