2 * WPA Supplicant / Configuration backend: text file
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.
14 * This file implements a configuration backend for text files. All the
15 * configuration information is stored in a text file that uses a format
16 * described in the sample configuration file, wpa_supplicant.conf.
25 #include "eap_peer/eap_methods.h"
29 * wpa_config_get_line - Read the next configuration file line
30 * @s: Buffer for the line
31 * @size: The buffer length
32 * @stream: File stream to read from
33 * @line: Pointer to a variable storing the file line number
34 * @_pos: Buffer for the pointer to the beginning of data on the text line or
35 * %NULL if not needed (returned value used instead)
36 * Returns: Pointer to the beginning of data on the text line or %NULL if no
37 * more text lines are available.
39 * This function reads the next non-empty line from the configuration file and
40 * removes comments. The returned string is guaranteed to be null-terminated.
42 static char * wpa_config_get_line(char *s, int size, FILE *stream, int *line,
45 char *pos, *end, *sstart;
47 while (fgets(s, size, stream)) {
52 /* Skip white space from the beginning of line. */
53 while (*pos == ' ' || *pos == '\t' || *pos == '\r')
56 /* Skip comment lines and empty lines */
57 if (*pos == '#' || *pos == '\n' || *pos == '\0')
61 * Remove # comments unless they are within a double quoted
64 sstart = os_strchr(pos, '"');
66 sstart = os_strrchr(sstart + 1, '"');
69 end = os_strchr(sstart, '#');
73 end = pos + os_strlen(pos) - 1;
75 /* Remove trailing white space. */
77 (*end == '\n' || *end == ' ' || *end == '\t' ||
95 static int wpa_config_validate_network(struct wpa_ssid *ssid, int line)
99 if (ssid->passphrase) {
101 wpa_printf(MSG_ERROR, "Line %d: both PSK and "
102 "passphrase configured.", line);
105 wpa_config_update_psk(ssid);
108 if ((ssid->key_mgmt & (WPA_KEY_MGMT_PSK | WPA_KEY_MGMT_FT_PSK |
109 WPA_KEY_MGMT_PSK_SHA256)) &&
111 wpa_printf(MSG_ERROR, "Line %d: WPA-PSK accepted for key "
112 "management, but no PSK configured.", line);
116 if ((ssid->group_cipher & WPA_CIPHER_CCMP) &&
117 !(ssid->pairwise_cipher & WPA_CIPHER_CCMP) &&
118 !(ssid->pairwise_cipher & WPA_CIPHER_NONE)) {
119 /* Group cipher cannot be stronger than the pairwise cipher. */
120 wpa_printf(MSG_DEBUG, "Line %d: removed CCMP from group cipher"
121 " list since it was not allowed for pairwise "
123 ssid->group_cipher &= ~WPA_CIPHER_CCMP;
130 static struct wpa_ssid * wpa_config_read_network(FILE *f, int *line, int id)
132 struct wpa_ssid *ssid;
133 int errors = 0, end = 0;
134 char buf[256], *pos, *pos2;
136 wpa_printf(MSG_MSGDUMP, "Line: %d - start of a new network block",
138 ssid = os_zalloc(sizeof(*ssid));
143 wpa_config_set_network_defaults(ssid);
145 while (wpa_config_get_line(buf, sizeof(buf), f, line, &pos)) {
146 if (os_strcmp(pos, "}") == 0) {
151 pos2 = os_strchr(pos, '=');
153 wpa_printf(MSG_ERROR, "Line %d: Invalid SSID line "
154 "'%s'.", *line, pos);
161 if (os_strchr(pos2 + 1, '"') == NULL) {
162 wpa_printf(MSG_ERROR, "Line %d: invalid "
163 "quotation '%s'.", *line, pos2);
169 if (wpa_config_set(ssid, pos, pos2, *line) < 0)
174 wpa_printf(MSG_ERROR, "Line %d: network block was not "
175 "terminated properly.", *line);
179 errors += wpa_config_validate_network(ssid, *line);
182 wpa_config_free_ssid(ssid);
190 #ifndef CONFIG_NO_CONFIG_BLOBS
191 static struct wpa_config_blob * wpa_config_read_blob(FILE *f, int *line,
194 struct wpa_config_blob *blob;
196 unsigned char *encoded = NULL, *nencoded;
198 size_t encoded_len = 0, len;
200 wpa_printf(MSG_MSGDUMP, "Line: %d - start of a new named blob '%s'",
203 while (wpa_config_get_line(buf, sizeof(buf), f, line, &pos)) {
204 if (os_strcmp(pos, "}") == 0) {
209 len = os_strlen(pos);
210 nencoded = os_realloc(encoded, encoded_len + len);
211 if (nencoded == NULL) {
212 wpa_printf(MSG_ERROR, "Line %d: not enough memory for "
218 os_memcpy(encoded + encoded_len, pos, len);
223 wpa_printf(MSG_ERROR, "Line %d: blob was not terminated "
229 blob = os_zalloc(sizeof(*blob));
234 blob->name = os_strdup(name);
235 blob->data = base64_decode(encoded, encoded_len, &blob->len);
238 if (blob->name == NULL || blob->data == NULL) {
239 wpa_config_free_blob(blob);
247 static int wpa_config_process_blob(struct wpa_config *config, FILE *f,
248 int *line, char *bname)
251 struct wpa_config_blob *blob;
253 name_end = os_strchr(bname, '=');
254 if (name_end == NULL) {
255 wpa_printf(MSG_ERROR, "Line %d: no blob name terminator",
261 blob = wpa_config_read_blob(f, line, bname);
263 wpa_printf(MSG_ERROR, "Line %d: failed to read blob %s",
267 wpa_config_set_blob(config, blob);
270 #endif /* CONFIG_NO_CONFIG_BLOBS */
273 struct global_parse_data {
275 int (*parser)(const struct global_parse_data *data,
276 struct wpa_config *config, int line, const char *value);
277 void *param1, *param2, *param3;
281 static int wpa_config_parse_int(const struct global_parse_data *data,
282 struct wpa_config *config, int line,
286 dst = (int *) (((u8 *) config) + (long) data->param1);
288 wpa_printf(MSG_DEBUG, "%s=%d", data->name, *dst);
290 if (data->param2 && *dst < (long) data->param2) {
291 wpa_printf(MSG_ERROR, "Line %d: too small %s (value=%d "
292 "min_value=%ld)", line, data->name, *dst,
293 (long) data->param2);
294 *dst = (long) data->param2;
298 if (data->param3 && *dst > (long) data->param3) {
299 wpa_printf(MSG_ERROR, "Line %d: too large %s (value=%d "
300 "max_value=%ld)", line, data->name, *dst,
301 (long) data->param3);
302 *dst = (long) data->param3;
310 static int wpa_config_parse_str(const struct global_parse_data *data,
311 struct wpa_config *config, int line,
317 len = os_strlen(pos);
318 if (data->param2 && len < (size_t) data->param2) {
319 wpa_printf(MSG_ERROR, "Line %d: too short %s (len=%lu "
320 "min_len=%ld)", line, data->name,
321 (unsigned long) len, (long) data->param2);
325 if (data->param3 && len > (size_t) data->param3) {
326 wpa_printf(MSG_ERROR, "Line %d: too long %s (len=%lu "
327 "max_len=%ld)", line, data->name,
328 (unsigned long) len, (long) data->param3);
332 tmp = os_strdup(pos);
336 dst = (char **) (((u8 *) config) + (long) data->param1);
339 wpa_printf(MSG_DEBUG, "%s='%s'", data->name, *dst);
345 static int wpa_config_process_country(const struct global_parse_data *data,
346 struct wpa_config *config, int line,
349 if (!pos[0] || !pos[1]) {
350 wpa_printf(MSG_DEBUG, "Invalid country set");
353 config->country[0] = pos[0];
354 config->country[1] = pos[1];
355 wpa_printf(MSG_DEBUG, "country='%c%c'",
356 config->country[0], config->country[1]);
361 static int wpa_config_process_load_dynamic_eap(
362 const struct global_parse_data *data, struct wpa_config *config,
363 int line, const char *so)
366 wpa_printf(MSG_DEBUG, "load_dynamic_eap=%s", so);
367 ret = eap_peer_method_load(so);
369 wpa_printf(MSG_DEBUG, "This EAP type was already loaded - not "
372 wpa_printf(MSG_ERROR, "Line %d: Failed to load dynamic EAP "
373 "method '%s'.", line, so);
383 static int wpa_config_process_uuid(const struct global_parse_data *data,
384 struct wpa_config *config, int line,
388 if (uuid_str2bin(pos, config->uuid)) {
389 wpa_printf(MSG_ERROR, "Line %d: invalid UUID", line);
392 uuid_bin2str(config->uuid, buf, sizeof(buf));
393 wpa_printf(MSG_DEBUG, "uuid=%s", buf);
398 static int wpa_config_process_os_version(const struct global_parse_data *data,
399 struct wpa_config *config, int line,
402 if (hexstr2bin(pos, config->os_version, 4)) {
403 wpa_printf(MSG_ERROR, "Line %d: invalid os_version", line);
406 wpa_printf(MSG_DEBUG, "os_version=%08x",
407 WPA_GET_BE32(config->os_version));
411 #endif /* CONFIG_WPS */
417 /* OFFSET: Get offset of a variable within the wpa_config structure */
418 #define OFFSET(v) ((void *) &((struct wpa_config *) 0)->v)
420 #define FUNC(f) #f, wpa_config_process_ ## f, OFFSET(f), NULL, NULL
421 #define FUNC_NO_VAR(f) #f, wpa_config_process_ ## f, NULL, NULL, NULL
422 #define _INT(f) #f, wpa_config_parse_int, OFFSET(f)
423 #define INT(f) _INT(f), NULL, NULL
424 #define INT_RANGE(f, min, max) _INT(f), (void *) min, (void *) max
425 #define _STR(f) #f, wpa_config_parse_str, OFFSET(f)
426 #define STR(f) _STR(f), NULL, NULL
427 #define STR_RANGE(f, min, max) _STR(f), (void *) min, (void *) max
429 static const struct global_parse_data global_fields[] = {
430 #ifdef CONFIG_CTRL_IFACE
431 { STR(ctrl_interface) },
432 { STR(ctrl_interface_group) } /* deprecated */,
433 #endif /* CONFIG_CTRL_IFACE */
434 { INT_RANGE(eapol_version, 1, 2) },
436 { INT(fast_reauth) },
437 { STR(opensc_engine_path) },
438 { STR(pkcs11_engine_path) },
439 { STR(pkcs11_module_path) },
440 { STR(driver_param) },
441 { INT(dot11RSNAConfigPMKLifetime) },
442 { INT(dot11RSNAConfigPMKReauthThreshold) },
443 { INT(dot11RSNAConfigSATimeout) },
444 #ifndef CONFIG_NO_CONFIG_WRITE
445 { INT(update_config) },
446 #endif /* CONFIG_NO_CONFIG_WRITE */
447 { FUNC_NO_VAR(load_dynamic_eap) },
450 { STR_RANGE(device_name, 0, 32) },
451 { STR_RANGE(manufacturer, 0, 64) },
452 { STR_RANGE(model_name, 0, 32) },
453 { STR_RANGE(model_number, 0, 32) },
454 { STR_RANGE(serial_number, 0, 32) },
455 { STR(device_type) },
456 { FUNC(os_version) },
457 { STR(config_methods) },
458 { INT_RANGE(wps_cred_processing, 0, 2) },
459 #endif /* CONFIG_WPS */
461 { INT(bss_max_count) },
462 { INT_RANGE(filter_ssids, 0, 1) }
472 #define NUM_GLOBAL_FIELDS (sizeof(global_fields) / sizeof(global_fields[0]))
475 static int wpa_config_process_global(struct wpa_config *config, char *pos,
481 for (i = 0; i < NUM_GLOBAL_FIELDS; i++) {
482 const struct global_parse_data *field = &global_fields[i];
483 size_t flen = os_strlen(field->name);
484 if (os_strncmp(pos, field->name, flen) != 0 ||
488 if (field->parser(field, config, line, pos + flen + 1)) {
489 wpa_printf(MSG_ERROR, "Line %d: failed to "
490 "parse '%s'.", line, pos);
495 if (i == NUM_GLOBAL_FIELDS) {
496 wpa_printf(MSG_ERROR, "Line %d: unknown global field '%s'.",
505 struct wpa_config * wpa_config_read(const char *name)
509 int errors = 0, line = 0;
510 struct wpa_ssid *ssid, *tail = NULL, *head = NULL;
511 struct wpa_config *config;
514 config = wpa_config_alloc_empty(NULL, NULL);
517 wpa_printf(MSG_DEBUG, "Reading configuration file '%s'", name);
518 f = fopen(name, "r");
524 while (wpa_config_get_line(buf, sizeof(buf), f, &line, &pos)) {
525 if (os_strcmp(pos, "network={") == 0) {
526 ssid = wpa_config_read_network(f, &line, id++);
528 wpa_printf(MSG_ERROR, "Line %d: failed to "
529 "parse network block.", line);
539 if (wpa_config_add_prio_network(config, ssid)) {
540 wpa_printf(MSG_ERROR, "Line %d: failed to add "
541 "network block to priority list.",
546 #ifndef CONFIG_NO_CONFIG_BLOBS
547 } else if (os_strncmp(pos, "blob-base64-", 12) == 0) {
548 if (wpa_config_process_blob(config, f, &line, pos + 12)
553 #endif /* CONFIG_NO_CONFIG_BLOBS */
554 } else if (wpa_config_process_global(config, pos, line) < 0) {
555 wpa_printf(MSG_ERROR, "Line %d: Invalid configuration "
556 "line '%s'.", line, pos);
565 wpa_config_debug_dump_networks(config);
568 wpa_config_free(config);
577 #ifndef CONFIG_NO_CONFIG_WRITE
579 static void write_str(FILE *f, const char *field, struct wpa_ssid *ssid)
581 char *value = wpa_config_get(ssid, field);
584 fprintf(f, "\t%s=%s\n", field, value);
589 static void write_int(FILE *f, const char *field, int value, int def)
593 fprintf(f, "\t%s=%d\n", field, value);
597 static void write_bssid(FILE *f, struct wpa_ssid *ssid)
599 char *value = wpa_config_get(ssid, "bssid");
602 fprintf(f, "\tbssid=%s\n", value);
607 static void write_psk(FILE *f, struct wpa_ssid *ssid)
609 char *value = wpa_config_get(ssid, "psk");
612 fprintf(f, "\tpsk=%s\n", value);
617 static void write_proto(FILE *f, struct wpa_ssid *ssid)
621 if (ssid->proto == DEFAULT_PROTO)
624 value = wpa_config_get(ssid, "proto");
628 fprintf(f, "\tproto=%s\n", value);
633 static void write_key_mgmt(FILE *f, struct wpa_ssid *ssid)
637 if (ssid->key_mgmt == DEFAULT_KEY_MGMT)
640 value = wpa_config_get(ssid, "key_mgmt");
644 fprintf(f, "\tkey_mgmt=%s\n", value);
649 static void write_pairwise(FILE *f, struct wpa_ssid *ssid)
653 if (ssid->pairwise_cipher == DEFAULT_PAIRWISE)
656 value = wpa_config_get(ssid, "pairwise");
660 fprintf(f, "\tpairwise=%s\n", value);
665 static void write_group(FILE *f, struct wpa_ssid *ssid)
669 if (ssid->group_cipher == DEFAULT_GROUP)
672 value = wpa_config_get(ssid, "group");
676 fprintf(f, "\tgroup=%s\n", value);
681 static void write_auth_alg(FILE *f, struct wpa_ssid *ssid)
685 if (ssid->auth_alg == 0)
688 value = wpa_config_get(ssid, "auth_alg");
692 fprintf(f, "\tauth_alg=%s\n", value);
697 #ifdef IEEE8021X_EAPOL
698 static void write_eap(FILE *f, struct wpa_ssid *ssid)
702 value = wpa_config_get(ssid, "eap");
707 fprintf(f, "\teap=%s\n", value);
710 #endif /* IEEE8021X_EAPOL */
713 static void write_wep_key(FILE *f, int idx, struct wpa_ssid *ssid)
715 char field[20], *value;
718 res = os_snprintf(field, sizeof(field), "wep_key%d", idx);
719 if (res < 0 || (size_t) res >= sizeof(field))
721 value = wpa_config_get(ssid, field);
723 fprintf(f, "\t%s=%s\n", field, value);
729 static void wpa_config_write_network(FILE *f, struct wpa_ssid *ssid)
733 #define STR(t) write_str(f, #t, ssid)
734 #define INT(t) write_int(f, #t, ssid->t, 0)
735 #define INTe(t) write_int(f, #t, ssid->eap.t, 0)
736 #define INT_DEF(t, def) write_int(f, #t, ssid->t, def)
737 #define INT_DEFe(t, def) write_int(f, #t, ssid->eap.t, def)
741 write_bssid(f, ssid);
743 write_proto(f, ssid);
744 write_key_mgmt(f, ssid);
745 write_pairwise(f, ssid);
746 write_group(f, ssid);
747 write_auth_alg(f, ssid);
748 #ifdef IEEE8021X_EAPOL
751 STR(anonymous_identity);
757 STR(private_key_passwd);
760 STR(altsubject_match);
765 STR(private_key2_passwd);
768 STR(altsubject_match2);
784 INT_DEF(eapol_flags, DEFAULT_EAPOL_FLAGS);
785 #endif /* IEEE8021X_EAPOL */
786 for (i = 0; i < 4; i++)
787 write_wep_key(f, i, ssid);
790 #ifdef IEEE8021X_EAPOL
791 INT_DEF(eap_workaround, DEFAULT_EAP_WORKAROUND);
793 INT_DEFe(fragment_size, DEFAULT_FRAGMENT_SIZE);
794 #endif /* IEEE8021X_EAPOL */
796 INT(proactive_key_caching);
799 #ifdef CONFIG_IEEE80211W
801 #endif /* CONFIG_IEEE80211W */
810 #ifndef CONFIG_NO_CONFIG_BLOBS
811 static int wpa_config_write_blob(FILE *f, struct wpa_config_blob *blob)
813 unsigned char *encoded;
815 encoded = base64_encode(blob->data, blob->len, NULL);
819 fprintf(f, "\nblob-base64-%s={\n%s}\n", blob->name, encoded);
823 #endif /* CONFIG_NO_CONFIG_BLOBS */
826 static void wpa_config_write_global(FILE *f, struct wpa_config *config)
828 #ifdef CONFIG_CTRL_IFACE
829 if (config->ctrl_interface)
830 fprintf(f, "ctrl_interface=%s\n", config->ctrl_interface);
831 if (config->ctrl_interface_group)
832 fprintf(f, "ctrl_interface_group=%s\n",
833 config->ctrl_interface_group);
834 #endif /* CONFIG_CTRL_IFACE */
835 if (config->eapol_version != DEFAULT_EAPOL_VERSION)
836 fprintf(f, "eapol_version=%d\n", config->eapol_version);
837 if (config->ap_scan != DEFAULT_AP_SCAN)
838 fprintf(f, "ap_scan=%d\n", config->ap_scan);
839 if (config->fast_reauth != DEFAULT_FAST_REAUTH)
840 fprintf(f, "fast_reauth=%d\n", config->fast_reauth);
841 if (config->opensc_engine_path)
842 fprintf(f, "opensc_engine_path=%s\n",
843 config->opensc_engine_path);
844 if (config->pkcs11_engine_path)
845 fprintf(f, "pkcs11_engine_path=%s\n",
846 config->pkcs11_engine_path);
847 if (config->pkcs11_module_path)
848 fprintf(f, "pkcs11_module_path=%s\n",
849 config->pkcs11_module_path);
850 if (config->driver_param)
851 fprintf(f, "driver_param=%s\n", config->driver_param);
852 if (config->dot11RSNAConfigPMKLifetime)
853 fprintf(f, "dot11RSNAConfigPMKLifetime=%d\n",
854 config->dot11RSNAConfigPMKLifetime);
855 if (config->dot11RSNAConfigPMKReauthThreshold)
856 fprintf(f, "dot11RSNAConfigPMKReauthThreshold=%d\n",
857 config->dot11RSNAConfigPMKReauthThreshold);
858 if (config->dot11RSNAConfigSATimeout)
859 fprintf(f, "dot11RSNAConfigSATimeout=%d\n",
860 config->dot11RSNAConfigSATimeout);
861 if (config->update_config)
862 fprintf(f, "update_config=%d\n", config->update_config);
864 if (!is_nil_uuid(config->uuid)) {
866 uuid_bin2str(config->uuid, buf, sizeof(buf));
867 fprintf(f, "uuid=%s\n", buf);
869 if (config->device_name)
870 fprintf(f, "device_name=%s\n", config->device_name);
871 if (config->manufacturer)
872 fprintf(f, "manufacturer=%s\n", config->manufacturer);
873 if (config->model_name)
874 fprintf(f, "model_name=%s\n", config->model_name);
875 if (config->model_number)
876 fprintf(f, "model_number=%s\n", config->model_number);
877 if (config->serial_number)
878 fprintf(f, "serial_number=%s\n", config->serial_number);
879 if (config->device_type)
880 fprintf(f, "device_type=%s\n", config->device_type);
881 if (WPA_GET_BE32(config->os_version))
882 fprintf(f, "os_version=%08x\n",
883 WPA_GET_BE32(config->os_version));
884 if (config->config_methods)
885 fprintf(f, "config_methods=%s\n", config->config_methods);
886 if (config->wps_cred_processing)
887 fprintf(f, "wps_cred_processing=%d\n",
888 config->wps_cred_processing);
889 #endif /* CONFIG_WPS */
890 if (config->country[0] && config->country[1]) {
891 fprintf(f, "country=%c%c\n",
892 config->country[0], config->country[1]);
894 if (config->bss_max_count != DEFAULT_BSS_MAX_COUNT)
895 fprintf(f, "bss_max_count=%u\n", config->bss_max_count);
896 if (config->filter_ssids)
897 fprintf(f, "filter_ssids=%d\n", config->filter_ssids);
900 #endif /* CONFIG_NO_CONFIG_WRITE */
903 int wpa_config_write(const char *name, struct wpa_config *config)
905 #ifndef CONFIG_NO_CONFIG_WRITE
907 struct wpa_ssid *ssid;
908 #ifndef CONFIG_NO_CONFIG_BLOBS
909 struct wpa_config_blob *blob;
910 #endif /* CONFIG_NO_CONFIG_BLOBS */
913 wpa_printf(MSG_DEBUG, "Writing configuration file '%s'", name);
915 f = fopen(name, "w");
917 wpa_printf(MSG_DEBUG, "Failed to open '%s' for writing", name);
921 wpa_config_write_global(f, config);
923 for (ssid = config->ssid; ssid; ssid = ssid->next) {
924 if (ssid->key_mgmt == WPA_KEY_MGMT_WPS)
925 continue; /* do not save temporary WPS networks */
926 fprintf(f, "\nnetwork={\n");
927 wpa_config_write_network(f, ssid);
931 #ifndef CONFIG_NO_CONFIG_BLOBS
932 for (blob = config->blobs; blob; blob = blob->next) {
933 ret = wpa_config_write_blob(f, blob);
937 #endif /* CONFIG_NO_CONFIG_BLOBS */
941 wpa_printf(MSG_DEBUG, "Configuration file '%s' written %ssuccessfully",
942 name, ret ? "un" : "");
944 #else /* CONFIG_NO_CONFIG_WRITE */
946 #endif /* CONFIG_NO_CONFIG_WRITE */