Dependencies:   mbed

Dependents:   TCP

Committer:
slowness
Date:
Tue Sep 06 18:05:46 2011 +0000
Revision:
0:58c3d014a4e7

        

Who changed what in which revision?

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