updated API doc for socket.h
[strongswan.git] / src / charon / sa / keymat.h
1 /*
2 * Copyright (C) 2008 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 *
15 * $Id$
16 */
17
18 /**
19 * @defgroup keymat keymat
20 * @{ @ingroup sa
21 */
22
23 #ifndef KEYMAT_H_
24 #define KEYMAT_H_
25
26 #include <library.h>
27 #include <utils/identification.h>
28 #include <crypto/prfs/prf.h>
29 #include <crypto/crypters/crypter.h>
30 #include <crypto/signers/signer.h>
31 #include <config/proposal.h>
32 #include <sa/ike_sa_id.h>
33
34 typedef struct keymat_t keymat_t;
35
36 /**
37 * Derivation an management of sensitive keying material.
38 */
39 struct keymat_t {
40
41 /**
42 * Create a diffie hellman object for key agreement.
43 *
44 * The diffie hellman is either for IKE negotiation/rekeying or
45 * CHILD_SA rekeying (using PFS). The resulting DH object must be passed
46 * to derive_keys or to derive_child_keys and destroyed after use
47 *
48 * @param group diffie hellman group
49 * @return DH object, NULL if group not supported
50 */
51 diffie_hellman_t* (*create_dh)(keymat_t *this, diffie_hellman_group_t group);
52
53 /**
54 * Derive keys for the IKE_SA.
55 *
56 * These keys are not handed out, but are used by the associated signers,
57 * crypters and authentication functions.
58 *
59 * @param proposal selected algorithms
60 * @param dh diffie hellman key allocated by create_dh()
61 * @param nonce_i initiators nonce value
62 * @param nonce_r responders nonce value
63 * @param id IKE_SA identifier
64 * @param rekey keymat of old SA if we are rekeying
65 * @return TRUE on success
66 */
67 bool (*derive_ike_keys)(keymat_t *this, proposal_t *proposal,
68 diffie_hellman_t *dh, chunk_t nonce_i,
69 chunk_t nonce_r, ike_sa_id_t *id, keymat_t *rekey);
70 /**
71 * Derive keys for a CHILD_SA.
72 *
73 * The keys for the CHILD_SA are allocated in the integ and encr chunks.
74 * An implementation might hand out encrypted keys only, which are
75 * decrypted in the kernel before use.
76 * If no PFS is used for the CHILD_SA, dh can be NULL.
77 *
78 * @param proposal selected algorithms
79 * @param dh diffie hellman key allocated by create_dh(), or NULL
80 * @param nonce_i initiators nonce value
81 * @param nonce_r responders nonce value
82 * @param encr_i chunk to write initiators encryption key to
83 * @param integ_i chunk to write initiators integrity key to
84 * @param encr_r chunk to write responders encryption key to
85 * @param integ_r chunk to write responders integrity key to
86 * @return TRUE on success
87 */
88 bool (*derive_child_keys)(keymat_t *this,
89 proposal_t *proposal, diffie_hellman_t *dh,
90 chunk_t nonce_i, chunk_t nonce_r,
91 chunk_t *encr_i, chunk_t *integ_i,
92 chunk_t *encr_r, chunk_t *integ_r);
93 /**
94 * Get a signer to sign/verify IKE messages.
95 *
96 * @param in TRUE for inbound (verify), FALSE for outbound (sign)
97 * @return signer
98 */
99 signer_t* (*get_signer)(keymat_t *this, bool in);
100
101 /*
102 * Get a crypter to en-/decrypt IKE messages.
103 *
104 * @param in TRUE for inbound (decrypt), FALSE for outbound (encrypt)
105 * @return crypter
106 */
107 crypter_t* (*get_crypter)(keymat_t *this, bool in);
108
109 /**
110 * Generate octets to use for authentication procedure (RFC4306 2.15).
111 *
112 * This method creates the plain octets and is usually signed by a private
113 * key. PSK and EAP authentication include a secret into the data, use
114 * the get_psk_sig() method instead.
115 *
116 * @param verify TRUE to create for verfification, FALSE to sign
117 * @param ike_sa_init encoded ike_sa_init message
118 * @param nonce nonce value
119 * @param id identity
120 * @return authentication octets
121 */
122 chunk_t (*get_auth_octets)(keymat_t *this, bool verify, chunk_t ike_sa_init,
123 chunk_t nonce, identification_t *id);
124 /**
125 * Build the shared secret signature used for PSK and EAP authentication.
126 *
127 * This method wraps the get_auth_octets() method and additionally
128 * includes the secret into the signature. If no secret is given, SK_p is
129 * used as secret (used for EAP methods without MSK).
130 *
131 * @param verify TRUE to create for verfification, FALSE to sign
132 * @param ike_sa_init encoded ike_sa_init message
133 * @param nonce nonce value
134 * @param secret optional secret to include into signature
135 * @param id identity
136 * @return signature octets
137 */
138 chunk_t (*get_psk_sig)(keymat_t *this, bool verify, chunk_t ike_sa_init,
139 chunk_t nonce, chunk_t secret, identification_t *id);
140 /**
141 * Destroy a keymat_t.
142 */
143 void (*destroy)(keymat_t *this);
144 };
145
146 /**
147 * Create a keymat instance.
148 *
149 * @param initiator TRUE if we are the initiator
150 * @return keymat instance
151 */
152 keymat_t *keymat_create(bool initiator);
153
154 #endif /* KEYMAT_ @}*/