strongswan/src/libstrongswan/plugins/ntru/ntru_param_set.h

177 lines
3.7 KiB
C

/*
* Copyright (C) 2014 Andreas Steffen
* HSR Hochschule fuer Technik Rapperswil
*
* Copyright (C) 2009-2013 Security Innovation
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*/
/**
* @defgroup ntru_param_set ntru_param_set
* @{ @ingroup ntru_p
*/
#ifndef NTRU_PARAM_SET_H_
#define NTRU_PARAM_SET_H_
typedef enum ntru_param_set_id_t ntru_param_set_id_t;
typedef struct ntru_param_set_t ntru_param_set_t;
#include <library.h>
/**
* Encoding types for NTRU encryption public/private key blobs
*/
#define NTRU_PUBKEY_TAG 0x01
#define NTRU_PRIVKEY_DEFAULT_TAG 0x02
#define NTRU_PRIVKEY_TRITS_TAG 0xfe
#define NTRU_PRIVKEY_INDICES_TAG 0xff
/**
* Size in octets of the OID designating the NTRU encryption parameter set
*/
#define NTRU_OID_LEN 3
/**
* Packing types for NTRU encryption public/private keys
*/
#define NTRU_KEY_PACKED_COEFFICIENTS 0x01
#define NTRU_KEY_PACKED_INDICES 0x02
#define NTRU_KEY_PACKED_TRITS 0x03
/**
* NTRU encryption parameter set ID list
*/
enum ntru_param_set_id_t {
/* X9.98/IEEE 1363.1 parameter sets for best bandwidth (smallest size) */
NTRU_EES401EP1,
NTRU_EES449EP1,
NTRU_EES677EP1,
NTRU_EES1087EP2,
/* X9.98/IEEE 1363.1 parameter sets balancing speed and bandwidth */
NTRU_EES541EP1,
NTRU_EES613EP1,
NTRU_EES887EP1,
NTRU_EES1171EP1,
/* X9.98/IEEE 1363.1 parameter sets for best speed */
NTRU_EES659EP1,
NTRU_EES761EP1,
NTRU_EES1087EP1,
NTRU_EES1499EP1,
/* Best bandwidth and speed, no X9.98 compatibility */
NTRU_EES401EP2,
NTRU_EES439EP1,
NTRU_EES593EP1,
NTRU_EES743EP1,
};
extern enum_name_t *ntru_param_set_id_names;
/**
* NTRU encryption parameter set definitions
*/
struct ntru_param_set_t {
/**
* NTRU parameter set ID
*/
const ntru_param_set_id_t id;
/**
* pointer to OID
*/
const uint8_t oid[NTRU_OID_LEN];
/**
* parameter-set DER id
*/
const uint8_t der_id;
/**
* no. of bits in N (i.e. in an index
*/
const uint8_t N_bits;
/**
* ring dimension
*/
const uint16_t N;
/**
* no. of octets of security strength
*/
const uint16_t sec_strength_len;
/**
* big modulus
*/
const uint16_t q;
/**
* no. of bits in q (i.e. in a coefficient)
*/
const uint8_t q_bits;
/**
* if product form used
*/
const bool is_product_form;
/**
* no. of +1 or -1 coefficients in ring elements F, r
*/
const uint32_t dF_r;
/**
* no. - 1 of +1 coefficients or no. of -1 coefficients in ring element g
*/
const uint16_t dg;
/**
* max no. of plaintext octets
*/
const uint16_t m_len_max;
/**
* min. message representative weight
*/
const uint16_t min_msg_rep_wt;
/**
* no. bits in candidate for deriving an index
*/
const uint8_t c_bits;
/**
* no. of octets to hold mLenOctets
*/
const uint8_t m_len_len;
};
/**
* Get NTRU encryption parameter set by NTRU parameter set ID
*
* @param id NTRU parameter set ID
* @return NTRU parameter set
*/
const ntru_param_set_t* ntru_param_set_get_by_id(ntru_param_set_id_t id);
/**
* Get NTRU encryption parameter set by NTRU parameter set OID
*
* @param oid NTRU parameter set OID
* @return NTRU parameter set
*/
const ntru_param_set_t* ntru_param_set_get_by_oid(uint8_t const *oid);
#endif /** NTRU_PARAM_SET_H_ @}*/