1 // SoftEther VPN Source Code - Stable Edition Repository
2 // Cedar Communication Module
3 //
4 // SoftEther VPN Server, Client and Bridge are free software under the Apache License, Version 2.0.
5 //
6 // Copyright (c) Daiyuu Nobori.
7 // Copyright (c) SoftEther VPN Project, University of Tsukuba, Japan.
8 // Copyright (c) SoftEther Corporation.
9 // Copyright (c) all contributors on SoftEther VPN project in GitHub.
10 //
11 // All Rights Reserved.
12 //
13 // http://www.softether.org/
14 //
15 // This stable branch is officially managed by Daiyuu Nobori, the owner of SoftEther VPN Project.
16 // Pull requests should be sent to the Developer Edition Master Repository on https://github.com/SoftEtherVPN/SoftEtherVPN
17 //
18 // License: The Apache License, Version 2.0
19 // https://www.apache.org/licenses/LICENSE-2.0
20 //
21 // DISCLAIMER
22 // ==========
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 // SOFTWARE.
31 //
32 // THIS SOFTWARE IS DEVELOPED IN JAPAN, AND DISTRIBUTED FROM JAPAN, UNDER
33 // JAPANESE LAWS. YOU MUST AGREE IN ADVANCE TO USE, COPY, MODIFY, MERGE, PUBLISH,
34 // DISTRIBUTE, SUBLICENSE, AND/OR SELL COPIES OF THIS SOFTWARE, THAT ANY
35 // JURIDICAL DISPUTES WHICH ARE CONCERNED TO THIS SOFTWARE OR ITS CONTENTS,
36 // AGAINST US (SOFTETHER PROJECT, SOFTETHER CORPORATION, DAIYUU NOBORI OR OTHER
37 // SUPPLIERS), OR ANY JURIDICAL DISPUTES AGAINST US WHICH ARE CAUSED BY ANY KIND
38 // OF USING, COPYING, MODIFYING, MERGING, PUBLISHING, DISTRIBUTING, SUBLICENSING,
39 // AND/OR SELLING COPIES OF THIS SOFTWARE SHALL BE REGARDED AS BE CONSTRUED AND
40 // CONTROLLED BY JAPANESE LAWS, AND YOU MUST FURTHER CONSENT TO EXCLUSIVE
41 // JURISDICTION AND VENUE IN THE COURTS SITTING IN TOKYO, JAPAN. YOU MUST WAIVE
42 // ALL DEFENSES OF LACK OF PERSONAL JURISDICTION AND FORUM NON CONVENIENS.
43 // PROCESS MAY BE SERVED ON EITHER PARTY IN THE MANNER AUTHORIZED BY APPLICABLE
44 // LAW OR COURT RULE.
45 //
46 // USE ONLY IN JAPAN. DO NOT USE THIS SOFTWARE IN ANOTHER COUNTRY UNLESS YOU HAVE
47 // A CONFIRMATION THAT THIS SOFTWARE DOES NOT VIOLATE ANY CRIMINAL LAWS OR CIVIL
48 // RIGHTS IN THAT PARTICULAR COUNTRY. USING THIS SOFTWARE IN OTHER COUNTRIES IS
49 // COMPLETELY AT YOUR OWN RISK. THE SOFTETHER VPN PROJECT HAS DEVELOPED AND
50 // DISTRIBUTED THIS SOFTWARE TO COMPLY ONLY WITH THE JAPANESE LAWS AND EXISTING
51 // CIVIL RIGHTS INCLUDING PATENTS WHICH ARE SUBJECTS APPLY IN JAPAN. OTHER
52 // COUNTRIES' LAWS OR CIVIL RIGHTS ARE NONE OF OUR CONCERNS NOR RESPONSIBILITIES.
53 // WE HAVE NEVER INVESTIGATED ANY CRIMINAL REGULATIONS, CIVIL LAWS OR
54 // INTELLECTUAL PROPERTY RIGHTS INCLUDING PATENTS IN ANY OF OTHER 200+ COUNTRIES
55 // AND TERRITORIES. BY NATURE, THERE ARE 200+ REGIONS IN THE WORLD, WITH
56 // DIFFERENT LAWS. IT IS IMPOSSIBLE TO VERIFY EVERY COUNTRIES' LAWS, REGULATIONS
57 // AND CIVIL RIGHTS TO MAKE THE SOFTWARE COMPLY WITH ALL COUNTRIES' LAWS BY THE
58 // PROJECT. EVEN IF YOU WILL BE SUED BY A PRIVATE ENTITY OR BE DAMAGED BY A
59 // PUBLIC SERVANT IN YOUR COUNTRY, THE DEVELOPERS OF THIS SOFTWARE WILL NEVER BE
60 // LIABLE TO RECOVER OR COMPENSATE SUCH DAMAGES, CRIMINAL OR CIVIL
61 // RESPONSIBILITIES. NOTE THAT THIS LINE IS NOT LICENSE RESTRICTION BUT JUST A
62 // STATEMENT FOR WARNING AND DISCLAIMER.
63 //
64 // READ AND UNDERSTAND THE 'WARNING.TXT' FILE BEFORE USING THIS SOFTWARE.
65 // SOME SOFTWARE PROGRAMS FROM THIRD PARTIES ARE INCLUDED ON THIS SOFTWARE WITH
66 // LICENSE CONDITIONS WHICH ARE DESCRIBED ON THE 'THIRD_PARTY.TXT' FILE.
67 //
68 //
69 // SOURCE CODE CONTRIBUTION
70 // ------------------------
71 //
72 // Your contribution to SoftEther VPN Project is much appreciated.
73 // Please send patches to us through GitHub.
74 // Read the SoftEther VPN Patch Acceptance Policy in advance:
75 // http://www.softether.org/5-download/src/9.patch
76 //
77 //
78 // DEAR SECURITY EXPERTS
79 // ---------------------
80 //
81 // If you find a bug or a security vulnerability please kindly inform us
82 // about the problem immediately so that we can fix the security problem
83 // to protect a lot of users around the world as soon as possible.
84 //
85 // Our e-mail address for security reports is:
86 // softether-vpn-security [at] softether.org
87 //
88 // Please note that the above e-mail address is not a technical support
89 // inquiry address. If you need technical assistance, please visit
90 // http://www.softether.org/ and ask your question on the users forum.
91 //
92 // Thank you for your cooperation.
93 //
94 //
95 // NO MEMORY OR RESOURCE LEAKS
96 // ---------------------------
97 //
98 // The memory-leaks and resource-leaks verification under the stress
99 // test has been passed before release this source code.
100 
101 
102 // IPsec_IPC.h
103 // Header of IPsec_IPC.c
104 
105 #ifndef	IPSEC_IPC
106 #define	IPSEC_IPC
107 
108 // Constants
109 #define	IPC_ARP_LIFETIME				(3 * 60 * 1000)
110 #define	IPC_ARP_GIVEUPTIME				(1 * 1000)
111 #define	IPC_DHCP_TIMEOUT				(5 * 1000)
112 #define	IPC_DHCP_TIMEOUT_TOTAL_GIVEUP	(20 * 1000)
113 #define	IPC_DHCP_MIN_LEASE				5
114 #define	IPC_DHCP_DEFAULT_LEASE			3600
115 
116 #define	IPC_MAX_PACKET_QUEUE_LEN		10000
117 
118 #define	IPC_DHCP_VENDOR_ID				"MSFT 5.0"
119 
120 #define	IPC_PASSWORD_MSCHAPV2_TAG		"xH7DiNlurDhcYV4a:"
121 
122 #define IPC_LAYER_2						2
123 #define IPC_LAYER_3						3
124 
125 // ARP table entry
126 struct IPC_ARP
127 {
128 	IP Ip;								// IP address
129 	bool Resolved;						// Whether the MAC address have been resolved
130 	UCHAR MacAddress[6];				// MAC address
131 	UINT64 GiveupTime;					// Time to give up (in the case of unresolved)
132 	UINT64 ExpireTime;					// Expiration date (If resolved)
133 	QUEUE *PacketQueue;					// Transmission packet queue
134 };
135 
136 // DHCP release queue
137 struct IPC_DHCP_RELESAE_QUEUE
138 {
139 	DHCP_OPTION_LIST Req;
140 	UINT TranId;
141 	UCHAR MacAddress[6];
142 };
143 
144 // IPC_SESSION_SHARED_BUFFER_DATA
145 struct IPC_SESSION_SHARED_BUFFER_DATA
146 {
147 	char ProtocolDetails[256];		// Protocol Details
148 	bool EnableUdpAccel;
149 	bool UsingUdpAccel;
150 };
151 
152 // IPC_PARAM
153 struct IPC_PARAM
154 {
155 	char ClientName[MAX_SIZE];
156 	char Postfix[MAX_SIZE];
157 	char HubName[MAX_HUBNAME_LEN + 1];
158 	char UserName[MAX_USERNAME_LEN + 1];
159 	char Password[MAX_PASSWORD_LEN + 1];
160 	IP ClientIp;
161 	UINT ClientPort;
162 	IP ServerIp;
163 	UINT ServerPort;
164 	char ClientHostname[MAX_SIZE];
165 	char CryptName[MAX_SIZE];
166 	bool BridgeMode;
167 	UINT Mss;
168 	bool IsL3Mode;
169 	bool IsOpenVPN;
170 	X *ClientCertificate;
171 	UINT Layer;
172 };
173 
174 // IPC_ASYNC object
175 struct IPC_ASYNC
176 {
177 	CEDAR *Cedar;						// Cedar
178 	IPC_PARAM Param;					// Parameters for creating IPC
179 	THREAD *Thread;						// Thread
180 	SOCK_EVENT *SockEvent;				// Socket events that is set when the connection is completed
181 	bool Done;							// Processing completion flag
182 	IPC *Ipc;							// IPC object (if it fails to connect, the value is NULL)
183 	TUBE *TubeForDisconnect;			// Tube for disconnection notification
184 	UINT ErrorCode;						// Error code in the case of failing to connect
185 	DHCP_OPTION_LIST L3ClientAddressOption;	// Client IP address option (Only in the case of L3 mode)
186 	UINT64 L3DhcpRenewInterval;			// DHCP update interval
187 	UINT64 L3NextDhcpRenewTick;			// DHCP renewal time of the next
188 	bool DhcpAllocFailed;				// Failed to get IP address from the DHCP server
189 };
190 
191 // IPC object
192 struct IPC
193 {
194 	CEDAR *Cedar;
195 	char HubName[MAX_HUBNAME_LEN + 1];
196 	char UserName[MAX_USERNAME_LEN + 1];
197 	char Password[MAX_PASSWORD_LEN + 1];
198 	char ClientHostname[MAX_SIZE];
199 	UCHAR random[SHA1_SIZE];
200 	char SessionName[MAX_SESSION_NAME_LEN + 1];
201 	char ConnectionName[MAX_CONNECTION_NAME_LEN + 1];
202 	POLICY *Policy;
203 	SOCK *Sock;
204 	INTERRUPT_MANAGER *Interrupt;		// Interrupt manager
205 	IP ClientIPAddress;					// IP address of the client
206 	IP SubnetMask;						// Subnet mask of the client
207 	IP DefaultGateway;					// Default gateway address
208 	IP BroadcastAddress;				// Broadcast address
209 	UCHAR MacAddress[6];				// MAC address
210 	UCHAR Padding[2];
211 	LIST *ArpTable;						// ARP table
212 	QUEUE *IPv4RecviedQueue;			// IPv4 reception queue
213 	TUBE_FLUSH_LIST *FlushList;			// Tube Flush List
214 	UCHAR MsChapV2_ServerResponse[20];	// Server response
215 	DHCP_CLASSLESS_ROUTE_TABLE ClasslessRoute;	// Classless routing table
216 	SHARED_BUFFER *IpcSessionSharedBuffer;	// A shared buffer between IPC and Session
217 	IPC_SESSION_SHARED_BUFFER_DATA *IpcSessionShared;	// A shared data between IPC and Session
218 	UINT Layer;
219 };
220 
221 // MS-CHAPv2 authentication information
222 struct IPC_MSCHAP_V2_AUTHINFO
223 {
224 	char MsChapV2_PPPUsername[MAX_SIZE];	// MS-CHAPv2 Username
225 	UCHAR MsChapV2_ServerChallenge[16];	// MS-CHAPv2 Server Challenge
226 	UCHAR MsChapV2_ClientChallenge[16];	// MS-CHAPv2 Client Challenge
227 	UCHAR MsChapV2_ClientResponse[24];	// MS-CHAPv2 Client Response
228 	EAP_CLIENT *MsChapV2_EapClient;		// EAP client
229 };
230 
231 IPC *NewIPC(CEDAR *cedar, char *client_name, char *postfix, char *hubname, char *username, char *password,
232 			UINT *error_code, IP *client_ip, UINT client_port, IP *server_ip, UINT server_port,
233 			char *client_hostname, char *crypt_name,
234 			bool bridge_mode, UINT mss, EAP_CLIENT *eap_client, X *client_certificate,
235 			UINT layer);
236 IPC *NewIPCByParam(CEDAR *cedar, IPC_PARAM *param, UINT *error_code);
237 IPC *NewIPCBySock(CEDAR *cedar, SOCK *s, void *mac_address);
238 void FreeIPC(IPC *ipc);
239 bool IsIPCConnected(IPC *ipc);
240 void IPCSetSockEventWhenRecvL2Packet(IPC *ipc, SOCK_EVENT *e);
241 void IPCSendL2(IPC *ipc, void *data, UINT size);
242 void IPCSendIPv4(IPC *ipc, void *data, UINT size);
243 BLOCK *IPCRecvL2(IPC *ipc);
244 BLOCK *IPCRecvIPv4(IPC *ipc);
245 void IPCProcessInterrupts(IPC *ipc);
246 void IPCProcessL3Events(IPC *ipc);
247 void IPCProcessL3EventsEx(IPC *ipc, UINT64 now);
248 bool IPCSetIPv4Parameters(IPC *ipc, IP *ip, IP *subnet, IP *gw, DHCP_CLASSLESS_ROUTE_TABLE *rt);
249 IPC_ARP *IPCNewARP(IP *ip, UCHAR *mac_address);
250 void IPCFreeARP(IPC_ARP *a);
251 int IPCCmpArpTable(void *p1, void *p2);
252 void IPCSendIPv4Unicast(IPC *ipc, void *data, UINT size, IP *next_ip);
253 IPC_ARP *IPCSearchArpTable(IPC *ipc, IP *ip);
254 void IPCSendIPv4WithDestMacAddr(IPC *ipc, void *data, UINT size, UCHAR *dest_mac_addr);
255 void IPCFlushArpTable(IPC *ipc);
256 void IPCFlushArpTableEx(IPC *ipc, UINT64 now);
257 void IPCProcessArp(IPC *ipc, BLOCK *b);
258 void IPCAssociateOnArpTable(IPC *ipc, IP *ip, UCHAR *mac_address);
259 bool IsValidUnicastMacAddress(UCHAR *mac);
260 bool IsValidUnicastIPAddress4(IP *ip);
261 bool IsValidUnicastIPAddressUINT4(UINT ip);
262 DHCPV4_DATA *IPCSendDhcpRequest(IPC *ipc, IP *dest_ip, UINT tran_id, DHCP_OPTION_LIST *opt, UINT expecting_code, UINT timeout, TUBE *discon_poll_tube);
263 BUF *IPCBuildDhcpRequest(IPC *ipc, IP *dest_ip, UINT tran_id, DHCP_OPTION_LIST *opt);
264 BUF *IPCBuildDhcpRequestOptions(IPC *ipc, DHCP_OPTION_LIST *opt);
265 bool IPCDhcpAllocateIP(IPC *ipc, DHCP_OPTION_LIST *opt, TUBE *discon_poll_tube);
266 bool IPCDhcpAllocateIPEx(IPC *ipc, DHCP_OPTION_LIST *opt, TUBE *discon_poll_tube, bool openvpn_compatible);
267 bool IPCDhcpRequestInformIP(IPC *ipc, DHCP_OPTION_LIST *opt, TUBE *discon_poll_tube, IP *client_ip);
268 void IPCDhcpRenewIP(IPC *ipc, IP *dhcp_server);
269 void IPCDhcpFreeIP(IPC *ipc, IP *dhcp_server);
270 IPC_ASYNC *NewIPCAsync(CEDAR *cedar, IPC_PARAM *param, SOCK_EVENT *sock_event);
271 void IPCAsyncThreadProc(THREAD *thread, void *param);
272 void FreeIPCAsync(IPC_ASYNC *a);
273 
274 bool ParseAndExtractMsChapV2InfoFromPassword(IPC_MSCHAP_V2_AUTHINFO *d, char *password);
275 
276 #endif	// IPSEC_IPC
277 
278 
279 
280