1 // SoftEther VPN Source Code - Stable Edition Repository
2 // Kernel Device Driver
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 // NDIS5.h
103 // Header of NDIS5.c
104 
105 #ifndef	NDIS5_H
106 #define	NDIS5_H
107 
108 // Win32 DDK related
109 #ifndef	CPU_64
110 #define	_X86_
111 #else	// CPU_64
112 #ifndef	NEO_IA64
113 #define	_AMD64_
114 #define	AMD64
115 #else	// NEO_IA64
116 #define	_IA64_
117 #define	IA64
118 #endif	// NEO_IA64
119 #endif	// CPU_64
120 #define	NDIS_MINIPORT_DRIVER
121 #ifndef	WIN9X
122 // Windows 2000 or later: NDIS 5.0
123 #define	NDIS50_MINIPORT
124 #define NEO_NDIS_MAJOR_VERSION		5
125 #define NEO_NDIS_MINOR_VERSION		0
126 #else	// WIN9X
127 // Windows 9x: NDIS 4.0
128 #define	NDIS40_MINIPORT
129 #define NEO_NDIS_MAJOR_VERSION		4
130 #define NEO_NDIS_MINOR_VERSION		0
131 #define	BINARY_COMPATIBLE 			1
132 #endif	// WIN9X
133 #define	NDIS_WDM					1
134 
135 #ifndef	WIN9X
136 #include <wdm.h>
137 #include <ndis.h>
138 #include <stdio.h>
139 #include <string.h>
140 #else	// WIN9X
141 #include <basedef.h>
142 #define	_LARGE_INTEGER	DUMMY__LARGE_INTEGER
143 #define	LARGE_INTEGER	DUMMY_LARGE_INTEGER
144 #define	PLARGE_INTEGER	DUMMY_PLARGE_INTEGER
145 #define	_ULARGE_INTEGER	DUMMY__ULARGE_INTEGER
146 #define	ULARGE_INTEGER	DUMMY_ULARGE_INTEGER
147 #define	PULARGE_INTEGER	DUMMY_PULARGE_INTEGER
148 #define	PSZ				DUMMY_PSZ
149 #include <ndis.h>
150 #include <vmm.h>
151 #include <vwin32.h>
152 #include <stdio.h>
153 #include <string.h>
154 #undef	_LARGE_INTEGER
155 #undef	LARGE_INTEGER
156 #undef	PLARGE_INTEGER
157 #undef	_ULARGE_INTEGER
158 #undef	ULARGE_INTEGER
159 #undef	PULARGE_INTEGER
160 #undef	PSZ
161 #endif	// WIN9X
162 
163 // Error checking macro
164 #define	OK(val)		(val == STATUS_SUCCESS)
165 #define	NG(val)		(!OK(val))
166 
167 // Constant
168 static UINT SupportedOids[] =
169 {
170 	OID_GEN_SUPPORTED_LIST,
171 	OID_GEN_HARDWARE_STATUS,
172 	OID_GEN_MEDIA_SUPPORTED,
173 	OID_GEN_MEDIA_IN_USE,
174 	OID_GEN_MAXIMUM_FRAME_SIZE,
175 	OID_GEN_MAXIMUM_TOTAL_SIZE,
176 	OID_GEN_MAC_OPTIONS,
177 	OID_GEN_MAXIMUM_LOOKAHEAD,
178 	OID_GEN_CURRENT_LOOKAHEAD,
179 	OID_GEN_LINK_SPEED,
180 	OID_GEN_MEDIA_CONNECT_STATUS,
181 	OID_GEN_TRANSMIT_BUFFER_SPACE,
182 	OID_GEN_RECEIVE_BUFFER_SPACE,
183 	OID_GEN_TRANSMIT_BLOCK_SIZE,
184 	OID_GEN_RECEIVE_BLOCK_SIZE,
185 	OID_GEN_VENDOR_DESCRIPTION,
186 	OID_GEN_VENDOR_ID,
187 	OID_GEN_DRIVER_VERSION,
188 	OID_GEN_VENDOR_DRIVER_VERSION,
189 	OID_GEN_XMIT_OK,
190 	OID_GEN_RCV_OK,
191 	OID_GEN_XMIT_ERROR,
192 	OID_GEN_RCV_ERROR,
193 	OID_GEN_RCV_NO_BUFFER,
194 	OID_GEN_CURRENT_PACKET_FILTER,
195 	OID_802_3_PERMANENT_ADDRESS,
196 	OID_802_3_CURRENT_ADDRESS,
197 	OID_802_3_MAXIMUM_LIST_SIZE,
198 	OID_802_3_RCV_ERROR_ALIGNMENT,
199 	OID_802_3_XMIT_ONE_COLLISION,
200 	OID_802_3_XMIT_MORE_COLLISIONS,
201 	OID_802_3_MULTICAST_LIST,
202 	//OID_GEN_PROTOCOL_OPTIONS,
203 	OID_GEN_MAXIMUM_SEND_PACKETS
204 	};
205 #define	NEO_MEDIA					NdisMedium802_3
206 #define	MAX_MULTICAST				32
207 
208 #define	MAX_PATH					260
209 #define	MAX_SIZE					512
210 #define	STD_SIZE					512
211 
212 
213 // Macro
214 #define _NdisInitializeString(Destination,Source) \
215 {\
216     PNDIS_STRING _D = (Destination);\
217     UCHAR *_S = (Source);\
218     WCHAR *_P;\
219     _D->Length = (USHORT)((strlen(_S)) * sizeof(WCHAR));\
220     _D->MaximumLength = _D->Length + sizeof(WCHAR);\
221     NdisAllocateMemoryWithTag((PVOID *)&(_D->Buffer), _D->MaximumLength, 'SETH');\
222     _P = _D->Buffer;\
223     while(*_S != '\0'){\
224         *_P = (WCHAR)(*_S);\
225         _S++;\
226         _P++;\
227     }\
228     *_P = UNICODE_NULL;\
229 }
230 
231 
232 // Unicode string
233 typedef struct _UNICODE
234 {
235 	UNICODE_STRING String;
236 } UNICODE;
237 
238 typedef struct _PACKET_BUFFER PACKET_BUFFER;
239 
240 // Function prototype
241 UNICODE *NewUnicode(char *str);
242 void FreeUnicode(UNICODE *u);
243 NDIS_STRING *GetUnicode(UNICODE *u);
244 PACKET_BUFFER *NeoNewPacketBuffer();
245 void NeoFreePacketBuffer(PACKET_BUFFER *p);
246 void NeoInitPacketArray();
247 void NeoFreePacketArray();
248 NDIS_STATUS DriverEntry(DRIVER_OBJECT *DriverObject, UNICODE_STRING *RegistryPath);
249 NDIS_STATUS NeoNdisInit(NDIS_STATUS *OpenErrorStatus,
250 					UINT *SelectedMediumIndex,
251 					NDIS_MEDIUM *MediumArray,
252 					UINT MediumArraySize,
253 					NDIS_HANDLE MiniportAdapterHandle,
254 					NDIS_HANDLE WrapperConfigurationContext);
255 NDIS_STATUS NeoNdisHalt(NDIS_HANDLE MiniportAdapterContext);
256 NDIS_STATUS NeoNdisReset(BOOLEAN *AddressingReset, NDIS_HANDLE MiniportAdapterContext);
257 NDIS_STATUS NeoNdisQuery(NDIS_HANDLE MiniportAdapterContext,
258 					NDIS_OID Oid,
259 					void *InformationBuffer,
260 					ULONG InformationBufferLength,
261 					ULONG *BytesWritten,
262 					ULONG *BytesNeeded);
263 NDIS_STATUS NeoNdisSet(
264 					NDIS_HANDLE MiniportAdapterContext,
265 					NDIS_OID Oid,
266 					void *InformationBuffer,
267 					ULONG InformationBufferLength,
268 					ULONG *BytesRead,
269 					ULONG *BytesNeeded);
270 void NeoNdisSendPackets(NDIS_HANDLE MiniportAdapterContext,
271 						NDIS_PACKET **PacketArray,
272 						UINT NumberOfPackets);
273 NDIS_STATUS NeoNdisSend(NDIS_HANDLE MiniportAdapterContext,
274 						NDIS_PACKET *Packet, UINT Flags);
275 BOOL NeoNdisSendPacketsHaltCheck(NDIS_PACKET **PacketArray, UINT NumberOfPackets);
276 BOOL NeoLoadRegistory();
277 void NeoInitControlDevice();
278 void NeoFreeControlDevice();
279 NTSTATUS NeoNdisDispatch(DEVICE_OBJECT *DeviceObject, IRP *Irp);
280 void NeoCheckConnectState();
281 void NeoSetConnectState(BOOL connected);
282 BOOL NeoNdisOnOpen(IRP *irp, IO_STACK_LOCATION *stack);
283 BOOL NeoNdisOnClose(IRP *irp, IO_STACK_LOCATION *stack);
284 
285 #endif	// NDIS5_H
286 
287