Dependencies:   mbed

Committer:
gbeardall
Date:
Mon Oct 17 10:39:17 2011 +0000
Revision:
0:715023d993d6

        

Who changed what in which revision?

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