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 // NDIS6.h
103 // Header of NDIS6.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 // NDIS 6.2
122 #define	NDIS620_MINIPORT
123 #define	NDIS_SUPPORT_NDIS61			1
124 #define	NDIS_SUPPORT_NDIS620		1
125 #define NEO_NDIS_MAJOR_VERSION		6
126 #define NEO_NDIS_MINOR_VERSION		20
127 #define	NDIS_WDM					1
128 
129 #include <wdm.h>
130 #include <ndis.h>
131 #include <stdio.h>
132 #include <string.h>
133 
134 // Error checking macro
135 #define	OK(val)		((val) == STATUS_SUCCESS)
136 #define	NG(val)		(!OK(val))
137 
138 // Constant
139 static UINT SupportedOids[] =
140 {
141 	OID_GEN_SUPPORTED_LIST,
142 	OID_GEN_HARDWARE_STATUS,
143 	OID_GEN_MEDIA_SUPPORTED,
144 	OID_GEN_MEDIA_IN_USE,
145 	OID_GEN_MAXIMUM_FRAME_SIZE,
146 	OID_GEN_MAXIMUM_TOTAL_SIZE,
147 	OID_GEN_MAC_OPTIONS,
148 	OID_GEN_MAXIMUM_LOOKAHEAD,
149 	OID_GEN_CURRENT_LOOKAHEAD,
150 	OID_GEN_LINK_SPEED,
151 	OID_GEN_MEDIA_CONNECT_STATUS,
152 	OID_GEN_TRANSMIT_BUFFER_SPACE,
153 	OID_GEN_RECEIVE_BUFFER_SPACE,
154 	OID_GEN_TRANSMIT_BLOCK_SIZE,
155 	OID_GEN_RECEIVE_BLOCK_SIZE,
156 	OID_GEN_VENDOR_DESCRIPTION,
157 	OID_GEN_VENDOR_ID,
158 	OID_GEN_DRIVER_VERSION,
159 	OID_GEN_VENDOR_DRIVER_VERSION,
160 	OID_GEN_XMIT_OK,
161 	OID_GEN_RCV_OK,
162 	OID_GEN_XMIT_ERROR,
163 	OID_GEN_RCV_ERROR,
164 	OID_GEN_RCV_NO_BUFFER,
165 	OID_GEN_CURRENT_PACKET_FILTER,
166 	OID_802_3_PERMANENT_ADDRESS,
167 	OID_802_3_CURRENT_ADDRESS,
168 	OID_802_3_MAXIMUM_LIST_SIZE,
169 	OID_802_3_RCV_ERROR_ALIGNMENT,
170 	OID_802_3_XMIT_ONE_COLLISION,
171 	OID_802_3_XMIT_MORE_COLLISIONS,
172 	OID_802_3_MULTICAST_LIST,
173 	//OID_GEN_PROTOCOL_OPTIONS,
174 	OID_GEN_MAXIMUM_SEND_PACKETS,
175 	OID_GEN_STATISTICS,
176 	OID_GEN_INTERRUPT_MODERATION,
177 	OID_GEN_LINK_PARAMETERS,
178 	OID_PNP_SET_POWER,
179 	OID_PNP_QUERY_POWER,
180 	};
181 #define	NEO_MEDIA					NdisMedium802_3
182 #define	MAX_MULTICAST				32
183 
184 #define	MAX_PATH					260
185 #define	MAX_SIZE					512
186 #define	STD_SIZE					512
187 
188 
189 
190 // Unicode string
191 typedef struct _UNICODE
192 {
193 	UNICODE_STRING String;
194 } UNICODE;
195 
196 typedef struct _PACKET_BUFFER PACKET_BUFFER;
197 
198 // Function prototype
199 UNICODE *NewUnicode(char *str);
200 void FreeUnicode(UNICODE *u);
201 NDIS_STRING *GetUnicode(UNICODE *u);
202 PACKET_BUFFER *NeoNewPacketBuffer();
203 void NeoFreePacketBuffer(PACKET_BUFFER *p);
204 void NeoInitPacketArray();
205 void NeoFreePacketArray();
206 NDIS_STATUS DriverEntry(DRIVER_OBJECT *DriverObject, UNICODE_STRING *RegistryPath);
207 NDIS_STATUS NeoNdisInitEx(NDIS_HANDLE MiniportAdapterHandle,
208 						  NDIS_HANDLE MiniportDriverContext,
209 						  PNDIS_MINIPORT_INIT_PARAMETERS MiniportInitParameters);
210 void NeoNdisHaltEx(NDIS_HANDLE MiniportAdapterContext, NDIS_HALT_ACTION HaltAction);
211 VOID NeoNdisDriverUnload(PDRIVER_OBJECT DriverObject);
212 NDIS_STATUS NeoNdisResetEx(NDIS_HANDLE MiniportAdapterContext, PBOOLEAN AddressingReset);
213 BOOLEAN NeoNdisCheckForHangEx(NDIS_HANDLE MiniportAdapterContext);
214 NDIS_STATUS NeoNdisQuery(NDIS_HANDLE MiniportAdapterContext,
215 					NDIS_OID Oid,
216 					void *InformationBuffer,
217 					ULONG InformationBufferLength,
218 					ULONG *BytesWritten,
219 					ULONG *BytesNeeded);
220 NDIS_STATUS NeoNdisSet(
221 					NDIS_HANDLE MiniportAdapterContext,
222 					NDIS_OID Oid,
223 					void *InformationBuffer,
224 					ULONG InformationBufferLength,
225 					ULONG *BytesRead,
226 					ULONG *BytesNeeded);
227 NDIS_STATUS NeoNdisOidRequest(NDIS_HANDLE MiniportAdapterContext,
228 							  PNDIS_OID_REQUEST OidRequest);
229 void NeoNdisSendNetBufferLists(NDIS_HANDLE MiniportAdapterContext,
230 							   NET_BUFFER_LIST *NetBufferLists,
231 							   NDIS_PORT_NUMBER PortNumber,
232 							   ULONG SendFlags);
233 void NeoNdisSetNetBufferListsStatus(NET_BUFFER_LIST *nbl, UINT status);
234 BOOL NeoLoadRegistory();
235 void NeoInitControlDevice();
236 void NeoFreeControlDevice();
237 NTSTATUS NeoNdisDispatch(DEVICE_OBJECT *DeviceObject, IRP *Irp);
238 void NeoCheckConnectState();
239 void NeoSetConnectState(BOOL connected);
240 BOOL NeoNdisOnOpen(IRP *irp, IO_STACK_LOCATION *stack);
241 BOOL NeoNdisOnClose(IRP *irp, IO_STACK_LOCATION *stack);
242 void NeoNdisCrash();
243 void NeoNdisCrash2();
244 
245 NDIS_STATUS NeoNdisSetOptions(NDIS_HANDLE NdisDriverHandle, NDIS_HANDLE DriverContext);
246 NDIS_STATUS NeoNdisPause(NDIS_HANDLE MiniportAdapterContext, PNDIS_MINIPORT_PAUSE_PARAMETERS MiniportPauseParameters);
247 NDIS_STATUS NeoNdisRestart(NDIS_HANDLE MiniportAdapterContext, PNDIS_MINIPORT_RESTART_PARAMETERS MiniportRestartParameters);
248 void NeoNdisReturnNetBufferLists(NDIS_HANDLE MiniportAdapterContext, PNET_BUFFER_LIST NetBufferLists, ULONG ReturnFlags);
249 void NeoNdisCancelSend(NDIS_HANDLE MiniportAdapterContext, PVOID CancelId);
250 void NeoNdisDevicePnPEventNotify(NDIS_HANDLE MiniportAdapterContext, PNET_DEVICE_PNP_EVENT NetDevicePnPEvent);
251 void NeoNdisShutdownEx(NDIS_HANDLE MiniportAdapterContext, NDIS_SHUTDOWN_ACTION ShutdownAction);
252 void NeoNdisCancelOidRequest(NDIS_HANDLE MiniportAdapterContext, PVOID RequestId);
253 
254 // 		NeoNdisCrash2(__LINE__, __LINE__, __LINE__, __LINE__);
255 
256 
257 #endif	// NDIS5_H
258 
259