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
|
/**
*
* Copyright (c) 1999-2009 Jim Hull <imaginos@imaginos.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:
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 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.
* Redistributions in any form must be accompanied by information on how to obtain
* complete source code for this software and any accompanying software that uses this software.
* The source code must either be included in the distribution or be available for no more than
* the cost of distribution plus a nominal fee, and must be freely redistributable
* under reasonable conditions. For an executable file, complete source code means the source
* code for all modules it contains. It does not include source code for modules or files
* that typically accompany the major components of the operating system on which the executable file runs.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
* OR NON-INFRINGEMENT, ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OF THIS SOFTWARE 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.
*
*
*/
// note to compile with win32 need to link to winsock2, using gcc its -lws2_32
#ifndef _HAS_CSOCKET_
#define _HAS_CSOCKET_
#include "defines.h" // require this as a general rule, most projects have a defines.h or the like
#include <stdio.h>
#include <unistd.h>
#include <sys/time.h>
#include <sys/types.h>
#include <sys/fcntl.h>
#include <sys/file.h>
#ifndef _WIN32
#include <netinet/in.h>
#include <arpa/inet.h>
#include <sys/socket.h>
#include <sys/ioctl.h>
#include <netdb.h>
#else
#include <winsock2.h>
#include <ws2tcpip.h>
#include <sys/timeb.h>
#define ECONNREFUSED WSAECONNREFUSED
#define EINPROGRESS WSAEINPROGRESS
#define ETIMEDOUT WSAETIMEDOUT
#define EADDRNOTAVAIL WSAEADDRNOTAVAIL
#define ECONNABORTED WSAECONNABORTED
#define ENETUNREACH WSAENETUNREACH
#endif /* _WIN32 */
#ifdef HAVE_C_ARES
#include <ares.h>
#endif /* HAVE_C_ARES */
#include <stdlib.h>
#include <errno.h>
#include <string.h>
#include <ctype.h>
#include <assert.h>
#ifdef HAVE_LIBSSL
#include <openssl/ssl.h>
#include <openssl/err.h>
#include <openssl/rand.h>
#endif /* HAVE_LIBSSL */
#ifdef __sun
#include <strings.h>
#include <fcntl.h>
#endif /* __sun */
#include <vector>
#include <list>
#include <iostream>
#include <sstream>
#include <string>
#include <set>
#include <map>
#ifndef CS_STRING
# ifdef _HAS_CSTRING_
# define CS_STRING Cstring
# else
# define CS_STRING std::string
# endif /* _HAS_CSTRING_ */
#endif /* CS_STRING */
#ifndef CS_DEBUG
#ifdef __DEBUG__
# define CS_DEBUG( f ) std::cerr << __FILE__ << ":" << __LINE__ << " " << f << std::endl
#else
# define CS_DEBUG(f) (void)0
#endif /* __DEBUG__ */
#endif /* CS_DEBUG */
#ifndef PERROR
#ifdef __DEBUG__
# define PERROR( f ) __Perror( f, __FILE__, __LINE__ )
#else
# define PERROR( f ) (void)0
#endif /* __DEBUG__ */
#endif /* PERROR */
#ifdef _WIN32
typedef SOCKET cs_sock_t;
#ifdef _WIN64
typedef signed __int64 cs_ssize_t;
#else
typedef signed int cs_ssize_t;
#endif /* _WIN64 */
#define CS_INVALID_SOCK INVALID_SOCKET
#else
typedef int cs_sock_t;
typedef ssize_t cs_ssize_t;
#define CS_INVALID_SOCK -1
#endif /* _WIN32 */
#ifdef CSOCK_USE_POLL
#include <poll.h>
#endif /* CSOCK_USE_POLL */
#ifndef _NO_CSOCKET_NS // some people may not want to use a namespace
namespace Csocket
{
#endif /* _NO_CSOCKET_NS */
/**
* @class CSCharBuffer
* @brief ease of use self deleting char * class
*/
class CSCharBuffer
{
public:
CSCharBuffer( size_t iSize )
{
m_pBuffer = (char *)malloc( iSize );
}
~CSCharBuffer()
{
free( m_pBuffer );
}
char * operator()() { return( m_pBuffer ); }
private:
char * m_pBuffer;
};
class CSSockAddr
{
public:
CSSockAddr()
{
m_bIsIPv6 = false;
memset( (struct sockaddr_in *)&m_saddr, '\0', sizeof( m_saddr ) );
#ifdef HAVE_IPV6
memset( (struct sockaddr_in6 *)&m_saddr6, '\0', sizeof( m_saddr6 ) );
#endif /* HAVE_IPV6 */
m_iAFRequire = RAF_ANY;
}
virtual ~CSSockAddr() {}
enum EAFRequire
{
RAF_ANY = PF_UNSPEC,
#ifdef HAVE_IPV6
RAF_INET6 = AF_INET6,
#endif /* HAVE_IPV6 */
RAF_INET = AF_INET
};
void SinFamily()
{
#ifdef HAVE_IPV6
m_saddr6.sin6_family = PF_INET6;
#endif /* HAVE_IPV6 */
m_saddr.sin_family = PF_INET;
}
void SinPort( u_short iPort )
{
#ifdef HAVE_IPV6
m_saddr6.sin6_port = htons( iPort );
#endif /* HAVE_IPV6 */
m_saddr.sin_port = htons( iPort );
}
void SetIPv6( bool b )
{
#ifndef HAVE_IPV6
if( b )
{
CS_DEBUG( "-DHAVE_IPV6 must be set during compile time to enable this feature" );
m_bIsIPv6 = false;
return;
}
#endif /* HAVE_IPV6 */
m_bIsIPv6 = b;
SinFamily();
}
bool GetIPv6() const { return( m_bIsIPv6 ); }
socklen_t GetSockAddrLen() { return( sizeof( m_saddr ) ); }
sockaddr_in * GetSockAddr() { return( &m_saddr ); }
in_addr * GetAddr() { return( &(m_saddr.sin_addr) ); }
#ifdef HAVE_IPV6
socklen_t GetSockAddrLen6() { return( sizeof( m_saddr6 ) ); }
sockaddr_in6 * GetSockAddr6() { return( &m_saddr6 ); }
in6_addr * GetAddr6() { return( &(m_saddr6.sin6_addr) ); }
#endif /* HAVE_IPV6 */
void SetAFRequire( EAFRequire iWhich ) { m_iAFRequire = iWhich; }
EAFRequire GetAFRequire() const { return( m_iAFRequire ); }
private:
bool m_bIsIPv6;
sockaddr_in m_saddr;
#ifdef HAVE_IPV6
sockaddr_in6 m_saddr6;
#endif /* HAVE_IPV6 */
EAFRequire m_iAFRequire;
};
class Csock;
/**
* @brief this function is a wrapper around gethostbyname and getaddrinfo (for ipv6)
*
* in the event this code is using ipv6, it calls getaddrinfo, and it tries to start the connection on each iteration
* in the linked list returned by getaddrinfo. if pSock is not NULL the following behavior happens.
* - if pSock is a listener, or if the connect state is in a bind vhost state (to be used with bind) AI_PASSIVE is sent to getaddrinfo
* - if pSock is an outbound connection, AI_ADDRCONFIG and the connection is started from within this function.
* getaddrinfo might return multiple (possibly invalid depending on system configuration) ip addresses, so connect needs to try them all.
* A classic example of this is a hostname that resolves to both ipv4 and ipv6 ip's. You still need to call Connect (and ConnectSSL) to finish
* up the connection state
* - NOTE ... Once threading is reimplemented, this function will spin off a thread to resolve and return EAGAIN until its done.
*
* @param sHostname the host to resolve
* @param pSock the sock being setup, this option can be NULL, if it is null csSockAddr is only setup
* @param csSockAddr the struct that sockaddr data is being copied to
* @return 0 on success, otherwise an error. EAGAIN if this needs to be called again at a later time, ETIMEDOUT if no host is found
*/
int GetAddrInfo( const CS_STRING & sHostname, Csock *pSock, CSSockAddr & csSockAddr );
//! used to retrieve the context position of the socket to its associated ssl connection. Setup once in InitSSL() via SSL_get_ex_new_index
int GetCsockClassIdx();
#ifdef HAVE_LIBSSL
//! returns the sock object associated to the particular context. returns NULL on failure or if not available
Csock *GetCsockFromCTX( X509_STORE_CTX *pCTX );
#endif /* HAVE_LIBSSL */
const u_int CS_BLOCKSIZE = 4096;
template <class T> inline void CS_Delete( T * & p ) { if( p ) { delete p; p = NULL; } }
#ifdef HAVE_LIBSSL
enum ECompType
{
CT_NONE = 0,
CT_ZLIB = 1,
CT_RLE = 2
};
void SSLErrors( const char *filename, u_int iLineNum );
/**
* @brief You HAVE to call this in order to use the SSL library, calling InitCsocket() also calls this
* so unless you need to call InitSSL for a specific reason call InitCsocket()
* @return true on success
*/
bool InitSSL( ECompType eCompressionType = CT_NONE );
#endif /* HAVE_LIBSSL */
/**
* This does all the csocket initialized inclusing InitSSL() and win32 specific initializations, only needs to be called once
*/
bool InitCsocket();
/**
* Shutdown and release global allocated memory
*/
void ShutdownCsocket();
//! @todo need to make this sock specific via getsockopt
inline int GetSockError()
{
#ifdef _WIN32
return( WSAGetLastError() );
#else
return( errno );
#endif /* _WIN32 */
}
//! wrappers for FD_SET and such to work in templates.
inline void TFD_ZERO( fd_set *set )
{
FD_ZERO( set );
}
inline void TFD_SET( cs_sock_t iSock, fd_set *set )
{
FD_SET( iSock, set );
}
inline bool TFD_ISSET( cs_sock_t iSock, fd_set *set )
{
if ( FD_ISSET( iSock, set ) )
return( true );
return( false );
}
inline void TFD_CLR( cs_sock_t iSock, fd_set *set )
{
FD_CLR( iSock, set );
}
void __Perror( const CS_STRING & s, const char *pszFile, unsigned int iLineNo );
unsigned long long millitime();
/**
* @class CCron
* @brief this is the main cron job class
*
* You should derive from this class, and override RunJob() with your code
* @author Jim Hull <imaginos@imaginos.net>
*/
class CCron
{
public:
CCron();
virtual ~CCron() {}
//! This is used by the Job Manager, and not you directly
void run( time_t & iNow );
/**
* @param TimeSequence how often to run in seconds
* @param iMaxCycles how many times to run, 0 makes it run forever
*/
void StartMaxCycles( int TimeSequence, u_int iMaxCycles );
//! starts and runs infinity amount of times
void Start( int TimeSequence );
//! call this to turn off your cron, it will be removed
void Stop();
//! pauses excution of your code in RunJob
void Pause();
//! removes the pause on RunJon
void UnPause();
int GetInterval() const;
u_int GetMaxCycles() const;
u_int GetCyclesLeft() const;
//! returns true if cron is active
bool isValid();
const CS_STRING & GetName() const;
void SetName( const CS_STRING & sName );
//! returns the timestamp of the next estimated run time. Note that it may not run at this EXACT time, but it will run at least at this time or after
time_t GetNextRun() const { return( m_iTime ); }
public:
//! this is the method you should override
virtual void RunJob();
protected:
bool m_bRunOnNextCall; //!< if set to true, RunJob() gets called on next invocation of run() despite the timeout
private:
time_t m_iTime;
bool m_bActive, m_bPause;
int m_iTimeSequence;
u_int m_iMaxCycles, m_iCycles;
CS_STRING m_sName;
};
#ifdef HAVE_LIBSSL
typedef int (*FPCertVerifyCB)( int, X509_STORE_CTX * );
#endif /* HAVE_LIBSSL */
/**
* @class Csock
* @brief Basic Socket Class
* The most basic level socket class
* You can use this class directly for quick things
* or use the socket manager
* @see TSocketManager
* @author Jim Hull <imaginos@imaginos.net>
*/
class Csock
{
public:
//! default constructor, sets a timeout of 60 seconds
Csock( int itimeout = 60 );
/**
* Advanced constructor, for creating a simple connection
*
* @param sHostname the hostname your are connecting to
* @param uPort the port you are connectint to
* @param itimeout how long to wait before ditching the connection, default is 60 seconds
*/
Csock( const CS_STRING & sHostname, u_short uPort, int itimeout = 60 );
//! override this for accept sockets
virtual Csock *GetSockObj( const CS_STRING & sHostname, u_short iPort );
virtual ~Csock();
/**
* @brief in the event you pass this class to Copy(), you MUST call this function or
* on the original Csock other wise bad side effects will happen (double deletes, weird sock closures, etc)
* if you call this function and have not handled the internal pointers, other bad things can happend (memory leaks, fd leaks, etc)
* the whole point of this function is to allow this class to go away without shutting down
*/
virtual void Dereference();
//! use this to copy a sock from one to the other, override it if you have special needs in the event of a copy
virtual void Copy( const Csock & cCopy );
enum ETConn
{
OUTBOUND = 0, //!< outbound connection
LISTENER = 1, //!< a socket accepting connections
INBOUND = 2 //!< an inbound connection, passed from LISTENER
};
enum EFRead
{
READ_EOF = 0, //!< End Of File, done reading
READ_ERR = -1, //!< Error on the socket, socket closed, done reading
READ_EAGAIN = -2, //!< Try to get data again
READ_CONNREFUSED = -3, //!< Connection Refused
READ_TIMEDOUT = -4 //!< Connection timed out
};
enum EFSelect
{
SEL_OK = 0, //!< Select passed ok
SEL_TIMEOUT = -1, //!< Select timed out
SEL_EAGAIN = -2, //!< Select wants you to try again
SEL_ERR = -3 //!< Select recieved an error
};
enum ESSLMethod
{
SSL23 = 0,
SSL2 = 2,
SSL3 = 3,
TLS1 = 4
};
enum ECONState
{
CST_START = 0,
CST_DNS = CST_START,
CST_BINDVHOST = 1,
CST_DESTDNS = 2,
CST_CONNECT = 3,
CST_CONNECTSSL = 4,
CST_OK = 5
};
enum ECloseType
{
CLT_DONT = 0, //! don't close DER
CLT_NOW = 1, //! close immediatly
CLT_AFTERWRITE = 2, //! close after finishing writing the buffer
CLT_DEREFERENCE = 3 //! used after copy in Csock::Dereference() to cleanup a sock thats being shutdown
};
Csock & operator<<( const CS_STRING & s );
Csock & operator<<( std::ostream & ( *io )( std::ostream & ) );
Csock & operator<<( int i );
Csock & operator<<( unsigned int i );
Csock & operator<<( long i );
Csock & operator<<( unsigned long i );
Csock & operator<<( unsigned long long i );
Csock & operator<<( float i );
Csock & operator<<( double i );
/**
* Create the connection
*
* @param sBindHost the ip you want to bind to locally
* @param bSkipSetup if true, setting up the vhost etc is skipped
* @return true on success
*/
virtual bool Connect( const CS_STRING & sBindHost = "", bool bSkipSetup = false );
/**
* WriteSelect on this socket
* Only good if JUST using this socket, otherwise use the TSocketManager
*/
virtual int WriteSelect();
/**
* ReadSelect on this socket
* Only good if JUST using this socket, otherwise use the TSocketManager
*/
virtual int ReadSelect();
/**
* Listens for connections
*
* @param iPort the port to listen on
* @param iMaxConns the maximum amount of connections to allow
* @param sBindHost the vhost on which to listen
* @param iTimeout i dont know what this does :(
*/
virtual bool Listen( u_short iPort, int iMaxConns = SOMAXCONN, const CS_STRING & sBindHost = "", u_int iTimeout = 0 );
//! Accept an inbound connection, this is used internally
virtual cs_sock_t Accept( CS_STRING & sHost, u_short & iRPort );
//! Accept an inbound SSL connection, this is used internally and called after Accept
virtual bool AcceptSSL();
//! This sets up the SSL Client, this is used internally
virtual bool SSLClientSetup();
//! This sets up the SSL Server, this is used internally
virtual bool SSLServerSetup();
/**
* Create the SSL connection
*
* @param sBindhost the ip you want to bind to locally
* @return true on success
*/
virtual bool ConnectSSL( const CS_STRING & sBindhost = "" );
/**
* Write data to the socket
* if not all of the data is sent, it will be stored on
* an internal buffer, and tried again with next call to Write
* if the socket is blocking, it will send everything, its ok to check ernno after this (nothing else is processed)
*
* @param data the data to send
* @param len the length of data
*
*/
virtual bool Write( const char *data, size_t len );
/**
* convience function
* @see Write( const char *, int )
*/
virtual bool Write( const CS_STRING & sData );
/**
* Read from the socket
* Just pass in a pointer, big enough to hold len bytes
*
* @param data the buffer to read into
* @param len the size of the buffer
*
* @return
* Returns READ_EOF for EOF
* Returns READ_ERR for ERROR
* Returns READ_EAGAIN for Try Again ( EAGAIN )
* Returns READ_CONNREFUSED for connection refused
* Returns READ_TIMEDOUT for a connection that timed out at the TCP level
* Otherwise returns the bytes read into data
*/
virtual cs_ssize_t Read( char *data, size_t len );
CS_STRING GetLocalIP();
CS_STRING GetRemoteIP();
virtual CS_STRING ConvertAddress( void *addr, bool bIPv6 = false );
//! Tells you if the socket is connected
virtual bool IsConnected() const;
//! Sets the sock, telling it its connected (internal use only)
virtual void SetIsConnected( bool b );
//! returns a reference to the sock
cs_sock_t & GetRSock();
void SetRSock( cs_sock_t iSock );
cs_sock_t & GetWSock();
void SetWSock( cs_sock_t iSock );
void SetSock( cs_sock_t iSock );
cs_sock_t & GetSock();
//! resets the time counter, this is virtual in the event you need an event on the timer being Reset
virtual void ResetTimer();
//! will pause/unpause reading on this socket
void PauseRead();
void UnPauseRead();
bool IsReadPaused();
/**
* this timeout isn't just connection timeout, but also timeout on
* NOT recieving data, to disable this set it to 0
* then the normal TCP timeout will apply (basically TCP will kill a dead connection)
* Set the timeout, set to 0 to never timeout
*/
enum
{
TMO_READ = 1,
TMO_WRITE = 2,
TMO_ACCEPT = 4,
TMO_ALL = TMO_READ|TMO_WRITE|TMO_ACCEPT
};
//! Currently this uses the same value for all timeouts, and iTimeoutType merely states which event will be checked
//! for timeouts
void SetTimeout( int iTimeout, u_int iTimeoutType = TMO_ALL );
void SetTimeoutType( u_int iTimeoutType );
int GetTimeout() const;
u_int GetTimeoutType() const;
//! returns true if the socket has timed out
virtual bool CheckTimeout( time_t iNow );
/**
* pushes data up on the buffer, if a line is ready
* it calls the ReadLine event
*/
virtual void PushBuff( const char *data, size_t len, bool bStartAtZero = false );
//! This gives access to the internal read buffer, if your
//! not going to use ReadLine(), then you may want to clear this out
//! (if its binary data and not many '\\n')
CS_STRING & GetInternalReadBuffer();
//! This gives access to the internal write buffer.
//! If you want to check if the send queue fills up, check here.
CS_STRING & GetInternalWriteBuffer();
//! sets the max buffered threshold when EnableReadLine() is enabled
void SetMaxBufferThreshold( u_int iThreshold );
u_int GetMaxBufferThreshold() const;
//! Returns the connection type from enum eConnType
int GetType() const;
void SetType( int iType );
//! Returns a reference to the socket name
const CS_STRING & GetSockName() const;
void SetSockName( const CS_STRING & sName );
//! Returns a reference to the host name
const CS_STRING & GetHostName() const;
void SetHostName( const CS_STRING & sHostname );
//! Gets the starting time of this socket
unsigned long long GetStartTime() const;
//! Resets the start time
void ResetStartTime();
//! Gets the amount of data read during the existence of the socket
unsigned long long GetBytesRead() const;
void ResetBytesRead();
//! Gets the amount of data written during the existence of the socket
unsigned long long GetBytesWritten() const;
void ResetBytesWritten();
//! Get Avg Read Speed in sample milliseconds (default is 1000 milliseconds or 1 second)
double GetAvgRead( unsigned long long iSample = 1000 );
//! Get Avg Write Speed in sample milliseconds (default is 1000 milliseconds or 1 second)
double GetAvgWrite( unsigned long long iSample = 1000 );
//! Returns the remote port
u_short GetRemotePort();
//! Returns the local port
u_short GetLocalPort();
//! Returns the port
u_short GetPort();
void SetPort( u_short iPort );
//! just mark us as closed, the parent can pick it up
void Close( ECloseType eCloseType = CLT_NOW );
//! returns int of type to close @see ECloseType
ECloseType GetCloseType() { return( m_eCloseType ); }
bool IsClosed() { return( GetCloseType() != CLT_DONT ); }
//! Set rather to NON Blocking IO on this socket, default is true
void BlockIO( bool bBLOCK );
//! Use this to change your fd's to blocking or none blocking
void NonBlockingIO();
//! if this connection type is ssl or not
bool GetSSL();
void SetSSL( bool b );
#ifdef HAVE_LIBSSL
//! Set the cipher type ( openssl cipher [to see ciphers available] )
void SetCipher( const CS_STRING & sCipher );
const CS_STRING & GetCipher();
//! Set the pem file location
void SetPemLocation( const CS_STRING & sPemFile );
const CS_STRING & GetPemLocation();
void SetPemPass( const CS_STRING & sPassword );
const CS_STRING & GetPemPass() const;
static int PemPassCB( char *buf, int size, int rwflag, void *pcSocket );
static int CertVerifyCB( int preverify_ok, X509_STORE_CTX *x509_ctx );
//! Set the SSL method type
void SetSSLMethod( int iMethod );
int GetSSLMethod();
void SetSSLObject( SSL *ssl );
void SetCTXObject( SSL_CTX *sslCtx );
SSL_SESSION * GetSSLSession();
void SetCertVerifyCB( FPCertVerifyCB pFP ) { m_pCerVerifyCB = pFP; }
#endif /* HAVE_LIBSSL */
//! Get the send buffer
const CS_STRING & GetWriteBuffer();
void ClearWriteBuffer();
//! is SSL_accept finished ?
//! is the ssl properly finished (from write no error)
bool SslIsEstablished();
//! Use this to bind this socket to inetd
bool ConnectInetd( bool bIsSSL = false, const CS_STRING & sHostname = "" );
//! Tie this guy to an existing real file descriptor
bool ConnectFD( int iReadFD, int iWriteFD, const CS_STRING & sName, bool bIsSSL = false, ETConn eDirection = INBOUND );
//! Get the peer's X509 cert
#ifdef HAVE_LIBSSL
X509 *getX509();
//! Returns the peer's public key
CS_STRING GetPeerPubKey();
//! Returns the peer's certificate finger print
int GetPeerFingerprint( CS_STRING & sFP);
unsigned int GetRequireClientCertFlags();
//! legacy, deprecated @see SetRequireClientCertFlags
void SetRequiresClientCert( bool bRequiresCert );
//! bitwise flags, 0 means don't require cert, SSL_VERIFY_PEER verifies peers, SSL_VERIFY_FAIL_IF_NO_PEER_CERT will cause the connection to fail if no cert
void SetRequireClientCertFlags( unsigned int iRequireClientCertFlags ) { m_iRequireClientCertFlags = iRequireClientCertFlags; }
#endif /* HAVE_LIBSSL */
//! Set The INBOUND Parent sockname
virtual void SetParentSockName( const CS_STRING & sParentName );
const CS_STRING & GetParentSockName();
/**
* sets the rate at which we can send data
* @param iBytes the amount of bytes we can write
* @param iMilliseconds the amount of time we have to rate to iBytes
*/
virtual void SetRate( u_int iBytes, unsigned long long iMilliseconds );
u_int GetRateBytes();
unsigned long long GetRateTime();
//! This has a garbage collecter, and is used internall to call the jobs
virtual void Cron();
//! insert a newly created cron
virtual void AddCron( CCron * pcCron );
/**
* @brief deletes a cron by name
* @param sName the name of the cron
* @param bDeleteAll delete all crons that match sName
* @param bCaseSensitive use strcmp or strcasecmp
*/
virtual void DelCron( const CS_STRING & sName, bool bDeleteAll = true, bool bCaseSensitive = true );
//! delete cron by idx
virtual void DelCron( u_int iPos );
//! delete cron by address
virtual void DelCronByAddr( CCron *pcCron );
/**
* Override these functions for an easy interface when using the Socket Manager
* Don't bother using these callbacks if you are using this class directly (without Socket Manager)
* as the Socket Manager calls most of these callbacks
*
* Connected event
*/
virtual void Connected() {}
/**
* Override these functions for an easy interface when using the Socket Manager
* Don't bother using these callbacks if you are using this class directly (without Socket Manager)
* as the Socket Manager calls most of these callbacks
*
* Disconnected event
*/
virtual void Disconnected() {}
/**
* Override these functions for an easy interface when using the Socket Manager
* Don't bother using these callbacks if you are using this class directly (without Socket Manager)
* as the Socket Manager calls most of these callbacks
*
* Sock Timed out event
*/
virtual void Timeout() {}
/**
* Override these functions for an easy interface when using the Socket Manager
* Don't bother using these callbacks if you are using this class directly (without Socket Manager)
* as the Socket Manager calls most of these callbacks
*
* Ready to read data event
*/
virtual void ReadData( const char *data, size_t len ) {}
/**
* Override these functions for an easy interface when using the Socket Manager
* Don't bother using these callbacks if you are using this class directly (without Socket Manager)
* as the Socket Manager calls most of these callbacks.
* With ReadLine, if your not going to use it IE a data stream, @see EnableReadLine()
*
* Ready to Read a full line event
*/
virtual void ReadLine( const CS_STRING & sLine ) {}
//! set the value of m_bEnableReadLine to true, we don't want to store a buffer for ReadLine, unless we want it
void EnableReadLine();
void DisableReadLine();
//! returns the value of m_bEnableReadLine, if ReadLine is enabled
bool HasReadLine() const { return( m_bEnableReadLine ); }
/**
* Override these functions for an easy interface when using the Socket Manager
* Don't bother using these callbacks if you are using this class directly (without Socket Manager)
* as the Socket Manager calls most of these callbacks
* This WARNING event is called when your buffer for readline exceeds the warning threshold
* and triggers this event. Either Override it and do nothing, or SetMaxBufferThreshold()
* This event will only get called if m_bEnableReadLine is enabled
*/
virtual void ReachedMaxBuffer();
/**
* Override these functions for an easy interface when using the Socket Manager
* Don't bother using these callbacks if you are using this class directly (without Socket Manager)
* as the Socket Manager calls most of these callbacks
*
* A sock error occured event
*/
virtual void SockError( int iErrno ) {}
/**
* Override these functions for an easy interface when using the Socket Manager
* Don't bother using these callbacks if you are using this class directly (without Socket Manager)
* as the Socket Manager calls most of these callbacks
*
*
* Incoming Connection Event
* return false and the connection will fail
* default returns true
*/
virtual bool ConnectionFrom( const CS_STRING & sHost, u_short iPort ) { return( true ); }
/**
* Override these functions for an easy interface when using the Socket Manager
* Don't bother using these callbacks if you are using this class directly (without Socket Manager)
* as the Socket Manager calls most of these callbacks
*
* Connection Refused Event
*
*/
virtual void ConnectionRefused() {}
/**
* This gets called every iteration of TSocketManager::Select() if the socket is ReadPaused
*/
virtual void ReadPaused() {}
#ifdef HAVE_LIBSSL
/**
* Gets called immediatly after the m_ssl member is setup and initialized, useful if you need to assign anything
* to this ssl session via SSL_set_ex_data
*/
virtual void SSLFinishSetup( SSL *pSSL ) {}
#endif /* HAVE_LIBSSL */
//! return how long it has been (in seconds) since the last read or successful write
time_t GetTimeSinceLastDataTransaction( time_t iNow = 0 )
{
if( m_iLastCheckTimeoutTime == 0 )
return( 0 );
return( ( iNow > 0 ? iNow : time( NULL ) ) - m_iLastCheckTimeoutTime );
}
time_t GetLastCheckTimeout() { return( m_iLastCheckTimeoutTime ); }
//! Returns the time when CheckTimeout() should be called next
time_t GetNextCheckTimeout( time_t iNow = 0 )
{
if( iNow == 0 )
iNow = time( NULL );
time_t itimeout = m_itimeout;
time_t iDiff = iNow - m_iLastCheckTimeoutTime;
/* CheckTimeout() wants to be called after half the timeout */
if( m_iTcount == 0 )
itimeout /= 2;
if( iDiff > itimeout )
itimeout = 0;
else
itimeout -= iDiff;
return( iNow + itimeout );
}
//! return the data imediatly ready for read
virtual int GetPending();
//////////////////////////
// Connection State Stuff
//! returns the current connection state
ECONState GetConState() const { return( m_eConState ); }
//! sets the connection state to eState
void SetConState( ECONState eState ) { m_eConState = eState; }
//! grabs fd's for the sockets
bool CreateSocksFD()
{
if( m_iReadSock != CS_INVALID_SOCK )
return( true );
m_iReadSock = m_iWriteSock = CreateSocket();
if ( m_iReadSock == CS_INVALID_SOCK )
return( false );
m_address.SinFamily();
m_address.SinPort( m_uPort );
return( true );
}
//! puts the socks back to the state they were prior to calling CreateSocksFD
void CloseSocksFD();
const CS_STRING & GetBindHost() const { return( m_sBindHost ); }
void SetBindHost( const CS_STRING & sBindHost ) { m_sBindHost = sBindHost; }
enum EDNSLType
{
DNS_VHOST, //!< this lookup is for the vhost bind
DNS_DEST //!< this lookup is for the destination address
};
/**
* dns lookup @see EDNSLType
* @return 0 for success, EAGAIN to check back again (same arguments as before), ETIMEDOUT on failure
*/
int DNSLookup( EDNSLType eDNSLType );
//! this is only used on outbound connections, listeners bind in a different spot
bool SetupVHost();
bool GetIPv6() const { return( m_bIsIPv6 ); }
void SetIPv6( bool b )
{
m_bIsIPv6 = b;
m_address.SetIPv6( b );
m_bindhost.SetIPv6( b );
}
void SetAFRequire( CSSockAddr::EAFRequire iAFRequire )
{
m_address.SetAFRequire( iAFRequire );
m_bindhost.SetAFRequire( iAFRequire );
}
//! returns true if this socket can write its data, primarily used with rate shaping, initialize iNOW to 0 and it sets it on the first call
bool AllowWrite( unsigned long long & iNOW ) const;
//! returns a const reference to the crons associated to this socket
const std::vector<CCron *> & GetCrons() const { return( m_vcCrons ); }
void SetSkipConnect( bool b ) { m_bSkipConnect = b; }
/**
* @brief override this call with your own DNS lookup method if you have one. By default this function is blocking
* @param sHostname the hostname to resolve
* @param csSockAddr the destination sock address info @see CSSockAddr
* @return 0 on success, ETIMEDOUT if no lookup was found, EAGAIN if you should check again later for an answer
*/
virtual int GetAddrInfo( const CS_STRING & sHostname, CSSockAddr & csSockAddr );
#ifdef HAVE_C_ARES
CSSockAddr * GetCurrentAddr() const { return( m_pCurrAddr ); }
void SetAresFinished( int status ) { m_pCurrAddr = NULL; m_iARESStatus = status; }
ares_channel GetAresChannel() { return( m_pARESChannel ); }
#endif /* HAVE_C_ARES */
private:
//! making private for safety
Csock( const Csock & cCopy ) {}
// NOTE! if you add any new members, be sure to add them to Copy()
u_short m_uPort, m_iRemotePort, m_iLocalPort;
cs_sock_t m_iReadSock, m_iWriteSock;
int m_itimeout, m_iConnType, m_iMethod, m_iTcount;
bool m_bssl, m_bIsConnected, m_bBLOCK;
bool m_bsslEstablished, m_bEnableReadLine, m_bPauseRead;
CS_STRING m_shostname, m_sbuffer, m_sSockName, m_sPemFile, m_sCipherType, m_sParentName;
CS_STRING m_sSend, m_sPemPass, m_sLocalIP, m_sRemoteIP;
ECloseType m_eCloseType;
unsigned long long m_iMaxMilliSeconds, m_iLastSendTime, m_iBytesRead, m_iBytesWritten, m_iStartTime;
unsigned int m_iMaxBytes, m_iMaxStoredBufferLength, m_iTimeoutType;
size_t m_iLastSend;
CSSockAddr m_address, m_bindhost;
bool m_bIsIPv6, m_bSkipConnect;
time_t m_iLastCheckTimeoutTime;
#ifdef HAVE_LIBSSL
CS_STRING m_sSSLBuffer;
SSL *m_ssl;
SSL_CTX *m_ssl_ctx;
unsigned int m_iRequireClientCertFlags;
FPCertVerifyCB m_pCerVerifyCB;
void FREE_SSL();
void FREE_CTX();
#endif /* HAVE_LIBSSL */
std::vector<CCron *> m_vcCrons;
//! Create the socket
cs_sock_t CreateSocket( bool bListen = false );
void Init( const CS_STRING & sHostname, u_short uPort, int itimeout = 60 );
// Connection State Info
ECONState m_eConState;
CS_STRING m_sBindHost;
u_int m_iCurBindCount, m_iDNSTryCount;
#ifdef HAVE_C_ARES
void FreeAres();
ares_channel m_pARESChannel;
CSSockAddr *m_pCurrAddr;
int m_iARESStatus;
#endif /* HAVE_C_ARES */
};
/**
* @class CSConnection
* @brief options for creating a connection
*/
class CSConnection
{
public:
/**
* @param sHostname hostname to connect to
* @param iPort port to connect to
* @param iTimeout connection timeout
*/
CSConnection( const CS_STRING & sHostname, u_short iPort, int iTimeout = 60 )
{
m_sHostname = sHostname;
m_iPort = iPort;
m_iTimeout = iTimeout;
m_bIsSSL = false;
#ifdef HAVE_LIBSSL
m_sCipher = "HIGH";
#endif /* HAVE_LIBSSL */
m_iAFrequire = CSSockAddr::RAF_ANY;
}
virtual ~CSConnection() {}
const CS_STRING & GetHostname() const { return( m_sHostname ); }
const CS_STRING & GetSockName() const { return( m_sSockName ); }
const CS_STRING & GetBindHost() const { return( m_sBindHost ); }
u_short GetPort() const { return( m_iPort ); }
int GetTimeout() const { return( m_iTimeout ); }
bool GetIsSSL() const { return( m_bIsSSL ); }
CSSockAddr::EAFRequire GetAFRequire() const { return( m_iAFrequire ); }
#ifdef HAVE_LIBSSL
const CS_STRING & GetCipher() const { return( m_sCipher ); }
const CS_STRING & GetPemLocation() const { return( m_sPemLocation ); }
const CS_STRING & GetPemPass() const { return( m_sPemPass ); }
#endif /* HAVE_LIBSSL */
//! sets the hostname to connect to
void SetHostname( const CS_STRING & s ) { m_sHostname = s; }
//! sets the name of the socket, used for reference, ie in FindSockByName()
void SetSockName( const CS_STRING & s ) { m_sSockName = s; }
//! sets the hostname to bind to (vhost support)
void SetBindHost( const CS_STRING & s ) { m_sBindHost = s; }
//! sets the port to connect to
void SetPort( u_short i ) { m_iPort = i; }
//! sets the connection timeout
void SetTimeout( int i ) { m_iTimeout = i; }
//! set to true to enable SSL
void SetIsSSL( bool b ) { m_bIsSSL = b; }
//! sets the AF family type required
void SetAFRequire( CSSockAddr::EAFRequire iAFRequire ) { m_iAFrequire = iAFRequire; }
#ifdef HAVE_LIBSSL
//! set the cipher strength to use, default is HIGH
void SetCipher( const CS_STRING & s ) { m_sCipher = s; }
//! set the location of the pemfile
void SetPemLocation( const CS_STRING & s ) { m_sPemLocation = s; }
//! set the pemfile pass
void SetPemPass( const CS_STRING & s ) { m_sPemPass = s; }
#endif /* HAVE_LIBSSL */
protected:
CS_STRING m_sHostname, m_sSockName, m_sBindHost;
u_short m_iPort;
int m_iTimeout;
bool m_bIsSSL;
CSSockAddr::EAFRequire m_iAFrequire;
#ifdef HAVE_LIBSSL
CS_STRING m_sPemLocation, m_sPemPass, m_sCipher;
#endif /* HAVE_LIBSSL */
};
class CSSSLConnection : public CSConnection
{
public:
CSSSLConnection( const CS_STRING & sHostname, u_short iPort, int iTimeout = 60 ) :
CSConnection( sHostname, iPort, iTimeout )
{
SetIsSSL( true );
}
};
/**
* @class CSListener
* @brief options container to create a listener
*/
class CSListener
{
public:
/**
* @param iPort port to listen on. Set to 0 to listen on a random port
* @param sBindHost host to bind to
*/
CSListener( u_short iPort, const CS_STRING & sBindHost = "" )
{
m_iPort = iPort;
m_sBindHost = sBindHost;
m_bIsSSL = false;
m_iMaxConns = SOMAXCONN;
m_iTimeout = 0;
m_iAFrequire = CSSockAddr::RAF_ANY;
#ifdef HAVE_LIBSSL
m_sCipher = "HIGH";
m_iRequireCertFlags = 0;
#endif /* HAVE_LIBSSL */
}
virtual ~CSListener() {}
u_short GetPort() const { return( m_iPort ); }
const CS_STRING & GetSockName() const { return( m_sSockName ); }
const CS_STRING & GetBindHost() const { return( m_sBindHost ); }
bool GetIsSSL() const { return( m_bIsSSL ); }
int GetMaxConns() const { return( m_iMaxConns ); }
u_int GetTimeout() const { return( m_iTimeout ); }
CSSockAddr::EAFRequire GetAFRequire() const { return( m_iAFrequire ); }
#ifdef HAVE_LIBSSL
const CS_STRING & GetCipher() const { return( m_sCipher ); }
const CS_STRING & GetPemLocation() const { return( m_sPemLocation ); }
const CS_STRING & GetPemPass() const { return( m_sPemPass ); }
unsigned int GetRequireClientCertFlags() const { return( m_iRequireCertFlags ); }
#endif /* HAVE_LIBSSL */
//! sets the port to listen on. Set to 0 to listen on a random port
void SetPort( u_short iPort ) { m_iPort = iPort; }
//! sets the sock name for later reference (ie FindSockByName)
void SetSockName( const CS_STRING & sSockName ) { m_sSockName = sSockName; }
//! sets the host to bind to
void SetBindHost( const CS_STRING & sBindHost ) { m_sBindHost = sBindHost; }
//! set to true to enable SSL
void SetIsSSL( bool b ) { m_bIsSSL = b; }
//! set max connections as called by accept()
void SetMaxConns( int i ) { m_iMaxConns = i; }
//! sets the listen timeout. The listener class will close after timeout has been reached if not 0
void SetTimeout( u_int i ) { m_iTimeout = i; }
//! sets the AF family type required
void SetAFRequire( CSSockAddr::EAFRequire iAFRequire ) { m_iAFrequire = iAFRequire; }
#ifdef HAVE_LIBSSL
//! set the cipher strength to use, default is HIGH
void SetCipher( const CS_STRING & s ) { m_sCipher = s; }
//! set the location of the pemfile
void SetPemLocation( const CS_STRING & s ) { m_sPemLocation = s; }
//! set the pemfile pass
void SetPemPass( const CS_STRING & s ) { m_sPemPass = s; }
//! set to true if require a client certificate (deprecated @see SetRequireClientCertFlags)
void SetRequiresClientCert( bool b ) { m_iRequireCertFlags = ( b ? SSL_VERIFY_PEER|SSL_VERIFY_FAIL_IF_NO_PEER_CERT : 0 ); }
//! bitwise flags, 0 means don't require cert, SSL_VERIFY_PEER verifies peers, SSL_VERIFY_FAIL_IF_NO_PEER_CERT will cause the connection to fail if no cert
void SetRequireClientCertFlags( unsigned int iRequireCertFlags ) { m_iRequireCertFlags = iRequireCertFlags; }
#endif /* HAVE_LIBSSL */
private:
u_short m_iPort;
CS_STRING m_sSockName, m_sBindHost;
bool m_bIsSSL;
int m_iMaxConns;
u_int m_iTimeout;
CSSockAddr::EAFRequire m_iAFrequire;
#ifdef HAVE_LIBSSL
CS_STRING m_sPemLocation, m_sPemPass, m_sCipher;
unsigned int m_iRequireCertFlags;
#endif /* HAVE_LIBSSL */
};
#ifdef HAVE_LIBSSL
class CSSSListener : public CSListener
{
public:
CSSSListener( u_short iPort, const CS_STRING & sBindHost = "" ) :
CSListener( iPort, sBindHost )
{
SetIsSSL( true );
}
};
#endif /* HAVE_LIBSSL */
/**
* @class TSocketManager
* @brief Best class to use to interact with the sockets
*
* handles SSL and NON Blocking IO
* Its a template class since Csock derives need to be new'd correctly
* Makes it easier to use overall
* Rather then use it directly, you'll probably get more use deriving from it
* Another thing to note, is that all sockets are deleted implicitly, so obviously you
* cant pass in Csock classes created on the stack. For those of you who don't
* know STL very well, the reason I did this is because whenever you add to certain stl containers
* (ie vector, or map), its completely rebuilt using the copy constructor on each element.
* That then means the constructor and destructor are called on every item in the container.
* Not only is this more overhead then just moving pointers around, its dangerous as if you have
* an object that is newed and deleted in the destructor the value of its pointer is copied in the
* default copy constructor. This means everyone has to know better and create a copy constructor,
* or I just make everyone new their object :)
*
* class CBlahSock : public TSocketManager<SomeSock>
*
* @author Jim Hull <imaginos@imaginos.net>
*/
template<class T>
class TSocketManager : public std::vector<T *>
{
public:
TSocketManager() : std::vector<T *>()
{
m_errno = SUCCESS;
m_iCallTimeouts = millitime();
m_iSelectWait = 100000; // Default of 100 milliseconds
m_iBytesRead = 0;
m_iBytesWritten = 0;
}
virtual ~TSocketManager()
{
Cleanup();
}
void clear()
{
while ( this->size() )
DelSock( 0 );
}
virtual void Cleanup()
{
for( u_int a = 0; a < m_vcCrons.size(); a++ )
CS_Delete( m_vcCrons[a] );
m_vcCrons.clear();
clear();
}
enum EMessages
{
SUCCESS = 0, //! Select returned at least 1 fd ready for action
SELECT_ERROR = -1, //! An Error Happened, Probably dead socket. That socket is returned if available
SELECT_TIMEOUT = -2, //! Select Timeout
SELECT_TRYAGAIN = -3 //! Select calls for you to try again
};
/**
* Create a connection
*
* @param cCon the connection which should be established
* @param pcSock the socket used for the connectiong, can be NULL
* @return true on success
*/
bool Connect( const CSConnection & cCon, T * pcSock = NULL )
{
// create the new object
if ( !pcSock )
pcSock = new T( cCon.GetHostname(), cCon.GetPort(), cCon.GetTimeout() );
else
{
pcSock->SetHostName( cCon.GetHostname() );
pcSock->SetPort( cCon.GetPort() );
pcSock->SetTimeout( cCon.GetTimeout() );
}
if( cCon.GetAFRequire() != CSSockAddr::RAF_ANY )
pcSock->SetAFRequire( cCon.GetAFRequire() );
// make it NON-Blocking IO
pcSock->BlockIO( false );
// bind the vhost
pcSock->SetBindHost( cCon.GetBindHost() );
#ifdef HAVE_LIBSSL
pcSock->SetSSL( cCon.GetIsSSL() );
if( cCon.GetIsSSL() )
{
if( !cCon.GetPemLocation().empty() )
{
pcSock->SetPemLocation( cCon.GetPemLocation() );
pcSock->SetPemPass( cCon.GetPemPass() );
}
if( !cCon.GetCipher().empty() )
pcSock->SetCipher( cCon.GetCipher() );
}
#endif /* HAVE_LIBSSL */
pcSock->SetType( T::OUTBOUND );
pcSock->SetConState( T::CST_START );
AddSock( pcSock, cCon.GetSockName() );
return( true );
}
virtual bool Listen( const CSListener & cListen, T * pcSock = NULL, u_short *piRandPort = NULL )
{
if ( !pcSock )
pcSock = new T();
pcSock->BlockIO( false );
if( cListen.GetAFRequire() != CSSockAddr::RAF_ANY )
{
pcSock->SetAFRequire( cListen.GetAFRequire() );
#ifdef HAVE_IPV6
if( cListen.GetAFRequire() == CSSockAddr::RAF_INET6 )
pcSock->SetIPv6( true );
#endif /* HAVE_IPV6 */
}
#ifdef HAVE_IPV6
else
{
pcSock->SetIPv6( true );
}
#endif /* HAVE_IPV6 */
#ifdef HAVE_LIBSSL
pcSock->SetSSL( cListen.GetIsSSL() );
if( ( cListen.GetIsSSL() ) && ( !cListen.GetPemLocation().empty() ) )
{
pcSock->SetPemLocation( cListen.GetPemLocation() );
pcSock->SetPemPass( cListen.GetPemPass() );
pcSock->SetCipher( cListen.GetCipher() );
pcSock->SetRequireClientCertFlags( cListen.GetRequireClientCertFlags() );
}
#endif /* HAVE_LIBSSL */
if( piRandPort )
*piRandPort = 0;
if ( pcSock->Listen( cListen.GetPort(), cListen.GetMaxConns(), cListen.GetBindHost(), cListen.GetTimeout() ) )
{
AddSock( pcSock, cListen.GetSockName() );
if( ( piRandPort ) && ( cListen.GetPort() == 0 ) )
{
cs_sock_t iSock = pcSock->GetSock();
if ( iSock == CS_INVALID_SOCK )
{
CS_DEBUG( "Failed to attain a valid file descriptor" );
pcSock->Close();
return( false );
}
struct sockaddr_in mLocalAddr;
socklen_t mLocalLen = sizeof( mLocalAddr );
getsockname( iSock, (struct sockaddr *) &mLocalAddr, &mLocalLen );
*piRandPort = ntohs( mLocalAddr.sin_port );
}
return( true );
}
CS_Delete( pcSock );
return( false );
}
/**
* Best place to call this class for running, all the call backs are called.
* You should through this in your main while loop (long as its not blocking)
* all the events are called as needed.
*/
virtual void Loop()
{
for( u_int a = 0; a < this->size(); a++ )
{
T *pcSock = (*this)[a];
if ( ( pcSock->GetType() != T::OUTBOUND ) || ( pcSock->GetConState() == T::CST_OK ) )
continue;
if ( pcSock->GetConState() == T::CST_DNS )
{
if ( pcSock->DNSLookup( T::DNS_VHOST ) == ETIMEDOUT )
{
pcSock->SockError( EDOM );
DelSock( a-- );
continue;
}
}
if ( pcSock->GetConState() == T::CST_BINDVHOST )
{
if ( !pcSock->SetupVHost() )
{
pcSock->SockError( GetSockError() );
DelSock( a-- );
continue;
}
}
if ( pcSock->GetConState() == T::CST_DESTDNS )
{
if ( pcSock->DNSLookup( T::DNS_DEST ) == ETIMEDOUT )
{
pcSock->SockError( EADDRNOTAVAIL );
DelSock( a-- );
continue;
}
}
if ( pcSock->GetConState() == T::CST_CONNECT )
{
if ( !pcSock->Connect( pcSock->GetBindHost(), true ) )
{
if ( GetSockError() == ECONNREFUSED )
pcSock->ConnectionRefused();
else
pcSock->SockError( GetSockError() );
DelSock( a-- );
continue;
}
}
#ifdef HAVE_LIBSSL
if( pcSock->GetConState() == T::CST_CONNECTSSL )
{
if ( pcSock->GetSSL() )
{
if ( !pcSock->ConnectSSL() )
{
if ( GetSockError() == ECONNREFUSED )
pcSock->ConnectionRefused();
else
pcSock->SockError( GetSockError() == 0 ? ECONNABORTED : GetSockError() );
DelSock( a-- );
continue;
}
}
}
#endif /* HAVE_LIBSSL */
}
std::map<T *, EMessages> mpeSocks;
Select( mpeSocks );
switch( m_errno )
{
case SUCCESS:
{
for( typename std::map<T *, EMessages>::iterator itSock = mpeSocks.begin(); itSock != mpeSocks.end(); itSock++ )
{
T * pcSock = itSock->first;
EMessages iErrno = itSock->second;
if ( iErrno == SUCCESS )
{
// read in data
// if this is a
int iLen = 0;
if ( pcSock->GetSSL() )
iLen = pcSock->GetPending();
if ( iLen <= 0 )
iLen = CS_BLOCKSIZE;
CSCharBuffer cBuff( iLen );
cs_ssize_t bytes = pcSock->Read( cBuff(), iLen );
if ( bytes != T::READ_TIMEDOUT && bytes != T::READ_CONNREFUSED && bytes != T::READ_ERR && !pcSock->IsConnected() )
{
pcSock->SetIsConnected( true );
pcSock->Connected();
}
switch( bytes )
{
case T::READ_EOF:
{
DelSockByAddr( pcSock );
break;
}
case T::READ_ERR:
{
pcSock->SockError( GetSockError() );
DelSockByAddr( pcSock );
break;
}
case T::READ_EAGAIN:
break;
case T::READ_CONNREFUSED:
pcSock->ConnectionRefused();
DelSockByAddr( pcSock );
break;
case T::READ_TIMEDOUT:
pcSock->Timeout();
DelSockByAddr( pcSock );
break;
default:
{
if ( T::TMO_READ & pcSock->GetTimeoutType() )
pcSock->ResetTimer(); // reset the timeout timer
pcSock->ReadData( cBuff(), bytes ); // Call ReadData() before PushBuff() so that it is called before the ReadLine() event - LD 07/18/05
pcSock->PushBuff( cBuff(), bytes );
break;
}
}
} else if ( iErrno == SELECT_ERROR )
{
// a socket came back with an error
// usually means it was closed
DelSockByAddr( pcSock );
}
}
break;
}
case SELECT_TIMEOUT:
case SELECT_TRYAGAIN:
case SELECT_ERROR:
default :
break;
}
unsigned long long iMilliNow = millitime();
if ( ( iMilliNow - m_iCallTimeouts ) >= 1000 )
{
m_iCallTimeouts = iMilliNow;
// call timeout on all the sockets that recieved no data
for( unsigned int i = 0; i < this->size(); i++ )
{
if ( (*this)[i]->GetConState() != T::CST_OK )
continue;
if ( (*this)[i]->CheckTimeout( iMilliNow / 1000 ) )
DelSock( i-- );
}
}
// run any Manager Crons we may have
Cron();
}
/**
* @brief this is similar to loop, except that it dynamically adjusts the select time based on jobs and timeouts in sockets
*
* - This type of behavior only works well in a scenario where there is low traffic. If you use this then its because you
* - are trying to spare yourself some of those idle loops where nothing is done. If you try to use this code where you have lots of
* - connections and/or lots of traffic you might end up causing more CPU usage than just a plain Loop() with a static sleep of 500ms
* - its a trade off at some point, and you'll probably find out that the vast majority of the time and in most cases Loop() works fine
* - by itself. I've tried to mitigate that as much as possible by not having it change the select if the previous call to select
* - was not a timeout. Anyways .... Caveat Emptor.
* - Sample useage is cFoo.DynamicSelectLoop( 500000, 5000000 ); which basically says min of 500ms and max of 5s
*
* @param iLowerBounds the lower bounds to use in MICROSECONDS
* @param iUpperBounds the upper bounds to use in MICROSECONDS
* @param iMaxResolution the maximum time to calculate overall in seconds
*/
void DynamicSelectLoop( u_long iLowerBounds, u_long iUpperBounds, time_t iMaxResolution = 3600 )
{
SetSelectTimeout( iLowerBounds );
if( m_errno == SELECT_TIMEOUT )
{ // only do this if the previous call to select was a timeout
time_t iNow = time( NULL );
u_long iSelectTimeout = GetDynamicSleepTime( iNow, iMaxResolution );
iSelectTimeout *= 1000000;
iSelectTimeout = std::max( iLowerBounds, iSelectTimeout );
iSelectTimeout = std::min( iSelectTimeout, iUpperBounds );
if( iLowerBounds != iSelectTimeout )
SetSelectTimeout( iSelectTimeout );
}
Loop();
}
/**
* Make this method virtual, so you can override it when a socket is added.
* Assuming you might want to do some extra stuff
*/
virtual void AddSock( T *pcSock, const CS_STRING & sSockName )
{
pcSock->SetSockName( sSockName );
this->push_back( pcSock );
}
//! returns a pointer to the FIRST sock found by port or NULL on no match
virtual T * FindSockByRemotePort( u_short iPort )
{
for( unsigned int i = 0; i < this->size(); i++ )
{
if ( (*this)[i]->GetRemotePort() == iPort )
return( (*this)[i] );
}
return( NULL );
}
//! returns a pointer to the FIRST sock found by port or NULL on no match
virtual T * FindSockByLocalPort( u_short iPort )
{
for( unsigned int i = 0; i < this->size(); i++ )
if ( (*this)[i]->GetLocalPort() == iPort )
return( (*this)[i] );
return( NULL );
}
//! returns a pointer to the FIRST sock found by name or NULL on no match
virtual T * FindSockByName( const CS_STRING & sName )
{
typename std::vector<T *>::iterator it;
typename std::vector<T *>::iterator it_end = this->end();
for( it = this->begin(); it != it_end; it++ )
if ( (*it)->GetSockName() == sName )
return( *it );
return( NULL );
}
//! returns a pointer to the FIRST sock found by filedescriptor or NULL on no match
virtual T * FindSockByFD( cs_sock_t iFD )
{
for( unsigned int i = 0; i < this->size(); i++ )
if ( ( (*this)[i]->GetRSock() == iFD ) || ( (*this)[i]->GetWSock() == iFD ) )
return( (*this)[i] );
return( NULL );
}
virtual std::vector<T *> FindSocksByName( const CS_STRING & sName )
{
std::vector<T *> vpSocks;
for( unsigned int i = 0; i < this->size(); i++ )
if ( (*this)[i]->GetSockName() == sName )
vpSocks.push_back( (*this)[i] );
return( vpSocks );
}
//! returns a vector of pointers to socks with sHostname as being connected
virtual std::vector<T *> FindSocksByRemoteHost( const CS_STRING & sHostname )
{
std::vector<T *> vpSocks;
for( unsigned int i = 0; i < this->size(); i++ )
if ( (*this)[i]->GetHostName() == sHostname )
vpSocks.push_back( (*this)[i] );
return( vpSocks );
}
//! return the last known error as set by this class
int GetErrno() { return( m_errno ); }
//! add a cronjob at the manager level
virtual void AddCron( CCron *pcCron )
{
m_vcCrons.push_back( pcCron );
}
/**
* @brief deletes a cron by name
* @param sName the name of the cron
* @param bDeleteAll delete all crons that match sName
* @param bCaseSensitive use strcmp or strcasecmp
*/
virtual void DelCron( const CS_STRING & sName, bool bDeleteAll = true, bool bCaseSensitive = true )
{
for( u_int a = 0; a < m_vcCrons.size(); a++ )
{
int (*Cmp)(const char *, const char *) = ( bCaseSensitive ? strcmp : strcasecmp );
if ( Cmp( m_vcCrons[a]->GetName().c_str(), sName.c_str() ) == 0 )
{
m_vcCrons[a]->Stop();
CS_Delete( m_vcCrons[a] );
m_vcCrons.erase( m_vcCrons.begin() + a-- );
if( !bDeleteAll )
break;
}
}
}
//! delete cron by idx
virtual void DelCron( u_int iPos )
{
if ( iPos < m_vcCrons.size() )
{
m_vcCrons[iPos]->Stop();
CS_Delete( m_vcCrons[iPos] );
m_vcCrons.erase( m_vcCrons.begin() + iPos );
}
}
//! delete cron by address
virtual void DelCronByAddr( CCron *pcCron )
{
for( u_int a = 0; a < m_vcCrons.size(); a++ )
{
if ( m_vcCrons[a] == pcCron )
{
m_vcCrons[a]->Stop();
CS_Delete( m_vcCrons[a] );
m_vcCrons.erase( m_vcCrons.begin() + a );
return;
}
}
}
//! Get the Select Timeout in MICROSECONDS ( 1000 == 1 millisecond )
u_long GetSelectTimeout() { return( m_iSelectWait ); }
//! Set the Select Timeout in MICROSECONDS ( 1000 == 1 millisecond )
//! Setting this to 0 will cause no timeout to happen, Select() will return instantly
void SetSelectTimeout( u_long iTimeout ) { m_iSelectWait = iTimeout; }
std::vector<CCron *> & GetCrons() { return( m_vcCrons ); }
//! Delete a sock by addr
//! its position is looked up
//! the socket is deleted, the appropriate call backs are peformed
//! and its instance is removed from the manager
virtual void DelSockByAddr( T *pcSock )
{
for( u_int a = 0; a < this->size(); a++ )
{
if ( pcSock == (*this)[a] )
{
DelSock( a );
return;
}
}
}
//! Delete a sock by position in the vector
//! the socket is deleted, the appropriate call backs are peformed
//! and its instance is removed from the manager
//! deleting in a loop can be tricky, be sure you watch your position.
//! ie for( u_int a = 0; a < size(); a++ ) DelSock( a-- );
virtual void DelSock( u_int iPos )
{
if ( iPos >= this->size() )
{
CS_DEBUG( "Invalid Sock Position Requested! [" << iPos << "]" );
return;
}
T * pSock = (*this)[iPos];
if( pSock->GetCloseType() != T::CLT_DEREFERENCE )
{
if ( pSock->IsConnected() )
pSock->Disconnected(); // only call disconnected event if connected event was called (IE IsConnected was set)
m_iBytesRead += pSock->GetBytesRead();
m_iBytesWritten += pSock->GetBytesWritten();
}
CS_Delete( pSock );
this->erase( this->begin() + iPos );
}
/**
* @brief swaps out a sock with a copy of the original sock
* @param pNewSock the new sock to change out with. (this should be constructed by you with the default ctor)
* @param iOrginalSockIdx the position in this sockmanager of the original sock
* @return true on success
*/
virtual bool SwapSockByIdx( Csock *pNewSock, u_long iOrginalSockIdx )
{
if( iOrginalSockIdx >= this->size() )
{
CS_DEBUG( "Invalid Sock Position Requested! [" << iOrginalSockIdx << "]" );
return( false );
}
Csock *pSock = (*this)[iOrginalSockIdx];
pNewSock->Copy( *pSock );
pSock->Dereference();
(*this)[iOrginalSockIdx] = (T *)pNewSock;
this->push_back( (T *)pSock ); // this allows it to get cleaned up
return( true );
}
/**
* @brief swaps out a sock with a copy of the original sock
* @param pNewSock the new sock to change out with. (this should be constructed by you with the default ctor)
* @param pOrigSock the address of the original socket
* @return true on success
*/
virtual bool SwapSockByAddr( Csock *pNewSock, Csock *pOrigSock )
{
for( u_long a = 0; a < this->size(); a++ )
{
if( (*this)[a] == pOrigSock )
return( SwapSockByIdx( pNewSock, a ) );
}
return( false );
}
//! Get the bytes read from all sockets current and past
unsigned long long GetBytesRead() const
{
// Start with the total bytes read from destroyed sockets
unsigned long long iRet = m_iBytesRead;
// Add in the outstanding bytes read from active sockets
for( u_int a = 0; a < this->size(); a++ )
iRet += (*this)[a]->GetBytesRead();
return( iRet );
}
//! Get the bytes written to all sockets current and past
unsigned long long GetBytesWritten() const
{
// Start with the total bytes written to destroyed sockets
unsigned long long iRet = m_iBytesWritten;
// Add in the outstanding bytes written to active sockets
for( u_int a = 0; a < this->size(); a++ )
iRet += (*this)[a]->GetBytesWritten();
return( iRet );
}
protected:
//! this is a strict wrapper around C-api select(). Added in the event you need to do special work here
enum ECheckType
{
eCheckRead = 1,
eCheckWrite = 2
};
void FDSetCheck( int iFd, std::map< int, short > & miiReadyFds, ECheckType eType )
{
std::map< int, short >::iterator it = miiReadyFds.find( iFd );
if( it != miiReadyFds.end() )
it->second |= eType;
else
miiReadyFds[iFd] = eType;
}
bool FDHasCheck( int iFd, std::map< int, short > & miiReadyFds, ECheckType eType )
{
std::map< int, short >::iterator it = miiReadyFds.find( iFd );
if( it != miiReadyFds.end() )
return( (it->second & eType) );
return( false );
}
virtual int Select( std::map< int, short > & miiReadyFds, struct timeval *tvtimeout)
{
#ifdef CSOCK_USE_POLL
if( miiReadyFds.empty() )
return( select( 0, NULL, NULL, NULL, tvtimeout ) );
struct pollfd * pFDs = (struct pollfd *)malloc( sizeof( struct pollfd ) * miiReadyFds.size() );
size_t uCurrPoll = 0;
for( std::map< int, short >::iterator it = miiReadyFds.begin(); it != miiReadyFds.end(); ++it, ++uCurrPoll )
{
short iEvents = 0;
if( it->second & eCheckRead )
iEvents |= POLLIN;
if( it->second & eCheckWrite )
iEvents |= POLLOUT;
pFDs[uCurrPoll].fd = it->first;
pFDs[uCurrPoll].events = iEvents;
pFDs[uCurrPoll].revents = 0;
}
int iTimeout = (int)(tvtimeout->tv_usec / 1000);
iTimeout += (int)(tvtimeout->tv_sec * 1000);
size_t uMaxFD = miiReadyFds.size();
int iRet = poll( pFDs, uMaxFD, iTimeout );
miiReadyFds.clear();
for( uCurrPoll = 0; uCurrPoll < uMaxFD; ++uCurrPoll )
{
short iEvents = 0;
if( (pFDs[uCurrPoll].revents & (POLLIN|POLLERR|POLLHUP|POLLNVAL) ) )
iEvents |= eCheckRead;
if( (pFDs[uCurrPoll].revents & POLLOUT ) )
iEvents |= eCheckWrite;
std::map< int, short >::iterator it = miiReadyFds.find( pFDs[uCurrPoll].fd );
if( it != miiReadyFds.end() )
it->second |= iEvents;
else
miiReadyFds[pFDs[uCurrPoll].fd] = iEvents;
}
free( pFDs );
#else
fd_set rfds, wfds;
TFD_ZERO( &rfds );
TFD_ZERO( &wfds );
bool bHasWrite = false;
int iHighestFD = 0;
for( std::map< int, short >::iterator it = miiReadyFds.begin(); it != miiReadyFds.end(); ++it )
{
iHighestFD = std::max( it->first, iHighestFD );
if( it->second & eCheckRead )
{
TFD_SET( it->first, &rfds );
}
if( it->second & eCheckWrite )
{
bHasWrite = true;
TFD_SET( it->first, &wfds );
}
}
int iRet = select( iHighestFD + 1, &rfds, ( bHasWrite ? &wfds : NULL ), NULL, tvtimeout );
if( iRet <= 0 )
miiReadyFds.clear();
else
{
for( std::map< int, short >::iterator it = miiReadyFds.begin(); it != miiReadyFds.end(); ++it )
{
if( (it->second & eCheckRead) && !TFD_ISSET( it->first, &rfds ) )
it->second &= ~eCheckRead;
if( (it->second & eCheckWrite) && !TFD_ISSET( it->first, &wfds ) )
it->second &= ~eCheckWrite;
}
}
#endif /* CSOCK_USE_POLL */
return( iRet );
}
private:
/**
* fills a map of socks to a message for check
* map is empty if none are ready, check GetErrno() for the error, if not SUCCESS Select() failed
* each struct contains the socks error
* @see GetErrno()
*/
virtual void Select( std::map<T *, EMessages> & mpeSocks )
{
mpeSocks.clear();
struct timeval tv;
std::map< int, short > miiReadyFds;
tv.tv_sec = m_iSelectWait / 1000000;
tv.tv_usec = m_iSelectWait % 1000000;
u_int iQuickReset = 1000;
if ( m_iSelectWait == 0 )
iQuickReset = 0;
bool bHasAvailSocks = false;
unsigned long long iNOW = 0;
for( unsigned int i = 0; i < this->size(); i++ )
{
T *pcSock = (*this)[i];
Csock::ECloseType eCloseType = pcSock->GetCloseType();
if( eCloseType == T::CLT_NOW || eCloseType == T::CLT_DEREFERENCE || ( eCloseType == T::CLT_AFTERWRITE && pcSock->GetWriteBuffer().empty() ) )
{
DelSock( i-- ); // close any socks that have requested it
continue;
}
else
pcSock->Cron(); // call the Cron handler here
cs_sock_t & iRSock = pcSock->GetRSock();
cs_sock_t & iWSock = pcSock->GetWSock();
#ifndef CSOCK_USE_POLL
if( iRSock > FD_SETSIZE || iWSock > FD_SETSIZE )
{
CS_DEBUG( "FD is larger than select() can handle" );
DelSock( i-- );
continue;
}
#endif /* CSOCK_USE_POLL */
#ifdef HAVE_C_ARES
ares_channel pChannel = pcSock->GetAresChannel();
if( pChannel )
{
ares_socket_t aiAresSocks[1];
aiAresSocks[0] = ARES_SOCKET_BAD;
int iSockMask = ares_getsock( pChannel, aiAresSocks, 1 );
if( ARES_GETSOCK_READABLE( iSockMask, 0 ) )
FDSetCheck( aiAresSocks[0], miiReadyFds, eCheckRead );
if( ARES_GETSOCK_WRITABLE( iSockMask, 0 ) )
FDSetCheck( aiAresSocks[0], miiReadyFds, eCheckWrite );
// let ares drop the timeout if it has something timing out sooner then whats in tv currently
ares_timeout( pChannel, &tv, &tv );
}
#endif /* HAVE_C_ARES */
if ( pcSock->GetConState() != T::CST_OK )
continue;
bHasAvailSocks = true;
bool bIsReadPaused = pcSock->IsReadPaused();
if ( bIsReadPaused )
{
pcSock->ReadPaused();
bIsReadPaused = pcSock->IsReadPaused(); // re-read it again, incase it changed status)
}
if ( iRSock == CS_INVALID_SOCK || iWSock == CS_INVALID_SOCK )
{
SelectSock( mpeSocks, SUCCESS, pcSock );
continue; // invalid sock fd
}
if( pcSock->GetType() != T::LISTENER )
{
bool bHasWriteBuffer = !pcSock->GetWriteBuffer().empty();
if ( !bIsReadPaused )
FDSetCheck( iRSock, miiReadyFds, eCheckRead );
if( pcSock->AllowWrite( iNOW ) && ( !pcSock->IsConnected() || bHasWriteBuffer ) )
{
if( !pcSock->IsConnected() )
{ // set the write bit if not connected yet
FDSetCheck( iWSock, miiReadyFds, eCheckWrite );
}
else if( bHasWriteBuffer && !pcSock->GetSSL() )
{ // always set the write bit if there is data to send when NOT ssl
FDSetCheck( iWSock, miiReadyFds, eCheckWrite );
}
else if( bHasWriteBuffer && pcSock->GetSSL() && pcSock->SslIsEstablished() )
{ // ONLY set the write bit if there is data to send and the SSL handshake is finished
FDSetCheck( iWSock, miiReadyFds, eCheckWrite );
}
}
if( pcSock->GetSSL() && !pcSock->SslIsEstablished() && bHasWriteBuffer )
{ // if this is an unestabled SSL session with data to send ... try sending it
// do this here, cause otherwise ssl will cause a small
// cpu spike waiting for the handshake to finish
// resend this data
if ( !pcSock->Write( "" ) )
{
pcSock->Close();
}
// warning ... setting write bit in here causes massive CPU spinning on invalid SSL servers
// http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=631590
// however, we can set the select WAY down and it will retry quickly, but keep it from spinning at 100%
tv.tv_usec = iQuickReset;
tv.tv_sec = 0;
}
}
else
{
FDSetCheck( iRSock, miiReadyFds, eCheckRead );
}
if( pcSock->GetSSL() && pcSock->GetType() != Csock::LISTENER )
{
if ( ( pcSock->GetPending() > 0 ) && ( !pcSock->IsReadPaused() ) )
SelectSock( mpeSocks, SUCCESS, pcSock );
}
}
// old fashion select, go fer it
int iSel;
if( !mpeSocks.empty() ) // .1 ms pause to see if anything else is ready (IE if there is SSL data pending, don't wait too long)
{
tv.tv_usec = iQuickReset;
tv.tv_sec = 0;
}
else if ( !this->empty() && !bHasAvailSocks )
{
tv.tv_usec = iQuickReset;
tv.tv_sec = 0;
}
iSel = Select( miiReadyFds, &tv );
if ( iSel == 0 )
{
if ( mpeSocks.empty() )
m_errno = SELECT_TIMEOUT;
else
m_errno = SUCCESS;
#ifdef HAVE_C_ARES
// run through ares channels and process timeouts
for( u_long uSock = 0; uSock < this->size(); ++uSock )
{
T *pcSock = this->at( uSock );
ares_channel pChannel = pcSock->GetAresChannel();
if( pChannel )
ares_process_fd( pChannel, ARES_SOCKET_BAD, ARES_SOCKET_BAD );
}
#endif /* HAVE_C_ARES */
return;
}
if ( ( iSel == -1 ) && ( errno == EINTR ) )
{
if ( mpeSocks.empty() )
m_errno = SELECT_TRYAGAIN;
else
m_errno = SUCCESS;
return;
}
else if ( iSel == -1 )
{
if ( mpeSocks.empty() )
m_errno = SELECT_ERROR;
else
m_errno = SUCCESS;
return;
}
else
{
m_errno = SUCCESS;
}
// find out wich one is ready
for( unsigned int i = 0; i < this->size(); i++ )
{
T *pcSock = (*this)[i];
#ifdef HAVE_C_ARES
ares_channel pChannel = pcSock->GetAresChannel();
if( pChannel )
{
ares_socket_t aiAresSocks[1];
aiAresSocks[0] = ARES_SOCKET_BAD;
ares_getsock( pChannel, aiAresSocks, 1 );
if( FDHasCheck( aiAresSocks[0], miiReadyFds, eCheckRead ) || FDHasCheck( aiAresSocks[0], miiReadyFds, eCheckWrite ) )
ares_process_fd( pChannel, aiAresSocks[0], aiAresSocks[0] );
}
#endif /* HAVE_C_ARES */
if ( pcSock->GetConState() != T::CST_OK )
continue;
cs_sock_t & iRSock = pcSock->GetRSock();
cs_sock_t & iWSock = pcSock->GetWSock();
EMessages iErrno = SUCCESS;
if ( iRSock == CS_INVALID_SOCK || iWSock == CS_INVALID_SOCK )
{
// trigger a success so it goes through the normal motions
// and an error is produced
SelectSock( mpeSocks, SUCCESS, pcSock );
continue; // watch for invalid socks
}
if ( FDHasCheck( iWSock, miiReadyFds, eCheckWrite ) )
{
if ( iSel > 0 )
{
iErrno = SUCCESS;
if ( ( !pcSock->GetWriteBuffer().empty() ) && ( pcSock->IsConnected() ) )
{ // write whats in the socks send buffer
if ( !pcSock->Write( "" ) )
{
// write failed, sock died :(
iErrno = SELECT_ERROR;
}
}
} else
iErrno = SELECT_ERROR;
SelectSock( mpeSocks, iErrno, pcSock );
}
else if ( FDHasCheck( iRSock, miiReadyFds, eCheckRead ) )
{
if ( iSel > 0 )
iErrno = SUCCESS;
else
iErrno = SELECT_ERROR;
if ( pcSock->GetType() != T::LISTENER )
SelectSock( mpeSocks, iErrno, pcSock );
else // someone is coming in!
{
CS_STRING sHost;
u_short port;
cs_sock_t inSock = pcSock->Accept( sHost, port );
if ( inSock != CS_INVALID_SOCK )
{
if ( T::TMO_ACCEPT & pcSock->GetTimeoutType() )
pcSock->ResetTimer(); // let them now it got dinged
// if we have a new sock, then add it
T *NewpcSock = (T *)pcSock->GetSockObj( sHost, port );
if ( !NewpcSock )
NewpcSock = new T( sHost, port );
NewpcSock->BlockIO( false );
NewpcSock->SetType( T::INBOUND );
NewpcSock->SetRSock( inSock );
NewpcSock->SetWSock( inSock );
NewpcSock->SetIPv6( pcSock->GetIPv6() );
bool bAddSock = true;
#ifdef HAVE_LIBSSL
//
// is this ssl ?
if ( pcSock->GetSSL() )
{
NewpcSock->SetCipher( pcSock->GetCipher() );
NewpcSock->SetPemLocation( pcSock->GetPemLocation() );
NewpcSock->SetPemPass( pcSock->GetPemPass() );
NewpcSock->SetRequireClientCertFlags( pcSock->GetRequireClientCertFlags() );
bAddSock = NewpcSock->AcceptSSL();
}
#endif /* HAVE_LIBSSL */
if ( bAddSock )
{
// set the name of the listener
NewpcSock->SetParentSockName( pcSock->GetSockName() );
NewpcSock->SetRate( pcSock->GetRateBytes(), pcSock->GetRateTime() );
if ( NewpcSock->GetSockName().empty() )
{
std::stringstream s;
s << sHost << ":" << port;
AddSock( NewpcSock, s.str() );
} else
AddSock( NewpcSock, NewpcSock->GetSockName() );
} else
CS_Delete( NewpcSock );
}
#ifdef _WIN32
else if( GetSockError() != WSAEWOULDBLOCK )
#else /* _WIN32 */
else if( GetSockError() != EAGAIN )
#endif /* _WIN32 */
{
pcSock->SockError( GetSockError() );
}
}
}
}
}
time_t GetDynamicSleepTime( time_t iNow, time_t iMaxResolution = 3600 ) const
{
time_t iNextRunTime = iNow + iMaxResolution;
typename std::vector<T *>::const_iterator it;
// This is safe, because we don't modify the vector.
typename std::vector<T *>::const_iterator it_end = this->end();
for (it = this->begin(); it != it_end; it++)
{
T* pSock = *it;
if( pSock->GetConState() != T::CST_OK )
iNextRunTime = iNow; // this is in a nebulous state, need to let it proceed like normal
time_t iTimeoutInSeconds = pSock->GetTimeout();
if( iTimeoutInSeconds > 0 )
{
time_t iNextTimeout = pSock->GetNextCheckTimeout( iNow );
iNextRunTime = std::min( iNextRunTime, iNextTimeout );
}
const std::vector<CCron *> & vCrons = pSock->GetCrons();
std::vector<CCron *>::const_iterator cit;
std::vector<CCron *>::const_iterator cit_end = vCrons.end();
for (cit = vCrons.begin(); cit != cit_end; cit++)
iNextRunTime = std::min( iNextRunTime, (*cit)->GetNextRun() );
}
std::vector<CCron *>::const_iterator cit;
std::vector<CCron *>::const_iterator cit_end = m_vcCrons.end();
for (cit = m_vcCrons.begin(); cit != cit_end; cit++)
iNextRunTime = std::min( iNextRunTime, (*cit)->GetNextRun() );
if( iNextRunTime < iNow )
return( 0 ); // smallest unit possible
return( std::min( iNextRunTime - iNow, iMaxResolution ) );
}
//! internal use only
virtual void SelectSock( std::map<T *, EMessages> & mpeSocks, EMessages eErrno, T * pcSock )
{
if ( mpeSocks.find( pcSock ) != mpeSocks.end() )
return;
mpeSocks[pcSock] = eErrno;
}
//! these crons get ran and checked in Loop()
virtual void Cron()
{
time_t iNow = 0;
for( unsigned int a = 0; a < m_vcCrons.size(); a++ )
{
CCron *pcCron = m_vcCrons[a];
if ( !pcCron->isValid() )
{
CS_Delete( pcCron );
m_vcCrons.erase( m_vcCrons.begin() + a-- );
} else
pcCron->run( iNow );
}
}
////////
// Connection State Functions
///////////
// members
EMessages m_errno;
std::vector<CCron *> m_vcCrons;
unsigned long long m_iCallTimeouts;
unsigned long long m_iBytesRead;
unsigned long long m_iBytesWritten;
u_long m_iSelectWait;
};
//! basic socket class
typedef TSocketManager<Csock> CSocketManager;
#ifndef _NO_CSOCKET_NS
}
#endif /* _NO_CSOCKET_NS */
#endif /* _HAS_CSOCKET_ */
|