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