Committer:
mbed714
Date:
Sat Sep 18 23:05:49 2010 +0000
Revision:
0:d616ece2d859

        

Who changed what in which revision?

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