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#define SNMP_V3_AUTH_ALGO_INVAL  0
44#define SNMP_V3_AUTH_ALGO_MD5    1
45#define SNMP_V3_AUTH_ALGO_SHA    2
46
47#define SNMP_V3_PRIV_ALGO_INVAL  0
48#define SNMP_V3_PRIV_ALGO_DES    1
49#define SNMP_V3_PRIV_ALGO_AES    2
50
51#define SNMP_V3_PRIV_MODE_DECRYPT  0
52#define SNMP_V3_PRIV_MODE_ENCRYPT  1
53
54/*
55 * The following callback functions must be implemented by the application.
56 * There is a dummy implementation in snmpv3_dummy.c.
57 */
58
59void snmpv3_get_engine_id(const char **id, u8_t *len);
60err_t snmpv3_set_engine_id(const char* id, u8_t len);
61
62u32_t snmpv3_get_engine_boots(void);
63void snmpv3_set_engine_boots(u32_t boots);
64
65u32_t snmpv3_get_engine_time(void);
66void snmpv3_reset_engine_time(void);
67
68err_t snmpv3_get_user(const char* username, u8_t *auth_algo, u8_t *auth_key, u8_t *priv_algo, u8_t *priv_key);
69
70/* The following functions are provided by the SNMPv3 agent */
71
72void snmpv3_engine_id_changed(void);
73
74void snmpv3_password_to_key_md5(
75    const u8_t *password,     /* IN */
76    u8_t        passwordlen,  /* IN */
77    const u8_t *engineID,     /* IN  - pointer to snmpEngineID  */
78    u8_t        engineLength, /* IN  - length of snmpEngineID */
79    u8_t       *key);         /* OUT - pointer to caller 16-octet buffer */
80
81void snmpv3_password_to_key_sha(
82    const u8_t *password,     /* IN */
83    u8_t        passwordlen,  /* IN */
84    const u8_t *engineID,     /* IN  - pointer to snmpEngineID  */
85    u8_t        engineLength, /* IN  - length of snmpEngineID */
86    u8_t       *key);         /* OUT - pointer to caller 20-octet buffer */
87
88#endif
89
90#endif /* LWIP_HDR_APPS_SNMP_V3_H */
91