(no commit message)
[strongswan.git] / Source / charon / transforms / diffie_hellman.h
1 /**
2 * @file diffie_hellman.h
3 *
4 * @brief Interface of diffie_hellman_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2005 Jan Hutter, Martin Willi
10 * Hochschule fuer Technik Rapperswil
11 *
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * for more details.
21 */
22
23 #ifndef DIFFIE_HELLMAN_H_
24 #define DIFFIE_HELLMAN_H_
25
26 #include <types.h>
27
28
29 typedef enum diffie_hellman_group_t diffie_hellman_group_t;
30
31 /**
32 * @brief Diffie-Hellman group.
33 *
34 * The modulus (or group) to use for a Diffie-Hellman calculation.
35 *
36 * @see IKEv2 draft 3.3.2 and RFC 3526.
37 *
38 * @ingroup transforms
39 */
40 enum diffie_hellman_group_t {
41 MODP_UNDEFINED = 1024,
42 MODP_768_BIT = 1,
43 MODP_1024_BIT = 2,
44 MODP_1536_BIT = 5,
45 MODP_2048_BIT = 14,
46 MODP_3072_BIT = 15,
47 MODP_4096_BIT = 16,
48 MODP_6144_BIT = 17,
49 MODP_8192_BIT = 18
50 };
51
52 /**
53 * string mappings for diffie_hellman_group_t
54 */
55 extern mapping_t diffie_hellman_group_m[];
56
57
58 typedef struct diffie_hellman_t diffie_hellman_t;
59
60 /**
61 * @brief Implementation of the widely used Diffie-Hellman algorithm.
62 *
63 * @ingroup transforms
64 */
65 struct diffie_hellman_t {
66
67 /**
68 * @brief Returns the shared secret of this diffie hellman exchange.
69 *
70 * @warning Space for returned secret is allocated and must be
71 * freed by the caller.
72 *
73 * @param this calling diffie_hellman_t object
74 * @param[out] secret shared secret will be written into this chunk
75 * @return
76 * - SUCCESS, or
77 * - FAILED if not both DH values are set
78 */
79 status_t (*get_shared_secret) (diffie_hellman_t *this, chunk_t *secret);
80
81 /**
82 * @brief Sets the public value of partner.
83 *
84 * @warning chunk gets copied
85 *
86 * @param this calling diffie_hellman_t object
87 * @param public_value public value of partner
88 */
89 void (*set_other_public_value) (diffie_hellman_t *this, chunk_t public_value);
90
91 /**
92 * @brief Gets the public value of partner.
93 *
94 * @warning chunk gets copied
95 *
96 * @param this calling diffie_hellman_t object
97 * @param[out] public_value public value of partner is stored at this location
98 * @return
99 * - SUCCESS, or
100 * - FAILED if other public value not set
101 */
102 status_t (*get_other_public_value) (diffie_hellman_t *this, chunk_t *public_value);
103
104 /**
105 * @brief Gets the public value of caller
106 *
107 * @warning chunk gets copied
108 *
109 * @param this calling diffie_hellman_t object
110 * @param[out] public_value public value of caller is stored at this location
111 */
112 void (*get_my_public_value) (diffie_hellman_t *this, chunk_t *public_value);
113
114 /**
115 * @brief Destroys an diffie_hellman_t object.
116 *
117 * @param this diffie_hellman_t object to destroy
118 */
119 void (*destroy) (diffie_hellman_t *this);
120 };
121
122 /**
123 * @brief Creates a new diffie_hellman_t object.
124 *
125 * The first diffie hellman public value gets automatically created.
126 *
127 * @param dh_group_number Diffie Hellman group number to use
128 * @return
129 * - diffie_hellman_t object
130 * - NULL if dh group not supported
131 *
132 * @ingroup transforms
133 */
134 diffie_hellman_t *diffie_hellman_create(diffie_hellman_group_t dh_group_number);
135
136 #endif /*DIFFIE_HELLMAN_H_*/