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
|
// SoftEther VPN Source Code
// Cedar Communication Module
//
// SoftEther VPN Server, Client and Bridge are free software under GPLv2.
//
// Copyright (c) 2012-2014 Daiyuu Nobori.
// Copyright (c) 2012-2014 SoftEther VPN Project, University of Tsukuba, Japan.
// Copyright (c) 2012-2014 SoftEther Corporation.
//
// All Rights Reserved.
//
// http://www.softether.org/
//
// Author: Daiyuu Nobori
// Comments: Tetsuo Sugiyama, Ph.D.
//
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// version 2 as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License version 2
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
// THE LICENSE AGREEMENT IS ATTACHED ON THE SOURCE-CODE PACKAGE
// AS "LICENSE.TXT" FILE. READ THE TEXT FILE IN ADVANCE TO USE THE SOFTWARE.
//
//
// THIS SOFTWARE IS DEVELOPED IN JAPAN, AND DISTRIBUTED FROM JAPAN,
// UNDER JAPANESE LAWS. YOU MUST AGREE IN ADVANCE TO USE, COPY, MODIFY,
// MERGE, PUBLISH, DISTRIBUTE, SUBLICENSE, AND/OR SELL COPIES OF THIS
// SOFTWARE, THAT ANY JURIDICAL DISPUTES WHICH ARE CONCERNED TO THIS
// SOFTWARE OR ITS CONTENTS, AGAINST US (SOFTETHER PROJECT, SOFTETHER
// CORPORATION, DAIYUU NOBORI OR OTHER SUPPLIERS), OR ANY JURIDICAL
// DISPUTES AGAINST US WHICH ARE CAUSED BY ANY KIND OF USING, COPYING,
// MODIFYING, MERGING, PUBLISHING, DISTRIBUTING, SUBLICENSING, AND/OR
// SELLING COPIES OF THIS SOFTWARE SHALL BE REGARDED AS BE CONSTRUED AND
// CONTROLLED BY JAPANESE LAWS, AND YOU MUST FURTHER CONSENT TO
// EXCLUSIVE JURISDICTION AND VENUE IN THE COURTS SITTING IN TOKYO,
// JAPAN. YOU MUST WAIVE ALL DEFENSES OF LACK OF PERSONAL JURISDICTION
// AND FORUM NON CONVENIENS. PROCESS MAY BE SERVED ON EITHER PARTY IN
// THE MANNER AUTHORIZED BY APPLICABLE LAW OR COURT RULE.
//
// USE ONLY IN JAPAN. DO NOT USE IT IN OTHER COUNTRIES. IMPORTING THIS
// SOFTWARE INTO OTHER COUNTRIES IS AT YOUR OWN RISK. SOME COUNTRIES
// PROHIBIT ENCRYPTED COMMUNICATIONS. USING THIS SOFTWARE IN OTHER
// COUNTRIES MIGHT BE RESTRICTED.
//
//
// DEAR SECURITY EXPERTS
// ---------------------
//
// If you find a bug or a security vulnerability please kindly inform us
// about the problem immediately so that we can fix the security problem
// to protect a lot of users around the world as soon as possible.
//
// Our e-mail address for security reports is:
// softether-vpn-security [at] softether.org
//
// Please note that the above e-mail address is not a technical support
// inquiry address. If you need technical assistance, please visit
// http://www.softether.org/ and ask your question on the users forum.
//
// Thank you for your cooperation.
// IPsec_EtherIP.c
// EtherIP protocol stack
#include "CedarPch.h"
// IPC connection processing thread
void EtherIPIpcConnectThread(THREAD *t, void *p)
{
ETHERIP_SERVER *s;
IPC *ipc = NULL;
UINT error_code = 0;
char tmp[MAX_SIZE];
ETHERIP_ID id;
// Validate arguments
if (t == NULL || p == NULL)
{
return;
}
s = (ETHERIP_SERVER *)p;
GetHostName(tmp, sizeof(tmp), &s->ClientIP);
// Get the setting of the virtual HUB to be connected based on the client ID presented
if (SearchEtherIPId(s->Ike->IPsec, &id, s->ClientId) == false &&
SearchEtherIPId(s->Ike->IPsec, &id, "*") == false)
{
// Failed to get the settings for the virtual HUB
Debug("Not Found: EtherIP Settings for Client ID \"%s\".\n", s->ClientId);
EtherIPLog(s, "LE_NO_SETTING", s->ClientId);
}
else
{
UINT mss = CalcEtherIPTcpMss(s);
char client_name[MAX_SIZE];
if (s->L2TPv3 == false)
{
StrCpy(client_name, sizeof(client_name), ETHERIP_CLIENT_NAME);
}
else
{
if (IsEmptyStr(s->VendorName))
{
StrCpy(client_name, sizeof(client_name), ETHERIP_L2TPV3_CLIENT_NAME);
}
else
{
Format(client_name, sizeof(client_name), ETHERIP_L2TPV3_CLIENT_NAME_EX, s->VendorName);
}
}
// Execution of IPC connection process
EtherIPLog(s, "LE_START_IPC", id.HubName, id.UserName, mss);
ipc = NewIPC(s->Cedar, client_name,
(s->L2TPv3 ? ETHERIP_L2TPV3_POSTFIX : ETHERIP_POSTFIX),
id.HubName, id.UserName, id.Password,
&error_code,
&s->ClientIP, s->ClientPort,
&s->ServerIP, s->ServerPort,
tmp,
s->CryptName, true, mss);
if (ipc != NULL)
{
Copy(&s->CurrentEtherIPIdSetting, &id, sizeof(ETHERIP_ID));
EtherIPLog(s, "LE_IPC_CONNECT_OK", id.HubName);
}
else
{
EtherIPLog(s, "LE_IPC_CONNECT_ERROR", id.HubName, error_code, _E(error_code));
}
}
Lock(s->Lock);
{
// Set the results
ReleaseThread(s->IpcConnectThread);
s->IpcConnectThread = NULL;
s->Ipc = ipc;
s->LastConnectFailedTick = Tick64();
}
Unlock(s->Lock);
// Hit the event to cause interrupt
SetSockEvent(s->SockEvent);
// Release the EtherIP object that is hold by this thread
ReleaseEtherIPServer(s);
}
// Processing of the interrupt
void EtherIPProcInterrupts(ETHERIP_SERVER *s)
{
// Validate arguments
if (s == NULL)
{
return;
}
// If EtherIP settings have been changed, and the change may effect to this connection, disconnect
if (s->Ipc != NULL)
{
if (s->Ike->IPsec->EtherIPIdListSettingVerNo != s->LastEtherIPSettingVerNo)
{
ETHERIP_ID id;
bool ok = true;
s->LastEtherIPSettingVerNo = s->Ike->IPsec->EtherIPIdListSettingVerNo;
if (SearchEtherIPId(s->IPsec, &id, s->ClientId) == false &&
SearchEtherIPId(s->IPsec, &id, "*") == false)
{
ok = false;
}
else
{
if (StrCmpi(s->CurrentEtherIPIdSetting.HubName, id.HubName) != 0 ||
StrCmpi(s->CurrentEtherIPIdSetting.UserName, id.UserName) != 0 ||
StrCmp(s->CurrentEtherIPIdSetting.Password, id.Password) != 0)
{
ok = false;
}
}
if (ok == false)
{
// Disconnect immediately since setting of EtherIP seems to have been changed
FreeIPC(s->Ipc);
s->Ipc = NULL;
EtherIPLog(s, "LE_RECONNECT");
}
}
}
// Connect if IPC connection is not completed
Lock(s->Lock);
{
if (s->Ipc == NULL)
{
if (s->IpcConnectThread == NULL)
{
if ((s->LastConnectFailedTick == 0) || ((s->LastConnectFailedTick + (UINT64)ETHERIP_VPN_CONNECT_RETRY_INTERVAL) <= s->Now))
{
Lock(s->IPsec->LockSettings);
{
Copy(&s->CurrentIPSecServiceSetting, &s->IPsec->Services, sizeof(IPSEC_SERVICES));
}
Unlock(s->IPsec->LockSettings);
s->IpcConnectThread = NewThread(EtherIPIpcConnectThread, s);
AddThreadToThreadList(s->Ike->ThreadList, s->IpcConnectThread);
AddRef(s->Ref);
}
}
}
}
Unlock(s->Lock);
if (s->Ipc != NULL)
{
// Set to get hit the SockEvent when a packet arrives via the IPC
IPCSetSockEventWhenRecvL2Packet(s->Ipc, s->SockEvent);
// IPC interrupt processing
IPCProcessInterrupts(s->Ipc);
// Receive the MAC frame which arrived via the IPC
while (true)
{
BLOCK *b = IPCRecvL2(s->Ipc);
UCHAR *dst;
UINT dst_size;
if (b == NULL)
{
break;
}
if (b->Size >= 14)
{
BLOCK *block;
// Store the arrived MAC frame by adding an EtherIP header to the reception packet queue
if (s->L2TPv3 == false)
{
dst_size = b->Size + 2;
dst = Malloc(dst_size);
dst[0] = 0x30;
dst[1] = 0x00;
Copy(dst + 2, b->Buf, b->Size);
}
else
{
dst = Clone(b->Buf, b->Size);
dst_size = b->Size;
}
block = NewBlock(dst, dst_size, 0);
Add(s->SendPacketList, block);
}
FreeBlock(b);
}
if (IsIPCConnected(s->Ipc) == false)
{
// IPC connection is disconnected
FreeIPC(s->Ipc);
s->Ipc = NULL;
}
}
}
// Process the received packet
void EtherIPProcRecvPackets(ETHERIP_SERVER *s, BLOCK *b)
{
UCHAR *src;
UINT src_size;
// Validate arguments
if (s == NULL || b == NULL)
{
return;
}
if (s->Ipc == NULL)
{
// Not connected to the Virtual HUB
return;
}
src = b->Buf;
src_size = b->Size;
if (s->L2TPv3 == false)
{
// EtherIP header confirmation
if (src_size < 2)
{
return;
}
if ((src[0] & 0xf0) != 0x30)
{
return;
}
src += 2;
src_size -= 2;
}
if (src_size < 14)
{
// The size of the MAC frame is less than 14 bytes
return;
}
// Send by IPC since a MAC frame has been received
IPCSendL2(s->Ipc, src, src_size);
}
// Create a new EtherIP server
ETHERIP_SERVER *NewEtherIPServer(CEDAR *cedar, IPSEC_SERVER *ipsec, IKE_SERVER *ike,
IP *client_ip, UINT client_port, IP *server_ip, UINT server_port, char *crypt_name,
bool is_tunnel_mode, UINT crypt_block_size,
char *client_id, UINT id)
{
ETHERIP_SERVER *s;
// Validate arguments
if (cedar == NULL || ipsec == NULL || ike == NULL || client_ip == NULL || server_ip == NULL || client_id == NULL)
{
return NULL;
}
s = ZeroMalloc(sizeof(ETHERIP_SERVER));
s->Ref = NewRef();
s->Id = id;
s->Cedar = cedar;
AddRef(s->Cedar->ref);
s->IPsec = ipsec;
s->Ike = ike;
s->IsTunnelMode = is_tunnel_mode;
StrCpy(s->ClientId, sizeof(s->ClientId), client_id);
s->SendPacketList = NewList(NULL);
s->Now = Tick64();
s->Lock = NewLock();
Copy(&s->ClientIP, client_ip, sizeof(IP));
s->ClientPort = client_port;
Copy(&s->ServerIP, server_ip, sizeof(IP));
s->ServerPort = server_port;
StrCpy(s->CryptName, sizeof(s->CryptName), crypt_name);
s->CryptBlockSize = crypt_block_size;
EtherIPLog(s, "LE_START_MODULE");
return s;
}
// Release the EtherIP server
void ReleaseEtherIPServer(ETHERIP_SERVER *s)
{
// Validate arguments
if (s == NULL)
{
return;
}
if (Release(s->Ref) == 0)
{
CleanupEtherIPServer(s);
}
}
void CleanupEtherIPServer(ETHERIP_SERVER *s)
{
UINT i;
// Validate arguments
if (s == NULL)
{
return;
}
EtherIPLog(s, "LE_STOP");
if (s->IpcConnectThread != NULL)
{
ReleaseThread(s->IpcConnectThread);
}
if (s->Ipc != NULL)
{
FreeIPC(s->Ipc);
}
for (i = 0;i < LIST_NUM(s->SendPacketList);i++)
{
BLOCK *b = LIST_DATA(s->SendPacketList, i);
FreeBlock(b);
}
ReleaseList(s->SendPacketList);
ReleaseSockEvent(s->SockEvent);
ReleaseCedar(s->Cedar);
DeleteLock(s->Lock);
Free(s);
}
// Set SockEvent to EtherIP server
void SetEtherIPServerSockEvent(ETHERIP_SERVER *s, SOCK_EVENT *e)
{
// Validate arguments
if (s == NULL)
{
return;
}
if (e != NULL)
{
AddRef(e->ref);
}
if (s->SockEvent != NULL)
{
ReleaseSockEvent(s->SockEvent);
s->SockEvent = NULL;
}
s->SockEvent = e;
}
// Calculate the proper TCP MSS in EtherIP communication
UINT CalcEtherIPTcpMss(ETHERIP_SERVER *s)
{
UINT ret = MTU_FOR_PPPOE;
// Validate arguments
if (s == NULL)
{
return 0;
}
// IPv4 / IPv6
if (IsIP4(&s->ClientIP))
{
ret -= 20;
}
else
{
ret -= 40;
}
// IPsec UDP
ret -= 8;
// IPsec ESP
ret -= 20;
ret -= s->CryptBlockSize * 2;
// IPsec Tunnel Mode IPv4 / IPv6 Header
if (s->IsTunnelMode)
{
if (IsIP4(&s->ClientIP))
{
ret -= 20;
}
else
{
ret -= 40;
}
}
if (s->L2TPv3 == false)
{
// EtherIP
ret -= 2;
}
else
{
// L2TPv3
ret -= 2;
}
// Ethernet
ret -= 14;
// IPv4
ret -= 20;
// TCP
ret -= 20;
return ret;
}
// Developed by SoftEther VPN Project at University of Tsukuba in Japan.
// Department of Computer Science has dozens of overly-enthusiastic geeks.
// Join us: http://www.tsukuba.ac.jp/english/admission/
|