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