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