daemon: Flush shunts before unloading plugins
[strongswan.git] / src / libstrongswan / credentials / auth_cfg.h
1 /*
2 * Copyright (C) 2008-2015 Tobias Brunner
3 * Copyright (C) 2007-2009 Martin Willi
4 * Hochschule fuer Technik Rapperswil
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * for more details.
15 */
16
17 /**
18 * @defgroup auth_cfg auth_cfg
19 * @{ @ingroup credentials
20 */
21
22 #ifndef AUTH_CFG_H_
23 #define AUTH_CFG_H_
24
25 #include <collections/enumerator.h>
26
27 typedef struct auth_cfg_t auth_cfg_t;
28 typedef enum auth_rule_t auth_rule_t;
29 typedef enum auth_class_t auth_class_t;
30
31 /**
32 * Class of authentication to use. This is different to auth_method_t in that
33 * it does not specify a method, but a class of acceptable methods. The found
34 * certificate finally dictates which method is used.
35 */
36 enum auth_class_t {
37 /** any class acceptable */
38 AUTH_CLASS_ANY = 0,
39 /** authentication using public keys (RSA, ECDSA) */
40 AUTH_CLASS_PUBKEY = 1,
41 /** authentication using a pre-shared secrets */
42 AUTH_CLASS_PSK = 2,
43 /** authentication using EAP */
44 AUTH_CLASS_EAP = 3,
45 /** authentication using IKEv1 XAUTH */
46 AUTH_CLASS_XAUTH = 4,
47 };
48
49 /**
50 * enum strings for auth_class_t
51 */
52 extern enum_name_t *auth_class_names;
53
54 /**
55 * Authentication config to use during authentication process.
56 *
57 * Each authentication config contains a set of rules. These rule-sets are used
58 * in two ways:
59 * - For configs specifying local authentication behavior, the rules define
60 * which authentication method in which way.
61 * - For configs specifying remote peer authentication, the rules define
62 * constraints the peer has to fulfill.
63 *
64 * Additionally to the rules, there is a set of helper items. These are used
65 * to transport credentials during the authentication process.
66 */
67 enum auth_rule_t {
68 /** identity to use for IKEv2 authentication exchange, identification_t* */
69 AUTH_RULE_IDENTITY,
70 /** if TRUE don't send IDr as initiator, but verify the identity after
71 * receiving IDr (but also verify it against subjectAltNames), bool */
72 AUTH_RULE_IDENTITY_LOOSE,
73 /** authentication class, auth_class_t */
74 AUTH_RULE_AUTH_CLASS,
75 /** AAA-backend identity for EAP methods supporting it, identification_t* */
76 AUTH_RULE_AAA_IDENTITY,
77 /** EAP identity to use within EAP-Identity exchange, identification_t* */
78 AUTH_RULE_EAP_IDENTITY,
79 /** EAP type to propose for peer authentication, eap_type_t */
80 AUTH_RULE_EAP_TYPE,
81 /** EAP vendor for vendor specific type, u_int32_t */
82 AUTH_RULE_EAP_VENDOR,
83 /** XAUTH backend name to use, char* */
84 AUTH_RULE_XAUTH_BACKEND,
85 /** XAuth identity to use or require, identification_t* */
86 AUTH_RULE_XAUTH_IDENTITY,
87 /** certificate authority, certificate_t* */
88 AUTH_RULE_CA_CERT,
89 /** intermediate certificate in trustchain, certificate_t* */
90 AUTH_RULE_IM_CERT,
91 /** subject certificate, certificate_t* */
92 AUTH_RULE_SUBJECT_CERT,
93 /** result of a CRL validation, cert_validation_t */
94 AUTH_RULE_CRL_VALIDATION,
95 /** result of a OCSP validation, cert_validation_t */
96 AUTH_RULE_OCSP_VALIDATION,
97 /** subject is member of a group, identification_t*
98 * The group membership constraint is fulfilled if the subject is member of
99 * one group defined in the constraints. */
100 AUTH_RULE_GROUP,
101 /** required RSA public key strength, u_int in bits */
102 AUTH_RULE_RSA_STRENGTH,
103 /** required ECDSA public key strength, u_int in bits */
104 AUTH_RULE_ECDSA_STRENGTH,
105 /** required BLISS public key strength, u_int in bits */
106 AUTH_RULE_BLISS_STRENGTH,
107 /** required signature scheme, signature_scheme_t */
108 AUTH_RULE_SIGNATURE_SCHEME,
109 /** certificatePolicy constraint, numerical OID as char* */
110 AUTH_RULE_CERT_POLICY,
111
112 /** intermediate certificate, certificate_t* */
113 AUTH_HELPER_IM_CERT,
114 /** subject certificate, certificate_t* */
115 AUTH_HELPER_SUBJECT_CERT,
116 /** Hash and URL of a intermediate certificate, char* */
117 AUTH_HELPER_IM_HASH_URL,
118 /** Hash and URL of a end-entity certificate, char* */
119 AUTH_HELPER_SUBJECT_HASH_URL,
120 /** revocation certificate (CRL, OCSP), certificate_t* */
121 AUTH_HELPER_REVOCATION_CERT,
122 /** attribute certificate for authorization decisions, certificate_t */
123 AUTH_HELPER_AC_CERT,
124
125 /** helper to determine the number of elements in this enum */
126 AUTH_RULE_MAX,
127 };
128
129 /**
130 * enum name for auth_rule_t.
131 */
132 extern enum_name_t *auth_rule_names;
133
134 /**
135 * Authentication/Authorization round.
136 *
137 * RFC4739 defines multiple authentication rounds. This class defines such
138 * a round from a configuration perspective, either for the local or the remote
139 * peer. Local configs are called "rulesets". They define how we authenticate.
140 * Remote peer configs are called "constraits". They define what is needed to
141 * complete the authentication round successfully.
142 *
143 * @verbatim
144
145 [Repeat for each configuration]
146 +--------------------------------------------------+
147 | |
148 | |
149 | +----------+ IKE_AUTH +--------- + |
150 | | config | -----------> | | |
151 | | ruleset | | | |
152 | +----------+ [ <----------- ] | | |
153 | [ optional EAP ] | Peer | |
154 | +----------+ [ -----------> ] | | |
155 | | config | | | |
156 | | constr. | <----------- | | |
157 | +----------+ IKE_AUTH +--------- + |
158 | |
159 | |
160 +--------------------------------------------------+
161
162 @endverbatim
163 *
164 * Values for each item are either pointers (casted to void*) or short
165 * integers (use uintptr_t cast).
166 */
167 struct auth_cfg_t {
168
169 /**
170 * Add a rule to the set.
171 *
172 * Rules we expect only once (e.g. identities) implicitly replace previous
173 * rules of the same type (but pointers to previous values will remain
174 * valid until the auth_cfg_t object is destroyed).
175 * Rules that may occur multiple times (e.g. CA certificates) are inserted
176 * so that they can be enumerated in the order in which they were added.
177 * For these get() will return the value added first.
178 *
179 * @param rule rule type
180 * @param ... associated value to rule
181 */
182 void (*add)(auth_cfg_t *this, auth_rule_t rule, ...);
183
184 /**
185 * Get a rule value.
186 *
187 * For rules we expect only once the latest value is returned.
188 *
189 * @param rule rule type
190 * @return rule or NULL (or an appropriate default) if not found
191 */
192 void* (*get)(auth_cfg_t *this, auth_rule_t rule);
193
194 /**
195 * Create an enumerator over added rules.
196 *
197 * Refer to add() regarding the order in which rules are enumerated.
198 * For rules we expect only once the latest value is enumerated only.
199 *
200 * @return enumerator over (auth_rule_t, union{void*,uintpr_t})
201 */
202 enumerator_t* (*create_enumerator)(auth_cfg_t *this);
203
204 /**
205 * Replace a rule at enumerator position.
206 *
207 * @param pos enumerator position
208 * @param rule rule type
209 * @param ... associated value to rule
210 */
211 void (*replace)(auth_cfg_t *this, enumerator_t *pos,
212 auth_rule_t rule, ...);
213
214 /**
215 * Check if a used config fulfills a set of configured constraints.
216 *
217 * @param constraints required authorization rules
218 * @param log_error whether to log compliance errors
219 * @return TRUE if this complies with constraints
220 */
221 bool (*complies)(auth_cfg_t *this, auth_cfg_t *constraints, bool log_error);
222
223 /**
224 * Merge items from other into this.
225 *
226 * @param other items to read for merge
227 * @param copy TRUE to copy items, FALSE to move them
228 */
229 void (*merge)(auth_cfg_t *this, auth_cfg_t *other, bool copy);
230
231 /**
232 * Purge all rules in a config.
233 *
234 * @param keep_ca whether to keep AUTH_RULE_CA_CERT entries
235 */
236 void (*purge)(auth_cfg_t *this, bool keep_ca);
237
238 /**
239 * Check two configs for equality.
240 *
241 * For rules we expect only once the latest value is compared only.
242 *
243 * @param other other config to compare against this
244 * @return TRUE if auth infos identical
245 */
246 bool (*equals)(auth_cfg_t *this, auth_cfg_t *other);
247
248 /**
249 * Clone an authentication config, including all rules.
250 *
251 * @return cloned configuration
252 */
253 auth_cfg_t* (*clone)(auth_cfg_t *this);
254
255 /**
256 * Destroy a config with all associated rules/values.
257 */
258 void (*destroy)(auth_cfg_t *this);
259 };
260
261 /**
262 * Create a authentication config.
263 */
264 auth_cfg_t *auth_cfg_create();
265
266 #endif /** AUTH_CFG_H_ @}*/