Donatien Garnier
ZG2100 Network interface source
lwip/include/lwip/snmp_msg.h@0:b802fc31f1db, 2010-07-09 (annotated)
- Committer:
- donatien
- Date:
- Fri Jul 09 15:37:23 2010 +0000
- Revision:
- 0:b802fc31f1db
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:b802fc31f1db | 1 | /** |
| donatien | 0:b802fc31f1db | 2 | * @file |
| donatien | 0:b802fc31f1db | 3 | * SNMP Agent message handling structures. |
| donatien | 0:b802fc31f1db | 4 | */ |
| donatien | 0:b802fc31f1db | 5 | |
| donatien | 0:b802fc31f1db | 6 | /* |
| donatien | 0:b802fc31f1db | 7 | * Copyright (c) 2006 Axon Digital Design B.V., The Netherlands. |
| donatien | 0:b802fc31f1db | 8 | * All rights reserved. |
| donatien | 0:b802fc31f1db | 9 | * |
| donatien | 0:b802fc31f1db | 10 | * Redistribution and use in source and binary forms, with or without modification, |
| donatien | 0:b802fc31f1db | 11 | * are permitted provided that the following conditions are met: |
| donatien | 0:b802fc31f1db | 12 | * |
| donatien | 0:b802fc31f1db | 13 | * 1. Redistributions of source code must retain the above copyright notice, |
| donatien | 0:b802fc31f1db | 14 | * this list of conditions and the following disclaimer. |
| donatien | 0:b802fc31f1db | 15 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
| donatien | 0:b802fc31f1db | 16 | * this list of conditions and the following disclaimer in the documentation |
| donatien | 0:b802fc31f1db | 17 | * and/or other materials provided with the distribution. |
| donatien | 0:b802fc31f1db | 18 | * 3. The name of the author may not be used to endorse or promote products |
| donatien | 0:b802fc31f1db | 19 | * derived from this software without specific prior written permission. |
| donatien | 0:b802fc31f1db | 20 | * |
| donatien | 0:b802fc31f1db | 21 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
| donatien | 0:b802fc31f1db | 22 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| donatien | 0:b802fc31f1db | 23 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
| donatien | 0:b802fc31f1db | 24 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| donatien | 0:b802fc31f1db | 25 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
| donatien | 0:b802fc31f1db | 26 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| donatien | 0:b802fc31f1db | 27 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| donatien | 0:b802fc31f1db | 28 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
| donatien | 0:b802fc31f1db | 29 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
| donatien | 0:b802fc31f1db | 30 | * OF SUCH DAMAGE. |
| donatien | 0:b802fc31f1db | 31 | * |
| donatien | 0:b802fc31f1db | 32 | * Author: Christiaan Simons <christiaan.simons@axon.tv> |
| donatien | 0:b802fc31f1db | 33 | */ |
| donatien | 0:b802fc31f1db | 34 | |
| donatien | 0:b802fc31f1db | 35 | #ifndef __LWIP_SNMP_MSG_H__ |
| donatien | 0:b802fc31f1db | 36 | #define __LWIP_SNMP_MSG_H__ |
| donatien | 0:b802fc31f1db | 37 | |
| donatien | 0:b802fc31f1db | 38 | #include "lwip/opt.h" |
| donatien | 0:b802fc31f1db | 39 | #include "lwip/snmp.h" |
| donatien | 0:b802fc31f1db | 40 | #include "lwip/snmp_structs.h" |
| donatien | 0:b802fc31f1db | 41 | #include "lwip/ip_addr.h" |
| donatien | 0:b802fc31f1db | 42 | #include "lwip/err.h" |
| donatien | 0:b802fc31f1db | 43 | |
| donatien | 0:b802fc31f1db | 44 | #if LWIP_SNMP |
| donatien | 0:b802fc31f1db | 45 | |
| donatien | 0:b802fc31f1db | 46 | #if SNMP_PRIVATE_MIB |
| donatien | 0:b802fc31f1db | 47 | /* When using a private MIB, you have to create a file 'private_mib.h' that contains |
| donatien | 0:b802fc31f1db | 48 | * a 'struct mib_array_node mib_private' which contains your MIB. */ |
| donatien | 0:b802fc31f1db | 49 | #include "private_mib.h" |
| donatien | 0:b802fc31f1db | 50 | #endif |
| donatien | 0:b802fc31f1db | 51 | |
| donatien | 0:b802fc31f1db | 52 | #ifdef __cplusplus |
| donatien | 0:b802fc31f1db | 53 | extern "C" { |
| donatien | 0:b802fc31f1db | 54 | #endif |
| donatien | 0:b802fc31f1db | 55 | |
| donatien | 0:b802fc31f1db | 56 | /* The listen port of the SNMP agent. Clients have to make their requests to |
| donatien | 0:b802fc31f1db | 57 | this port. Most standard clients won't work if you change this! */ |
| donatien | 0:b802fc31f1db | 58 | #ifndef SNMP_IN_PORT |
| donatien | 0:b802fc31f1db | 59 | #define SNMP_IN_PORT 161 |
| donatien | 0:b802fc31f1db | 60 | #endif |
| donatien | 0:b802fc31f1db | 61 | /* The remote port the SNMP agent sends traps to. Most standard trap sinks won't |
| donatien | 0:b802fc31f1db | 62 | work if you change this! */ |
| donatien | 0:b802fc31f1db | 63 | #ifndef SNMP_TRAP_PORT |
| donatien | 0:b802fc31f1db | 64 | #define SNMP_TRAP_PORT 162 |
| donatien | 0:b802fc31f1db | 65 | #endif |
| donatien | 0:b802fc31f1db | 66 | |
| donatien | 0:b802fc31f1db | 67 | #define SNMP_ES_NOERROR 0 |
| donatien | 0:b802fc31f1db | 68 | #define SNMP_ES_TOOBIG 1 |
| donatien | 0:b802fc31f1db | 69 | #define SNMP_ES_NOSUCHNAME 2 |
| donatien | 0:b802fc31f1db | 70 | #define SNMP_ES_BADVALUE 3 |
| donatien | 0:b802fc31f1db | 71 | #define SNMP_ES_READONLY 4 |
| donatien | 0:b802fc31f1db | 72 | #define SNMP_ES_GENERROR 5 |
| donatien | 0:b802fc31f1db | 73 | |
| donatien | 0:b802fc31f1db | 74 | #define SNMP_GENTRAP_COLDSTART 0 |
| donatien | 0:b802fc31f1db | 75 | #define SNMP_GENTRAP_WARMSTART 1 |
| donatien | 0:b802fc31f1db | 76 | #define SNMP_GENTRAP_AUTHFAIL 4 |
| donatien | 0:b802fc31f1db | 77 | #define SNMP_GENTRAP_ENTERPRISESPC 6 |
| donatien | 0:b802fc31f1db | 78 | |
| donatien | 0:b802fc31f1db | 79 | struct snmp_varbind |
| donatien | 0:b802fc31f1db | 80 | { |
| donatien | 0:b802fc31f1db | 81 | /* next pointer, NULL for last in list */ |
| donatien | 0:b802fc31f1db | 82 | struct snmp_varbind *next; |
| donatien | 0:b802fc31f1db | 83 | /* previous pointer, NULL for first in list */ |
| donatien | 0:b802fc31f1db | 84 | struct snmp_varbind *prev; |
| donatien | 0:b802fc31f1db | 85 | |
| donatien | 0:b802fc31f1db | 86 | /* object identifier length (in s32_t) */ |
| donatien | 0:b802fc31f1db | 87 | u8_t ident_len; |
| donatien | 0:b802fc31f1db | 88 | /* object identifier array */ |
| donatien | 0:b802fc31f1db | 89 | s32_t *ident; |
| donatien | 0:b802fc31f1db | 90 | |
| donatien | 0:b802fc31f1db | 91 | /* object value ASN1 type */ |
| donatien | 0:b802fc31f1db | 92 | u8_t value_type; |
| donatien | 0:b802fc31f1db | 93 | /* object value length (in u8_t) */ |
| donatien | 0:b802fc31f1db | 94 | u8_t value_len; |
| donatien | 0:b802fc31f1db | 95 | /* object value */ |
| donatien | 0:b802fc31f1db | 96 | void *value; |
| donatien | 0:b802fc31f1db | 97 | |
| donatien | 0:b802fc31f1db | 98 | /* encoding varbind seq length length */ |
| donatien | 0:b802fc31f1db | 99 | u8_t seqlenlen; |
| donatien | 0:b802fc31f1db | 100 | /* encoding object identifier length length */ |
| donatien | 0:b802fc31f1db | 101 | u8_t olenlen; |
| donatien | 0:b802fc31f1db | 102 | /* encoding object value length length */ |
| donatien | 0:b802fc31f1db | 103 | u8_t vlenlen; |
| donatien | 0:b802fc31f1db | 104 | /* encoding varbind seq length */ |
| donatien | 0:b802fc31f1db | 105 | u16_t seqlen; |
| donatien | 0:b802fc31f1db | 106 | /* encoding object identifier length */ |
| donatien | 0:b802fc31f1db | 107 | u16_t olen; |
| donatien | 0:b802fc31f1db | 108 | /* encoding object value length */ |
| donatien | 0:b802fc31f1db | 109 | u16_t vlen; |
| donatien | 0:b802fc31f1db | 110 | }; |
| donatien | 0:b802fc31f1db | 111 | |
| donatien | 0:b802fc31f1db | 112 | struct snmp_varbind_root |
| donatien | 0:b802fc31f1db | 113 | { |
| donatien | 0:b802fc31f1db | 114 | struct snmp_varbind *head; |
| donatien | 0:b802fc31f1db | 115 | struct snmp_varbind *tail; |
| donatien | 0:b802fc31f1db | 116 | /* number of variable bindings in list */ |
| donatien | 0:b802fc31f1db | 117 | u8_t count; |
| donatien | 0:b802fc31f1db | 118 | /* encoding varbind-list seq length length */ |
| donatien | 0:b802fc31f1db | 119 | u8_t seqlenlen; |
| donatien | 0:b802fc31f1db | 120 | /* encoding varbind-list seq length */ |
| donatien | 0:b802fc31f1db | 121 | u16_t seqlen; |
| donatien | 0:b802fc31f1db | 122 | }; |
| donatien | 0:b802fc31f1db | 123 | |
| donatien | 0:b802fc31f1db | 124 | /** output response message header length fields */ |
| donatien | 0:b802fc31f1db | 125 | struct snmp_resp_header_lengths |
| donatien | 0:b802fc31f1db | 126 | { |
| donatien | 0:b802fc31f1db | 127 | /* encoding error-index length length */ |
| donatien | 0:b802fc31f1db | 128 | u8_t erridxlenlen; |
| donatien | 0:b802fc31f1db | 129 | /* encoding error-status length length */ |
| donatien | 0:b802fc31f1db | 130 | u8_t errstatlenlen; |
| donatien | 0:b802fc31f1db | 131 | /* encoding request id length length */ |
| donatien | 0:b802fc31f1db | 132 | u8_t ridlenlen; |
| donatien | 0:b802fc31f1db | 133 | /* encoding pdu length length */ |
| donatien | 0:b802fc31f1db | 134 | u8_t pdulenlen; |
| donatien | 0:b802fc31f1db | 135 | /* encoding community length length */ |
| donatien | 0:b802fc31f1db | 136 | u8_t comlenlen; |
| donatien | 0:b802fc31f1db | 137 | /* encoding version length length */ |
| donatien | 0:b802fc31f1db | 138 | u8_t verlenlen; |
| donatien | 0:b802fc31f1db | 139 | /* encoding sequence length length */ |
| donatien | 0:b802fc31f1db | 140 | u8_t seqlenlen; |
| donatien | 0:b802fc31f1db | 141 | |
| donatien | 0:b802fc31f1db | 142 | /* encoding error-index length */ |
| donatien | 0:b802fc31f1db | 143 | u16_t erridxlen; |
| donatien | 0:b802fc31f1db | 144 | /* encoding error-status length */ |
| donatien | 0:b802fc31f1db | 145 | u16_t errstatlen; |
| donatien | 0:b802fc31f1db | 146 | /* encoding request id length */ |
| donatien | 0:b802fc31f1db | 147 | u16_t ridlen; |
| donatien | 0:b802fc31f1db | 148 | /* encoding pdu length */ |
| donatien | 0:b802fc31f1db | 149 | u16_t pdulen; |
| donatien | 0:b802fc31f1db | 150 | /* encoding community length */ |
| donatien | 0:b802fc31f1db | 151 | u16_t comlen; |
| donatien | 0:b802fc31f1db | 152 | /* encoding version length */ |
| donatien | 0:b802fc31f1db | 153 | u16_t verlen; |
| donatien | 0:b802fc31f1db | 154 | /* encoding sequence length */ |
| donatien | 0:b802fc31f1db | 155 | u16_t seqlen; |
| donatien | 0:b802fc31f1db | 156 | }; |
| donatien | 0:b802fc31f1db | 157 | |
| donatien | 0:b802fc31f1db | 158 | /** output response message header length fields */ |
| donatien | 0:b802fc31f1db | 159 | struct snmp_trap_header_lengths |
| donatien | 0:b802fc31f1db | 160 | { |
| donatien | 0:b802fc31f1db | 161 | /* encoding timestamp length length */ |
| donatien | 0:b802fc31f1db | 162 | u8_t tslenlen; |
| donatien | 0:b802fc31f1db | 163 | /* encoding specific-trap length length */ |
| donatien | 0:b802fc31f1db | 164 | u8_t strplenlen; |
| donatien | 0:b802fc31f1db | 165 | /* encoding generic-trap length length */ |
| donatien | 0:b802fc31f1db | 166 | u8_t gtrplenlen; |
| donatien | 0:b802fc31f1db | 167 | /* encoding agent-addr length length */ |
| donatien | 0:b802fc31f1db | 168 | u8_t aaddrlenlen; |
| donatien | 0:b802fc31f1db | 169 | /* encoding enterprise-id length length */ |
| donatien | 0:b802fc31f1db | 170 | u8_t eidlenlen; |
| donatien | 0:b802fc31f1db | 171 | /* encoding pdu length length */ |
| donatien | 0:b802fc31f1db | 172 | u8_t pdulenlen; |
| donatien | 0:b802fc31f1db | 173 | /* encoding community length length */ |
| donatien | 0:b802fc31f1db | 174 | u8_t comlenlen; |
| donatien | 0:b802fc31f1db | 175 | /* encoding version length length */ |
| donatien | 0:b802fc31f1db | 176 | u8_t verlenlen; |
| donatien | 0:b802fc31f1db | 177 | /* encoding sequence length length */ |
| donatien | 0:b802fc31f1db | 178 | u8_t seqlenlen; |
| donatien | 0:b802fc31f1db | 179 | |
| donatien | 0:b802fc31f1db | 180 | /* encoding timestamp length */ |
| donatien | 0:b802fc31f1db | 181 | u16_t tslen; |
| donatien | 0:b802fc31f1db | 182 | /* encoding specific-trap length */ |
| donatien | 0:b802fc31f1db | 183 | u16_t strplen; |
| donatien | 0:b802fc31f1db | 184 | /* encoding generic-trap length */ |
| donatien | 0:b802fc31f1db | 185 | u16_t gtrplen; |
| donatien | 0:b802fc31f1db | 186 | /* encoding agent-addr length */ |
| donatien | 0:b802fc31f1db | 187 | u16_t aaddrlen; |
| donatien | 0:b802fc31f1db | 188 | /* encoding enterprise-id length */ |
| donatien | 0:b802fc31f1db | 189 | u16_t eidlen; |
| donatien | 0:b802fc31f1db | 190 | /* encoding pdu length */ |
| donatien | 0:b802fc31f1db | 191 | u16_t pdulen; |
| donatien | 0:b802fc31f1db | 192 | /* encoding community length */ |
| donatien | 0:b802fc31f1db | 193 | u16_t comlen; |
| donatien | 0:b802fc31f1db | 194 | /* encoding version length */ |
| donatien | 0:b802fc31f1db | 195 | u16_t verlen; |
| donatien | 0:b802fc31f1db | 196 | /* encoding sequence length */ |
| donatien | 0:b802fc31f1db | 197 | u16_t seqlen; |
| donatien | 0:b802fc31f1db | 198 | }; |
| donatien | 0:b802fc31f1db | 199 | |
| donatien | 0:b802fc31f1db | 200 | /* Accepting new SNMP messages. */ |
| donatien | 0:b802fc31f1db | 201 | #define SNMP_MSG_EMPTY 0 |
| donatien | 0:b802fc31f1db | 202 | /* Search for matching object for variable binding. */ |
| donatien | 0:b802fc31f1db | 203 | #define SNMP_MSG_SEARCH_OBJ 1 |
| donatien | 0:b802fc31f1db | 204 | /* Perform SNMP operation on in-memory object. |
| donatien | 0:b802fc31f1db | 205 | Pass-through states, for symmetry only. */ |
| donatien | 0:b802fc31f1db | 206 | #define SNMP_MSG_INTERNAL_GET_OBJDEF 2 |
| donatien | 0:b802fc31f1db | 207 | #define SNMP_MSG_INTERNAL_GET_VALUE 3 |
| donatien | 0:b802fc31f1db | 208 | #define SNMP_MSG_INTERNAL_SET_TEST 4 |
| donatien | 0:b802fc31f1db | 209 | #define SNMP_MSG_INTERNAL_GET_OBJDEF_S 5 |
| donatien | 0:b802fc31f1db | 210 | #define SNMP_MSG_INTERNAL_SET_VALUE 6 |
| donatien | 0:b802fc31f1db | 211 | /* Perform SNMP operation on object located externally. |
| donatien | 0:b802fc31f1db | 212 | In theory this could be used for building a proxy agent. |
| donatien | 0:b802fc31f1db | 213 | Practical use is for an enterprise spc. app. gateway. */ |
| donatien | 0:b802fc31f1db | 214 | #define SNMP_MSG_EXTERNAL_GET_OBJDEF 7 |
| donatien | 0:b802fc31f1db | 215 | #define SNMP_MSG_EXTERNAL_GET_VALUE 8 |
| donatien | 0:b802fc31f1db | 216 | #define SNMP_MSG_EXTERNAL_SET_TEST 9 |
| donatien | 0:b802fc31f1db | 217 | #define SNMP_MSG_EXTERNAL_GET_OBJDEF_S 10 |
| donatien | 0:b802fc31f1db | 218 | #define SNMP_MSG_EXTERNAL_SET_VALUE 11 |
| donatien | 0:b802fc31f1db | 219 | |
| donatien | 0:b802fc31f1db | 220 | #define SNMP_COMMUNITY_STR_LEN 64 |
| donatien | 0:b802fc31f1db | 221 | struct snmp_msg_pstat |
| donatien | 0:b802fc31f1db | 222 | { |
| donatien | 0:b802fc31f1db | 223 | /* lwIP local port (161) binding */ |
| donatien | 0:b802fc31f1db | 224 | struct udp_pcb *pcb; |
| donatien | 0:b802fc31f1db | 225 | /* source IP address */ |
| donatien | 0:b802fc31f1db | 226 | ip_addr_t sip; |
| donatien | 0:b802fc31f1db | 227 | /* source UDP port */ |
| donatien | 0:b802fc31f1db | 228 | u16_t sp; |
| donatien | 0:b802fc31f1db | 229 | /* request type */ |
| donatien | 0:b802fc31f1db | 230 | u8_t rt; |
| donatien | 0:b802fc31f1db | 231 | /* request ID */ |
| donatien | 0:b802fc31f1db | 232 | s32_t rid; |
| donatien | 0:b802fc31f1db | 233 | /* error status */ |
| donatien | 0:b802fc31f1db | 234 | s32_t error_status; |
| donatien | 0:b802fc31f1db | 235 | /* error index */ |
| donatien | 0:b802fc31f1db | 236 | s32_t error_index; |
| donatien | 0:b802fc31f1db | 237 | /* community name (zero terminated) */ |
| donatien | 0:b802fc31f1db | 238 | u8_t community[SNMP_COMMUNITY_STR_LEN + 1]; |
| donatien | 0:b802fc31f1db | 239 | /* community string length (exclusive zero term) */ |
| donatien | 0:b802fc31f1db | 240 | u8_t com_strlen; |
| donatien | 0:b802fc31f1db | 241 | /* one out of MSG_EMPTY, MSG_DEMUX, MSG_INTERNAL, MSG_EXTERNAL_x */ |
| donatien | 0:b802fc31f1db | 242 | u8_t state; |
| donatien | 0:b802fc31f1db | 243 | /* saved arguments for MSG_EXTERNAL_x */ |
| donatien | 0:b802fc31f1db | 244 | struct mib_external_node *ext_mib_node; |
| donatien | 0:b802fc31f1db | 245 | struct snmp_name_ptr ext_name_ptr; |
| donatien | 0:b802fc31f1db | 246 | struct obj_def ext_object_def; |
| donatien | 0:b802fc31f1db | 247 | struct snmp_obj_id ext_oid; |
| donatien | 0:b802fc31f1db | 248 | /* index into input variable binding list */ |
| donatien | 0:b802fc31f1db | 249 | u8_t vb_idx; |
| donatien | 0:b802fc31f1db | 250 | /* ptr into input variable binding list */ |
| donatien | 0:b802fc31f1db | 251 | struct snmp_varbind *vb_ptr; |
| donatien | 0:b802fc31f1db | 252 | /* list of variable bindings from input */ |
| donatien | 0:b802fc31f1db | 253 | struct snmp_varbind_root invb; |
| donatien | 0:b802fc31f1db | 254 | /* list of variable bindings to output */ |
| donatien | 0:b802fc31f1db | 255 | struct snmp_varbind_root outvb; |
| donatien | 0:b802fc31f1db | 256 | /* output response lengths used in ASN encoding */ |
| donatien | 0:b802fc31f1db | 257 | struct snmp_resp_header_lengths rhl; |
| donatien | 0:b802fc31f1db | 258 | }; |
| donatien | 0:b802fc31f1db | 259 | |
| donatien | 0:b802fc31f1db | 260 | struct snmp_msg_trap |
| donatien | 0:b802fc31f1db | 261 | { |
| donatien | 0:b802fc31f1db | 262 | /* lwIP local port (161) binding */ |
| donatien | 0:b802fc31f1db | 263 | struct udp_pcb *pcb; |
| donatien | 0:b802fc31f1db | 264 | /* destination IP address in network order */ |
| donatien | 0:b802fc31f1db | 265 | ip_addr_t dip; |
| donatien | 0:b802fc31f1db | 266 | |
| donatien | 0:b802fc31f1db | 267 | /* source enterprise ID (sysObjectID) */ |
| donatien | 0:b802fc31f1db | 268 | struct snmp_obj_id *enterprise; |
| donatien | 0:b802fc31f1db | 269 | /* source IP address, raw network order format */ |
| donatien | 0:b802fc31f1db | 270 | u8_t sip_raw[4]; |
| donatien | 0:b802fc31f1db | 271 | /* generic trap code */ |
| donatien | 0:b802fc31f1db | 272 | u32_t gen_trap; |
| donatien | 0:b802fc31f1db | 273 | /* specific trap code */ |
| donatien | 0:b802fc31f1db | 274 | u32_t spc_trap; |
| donatien | 0:b802fc31f1db | 275 | /* timestamp */ |
| donatien | 0:b802fc31f1db | 276 | u32_t ts; |
| donatien | 0:b802fc31f1db | 277 | /* list of variable bindings to output */ |
| donatien | 0:b802fc31f1db | 278 | struct snmp_varbind_root outvb; |
| donatien | 0:b802fc31f1db | 279 | /* output trap lengths used in ASN encoding */ |
| donatien | 0:b802fc31f1db | 280 | struct snmp_trap_header_lengths thl; |
| donatien | 0:b802fc31f1db | 281 | }; |
| donatien | 0:b802fc31f1db | 282 | |
| donatien | 0:b802fc31f1db | 283 | /** Agent Version constant, 0 = v1 oddity */ |
| donatien | 0:b802fc31f1db | 284 | extern const s32_t snmp_version; |
| donatien | 0:b802fc31f1db | 285 | /** Agent default "public" community string */ |
| donatien | 0:b802fc31f1db | 286 | extern const char snmp_publiccommunity[7]; |
| donatien | 0:b802fc31f1db | 287 | |
| donatien | 0:b802fc31f1db | 288 | extern struct snmp_msg_trap trap_msg; |
| donatien | 0:b802fc31f1db | 289 | |
| donatien | 0:b802fc31f1db | 290 | /** Agent setup, start listening to port 161. */ |
| donatien | 0:b802fc31f1db | 291 | void snmp_init(void); |
| donatien | 0:b802fc31f1db | 292 | void snmp_trap_dst_enable(u8_t dst_idx, u8_t enable); |
| donatien | 0:b802fc31f1db | 293 | void snmp_trap_dst_ip_set(u8_t dst_idx, ip_addr_t *dst); |
| donatien | 0:b802fc31f1db | 294 | |
| donatien | 0:b802fc31f1db | 295 | /** Varbind-list functions. */ |
| donatien | 0:b802fc31f1db | 296 | struct snmp_varbind* snmp_varbind_alloc(struct snmp_obj_id *oid, u8_t type, u8_t len); |
| donatien | 0:b802fc31f1db | 297 | void snmp_varbind_free(struct snmp_varbind *vb); |
| donatien | 0:b802fc31f1db | 298 | void snmp_varbind_list_free(struct snmp_varbind_root *root); |
| donatien | 0:b802fc31f1db | 299 | void snmp_varbind_tail_add(struct snmp_varbind_root *root, struct snmp_varbind *vb); |
| donatien | 0:b802fc31f1db | 300 | struct snmp_varbind* snmp_varbind_tail_remove(struct snmp_varbind_root *root); |
| donatien | 0:b802fc31f1db | 301 | |
| donatien | 0:b802fc31f1db | 302 | /** Handle an internal (recv) or external (private response) event. */ |
| donatien | 0:b802fc31f1db | 303 | void snmp_msg_event(u8_t request_id); |
| donatien | 0:b802fc31f1db | 304 | err_t snmp_send_response(struct snmp_msg_pstat *m_stat); |
| donatien | 0:b802fc31f1db | 305 | err_t snmp_send_trap(s8_t generic_trap, struct snmp_obj_id *eoid, s32_t specific_trap); |
| donatien | 0:b802fc31f1db | 306 | void snmp_coldstart_trap(void); |
| donatien | 0:b802fc31f1db | 307 | void snmp_authfail_trap(void); |
| donatien | 0:b802fc31f1db | 308 | |
| donatien | 0:b802fc31f1db | 309 | #ifdef __cplusplus |
| donatien | 0:b802fc31f1db | 310 | } |
| donatien | 0:b802fc31f1db | 311 | #endif |
| donatien | 0:b802fc31f1db | 312 | |
| donatien | 0:b802fc31f1db | 313 | #endif /* LWIP_SNMP */ |
| donatien | 0:b802fc31f1db | 314 | |
| donatien | 0:b802fc31f1db | 315 | #endif /* __LWIP_SNMP_MSG_H__ */ |