1*10465441SEvalZero /** 2*10465441SEvalZero * @file 3*10465441SEvalZero * Additional SNMPv3 functionality RFC3414 and RFC3826. 4*10465441SEvalZero */ 5*10465441SEvalZero 6*10465441SEvalZero /* 7*10465441SEvalZero * Copyright (c) 2016 Elias Oenal. 8*10465441SEvalZero * All rights reserved. 9*10465441SEvalZero * 10*10465441SEvalZero * Redistribution and use in source and binary forms, with or without modification, 11*10465441SEvalZero * are permitted provided that the following conditions are met: 12*10465441SEvalZero * 13*10465441SEvalZero * 1. Redistributions of source code must retain the above copyright notice, 14*10465441SEvalZero * this list of conditions and the following disclaimer. 15*10465441SEvalZero * 2. Redistributions in binary form must reproduce the above copyright notice, 16*10465441SEvalZero * this list of conditions and the following disclaimer in the documentation 17*10465441SEvalZero * and/or other materials provided with the distribution. 18*10465441SEvalZero * 3. The name of the author may not be used to endorse or promote products 19*10465441SEvalZero * derived from this software without specific prior written permission. 20*10465441SEvalZero * 21*10465441SEvalZero * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 22*10465441SEvalZero * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 23*10465441SEvalZero * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 24*10465441SEvalZero * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25*10465441SEvalZero * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 26*10465441SEvalZero * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27*10465441SEvalZero * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28*10465441SEvalZero * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 29*10465441SEvalZero * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 30*10465441SEvalZero * OF SUCH DAMAGE. 31*10465441SEvalZero * 32*10465441SEvalZero * Author: Elias Oenal <[email protected]> 33*10465441SEvalZero */ 34*10465441SEvalZero 35*10465441SEvalZero #ifndef LWIP_HDR_APPS_SNMP_V3_H 36*10465441SEvalZero #define LWIP_HDR_APPS_SNMP_V3_H 37*10465441SEvalZero 38*10465441SEvalZero #include "lwip/apps/snmp_opts.h" 39*10465441SEvalZero #include "lwip/err.h" 40*10465441SEvalZero 41*10465441SEvalZero #if LWIP_SNMP && LWIP_SNMP_V3 42*10465441SEvalZero 43*10465441SEvalZero #define SNMP_V3_AUTH_ALGO_INVAL 0 44*10465441SEvalZero #define SNMP_V3_AUTH_ALGO_MD5 1 45*10465441SEvalZero #define SNMP_V3_AUTH_ALGO_SHA 2 46*10465441SEvalZero 47*10465441SEvalZero #define SNMP_V3_PRIV_ALGO_INVAL 0 48*10465441SEvalZero #define SNMP_V3_PRIV_ALGO_DES 1 49*10465441SEvalZero #define SNMP_V3_PRIV_ALGO_AES 2 50*10465441SEvalZero 51*10465441SEvalZero #define SNMP_V3_PRIV_MODE_DECRYPT 0 52*10465441SEvalZero #define SNMP_V3_PRIV_MODE_ENCRYPT 1 53*10465441SEvalZero 54*10465441SEvalZero /* 55*10465441SEvalZero * The following callback functions must be implemented by the application. 56*10465441SEvalZero * There is a dummy implementation in snmpv3_dummy.c. 57*10465441SEvalZero */ 58*10465441SEvalZero 59*10465441SEvalZero void snmpv3_get_engine_id(const char **id, u8_t *len); 60*10465441SEvalZero err_t snmpv3_set_engine_id(const char* id, u8_t len); 61*10465441SEvalZero 62*10465441SEvalZero u32_t snmpv3_get_engine_boots(void); 63*10465441SEvalZero void snmpv3_set_engine_boots(u32_t boots); 64*10465441SEvalZero 65*10465441SEvalZero u32_t snmpv3_get_engine_time(void); 66*10465441SEvalZero void snmpv3_reset_engine_time(void); 67*10465441SEvalZero 68*10465441SEvalZero err_t snmpv3_get_user(const char* username, u8_t *auth_algo, u8_t *auth_key, u8_t *priv_algo, u8_t *priv_key); 69*10465441SEvalZero 70*10465441SEvalZero /* The following functions are provided by the SNMPv3 agent */ 71*10465441SEvalZero 72*10465441SEvalZero void snmpv3_engine_id_changed(void); 73*10465441SEvalZero 74*10465441SEvalZero void snmpv3_password_to_key_md5( 75*10465441SEvalZero const u8_t *password, /* IN */ 76*10465441SEvalZero u8_t passwordlen, /* IN */ 77*10465441SEvalZero const u8_t *engineID, /* IN - pointer to snmpEngineID */ 78*10465441SEvalZero u8_t engineLength, /* IN - length of snmpEngineID */ 79*10465441SEvalZero u8_t *key); /* OUT - pointer to caller 16-octet buffer */ 80*10465441SEvalZero 81*10465441SEvalZero void snmpv3_password_to_key_sha( 82*10465441SEvalZero const u8_t *password, /* IN */ 83*10465441SEvalZero u8_t passwordlen, /* IN */ 84*10465441SEvalZero const u8_t *engineID, /* IN - pointer to snmpEngineID */ 85*10465441SEvalZero u8_t engineLength, /* IN - length of snmpEngineID */ 86*10465441SEvalZero u8_t *key); /* OUT - pointer to caller 20-octet buffer */ 87*10465441SEvalZero 88*10465441SEvalZero #endif 89*10465441SEvalZero 90*10465441SEvalZero #endif /* LWIP_HDR_APPS_SNMP_V3_H */ 91