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
package wfp
import (
"fmt"
"runtime"
"unsafe"
"golang.org/x/sys/windows"
)
// Rules is what Start enforces: on the ALE connect layers (IPv4 and IPv6),
// Programs may connect anywhere, anything may use the TUN interface and
// loopback, and nothing else may reach a remote port 53, nor, with
// BlockIPv6, any IPv6 address.
type Rules struct {
// Interface is the TUN adapter's interface index.
Interface uint32
// Programs are executable paths: the TUN service and the core.
Programs []string
// BlockIPv6 is for an adapter without IPv6 (IPv6 turned off on the
// computer): IPv6 then has no route into it, and must not leave
// outside it either.
BlockIPv6 bool
}
// Session holds the filters until Close.
type Session struct {
engine windows.Handle
}
// The filters' weights in their sublayer: the highest matching one
// decides.
const (
weightPrograms = 15
weightLoopback = 14
weightInterface = 13
weightBlockDNS = 12
weightBlockIPv6 = 11
)
// Start adds the filters in one transaction.
func Start(r Rules) (s *Session, err error) {
name, _ := windows.UTF16PtrFromString("Firefox VPN TUN")
session := fwpmSession0{
displayData: fwpmDisplayData0{name: name},
flags: fwpmSessionFlagDynamic,
}
var engine windows.Handle
if err := call(procFwpmEngineOpen0, 0, rpcCAuthnWinNT, 0, uintptr(unsafe.Pointer(&session)), uintptr(unsafe.Pointer(&engine))); err != nil {
return nil, fmt.Errorf("opening the filtering engine: %w", err)
}
defer func() {
if err != nil {
_ = call(procFwpmEngineClose0, uintptr(engine))
}
}()
if err := call(procFwpmTransactionBegin0, uintptr(engine), 0); err != nil {
return nil, fmt.Errorf("starting a filter transaction: %w", err)
}
if err := addFilters(engine, r); err != nil {
_ = call(procFwpmTransactionAbort0, uintptr(engine))
return nil, err
}
if err := call(procFwpmTransactionCommit0, uintptr(engine)); err != nil {
return nil, fmt.Errorf("committing the filters: %w", err)
}
return &Session{engine: engine}, nil
}
// Close removes the filters.
func (s *Session) Close() error {
if s == nil || s.engine == 0 {
return nil
}
err := call(procFwpmEngineClose0, uintptr(s.engine))
s.engine = 0
return err
}
func addFilters(engine windows.Handle, r Rules) error {
key, err := windows.GenerateGUID()
if err != nil {
return err
}
name, _ := windows.UTF16PtrFromString("Firefox VPN TUN")
description, _ := windows.UTF16PtrFromString("DNS only through the TUN adapter")
sublayer := fwpmSublayer0{
subLayerKey: key,
displayData: fwpmDisplayData0{name: name, description: description},
weight: 0xffff,
}
if err := call(procFwpmSubLayerAdd0, uintptr(engine), uintptr(unsafe.Pointer(&sublayer)), 0); err != nil {
return fmt.Errorf("adding the filter sublayer: %w", err)
}
both := []windows.GUID{fwpmLayerALEAuthConnectV4, fwpmLayerALEAuthConnectV6}
addTo := func(layers []windows.GUID, what string, weight uint8, action uint32, flags uint32, conditions []fwpmFilterCondition0) error {
for _, layer := range layers {
filterName, _ := windows.UTF16PtrFromString("Firefox VPN TUN: " + what)
f := fwpmFilter0{
displayData: fwpmDisplayData0{name: filterName},
flags: flags,
layerKey: layer,
subLayerKey: key,
weight: fwpValue0{typ: fwpUint8, value: uintptr(weight)},
action: fwpmAction0{typ: action},
}
if len(conditions) > 0 {
f.numFilterConditions = uint32(len(conditions))
f.filterCondition = &conditions[0]
}
var id uint64
err := call(procFwpmFilterAdd0, uintptr(engine), uintptr(unsafe.Pointer(&f)), 0, uintptr(unsafe.Pointer(&id)))
runtime.KeepAlive(conditions)
if err != nil {
return fmt.Errorf("adding the filter %q: %w", what, err)
}
}
return nil
}
add := func(what string, weight uint8, action uint32, flags uint32, conditions []fwpmFilterCondition0) error {
return addTo(both, what, weight, action, flags, conditions)
}
for _, program := range r.Programs {
blob, err := appID(program)
if err != nil {
return fmt.Errorf("the application ID of %s: %w", program, err)
}
conditions := []fwpmFilterCondition0{{
fieldKey: fwpmConditionALEAppID,
matchType: fwpMatchEqual,
conditionValue: fwpValue0{typ: fwpByteBlobType, value: uintptr(unsafe.Pointer(blob))},
}}
// A hard permit: no filter of a lower sublayer can block them.
err = add("permit "+program, weightPrograms, fwpActionPermit, fwpmFilterFlagClearActionRight, conditions)
freeMemory(unsafe.Pointer(blob))
if err != nil {
return err
}
}
if err := add("permit loopback", weightLoopback, fwpActionPermit, 0, []fwpmFilterCondition0{{
fieldKey: fwpmConditionFlags,
matchType: fwpMatchFlagsAllSet,
conditionValue: fwpValue0{typ: fwpUint32, value: fwpConditionFlagIsLoopback},
}}); err != nil {
return err
}
if err := add("permit the TUN adapter", weightInterface, fwpActionPermit, 0, []fwpmFilterCondition0{{
fieldKey: fwpmConditionLocalInterfaceIndex,
matchType: fwpMatchEqual,
conditionValue: fwpValue0{typ: fwpUint32, value: uintptr(r.Interface)},
}}); err != nil {
return err
}
if err := add("block DNS outside the TUN adapter", weightBlockDNS, fwpActionBlock, 0, []fwpmFilterCondition0{{
fieldKey: fwpmConditionIPRemotePort,
matchType: fwpMatchEqual,
conditionValue: fwpValue0{typ: fwpUint16, value: 53},
}}); err != nil {
return err
}
if r.BlockIPv6 {
return addTo([]windows.GUID{fwpmLayerALEAuthConnectV6}, "block IPv6 outside the TUN adapter", weightBlockIPv6, fwpActionBlock, 0, nil)
}
return nil
}
// appID is the filtering engine's identifier for an executable; free it
// with freeMemory.
func appID(path string) (*fwpByteBlob, error) {
p, err := windows.UTF16PtrFromString(path)
if err != nil {
return nil, err
}
var blob *fwpByteBlob
if err := call(procFwpmGetAppIdFromFileName0, uintptr(unsafe.Pointer(p)), uintptr(unsafe.Pointer(&blob))); err != nil {
return nil, err
}
return blob, nil
}
func freeMemory(p unsafe.Pointer) {
_, _, _ = procFwpmFreeMemory0.Call(uintptr(unsafe.Pointer(&p)))
}
// call runs a filtering engine function, which returns a Win32 error code.
func call(proc *windows.LazyProc, args ...uintptr) error {
if err := proc.Find(); err != nil {
return err
}
r, _, _ := proc.Call(args...)
if r != 0 {
return windows.Errno(r)
}
return nil
}
var (
fwpuclnt = windows.NewLazySystemDLL("fwpuclnt.dll")
procFwpmEngineOpen0 = fwpuclnt.NewProc("FwpmEngineOpen0")
procFwpmEngineClose0 = fwpuclnt.NewProc("FwpmEngineClose0")
procFwpmTransactionBegin0 = fwpuclnt.NewProc("FwpmTransactionBegin0")
procFwpmTransactionCommit0 = fwpuclnt.NewProc("FwpmTransactionCommit0")
procFwpmTransactionAbort0 = fwpuclnt.NewProc("FwpmTransactionAbort0")
procFwpmSubLayerAdd0 = fwpuclnt.NewProc("FwpmSubLayerAdd0")
procFwpmFilterAdd0 = fwpuclnt.NewProc("FwpmFilterAdd0")
procFwpmGetAppIdFromFileName0 = fwpuclnt.NewProc("FwpmGetAppIdFromFileName0")
procFwpmFreeMemory0 = fwpuclnt.NewProc("FwpmFreeMemory0")
)
// The filtering engine's types (fwptypes.h, fwpmtypes.h), laid out as in C
// on 64-bit Windows.
type fwpByteBlob struct {
size uint32
data *uint8
}
type fwpmDisplayData0 struct {
name, description *uint16
}
type fwpmSession0 struct {
sessionKey windows.GUID
displayData fwpmDisplayData0
flags uint32
txnWaitTimeoutInMSec uint32
processID uint32
sid *windows.SID
username *uint16
kernelMode int32
}
type fwpmSublayer0 struct {
subLayerKey windows.GUID
displayData fwpmDisplayData0
flags uint32
providerKey *windows.GUID
providerData fwpByteBlob
weight uint16
}
// fwpValue0 is FWP_VALUE0 and FWP_CONDITION_VALUE0: a type and an
// 8-byte union, here a number or a pointer.
type fwpValue0 struct {
typ uint32
value uintptr
}
type fwpmFilterCondition0 struct {
fieldKey windows.GUID
matchType uint32
conditionValue fwpValue0
}
type fwpmAction0 struct {
typ uint32
filterType windows.GUID
}
type fwpmFilter0 struct {
filterKey windows.GUID
displayData fwpmDisplayData0
flags uint32
providerKey *windows.GUID
providerData fwpByteBlob
layerKey windows.GUID
subLayerKey windows.GUID
weight fwpValue0
numFilterConditions uint32
filterCondition *fwpmFilterCondition0
action fwpmAction0
// providerContext is the union of rawContext and providerContextKey,
// 8-byte aligned.
providerContext [2]uint64
reserved *windows.GUID
filterID uint64
effectiveWeight fwpValue0
}
const (
rpcCAuthnWinNT = 10
fwpmSessionFlagDynamic = 0x1
fwpmFilterFlagClearActionRight = 0x8
fwpActionFlagTerminating = 0x1000
fwpActionBlock = 0x1 | fwpActionFlagTerminating
fwpActionPermit = 0x2 | fwpActionFlagTerminating
fwpMatchEqual = 0
fwpMatchFlagsAllSet = 6
fwpUint8 = 1
fwpUint16 = 2
fwpUint32 = 3
fwpByteBlobType = 12
fwpConditionFlagIsLoopback = 0x1
)
var (
fwpmLayerALEAuthConnectV4 = windows.GUID{Data1: 0xc38d57d1, Data2: 0x05a7, Data3: 0x4c33, Data4: [8]byte{0x90, 0x4f, 0x7f, 0xbc, 0xee, 0xe6, 0x0e, 0x82}}
fwpmLayerALEAuthConnectV6 = windows.GUID{Data1: 0x4a72393b, Data2: 0x319f, Data3: 0x44bc, Data4: [8]byte{0x84, 0xc3, 0xba, 0x54, 0xdc, 0xb3, 0xb6, 0xb4}}
fwpmConditionALEAppID = windows.GUID{Data1: 0xd78e1e87, Data2: 0x8644, Data3: 0x4ea5, Data4: [8]byte{0x94, 0x37, 0xd8, 0x09, 0xec, 0xef, 0xc9, 0x71}}
fwpmConditionIPRemotePort = windows.GUID{Data1: 0xc35a604d, Data2: 0xd22b, Data3: 0x4e1a, Data4: [8]byte{0x91, 0xb4, 0x68, 0xf6, 0x74, 0xee, 0x67, 0x4b}}
fwpmConditionLocalInterfaceIndex = windows.GUID{Data1: 0x667fd755, Data2: 0xd695, Data3: 0x434a, Data4: [8]byte{0x8a, 0xf5, 0xd3, 0x83, 0x5a, 0x12, 0x59, 0xbc}}
fwpmConditionFlags = windows.GUID{Data1: 0x632ce23b, Data2: 0x5167, Data3: 0x435c, Data4: [8]byte{0x86, 0xd7, 0xe9, 0x03, 0x68, 0x4a, 0xa8, 0x0c}}
)