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
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
|
<?php
/*
captiveportal.inc
part of m0n0wall (http://m0n0.ch/wall)
Copyright (C) 2003-2006 Manuel Kasper <mk@neon1.net>.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
This version of captiveportal.inc has been modified by Rob Parker
<rob.parker@keycom.co.uk> to include changes for per-user bandwidth management
via returned RADIUS attributes. This page has been modified to delete any
added rules which may have been created by other per-user code (index.php, etc).
These changes are (c) 2004 Keycom PLC.
*/
/* include all configuration functions */
require_once("functions.inc");
require_once("globals.inc");
require_once("radius_authentication.inc");
require_once("radius_accounting.inc");
require_once("radius.inc");
$lockfile = "{$g['varrun_path']}/captiveportal.lock";
function captiveportal_configure() {
global $config, $g;
if (isset($config['captiveportal']['enable']) &&
(($config['captiveportal']['interface'] == "lan") ||
isset($config['interfaces'][$config['captiveportal']['interface']]['enable']))) {
if ($g['booting'])
echo "Starting captive portal... ";
/* kill any running mini_httpd */
killbypid("{$g['varrun_path']}/lighty-CaptivePortal.pid");
killbypid("{$g['varrun_path']}/lighty-CaptivePortal-SSL.pid");
/* kill any running minicron */
killbypid("{$g['varrun_path']}/minicron.pid");
/* generate ipfw rules */
$cprules = captiveportal_rules_generate();
/* make sure ipfw is loaded */
mwexec("/sbin/kldload ipfw");
/* stop accounting on all clients */
captiveportal_radius_stop_all();
/* initialize minicron interval value */
$croninterval = $config['captiveportal']['croninterval'] ? $config['captiveportal']['croninterval'] : 60;
/* double check if the $croninterval is numeric and at least 10 seconds. If not we set it to 60 to avoid problems */
if ((!is_numeric($croninterval)) || ($croninterval < 10)) { $croninterval = 60; }
/* remove old information */
unlink_if_exists("{$g['vardb_path']}/captiveportal.nextrule");
unlink_if_exists("{$g['vardb_path']}/captiveportal.db");
unlink_if_exists("{$g['vardb_path']}/captiveportal_mac.db");
unlink_if_exists("{$g['vardb_path']}/captiveportal_ip.db");
unlink_if_exists("{$g['vardb_path']}/captiveportal_radius.db");
/* write portal page */
if ($config['captiveportal']['page']['htmltext'])
$htmltext = base64_decode($config['captiveportal']['page']['htmltext']);
else {
/* example/template page */
$htmltext = <<<EOD
<html>
<head>
<title>pfSense captive portal</title>
</head>
<body>
<center>
<h2>pfSense captive portal</h2>
Welcome to the pfSense Captive Portal! This is the default page since a custom page has not been defined.
<p>
<form method="post" action="\$PORTAL_ACTION\$">
<input name="redirurl" type="hidden" value="\$PORTAL_REDIRURL\$">
<table>
<tr><td>Username:</td><td><input name="auth_user" type="text"></td></tr>
<tr><td>Password:</td><td><input name="auth_pass" type="password"></td></tr>
<tr><td> </td></tr>
<tr>
<td colspan="2">
<center><input name="accept" type="submit" value="Continue"></center>
</td>
</tr>
</table>
</center>
</form>
</body>
</html>
EOD;
}
$fd = @fopen("{$g['varetc_path']}/captiveportal.html", "w");
if ($fd) {
fwrite($fd, $htmltext);
fclose($fd);
}
/* write error page */
if ($config['captiveportal']['page']['errtext'])
$errtext = base64_decode($config['captiveportal']['page']['errtext']);
else {
/* example page */
$errtext = <<<EOD
<html>
<head>
<title>Authentication error</title>
</head>
<body>
<font color="#cc0000"><h2>Authentication error</h2></font>
<b>
Username and/or password invalid.
<br><br>
<a href="javascript:history.back()">Go back</a>
</b>
</body>
</html>
EOD;
}
$fd = @fopen("{$g['varetc_path']}/captiveportal-error.html", "w");
if ($fd) {
fwrite($fd, $errtext);
fclose($fd);
}
/* write elements */
captiveportal_write_elements();
/* load rules */
mwexec("/sbin/ipfw -f delete set 1");
mwexec("/sbin/ipfw -f delete set 2");
mwexec("/sbin/ipfw -f delete set 3");
/* ipfw cannot accept rules directly on stdin,
so we have to write them to a temporary file first */
$fd = @fopen("{$g['tmp_path']}/ipfw.cp.rules", "w");
if (!$fd) {
printf("Cannot open ipfw.cp.rules in captiveportal_configure()\n");
return 1;
}
fwrite($fd, $cprules);
fclose($fd);
mwexec("/sbin/ipfw {$g['tmp_path']}/ipfw.cp.rules");
unlink("{$g['tmp_path']}/ipfw.cp.rules");
/* filter on layer2 as well so we can check MAC addresses */
mwexec("/sbin/sysctl net.link.ether.ipfw=1");
chdir($g['captiveportal_path']);
if ($config['captiveportal']['maxproc'])
$maxproc = $config['captiveportal']['maxproc'];
else
$maxproc = 16;
$use_fastcgi = true;
if(isset($config['captiveportal']['httpslogin'])) {
$cert = base64_decode($config['captiveportal']['certificate']);
$key = base64_decode($config['captiveportal']['private-key']);
/* generate lighttpd configuration */
system_generate_lighty_config("{$g['varetc_path']}/lighty-CaptivePortal-SSL.conf",
$cert, $key, "lighty-CaptivePortal-ssl.pid", "8001", "/usr/local/captiveportal/",
"cert-portal.pem", "1", $maxproc, $use_fastcgi, true);
}
/* generate lighttpd configuration */
system_generate_lighty_config("{$g['varetc_path']}/lighty-CaptivePortal.conf",
"", "", "lighty-CaptivePortal.pid", "8000", "/usr/local/captiveportal/",
"cert-portal.pem", "1", $maxproc, $use_fastcgi, true);
/* attempt to start lighttpd */
$res = mwexec("/usr/local/sbin/lighttpd -f {$g['varetc_path']}/lighty-CaptivePortal.conf");
/* fire up https instance */
if(isset($config['captiveportal']['httpslogin']))
$res = mwexec("/usr/local/sbin/lighttpd -f {$g['varetc_path']}/lighty-CaptivePortal-SSL.conf");
/* start pruning process (interval defaults to 60 seconds) */
mwexec("/usr/local/bin/minicron $croninterval {$g['varrun_path']}/minicron.pid " .
"/etc/rc.prunecaptiveportal");
/* generate passthru mac database */
captiveportal_passthrumac_configure();
/* create allowed ip database and insert ipfw rules to make it so */
captiveportal_allowedip_configure();
/* generate radius server database */
if ($config['captiveportal']['radiusip'] && (!isset($config['captiveportal']['auth_method']) ||
($config['captiveportal']['auth_method'] == "radius"))) {
$radiusip = $config['captiveportal']['radiusip'];
$radiusip2 = ($config['captiveportal']['radiusip2']) ? $config['captiveportal']['radiusip2'] : null;
if ($config['captiveportal']['radiusport'])
$radiusport = $config['captiveportal']['radiusport'];
else
$radiusport = 1812;
if ($config['captiveportal']['radiusacctport'])
$radiusacctport = $config['captiveportal']['radiusacctport'];
else
$radiusacctport = 1813;
if ($config['captiveportal']['radiusport2'])
$radiusport2 = $config['captiveportal']['radiusport2'];
else
$radiusport2 = 1812;
$radiuskey = $config['captiveportal']['radiuskey'];
$radiuskey2 = ($config['captiveportal']['radiuskey2']) ? $config['captiveportal']['radiuskey2'] : null;
$fd = @fopen("{$g['vardb_path']}/captiveportal_radius.db", "w");
if (!$fd) {
printf("Error: cannot open radius DB file in captiveportal_configure().\n");
return 1;
} else if (isset($radiusip2, $radiuskey2)) {
fwrite($fd,$radiusip . "," . $radiusport . "," . $radiusacctport . "," . $radiuskey . "\n"
. $radiusip2 . "," . $radiusport2 . "," . $radiusacctport . "," . $radiuskey2);
} else {
fwrite($fd,$radiusip . "," . $radiusport . "," . $radiusacctport . "," . $radiuskey);
}
fclose($fd);
}
if ($g['booting'])
echo "done\n";
} else {
killbypid("{$g['varrun_path']}/lighty-CaptivePortal.pid");
killbypid("{$g['varrun_path']}/minicron.pid");
captiveportal_radius_stop_all();
mwexec("/sbin/sysctl net.link.ether.ipfw=0");
if (!isset($config['shaper']['enable'])) {
/* unload ipfw */
$installed_time_based_rules = false;
if($config['schedules']) {
foreach($config['schedules']['schedule'] as $sched) {
$installed_time_based_rules = true;
}
}
if($installed_time_based_rules == false)
mwexec("/sbin/kldunload ipfw", true);
} else {
/* shaper is on - just remove our rules */
mwexec("/sbin/ipfw -f delete set 1");
mwexec("/sbin/ipfw -f delete set 2");
mwexec("/sbin/ipfw -f delete set 3");
}
}
captiveportal_unlock();
return 0;
}
function captiveportal_rules_generate() {
global $config, $g;
$cpifn = $config['captiveportal']['interface'];
$cpif = $config['interfaces'][$cpifn]['if'];
$cpip = $config['interfaces'][$cpifn]['ipaddr'];
$lanip = $config['interfaces']['lan']['ipaddr'];
/* note: the captive portal daemon inserts all pass rules for authenticated
clients as skipto 50000 rules to make traffic shaping work */
$cprules = "add 500 set 1 allow pfsync from any to any\n";
$cprules .= "add 500 set 1 allow carp from any to any\n";
/* allow nat redirects to work see
http://cvstrac.pfsense.com/tktview?tn=651
*/
$iflist = array("lan" => "LAN", "wan" => "WAN");
$captive_portal_interface = strtoupper($cpifn);
for ($i = 1; isset($config['interfaces']['opt' . $i]); $i++)
$iflist['opt' . $i] = "OPT{$i}";
foreach ($iflist as $ifent => $ifname) {
if($captive_portal_interface == strtoupper($ifname))
continue;
$int = convert_friendly_interface_to_real_interface_name($ifname);
$cprules .= "add 30 set 1 skipto 50000 all from any to any in via {$int} keep-state\n";
}
/* captive portal on LAN interface? */
if ($cpifn == "lan") {
/* add anti-lockout rules */
$cprules .= <<<EOD
add 500 set 1 pass all from $cpip to any out via $cpif
add 501 set 1 pass all from any to $cpip in via $cpif
EOD;
}
$cprules .= <<<EOD
# skip to traffic shaper if not on captive portal interface
add 1000 set 1 skipto 50000 all from any to any not layer2 not via $cpif
# pass all layer2 traffic on other interfaces
add 1001 set 1 pass layer2 not via $cpif
# layer 2: pass ARP
add 1100 set 1 pass layer2 mac-type arp
# pfsense requires for WPA
add 1100 set 1 pass layer2 mac-type 0x888e
add 1100 set 1 pass layer2 mac-type 0x88c7
# PPP Over Ethernet Discovery Stage
add 1100 set 1 pass layer2 mac-type 0x8863
# PPP Over Ethernet Session Stage
add 1100 set 1 pass layer2 mac-type 0x8864
# layer 2: block anything else non-IP
add 1101 set 1 deny layer2 not mac-type ip
# layer 2: check if MAC addresses of authenticated clients are correct
add 1102 set 1 skipto 20000 layer2
# allow access to our DHCP server (which needs to be able to ping clients as well)
add 1200 set 1 pass udp from any 68 to 255.255.255.255 67 in
add 1201 set 1 pass udp from any 68 to $cpip 67 in
add 1202 set 1 pass udp from $cpip 67 to any 68 out
add 1203 set 1 pass icmp from $cpip to any out icmptype 8
add 1204 set 1 pass icmp from any to $cpip in icmptype 0
# allow access to our DNS forwarder
add 1300 set 1 pass udp from any to $cpip 53 in
add 1301 set 1 pass udp from $cpip 53 to any out
# allow access to our DNS forwarder if it incorrectly resolves the hostname to $lanip
add 1300 set 1 pass udp from any to $lanip 53 in
add 1301 set 1 pass udp from $lanip 53 to any out
# allow access to our web server
add 1302 set 1 pass tcp from any to $cpip 8000 in
add 1303 set 1 pass tcp from $cpip 8000 to any out
# allow access to lan web server incase the dns name resolves incorrectly to $lanip
add 1302 set 1 pass tcp from any to $lanip 8000 in
add 1303 set 1 pass tcp from $lanip 8000 to any out
EOD;
if (isset($config['captiveportal']['httpslogin'])) {
$cprules .= <<<EOD
add 1304 set 1 pass tcp from any to $cpip 8001 in
add 1305 set 1 pass tcp from $cpip 8001 to any out
add 1306 set 1 pass tcp from any to $lanip 8001 in
add 1307 set 1 pass tcp from $lanip 8001 to any out
EOD;
}
$cprules .= <<<EOD
#PPPoE Discovery Stage
add 1100 set 1 pass layer2 mac-type 0x8863
#PPPoE Session Stage
add 1100 set 1 pass layer2 mac-type 0x8864
EOD;
$cprules .= <<<EOD
# Allow WPA
add 1100 set 1 pass layer2 mac-type 0x888e
EOD;
$cprules .= <<<EOD
# ... 10000-19899: rules per authenticated client go here...
# redirect non-authenticated clients to captive portal
add 19902 set 1 fwd 127.0.0.1,8000 tcp from any to any 80 in
# let the responses from the captive portal web server back out
add 19903 set 1 pass tcp from any 80 to any out
# block everything else
add 19904 set 1 deny all from any to any
# ... 20000-29899: layer2 block rules per authenticated client go here...
# pass everything else on layer2
add 29900 set 1 pass all from any to any layer2
EOD;
return $cprules;
}
/* remove clients that have been around for longer than the specified amount of time */
/* db file structure:
timestamp,ipfw_rule_no,clientip,clientmac,username,sessionid,password,session_timeout,idle_timeout,session_terminate_time */
/* (password is in Base64 and only saved when reauthentication is enabled) */
function captiveportal_prune_old() {
global $g, $config;
/* check for expired entries */
if ($config['captiveportal']['timeout'])
$timeout = $config['captiveportal']['timeout'] * 60;
else
$timeout = 0;
if ($config['captiveportal']['idletimeout'])
$idletimeout = $config['captiveportal']['idletimeout'] * 60;
else
$idletimeout = 0;
if (!$timeout && !$idletimeout && !isset($config['captiveportal']['reauthenticate']) && !isset($config['captiveportal']['radiussession_timeout']))
return;
captiveportal_lock();
/* read database */
$cpdb = captiveportal_read_db();
$radiusservers = captiveportal_get_radius_servers();
/* To make sure we iterate over ALL accounts on every run the count($cpdb) is moved outside of the loop. Otherwise
* the loop would evalate count() on every iteration and since $i would increase and count() would decrement they
* would meet before we had a chance to iterate over all accounts.
*/
$no_users = count($cpdb);
for ($i = 0; $i < $no_users; $i++) {
$timedout = false;
$term_cause = 1;
/* no pruning for fixed mac address entry */
if (portal_mac_fixed($cpdb[$i][3])) {
continue; // check next value
}
/* hard timeout? */
if ($timeout) {
if ((time() - $cpdb[$i][0]) >= $timeout) {
$timedout = true;
$term_cause = 5; // Session-Timeout
}
}
/* Session-Terminate-Time */
if (!$timedout && !empty($cpdb[$i][9])) {
if (time() >= $cpdb[$i][9]) {
$timedout = true;
$term_cause = 5; // Session-Timeout
}
}
/* check if the radius idle_timeout attribute has been set and if its set change the idletimeout to this value */
$idletimeout = (is_numeric($cpdb[$i][8])) ? $cpdb[$i][8] : $idletimeout;
/* if an idle timeout is specified, get last activity timestamp from ipfw */
if (!$timedout && $idletimeout) {
$lastact = captiveportal_get_last_activity($cpdb[$i][1]);
/* if the user has logged on but not sent any trafic they will never be logged out.
* We "fix" this by setting lastact to the login timestamp
*/
$lastact = $lastact ? $lastact : $cpdb[$i][0];
if ($lastact && ((time() - $lastact) >= $idletimeout)) {
$timedout = true;
$term_cause = 4; // Idle-Timeout
$stop_time = $lastact; // Entry added to comply with WISPr
}
}
/* if radius session_timeout is enabled and the session_timeout is not null, then check if the user should be logged out */
if (!$timedout && isset($config['captiveportal']['radiussession_timeout']) && !empty($cpdb[$i][7])) {
if (time() >= ($cpdb[$i][0] + $cpdb[$i][7])) {
$timedout = true;
$term_cause = 5; // Session-Timeout
}
}
if ($timedout) {
captiveportal_disconnect($cpdb[$i], $radiusservers,$term_cause,$stop_time);
captiveportal_logportalauth($cpdb[$i][4], $cpdb[$i][3], $cpdb[$i][2], "TIMEOUT");
unset($cpdb[$i]);
}
/* do periodic RADIUS reauthentication? */
if (!$timedout && isset($config['captiveportal']['reauthenticate']) &&
($radiusservers !== false)) {
if (isset($config['captiveportal']['radacct_enable'])) {
if ($config['captiveportal']['reauthenticateacct'] == "stopstart") {
/* stop and restart accounting */
RADIUS_ACCOUNTING_STOP($cpdb[$i][1], // ruleno
$cpdb[$i][4], // username
$cpdb[$i][5], // sessionid
$cpdb[$i][0], // start time
$radiusservers[0]['ipaddr'],
$radiusservers[0]['acctport'],
$radiusservers[0]['key'],
$cpdb[$i][2], // clientip
$cpdb[$i][3], // clientmac
10); // NAS Request
exec("/sbin/ipfw zero {$cpdb[$i][1]}");
RADIUS_ACCOUNTING_START($cpdb[$i][1], // ruleno
$cpdb[$i][4], // username
$cpdb[$i][5], // sessionid
$radiusservers[0]['ipaddr'],
$radiusservers[0]['acctport'],
$radiusservers[0]['key'],
$cpdb[$i][2], // clientip
$cpdb[$i][3]); // clientmac
} else if ($config['captiveportal']['reauthenticateacct'] == "interimupdate") {
RADIUS_ACCOUNTING_STOP($cpdb[$i][1], // ruleno
$cpdb[$i][4], // username
$cpdb[$i][5], // sessionid
$cpdb[$i][0], // start time
$radiusservers[0]['ipaddr'],
$radiusservers[0]['acctport'],
$radiusservers[0]['key'],
$cpdb[$i][2], // clientip
$cpdb[$i][3], // clientmac
10, // NAS Request
true); // Interim Updates
}
}
/* check this user against RADIUS again */
$auth_list = RADIUS_AUTHENTICATION($cpdb[$i][4], // username
base64_decode($cpdb[$i][6]), // password
$radiusservers,
$cpdb[$i][2], // clientip
$cpdb[$i][3], // clientmac
$cpdb[$i][1]); // ruleno
if ($auth_list['auth_val'] == 3) {
captiveportal_disconnect($cpdb[$i], $radiusservers, 17);
captiveportal_logportalauth($cpdb[$i][4], $cpdb[$i][3], $cpdb[$i][2], "RADIUS_DISCONNECT", $auth_list['reply_message']);
unset($cpdb[$i]);
}
}
}
/* write database */
captiveportal_write_db($cpdb);
captiveportal_unlock();
}
/* remove a single client according to the DB entry */
function captiveportal_disconnect($dbent, $radiusservers,$term_cause = 1,$stop_time = null) {
global $g, $config;
$stop_time = (empty($stop_time)) ? time() : $stop_time;
/* this client needs to be deleted - remove ipfw rules */
if (isset($config['captiveportal']['radacct_enable']) && isset($radiusservers[0])) {
RADIUS_ACCOUNTING_STOP($dbent[1], // ruleno
$dbent[4], // username
$dbent[5], // sessionid
$dbent[0], // start time
$radiusservers[0]['ipaddr'],
$radiusservers[0]['acctport'],
$radiusservers[0]['key'],
$dbent[2], // clientip
$dbent[3], // clientmac
$term_cause, // Acct-Terminate-Cause
false,
$stop_time);
}
mwexec("/sbin/ipfw delete " . $dbent[1] . " " . ($dbent[1]+10000));
/* We need to delete +40500 and +45500 as well...
* these are the pipe numbers we use to control traffic shaping for each logged in user via captive portal
* We could get an error if the pipe doesn't exist but everything should still be fine
*/
if (isset($config['captiveportal']['peruserbw'])) {
mwexec("/sbin/ipfw pipe " . ($dbent[1]+40500) . " delete");
mwexec("/sbin/ipfw pipe " . ($dbent[1]+45500) . " delete");
}
/* pfSense: ensure all pf states are killed (pfSense) */
mwexec("pfctl -k {$dbent[2]}");
}
/* remove a single client by ipfw rule number */
function captiveportal_disconnect_client($id,$term_cause = 1) {
global $g, $config;
captiveportal_lock();
/* read database */
$cpdb = captiveportal_read_db();
$radiusservers = captiveportal_get_radius_servers();
/* find entry */
for ($i = 0; $i < count($cpdb); $i++) {
if ($cpdb[$i][1] == $id) {
captiveportal_disconnect($cpdb[$i], $radiusservers, $term_cause);
captiveportal_logportalauth($cpdb[$i][4], $cpdb[$i][3], $cpdb[$i][2], "DISCONNECT");
unset($cpdb[$i]);
break;
}
}
/* write database */
captiveportal_write_db($cpdb);
captiveportal_unlock();
}
/* send RADIUS acct stop for all current clients */
function captiveportal_radius_stop_all() {
global $g, $config;
if (!isset($config['captiveportal']['radacct_enable']))
return;
captiveportal_lock();
$cpdb = captiveportal_read_db();
$radiusservers = captiveportal_get_radius_servers();
if (isset($radiusservers[0])) {
for ($i = 0; $i < count($cpdb); $i++) {
RADIUS_ACCOUNTING_STOP($cpdb[$i][1], // ruleno
$cpdb[$i][4], // username
$cpdb[$i][5], // sessionid
$cpdb[$i][0], // start time
$radiusservers[0]['ipaddr'],
$radiusservers[0]['acctport'],
$radiusservers[0]['key'],
$cpdb[$i][2], // clientip
$cpdb[$i][3], // clientmac
7); // Admin Reboot
}
}
captiveportal_unlock();
}
function captiveportal_passthrumac_configure() {
global $config, $g;
captiveportal_lock();
/* clear out passthru macs, if necessary */
unlink_if_exists("{$g['vardb_path']}/captiveportal_mac.db");
if (is_array($config['captiveportal']['passthrumac'])) {
$fd = @fopen("{$g['vardb_path']}/captiveportal_mac.db", "w");
if (!$fd) {
printf("Error: cannot open passthru mac DB file in captiveportal_passthrumac_configure().\n");
captiveportal_unlock();
return 1;
}
foreach ($config['captiveportal']['passthrumac'] as $macent) {
/* record passthru mac so it can be recognized and let thru */
fwrite($fd, $macent['mac'] . "\n");
}
fclose($fd);
}
/* pfSense:
* pass through mac entries should always exist. the reason
* for this is because we do not have native mac address filtering
* mechanisms. this allows us to filter by mac address easily
* and get around this limitation. I consider this a bug in
* m0n0wall and pfSense as m0n0wall does not have native mac
* filtering mechanisms as well. -Scott Ullrich
*/
if (is_array($config['captiveportal']['passthrumac'])) {
mwexec("/sbin/ipfw delete 50");
foreach($config['captiveportal']['passthrumac'] as $ptm) {
/* create the pass through mac entry */
//system("echo /sbin/ipfw add 50 skipto 65535 ip from any to any MAC {$ptm['mac']} any > /tmp/cp");
mwexec("/sbin/ipfw add 50 skipto 29900 ip from any to any MAC {$ptm['mac']} any keep-state");
mwexec("/sbin/ipfw add 50 skipto 29900 ip from any to any MAC any {$ptm['mac']} keep-state");
}
}
captiveportal_unlock();
return 0;
}
function captiveportal_allowedip_configure() {
global $config, $g;
captiveportal_lock();
/* clear out existing allowed ips, if necessary */
if (file_exists("{$g['vardb_path']}/captiveportal_ip.db")) {
$fd = @fopen("{$g['vardb_path']}/captiveportal_ip.db", "r");
if ($fd) {
while (!feof($fd)) {
$line = trim(fgets($fd));
if ($line) {
list($ip,$rule) = explode(",",$line);
mwexec("/sbin/ipfw delete $rule");
}
}
}
fclose($fd);
unlink("{$g['vardb_path']}/captiveportal_ip.db");
}
/* get next ipfw rule number */
if (file_exists("{$g['vardb_path']}/captiveportal.nextrule"))
$ruleno = trim(file_get_contents("{$g['vardb_path']}/captiveportal.nextrule"));
if (!$ruleno)
$ruleno = 10000; /* first rule number */
if (is_array($config['captiveportal']['allowedip'])) {
$fd = @fopen("{$g['vardb_path']}/captiveportal_ip.db", "w");
if (!$fd) {
printf("Error: cannot open allowed ip DB file in captiveportal_allowedip_configure().\n");
captiveportal_unlock();
return 1;
}
foreach ($config['captiveportal']['allowedip'] as $ipent) {
/* get next ipfw rule number */
$ruleno = captiveportal_get_next_ipfw_ruleno();
/* if the pool is empty, return apprioriate message and fail */
if (is_null($ruleno)) {
printf("Error: system reached maximum login capacity, no free FW rulenos in captiveportal_allowedip_configure().\n");
fclose($fd);
captiveportal_unlock();
return 1;
}
/* record allowed ip so it can be recognized and removed later */
fwrite($fd, $ipent['ip'] . "," . $ruleno ."\n");
/* insert ipfw rule to allow ip thru */
if ($ipent['dir'] == "from") {
mwexec("/sbin/ipfw add $ruleno set 2 skipto 50000 ip from " . $ipent['ip'] . " to any in");
mwexec("/sbin/ipfw add $ruleno set 2 skipto 50000 ip from any to " . $ipent['ip'] . " out");
} else {
mwexec("/sbin/ipfw add $ruleno set 2 skipto 50000 ip from any to " . $ipent['ip'] . " in");
mwexec("/sbin/ipfw add $ruleno set 2 skipto 50000 ip from " . $ipent['ip'] . " to any out");
}
}
fclose($fd);
}
captiveportal_unlock();
return 0;
}
/* get last activity timestamp given ipfw rule number */
function captiveportal_get_last_activity($ruleno) {
$ipfwoutput = "";
exec("/sbin/ipfw -T list {$ruleno} 2>/dev/null", $ipfwoutput);
/* in */
if ($ipfwoutput[0]) {
$ri = explode(" ", $ipfwoutput[0]);
if ($ri[1])
return $ri[1];
}
return 0;
}
/* read RADIUS servers into array */
function captiveportal_get_radius_servers() {
global $g;
if (file_exists("{$g['vardb_path']}/captiveportal_radius.db")) {
$fd = @fopen("{$g['vardb_path']}/captiveportal_radius.db","r");
if ($fd) {
$radiusservers = array();
while (!feof($fd)) {
$line = trim(fgets($fd));
if ($line) {
$radsrv = array();
list($radsrv['ipaddr'],$radsrv['port'],$radsrv['acctport'],$radsrv['key']) = explode(",",$line);
$radiusservers[] = $radsrv;
}
}
fclose($fd);
return $radiusservers;
}
}
return false;
}
/* lock captive portal information, decide that the lock file is stale after
10 minutes and EXIT the process to not risk dataloss, issue warning in syslog every 1 minutes */
function captiveportal_lock() {
global $lockfile;
$n = 1;
while ($n) {
/* open the lock file in append mode to avoid race condition */
if ($fd = @fopen($lockfile, "x")) {
/* succeeded */
fclose($fd);
if($n > 10) {
captiveportal_syslog("LOCKINFO: Waiting for lock for $n seconds/s!");
}
return;
} else {
/* file locked, wait and try again */
sleep(1);
if(($n % 60) == 0) {
captiveportal_syslog("LOCKWARNING: waiting for lock for " . $n/60 . " minute/s!");
if(($n % 600) == 0) {
captiveportal_syslog("LOCKERROR: waiting for lock for 10 minute/s - EXITING PROCESS!");
die("Can't get a lock");
}
}
}
$n++;
}
/* we never get here */
}
/* unlock captive portal information file */
function captiveportal_unlock() {
global $lockfile;
if (file_exists($lockfile))
unlink($lockfile);
}
/* log successful captive portal authentication to syslog */
/* part of this code from php.net */
function captiveportal_logportalauth($user,$mac,$ip,$status, $message = null) {
$message = trim($message);
// Log it
if (!$message)
$message = "$status: $user, $mac, $ip";
else
$message = "$status: $user, $mac, $ip, $message";
captiveportal_syslog($message);
closelog();
}
/* log simple messages to syslog */
function captiveportal_syslog($message) {
define_syslog_variables();
$message = trim($message);
openlog("logportalauth", LOG_PID, LOG_LOCAL4);
// Log it
syslog(LOG_INFO, $message);
closelog();
}
function radius($username,$password,$clientip,$clientmac,$type) {
global $g, $config;
/* Start locking from the beginning of an authentication session */
captiveportal_lock();
$ruleno = captiveportal_get_next_ipfw_ruleno();
/* if the pool is empty, return apprioriate message and fail authentication */
if (is_null($ruleno)) {
$auth_list = array();
$auth_list['auth_val'] = 1;
$auth_list['error'] = "System reached maximum login capacity";
captiveportal_unlock();
return $auth_list;
}
$radiusservers = captiveportal_get_radius_servers();
$auth_list = RADIUS_AUTHENTICATION($username,
$password,
$radiusservers,
$clientip,
$clientmac,
$ruleno);
if ($auth_list['auth_val'] == 2) {
captiveportal_logportalauth($username,$clientmac,$clientip,$type);
$sessionid = portal_allow($clientip,
$clientmac,
$username,
$password,
$auth_list,
$ruleno);
}
else {
captiveportal_unlock();
}
return $auth_list;
}
/* read captive portal DB into array */
function captiveportal_read_db() {
global $g;
$cpdb = array();
$fd = @fopen("{$g['vardb_path']}/captiveportal.db", "r");
if ($fd) {
while (!feof($fd)) {
$line = trim(fgets($fd));
if ($line) {
$cpdb[] = explode(",", $line);
}
}
fclose($fd);
}
return $cpdb;
}
/* write captive portal DB */
function captiveportal_write_db($cpdb) {
global $g;
$fd = @fopen("{$g['vardb_path']}/captiveportal.db", "w");
if ($fd) {
foreach ($cpdb as $cpent) {
fwrite($fd, join(",", $cpent) . "\n");
}
fclose($fd);
}
}
function captiveportal_write_elements() {
global $g, $config;
/* delete any existing elements */
if (is_dir($g['captiveportal_element_path'])) {
$dh = opendir($g['captiveportal_element_path']);
while (($file = readdir($dh)) !== false) {
if ($file != "." && $file != "..")
unlink($g['captiveportal_element_path'] . "/" . $file);
}
closedir($dh);
} else {
mkdir($g['captiveportal_element_path']);
}
if (is_array($config['captiveportal']['element'])) {
conf_mount_rw();
foreach ($config['captiveportal']['element'] as $data) {
$fd = @fopen($g['captiveportal_element_path'] . '/' . $data['name'], "wb");
if (!$fd) {
printf("Error: cannot open '{$data['name']}' in captiveportal_write_elements().\n");
return 1;
}
$decoded = base64_decode($data['content']);
fwrite($fd,$decoded);
fclose($fd);
unlink_if_exists("{$g['captiveportal_path']}/{$data['name']}");
unlink_if_exists("{$g['captiveportal_path']}/{$data['name']}");
mwexec("cd {$g['captiveportal_path']}/ && ln -s {$g['captiveportal_element_path']}/{$data['name']} {$data['name']}");
}
conf_mount_ro();
}
return 0;
}
/*
* This function will calculate the lowest free firewall ruleno
* within the range specified based on the actual installed rules
*
*/
function captiveportal_get_next_ipfw_ruleno($rulenos_start = 10000, $rulenos_range_max = 9899) {
$fwrules = "";
$matches = "";
exec("/sbin/ipfw show", $fwrules);
foreach ($fwrules as $fwrule) {
preg_match("/^(\d+)\s+/", $fwrule, $matches);
$rulenos_used[] = $matches[1];
}
$rulenos_used = array_unique($rulenos_used);
$rulenos_range = count($rulenos_used);
if ($rulenos_range > $rulenos_range_max) {
return NULL;
}
$rulenos_pool = range($rulenos_start, ($rulenos_start + $rulenos_range));
$rulenos_free = array_diff($rulenos_pool, $rulenos_used);
$ruleno = array_shift($rulenos_free);
return $ruleno;
}
/**
* This function will calculate the traffic produced by a client
* based on its firewall rule
*
* Point of view: NAS
*
* Input means: from the client
* Output means: to the client
*
*/
function getVolume($ruleno) {
$volume = array();
// Initialize vars properly, since we don't want NULL vars
$volume['input_pkts'] = $volume['input_bytes'] = $volume['output_pkts'] = $volume['output_bytes'] = 0 ;
// Ingress
$ipfw = "";
$matches = "";
exec("/sbin/ipfw show {$ruleno}", $ipfw);
preg_match("/(\d+)\s+(\d+)\s+(\d+)\s+.*/", $ipfw[0], $matches);
$volume['input_pkts'] = $matches[2];
$volume['input_bytes'] = $matches[3];
// Flush internal buffer
unset($matches);
// Outgress
preg_match("/(\d+)\s+(\d+)\s+(\d+)\s+.*/", $ipfw[1], $matches);
$volume['output_pkts'] = $matches[2];
$volume['output_bytes'] = $matches[3];
return $volume;
}
/**
* Get the NAS-Identifier
*
* We will use our local hostname to make up the nas_id
*/
function getNasID()
{
$nasId = "";
exec("/bin/hostname", $nasId);
if(!$nasId[0])
$nasId[0] = "pfSense";
return $nasId[0];
}
/**
* Get the NAS-IP-Address based on the current wan address
*
* Use functions in interfaces.inc to find this out
*
*/
function getNasIP()
{
$nasIp = get_current_wan_address();
if(!$nasIp)
$nasIp = "0.0.0.0";
return $nasIp;
}
function portal_mac_fixed($clientmac) {
global $g ;
/* open captive portal mac db */
if (file_exists("{$g['vardb_path']}/captiveportal_mac.db")) {
$fd = @fopen("{$g['vardb_path']}/captiveportal_mac.db","r") ;
if (!$fd) {
return FALSE;
}
while (!feof($fd)) {
$mac = trim(fgets($fd)) ;
if(strcasecmp($clientmac, $mac) == 0) {
fclose($fd) ;
return TRUE ;
}
}
fclose($fd) ;
}
return FALSE ;
}
?>
|
