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
|
////////////////////////////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2014 Microsoft Corporation. All Rights Reserved.
//
// Module Name:
// Scenarios_FlowAssociation.cpp
//
// Abstract:
// This module contains functions which prepares and sends data for the FLOW_ASSOCIATION
// scenario implementation.
//
// Naming Convention:
//
// <Scope><Object><Action><Modifier>
//
// i.e.
//
// <Scope>
// {
// - Function is likely visible to other modules.
// Prv - Function is private to this module.
// }
// <Object>
// {
// FlowAssociationScenario - Function pertains to Flow Association Scenario.
// }
// <Action>
// {
// Execute - Function packages data and invokes RPC to the
// WFPSampler service
// Log - Function writes to the console.
// Parse - Function pulls data into the required format from the
// provided data.
// }
// <Modifier>
// {
// Help - Function provides context sensitive help for the
// scenario.
// }
//
// Private Functions:
//
// Public Functions:
// FlowAssociationScenarioExecute(),
// FlowAssociationScenarioLogHelp(),
//
// Author:
// Dusty Harper (DHarper)
//
// Revision History:
//
// [ Month ][Day] [Year] - [Revision]-[ Comments ]
// December 13, 2013 - 1.1 - Creation
//
////////////////////////////////////////////////////////////////////////////////////////////////////
#include "Framework_WFPSampler.h" /// .
/**
@private_function="PrvFlowAssociationScenarioParseFlowAsociationData"
Purpose: Parse the command line parameters for implementing flow association such as: <br>
Associate context with the scenario callout for the layer (-aws) <br>
<br>
Notes: <br>
<br>
MSDN_Ref: <br>
*/
_Success_(return == NO_ERROR)
UINT32 PrvFlowAssociationScenarioParseFlowAsociationData(_In_reads_(stringCount) PCWSTR* ppCLPStrings,
_In_ const UINT32 stringCount,
_Inout_ PC_FLOW_ASSOCIATION_DATA* pPCFlowAssociationData)
{
ASSERT(ppCLPStrings);
ASSERT(stringCount);
ASSERT(pPCFlowAssociationData);
UINT32 status = NO_ERROR;
HANDLE engineHandle = 0;
FWPM_CALLOUT* pCallout = 0;
GUID calloutKey = {0};
for(UINT32 stringIndex = 0;
stringIndex < stringCount;
stringIndex++)
{
#pragma warning(push)
#pragma warning(disable: 6385) /// careful validation of stringIndex (and advancement) against stringCount prevents read overrun
if((stringIndex + 1) < stringCount)
{
/// Associate with callout
if(HlprStringsAreEqual(L"-aws",
ppCLPStrings[stringIndex]))
{
PCWSTR pString = ppCLPStrings[++stringIndex];
if(HlprStringsAreEqual(L"BASIC_PACKET_INJECTION",
pString))
calloutKey = WFPSAMPLER_CALLOUT_BASIC_PACKET_INJECTION;
else if(HlprStringsAreEqual(L"BASIC_PACKET_MODIFICATION",
pString))
calloutKey = WFPSAMPLER_CALLOUT_BASIC_PACKET_MODIFICATION;
else if(HlprStringsAreEqual(L"BASIC_STREAM_INJECTION",
pString))
calloutKey = WFPSAMPLER_CALLOUT_BASIC_STREAM_INJECTION;
else if(HlprStringsAreEqual(L"PEND_ENDPOINT_CLOSURE",
pString))
calloutKey = WFPSAMPLER_CALLOUT_PEND_ENDPOINT_CLOSURE;
break;
}
}
#pragma warning(pop)
}
if(HlprGUIDIsNull(&calloutKey))
{
status = (UINT32)FWP_E_INCOMPATIBLE_LAYER;
HlprLogError(L"PrvFlowAssociationScenarioParseFlowAsociationData() [status: %#x]",
status);
HLPR_BAIL;
}
status = HlprFwpmEngineOpen(&engineHandle);
HLPR_BAIL_ON_FAILURE(status);
for(UINT32 stringIndex = 0;
stringIndex < stringCount;
stringIndex++)
{
if((stringIndex + 1) < stringCount)
{
/// Associate with layer
if(HlprStringsAreEqual(L"-awl",
ppCLPStrings[stringIndex]))
{
for(UINT32 index = 0;
index < PCFA_MAX_COUNT;
index++)
{
stringIndex++;
if(stringIndex < stringCount)
{
PCWSTR pString = ppCLPStrings[stringIndex];
UINT8 layerID = HlprFwpmLayerGetIDByString(pString);
if(layerID == FWPS_BUILTIN_LAYER_MAX)
break;
else
{
GUID queryCalloutKey = calloutKey;
#if(NTDDI_VERSION >= NTDDI_WIN7)
if(layerID == FWPS_LAYER_ALE_ENDPOINT_CLOSURE_V4 ||
layerID == FWPS_LAYER_ALE_ENDPOINT_CLOSURE_V6)
queryCalloutKey = WFPSAMPLER_CALLOUT_PEND_ENDPOINT_CLOSURE;
#endif /// (NTDDI_VERSION >= NTDDI_WIN7)
queryCalloutKey.Data4[7] = layerID;
status = FwpmCalloutGetByKey(engineHandle,
&queryCalloutKey,
&pCallout);
if(status != NO_ERROR)
{
if(status == FWP_E_CALLOUT_NOT_FOUND)
HlprLogError(L"Must add scenario filter and callout first");
HlprLogError(L"PrvFlowAssociationScenarioParseFlowAsociationData() [status: %#x]",
status);
HLPR_BAIL;
}
if(pCallout)
{
pPCFlowAssociationData->itemCount++;
pPCFlowAssociationData->pLayerIDs[index] = layerID;
pPCFlowAssociationData->pCalloutIDs[index] = pCallout->calloutId;
FwpmFreeMemory((VOID**)&pCallout);
}
}
}
}
}
}
}
if(pPCFlowAssociationData->itemCount == 0)
{
status = ERROR_INVALID_DATA;
HlprLogError(L"PrvFlowAssociationScenarioParseFlowAsociationData() [status: %#x]",
status);
}
HLPR_BAIL_LABEL:
if(engineHandle)
HlprFwpmEngineClose(&engineHandle);
return status;
}
/**
@scenario_function="FlowAssociationScenarioExecute"
Purpose: Gather and package data neccessary to setup the FLOW_ASSOCIATION scenario,
then invoke RPC to implement the scenario in the WFPSampler service. <br>
<br>
Notes: <br>
<br>
MSDN_Ref: <br>
*/
_Success_(return == NO_ERROR)
UINT32 FlowAssociationScenarioExecute(_In_reads_(stringCount) PCWSTR* ppCLPStrings,
_In_ const UINT32 stringCount)
{
ASSERT(ppCLPStrings);
ASSERT(stringCount);
UINT32 status = NO_ERROR;
BOOLEAN removeScenario = FALSE;
FWPM_FILTER* pFilter = 0;
PC_FLOW_ASSOCIATION_DATA* pPCFlowAssociationData = 0;
status = HlprFwpmFilterCreate(&pFilter);
HLPR_BAIL_ON_FAILURE(status);
pFilter->displayData.name = L"WFPSampler's Flow Association Scenario Filter";
HlprCommandLineParseForScenarioRemoval(ppCLPStrings,
stringCount,
&removeScenario);
status = HlprCommandLineParseForFilterInfo(ppCLPStrings,
stringCount,
pFilter,
removeScenario);
HLPR_BAIL_ON_FAILURE(status);
if(!removeScenario)
{
HLPR_NEW(pPCFlowAssociationData,
PC_FLOW_ASSOCIATION_DATA);
HLPR_BAIL_ON_ALLOC_FAILURE(pPCFlowAssociationData,
status);
status = PrvFlowAssociationScenarioParseFlowAsociationData(ppCLPStrings,
stringCount,
pPCFlowAssociationData);
HLPR_BAIL_ON_FAILURE(status);
}
status = RPCInvokeScenarioFlowAssociation(wfpSamplerBindingHandle,
SCENARIO_FLOW_ASSOCIATION,
removeScenario ? FWPM_CHANGE_DELETE : FWPM_CHANGE_ADD,
pFilter,
pPCFlowAssociationData);
if(status != NO_ERROR)
HlprLogError(L"FlowAssociationScenarioExecute : RPCInvokeScenarioFlowAssociation() [status: %#x]",
status);
else
HlprLogInfo(L"FlowAssociationScenarioExecute : RPCInvokeScenarioFlowAssociation() [status: %#x]",
status);
HLPR_BAIL_LABEL:
if(pFilter)
HlprFwpmFilterDestroy(&pFilter);
HLPR_DELETE(pPCFlowAssociationData);
return status;
}
/**
@public_function="FlowAssociationScenarioLogHelp"
Purpose: Log usage information for the FLOW_ASSOCIATION scenario to the console. <br>
<br>
Notes: <br>
<br>
MSDN_Ref: <br>
*/
VOID FlowAssociationScenarioLogHelp()
{
wprintf(L"\n\t\t -s \t FLOW_ASSOCIATION");
wprintf(L"\n\t\t -? \t Receive usage information.");
wprintf(L"\n\t\t -l \t Specify the flow established layer from which the context will be associated. [Required]");
wprintf(L"\n\t\t -sl \t Specify the sublayer to perform the filtering. [Optional]");
wprintf(L"\n\t\t -r \t Remove the scenario objects.");
wprintf(L"\n\t\t -v \t Make the filter volatile (non-persistent). [Optional]");
wprintf(L"\n\t\t -b \t Makes the objects available during boot time. [Optional]");
wprintf(L"\n\t\t -ipla \t Specify the IP_LOCAL_ADDRESS /");
wprintf(L"\n\t\t \t IP_SOURCE_ADDRESS to filter. [Optional]");
wprintf(L"\n\t\t -ipra \t Specify the IP_REMOTE_ADDRESS /");
wprintf(L"\n\t\t \t IP_DESTINATION_ADDRESS to filter. [Optional]");
wprintf(L"\n\t\t -iplp \t Specify the IP_LOCAL_PORT to filter. [Optional]");
wprintf(L"\n\t\t -iprp \t Specify the IP_REMOTE_PORT to filter. [Optional]");
wprintf(L"\n\t\t -aws \t Specify the SCENARIO to associate the context with. [Required]");
wprintf(L"\n\t\t -awl \t Specify the layers to associate context with. [Required]");
wprintf(L"\n");
wprintf(L"\n\t i.e.");
wprintf(L"\n\t\t WFPSampler.Exe -s FLOW_ASSOCIATION -l FWPM_LAYER_ALE_FLOW_ESTABLISHED_V4 -ipla 1.0.0.1 -ipra 1.0.0.254 -iprp 80 -aws BASIC_STREAM_INJECTION -awl FWPM_LAYER_STREAM_V4 FWPM_LAYER_ALE_ENDPOINT_CLOSURE_V4 -v");
wprintf(L"\n\t\t WFPSampler.Exe -s FLOW_ASSOCIATION -l FWPM_LAYER_ALE_FLOW_ESTABLISHED_V4 -ipla 1.0.0.1 -ipra 1.0.0.254 -iprp 80 -aws BASIC_STREAM_INJECTION -awl FWPM_LAYER_STREAM_V4 FWPM_LAYER_ALE_ENDPOINT_CLOSURE_V4 -v -r");
wprintf(L"\n");
return;
}
|
