2 * RADIUS authentication server
3 * Copyright (c) 2005-2009, 2011, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
9 #ifndef RADIUS_SERVER_H
10 #define RADIUS_SERVER_H
12 struct radius_server_data;
16 * struct radius_server_conf - RADIUS server configuration
18 struct radius_server_conf {
20 * auth_port - UDP port to listen to as an authentication server
25 * acct_port - UDP port to listen to as an accounting server
30 * client_file - RADIUS client configuration file
32 * This file contains the RADIUS clients and the shared secret to be
33 * used with them in a format where each client is on its own line. The
34 * first item on the line is the IPv4 or IPv6 address of the client
35 * with an optional address mask to allow full network to be specified
36 * (e.g., 192.168.1.2 or 192.168.1.0/24). This is followed by white
37 * space (space or tabulator) and the shared secret. Lines starting
38 * with '#' are skipped and can be used as comments.
43 * sqlite_file - SQLite database for storing debug log information
45 const char *sqlite_file;
48 * conf_ctx - Context pointer for callbacks
50 * This is used as the ctx argument in get_eap_user() calls.
55 * eap_sim_db_priv - EAP-SIM/AKA database context
57 * This is passed to the EAP-SIM/AKA server implementation as a
60 void *eap_sim_db_priv;
63 * ssl_ctx - TLS context
65 * This is passed to the EAP server implementation as a callback
66 * context for TLS operations.
71 * pac_opaque_encr_key - PAC-Opaque encryption key for EAP-FAST
73 * This parameter is used to set a key for EAP-FAST to encrypt the
74 * PAC-Opaque data. It can be set to %NULL if EAP-FAST is not used. If
75 * set, must point to a 16-octet key.
77 u8 *pac_opaque_encr_key;
80 * eap_fast_a_id - EAP-FAST authority identity (A-ID)
82 * If EAP-FAST is not used, this can be set to %NULL. In theory, this
83 * is a variable length field, but due to some existing implementations
84 * requiring A-ID to be 16 octets in length, it is recommended to use
85 * that length for the field to provide interoperability with deployed
86 * peer implementations.
91 * eap_fast_a_id_len - Length of eap_fast_a_id buffer in octets
93 size_t eap_fast_a_id_len;
96 * eap_fast_a_id_info - EAP-FAST authority identifier information
98 * This A-ID-Info contains a user-friendly name for the A-ID. For
99 * example, this could be the enterprise and server names in
100 * human-readable format. This field is encoded as UTF-8. If EAP-FAST
101 * is not used, this can be set to %NULL.
103 char *eap_fast_a_id_info;
106 * eap_fast_prov - EAP-FAST provisioning modes
108 * 0 = provisioning disabled, 1 = only anonymous provisioning allowed,
109 * 2 = only authenticated provisioning allowed, 3 = both provisioning
115 * pac_key_lifetime - EAP-FAST PAC-Key lifetime in seconds
117 * This is the hard limit on how long a provisioned PAC-Key can be
120 int pac_key_lifetime;
123 * pac_key_refresh_time - EAP-FAST PAC-Key refresh time in seconds
125 * This is a soft limit on the PAC-Key. The server will automatically
126 * generate a new PAC-Key when this number of seconds (or fewer) of the
129 int pac_key_refresh_time;
132 * eap_sim_aka_result_ind - EAP-SIM/AKA protected success indication
134 * This controls whether the protected success/failure indication
135 * (AT_RESULT_IND) is used with EAP-SIM and EAP-AKA.
137 int eap_sim_aka_result_ind;
140 * tnc - Trusted Network Connect (TNC)
142 * This controls whether TNC is enabled and will be required before the
143 * peer is allowed to connect. Note: This is only used with EAP-TTLS
144 * and EAP-FAST. If any other EAP method is enabled, the peer will be
145 * allowed to connect without TNC.
150 * pwd_group - EAP-pwd D-H group
152 * This is used to select which D-H group to use with EAP-pwd.
157 * server_id - Server identity
159 const char *server_id;
162 * erp - Whether EAP Re-authentication Protocol (ERP) is enabled
164 * This controls whether the authentication server derives ERP key
165 * hierarchy (rRK and rIK) from full EAP authentication and allows
166 * these keys to be used to perform ERP to derive rMSK instead of full
167 * EAP authentication to derive MSK.
171 const char *erp_domain;
173 unsigned int tls_session_lifetime;
175 unsigned int tls_flags;
178 * wps - Wi-Fi Protected Setup context
180 * If WPS is used with an external RADIUS server (which is quite
181 * unlikely configuration), this is used to provide a pointer to WPS
182 * context data. Normally, this can be set to %NULL.
184 struct wps_context *wps;
187 * ipv6 - Whether to enable IPv6 support in the RADIUS server
192 * get_eap_user - Callback for fetching EAP user information
193 * @ctx: Context data from conf_ctx
194 * @identity: User identity
195 * @identity_len: identity buffer length in octets
196 * @phase2: Whether this is for Phase 2 identity
197 * @user: Data structure for filling in the user information
198 * Returns: 0 on success, -1 on failure
200 * This is used to fetch information from user database. The callback
201 * will fill in information about allowed EAP methods and the user
202 * password. The password field will be an allocated copy of the
203 * password data and RADIUS server will free it after use.
205 int (*get_eap_user)(void *ctx, const u8 *identity, size_t identity_len,
206 int phase2, struct eap_user *user);
209 * eap_req_id_text - Optional data for EAP-Request/Identity
211 * This can be used to configure an optional, displayable message that
212 * will be sent in EAP-Request/Identity. This string can contain an
213 * ASCII-0 character (nul) to separate network infromation per RFC
214 * 4284. The actual string length is explicit provided in
215 * eap_req_id_text_len since nul character will not be used as a string
218 const char *eap_req_id_text;
221 * eap_req_id_text_len - Length of eap_req_id_text buffer in octets
223 size_t eap_req_id_text_len;
226 * msg_ctx - Context data for wpa_msg() calls
230 #ifdef CONFIG_RADIUS_TEST
231 const char *dump_msk_file;
232 #endif /* CONFIG_RADIUS_TEST */
234 char *subscr_remediation_url;
235 u8 subscr_remediation_method;
236 char *hs20_sim_provisioning_url;
238 char *t_c_server_url;
242 struct radius_server_data *
243 radius_server_init(struct radius_server_conf *conf);
245 void radius_server_erp_flush(struct radius_server_data *data);
246 void radius_server_deinit(struct radius_server_data *data);
248 int radius_server_get_mib(struct radius_server_data *data, char *buf,
251 void radius_server_eap_pending_cb(struct radius_server_data *data, void *ctx);
252 int radius_server_dac_request(struct radius_server_data *data, const char *req);
254 #endif /* RADIUS_SERVER_H */