xref: /nrf52832-nimble/rt-thread/components/net/lwip-2.1.0/src/apps/snmp/snmpv3_priv.h (revision 104654410c56c573564690304ae786df310c91fc)
1*10465441SEvalZero /**
2*10465441SEvalZero  * @file
3*10465441SEvalZero  * Additional SNMPv3 functionality RFC3414 and RFC3826 (internal API, do not use in client code).
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_PRIV_H
36*10465441SEvalZero #define LWIP_HDR_APPS_SNMP_V3_PRIV_H
37*10465441SEvalZero 
38*10465441SEvalZero #include "lwip/apps/snmp_opts.h"
39*10465441SEvalZero 
40*10465441SEvalZero #if LWIP_SNMP && LWIP_SNMP_V3
41*10465441SEvalZero 
42*10465441SEvalZero #include "lwip/apps/snmpv3.h"
43*10465441SEvalZero #include "snmp_pbuf_stream.h"
44*10465441SEvalZero 
45*10465441SEvalZero /* According to RFC 3411 */
46*10465441SEvalZero #define SNMP_V3_MAX_ENGINE_ID_LENGTH  32
47*10465441SEvalZero #define SNMP_V3_MAX_USER_LENGTH       32
48*10465441SEvalZero 
49*10465441SEvalZero #define SNMP_V3_MAX_AUTH_PARAM_LENGTH  12
50*10465441SEvalZero #define SNMP_V3_MAX_PRIV_PARAM_LENGTH  8
51*10465441SEvalZero 
52*10465441SEvalZero #define SNMP_V3_MD5_LEN        16
53*10465441SEvalZero #define SNMP_V3_SHA_LEN        20
54*10465441SEvalZero 
55*10465441SEvalZero typedef enum {
56*10465441SEvalZero   SNMP_V3_PRIV_MODE_DECRYPT = 0,
57*10465441SEvalZero   SNMP_V3_PRIV_MODE_ENCRYPT = 1
58*10465441SEvalZero } snmpv3_priv_mode_t;
59*10465441SEvalZero 
60*10465441SEvalZero s32_t snmpv3_get_engine_boots_internal(void);
61*10465441SEvalZero err_t snmpv3_auth(struct snmp_pbuf_stream *stream, u16_t length, const u8_t *key, snmpv3_auth_algo_t algo, u8_t *hmac_out);
62*10465441SEvalZero err_t snmpv3_crypt(struct snmp_pbuf_stream *stream, u16_t length, const u8_t *key,
63*10465441SEvalZero                    const u8_t *priv_param, const u32_t engine_boots, const u32_t engine_time, snmpv3_priv_algo_t algo, snmpv3_priv_mode_t mode);
64*10465441SEvalZero err_t snmpv3_build_priv_param(u8_t *priv_param);
65*10465441SEvalZero void snmpv3_enginetime_timer(void *arg);
66*10465441SEvalZero 
67*10465441SEvalZero #endif
68*10465441SEvalZero 
69*10465441SEvalZero #endif /* LWIP_HDR_APPS_SNMP_V3_PRIV_H */
70