strongswan/src/libstrongswan/crypto/diffie_hellman.h

158 lines
3.8 KiB
C

/*
* Copyright (C) 2010 Tobias Brunner
* Copyright (C) 2005-2007 Martin Willi
* Copyright (C) 2005 Jan Hutter
* Hochschule fuer Technik Rapperswil
*
* 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 diffie_hellman diffie_hellman
* @{ @ingroup crypto
*/
#ifndef DIFFIE_HELLMAN_H_
#define DIFFIE_HELLMAN_H_
typedef enum diffie_hellman_group_t diffie_hellman_group_t;
typedef struct diffie_hellman_t diffie_hellman_t;
typedef struct diffie_hellman_params_t diffie_hellman_params_t;
#include <library.h>
/**
* Diffie-Hellman group.
*
* The modulus (or group) to use for a Diffie-Hellman calculation.
* See IKEv2 RFC 3.3.2 and RFC 3526.
*
* ECP groups are defined in RFC 4753 and RFC 5114.
*/
enum diffie_hellman_group_t {
MODP_NONE = 0,
MODP_768_BIT = 1,
MODP_1024_BIT = 2,
MODP_1536_BIT = 5,
MODP_2048_BIT = 14,
MODP_3072_BIT = 15,
MODP_4096_BIT = 16,
MODP_6144_BIT = 17,
MODP_8192_BIT = 18,
ECP_256_BIT = 19,
ECP_384_BIT = 20,
ECP_521_BIT = 21,
MODP_1024_160 = 22,
MODP_2048_224 = 23,
MODP_2048_256 = 24,
ECP_192_BIT = 25,
ECP_224_BIT = 26,
/** insecure NULL diffie hellman group for testing, in PRIVATE USE */
MODP_NULL = 1024,
/** MODP group with custom generator/prime */
MODP_CUSTOM = 1025,
};
/**
* enum name for diffie_hellman_group_t.
*/
extern enum_name_t *diffie_hellman_group_names;
/**
* Implementation of the Diffie-Hellman algorithm, as in RFC2631.
*/
struct diffie_hellman_t {
/**
* Returns the shared secret of this diffie hellman exchange.
*
* Space for returned secret is allocated and must be freed by the caller.
*
* @param secret shared secret will be written into this chunk
* @return SUCCESS, FAILED if not both DH values are set
*/
status_t (*get_shared_secret) (diffie_hellman_t *this, chunk_t *secret);
/**
* Sets the public value of partner.
*
* Chunk gets cloned and can be destroyed afterwards.
*
* @param value public value of partner
*/
void (*set_other_public_value) (diffie_hellman_t *this, chunk_t value);
/**
* Gets the own public value to transmit.
*
* Space for returned chunk is allocated and must be freed by the caller.
*
* @param value public value of caller is stored at this location
*/
void (*get_my_public_value) (diffie_hellman_t *this, chunk_t *value);
/**
* Get the DH group used.
*
* @return DH group set in construction
*/
diffie_hellman_group_t (*get_dh_group) (diffie_hellman_t *this);
/**
* Destroys a diffie_hellman_t object.
*/
void (*destroy) (diffie_hellman_t *this);
};
/**
* Parameters for a specific diffie hellman group.
*/
struct diffie_hellman_params_t {
/**
* The prime of the group
*/
const chunk_t prime;
/**
* Generator of the group
*/
const chunk_t generator;
/**
* Exponent length to use
*/
size_t exp_len;
/**
* Prime order subgroup; for MODP Groups 22-24
*/
const chunk_t subgroup;
};
/**
* Get the parameters associated with the specified diffie hellman group.
*
* @param group DH group
* @return The parameters or NULL, if the group is not supported
*/
diffie_hellman_params_t *diffie_hellman_get_params(diffie_hellman_group_t group);
/**
* Check if a given DH group is an ECDH group
*
* @param group group to check
* @return TUE if group is an ECP group
*/
bool diffie_hellman_group_is_ec(diffie_hellman_group_t group);
#endif /** DIFFIE_HELLMAN_H_ @}*/