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