third_party/lwip/repo/lwip/src/apps/snmp/snmpv3_priv.h

   1 /**
   2  * @file
   3  * Additional SNMPv3 functionality RFC3414 and RFC3826 (internal API, do not use in client code).
   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_PRIV_H
  36 #define LWIP_HDR_APPS_SNMP_V3_PRIV_H
  37
  38 #include "lwip/apps/snmp_opts.h"
  39
  40 #if LWIP_SNMP && LWIP_SNMP_V3
  41
  42 #include "snmp_pbuf_stream.h"
  43
  44 /* According to RFC 3411 */
  45 #define SNMP_V3_MAX_ENGINE_ID_LENGTH  32
  46 #define SNMP_V3_MAX_USER_LENGTH       32
  47
  48 #define SNMP_V3_MAX_AUTH_PARAM_LENGTH  12
  49 #define SNMP_V3_MAX_PRIV_PARAM_LENGTH  8
  50
  51 #define SNMP_V3_AUTH_FLAG      0x01
  52 #define SNMP_V3_PRIV_FLAG      0x02
  53
  54 #define SNMP_V3_MD5_LEN        16
  55 #define SNMP_V3_SHA_LEN        20
  56
  57 u32_t snmpv3_get_engine_boots_internal(void);
  58 u32_t snmpv3_get_engine_time_internal(void);
  59 err_t snmpv3_auth(struct snmp_pbuf_stream* stream, u16_t length, const u8_t* key, u8_t algo, u8_t* hmac_out);
  60 err_t snmpv3_crypt(struct snmp_pbuf_stream* stream, u16_t length, const u8_t* key,
  61     const u8_t* priv_param, const u32_t engine_boots, const u32_t engine_time, u8_t algo, u8_t mode);
  62 err_t snmpv3_build_priv_param(u8_t* priv_param);
  63
  64 #endif
  65
  66 #endif /* LWIP_HDR_APPS_SNMP_V3_PRIV_H */