2554b3f2ebf3d0e5432b27d80fd3ee1c4149f045
[strongswan.git] / src / libstrongswan / credentials / auth_cfg.h
1 /*
2 * Copyright (C) 2007-2009 Martin Willi
3 * Copyright (C) 2008 Tobias Brunner
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 <utils/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 pre-shared secrets in combination with XAuth */
46 AUTH_CLASS_XAUTH_PSK = 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
69 /** identity to use for IKEv2 authentication exchange, identification_t* */
70 AUTH_RULE_IDENTITY,
71 /** authentication class, auth_class_t */
72 AUTH_RULE_AUTH_CLASS,
73 /** AAA-backend identity for EAP methods supporting it, identification_t* */
74 AUTH_RULE_AAA_IDENTITY,
75 /** EAP identity to use within EAP-Identity exchange, identification_t* */
76 AUTH_RULE_EAP_IDENTITY,
77 /** EAP type to propose for peer authentication, eap_type_t */
78 AUTH_RULE_EAP_TYPE,
79 /** EAP vendor for vendor specific type, u_int32_t */
80 AUTH_RULE_EAP_VENDOR,
81 /** certificate authority, certificate_t* */
82 AUTH_RULE_CA_CERT,
83 /** intermediate certificate in trustchain, certificate_t* */
84 AUTH_RULE_IM_CERT,
85 /** subject certificate, certificate_t* */
86 AUTH_RULE_SUBJECT_CERT,
87 /** result of a CRL validation, cert_validation_t */
88 AUTH_RULE_CRL_VALIDATION,
89 /** result of a OCSP validation, cert_validation_t */
90 AUTH_RULE_OCSP_VALIDATION,
91 /** subject is member of a group, identification_t*
92 * The group membership constraint is fulfilled if the subject is member of
93 * one group defined in the constraints. */
94 AUTH_RULE_GROUP,
95 /** required RSA public key strength, u_int in bits */
96 AUTH_RULE_RSA_STRENGTH,
97 /** required ECDSA public key strength, u_int in bits */
98 AUTH_RULE_ECDSA_STRENGTH,
99 /** certificatePolicy constraint, numerical OID as char* */
100 AUTH_RULE_CERT_POLICY,
101
102 /** intermediate certificate, certificate_t* */
103 AUTH_HELPER_IM_CERT,
104 /** subject certificate, certificate_t* */
105 AUTH_HELPER_SUBJECT_CERT,
106 /** Hash and URL of a intermediate certificate, char* */
107 AUTH_HELPER_IM_HASH_URL,
108 /** Hash and URL of a end-entity certificate, char* */
109 AUTH_HELPER_SUBJECT_HASH_URL,
110 /** revocation certificate (CRL, OCSP), certificate_t* */
111 AUTH_HELPER_REVOCATION_CERT,
112 };
113
114 /**
115 * enum name for auth_rule_t.
116 */
117 extern enum_name_t *auth_rule_names;
118
119 /**
120 * Authentication/Authorization round.
121 *
122 * RFC4739 defines multiple authentication rounds. This class defines such
123 * a round from a configuration perspective, either for the local or the remote
124 * peer. Local config are called "rulesets", as they define how we authenticate.
125 * Remote peer configs are called "constraits", they define what is needed to
126 * complete the authentication round successfully.
127 *
128 * @verbatim
129
130 [Repeat for each configuration]
131 +--------------------------------------------------+
132 | |
133 | |
134 | +----------+ IKE_AUTH +--------- + |
135 | | config | -----------> | | |
136 | | ruleset | | | |
137 | +----------+ [ <----------- ] | | |
138 | [ optional EAP ] | Peer | |
139 | +----------+ [ -----------> ] | | |
140 | | config | | | |
141 | | constr. | <----------- | | |
142 | +----------+ IKE_AUTH +--------- + |
143 | |
144 | |
145 +--------------------------------------------------+
146
147 @endverbatim
148 *
149 * Values for each items are either pointers (casted to void*) or short
150 * integers (use uintptr_t cast).
151 */
152 struct auth_cfg_t {
153
154 /**
155 * Add an rule to the set.
156 *
157 * @param rule rule type
158 * @param ... associated value to rule
159 */
160 void (*add)(auth_cfg_t *this, auth_rule_t rule, ...);
161
162 /**
163 * Get an rule value.
164 *
165 * @param rule rule type
166 * @return bool if item has been found
167 */
168 void* (*get)(auth_cfg_t *this, auth_rule_t rule);
169
170 /**
171 * Create an enumerator over added rules.
172 *
173 * @return enumerator over (auth_rule_t, union{void*,uintpr_t})
174 */
175 enumerator_t* (*create_enumerator)(auth_cfg_t *this);
176
177 /**
178 * Replace an rule at enumerator position.
179 *
180 * @param pos enumerator position position
181 * @param rule rule type
182 * @param ... associated value to rule
183 */
184 void (*replace)(auth_cfg_t *this, enumerator_t *pos,
185 auth_rule_t rule, ...);
186
187 /**
188 * Check if a used config fulfills a set of configured constraints.
189 *
190 * @param constraints required authorization rules
191 * @param log_error wheter to log compliance errors
192 * @return TRUE if this complies with constraints
193 */
194 bool (*complies)(auth_cfg_t *this, auth_cfg_t *constraints, bool log_error);
195
196 /**
197 * Merge items from other into this.
198 *
199 * @param other items to read for merge
200 * @param copy TRUE to copy items, FALSE to move them
201 */
202 void (*merge)(auth_cfg_t *this, auth_cfg_t *other, bool copy);
203
204 /**
205 * Purge all rules in a config.
206 *
207 * @param keep_ca wheter to keep AUTH_RULE_CA_CERT entries
208 */
209 void (*purge)(auth_cfg_t *this, bool keep_ca);
210
211 /**
212 * Check two configs for equality.
213 *
214 * @param other other config to compaire against this
215 * @return TRUE if auth infos identical
216 */
217 bool (*equals)(auth_cfg_t *this, auth_cfg_t *other);
218
219 /**
220 * Clone a authentication config, including all rules.
221 *
222 * @return cloned configuration
223 */
224 auth_cfg_t* (*clone)(auth_cfg_t *this);
225
226 /**
227 * Destroy a config with all associated rules/values.
228 */
229 void (*destroy)(auth_cfg_t *this);
230 };
231
232 /**
233 * Create a authentication config.
234 */
235 auth_cfg_t *auth_cfg_create();
236
237 #endif /** AUTH_CFG_H_ @}*/