1 | /**
|
---|
2 | * @file
|
---|
3 | * Additional SNMPv3 functionality RFC3414 and RFC3826.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (c) 2016 Elias Oenal.
|
---|
8 | * All rights reserved.
|
---|
9 | *
|
---|
10 | * Redistribution and use in source and binary forms, with or without modification,
|
---|
11 | * are permitted provided that the following conditions are met:
|
---|
12 | *
|
---|
13 | * 1. Redistributions of source code must retain the above copyright notice,
|
---|
14 | * this list of conditions and the following disclaimer.
|
---|
15 | * 2. Redistributions in binary form must reproduce the above copyright notice,
|
---|
16 | * this list of conditions and the following disclaimer in the documentation
|
---|
17 | * and/or other materials provided with the distribution.
|
---|
18 | * 3. The name of the author may not be used to endorse or promote products
|
---|
19 | * derived from this software without specific prior written permission.
|
---|
20 | *
|
---|
21 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
|
---|
22 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
---|
23 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
|
---|
24 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
---|
25 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
|
---|
26 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
---|
27 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
---|
28 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
|
---|
29 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
|
---|
30 | * OF SUCH DAMAGE.
|
---|
31 | *
|
---|
32 | * Author: Elias Oenal <lwip@eliasoenal.com>
|
---|
33 | */
|
---|
34 |
|
---|
35 | #ifndef LWIP_HDR_APPS_SNMP_V3_H
|
---|
36 | #define LWIP_HDR_APPS_SNMP_V3_H
|
---|
37 |
|
---|
38 | #include "lwip/apps/snmp_opts.h"
|
---|
39 | #include "lwip/err.h"
|
---|
40 |
|
---|
41 | #ifdef __cplusplus
|
---|
42 | extern "C" {
|
---|
43 | #endif
|
---|
44 |
|
---|
45 | #if LWIP_SNMP && LWIP_SNMP_V3
|
---|
46 |
|
---|
47 | typedef enum
|
---|
48 | {
|
---|
49 | SNMP_V3_AUTH_ALGO_INVAL = 0,
|
---|
50 | SNMP_V3_AUTH_ALGO_MD5 = 1,
|
---|
51 | SNMP_V3_AUTH_ALGO_SHA = 2
|
---|
52 | } snmpv3_auth_algo_t;
|
---|
53 |
|
---|
54 | typedef enum
|
---|
55 | {
|
---|
56 | SNMP_V3_PRIV_ALGO_INVAL = 0,
|
---|
57 | SNMP_V3_PRIV_ALGO_DES = 1,
|
---|
58 | SNMP_V3_PRIV_ALGO_AES = 2
|
---|
59 | } snmpv3_priv_algo_t;
|
---|
60 |
|
---|
61 | typedef enum
|
---|
62 | {
|
---|
63 | SNMP_V3_USER_STORAGETYPE_OTHER = 1,
|
---|
64 | SNMP_V3_USER_STORAGETYPE_VOLATILE = 2,
|
---|
65 | SNMP_V3_USER_STORAGETYPE_NONVOLATILE = 3,
|
---|
66 | SNMP_V3_USER_STORAGETYPE_PERMANENT = 4,
|
---|
67 | SNMP_V3_USER_STORAGETYPE_READONLY = 5
|
---|
68 | } snmpv3_user_storagetype_t;
|
---|
69 |
|
---|
70 | /*
|
---|
71 | * The following callback functions must be implemented by the application.
|
---|
72 | * There is a dummy implementation in snmpv3_dummy.c.
|
---|
73 | */
|
---|
74 |
|
---|
75 | void snmpv3_get_engine_id(const char **id, u8_t *len);
|
---|
76 | err_t snmpv3_set_engine_id(const char* id, u8_t len);
|
---|
77 |
|
---|
78 | u32_t snmpv3_get_engine_boots(void);
|
---|
79 | void snmpv3_set_engine_boots(u32_t boots);
|
---|
80 |
|
---|
81 | u32_t snmpv3_get_engine_time(void);
|
---|
82 | void snmpv3_reset_engine_time(void);
|
---|
83 |
|
---|
84 | err_t snmpv3_get_user(const char* username, snmpv3_auth_algo_t *auth_algo, u8_t *auth_key, snmpv3_priv_algo_t *priv_algo, u8_t *priv_key);
|
---|
85 | u8_t snmpv3_get_amount_of_users(void);
|
---|
86 | err_t snmpv3_get_user_storagetype(const char *username, snmpv3_user_storagetype_t *storagetype);
|
---|
87 | err_t snmpv3_get_username(char *username, u8_t index);
|
---|
88 |
|
---|
89 | /* The following functions are provided by the SNMPv3 agent */
|
---|
90 |
|
---|
91 | void snmpv3_engine_id_changed(void);
|
---|
92 | s32_t snmpv3_get_engine_time_internal(void);
|
---|
93 |
|
---|
94 | void snmpv3_password_to_key_md5(
|
---|
95 | const u8_t *password, /* IN */
|
---|
96 | size_t passwordlen, /* IN */
|
---|
97 | const u8_t *engineID, /* IN - pointer to snmpEngineID */
|
---|
98 | u8_t engineLength, /* IN - length of snmpEngineID */
|
---|
99 | u8_t *key); /* OUT - pointer to caller 16-octet buffer */
|
---|
100 |
|
---|
101 | void snmpv3_password_to_key_sha(
|
---|
102 | const u8_t *password, /* IN */
|
---|
103 | size_t passwordlen, /* IN */
|
---|
104 | const u8_t *engineID, /* IN - pointer to snmpEngineID */
|
---|
105 | u8_t engineLength, /* IN - length of snmpEngineID */
|
---|
106 | u8_t *key); /* OUT - pointer to caller 20-octet buffer */
|
---|
107 |
|
---|
108 | #endif
|
---|
109 |
|
---|
110 | #ifdef __cplusplus
|
---|
111 | }
|
---|
112 | #endif
|
---|
113 |
|
---|
114 | #endif /* LWIP_HDR_APPS_SNMP_V3_H */
|
---|