a3850bb7fc9525f5ede2d59b186c2b8956568060
[strongswan.git] / src / libcharon / sa / authenticators / authenticator.h
1 /*
2 * Copyright (C) 2005-2009 Martin Willi
3 * Copyright (C) 2008 Tobias Brunner
4 * Copyright (C) 2005 Jan Hutter
5 * Hochschule fuer Technik Rapperswil
6 *
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2 of the License, or (at your
10 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
14 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 * for more details.
16 */
17
18 /**
19 * @defgroup authenticator authenticator
20 * @{ @ingroup authenticators
21 */
22
23 #ifndef AUTHENTICATOR_H_
24 #define AUTHENTICATOR_H_
25
26 typedef enum auth_method_t auth_method_t;
27 typedef struct authenticator_t authenticator_t;
28
29 #include <library.h>
30 #include <credentials/auth_cfg.h>
31 #include <sa/ike_sa.h>
32
33 /**
34 * Method to use for authentication, as defined in IKEv2.
35 */
36 enum auth_method_t {
37
38 /**
39 * No authentication used.
40 */
41 AUTH_NONE = 0,
42
43 /**
44 * Computed as specified in section 2.15 of RFC using
45 * an RSA private key over a PKCS#1 padded hash.
46 */
47 AUTH_RSA = 1,
48
49 /**
50 * Computed as specified in section 2.15 of RFC using the
51 * shared key associated with the identity in the ID payload
52 * and the negotiated prf function
53 */
54 AUTH_PSK = 2,
55
56 /**
57 * Computed as specified in section 2.15 of RFC using a
58 * DSS private key over a SHA-1 hash.
59 */
60 AUTH_DSS = 3,
61
62 /**
63 * ECDSA with SHA-256 on the P-256 curve as specified in RFC 4754
64 */
65 AUTH_ECDSA_256 = 9,
66
67 /**
68 * ECDSA with SHA-384 on the P-384 curve as specified in RFC 4754
69 */
70 AUTH_ECDSA_384 = 10,
71
72 /**
73 * ECDSA with SHA-512 on the P-521 curve as specified in RFC 4754
74 */
75 AUTH_ECDSA_521 = 11,
76 };
77
78 /**
79 * enum names for auth_method_t.
80 */
81 extern enum_name_t *auth_method_names;
82
83 /**
84 * Authenticator interface implemented by the various authenticators.
85 *
86 * An authenticator implementation handles AUTH and EAP payloads. Received
87 * messages are passed to the process() method, to send authentication data
88 * the message is passed to the build() method.
89 */
90 struct authenticator_t {
91
92 /**
93 * Process an incoming message using the authenticator.
94 *
95 * @param message message containing authentication payloads
96 * @return
97 * - SUCCESS if authentication successful
98 * - FAILED if authentication failed
99 * - NEED_MORE if another exchange required
100 */
101 status_t (*process)(authenticator_t *this, message_t *message);
102
103 /**
104 * Attach authentication data to an outgoing message.
105 *
106 * @param message message to add authentication data to
107 * @return
108 * - SUCCESS if authentication successful
109 * - FAILED if authentication failed
110 * - NEED_MORE if another exchange required
111 */
112 status_t (*build)(authenticator_t *this, message_t *message);
113
114 /**
115 * Check if the authenticator is capable of mutual authentication.
116 *
117 * Some authenticator authenticate both peers, e.g. EAP. To support
118 * mutual authentication with only a single authenticator (EAP-only
119 * authentication), it must be mutual. This method is invoked in ike_auth
120 * to check if the given authenticator is capable of doing so.
121 */
122 bool (*is_mutual)(authenticator_t *this);
123
124 /**
125 * Destroy authenticator instance.
126 */
127 void (*destroy) (authenticator_t *this);
128 };
129
130 /**
131 * Create an authenticator to build signatures.
132 *
133 * @param ike_sa associated ike_sa
134 * @param cfg authentication configuration
135 * @param received_nonce nonce received in IKE_SA_INIT
136 * @param sent_nonce nonce sent in IKE_SA_INIT
137 * @param received_init received IKE_SA_INIT message data
138 * @param sent_init sent IKE_SA_INIT message data
139 * @param reserved reserved bytes of the ID payload
140 * @return authenticator, NULL if not supported
141 */
142 authenticator_t *authenticator_create_builder(
143 ike_sa_t *ike_sa, auth_cfg_t *cfg,
144 chunk_t received_nonce, chunk_t sent_nonce,
145 chunk_t received_init, chunk_t sent_init,
146 char reserved[3]);
147
148 /**
149 * Create an authenticator to verify signatures.
150 *
151 * @param ike_sa associated ike_sa
152 * @param message message containing authentication data
153 * @param received_nonce nonce received in IKE_SA_INIT
154 * @param sent_nonce nonce sent in IKE_SA_INIT
155 * @param received_init received IKE_SA_INIT message data
156 * @param sent_init sent IKE_SA_INIT message data
157 * @param reserved reserved bytes of the ID payload
158 * @return authenticator, NULL if not supported
159 */
160 authenticator_t *authenticator_create_verifier(
161 ike_sa_t *ike_sa, message_t *message,
162 chunk_t received_nonce, chunk_t sent_nonce,
163 chunk_t received_init, chunk_t sent_init,
164 char reserved[3]);
165
166 #endif /** AUTHENTICATOR_H_ @}*/