summaryrefslogtreecommitdiff
path: root/recipes/wpa-supplicant/wpa-supplicant-0.6.7/functions.sh
blob: 0baa101925bea9c4794050349d75d508ff893bd0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
#!/bin/sh

#####################################################################
## Purpose
# This file contains common shell functions used by scripts of the
# wpasupplicant package to allow ifupdown to manage wpa_supplicant.
# It also contains some functions used by wpa_action(8) that allow
# ifupdown to be managed by wpa_cli(8) action events.
#
# This file is provided by the wpasupplicant package.

#####################################################################
# Copyright (C) 2006 - 2008 Debian/Ubuntu wpasupplicant Maintainers 
# <pkg-wpa-devel@lists.alioth.debian.org>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# On Debian GNU/Linux systems, the text of the GPL license can be
# found in /usr/share/common-licenses/GPL.

#####################################################################
## global variables
# wpa_supplicant variables
WPA_SUP_BIN="/sbin/wpa_supplicant"
WPA_SUP_PNAME="wpa_supplicant"
WPA_SUP_PIDFILE="/var/run/wpa_supplicant.${WPA_IFACE}.pid"
#WPA_SUP_LOGFILE="/var/log/wpa_supplicant.${WPA_IFACE}.log"
WPA_SUP_LOGFILE="syslog"

# wpa_cli variables
WPA_CLI_BIN="/sbin/wpa_cli"
WPA_CLI_PNAME="wpa_cli"
WPA_CLI_PIDFILE="/var/run/wpa_action.${WPA_IFACE}.pid"
WPA_CLI_LOGFILE="/var/log/wpa_action.${WPA_IFACE}.log"
WPA_CLI_TIMESTAMP="/var/run/wpa_action.${WPA_IFACE}.timestamp"
WPA_CLI_IFUPDOWN="/var/run/wpa_action.${WPA_IFACE}.ifupdown"

# sendsigs omission interface, present in initscripts (>= 2.86.ds1-48)
if [ -d /lib/init/rw/sendsigs.omit.d/ ]; then
	# Debian
	WPA_SUP_OMIT_PIDFILE="/lib/init/rw/sendsigs.omit.d/wpasupplicant.wpa_supplicant.${WPA_IFACE}.pid"
	WPA_CLI_OMIT_PIDFILE="/lib/init/rw/sendsigs.omit.d/wpasupplicant.wpa_action.${WPA_IFACE}.pid"
elif [ -d /var/run/sendsigs.omit.d/ ]; then
	# Ubuntu, see https://launchpad.net/bugs/181541 for status
	WPA_SUP_OMIT_PIDFILE="/var/run/sendsigs.omit.d/wpasupplicant.wpa_supplicant.${WPA_IFACE}.pid"
	WPA_CLI_OMIT_PIDFILE="/var/run/sendsigs.omit.d/wpasupplicant.wpa_action.${WPA_IFACE}.pid"
else
	WPA_SUP_OMIT_PIDFILE=
	WPA_CLI_OMIT_PIDFILE=
fi

# default ctrl_interface socket directory
if [ -z "$WPA_CTRL_DIR" ]; then
	WPA_CTRL_DIR="/var/run/wpa_supplicant"
fi

# verbosity variables
if [ -n "$IF_WPA_VERBOSITY" ] || [ "$VERBOSITY" = "1" ]; then
	TO_NULL="/dev/stdout"
	DAEMON_VERBOSITY="--verbose"
else
	TO_NULL="/dev/null"
	DAEMON_VERBOSITY="--quiet"
fi

#####################################################################
## wpa_cli wrapper
# Path to common ctrl_interface socket and iface supplied.
# NB: WPA_CTRL_DIR cannot be used for interactive commands, it is
# set only in the environment that wpa_cli provides when processing
# action events.
#
wpa_cli () {
	"$WPA_CLI_BIN" -p "$WPA_CTRL_DIR" -i "$WPA_IFACE" "$@"

	return "$?"
}

#####################################################################
## verbose and stderr message wrapper
# Ensures a standard and easily identifiable message is printed by
# scripts using this function library.
#
# verbose	To stdout when IF_WPA_VERBOSITY or VERBOSITY is true
#
# action	Same as verbose but without newline
#		Useful for allowing wpa_cli commands to echo result
#		value of 'OK' or 'FAILED'
#
# stderr	Echo warning or error messages to stderr
#
# NB: when called by wpa_action, there is no redirection (verbose)
#
wpa_msg () {
	if [ -n "$WPA_ACTION" ]; then
		shift
		echo "wpa_action: $@"
		return
	fi
	
	case "$1" in 
		"verbose")
			shift
			echo "$WPA_SUP_PNAME: $@" >$TO_NULL
			;;
		"action")
			shift
			echo -n "$WPA_SUP_PNAME: $@ -- " >$TO_NULL
			;;
		"stderr")
			shift
			echo "$WPA_SUP_PNAME: $@" >/dev/stderr
			;;
		*)
			;;
	esac
}

#####################################################################
## validate daemon pid files
# Test daemon process ID files via start-stop-daemon with a signal 0
# given the exec binary and pidfile location.
#
# $1	daemon
# $2	pidfile
#
# Returns true when pidfile exists, the process ID exists _and_ was
# created by the exec binary.
#
# If the test fails, but the pidfile exists, it is stale
#
test_daemon_pidfile () {
	local DAEMON
	local PIDFILE
	
	if [ -n "$1" ]; then
		DAEMON="$1"
	fi
	
	if [ -f "$2" ]; then
		PIDFILE="$2"
	fi
	
	if [ -n "$DAEMON" ] && [ -f "$PIDFILE" ]; then
		if start-stop-daemon --stop --quiet --signal 0 \
			--exec "$DAEMON" --pidfile "$PIDFILE"; then
			return 0
		else
			rm -f "$PIDFILE"
			return 1
		fi
	else
		return 1
	fi
}

# validate wpa_supplicant pidfile
test_wpa_supplicant () {
	test_daemon_pidfile "$WPA_SUP_BIN" "$WPA_SUP_PIDFILE"
}

# validate wpa_cli pidfile
test_wpa_cli () {
	test_daemon_pidfile "$WPA_CLI_BIN" "$WPA_CLI_PIDFILE"
}

#####################################################################
## daemonize wpa_supplicant
# Start wpa_supplicant via start-stop-dameon with all required
# options. Will start if environment variable WPA_SUP_CONF is present
#
# Required options:
# -B	dameonize/background process
# -D	driver backend ('wext' if none given)
# -P	process ID file
# -C	path to ctrl_interface socket directory
#
# Optional options:
# -c	configuration file
# -W	wait for wpa_cli to attach to ctrl_interface socket
# -b	bridge interface name
# -f	path to log file
#
init_wpa_supplicant () {
	[ -n "$WPA_SUP_CONF" ] || return 0

	local WPA_SUP_OPTIONS

	if [ -n "$WPA_ACTION_SCRIPT" ]; then
		if [ -x "$WPA_ACTION_SCRIPT" ]; then
			WPA_SUP_OPTIONS="-W -B -P $WPA_SUP_PIDFILE -i $WPA_IFACE"
			wpa_msg verbose "wait for wpa_cli to attach"
		else
			wpa_msg stderr "action script \"$WPA_ACTION_SCRIPT\" not executable"
			return 1
		fi
	else
		WPA_SUP_OPTIONS="-B -P $WPA_SUP_PIDFILE -i $WPA_IFACE"
	fi

	if [ -n "$IF_WPA_BRIDGE" ]; then
		WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -b $IF_WPA_BRIDGE"
		wpa_msg verbose "wpa-bridge $IF_WPA_BRIDGE"
	fi

	if [ -n "$IF_WPA_DRIVER" ]; then
		wpa_msg verbose "wpa-driver $IF_WPA_DRIVER"
		case "$IF_WPA_DRIVER" in
			hostap|ipw|madwifi|ndiswrapper)
				WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -D wext"
				wpa_msg stderr "\"$IF_WPA_DRIVER\" wpa-driver is unsupported"
				wpa_msg stderr "using \"wext\" wpa-driver instead ..."
				;;
			*)
				WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -D $IF_WPA_DRIVER"
				;;
		esac
	else
		WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -D wext"
		wpa_msg verbose "using default driver type: wpa-driver wext"
	fi

	if [ -n "$IF_WPA_DEBUG_LEVEL" ]; then
		case "$IF_WPA_DEBUG_LEVEL" in
			3)
				WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -t -ddd"
				;;
			2)
				WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -t -dd"
				;;
			1)
				WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -t -d"
				;;
			0)
				# wpa_supplicant default verbosity
				;;
			-1)
				WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -q"
				;;
			-2)
				WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -qq"
				;;
		esac
		wpa_msg verbose "using debug level: $IF_WPA_DEBUG_LEVEL"
	else
		# log warnings only by default
		WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -q"
	fi

	if [ -n "$IF_WPA_LOGFILE" ]; then
		# custom log file
		WPA_SUP_LOGFILE="$IF_WPA_LOGFILE"
		wpa_msg verbose "logging to $IF_WPA_LOGFILE"
	fi

	if [ "$WPA_SUP_LOGFILE" = syslog ]; then
		WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -s"
	elif [ -d "${WPA_SUP_LOGFILE%/*}" ]; then
		WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -f $WPA_SUP_LOGFILE"
	else
		wpa_msg stderr "unable to log output to $WPA_SUP_LOGFILE"
	fi

	wpa_msg verbose "$WPA_SUP_BIN $WPA_SUP_OPTIONS $WPA_SUP_CONF"
		
	start-stop-daemon --start --oknodo $DAEMON_VERBOSITY \
		--name $WPA_SUP_PNAME --startas $WPA_SUP_BIN --pidfile $WPA_SUP_PIDFILE \
		-- $WPA_SUP_OPTIONS $WPA_SUP_CONF

	if [ "$?" -ne 0 ]; then
		wpa_msg stderr "$WPA_SUP_BIN daemon failed to start"
		return 1
	fi

	if [ -n "$WPA_SUP_OMIT_PIDFILE" ]; then
		local WPA_PIDFILE_WAIT
		local MAX_WPA_PIDFILE_WAIT
		WPA_PIDFILE_WAIT="0"
		MAX_WPA_PIDFILE_WAIT="5"
		until [ -s "$WPA_SUP_PIDFILE" ]; do
			if [ "$WPA_PIDFILE_WAIT" -ge "$MAX_WPA_PIDFILE_WAIT" ]; then
				wpa_msg stderr "timed out waiting for creation of $WPA_SUP_PIDFILE"
				return 1
			else
				wpa_msg verbose "waiting for \"$WPA_SUP_PIDFILE\": " \
					"$WPA_PIDFILE_WAIT (max. $MAX_WPA_PIDFILE_WAIT)"
			fi

			WPA_PIDFILE_WAIT=$(($WPA_PIDFILE_WAIT + 1))
			sleep 1
		done
		wpa_msg verbose "creating sendsigs omission pidfile: $WPA_SUP_OMIT_PIDFILE"
		cat "$WPA_SUP_PIDFILE" > "$WPA_SUP_OMIT_PIDFILE"
	else
		wpa_msg verbose "sendsigs omission pidfile not created"
	fi

	local WPA_SOCKET_WAIT
	local MAX_WPA_SOCKET_WAIT
	WPA_SOCKET_WAIT="0"
	MAX_WPA_SOCKET_WAIT="5"
	until [ -S "$WPA_CTRL_DIR/$WPA_IFACE" ]; do
		if [ "$WPA_SOCKET_WAIT" -ge "$MAX_WPA_SOCKET_WAIT" ]; then
			wpa_msg stderr "ctrl_interface socket not found at $WPA_CTRL_DIR/$WPA_IFACE"
			return 1
		else
			wpa_msg verbose "waiting for \"$WPA_CTRL_DIR/$WPA_IFACE\": " \
				"$WPA_SOCKET_WAIT (max. $MAX_WPA_SOCKET_WAIT)"
		fi
		
		WPA_SOCKET_WAIT=$(($WPA_SOCKET_WAIT + 1))
		sleep 1
	done
	
	wpa_msg verbose "ctrl_interface socket located at $WPA_CTRL_DIR/$WPA_IFACE"
}

#####################################################################
## stop wpa_supplicant process
# Kill wpa_supplicant via start-stop-daemon, given the location of
# the pidfile or ctrl_interface socket path and interface name
#
kill_wpa_supplicant () {
	test_wpa_supplicant || return 0

	wpa_msg verbose "terminating $WPA_SUP_PNAME daemon via pidfile $WPA_SUP_PIDFILE"

	start-stop-daemon --stop --oknodo $DAEMON_VERBOSITY \
		--exec $WPA_SUP_BIN --pidfile $WPA_SUP_PIDFILE

	if [ -f "$WPA_SUP_PIDFILE" ]; then
		rm -f "$WPA_SUP_PIDFILE"
	fi

	if [ -f "$WPA_SUP_OMIT_PIDFILE" ]; then
		wpa_msg verbose "removing $WPA_SUP_OMIT_PIDFILE"
		rm -f "$WPA_SUP_OMIT_PIDFILE"
	fi
}

#####################################################################
## reload wpa_supplicant process
# Sending a HUP signal causes wpa_supplicant to reparse its
# configuration file
#
reload_wpa_supplicant () {
	if test_wpa_supplicant; then
		wpa_msg verbose "reloading wpa_supplicant configuration file via HUP signal"
		start-stop-daemon --stop --signal HUP \
			--name "$WPA_SUP_PNAME" --pidfile "$WPA_SUP_PIDFILE"
	else
		wpa_msg verbose "cannot $WPA_ACTION, $WPA_SUP_PIDFILE does not exist"
	fi
}

#####################################################################
## daemonize wpa_cli and action script
# If environment variable WPA_ACTION_SCRIPT is present, wpa_cli will
# be spawned via start-stop-daemon
#
# Required options:
# -a	action script => wpa_action
# -P	process ID file
# -B	background process
#
init_wpa_cli () {
	[ -n "$WPA_ACTION_SCRIPT" ] || return 0

	local WPA_CLI_OPTIONS
	WPA_CLI_OPTIONS="-B -P $WPA_CLI_PIDFILE -i $WPA_IFACE"

	wpa_msg verbose "$WPA_CLI_BIN $WPA_CLI_OPTIONS -p $WPA_CTRL_DIR -a $WPA_ACTION_SCRIPT"
		
	start-stop-daemon --start --oknodo $DAEMON_VERBOSITY \
		--name $WPA_CLI_PNAME --startas $WPA_CLI_BIN --pidfile $WPA_CLI_PIDFILE \
		-- $WPA_CLI_OPTIONS -p $WPA_CTRL_DIR -a $WPA_ACTION_SCRIPT

	if [ "$?" -ne 0 ]; then
		wpa_msg stderr "$WPA_CLI_BIN daemon failed to start"
		return 1
	fi

	if [ -n "$WPA_CLI_OMIT_PIDFILE" ]; then
		local WPA_PIDFILE_WAIT
		local MAX_WPA_PIDFILE_WAIT
		WPA_PIDFILE_WAIT="0"
		MAX_WPA_PIDFILE_WAIT="5"
		until [ -s "$WPA_CLI_PIDFILE" ]; do
			if [ "$WPA_PIDFILE_WAIT" -ge "$MAX_WPA_PIDFILE_WAIT" ]; then
				wpa_msg stderr "timed out waiting for creation of $WPA_CLI_PIDFILE"
				return 1
			else
				wpa_msg verbose "waiting for \"$WPA_CLI_PIDFILE\": " \
					"$WPA_PIDFILE_WAIT (max. $MAX_WPA_PIDFILE_WAIT)"
			fi

			WPA_PIDFILE_WAIT=$(($WPA_PIDFILE_WAIT + 1))
			sleep 1
		done
		wpa_msg verbose "creating sendsigs omission pidfile: $WPA_CLI_OMIT_PIDFILE"
		cat "$WPA_CLI_PIDFILE" > "$WPA_CLI_OMIT_PIDFILE"
	else
		wpa_msg verbose "sendsigs omission pidfile not created"
	fi
}

#####################################################################
## stop wpa_cli process
# Kill wpa_cli via start-stop-daemon, given the location of the
# pidfile
#
kill_wpa_cli () {
	test_wpa_cli || return 0
	
	wpa_msg verbose "terminating $WPA_CLI_PNAME daemon via pidfile $WPA_CLI_PIDFILE"
	
	start-stop-daemon --stop --oknodo $DAEMON_VERBOSITY \
		--exec $WPA_CLI_BIN --pidfile $WPA_CLI_PIDFILE
	
	if [ -f "$WPA_CLI_PIDFILE" ]; then
		rm -f "$WPA_CLI_PIDFILE"
	fi

	if [ -f "$WPA_CLI_OMIT_PIDFILE" ]; then
		rm -f "$WPA_CLI_OMIT_PIDFILE"
	fi

	if [ -f "$WPA_CLI_TIMESTAMP" ]; then
		rm -f "$WPA_CLI_TIMESTAMP"
	fi

	if [ -L "$WPA_CLI_IFUPDOWN" ]; then
		rm -f "$WPA_CLI_IFUPDOWN"
	fi
}

#####################################################################
## higher level wpa_cli wrapper for variable and set_network commands
# wpa_cli_do <value> <type> <variable> [set_network variable] <desc>
#
# $1	envorinment variable
# $2	data type of variable {raw|ascii}
# $3	wpa_cli variable, if $3 is set_network, shift and take 
#	set_network subvariable
# $4	wpa-* string as it would appear in interfaces file, enhances
#	verbose messages
#
wpa_cli_do () {
	if [ -z "$1" ]; then
		return 0
	fi
	
	local WPACLISET_VALUE
	local WPACLISET_VARIABLE
	local WPACLISET_DESC
	
	case "$2" in
		ascii)
			# Double quote
			WPACLISET_VALUE="\"$1\""
			;;
		raw|*)
			# Provide raw value
			WPACLISET_VALUE="$1"
			;;
	esac
	
	case "$3" in
		set_network)
			if [ -z "$WPA_ID" ]; then
				return 1
			fi
			shift
			WPACLISET_VARIABLE="set_network $WPA_ID $3"
			;;
		*)
			WPACLISET_VARIABLE="$3"
			;;
	esac
	
	case "$4" in
		*-psk|*-passphrase|*-passwd*|*-wep-key*)
			WPACLISET_DESC="$4 *****"
			;;
		*)
			WPACLISET_DESC="$4 $WPACLISET_VALUE"
			;;
	esac

	wpa_msg action "$WPACLISET_DESC"
	
	wpa_cli $WPACLISET_VARIABLE "$WPACLISET_VALUE" >$TO_NULL

	if [ "$?" -ne 0 ]; then
		wpa_msg stderr "$WPACLISET_DESC failed!"
	fi
}

#####################################################################
## check value data type in plaintext or hex
# returns 0 if input consists of hexadecimal digits only, 1 otherwise
#
ishex () {
	if [ -z "$1" ]; then 
		return 0
	fi
	
	case "$1" in
		*[!0-9a-fA-F]*)
			# plaintext
			return 1
			;;
		*)
			# hexadecimal
			return 0
			;;
	esac
}

#####################################################################
## sanity check and set psk|passphrase
# Warn about strange psk|passphrase values
#
# $1	psk or passphrase value
# 
# If psk is surrounded by quotes strip them.
#
# If psk contains all hexadecimal characters and string length is 64:
#	is 256bit hexadecimal
# else:
# 	is plaintext
#
# plaintext passphrases must be 8 - 63 characters in length
# 256-bit hexadecimal key must be 64 characters in length
#
wpa_key_check_and_set () {
	if [ "$#" -ne 3 ]; then
		return 0
	fi

	local KEY
	local KEY_LEN
	local KEY_TYPE
	local ENC_TYPE
	
	case "$1" in
		'"'*'"')
			# Strip surrounding quotation marks
			KEY=$(echo -n "$1" | sed 's/^"//;s/"$//')
			;;
		*)
			KEY="$1"
			;;
	esac

	KEY_LEN="${#KEY}"

	case "$2" in
		wep_key*)
			ENC_TYPE="WEP"
			;;
		psk)
			ENC_TYPE="WPA"
			;;
		*)
			return 0
			;;
	esac

	if [ "$ENC_TYPE" = "WEP" ]; then
		if ishex "$KEY"; then
			case "$KEY_LEN" in
				10|26|32|58)
					# 64/128/152/256-bit WEP
					KEY_TYPE="raw"
					;;
				*)
					KEY_TYPE="ascii"
					;;
			esac
		else
			KEY_TYPE="ascii"
		fi

		if [ "$KEY_TYPE" = "ascii" ]; then
			if [ "$KEY_LEN" -lt "5" ]; then
				wpa_msg stderr "WARNING: plaintext or ascii WEP key has $KEY_LEN characters,"
				wpa_msg stderr "it must have at least 5 to be valid."
			fi
		fi
	elif [ "$ENC_TYPE" = "WPA" ]; then
		if ishex "$KEY"; then
			case "$KEY_LEN" in
				64)
					# 256-bit WPA
					KEY_TYPE="raw"
					;;
				*)
					KEY_TYPE="ascii"
					;;
			esac
		else
			KEY_TYPE="ascii"
		fi

		if [ "$KEY_TYPE" = "ascii" ]; then
			if [ "$KEY_LEN" -lt "8" ] || [ "$KEY_LEN" -gt "63" ]; then
				wpa_msg stderr "WARNING: plaintext or ascii WPA key has $KEY_LEN characters,"
				wpa_msg stderr "it must have between 8 and 63 to be valid."
				wpa_msg stderr "If the WPA key is a 256-bit hexadecimal key, it must have"
				wpa_msg stderr "exactly 64 characters."
			fi
		fi
	fi

	wpa_cli_do "$KEY" "$KEY_TYPE" set_network "$2" "$3"
}

#####################################################################
## formulate a usable configuration from interfaces(5) wpa- lines
# A series of wpa_cli commands corresponding to environment variables
# created as a result of wpa- lines in an interfaces stanza.
#
# NB: no-act when roaming daemon is used (to avoid prematurely
# attaching to ctrl_interface socket)
#
conf_wpa_supplicant () {
	if [ -n "$WPA_ACTION_SCRIPT" ]; then
		return 0
	fi

	if [ "$IF_WPA_DRIVER" = "wired" ]; then
		IF_WPA_AP_SCAN="0"
		wpa_msg verbose "forcing ap_scan=0 (required for wired IEEE8021X auth)"
	fi

	if [ -n "$IF_WPA_ESSID" ]; then
		# #403316, be similar to wireless tools
		IF_WPA_SSID="$IF_WPA_ESSID"
	fi
	
	wpa_cli_do "$IF_WPA_AP_SCAN" raw \
		ap_scan wpa-ap-scan
	
	wpa_cli_do "$IF_WPA_PREAUTHENTICATE" raw \
		preauthenticate wpa-preauthenticate
		
	if [ -n "$IF_WPA_SSID" ] || [ "$IF_WPA_DRIVER" = "wired" ] || \
		[ -n "$IF_WPA_KEY_MGMT" ]; then
		
		case "$IF_WPA_SSID" in
			'"'*'"')
				IF_WPA_SSID=$(echo -n "$IF_WPA_SSID" | sed 's/^"//;s/"$//')
				;;
			*)
				;;
		esac
		
		WPA_ID=$(wpa_cli add_network)

		wpa_msg verbose "configuring network block -- $WPA_ID"
		
		wpa_cli_do "$IF_WPA_SSID" ascii \
			set_network ssid wpa-ssid
		
		wpa_cli_do "$IF_WPA_PRIORITY" raw \
			set_network priority wpa-priority
		
		wpa_cli_do "$IF_WPA_BSSID" raw \
			set_network bssid wpa-bssid
		
		if [ -s "$IF_WPA_PSK_FILE" ]; then
			IF_WPA_PSK=$(cat "$IF_WPA_PSK_FILE")
		fi
		
		# remain compat with wpa-passphrase-file
		if [ -s "$IF_WPA_PASSPHRASE_FILE" ]; then
			IF_WPA_PSK=$(cat "$IF_WPA_PASSPHRASE_FILE")
		fi
		
		# remain compat with wpa-passphrase
		if [ -n "$IF_WPA_PASSPHRASE" ]; then
			IF_WPA_PSK="$IF_WPA_PASSPHRASE"
		fi
	
		if [ -n "$IF_WPA_PSK" ]; then
			wpa_key_check_and_set "$IF_WPA_PSK" \
				psk wpa-psk
		fi
		
		wpa_cli_do "$IF_WPA_PAIRWISE" raw \
			set_network pairwise wpa-pairwise
		
		wpa_cli_do "$IF_WPA_GROUP" raw \
			set_network group wpa-group

		wpa_cli_do "$IF_WPA_MODE" raw \
			set_network mode wpa-mode

		wpa_cli_do "$IF_WPA_FREQUENCY" raw \
			set_network frequency wpa-frequency
		
		wpa_cli_do "$IF_WPA_KEY_MGMT" raw \
			set_network key_mgmt wpa-key-mgmt
		
		wpa_cli_do "$IF_WPA_PROTO" raw \
			set_network proto wpa-proto
		
		wpa_cli_do "$IF_WPA_AUTH_ALG" raw \
			set_network auth_alg wpa-auth-alg
		
		wpa_cli_do "$IF_WPA_SCAN_SSID" raw \
			set_network scan_ssid wpa-scan-ssid
		
		wpa_cli_do "$IF_WPA_IDENTITY" ascii \
			set_network identity wpa-identity
		
		wpa_cli_do "$IF_WPA_ANONYMOUS_IDENTITY" ascii \
			set_network anonymous_identity wpa-anonymous-identity
		
		wpa_cli_do "$IF_WPA_EAP" raw \
			set_network eap wpa-eap
		
		wpa_cli_do "$IF_WPA_EAPPSK" raw \
			set_network eappsk wpa-eappsk

		wpa_cli_do "$IF_WPA_NAI" ascii \
			set_network nai wpa-nai

		wpa_cli_do "$IF_WPA_PASSWORD" ascii \
			set_network password wpa-password

		wpa_cli_do "$IF_WPA_CA_CERT" ascii \
			set_network ca_cert wpa-ca-cert

		wpa_cli_do "$IF_WPA_CA_PATH" ascii \
			set_network ca_path wpa-ca-path

		wpa_cli_do "$IF_WPA_CLIENT_CERT" ascii \
			set_network client_cert wpa-client-cert

		wpa_cli_do "$IF_WPA_PRIVATE_KEY" ascii \
			set_network private_key wpa-private-key

		wpa_cli_do "$IF_WPA_PRIVATE_KEY_PASSWD" ascii \
			set_network private_key_passwd wpa-private-key-passwd
		
		wpa_cli_do "$IF_WPA_DH_FILE" ascii \
			set_network dh_file wpa-dh-file

		wpa_cli_do "$IF_WPA_SUBJECT_MATCH" ascii \
			set_network subject_match wpa-subject-match

		wpa_cli_do "$IF_WPA_ALTSUBJECT_MATCH" ascii \
			set_network altsubject_match wpa-altsubject-match

		wpa_cli_do "$IF_WPA_CA_CERT2" ascii \
			set_network ca_cert2 wpa-ca-cert2

		wpa_cli_do "$IF_WPA_CA_PATH2" ascii \
			set_network ca_path2 wpa-ca-path2

		wpa_cli_do "$IF_WPA_CLIENT_CERT2" ascii \
			set_network client_cert2 wpa-client-cert2

		wpa_cli_do "$IF_WPA_PRIVATE_KEY2" ascii \
			set_network private_key2 wpa-private-key2

		wpa_cli_do "$IF_WPA_PRIVATE_KEY_PASSWD2" ascii \
			set_network private_key_passwd2 wpa-private-key-passwd2
		
		wpa_cli_do "$IF_WPA_DH_FILE2" ascii \
			set_network dh_file2 wpa-dh-file2

		wpa_cli_do "$IF_WPA_SUBJECT_MATCH2" ascii \
			set_network subject_match2 wpa-subject-match2

		wpa_cli_do "$IF_WPA_ALTSUBJECT_MATCH2" ascii \
			set_network altsubject_match2 wpa-altsubject-match2
		
		wpa_cli_do "$IF_WPA_EAP_METHODS" raw \
			set_network eap_methods wpa-eap-methods

		wpa_cli_do "$IF_WPA_PHASE1" ascii \
			set_network phase1 wpa-phase1

		wpa_cli_do "$IF_WPA_PHASE2" ascii \
			set_network phase2 wpa-phase2

		wpa_cli_do "$IF_WPA_PCSC" raw \
			set_network pcsc wpa-pcsc

		wpa_cli_do "$IF_WPA_PIN" ascii \
			set_network pin wpa-pin

		wpa_cli_do "$IF_WPA_ENGINE" raw \
			set_network engine wpa-engine

		wpa_cli_do "$IF_WPA_ENGINE_ID" ascii \
			set_network engine_id wpa-engine-id

		wpa_cli_do "$IF_WPA_KEY_ID" ascii \
			set_network key_id wpa-key-id

		wpa_cli_do "$IF_WPA_EAPOL_FLAGS" raw \
			set_network eapol_flags wpa-eapol-flags
		
		if [ -n "$IF_WPA_WEP_KEY0" ]; then
			wpa_key_check_and_set "$IF_WPA_WEP_KEY0" \
				wep_key0 wpa-wep-key0
		fi
		
		if [ -n "$IF_WPA_WEP_KEY1" ]; then
			wpa_key_check_and_set "$IF_WPA_WEP_KEY1" \
				wep_key1 wpa-wep-key1
		fi

		if [ -n "$IF_WPA_WEP_KEY2" ]; then
			wpa_key_check_and_set "$IF_WPA_WEP_KEY2" \
				wep_key2 wpa-wep-key2
		fi

		if [ -n "$IF_WPA_WEP_KEY3" ]; then
			wpa_key_check_and_set "$IF_WPA_WEP_KEY3" \
				wep_key3 wpa-wep-key3
		fi
		
		wpa_cli_do "$IF_WPA_WEP_TX_KEYIDX" raw \
			set_network wep_tx_keyidx wpa-wep-tx-keyidx
		
		wpa_cli_do "$IF_WPA_PROACTIVE_KEY_CACHING" raw \
			set_network proactive_key_caching wpa-proactive-key-caching
			
		wpa_cli_do "$IF_WPA_PAC_FILE" ascii \
			set_network pac_file wpa-pac-file
		
		wpa_cli_do "$IF_WPA_MODE" raw \
			set_network mode wpa-mode
		
		wpa_cli_do "$IF_WPA_PEERKEY" raw \
			set_network peerkey wpa-peerkey
			
		wpa_cli_do "$IF_FRAGMENT_SIZE" raw \
			set_network fragment_size wpa-fragment-size

		wpa_cli_do "$IF_WPA_ID_STR" ascii \
			set_network id_str wpa-id-str
		
		wpa_cli_do "$WPA_ID" raw \
			enable_network "enabling network block"
	fi
}

#####################################################################
## wpa_action basic logging
# Log actions to file
#
wpa_log_init () {
	[ -w "$WPA_CLI_LOGFILE" ] || return 0

	exec >> "$WPA_CLI_LOGFILE" 2>&1
}

# log timestamp and wpa_action arguments
wpa_log_action () {
	[ -w "$WPA_CLI_LOGFILE" ] || return 0

	local DATE
	
	DATE=$(date +"%H:%M:%S  %Y-%m-%d")
	echo "########## $DATE ##########"
	echo "IFACE=$WPA_IFACE ACTION=$WPA_ACTION"
}

# log wpa_cli environment variables
wpa_log_environment () {
	[ -w "$WPA_CLI_LOGFILE" ] || return 0

	echo "WPA_ID=$WPA_ID WPA_ID_STR=$WPA_ID_STR"
	echo "WPA_CTRL_DIR=$WPA_CTRL_DIR"
}

#####################################################################
## hysteresis checking
# Networking tools such as dhcp clients used with ifupdown can
# synthesize artificial ACTION events, particuarly just after a
# DISCONNECTED/CONNECTED events are experienced in quick succession.
# This can lead to infinite event loops, and in extreme cases has the
# potential to cause system instability.
#
wpa_hysteresis_event () {
	local TIME

	TIME=$(date +%s)
	echo "$TIME" > "$WPA_CLI_TIMESTAMP"
}

wpa_hysteresis_check () {
	if [ -f "$WPA_CLI_TIMESTAMP" ]; then
		local TIME
		local TIMESTAMP
		local TIMEWAIT
		TIME=$(date +%s)
		# current time minus 4 second event buffer
		TIMEWAIT=$(($TIME-4))
		# get time of last event
		TIMESTAMP=$(cat $WPA_CLI_TIMESTAMP)
		# compare values, allowing new action to be processed 
		# only if last action was more than 4 seconds ago
		if [ "$TIMEWAIT" -le "$TIMESTAMP" ]; then
			echo "Ignoring $WPA_ACTION event, too soon after previous event"
			return 1
		fi
	fi

	return 0
}

#####################################################################
## identify ifupdown files
# Identify ifupdown core files, so that state of the interface can be
# checked. This is the weakest part of the wpa_action roaming scheme,
# it would be _much_ better if stateless ifupdown capabilities were
# a reality.
#
ifupdown_check () {
	if [ -e /etc/network/interfaces ]; then
		INTERFACES_FILE="/etc/network/interfaces"
	else
		echo "Cannot locate ifupdown's \"interfaces\" file, $WPA_IFACE will not be configured"
		return 1
	fi

	if [ -e /etc/network/run/ifstate ]; then
		# debian's ifupdown
		IFSTATE_FILE="/etc/network/run/ifstate"
	elif [ -e /var/run/network/ifstate ]; then
		# ubuntu's
		IFSTATE_FILE="/var/run/network/ifstate"
	else
		echo "Cannot locate ifupdown's \"ifstate\" file, $WPA_IFACE will not be configured"
		return 1
	fi

	return 0
}

ifupdown_status () {
	if grep -s -q "^${WPA_IFACE}=${WPA_LOGICAL_IFACE}" "$IFSTATE_FILE"; then
		return 0
	fi

	echo "Interface \"$WPA_IFACE\" failed to establish a connection."
	echo "Attempting reassociation..."
	return 1
}

ifupdown_lock () {
	ln -s lock "$WPA_CLI_IFUPDOWN"
}

ifupdown_locked () {
	[ -L "$WPA_CLI_IFUPDOWN" ] && return 0

	return 1
}

ifupdown_unlock () {
	rm -f "$WPA_CLI_IFUPDOWN"
}

#####################################################################
## apply mapping logic and ifup logical interface
# Apply mapping logic via id_str or external mapping script, check
# state of IFACE with respect to ifupdown and ifup logical interaface
#
ifup () {
	local WPA_LOGICAL_IFACE
	
	if [ -z "$IF_WPA_MAPPING_SCRIPT_PRIORITY" ] && [ -n "$WPA_ID_STR" ]; then
		WPA_LOGICAL_IFACE="$WPA_ID_STR"
		echo "Mapping logical interface via id_str: $WPA_LOGICAL_IFACE"
	fi
	
	if [ -z "$WPA_LOGICAL_IFACE" ] && [ -n "$IF_WPA_MAPPING_SCRIPT" ]; then
		echo "Mapping logical interface via wpa-mapping-script: $IF_WPA_MAPPING_SCRIPT"
		
		local WPA_MAP_STDIN
		
		WPA_MAP_STDIN=$(set | sed -n 's/^\(IF_WPA_MAP[0-9]*\)=.*/echo \$\1/p')
		
		if [ -n "$WPA_MAP_STDIN" ]; then
			WPA_LOGICAL_IFACE=$(eval "$WPA_MAP_STDIN" | "$IF_WPA_MAPPING_SCRIPT" "$WPA_IFACE")
		else		
			WPA_LOGICAL_IFACE=$("$IF_WPA_MAPPING_SCRIPT" "$WPA_IFACE")
		fi
		
		if [ -n "$WPA_LOGICAL_IFACE" ]; then
			echo "Mapping script result: $WPA_LOGICAL_IFACE"
		else
			echo "Mapping script failed."
		fi
	fi

	if [ -z "$WPA_LOGICAL_IFACE" ]; then
		if [ -n "$IF_WPA_ROAM_DEFAULT_IFACE" ]; then
			WPA_LOGICAL_IFACE="$IF_WPA_ROAM_DEFAULT_IFACE"
			echo "Using wpa-roam-default-iface: $WPA_LOGICAL_IFACE"
		else
			WPA_LOGICAL_IFACE="default"
			echo "Using fallback logical interface: $WPA_LOGICAL_IFACE"
		fi
	fi

	if [ -n "$WPA_LOGICAL_IFACE" ]; then
		if egrep -q "^iface[[:space:]]+${WPA_LOGICAL_IFACE}[[:space:]]+inet" "$INTERFACES_FILE"; then
			: # logical network is defined
		else
			echo "No network defined for \"$WPA_LOGICAL_IFACE\" in \"$INTERFACES_FILE\""
			echo "Trying to configure the \"default\" network instead ..."
			WPA_LOGICAL_IFACE="default"
		fi
			
		echo "ifup $WPA_IFACE=$WPA_LOGICAL_IFACE"

		ifupdown_lock
		
		if grep -q "^$WPA_IFACE=$WPA_IFACE" "$IFSTATE_FILE"; then
			# Force settings over the unconfigured "master" IFACE
			/sbin/ifup -v --force "$WPA_IFACE=$WPA_LOGICAL_IFACE"
		else
			/sbin/ifup -v "$WPA_IFACE=$WPA_LOGICAL_IFACE"
		fi

		ifupdown_unlock
	else
		echo "No suitable logical interface mapping for ifupdown to configure"
	fi
}

#####################################################################
## ifdown IFACE
# Check IFACE state and ifdown as requested.
#
ifdown () {
	if grep -q "^$WPA_IFACE" "$IFSTATE_FILE"; then
		ifupdown_lock

		echo "ifdown $WPA_IFACE"
		/sbin/ifdown -v "$WPA_IFACE"

		ifupdown_unlock
	else
		echo "Ignoring request to take \"$WPA_IFACE\" down, it is not up"
	fi
}

#####################################################################
## keep IFACE scanning
# After ifdown, the IFACE may be left "down", and inhibits 
# wpa_supplicant's ability to continue roaming.
#
# NB: use iproute if present, flushing the IFACE first
#
if_post_down_up () {
	if type ip >/dev/null; then
		ip addr flush dev "$WPA_IFACE" 2>/dev/null
		ip link set "$WPA_IFACE" up
	else
		ifconfig "$WPA_IFACE" up
	fi
}