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
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
|
<?php
/*
* util.inc
*
* part of pfSense (https://www.pfsense.org)
* Copyright (c) 2004-2016 Rubicon Communications, LLC (Netgate)
* All rights reserved.
*
* originally part of m0n0wall (http://m0n0.ch/wall)
* Copyright (c) 2003-2004 Manuel Kasper <mk@neon1.net>.
* All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
define('VIP_ALL', 1);
define('VIP_CARP', 2);
define('VIP_IPALIAS', 3);
/* kill a process by pid file */
function killbypid($pidfile) {
return sigkillbypid($pidfile, "TERM");
}
function isvalidpid($pidfile) {
$output = "";
if (file_exists($pidfile)) {
exec("/bin/pgrep -qnF {$pidfile} 2>/dev/null", $output, $retval);
return (intval($retval) == 0);
}
return false;
}
function is_process_running($process) {
$output = "";
exec("/bin/pgrep -anx " . escapeshellarg($process), $output, $retval);
return (intval($retval) == 0);
}
function isvalidproc($proc) {
return is_process_running($proc);
}
/* sigkill a process by pid file */
/* return 1 for success and 0 for a failure */
function sigkillbypid($pidfile, $sig) {
if (isvalidpid($pidfile)) {
return mwexec("/bin/pkill " . escapeshellarg("-{$sig}") .
" -F {$pidfile}", true);
}
return 0;
}
/* kill a process by name */
function sigkillbyname($procname, $sig) {
if (isvalidproc($procname)) {
return mwexec("/usr/bin/killall " . escapeshellarg("-{$sig}") . " " . escapeshellarg($procname), true);
}
}
/* kill a process by name */
function killbyname($procname) {
if (isvalidproc($procname)) {
mwexec("/usr/bin/killall " . escapeshellarg($procname));
}
}
function is_subsystem_dirty($subsystem = "") {
global $g;
if ($subsystem == "") {
return false;
}
if (file_exists("{$g['varrun_path']}/{$subsystem}.dirty")) {
return true;
}
return false;
}
function mark_subsystem_dirty($subsystem = "") {
global $g;
if (!file_put_contents("{$g['varrun_path']}/{$subsystem}.dirty", "DIRTY")) {
log_error(sprintf(gettext("WARNING: Could not mark subsystem: %s dirty"), $subsystem));
}
}
function clear_subsystem_dirty($subsystem = "") {
global $g;
@unlink("{$g['varrun_path']}/{$subsystem}.dirty");
}
/* lock configuration file */
function lock($lock, $op = LOCK_SH) {
global $g;
if (!$lock) {
die(gettext("WARNING: A name must be given as parameter to lock() function."));
}
if (!file_exists("{$g['tmp_path']}/{$lock}.lock")) {
@touch("{$g['tmp_path']}/{$lock}.lock");
@chmod("{$g['tmp_path']}/{$lock}.lock", 0666);
}
if ($fp = fopen("{$g['tmp_path']}/{$lock}.lock", "w")) {
if (flock($fp, $op)) {
return $fp;
} else {
fclose($fp);
}
}
}
function try_lock($lock, $timeout = 5) {
global $g;
if (!$lock) {
die(gettext("WARNING: A name must be given as parameter to try_lock() function."));
}
if (!file_exists("{$g['tmp_path']}/{$lock}.lock")) {
@touch("{$g['tmp_path']}/{$lock}.lock");
@chmod("{$g['tmp_path']}/{$lock}.lock", 0666);
}
if ($fp = fopen("{$g['tmp_path']}/{$lock}.lock", "w")) {
$trycounter = 0;
while (!flock($fp, LOCK_EX | LOCK_NB)) {
if ($trycounter >= $timeout) {
fclose($fp);
return NULL;
}
sleep(1);
$trycounter++;
}
return $fp;
}
return NULL;
}
/* unlock configuration file */
function unlock($cfglckkey = 0) {
global $g;
flock($cfglckkey, LOCK_UN);
fclose($cfglckkey);
return;
}
/* unlock forcefully configuration file */
function unlock_force($lock) {
global $g;
@unlink("{$g['tmp_path']}/{$lock}.lock");
}
function send_event($cmd) {
global $g;
if (!isset($g['event_address'])) {
$g['event_address'] = "unix:///var/run/check_reload_status";
}
$try = 0;
while ($try < 3) {
$fd = @fsockopen($g['event_address']);
if ($fd) {
fwrite($fd, $cmd);
$resp = fread($fd, 4096);
if ($resp != "OK\n") {
log_error("send_event: sent {$cmd} got {$resp}");
}
fclose($fd);
$try = 3;
} else if (!is_process_running("check_reload_status")) {
mwexec_bg("/usr/bin/nice -n20 /usr/local/sbin/check_reload_status");
}
$try++;
}
}
function send_multiple_events($cmds) {
global $g;
if (!isset($g['event_address'])) {
$g['event_address'] = "unix:///var/run/check_reload_status";
}
if (!is_array($cmds)) {
return;
}
while ($try < 3) {
$fd = @fsockopen($g['event_address']);
if ($fd) {
foreach ($cmds as $cmd) {
fwrite($fd, $cmd);
$resp = fread($fd, 4096);
if ($resp != "OK\n") {
log_error("send_event: sent {$cmd} got {$resp}");
}
}
fclose($fd);
$try = 3;
} else if (!is_process_running("check_reload_status")) {
mwexec_bg("/usr/bin/nice -n20 /usr/local/sbin/check_reload_status");
}
$try++;
}
}
function is_module_loaded($module_name) {
$module_name = str_replace(".ko", "", $module_name);
$running = 0;
$_gb = exec("/sbin/kldstat -qn {$module_name} 2>&1", $_gb, $running);
if (intval($running) == 0) {
return true;
} else {
return false;
}
}
/* validate non-negative numeric string, or equivalent numeric variable */
function is_numericint($arg) {
return (((is_int($arg) && $arg >= 0) || (is_string($arg) && strlen($arg) > 0 && ctype_digit($arg))) ? true : false);
}
/* Generate the (human readable) ipv4 or ipv6 subnet address (i.e., netmask, or subnet start IP)
given an (human readable) ipv4 or ipv6 host address and subnet bit count */
function gen_subnet($ipaddr, $bits) {
if (($sn = gen_subnetv6($ipaddr, $bits)) == '') {
$sn = gen_subnetv4($ipaddr, $bits); // try to avoid rechecking IPv4/v6
}
return $sn;
}
/* same as gen_subnet() but accepts IPv4 only */
function gen_subnetv4($ipaddr, $bits) {
if (is_ipaddrv4($ipaddr) && is_numericint($bits) && $bits <= 32) {
if ($bits == 0) {
return '0.0.0.0'; // avoids <<32
}
return long2ip(ip2long($ipaddr) & ((0xFFFFFFFF << (32 - $bits)) & 0xFFFFFFFF));
}
return "";
}
/* same as gen_subnet() but accepts IPv6 only */
function gen_subnetv6($ipaddr, $bits) {
if (is_ipaddrv6($ipaddr) && is_numericint($bits) && $bits <= 128) {
return text_to_compressed_ip6(Net_IPv6::getNetmask($ipaddr, $bits));
}
return "";
}
/* Generate the (human readable) ipv4 or ipv6 subnet end address (i.e., highest address, end IP, or IPv4 broadcast address)
given an (human readable) ipv4 or ipv6 host address and subnet bit count. */
function gen_subnet_max($ipaddr, $bits) {
if (($sn = gen_subnetv6_max($ipaddr, $bits)) == '') {
$sn = gen_subnetv4_max($ipaddr, $bits); // try to avoid rechecking IPv4/v6
}
return $sn;
}
/* same as gen_subnet_max() but validates IPv4 only */
function gen_subnetv4_max($ipaddr, $bits) {
if (is_ipaddrv4($ipaddr) && is_numericint($bits) && $bits <= 32) {
if ($bits == 32) {
return $ipaddr;
}
return long2ip32(ip2long($ipaddr) | (~gen_subnet_mask_long($bits) & 0xFFFFFFFF));
}
return "";
}
/* same as gen_subnet_max() but validates IPv6 only */
function gen_subnetv6_max($ipaddr, $bits) {
if (is_ipaddrv6($ipaddr) && is_numericint($bits) && $bits <= 128) {
$endip_bin = substr(ip6_to_bin($ipaddr), 0, $bits) . str_repeat('1', 128 - $bits);
return bin_to_compressed_ip6($endip_bin);
}
return "";
}
/* returns a subnet mask (long given a bit count) */
function gen_subnet_mask_long($bits) {
$sm = 0;
for ($i = 0; $i < $bits; $i++) {
$sm >>= 1;
$sm |= 0x80000000;
}
return $sm;
}
/* same as above but returns a string */
function gen_subnet_mask($bits) {
return long2ip(gen_subnet_mask_long($bits));
}
/* Convert a prefix length to an IPv6 address-like mask notation. Very rare but at least ntp needs it. See #4463 */
function gen_subnet_mask_v6($bits) {
/* Binary representation of the prefix length */
$bin = str_repeat('1', $bits);
/* Pad right with zeroes to reach the full address length */
$bin = str_pad($bin, 128, '0', STR_PAD_RIGHT);
/* Convert back to an IPv6 address style notation */
return bin_to_ip6($bin);
}
/* Convert long int to IPv4 address
Returns '' if not valid IPv4 (including if any bits >32 are non-zero) */
function long2ip32($ip) {
return long2ip($ip & 0xFFFFFFFF);
}
/* Convert IPv4 address to long int, truncated to 32-bits to avoid sign extension on 64-bit platforms.
Returns '' if not valid IPv4. */
function ip2long32($ip) {
return (ip2long($ip) & 0xFFFFFFFF);
}
/* Convert IPv4 address to unsigned long int.
Returns '' if not valid IPv4. */
function ip2ulong($ip) {
return sprintf("%u", ip2long32($ip));
}
/*
* Convert IPv6 address to binary
*
* Obtained from: pear-Net_IPv6
*/
function ip6_to_bin($ip) {
$binstr = '';
$ip = Net_IPv6::removeNetmaskSpec($ip);
$ip = Net_IPv6::Uncompress($ip);
$parts = explode(':', $ip);
foreach ( $parts as $v ) {
$str = base_convert($v, 16, 2);
$binstr .= str_pad($str, 16, '0', STR_PAD_LEFT);
}
return $binstr;
}
/*
* Convert IPv6 binary to uncompressed address
*
* Obtained from: pear-Net_IPv6
*/
function bin_to_ip6($bin) {
$ip = "";
if (strlen($bin) < 128) {
$bin = str_pad($bin, 128, '0', STR_PAD_LEFT);
}
$parts = str_split($bin, "16");
foreach ( $parts as $v ) {
$str = base_convert($v, 2, 16);
$ip .= $str.":";
}
$ip = substr($ip, 0, -1);
return $ip;
}
/*
* Convert IPv6 binary to compressed address
*/
function bin_to_compressed_ip6($bin) {
return text_to_compressed_ip6(bin_to_ip6($bin));
}
/*
* Convert textual IPv6 address string to compressed address
*/
function text_to_compressed_ip6($text) {
// Force re-compression by passing parameter 2 (force) true.
// This ensures that supposedly-compressed formats are uncompressed
// first then re-compressed into strictly correct form.
// e.g. 2001:0:0:4:0:0:0:1
// 2001::4:0:0:0:1 is a strictly-incorrect compression,
// but maybe the user entered it like that.
// The "force" parameter will ensure it is returned as:
// 2001:0:0:4::1
return Net_IPv6::compress($text, true);
}
/* Find out how many IPs are contained within a given IP range
* e.g. 192.168.0.0 to 192.168.0.255 returns 256
*/
function ip_range_size_v4($startip, $endip) {
if (is_ipaddrv4($startip) && is_ipaddrv4($endip)) {
// Operate as unsigned long because otherwise it wouldn't work
// when crossing over from 127.255.255.255 / 128.0.0.0 barrier
return abs(ip2ulong($startip) - ip2ulong($endip)) + 1;
}
return -1;
}
/* Find the smallest possible subnet mask which can contain a given number of IPs
* e.g. 512 IPs can fit in a /23, but 513 IPs need a /22
*/
function find_smallest_cidr_v4($number) {
$smallest = 1;
for ($b=32; $b > 0; $b--) {
$smallest = ($number <= pow(2, $b)) ? $b : $smallest;
}
return (32-$smallest);
}
/* Return the previous IP address before the given address */
function ip_before($ip, $offset = 1) {
return long2ip32(ip2long($ip) - $offset);
}
/* Return the next IP address after the given address */
function ip_after($ip, $offset = 1) {
return long2ip32(ip2long($ip) + $offset);
}
/* Return true if the first IP is 'before' the second */
function ip_less_than($ip1, $ip2) {
// Compare as unsigned long because otherwise it wouldn't work when
// crossing over from 127.255.255.255 / 128.0.0.0 barrier
return ip2ulong($ip1) < ip2ulong($ip2);
}
/* Return true if the first IP is 'after' the second */
function ip_greater_than($ip1, $ip2) {
// Compare as unsigned long because otherwise it wouldn't work
// when crossing over from 127.255.255.255 / 128.0.0.0 barrier
return ip2ulong($ip1) > ip2ulong($ip2);
}
/* compare two IP addresses */
function ipcmp($a, $b) {
if (ip_less_than($a, $b)) {
return -1;
} else if (ip_greater_than($a, $b)) {
return 1;
} else {
return 0;
}
}
/* Convert a range of IPv4 addresses to an array of individual addresses. */
/* Note: IPv6 ranges are not yet supported here. */
function ip_range_to_address_array($startip, $endip, $max_size = 5000) {
if (!is_ipaddrv4($startip) || !is_ipaddrv4($endip)) {
return false;
}
if (ip_greater_than($startip, $endip)) {
// Swap start and end so we can process sensibly.
$temp = $startip;
$startip = $endip;
$endip = $temp;
}
if (ip_range_size_v4($startip, $endip) > $max_size) {
return false;
}
// Container for IP addresses within this range.
$rangeaddresses = array();
$end_int = ip2ulong($endip);
for ($ip_int = ip2ulong($startip); $ip_int <= $end_int; $ip_int++) {
$rangeaddresses[] = long2ip($ip_int);
}
return $rangeaddresses;
}
/*
* Convert an IPv4 or IPv6 IP range to an array of subnets which can contain the range.
* Algorithm and embodying code PD'ed by Stilez - enjoy as you like :-)
*
* Documented on pfsense dev list 19-20 May 2013. Summary:
*
* The algorithm looks at patterns of 0's and 1's in the least significant bit(s), whether IPv4 or IPv6.
* These are all that needs checking to identify a _guaranteed_ correct, minimal and optimal subnet array.
*
* As a result, string/binary pattern matching of the binary IP is very efficient. It uses just 2 pattern-matching rules
* to chop off increasingly larger subnets at both ends that can't be part of larger subnets, until nothing's left.
*
* (a) If any range has EITHER low bit 1 (in startip) or 0 (in endip), that end-point is _always guaranteed_ to be optimally
* represented by its own 'single IP' CIDR; the remaining range then shrinks by one IP up or down, causing the new end-point's
* low bit to change from 1->0 (startip) or 0->1 (endip). Only one edge case needs checking: if a range contains exactly 2
* adjacent IPs of this format, then the two IPs themselves are required to span it, and we're done.
* Once this rule is applied, the remaining range is _guaranteed_ to end in 0's and 1's so rule (b) can now be used, and its
* low bits can now be ignored.
*
* (b) If any range has BOTH startip and endip ending in some number of 0's and 1's respectively, these low bits can
* *always* be ignored and "bit-shifted" for subnet spanning. So provided we remember the bits we've place-shifted, we can
* _always_ right-shift and chop off those bits, leaving a smaller range that has EITHER startip ending in 1 or endip ending
* in 0 (ie can now apply (a) again) or the entire range has vanished and we're done.
* We then loop to redo (a) again on the remaining (place shifted) range until after a few loops, the remaining (place shifted)
* range 'vanishes' by meeting the exit criteria of (a) or (b), and we're done.
*/
function ip_range_to_subnet_array($ip1, $ip2) {
if (is_ipaddrv4($ip1) && is_ipaddrv4($ip2)) {
$proto = 'ipv4'; // for clarity
$bits = 32;
$ip1bin = decbin(ip2long32($ip1));
$ip2bin = decbin(ip2long32($ip2));
} elseif (is_ipaddrv6($ip1) && is_ipaddrv6($ip2)) {
$proto = 'ipv6';
$bits = 128;
$ip1bin = ip6_to_bin($ip1);
$ip2bin = ip6_to_bin($ip2);
} else {
return array();
}
// it's *crucial* that binary strings are guaranteed the expected length; do this for certainty even though for IPv6 it's redundant
$ip1bin = str_pad($ip1bin, $bits, '0', STR_PAD_LEFT);
$ip2bin = str_pad($ip2bin, $bits, '0', STR_PAD_LEFT);
if ($ip1bin == $ip2bin) {
return array($ip1 . '/' . $bits); // exit if ip1=ip2 (trivial case)
}
if ($ip1bin > $ip2bin) {
list ($ip1bin, $ip2bin) = array($ip2bin, $ip1bin); // swap if needed (ensures ip1 < ip2)
}
$rangesubnets = array();
$netsize = 0;
do {
// at loop start, $ip1 is guaranteed strictly less than $ip2 (important for edge case trapping and preventing accidental binary wrapround)
// which means the assignments $ip1 += 1 and $ip2 -= 1 will always be "binary-wrapround-safe"
// step #1 if start ip (as shifted) ends in any '1's, then it must have a single cidr to itself (any cidr would include the '0' below it)
if (substr($ip1bin, -1, 1) == '1') {
// the start ip must be in a separate one-IP cidr range
$new_subnet_ip = substr($ip1bin, $netsize, $bits - $netsize) . str_repeat('0', $netsize);
$rangesubnets[$new_subnet_ip] = $bits - $netsize;
$n = strrpos($ip1bin, '0'); //can't be all 1's
$ip1bin = ($n == 0 ? '' : substr($ip1bin, 0, $n)) . '1' . str_repeat('0', $bits - $n - 1); // BINARY VERSION OF $ip1 += 1
}
// step #2, if end ip (as shifted) ends in any zeros then that must have a cidr to itself (as cidr cant span the 1->0 gap)
if (substr($ip2bin, -1, 1) == '0') {
// the end ip must be in a separate one-IP cidr range
$new_subnet_ip = substr($ip2bin, $netsize, $bits - $netsize) . str_repeat('0', $netsize);
$rangesubnets[$new_subnet_ip] = $bits - $netsize;
$n = strrpos($ip2bin, '1'); //can't be all 0's
$ip2bin = ($n == 0 ? '' : substr($ip2bin, 0, $n)) . '0' . str_repeat('1', $bits - $n - 1); // BINARY VERSION OF $ip2 -= 1
// already checked for the edge case where end = start+1 and start ends in 0x1, above, so it's safe
}
// this is the only edge case arising from increment/decrement.
// it happens if the range at start of loop is exactly 2 adjacent ips, that spanned the 1->0 gap. (we will have enumerated both by now)
if ($ip2bin < $ip1bin) {
continue;
}
// step #3 the start and end ip MUST now end in '0's and '1's respectively
// so we have a non-trivial range AND the last N bits are no longer important for CIDR purposes.
$shift = $bits - max(strrpos($ip1bin, '0'), strrpos($ip2bin, '1')); // num of low bits which are '0' in ip1 and '1' in ip2
$ip1bin = str_repeat('0', $shift) . substr($ip1bin, 0, $bits - $shift);
$ip2bin = str_repeat('0', $shift) . substr($ip2bin, 0, $bits - $shift);
$netsize += $shift;
if ($ip1bin == $ip2bin) {
// we're done.
$new_subnet_ip = substr($ip1bin, $netsize, $bits - $netsize) . str_repeat('0', $netsize);
$rangesubnets[$new_subnet_ip] = $bits - $netsize;
continue;
}
// at this point there's still a remaining range, and either startip ends with '1', or endip ends with '0'. So repeat cycle.
} while ($ip1bin < $ip2bin);
// subnets are ordered by bit size. Re sort by IP ("naturally") and convert back to IPv4/IPv6
ksort($rangesubnets, SORT_STRING);
$out = array();
foreach ($rangesubnets as $ip => $netmask) {
if ($proto == 'ipv4') {
$i = str_split($ip, 8);
$out[] = implode('.', array(bindec($i[0]), bindec($i[1]), bindec($i[2]), bindec($i[3]))) . '/' . $netmask;
} else {
$out[] = bin_to_compressed_ip6($ip) . '/' . $netmask;
}
}
return $out;
}
/* returns true if $range is a valid pair of IPv4 or IPv6 addresses separated by a "-"
false - if not a valid pair
true (numeric 4 or 6) - if valid, gives type of addresses */
function is_iprange($range) {
if (substr_count($range, '-') != 1) {
return false;
}
list($ip1, $ip2) = explode ('-', $range);
if (is_ipaddrv4($ip1) && is_ipaddrv4($ip2)) {
return 4;
}
if (is_ipaddrv6($ip1) && is_ipaddrv6($ip2)) {
return 6;
}
return false;
}
/* returns true if $ipaddr is a valid dotted IPv4 address or a IPv6
false - not valid
true (numeric 4 or 6) - if valid, gives type of address */
function is_ipaddr($ipaddr) {
if (is_ipaddrv4($ipaddr)) {
return 4;
}
if (is_ipaddrv6($ipaddr)) {
return 6;
}
return false;
}
/* returns true if $ipaddr is a valid IPv6 address */
function is_ipaddrv6($ipaddr) {
if (!is_string($ipaddr) || empty($ipaddr)) {
return false;
}
if (strstr($ipaddr, "%") && is_linklocal($ipaddr)) {
$tmpip = explode("%", $ipaddr);
$ipaddr = $tmpip[0];
}
return Net_IPv6::checkIPv6($ipaddr);
}
/* returns true if $ipaddr is a valid dotted IPv4 address */
function is_ipaddrv4($ipaddr) {
if (!is_string($ipaddr) || empty($ipaddr) || ip2long($ipaddr) === FALSE) {
return false;
}
return true;
}
/* returns 4 or 6 respectively (== TRUE) if $ipaddr is a valid IPv4 or IPv6 linklocal address
returns '' if not a valid linklocal address */
function is_linklocal($ipaddr) {
if (is_ipaddrv4($ipaddr)) {
// input is IPv4
// test if it's 169.254.x.x per rfc3927 2.1
$ip4 = explode(".", $ipaddr);
if ($ip4[0] == '169' && $ip4[1] == '254') {
return 4;
}
} elseif (Net_IPv6::getAddressType($ipaddr) == NET_IPV6_LOCAL_LINK) {
return 6;
}
return '';
}
/* returns scope of a linklocal address */
function get_ll_scope($addr) {
if (!is_linklocal($addr) || !strstr($addr, "%")) {
return "";
}
list ($ll, $scope) = explode("%", $addr);
return $scope;
}
/* returns true if $ipaddr is a valid literal IPv6 address */
function is_literalipaddrv6($ipaddr) {
if (substr($ipaddr,0,1) == '[' && substr($ipaddr,-1,1) == ']') {
// if it's data wrapped in "[ ... ]" then test if middle part is valid IPv6
return is_ipaddrv6(substr($ipaddr,1,-1));
}
return false;
}
/* returns true if $iport is a valid IPv4:port or [Literal IPv6]:port
false - not valid
true (numeric 4 or 6) - if valid, gives type of address */
function is_ipaddrwithport($ipport) {
$c = strrpos($ipport, ":");
if ($c === false) {
return false; // can't split at final colon if no colon exists
}
if (!is_port(substr($ipport, $c + 1))) {
return false; // no valid port after last colon
}
$ip = substr($ipport, 0, $c); // else is text before last colon a valid IP
if (is_literalipaddrv6($ip)) {
return 6;
} elseif (is_ipaddrv4($ip)) {
return 4;
} else {
return false;
}
}
function is_hostnamewithport($hostport) {
$parts = explode(":", $hostport);
// no need to validate with is_string(); if it's not a string then explode won't return 2 parts anyway
if (count($parts) == 2) {
return is_hostname($parts[0]) && is_port($parts[1]);
}
return false;
}
/* returns true if $ipaddr is a valid dotted IPv4 address or an alias thereof */
function is_ipaddroralias($ipaddr) {
global $config;
if (is_alias($ipaddr)) {
if (is_array($config['aliases']['alias'])) {
foreach ($config['aliases']['alias'] as $alias) {
if ($alias['name'] == $ipaddr && !preg_match("/port/i", $alias['type'])) {
return true;
}
}
}
return false;
} else {
return is_ipaddr($ipaddr);
}
}
/* returns true if $subnet is a valid IPv4 or IPv6 subnet in CIDR format
false - if not a valid subnet
true (numeric 4 or 6) - if valid, gives type of subnet */
function is_subnet($subnet) {
if (is_string($subnet) && preg_match('/^(?:([0-9.]{7,15})|([0-9a-f:]{2,39}))\/(\d{1,3})$/i', $subnet, $parts)) {
if (is_ipaddrv4($parts[1]) && $parts[3] <= 32) {
return 4;
}
if (is_ipaddrv6($parts[2]) && $parts[3] <= 128) {
return 6;
}
}
return false;
}
/* same as is_subnet() but accepts IPv4 only */
function is_subnetv4($subnet) {
return (is_subnet($subnet) == 4);
}
/* same as is_subnet() but accepts IPv6 only */
function is_subnetv6($subnet) {
return (is_subnet($subnet) == 6);
}
/* returns true if $subnet is a valid subnet in CIDR format or an alias thereof */
function is_subnetoralias($subnet) {
global $aliastable;
if (isset($aliastable[$subnet]) && is_subnet($aliastable[$subnet])) {
return true;
} else {
return is_subnet($subnet);
}
}
/* Get number of addresses in an IPv4/IPv6 subnet (represented as a string)
optional $exact=true forces error (0) to be returned if it can't be represented exactly
Exact result not possible above PHP_MAX_INT which is about 2^31 addresses on x32 or 2^63 on x64
Returns 0 for bad data or if cannot represent size as an INT when $exact is set. */
function subnet_size($subnet, $exact=false) {
$parts = explode("/", $subnet);
$iptype = is_ipaddr($parts[0]);
if (count($parts) == 2 && $iptype) {
return subnet_size_by_netmask($iptype, $parts[1], $exact);
}
return 0;
}
/* Get number of addresses in an IPv4/IPv6 subnet (represented numerically as IP type + bits)
optional $exact=true forces error (0) to be returned if it can't be represented exactly
Hard to think where we might need to count exactly a huge subnet but an overflow detection option is probably sensible
Returns 0 for bad data or if cannot represent size as an INT when $exact is set. */
function subnet_size_by_netmask($iptype, $bits, $exact=false) {
if (!is_numericint($bits)) {
return 0;
} elseif ($iptype == 4 && $bits <= 32) {
$snsize = 32 - $bits;
} elseif ($iptype == 6 && $bits <= 128) {
$snsize = 128 - $bits;
} else {
return 0;
}
// 2**N returns an exact result as an INT if possible, and a float/double if not.
// Detect this switch, rather than comparing $result<=PHP_MAX_INT or $bits >=8*PHP_INT_SIZE as it's (probably) easier to get completely reliable
$result = 2 ** $snsize;
if ($exact && !is_int($result)) {
//exact required but can't represent result exactly as an INT
return 0;
} else {
// result ok, will be an INT where possible (guaranteed up to 2^31 addresses on x32/x64) and a float for 'huge' subnets
return $result;
}
}
/* function used by pfblockerng */
function subnetv4_expand($subnet) {
$result = array();
list ($ip, $bits) = explode("/", $subnet);
$net = ip2long($ip);
$mask = (0xffffffff << (32 - $bits));
$net &= $mask;
$size = round(exp(log(2) * (32 - $bits)));
for ($i = 0; $i < $size; $i += 1) {
$result[] = long2ip($net | $i);
}
return $result;
}
/* find out whether two IPv4/IPv6 CIDR subnets overlap.
Note: CIDR overlap implies one is identical or included so largest sn will be the same */
function check_subnets_overlap($subnet1, $bits1, $subnet2, $bits2) {
if (is_ipaddrv4($subnet1)) {
return check_subnetsv4_overlap($subnet1, $bits1, $subnet2, $bits2);
} else {
return check_subnetsv6_overlap($subnet1, $bits1, $subnet2, $bits2);
}
}
/* find out whether two IPv4 CIDR subnets overlap.
Note: CIDR overlap means sn1/sn2 are identical or one is included in other. So sn using largest $bits will be the same */
function check_subnetsv4_overlap($subnet1, $bits1, $subnet2, $bits2) {
$largest_sn = min($bits1, $bits2);
$subnetv4_start1 = gen_subnetv4($subnet1, $largest_sn);
$subnetv4_start2 = gen_subnetv4($subnet2, $largest_sn);
if ($subnetv4_start1 == '' || $subnetv4_start2 == '') {
// One or both args is not a valid IPv4 subnet
//FIXME: needs to return "bad data" not true/false if bad. For now return false, best we can do until fixed
return false;
}
return ($subnetv4_start1 == $subnetv4_start2);
}
/* find out whether two IPv6 CIDR subnets overlap.
Note: CIDR overlap means sn1/sn2 are identical or one is included in other. So sn using largest $bits will be the same */
function check_subnetsv6_overlap($subnet1, $bits1, $subnet2, $bits2) {
$largest_sn = min($bits1, $bits2);
$subnetv6_start1 = gen_subnetv6($subnet1, $largest_sn);
$subnetv6_start2 = gen_subnetv6($subnet2, $largest_sn);
if ($subnetv6_start1 == '' || $subnetv6_start2 == '') {
// One or both args is not a valid IPv6 subnet
//FIXME: needs to return "bad data" not true/false if bad. For now return false, best we can do until fixed
return false;
}
return ($subnetv6_start1 == $subnetv6_start2);
}
/* return all PTR zones for a IPv6 network */
function get_v6_ptr_zones($subnet, $bits) {
$result = array();
if (!is_ipaddrv6($subnet)) {
return $result;
}
if (!is_numericint($bits) || $bits > 128) {
return $result;
}
/*
* Find a small nibble boundary subnet mask
* e.g. a /29 will create 8 /32 PTR zones
*/
$small_sn = $bits;
while ($small_sn % 4 != 0) {
$small_sn++;
}
/* Get network prefix */
$small_subnet = Net_IPv6::getNetmask($subnet, $bits);
/*
* While small network is part of bigger one, increase 4-bit in last
* digit to get next small network
*/
while (Net_IPv6::isInNetmask($small_subnet, $subnet, $bits)) {
/* Get a pure hex value */
$unpacked = unpack('H*hex', inet_pton($small_subnet));
/* Create PTR record using $small_sn / 4 chars */
$result[] = implode('.', array_reverse(str_split(substr(
$unpacked['hex'], 0, $small_sn / 4)))).'.ip6.arpa';
/* Detect what part of IP should be increased */
$change_part = (int) ($small_sn / 16);
if ($small_sn % 16 == 0) {
$change_part--;
}
/* Increase 1 to desired part */
$parts = explode(":", Net_IPv6::uncompress($small_subnet));
$parts[$change_part]++;
$small_subnet = implode(":", $parts);
}
return $result;
}
/* return true if $addr is in $subnet, false if not */
function ip_in_subnet($addr, $subnet) {
if (is_ipaddrv6($addr) && is_subnetv6($subnet)) {
return (Net_IPv6::isInNetmask($addr, $subnet));
} else if (is_ipaddrv4($addr) && is_subnetv4($subnet)) {
list($ip, $mask) = explode('/', $subnet);
$mask = (0xffffffff << (32 - $mask)) & 0xffffffff;
return ((ip2long($addr) & $mask) == (ip2long($ip) & $mask));
}
return false;
}
/* returns true if $hostname is just a valid hostname (top part without any of the domain part) */
function is_unqualified_hostname($hostname) {
if (!is_string($hostname)) {
return false;
}
if (preg_match('/^(?:[a-z0-9_]|[a-z0-9_][a-z0-9_\-]*[a-z0-9_])$/i', $hostname)) {
return true;
} else {
return false;
}
}
/* returns true if $hostname is a valid hostname, with or without being a fully-qualified domain name. */
function is_hostname($hostname, $allow_wildcard=false) {
if (!is_string($hostname)) {
return false;
}
if (is_domain($hostname, $allow_wildcard)) {
if ((substr_count($hostname, ".") == 1) && ($hostname[strlen($hostname)-1] == ".")) {
/* Only a single dot at the end like "test." - hosts cannot be directly in the root domain. */
return false;
} else {
return true;
}
} else {
return false;
}
}
/* returns true if $domain is a valid domain name */
function is_domain($domain, $allow_wildcard=false) {
if (!is_string($domain)) {
return false;
}
if ($allow_wildcard) {
$domain_regex = '/^(?:(?:[a-z_0-9\*]|[a-z_0-9][a-z_0-9\-]*[a-z_0-9])\.)*(?:[a-z_0-9]|[a-z_0-9][a-z_0-9\-]*[a-z_0-9\.])$/i';
} else {
$domain_regex = '/^(?:(?:[a-z_0-9]|[a-z_0-9][a-z_0-9\-]*[a-z_0-9])\.)*(?:[a-z_0-9]|[a-z_0-9][a-z_0-9\-]*[a-z_0-9\.])$/i';
}
if (preg_match($domain_regex, $domain)) {
return true;
} else {
return false;
}
}
/* returns true if $macaddr is a valid MAC address */
function is_macaddr($macaddr, $partial=false) {
$values = explode(":", $macaddr);
/* Verify if the MAC address has a proper amount of parts for either a partial or full match. */
if ($partial) {
if ((count($values) < 1) || (count($values) > 6)) {
return false;
}
} elseif (count($values) != 6) {
return false;
}
for ($i = 0; $i < count($values); $i++) {
if (ctype_xdigit($values[$i]) == false)
return false;
if (hexdec($values[$i]) < 0 || hexdec($values[$i]) > 255)
return false;
}
return true;
}
/*
If $return_message is true then
returns a text message about the reason that the name is invalid.
the text includes the type of "thing" that is being checked, passed in $object. (e.g. "alias", "gateway group", "schedule")
else
returns true if $name is a valid name for an alias
returns false if $name is not a valid name for an alias
Aliases cannot be:
bad chars: anything except a-z 0-9 and underscore
bad names: empty string, pure numeric, pure underscore
reserved words: pre-defined service/protocol/port names which should not be ambiguous, and the words "port" and "pass" */
function is_validaliasname($name, $return_message = false, $object = "alias") {
/* Array of reserved words */
$reserved = array("port", "pass");
if (!is_string($name) || strlen($name) >= 32 || preg_match('/(^_*$|^\d*$|[^a-z0-9_])/i', $name)) {
if ($return_message) {
return sprintf(gettext('The %1$s name must be less than 32 characters long, may not consist of only numbers, may not consist of only underscores, and may only contain the following characters: %2$s'), $object, 'a-z, A-Z, 0-9, _');
} else {
return false;
}
}
if (in_array($name, $reserved, true)) {
if ($return_message) {
return sprintf(gettext('The %1$s name must not be either of the reserved words %2$s or %3$s.'), $object, "'port'", "'pass'");
} else {
return false;
}
}
if (getprotobyname($name)) {
if ($return_message) {
return sprintf(gettext('The %1$s name must not be a well-known IP protocol name such as TCP, UDP, ICMP etc.'), $object);
} else {
return false;
}
}
if (getservbyname($name, "tcp") || getservbyname($name, "udp")) {
if ($return_message) {
return sprintf(gettext('The %1$s name must not be a well-known TCP or UDP port name such as ssh, smtp, pop3, tftp, http, openvpn etc.'), $object);
} else {
return false;
}
}
if ($return_message) {
return sprintf(gettext("The %1$s name is valid."), $object);
} else {
return true;
}
}
/* returns a text message indicating if the alias name is valid, or the reason it is not valid. */
function invalidaliasnamemsg($name, $object = "alias") {
return is_validaliasname($name, true, $object);
}
/*
* returns true if $range is a valid integer range between $min and $max
* range delimiter can be ':' or '-'
*/
function is_intrange($range, $min, $max) {
$values = preg_split("/[:-]/", $range);
if (!is_array($values) || count($values) != 2) {
return false;
}
if (!ctype_digit($values[0]) || !ctype_digit($values[1])) {
return false;
}
$values[0] = intval($values[0]);
$values[1] = intval($values[1]);
if ($values[0] >= $values[1]) {
return false;
}
if ($values[0] < $min || $values[1] > $max) {
return false;
}
return true;
}
/* returns true if $port is a valid TCP/UDP port */
function is_port($port) {
if (ctype_digit($port) && ((intval($port) >= 1) && (intval($port) <= 65535))) {
return true;
}
if (getservbyname($port, "tcp") || getservbyname($port, "udp")) {
return true;
}
return false;
}
/* returns true if $portrange is a valid TCP/UDP portrange ("<port>:<port>") */
function is_portrange($portrange) {
$ports = explode(":", $portrange);
return (count($ports) == 2 && is_port($ports[0]) && is_port($ports[1]));
}
/* returns true if $port is a valid TCP/UDP port number or range ("<port>:<port>") */
function is_port_or_range($port) {
return (is_port($port) || is_portrange($port));
}
/* returns true if $port is an alias that is a port type */
function is_portalias($port) {
global $config;
if (is_alias($port)) {
if (is_array($config['aliases']['alias'])) {
foreach ($config['aliases']['alias'] as $alias) {
if ($alias['name'] == $port && preg_match("/port/i", $alias['type'])) {
return true;
}
}
}
}
return false;
}
/* returns true if $port is a valid port number or an alias thereof */
function is_port_or_alias($port) {
return (is_port($port) || is_portalias($port));
}
/* returns true if $port is a valid TCP/UDP port number or range ("<port>:<port>") or an alias thereof */
function is_port_or_range_or_alias($port) {
return (is_port($port) || is_portrange($port) || is_portalias($port));
}
/* create ranges of sequential port numbers (200:215) and remove duplicates */
function group_ports($ports, $kflc = false) {
if (!is_array($ports) || empty($ports)) {
return;
}
$uniq = array();
$comments = array();
foreach ($ports as $port) {
if (($kflc) && (strpos($port, '#') === 0)) { // Keep Full Line Comments (lines beginning with #).
$comments[] = $port;
} else if (is_portrange($port)) {
list($begin, $end) = explode(":", $port);
if ($begin > $end) {
$aux = $begin;
$begin = $end;
$end = $aux;
}
for ($i = $begin; $i <= $end; $i++) {
if (!in_array($i, $uniq)) {
$uniq[] = $i;
}
}
} else if (is_port($port)) {
if (!in_array($port, $uniq)) {
$uniq[] = $port;
}
}
}
sort($uniq, SORT_NUMERIC);
$result = array();
foreach ($uniq as $idx => $port) {
if ($idx == 0) {
$result[] = $port;
continue;
}
$last = end($result);
if (is_portrange($last)) {
list($begin, $end) = explode(":", $last);
} else {
$begin = $end = $last;
}
if ($port == ($end+1)) {
$end++;
$result[count($result)-1] = "{$begin}:{$end}";
} else {
$result[] = $port;
}
}
return array_merge($comments, $result);
}
/* returns true if $val is a valid shaper bandwidth value */
function is_valid_shaperbw($val) {
return (preg_match("/^(\d+(?:\.\d+)?)([MKG]?b|%)$/", $val));
}
/* returns true if $test is in the range between $start and $end */
function is_inrange_v4($test, $start, $end) {
if (!is_ipaddrv4($test) || !is_ipaddrv4($start) || !is_ipaddrv4($end)) {
return false;
}
if (ip2ulong($test) <= ip2ulong($end) &&
ip2ulong($test) >= ip2ulong($start)) {
return true;
}
return false;
}
/* returns true if $test is in the range between $start and $end */
function is_inrange_v6($test, $start, $end) {
if (!is_ipaddrv6($test) || !is_ipaddrv6($start) || !is_ipaddrv6($end)) {
return false;
}
if (inet_pton($test) <= inet_pton($end) &&
inet_pton($test) >= inet_pton($start)) {
return true;
}
return false;
}
/* returns true if $test is in the range between $start and $end */
function is_inrange($test, $start, $end) {
return is_ipaddrv6($test) ? is_inrange_v6($test, $start, $end) : is_inrange_v4($test, $start, $end);
}
function get_configured_vip_list($family = 'all', $type = VIP_ALL) {
global $config;
$list = array();
if (!is_array($config['virtualip']['vip']) || empty($config['virtualip']['vip'])) {
return ($list);
}
$viparr = &$config['virtualip']['vip'];
foreach ($viparr as $vip) {
if ($type == VIP_CARP) {
if ($vip['mode'] != "carp")
continue;
} elseif ($type == VIP_IPALIAS) {
if ($vip['mode'] != "ipalias")
continue;
} else {
if ($vip['mode'] != "carp" && $vip['mode'] != "ipalias")
continue;
}
if ($family == 'all' ||
($family == 'inet' && is_ipaddrv4($vip['subnet'])) ||
($family == 'inet6' && is_ipaddrv6($vip['subnet']))) {
$list["_vip{$vip['uniqid']}"] = $vip['subnet'];
}
}
return ($list);
}
function get_configured_vip($vipinterface = '') {
return (get_configured_vip_detail($vipinterface, 'all', 'vip'));
}
function get_configured_vip_interface($vipinterface = '') {
return (get_configured_vip_detail($vipinterface, 'all', 'iface'));
}
function get_configured_vip_ipv4($vipinterface = '') {
return (get_configured_vip_detail($vipinterface, 'inet', 'ip'));
}
function get_configured_vip_ipv6($vipinterface = '') {
return (get_configured_vip_detail($vipinterface, 'inet6', 'ip'));
}
function get_configured_vip_subnetv4($vipinterface = '') {
return (get_configured_vip_detail($vipinterface, 'inet', 'subnet'));
}
function get_configured_vip_subnetv6($vipinterface = '') {
return (get_configured_vip_detail($vipinterface, 'inet6', 'subnet'));
}
function get_configured_vip_detail($vipinterface = '', $family = 'inet', $what = 'ip') {
global $config;
if (empty($vipinterface) || !is_array($config['virtualip']['vip']) ||
empty($config['virtualip']['vip'])) {
return (NULL);
}
$viparr = &$config['virtualip']['vip'];
foreach ($viparr as $vip) {
if ($vip['mode'] != "carp" && $vip['mode'] != "ipalias") {
continue;
}
if ($vipinterface != "_vip{$vip['uniqid']}") {
continue;
}
switch ($what) {
case 'subnet':
if ($family == 'inet' && is_ipaddrv4($vip['subnet']))
return ($vip['subnet_bits']);
else if ($family == 'inet6' && is_ipaddrv6($vip['subnet']))
return ($vip['subnet_bits']);
break;
case 'iface':
return ($vip['interface']);
break;
case 'vip':
return ($vip);
break;
case 'ip':
default:
if ($family == 'inet' && is_ipaddrv4($vip['subnet'])) {
return ($vip['subnet']);
} else if ($family == 'inet6' && is_ipaddrv6($vip['subnet'])) {
return ($vip['subnet']);
}
break;
}
break;
}
return (NULL);
}
/* comparison function for sorting by the order in which interfaces are normally created */
function compare_interface_friendly_names($a, $b) {
if ($a == $b) {
return 0;
} else if ($a == 'wan') {
return -1;
} else if ($b == 'wan') {
return 1;
} else if ($a == 'lan') {
return -1;
} else if ($b == 'lan') {
return 1;
}
return strnatcmp($a, $b);
}
/* return the configured interfaces list. */
function get_configured_interface_list($withdisabled = false) {
global $config;
$iflist = array();
/* if list */
foreach ($config['interfaces'] as $if => $ifdetail) {
if (isset($ifdetail['enable']) || $withdisabled == true) {
$iflist[$if] = $if;
}
}
return $iflist;
}
/* return the configured interfaces list. */
function get_configured_interface_list_by_realif($withdisabled = false) {
global $config;
$iflist = array();
/* if list */
foreach ($config['interfaces'] as $if => $ifdetail) {
if (isset($ifdetail['enable']) || $withdisabled == true) {
$tmpif = get_real_interface($if);
if (!empty($tmpif)) {
$iflist[$tmpif] = $if;
}
}
}
return $iflist;
}
/* return the configured interfaces list with their description. */
function get_configured_interface_with_descr($withdisabled = false) {
global $config, $user_settings;
$iflist = array();
/* if list */
foreach ($config['interfaces'] as $if => $ifdetail) {
if (isset($ifdetail['enable']) || $withdisabled == true) {
if (empty($ifdetail['descr'])) {
$iflist[$if] = strtoupper($if);
} else {
$iflist[$if] = strtoupper($ifdetail['descr']);
}
}
}
if ($user_settings['webgui']['interfacessort']) {
asort($iflist);
}
return $iflist;
}
/*
* get_configured_ip_addresses() - Return a list of all configured
* IPv4 addresses.
*
*/
function get_configured_ip_addresses() {
global $config;
if (!function_exists('get_interface_ip')) {
require_once("interfaces.inc");
}
$ip_array = array();
$interfaces = get_configured_interface_list();
if (is_array($interfaces)) {
foreach ($interfaces as $int) {
$ipaddr = get_interface_ip($int);
$ip_array[$int] = $ipaddr;
}
}
$interfaces = get_configured_vip_list('inet');
if (is_array($interfaces)) {
foreach ($interfaces as $int => $ipaddr) {
$ip_array[$int] = $ipaddr;
}
}
/* pppoe server */
if (is_array($config['pppoes']) && is_array($config['pppoes']['pppoe'])) {
foreach ($config['pppoes']['pppoe'] as $pppoe) {
if ($pppoe['mode'] == "server") {
if (is_ipaddr($pppoe['localip'])) {
$int = "pppoes". $pppoe['pppoeid'];
$ip_array[$int] = $pppoe['localip'];
}
}
}
}
return $ip_array;
}
/*
* get_configured_ipv6_addresses() - Return a list of all configured
* IPv6 addresses.
*
*/
function get_configured_ipv6_addresses($linklocal_fallback = false) {
require_once("interfaces.inc");
$ipv6_array = array();
$interfaces = get_configured_interface_list();
if (is_array($interfaces)) {
foreach ($interfaces as $int) {
$ipaddrv6 = text_to_compressed_ip6(get_interface_ipv6($int, false, $linklocal_fallback));
$ipv6_array[$int] = $ipaddrv6;
}
}
$interfaces = get_configured_vip_list('inet6');
if (is_array($interfaces)) {
foreach ($interfaces as $int => $ipaddrv6) {
$ipv6_array[$int] = text_to_compressed_ip6($ipaddrv6);
}
}
return $ipv6_array;
}
/*
* get_interface_list() - Return a list of all physical interfaces
* along with MAC and status.
*
* $mode = "active" - use ifconfig -lu
* "media" - use ifconfig to check physical connection
* status (much slower)
*/
function get_interface_list($mode = "active", $keyby = "physical", $vfaces = "") {
global $config;
$upints = array();
/* get a list of virtual interface types */
if (!$vfaces) {
$vfaces = array(
'bridge',
'ppp',
'pppoe',
'pptp',
'l2tp',
'sl',
'gif',
'gre',
'faith',
'lo',
'ng',
'_vlan',
'_wlan',
'pflog',
'plip',
'pfsync',
'enc',
'tun',
'lagg',
'vip',
'ipfw'
);
}
switch ($mode) {
case "active":
$upints = pfSense_interface_listget(IFF_UP);
break;
case "media":
$intlist = pfSense_interface_listget();
$ifconfig = "";
exec("/sbin/ifconfig -a", $ifconfig);
$regexp = '/(' . implode('|', $intlist) . '):\s/';
$ifstatus = preg_grep('/status:/', $ifconfig);
foreach ($ifstatus as $status) {
$int = array_shift($intlist);
if (stristr($status, "active")) {
$upints[] = $int;
}
}
break;
default:
$upints = pfSense_interface_listget();
break;
}
/* build interface list with netstat */
$linkinfo = "";
exec("/usr/bin/netstat -inW -f link | awk '{ print $1, $4 }'", $linkinfo);
array_shift($linkinfo);
/* build ip address list with netstat */
$ipinfo = "";
exec("/usr/bin/netstat -inW -f inet | awk '{ print $1, $4 }'", $ipinfo);
array_shift($ipinfo);
foreach ($linkinfo as $link) {
$friendly = "";
$alink = explode(" ", $link);
$ifname = rtrim(trim($alink[0]), '*');
/* trim out all numbers before checking for vfaces */
if (!in_array(array_shift(preg_split('/\d/', $ifname)), $vfaces) &&
!stristr($ifname, "_vlan") && !stristr($ifname, "_wlan")) {
$toput = array(
"mac" => trim($alink[1]),
"up" => in_array($ifname, $upints)
);
foreach ($ipinfo as $ip) {
$aip = explode(" ", $ip);
if ($aip[0] == $ifname) {
$toput['ipaddr'] = $aip[1];
}
}
if (is_array($config['interfaces'])) {
foreach ($config['interfaces'] as $name => $int) {
if ($int['if'] == $ifname) {
$friendly = $name;
}
}
}
switch ($keyby) {
case "physical":
if ($friendly != "") {
$toput['friendly'] = $friendly;
}
$dmesg_arr = array();
exec("/sbin/dmesg |grep $ifname | head -n1", $dmesg_arr);
preg_match_all("/<(.*?)>/i", $dmesg_arr[0], $dmesg);
$toput['dmesg'] = $dmesg[1][0];
$iflist[$ifname] = $toput;
break;
case "ppp":
case "friendly":
if ($friendly != "") {
$toput['if'] = $ifname;
$iflist[$friendly] = $toput;
}
break;
}
}
}
return $iflist;
}
/****f* util/log_error
* NAME
* log_error - Sends a string to syslog.
* INPUTS
* $error - string containing the syslog message.
* RESULT
* null
******/
function log_error($error) {
global $g;
$page = $_SERVER['SCRIPT_NAME'];
if (empty($page)) {
$files = get_included_files();
$page = basename($files[0]);
}
syslog(LOG_ERR, "$page: $error");
if ($g['debug']) {
syslog(LOG_WARNING, var_dump(debug_backtrace()));
}
return;
}
/****f* util/log_auth
* NAME
* log_auth - Sends a string to syslog as LOG_AUTH facility
* INPUTS
* $error - string containing the syslog message.
* RESULT
* null
******/
function log_auth($error) {
global $g;
$page = $_SERVER['SCRIPT_NAME'];
syslog(LOG_AUTH, "$page: $error");
if ($g['debug']) {
syslog(LOG_WARNING, var_dump(debug_backtrace()));
}
return;
}
/****f* util/exec_command
* NAME
* exec_command - Execute a command and return a string of the result.
* INPUTS
* $command - String of the command to be executed.
* RESULT
* String containing the command's result.
* NOTES
* This function returns the command's stdout and stderr.
******/
function exec_command($command) {
$output = array();
exec($command . ' 2>&1', $output);
return(implode("\n", $output));
}
/* wrapper for exec()
Executes in background or foreground.
For background execution, returns PID of background process to allow calling code control */
function mwexec($command, $nologentry = false, $clearsigmask = false, $background = false) {
global $g;
$retval = 0;
if ($g['debug']) {
if (!$_SERVER['REMOTE_ADDR']) {
echo "mwexec(): $command" . ($background ? " [BG]":"") . "\n";
}
}
if ($clearsigmask) {
$oldset = array();
pcntl_sigprocmask(SIG_SETMASK, array(), $oldset);
}
if ($background) {
// start background process and return PID
$retval = exec("/usr/bin/nohup $command > /dev/null 2>&1 & echo $!");
} else {
// run in foreground, and (optionally) log if nonzero return
$outputarray = array();
exec("$command 2>&1", $outputarray, $retval);
if (($retval <> 0) && (!$nologentry || isset($config['system']['developerspew']))) {
log_error(sprintf(gettext("The command '%1\$s' returned exit code '%2\$d', the output was '%3\$s' "), $command, $retval, implode(" ", $outputarray)));
}
}
if ($clearsigmask) {
pcntl_sigprocmask(SIG_SETMASK, $oldset);
}
return $retval;
}
/* wrapper for exec() in background */
function mwexec_bg($command, $clearsigmask = false) {
return mwexec($command, false, $clearsigmask, true);
}
/* unlink a file, or pattern-match of a file, if it exists
if the file/path contains glob() compatible wildcards, all matching files will be unlinked
any warning/errors are suppressed (e.g. no matching files to delete)
If there are matching file(s) and they were all unlinked OK, then return true.
Otherwise return false (the requested file(s) did not exist, or could not be deleted)
This allows the caller to know if they were the one to successfully delete the file(s).
*/
function unlink_if_exists($fn) {
$to_do = glob($fn);
if (is_array($to_do) && count($to_do) > 0) {
// Returns an array of true/false indicating if each unlink worked
$results = @array_map("unlink", $to_do);
// If there is no false in the array, then all went well
$result = !in_array(false, $results, true);
} else {
$result = @unlink($fn);
}
return $result;
}
/* make a global alias table (for faster lookups) */
function alias_make_table($config) {
global $aliastable;
$aliastable = array();
if (is_array($config['aliases']['alias'])) {
foreach ($config['aliases']['alias'] as $alias) {
if ($alias['name']) {
$aliastable[$alias['name']] = $alias['address'];
}
}
}
}
/* check if an alias exists */
function is_alias($name) {
global $aliastable;
return isset($aliastable[$name]);
}
function alias_get_type($name) {
global $config;
if (is_array($config['aliases']['alias'])) {
foreach ($config['aliases']['alias'] as $alias) {
if ($name == $alias['name']) {
return $alias['type'];
}
}
}
return "";
}
/* expand a host or network alias, if necessary */
function alias_expand($name) {
global $config, $aliastable;
$urltable_prefix = "/var/db/aliastables/";
$urltable_filename = $urltable_prefix . $name . ".txt";
if (isset($aliastable[$name])) {
// alias names cannot be strictly numeric. redmine #4289
if (is_numericint($name)) {
return null;
}
// make sure if it's a ports alias, it actually exists. redmine #5845
foreach ($config['aliases']['alias'] as $alias) {
if ($alias['name'] == $name) {
if ($alias['type'] == "urltable_ports") {
if (is_URL($alias['url']) && file_exists($urltable_filename) && filesize($urltable_filename)) {
return "\${$name}";
} else {
return null;
}
}
}
}
return "\${$name}";
} else if (is_ipaddr($name) || is_subnet($name) || is_port_or_range($name)) {
return "{$name}";
} else {
return null;
}
}
function alias_expand_urltable($name) {
global $config;
$urltable_prefix = "/var/db/aliastables/";
$urltable_filename = $urltable_prefix . $name . ".txt";
if (is_array($config['aliases']['alias'])) {
foreach ($config['aliases']['alias'] as $alias) {
if (preg_match("/urltable/i", $alias['type']) && ($alias['name'] == $name)) {
if (is_URL($alias["url"]) && file_exists($urltable_filename)) {
if (!filesize($urltable_filename)) {
// file exists, but is empty, try to sync
send_event("service sync alias {$name}");
}
return $urltable_filename;
} else {
send_event("service sync alias {$name}");
break;
}
}
}
}
return null;
}
/* obtain MAC address given an IP address by looking at the ARP/NDP table */
function arp_get_mac_by_ip($ip, $do_ping = true) {
unset($macaddr);
$retval = 1;
switch (is_ipaddr($ip)) {
case 4:
if ($do_ping === true) {
mwexec("/sbin/ping -c 1 -t 1 " . escapeshellarg($ip), true);
}
$macaddr = exec("/usr/sbin/arp -n " . escapeshellarg($ip) . " | /usr/bin/awk '{print $4}'", $output, $retval);
break;
case 6:
if ($do_ping === true) {
mwexec("/sbin/ping6 -c 1 -X 1 " . escapeshellarg($ip), true);
}
$macaddr = exec("/usr/sbin/ndp -n " . escapeshellarg($ip) . " | /usr/bin/awk '{print $2}'", $output, $retval);
break;
}
if ($retval == 0 && is_macaddr($macaddr)) {
return $macaddr;
} else {
return false;
}
}
/* return a fieldname that is safe for xml usage */
function xml_safe_fieldname($fieldname) {
$replace = array(
'/', '-', ' ', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')',
'_', '+', '=', '{', '}', '[', ']', '|', '/', '<', '>', '?',
':', ',', '.', '\'', '\\'
);
return strtolower(str_replace($replace, "", $fieldname));
}
function mac_format($clientmac) {
global $config, $cpzone;
$mac = explode(":", $clientmac);
$mac_format = $cpzone ? $config['captiveportal'][$cpzone]['radmac_format'] : false;
switch ($mac_format) {
case 'singledash':
return "$mac[0]$mac[1]$mac[2]-$mac[3]$mac[4]$mac[5]";
case 'ietf':
return "$mac[0]-$mac[1]-$mac[2]-$mac[3]-$mac[4]-$mac[5]";
case 'cisco':
return "$mac[0]$mac[1].$mac[2]$mac[3].$mac[4]$mac[5]";
case 'unformatted':
return "$mac[0]$mac[1]$mac[2]$mac[3]$mac[4]$mac[5]";
default:
return $clientmac;
}
}
function resolve_retry($hostname, $retries = 5) {
if (is_ipaddr($hostname)) {
return $hostname;
}
for ($i = 0; $i < $retries; $i++) {
// FIXME: gethostbyname does not work for AAAA hostnames, boo, hiss
$ip = gethostbyname($hostname);
if ($ip && $ip != $hostname) {
/* success */
return $ip;
}
sleep(1);
}
return false;
}
function format_bytes($bytes) {
if ($bytes >= 1099511627776) {
return sprintf("%.2f TiB", $bytes/1099511627776);
} else if ($bytes >= 1073741824) {
return sprintf("%.2f GiB", $bytes/1073741824);
} else if ($bytes >= 1048576) {
return sprintf("%.2f MiB", $bytes/1048576);
} else if ($bytes >= 1024) {
return sprintf("%.0f KiB", $bytes/1024);
} else {
return sprintf("%d B", $bytes);
}
}
function format_number($num, $precision = 3) {
$units = array('', 'K', 'M', 'G', 'T');
$i = 0;
while ($num > 1000 && $i < count($units)) {
$num /= 1000;
$i++;
}
$num = round($num, $precision);
return ("$num {$units[$i]}");
}
function update_filter_reload_status($text, $new=false) {
global $g;
if ($new) {
file_put_contents("{$g['varrun_path']}/filter_reload_status", $text . PHP_EOL);
} else {
file_put_contents("{$g['varrun_path']}/filter_reload_status", $text . PHP_EOL, FILE_APPEND);
}
}
/****** util/return_dir_as_array
* NAME
* return_dir_as_array - Return a directory's contents as an array.
* INPUTS
* $dir - string containing the path to the desired directory.
* $filter_regex - string containing a regular expression to filter file names. Default empty.
* RESULT
* $dir_array - array containing the directory's contents. This array will be empty if the path specified is invalid.
******/
function return_dir_as_array($dir, $filter_regex = '') {
$dir_array = array();
if (is_dir($dir)) {
if ($dh = opendir($dir)) {
while (($file = readdir($dh)) !== false) {
if (($file == ".") || ($file == "..")) {
continue;
}
if (empty($filter_regex) || preg_match($filter_regex, $file)) {
array_push($dir_array, $file);
}
}
closedir($dh);
}
}
return $dir_array;
}
function run_plugins($directory) {
global $config, $g;
/* process packager manager custom rules */
$files = return_dir_as_array($directory);
if (is_array($files)) {
foreach ($files as $file) {
if (stristr($file, ".sh") == true) {
mwexec($directory . $file . " start");
} else if (!is_dir($directory . "/" . $file) && stristr($file, ".inc")) {
require_once($directory . "/" . $file);
}
}
}
}
/*
* safe_mkdir($path, $mode = 0755)
* create directory if it doesn't already exist and isn't a file!
*/
function safe_mkdir($path, $mode = 0755) {
global $g;
if (!is_file($path) && !is_dir($path)) {
return @mkdir($path, $mode, true);
} else {
return false;
}
}
/*
* get_sysctl($names)
* Get values of sysctl OID's listed in $names (accepts an array or a single
* name) and return an array of key/value pairs set for those that exist
*/
function get_sysctl($names) {
if (empty($names)) {
return array();
}
if (is_array($names)) {
$name_list = array();
foreach ($names as $name) {
$name_list[] = escapeshellarg($name);
}
} else {
$name_list = array(escapeshellarg($names));
}
exec("/sbin/sysctl -i " . implode(" ", $name_list), $output);
$values = array();
foreach ($output as $line) {
$line = explode(": ", $line, 2);
if (count($line) == 2) {
$values[$line[0]] = $line[1];
}
}
return $values;
}
/*
* get_single_sysctl($name)
* Wrapper for get_sysctl() to simplify read of a single sysctl value
* return the value for sysctl $name or empty string if it doesn't exist
*/
function get_single_sysctl($name) {
if (empty($name)) {
return "";
}
$value = get_sysctl($name);
if (empty($value) || !isset($value[$name])) {
return "";
}
return $value[$name];
}
/*
* set_sysctl($value_list)
* Set sysctl OID's listed as key/value pairs and return
* an array with keys set for those that succeeded
*/
function set_sysctl($values) {
if (empty($values)) {
return array();
}
$value_list = array();
foreach ($values as $key => $value) {
$value_list[] = escapeshellarg($key) . "=" . escapeshellarg($value);
}
exec("/sbin/sysctl -i " . implode(" ", $value_list), $output, $success);
/* Retry individually if failed (one or more read-only) */
if ($success <> 0 && count($value_list) > 1) {
foreach ($value_list as $value) {
exec("/sbin/sysctl -i " . $value, $output);
}
}
$ret = array();
foreach ($output as $line) {
$line = explode(": ", $line, 2);
if (count($line) == 2) {
$ret[$line[0]] = true;
}
}
return $ret;
}
/*
* set_single_sysctl($name, $value)
* Wrapper to set_sysctl() to make it simple to set only one sysctl
* returns boolean meaning if it succeeded
*/
function set_single_sysctl($name, $value) {
if (empty($name)) {
return false;
}
$result = set_sysctl(array($name => $value));
if (!isset($result[$name]) || $result[$name] != $value) {
return false;
}
return true;
}
/*
* get_memory()
* returns an array listing the amount of
* memory installed in the hardware
* [0] net memory available for the OS (FreeBSD) after some is taken by BIOS, video or whatever - e.g. 235 MBytes
* [1] real (actual) memory of the system, should be the size of the RAM card/s - e.g. 256 MBytes
*/
function get_memory() {
$physmem = get_single_sysctl("hw.physmem");
$realmem = get_single_sysctl("hw.realmem");
/* convert from bytes to megabytes */
return array(($physmem/1048576), ($realmem/1048576));
}
function mute_kernel_msgs() {
global $g, $config;
if ($config['system']['enableserial']) {
return;
}
exec("/sbin/conscontrol mute on");
}
function unmute_kernel_msgs() {
global $g;
exec("/sbin/conscontrol mute off");
}
function start_devd() {
global $g;
/* Use the undocumented -q options of devd to quiet its log spamming */
$_gb = exec("/sbin/devd -q -f /etc/{$g['product_name']}-devd.conf");
sleep(1);
unset($_gb);
}
function is_interface_vlan_mismatch() {
global $config, $g;
if (is_array($config['vlans']['vlan'])) {
foreach ($config['vlans']['vlan'] as $vlan) {
if (substr($vlan['if'], 0, 4) == "lagg") {
return false;
}
if (does_interface_exist($vlan['if']) == false) {
return true;
}
}
}
return false;
}
function is_interface_mismatch() {
global $config, $g;
$do_assign = false;
$i = 0;
$missing_interfaces = array();
if (is_array($config['interfaces'])) {
foreach ($config['interfaces'] as $ifname => $ifcfg) {
if (preg_match("/^enc|^cua|^tun|^tap|^l2tp|^pptp|^ppp|^ovpn|^gif|^gre|^lagg|^bridge|vlan|_wlan|_\d{0,4}_\d{0,4}$/i", $ifcfg['if'])) {
// Do not check these interfaces.
$i++;
continue;
} else if (does_interface_exist($ifcfg['if']) == false) {
$missing_interfaces[] = $ifcfg['if'];
$do_assign = true;
} else {
$i++;
}
}
}
if (file_exists("{$g['tmp_path']}/assign_complete")) {
$do_assign = false;
}
if (!empty($missing_interfaces) && $do_assign) {
file_put_contents("{$g['tmp_path']}/missing_interfaces", implode(' ', $missing_interfaces));
} else {
@unlink("{$g['tmp_path']}/missing_interfaces");
}
return $do_assign;
}
/* sync carp entries to other firewalls */
function carp_sync_client() {
global $g;
send_event("filter sync");
}
/****f* util/isAjax
* NAME
* isAjax - reports if the request is driven from prototype
* INPUTS
* none
* RESULT
* true/false
******/
function isAjax() {
return isset ($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest';
}
/****f* util/timeout
* NAME
* timeout - console input with timeout countdown. Note: erases 2 char of screen for timer. Leave space.
* INPUTS
* optional, seconds to wait before timeout. Default 9 seconds.
* RESULT
* returns 1 char of user input or null if no input.
******/
function timeout($timer = 9) {
while (!isset($key)) {
if ($timer >= 9) {
echo chr(8) . chr(8) . ($timer == 9 ? chr(32) : null) . "{$timer}";
} else {
echo chr(8). "{$timer}";
}
`/bin/stty -icanon min 0 time 25`;
$key = trim(`KEY=\`dd count=1 2>/dev/null\`; echo \$KEY`);
`/bin/stty icanon`;
if ($key == '') {
unset($key);
}
$timer--;
if ($timer == 0) {
break;
}
}
return $key;
}
/****f* util/msort
* NAME
* msort - sort array
* INPUTS
* $array to be sorted, field to sort by, direction of sort
* RESULT
* returns newly sorted array
******/
function msort($array, $id = "id", $sort_ascending = true) {
$temp_array = array();
while (count($array)>0) {
$lowest_id = 0;
$index = 0;
foreach ($array as $item) {
if (isset($item[$id])) {
if ($array[$lowest_id][$id]) {
if (strtolower($item[$id]) < strtolower($array[$lowest_id][$id])) {
$lowest_id = $index;
}
}
}
$index++;
}
$temp_array[] = $array[$lowest_id];
$array = array_merge(array_slice($array, 0, $lowest_id), array_slice($array, $lowest_id + 1));
}
if ($sort_ascending) {
return $temp_array;
} else {
return array_reverse($temp_array);
}
}
/****f* util/is_URL
* NAME
* is_URL
* INPUTS
* string to check
* RESULT
* Returns true if item is a URL
******/
function is_URL($url) {
$match = preg_match("'\b(([\w-]+://?|www[.])[^\s()<>]+(?:\([\w\d]+\)|([^[:punct:]\s]|/)))'", $url);
if ($match) {
return true;
}
return false;
}
function is_file_included($file = "") {
$files = get_included_files();
if (in_array($file, $files)) {
return true;
}
return false;
}
/*
* Replace a value on a deep associative array using regex
*/
function array_replace_values_recursive($data, $match, $replace) {
if (empty($data)) {
return $data;
}
if (is_string($data)) {
$data = preg_replace("/{$match}/", $replace, $data);
} else if (is_array($data)) {
foreach ($data as $k => $v) {
$data[$k] = array_replace_values_recursive($v, $match, $replace);
}
}
return $data;
}
/*
This function was borrowed from a comment on PHP.net at the following URL:
http://www.php.net/manual/en/function.array-merge-recursive.php#73843
*/
function array_merge_recursive_unique($array0, $array1) {
$arrays = func_get_args();
$remains = $arrays;
// We walk through each arrays and put value in the results (without
// considering previous value).
$result = array();
// loop available array
foreach ($arrays as $array) {
// The first remaining array is $array. We are processing it. So
// we remove it from remaining arrays.
array_shift($remains);
// We don't care non array param, like array_merge since PHP 5.0.
if (is_array($array)) {
// Loop values
foreach ($array as $key => $value) {
if (is_array($value)) {
// we gather all remaining arrays that have such key available
$args = array();
foreach ($remains as $remain) {
if (array_key_exists($key, $remain)) {
array_push($args, $remain[$key]);
}
}
if (count($args) > 2) {
// put the recursion
$result[$key] = call_user_func_array(__FUNCTION__, $args);
} else {
foreach ($value as $vkey => $vval) {
$result[$key][$vkey] = $vval;
}
}
} else {
// simply put the value
$result[$key] = $value;
}
}
}
}
return $result;
}
/*
* converts a string like "a,b,c,d"
* into an array like array("a" => "b", "c" => "d")
*/
function explode_assoc($delimiter, $string) {
$array = explode($delimiter, $string);
$result = array();
$numkeys = floor(count($array) / 2);
for ($i = 0; $i < $numkeys; $i += 1) {
$result[$array[$i * 2]] = $array[$i * 2 + 1];
}
return $result;
}
/*
* Given a string of text with some delimiter, look for occurrences
* of some string and replace all of those.
* $text - the text string (e.g. "abc,defg,x123,ipv4,xyz")
* $delimiter - the delimiter (e.g. ",")
* $element - the element to match (e.g. "defg")
* $replacement - the string to replace it with (e.g. "42")
* Returns the resulting delimited string (e.g. "abc,42,x123,ipv4,xyz")
*/
function replace_element_in_list($text, $delimiter, $element, $replacement) {
$textArray = explode($delimiter, $text);
while (($entry = array_search($element, $textArray)) !== false) {
$textArray[$entry] = $replacement;
}
return implode(',', $textArray);
}
/* Try to change a static route, if it doesn't exist, add it */
function route_add_or_change($args) {
global $config;
if (empty($args)) {
return false;
}
/* First, try to add it */
$_gb = exec(escapeshellcmd("/sbin/route add " . $args), $output, $rc);
if (isset($config['system']['route-debug'])) {
$mt = microtime();
log_error("ROUTING debug: $mt - ADD RC={$rc} - $args");
}
if ($rc != 0) {
/* If it fails, try to change it */
$_gb = exec(escapeshellcmd("/sbin/route change " . $args),
$output, $rc);
if (isset($config['system']['route-debug'])) {
$mt = microtime();
log_error("ROUTING debug: $mt - CHG RC={$rc} - $args");
}
}
return ($rc == 0);
}
function get_staticroutes($returnsubnetsonly = false, $returnhostnames = false, $returnenabledroutesonly = false) {
global $config, $aliastable;
/* Bail if there are no routes, but return an array always so callers don't have to check. */
if (!is_array($config['staticroutes']['route'])) {
return array();
}
$allstaticroutes = array();
$allsubnets = array();
/* Loop through routes and expand aliases as we find them. */
foreach ($config['staticroutes']['route'] as $route) {
if ($returnenabledroutesonly && isset($route['disabled'])) {
continue;
}
if (is_alias($route['network'])) {
if (!isset($aliastable[$route['network']])) {
continue;
}
$subnets = preg_split('/\s+/', $aliastable[$route['network']]);
foreach ($subnets as $net) {
if (!is_subnet($net)) {
if (is_ipaddrv4($net)) {
$net .= "/32";
} else if (is_ipaddrv6($net)) {
$net .= "/128";
} else if ($returnhostnames === false || !is_fqdn($net)) {
continue;
}
}
$temproute = $route;
$temproute['network'] = $net;
$allstaticroutes[] = $temproute;
$allsubnets[] = $net;
}
} elseif (is_subnet($route['network'])) {
$allstaticroutes[] = $route;
$allsubnets[] = $route['network'];
}
}
if ($returnsubnetsonly) {
return $allsubnets;
} else {
return $allstaticroutes;
}
}
/****f* util/get_alias_list
* NAME
* get_alias_list - Provide a list of aliases.
* INPUTS
* $type - Optional, can be a string or array specifying what type(s) of aliases you need.
* RESULT
* Array containing list of aliases.
* If $type is unspecified, all aliases are returned.
* If $type is a string, all aliases of the type specified in $type are returned.
* If $type is an array, all aliases of any type specified in any element of $type are returned.
*/
function get_alias_list($type = null) {
global $config;
$result = array();
if ($config['aliases']['alias'] <> "" && is_array($config['aliases']['alias'])) {
foreach ($config['aliases']['alias'] as $alias) {
if ($type === null) {
$result[] = $alias['name'];
} else if (is_array($type)) {
if (in_array($alias['type'], $type)) {
$result[] = $alias['name'];
}
} else if ($type === $alias['type']) {
$result[] = $alias['name'];
}
}
}
return $result;
}
/* returns an array consisting of every element of $haystack that is not equal to $needle. */
function array_exclude($needle, $haystack) {
$result = array();
if (is_array($haystack)) {
foreach ($haystack as $thing) {
if ($needle !== $thing) {
$result[] = $thing;
}
}
}
return $result;
}
/* Define what is preferred, IPv4 or IPv6 */
function prefer_ipv4_or_ipv6() {
global $config;
if (isset($config['system']['prefer_ipv4'])) {
mwexec("/etc/rc.d/ip6addrctl prefer_ipv4");
} else {
mwexec("/etc/rc.d/ip6addrctl prefer_ipv6");
}
}
/* Redirect to page passing parameters via POST */
function post_redirect($page, $params) {
if (!is_array($params)) {
return;
}
print "<html><body><form action=\"{$page}\" name=\"formredir\" method=\"post\">\n";
foreach ($params as $key => $value) {
print "<input type=\"hidden\" name=\"{$key}\" value=\"{$value}\" />\n";
}
print "</form>\n";
print "<script type=\"text/javascript\">\n";
print "//<![CDATA[\n";
print "document.formredir.submit();\n";
print "//]]>\n";
print "</script>\n";
print "</body></html>\n";
}
/* Locate disks that can be queried for S.M.A.R.T. data. */
function get_smart_drive_list() {
$disk_list = explode(" ", get_single_sysctl("kern.disks"));
foreach ($disk_list as $id => $disk) {
// We only want certain kinds of disks for S.M.A.R.T.
// 1 is a match, 0 is no match, False is any problem processing the regex
if (preg_match("/^(ad|da|ada).*[0-9]{1,2}$/", $disk) !== 1) {
unset($disk_list[$id]);
}
}
sort($disk_list);
return $disk_list;
}
// Validate a network address
// $addr: the address to validate
// $type: IPV4|IPV6|IPV4V6
// $label: the label used by the GUI to display this value. Required to compose an error message
// $err_msg: pointer to the callers error message array so that error messages can be added to it here
// $alias: are aliases permitted for this address?
// Returns:
// IPV4 - if $addr is a valid IPv4 address
// IPV6 - if $addr is a valid IPv6 address
// ALIAS - if $alias=true and $addr is an alias
// false - otherwise
function validateipaddr(&$addr, $type, $label, &$err_msg, $alias=false) {
switch ($type) {
case IPV4:
if (is_ipaddrv4($addr)) {
return IPV4;
} else if ($alias) {
if (is_alias($addr)) {
return ALIAS;
} else {
$err_msg[] = sprintf(gettext("%s must be a valid IPv4 address or alias."), $label);
return false;
}
} else {
$err_msg[] = sprintf(gettext("%s must be a valid IPv4 address."), $label);
return false;
}
break;
case IPV6:
if (is_ipaddrv6($addr)) {
$addr = strtolower($addr);
return IPV6;
} else if ($alias) {
if (is_alias($addr)) {
return ALIAS;
} else {
$err_msg[] = sprintf(gettext("%s must be a valid IPv6 address or alias."), $label);
return false;
}
} else {
$err_msg[] = sprintf(gettext("%s must be a valid IPv6 address."), $label);
return false;
}
break;
case IPV4V6:
if (is_ipaddrv6($addr)) {
$addr = strtolower($addr);
return IPV6;
} else if (is_ipaddrv4($addr)) {
return IPV4;
} else if ($alias) {
if (is_alias($addr)) {
return ALIAS;
} else {
$err_msg[] = sprintf(gettext("%s must be a valid IPv4 or IPv6 address or alias."), $label);
return false;
}
} else {
$err_msg[] = sprintf(gettext("%s must be a valid IPv4 or IPv6 address."), $label);
return false;
}
break;
}
return false;
}
/* format a string to look (more) like the expected DUID format:
* 1) Replace any "-" with ":"
* 2) If the user inputs 14 components, then add the expected "0e:00:" to the front.
* This is convenience, because the actual DUID (which is reported in logs) is the last 14 components.
* 3) If any components are input with just a single char (hex digit hopefully), put a "0" in front.
*
* The final result should be closer to:
*
* "0e:00:00:01:00:01:nn:nn:nn:nn:nn:nn:nn:nn:nn:nn"
*
* This function does not validate the input. is_duid() will do validation.
*/
function format_duid($dhcp6duid) {
$values = explode(":", strtolower(str_replace("-", ":", $dhcp6duid)));
if (count($values) == 14) {
array_unshift($values, "0e", "00");
}
array_walk($values, function(&$value) {
$value = str_pad($value, 2, '0', STR_PAD_LEFT);
});
return implode(":", $values);
}
/* returns true if $dhcp6duid is a valid duid entry */
function is_duid($dhcp6duid) {
$values = explode(":", $dhcp6duid);
if (count($values) != 16 || strlen($dhcp6duid) != 47) {
return false;
}
for ($i = 0; $i < 16; $i++) {
if (ctype_xdigit($values[$i]) == false)
return false;
if (hexdec($values[$i]) < 0 || hexdec($values[$i]) > 255)
return false;
}
return true;
}
/* Write the DHCP6 DUID file */
function write_dhcp6_duid($duidstring) {
// Create the hex array from the dhcp6duid config entry and write to file
global $g;
if(!is_duid($duidstring)) {
log_error(gettext("Error: attempting to write DUID file - Invalid DUID detected"));
return false;
}
$temp = str_replace(":","",$duidstring);
$duid_binstring = pack("H*",$temp);
if ($fd = fopen("{$g['vardb_path']}/dhcp6c_duid", "wb")) {
fwrite($fd, $duid_binstring);
fclose($fd);
return true;
}
log_error(gettext("Error: attempting to write DUID file - File write error"));
return false;
}
/* returns duid string from 'vardb_path']}/dhcp6c_duid' */
function get_duid_from_file() {
global $g;
$duid_ASCII = "";
$count = 0;
if (file_exists("{$g['vardb_path']}/dhcp6c_duid") &&
($fd = fopen("{$g['vardb_path']}/dhcp6c_duid", "r"))) {
if(filesize("{$g['vardb_path']}/dhcp6c_duid")==16) {
$buffer = fread($fd,16);
while($count < 16) {
$duid_ASCII .= bin2hex($buffer[$count]);
$count++;
if($count < 16) {
$duid_ASCII .= ":";
}
}
}
fclose($fd);
}
//if no file or error with read then the string returns blanked DUID string
if(!is_duid($duid_ASCII)) {
return "--:--:--:--:--:--:--:--:--:--:--:--:--:--:--:--";
}
return($duid_ASCII);
}
/* Replaces the Mac OS 9 and earlier (\r) and DOS/Windows (\r\n) newlines with the Unix equivalent (\n). */
function unixnewlines($text) {
return preg_replace('/\r\n?/', "\n", $text);
}
?>
|