2
* EAP peer configuration data
3
* Copyright (c) 2003-2008, Jouni Malinen <j@w1.fi>
5
* This program is free software; you can redistribute it and/or modify
6
* it under the terms of the GNU General Public License version 2 as
7
* published by the Free Software Foundation.
9
* Alternatively, this software may be distributed under the terms of BSD
12
* See README and COPYING for more details.
19
* struct eap_peer_config - EAP peer configuration/credentials
21
struct eap_peer_config {
23
* identity - EAP Identity
25
* This field is used to set the real user identity or NAI (for
26
* EAP-PSK/PAX/SAKE/GPSK).
31
* identity_len - EAP Identity length
36
* anonymous_identity - Anonymous EAP Identity
38
* This field is used for unencrypted use with EAP types that support
39
* different tunnelled identity, e.g., EAP-TTLS, in order to reveal the
40
* real identity (identity field) only to the authentication server.
42
* If not set, the identity field will be used for both unencrypted and
45
u8 *anonymous_identity;
48
* anonymous_identity_len - Length of anonymous_identity
50
size_t anonymous_identity_len;
53
* password - Password string for EAP
55
* This field can include either the plaintext password (default
56
* option) or a NtPasswordHash (16-byte MD4 hash of the unicode
57
* presentation of the password) if flags field has
58
* EAP_CONFIG_FLAGS_PASSWORD_NTHASH bit set to 1. NtPasswordHash can
59
* only be used with authentication mechanism that use this hash as the
60
* starting point for operation: MSCHAP and MSCHAPv2 (EAP-MSCHAPv2,
61
* EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
63
* In addition, this field is used to configure a pre-shared key for
64
* EAP-PSK/PAX/SAKE/GPSK. The length of the PSK must be 16 for EAP-PSK
65
* and EAP-PAX and 32 for EAP-SAKE. EAP-GPSK can use a variable length
71
* password_len - Length of password field
76
* ca_cert - File path to CA certificate file (PEM/DER)
78
* This file can have one or more trusted CA certificates. If ca_cert
79
* and ca_path are not included, server certificate will not be
80
* verified. This is insecure and a trusted CA certificate should
81
* always be configured when using EAP-TLS/TTLS/PEAP. Full path to the
82
* file should be used since working directory may change when
83
* wpa_supplicant is run in the background.
85
* Alternatively, a named configuration blob can be used by setting
86
* this to blob://<blob name>.
88
* On Windows, trusted CA certificates can be loaded from the system
89
* certificate store by setting this to cert_store://<name>, e.g.,
90
* ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
91
* Note that when running wpa_supplicant as an application, the user
92
* certificate store (My user account) is used, whereas computer store
93
* (Computer account) is used when running wpasvc as a service.
98
* ca_path - Directory path for CA certificate files (PEM)
100
* This path may contain multiple CA certificates in OpenSSL format.
101
* Common use for this is to point to system trusted CA list which is
102
* often installed into directory like /etc/ssl/certs. If configured,
103
* these certificates are added to the list of trusted CAs. ca_cert
104
* may also be included in that case, but it is not required.
109
* client_cert - File path to client certificate file (PEM/DER)
111
* This field is used with EAP method that use TLS authentication.
112
* Usually, this is only configured for EAP-TLS, even though this could
113
* in theory be used with EAP-TTLS and EAP-PEAP, too. Full path to the
114
* file should be used since working directory may change when
115
* wpa_supplicant is run in the background.
117
* Alternatively, a named configuration blob can be used by setting
118
* this to blob://<blob name>.
123
* private_key - File path to client private key file (PEM/DER/PFX)
125
* When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
126
* commented out. Both the private key and certificate will be read
127
* from the PKCS#12 file in this case. Full path to the file should be
128
* used since working directory may change when wpa_supplicant is run
131
* Windows certificate store can be used by leaving client_cert out and
132
* configuring private_key in one of the following formats:
134
* cert://substring_to_match
136
* hash://certificate_thumbprint_in_hex
138
* For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
140
* Note that when running wpa_supplicant as an application, the user
141
* certificate store (My user account) is used, whereas computer store
142
* (Computer account) is used when running wpasvc as a service.
144
* Alternatively, a named configuration blob can be used by setting
145
* this to blob://<blob name>.
150
* private_key_passwd - Password for private key file
152
* If left out, this will be asked through control interface.
154
u8 *private_key_passwd;
157
* dh_file - File path to DH/DSA parameters file (in PEM format)
159
* This is an optional configuration file for setting parameters for an
160
* ephemeral DH key exchange. In most cases, the default RSA
161
* authentication does not use this configuration. However, it is
162
* possible setup RSA to use ephemeral DH key exchange. In addition,
163
* ciphers with DSA keys always use ephemeral DH keys. This can be used
164
* to achieve forward secrecy. If the file is in DSA parameters format,
165
* it will be automatically converted into DH params. Full path to the
166
* file should be used since working directory may change when
167
* wpa_supplicant is run in the background.
169
* Alternatively, a named configuration blob can be used by setting
170
* this to blob://<blob name>.
175
* subject_match - Constraint for server certificate subject
177
* This substring is matched against the subject of the authentication
178
* server certificate. If this string is set, the server sertificate is
179
* only accepted if it contains this string in the subject. The subject
180
* string is in following format:
182
* /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@n.example.com
187
* altsubject_match - Constraint for server certificate alt. subject
189
* Semicolon separated string of entries to be matched against the
190
* alternative subject name of the authentication server certificate.
191
* If this string is set, the server sertificate is only accepted if it
192
* contains one of the entries in an alternative subject name
195
* altSubjectName string is in following format: TYPE:VALUE
197
* Example: EMAIL:server@example.com
198
* Example: DNS:server.example.com;DNS:server2.example.com
200
* Following types are supported: EMAIL, DNS, URI
202
u8 *altsubject_match;
205
* ca_cert2 - File path to CA certificate file (PEM/DER) (Phase 2)
207
* This file can have one or more trusted CA certificates. If ca_cert2
208
* and ca_path2 are not included, server certificate will not be
209
* verified. This is insecure and a trusted CA certificate should
210
* always be configured. Full path to the file should be used since
211
* working directory may change when wpa_supplicant is run in the
214
* This field is like ca_cert, but used for phase 2 (inside
215
* EAP-TTLS/PEAP/FAST tunnel) authentication.
217
* Alternatively, a named configuration blob can be used by setting
218
* this to blob://<blob name>.
223
* ca_path2 - Directory path for CA certificate files (PEM) (Phase 2)
225
* This path may contain multiple CA certificates in OpenSSL format.
226
* Common use for this is to point to system trusted CA list which is
227
* often installed into directory like /etc/ssl/certs. If configured,
228
* these certificates are added to the list of trusted CAs. ca_cert
229
* may also be included in that case, but it is not required.
231
* This field is like ca_path, but used for phase 2 (inside
232
* EAP-TTLS/PEAP/FAST tunnel) authentication.
237
* client_cert2 - File path to client certificate file
239
* This field is like client_cert, but used for phase 2 (inside
240
* EAP-TTLS/PEAP/FAST tunnel) authentication. Full path to the
241
* file should be used since working directory may change when
242
* wpa_supplicant is run in the background.
244
* Alternatively, a named configuration blob can be used by setting
245
* this to blob://<blob name>.
250
* private_key2 - File path to client private key file
252
* This field is like private_key, but used for phase 2 (inside
253
* EAP-TTLS/PEAP/FAST tunnel) authentication. Full path to the
254
* file should be used since working directory may change when
255
* wpa_supplicant is run in the background.
257
* Alternatively, a named configuration blob can be used by setting
258
* this to blob://<blob name>.
263
* private_key2_passwd - Password for private key file
265
* This field is like private_key_passwd, but used for phase 2 (inside
266
* EAP-TTLS/PEAP/FAST tunnel) authentication.
268
u8 *private_key2_passwd;
271
* dh_file2 - File path to DH/DSA parameters file (in PEM format)
273
* This field is like dh_file, but used for phase 2 (inside
274
* EAP-TTLS/PEAP/FAST tunnel) authentication. Full path to the
275
* file should be used since working directory may change when
276
* wpa_supplicant is run in the background.
278
* Alternatively, a named configuration blob can be used by setting
279
* this to blob://<blob name>.
284
* subject_match2 - Constraint for server certificate subject
286
* This field is like subject_match, but used for phase 2 (inside
287
* EAP-TTLS/PEAP/FAST tunnel) authentication.
292
* altsubject_match2 - Constraint for server certificate alt. subject
294
* This field is like altsubject_match, but used for phase 2 (inside
295
* EAP-TTLS/PEAP/FAST tunnel) authentication.
297
u8 *altsubject_match2;
300
* eap_methods - Allowed EAP methods
302
* (vendor=EAP_VENDOR_IETF,method=EAP_TYPE_NONE) terminated list of
303
* allowed EAP methods or %NULL if all methods are accepted.
305
struct eap_method_type *eap_methods;
308
* phase1 - Phase 1 (outer authentication) parameters
310
* String with field-value pairs, e.g., "peapver=0" or
311
* "peapver=1 peaplabel=1".
313
* 'peapver' can be used to force which PEAP version (0 or 1) is used.
315
* 'peaplabel=1' can be used to force new label, "client PEAP
316
* encryption", to be used during key derivation when PEAPv1 or newer.
318
* Most existing PEAPv1 implementation seem to be using the old label,
319
* "client EAP encryption", and wpa_supplicant is now using that as the
322
* Some servers, e.g., Radiator, may require peaplabel=1 configuration
323
* to interoperate with PEAPv1; see eap_testing.txt for more details.
325
* 'peap_outer_success=0' can be used to terminate PEAP authentication
326
* on tunneled EAP-Success. This is required with some RADIUS servers
327
* that implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
328
* Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode).
330
* include_tls_length=1 can be used to force wpa_supplicant to include
331
* TLS Message Length field in all TLS messages even if they are not
334
* sim_min_num_chal=3 can be used to configure EAP-SIM to require three
335
* challenges (by default, it accepts 2 or 3).
337
* result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
338
* protected result indication.
340
* fast_provisioning option can be used to enable in-line provisioning
341
* of EAP-FAST credentials (PAC):
343
* 1 = allow unauthenticated provisioning,
344
* 2 = allow authenticated provisioning,
345
* 3 = allow both unauthenticated and authenticated provisioning
347
* fast_max_pac_list_len=<num> option can be used to set the maximum
348
* number of PAC entries to store in a PAC list (default: 10).
350
* fast_pac_format=binary option can be used to select binary format
351
* for storing PAC entires in order to save some space (the default
352
* text format uses about 2.5 times the size of minimal binary format).
357
* phase2 - Phase2 (inner authentication with TLS tunnel) parameters
359
* String with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
360
* "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS.
365
* pcsc - Parameters for PC/SC smartcard interface for USIM and GSM SIM
367
* This field is used to configure PC/SC smartcard interface.
368
* Currently, the only configuration is whether this field is %NULL (do
369
* not use PC/SC) or non-NULL (e.g., "") to enable PC/SC.
371
* This field is used for EAP-SIM and EAP-AKA.
376
* pin - PIN for USIM, GSM SIM, and smartcards
378
* This field is used to configure PIN for SIM and smartcards for
379
* EAP-SIM and EAP-AKA. In addition, this is used with EAP-TLS if a
380
* smartcard is used for private key operations.
382
* If left out, this will be asked through control interface.
387
* engine - Enable OpenSSL engine (e.g., for smartcard access)
389
* This is used if private key operations for EAP-TLS are performed
395
* engine_id - Engine ID for OpenSSL engine
397
* "opensc" to select OpenSC engine or "pkcs11" to select PKCS#11
400
* This is used if private key operations for EAP-TLS are performed
406
* key_id - Key ID for OpenSSL engine
408
* This is used if private key operations for EAP-TLS are performed
414
* otp - One-time-password
416
* This field should not be set in configuration step. It is only used
417
* internally when OTP is entered through the control interface.
422
* otp_len - Length of the otp field
427
* pending_req_identity - Whether there is a pending identity request
429
* This field should not be set in configuration step. It is only used
430
* internally when control interface is used to request needed
433
int pending_req_identity;
436
* pending_req_password - Whether there is a pending password request
438
* This field should not be set in configuration step. It is only used
439
* internally when control interface is used to request needed
442
int pending_req_password;
445
* pending_req_pin - Whether there is a pending PIN request
447
* This field should not be set in configuration step. It is only used
448
* internally when control interface is used to request needed
454
* pending_req_new_password - Pending password update request
456
* This field should not be set in configuration step. It is only used
457
* internally when control interface is used to request needed
460
int pending_req_new_password;
463
* pending_req_passphrase - Pending passphrase request
465
* This field should not be set in configuration step. It is only used
466
* internally when control interface is used to request needed
469
int pending_req_passphrase;
472
* pending_req_otp - Whether there is a pending OTP request
474
* This field should not be set in configuration step. It is only used
475
* internally when control interface is used to request needed
478
char *pending_req_otp;
481
* pending_req_otp_len - Length of the pending OTP request
483
size_t pending_req_otp_len;
486
* pac_file - File path or blob name for the PAC entries (EAP-FAST)
488
* wpa_supplicant will need to be able to create this file and write
489
* updates to it when PAC is being provisioned or refreshed. Full path
490
* to the file should be used since working directory may change when
491
* wpa_supplicant is run in the background.
492
* Alternatively, a named configuration blob can be used by setting
493
* this to blob://<blob name>.
498
* mschapv2_retry - MSCHAPv2 retry in progress
500
* This field is used internally by EAP-MSCHAPv2 and should not be set
501
* as part of configuration.
506
* new_password - New password for password update
508
* This field is used during MSCHAPv2 password update. This is normally
509
* requested from the user through the control interface and not set
510
* from configuration.
515
* new_password_len - Length of new_password field
517
size_t new_password_len;
520
* fragment_size - Maximum EAP fragment size in bytes (default 1398)
522
* This value limits the fragment size for EAP methods that support
523
* fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
524
* small enough to make the EAP messages fit in MTU of the network
525
* interface used for EAPOL. The default value is suitable for most
530
#define EAP_CONFIG_FLAGS_PASSWORD_NTHASH BIT(0)
532
* flags - Network configuration flags (bitfield)
534
* This variable is used for internal flags to describe further details
535
* for the network parameters.
536
* bit 0 = password is represented as a 16-byte NtPasswordHash value
537
* instead of plaintext password
544
* struct wpa_config_blob - Named configuration blob
546
* This data structure is used to provide storage for binary objects to store
547
* abstract information like certificates and private keys inlined with the
548
* configuration data.
550
struct wpa_config_blob {
557
* data - Pointer to binary data
562
* len - Length of binary data
567
* next - Pointer to next blob in the configuration
569
struct wpa_config_blob *next;
572
#endif /* EAP_CONFIG_H */
added
removed
src/eap_peer/eap_config.h
