UbixOS V2 2.0

snmp_opts.h
Go to the documentation of this file.
1
6 /*
7 * Copyright (c) 2015 Dirk Ziegelmeier
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 * This file is part of the lwIP TCP/IP stack.
33 *
34 * Author: Dirk Ziegelmeier
35 *
36 */
37 #ifndef LWIP_HDR_SNMP_OPTS_H
38 #define LWIP_HDR_SNMP_OPTS_H
39
40 #include "lwip/opt.h"
41
56 #if !defined LWIP_SNMP || defined __DOXYGEN__
57 #define LWIP_SNMP 0
58 #endif
59
65 #if !defined SNMP_USE_NETCONN || defined __DOXYGEN__
66 #define SNMP_USE_NETCONN 0
67 #endif
68
74 #if !defined SNMP_USE_RAW || defined __DOXYGEN__
75 #define SNMP_USE_RAW 1
76 #endif
77
78 #if SNMP_USE_NETCONN && SNMP_USE_RAW
79 #error SNMP stack can use only one of the APIs {raw, netconn}
80 #endif
81
82 #if LWIP_SNMP && !SNMP_USE_NETCONN && !SNMP_USE_RAW
83 #error SNMP stack needs a receive API and UDP {raw, netconn}
84 #endif
85
86 #if SNMP_USE_NETCONN
87
90 #if !defined SNMP_STACK_SIZE || defined __DOXYGEN__
91 #define SNMP_STACK_SIZE DEFAULT_THREAD_STACKSIZE
92 #endif
93
97 #if !defined SNMP_THREAD_PRIO || defined __DOXYGEN__
98 #define SNMP_THREAD_PRIO DEFAULT_THREAD_PRIO
99 #endif
100 #endif /* SNMP_USE_NETCONN */
101
106 #if !defined SNMP_TRAP_DESTINATIONS || defined __DOXYGEN__
107 #define SNMP_TRAP_DESTINATIONS 1
108 #endif
109
115 #if !defined SNMP_SAFE_REQUESTS || defined __DOXYGEN__
116 #define SNMP_SAFE_REQUESTS 1
117 #endif
118
122 #if !defined SNMP_MAX_OCTET_STRING_LEN || defined __DOXYGEN__
123 #define SNMP_MAX_OCTET_STRING_LEN 127
124 #endif
125
130 #if !defined SNMP_MAX_OBJ_ID_LEN || defined __DOXYGEN__
131 #define SNMP_MAX_OBJ_ID_LEN 50
132 #endif
133
134 #if !defined SNMP_MAX_VALUE_SIZE || defined __DOXYGEN__
135
138 #define SNMP_MIN_VALUE_SIZE (2 * sizeof(u32_t*)) /* size required to store the basic types (8 bytes for counter64) */
139
142 #define SNMP_MAX_VALUE_SIZE LWIP_MAX(LWIP_MAX((SNMP_MAX_OCTET_STRING_LEN), sizeof(u32_t)*(SNMP_MAX_OBJ_ID_LEN)), SNMP_MIN_VALUE_SIZE)
143 #endif
144
149 #if !defined SNMP_COMMUNITY || defined __DOXYGEN__
150 #define SNMP_COMMUNITY "public"
151 #endif
152
157 #if !defined SNMP_COMMUNITY_WRITE || defined __DOXYGEN__
158 #define SNMP_COMMUNITY_WRITE "private"
159 #endif
160
164 #if !defined SNMP_COMMUNITY_TRAP || defined __DOXYGEN__
165 #define SNMP_COMMUNITY_TRAP "public"
166 #endif
167
173 #if !defined SNMP_MAX_COMMUNITY_STR_LEN || defined __DOXYGEN__
174 #define SNMP_MAX_COMMUNITY_STR_LEN LWIP_MAX(LWIP_MAX(sizeof(SNMP_COMMUNITY), sizeof(SNMP_COMMUNITY_WRITE)), sizeof(SNMP_COMMUNITY_TRAP))
175 #endif
176
180 #if !defined SNMP_DEVICE_ENTERPRISE_OID || defined __DOXYGEN__
181 #define SNMP_LWIP_ENTERPRISE_OID 26381
182
195 #define SNMP_DEVICE_ENTERPRISE_OID {1, 3, 6, 1, 4, 1, SNMP_LWIP_ENTERPRISE_OID}
196
199 #define SNMP_DEVICE_ENTERPRISE_OID_LEN 7
200 #endif
201
205 #if !defined SNMP_DEBUG || defined __DOXYGEN__
206 #define SNMP_DEBUG LWIP_DBG_OFF
207 #endif
208
212 #if !defined SNMP_MIB_DEBUG || defined __DOXYGEN__
213 #define SNMP_MIB_DEBUG LWIP_DBG_OFF
214 #endif
215
219 #if !defined SNMP_LWIP_MIB2 || defined __DOXYGEN__
220 #define SNMP_LWIP_MIB2 LWIP_SNMP
221 #endif
222
226 #if !defined SNMP_LWIP_MIB2_SYSDESC || defined __DOXYGEN__
227 #define SNMP_LWIP_MIB2_SYSDESC "lwIP"
228 #endif
229
234 #if !defined SNMP_LWIP_MIB2_SYSNAME || defined __DOXYGEN__
235 #define SNMP_LWIP_MIB2_SYSNAME "FQDN-unk"
236 #endif
237
242 #if !defined SNMP_LWIP_MIB2_SYSCONTACT || defined __DOXYGEN__
243 #define SNMP_LWIP_MIB2_SYSCONTACT ""
244 #endif
245
250 #if !defined SNMP_LWIP_MIB2_SYSLOCATION || defined __DOXYGEN__
251 #define SNMP_LWIP_MIB2_SYSLOCATION ""
252 #endif
253
262 #if !defined SNMP_LWIP_GETBULK_MAX_REPETITIONS || defined __DOXYGEN__
263 #define SNMP_LWIP_GETBULK_MAX_REPETITIONS 0
264 #endif
265
270 /*
271 ------------------------------------
272 ---------- SNMPv3 options ----------
273 ------------------------------------
274 */
275
281 #ifndef LWIP_SNMP_V3
282 #define LWIP_SNMP_V3 0
283 #endif
284
285 #ifndef LWIP_SNMP_V3_CRYPTO
286 #define LWIP_SNMP_V3_CRYPTO LWIP_SNMP_V3
287 #endif
288
289 #ifndef LWIP_SNMP_V3_MBEDTLS
290 #define LWIP_SNMP_V3_MBEDTLS LWIP_SNMP_V3
291 #endif
292
293 #endif /* LWIP_HDR_SNMP_OPTS_H */