Sample Code

Windows Driver Samples/ Windows Filtering Platform Sample/ C++/ exe/ Scenarios_BasicAction.cpp/

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
////////////////////////////////////////////////////////////////////////////////////////////////////
//
//   Copyright (c) 2012 Microsoft Corporation.  All Rights Reserved.
//
//   Module Name:
//      Scenarios_BasicAction.cpp
//
//   Abstract:
//      This module contains functions which prepares and sends data for the BASIC_ACTION_* 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>
//          {
//            BasicActionBlockScenario    - Function pertains to the Basic Action Block Scenario.
//            BasicActionContinueScenario - Function pertains to the Basic Action Continue Scenario.
//            BasicActionPermitScenario   - Function pertains to the Basic Action Permit Scenario.
//            BasicActionRandomScenario   - Function pertains to the Basic Action Random Scenario.
//            BasicActionScenario         - Function pertains to all of the Basic Action Scenarios.
//          }
//       <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.
//            RandomizedData              - Function acts on the PC_BASIC_ACTION_DATA.
//          }
//
//   Private Functions:
//      PrvBasicActionScenarioParseRandomizedData(),
//
//   Public Functions:
//      BasicActionBlockScenarioExecute(),
//      BasicActionContinueScenarioExecute(),
//      BasicActionPermitScenarioExecute(),
//      BasicActionRandomScenarioExecute(),
//      BasicActionScenarioLogHelp(),
//
//   Author:
//      Dusty Harper      (DHarper)
//
//   Revision History:
//
//      [ Month ][Day] [Year] - [Revision]-[ Comments ]
//      May       01,   2010  -     1.0   -  Creation
//
////////////////////////////////////////////////////////////////////////////////////////////////////
 
#include "Framework_WFPSampler.h" /// .
 
/**
 @private_function="PrvBasicActionScenarioParseRandomizedData"
  
   Purpose:  Parse the command line parameters for implementing randomization such as:          <br>
                Random chance of returning block        (-rab PERCENTAGE)                       <br>
                Random chance of returning continue     (-rac PERCENTAGE)                       <br>
                Random chance of returning permit       (-rap PERCENTAGE)                       <br>
                                                                                                <br>
   Notes:    This is only used if using SCENARIO_BASIC_ACTION_RANDOM.                           <br>
                                                                                                <br>
   MSDN_Ref:                                                                                    <br>
*/
_Success_(return == NO_ERROR)
UINT32 PrvBasicActionScenarioParseRandomizedData(_In_reads_(stringCount) PCWSTR* ppCLPStrings,
                                                 _In_ const UINT32 stringCount,
                                                 _Inout_ PC_BASIC_ACTION_DATA* pPCBasicActionData)
{
   ASSERT(ppCLPStrings);
   ASSERT(stringCount);
   ASSERT(pPCBasicActionData);
 
   UINT32 status = NO_ERROR;
 
   for(UINT32 stringIndex = 0;
       (stringIndex + 1) < stringCount;
       stringIndex++)
   {
      const UINT32 WHOLE_PERCENTAGE = 100;
 
      /// Random FWP_ACTION_BLOCK
      if(HlprStringsAreEqual(L"-rab",
                             ppCLPStrings[stringIndex]))
      {
         PCWSTR pString = ppCLPStrings[stringIndex + 1];
 
         if(iswdigit((wint_t)pString[0]))
         {
            UINT32 percentBlock = wcstol(pString,
                                         0,
                                         0);
            if(percentBlock <= WHOLE_PERCENTAGE)
               pPCBasicActionData->percentBlock = percentBlock & 0xFF;
         }
 
         continue;
      }
 
      /// Random FWP_ACTION_CONTINUE
      if(HlprStringsAreEqual(L"-rac",
                             ppCLPStrings[stringIndex]))
      {
         PCWSTR pString = ppCLPStrings[stringIndex + 1];
 
         if(iswdigit((wint_t)pString[0]))
         {
            UINT32 percentContinue = wcstol(pString,
                                            0,
                                            0);
            if(percentContinue <= WHOLE_PERCENTAGE)
               pPCBasicActionData->percentContinue = percentContinue & 0xFF;
         }
 
         continue;
      }
 
      /// FWP_ACTION_PERMIT
      if(HlprStringsAreEqual(L"-rap",
                             ppCLPStrings[stringIndex]))
      {
         PCWSTR pString = ppCLPStrings[stringIndex + 1];
 
         if(iswdigit((wint_t)pString[0]))
         {
            UINT32 percentPermit = wcstol(pString,
                                          0,
                                          0);
            if(percentPermit <= WHOLE_PERCENTAGE)
               pPCBasicActionData->percentPermit = percentPermit & 0xFF;
         }
 
         continue;
      }
 
      if(pPCBasicActionData->percentBlock &&
         pPCBasicActionData->percentContinue &&
         pPCBasicActionData->percentPermit)
         break;
   }
 
   /// Set the chance of each action for Randomization
   if(pPCBasicActionData->percentBlock == 0 &&
      pPCBasicActionData->percentContinue == 0 &&
      pPCBasicActionData->percentPermit == 0)
   {
      pPCBasicActionData->percentBlock    = 50;
      pPCBasicActionData->percentContinue = 25;
      pPCBasicActionData->percentPermit   = 25;
   }
   else
   {
      if(pPCBasicActionData->percentBlock == 0)
         pPCBasicActionData->percentBlock = 100 - (pPCBasicActionData->percentContinue + pPCBasicActionData->percentPermit);
 
      if(pPCBasicActionData->percentContinue == 0)
         pPCBasicActionData->percentContinue = 100 - (pPCBasicActionData->percentBlock + pPCBasicActionData->percentPermit);
 
      if(pPCBasicActionData->percentPermit == 0)
         pPCBasicActionData->percentPermit = 100 - (pPCBasicActionData->percentBlock + pPCBasicActionData->percentContinue);
   }
 
   if((pPCBasicActionData->percentBlock +
      pPCBasicActionData->percentContinue +
      pPCBasicActionData->percentPermit) > 100)
   {
      pPCBasicActionData->percentBlock    = 50;
      pPCBasicActionData->percentContinue = 25;
      pPCBasicActionData->percentPermit   = 25;
   }
 
   return status;
}
 
/**
 @scenario_function="BasicActionBlockScenarioExecute"
 
   Purpose:  Gather and package data neccessary to setup the BASIC_ACTION_BLOCK 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 BasicActionBlockScenarioExecute(_In_reads_(stringCount) PCWSTR* ppCLPStrings,
                                       _In_ UINT32 stringCount)
{
   ASSERT(ppCLPStrings);
   ASSERT(stringCount);
 
   UINT32       status         = NO_ERROR;
   BOOLEAN      removeScenario = FALSE;
   FWPM_FILTER* pFilter        = 0;
 
   status = HlprFwpmFilterCreate(&pFilter);
   HLPR_BAIL_ON_FAILURE(status);
 
   pFilter->displayData.name = L"WFPSampler's Basic Action Block Scenario Filter";
 
   HlprCommandLineParseForScenarioRemoval(ppCLPStrings,
                                          stringCount,
                                          &removeScenario);
 
   status = HlprCommandLineParseForFilterInfo(ppCLPStrings,
                                              stringCount,
                                              pFilter,
                                              removeScenario);
   HLPR_BAIL_ON_FAILURE(status);
 
   status = RPCInvokeScenarioBasicAction(wfpSamplerBindingHandle,
                                         SCENARIO_BASIC_ACTION_BLOCK,
                                         removeScenario ? FWPM_CHANGE_DELETE : FWPM_CHANGE_ADD,
                                         pFilter,
                                         0);
   if(status != NO_ERROR)
      HlprLogError(L"BasicActionBlockScenarioExecute : RpcInvokeScenarioBasicAction() [status: %#x]",
                   status);
   else
      HlprLogInfo(L"BasicActionBlockScenarioExecute : RpcInvokeScenarioBasicAction() [status: %#x]",
                  status);
 
   HLPR_BAIL_LABEL:
 
   return status;
}
 
/**
 @scenario_function="BasicActionContinueScenarioExecute"
 
   Purpose:  Gather and package data neccessary to setup the BASIC_ACTION_CONTINUE 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 BasicActionContinueScenarioExecute(_In_reads_(stringCount) PCWSTR* ppCLPStrings,
                                          _In_ UINT32 stringCount)
{
   ASSERT(ppCLPStrings);
   ASSERT(stringCount);
 
   UINT32       status         = NO_ERROR;
   BOOLEAN      removeScenario = FALSE;
   FWPM_FILTER* pFilter        = 0;
 
   status = HlprFwpmFilterCreate(&pFilter);
   HLPR_BAIL_ON_FAILURE(status);
 
   pFilter->displayData.name = L"WFPSampler's Basic Action Continue Scenario Filter";
 
   HlprCommandLineParseForScenarioRemoval(ppCLPStrings,
                                          stringCount,
                                          &removeScenario);
 
   status = HlprCommandLineParseForFilterInfo(ppCLPStrings,
                                              stringCount,
                                              pFilter,
                                              removeScenario);
   HLPR_BAIL_ON_FAILURE(status);
 
   status = RPCInvokeScenarioBasicAction(wfpSamplerBindingHandle,
                                         SCENARIO_BASIC_ACTION_CONTINUE,
                                         removeScenario ? FWPM_CHANGE_DELETE : FWPM_CHANGE_ADD,
                                         pFilter,
                                         0);
   if(status != NO_ERROR)
      HlprLogError(L"BasicActionContinueScenarioExecute : RpcInvokeScenarioBasicAction() [status: %#x]",
                   status);
   else
      HlprLogInfo(L"BasicActionContinueScenarioExecute : RpcInvokeScenarioBasicAction() [status: %#x]",
                  status);
 
   HLPR_BAIL_LABEL:
 
   if(pFilter)
      HlprFwpmFilterDestroy(&pFilter);
 
   return status;
}
 
/**
 @scenario_function="BasicActionPermitScenarioExecute"
 
   Purpose:  Gather and package data neccessary to setup the BASIC_ACTION_PERMIT 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 BasicActionPermitScenarioExecute(_In_reads_(stringCount) PCWSTR* ppCLPStrings,
                                        _In_ UINT32 stringCount)
{
   ASSERT(ppCLPStrings);
   ASSERT(stringCount);
 
   UINT32       status         = NO_ERROR;
   BOOLEAN      removeScenario = FALSE;
   FWPM_FILTER* pFilter        = 0;
 
   status = HlprFwpmFilterCreate(&pFilter);
   HLPR_BAIL_ON_FAILURE(status);
 
   pFilter->displayData.name = L"WFPSampler's Basic Action Permit Scenario Filter";
 
   HlprCommandLineParseForScenarioRemoval(ppCLPStrings,
                                          stringCount,
                                          &removeScenario);
 
   status = HlprCommandLineParseForFilterInfo(ppCLPStrings,
                                              stringCount,
                                              pFilter,
                                              removeScenario);
   HLPR_BAIL_ON_FAILURE(status);
 
   status = RPCInvokeScenarioBasicAction(wfpSamplerBindingHandle,
                                         SCENARIO_BASIC_ACTION_PERMIT,
                                         removeScenario ? FWPM_CHANGE_DELETE : FWPM_CHANGE_ADD,
                                         pFilter,
                                         0);
   if(status != NO_ERROR)
      HlprLogError(L"BasicActionPermitScenarioExecute : RpcInvokeScenarioBasicAction() [status: %#x]",
                   status);
   else
      HlprLogInfo(L"BasicActionPermitScenarioExecute : RpcInvokeScenarioBasicAction() [status: %#x]",
                  status);
 
   HLPR_BAIL_LABEL:
 
   if(pFilter)
      HlprFwpmFilterDestroy(&pFilter);
 
   return status;
}
 
/**
 @scenario_function="BasicActionRandomScenarioExecute"
 
   Purpose:  Gather and package data neccessary to setup the BASIC_ACTION_RANDOM 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 BasicActionRandomScenarioExecute(_In_reads_(stringCount) PCWSTR* ppCLPStrings,
                                        _In_ UINT32 stringCount)
{
   UINT32                status             = NO_ERROR;
   BOOLEAN               removeScenario     = FALSE;
   PC_BASIC_ACTION_DATA* pPCBasicActionData = 0;
   FWPM_FILTER*          pFilter            = 0;
 
   status = HlprFwpmFilterCreate(&pFilter);
   HLPR_BAIL_ON_FAILURE(status);
 
   pFilter->displayData.name = L"WFPSampler's Basic Action Random Scenario Filter";
 
   HlprCommandLineParseForScenarioRemoval(ppCLPStrings,
                                          stringCount,
                                          &removeScenario);
 
   status = HlprCommandLineParseForFilterInfo(ppCLPStrings,
                                              stringCount,
                                              pFilter,
                                              removeScenario);
   HLPR_BAIL_ON_FAILURE(status);
 
   if(!removeScenario)
   {
      HLPR_NEW(pPCBasicActionData,
               PC_BASIC_ACTION_DATA);
      HLPR_BAIL_ON_ALLOC_FAILURE(pPCBasicActionData,
                                 status);
 
      status = PrvBasicActionScenarioParseRandomizedData(ppCLPStrings,
                                                         stringCount,
                                                         pPCBasicActionData);
      HLPR_BAIL_ON_FAILURE(status);
   }
 
   status = RPCInvokeScenarioBasicAction(wfpSamplerBindingHandle,
                                         SCENARIO_BASIC_ACTION_RANDOM,
                                         removeScenario ? FWPM_CHANGE_DELETE : FWPM_CHANGE_ADD,
                                         pFilter,
                                         pPCBasicActionData);
   if(status != NO_ERROR)
      HlprLogError(L"BasicActionRandomScenarioExecute : RpcInvokeScenarioBasicAction() [status: %#x]",
                   status);
   else
      HlprLogInfo(L"BasicActionRandomScenarioExecute : RpcInvokeScenarioBasicAction() [status: %#x]",
                  status);
 
   HLPR_BAIL_LABEL:
 
   if(pFilter)
      HlprFwpmFilterDestroy(&pFilter);
 
   HLPR_DELETE(pPCBasicActionData);
 
   return status;
}
 
/**
 @public_function="BasicActionScenarioLogHelp"
  
   Purpose:  Log usage information for the BASIC_ACTION* scenarios to the console.              <br>
                                                                                                <br>
   Notes:                                                                                       <br>
                                                                                                <br>
   MSDN_Ref:                                                                                    <br>
*/
VOID BasicActionScenarioLogHelp(_In_ const UINT32 scenario)
{
   PWSTR pScenario   = L"BASIC_ACTION_BLOCK";
   PWSTR pRandomInfo = L" ";
 
   if(scenario == SCENARIO_BASIC_ACTION_CONTINUE)
      pScenario = L"BASIC_ACTION_CONTINUE";
   else if(scenario == SCENARIO_BASIC_ACTION_PERMIT)
      pScenario = L"BASIC_ACTION_PERMIT";
   else if(scenario == SCENARIO_BASIC_ACTION_RANDOM)
      pScenario = L"BASIC_ACTION_RANDOM";
 
   wprintf(L"\n\t\t -s     \t %s",
           pScenario);
   wprintf(L"\n\t\t -?     \t Receive usage information.");
   wprintf(L"\n\t\t -l     \t Specify the layer to perform the filtering. [Required]");
   wprintf(L"\n\t\t -r     \t Remove the scenario objects.");
   wprintf(L"\n\t\t -c     \t Use a callout to perform the action. [Optional]");
   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 -ipp   \t Specify the IP_PROTOCOL to filter. [Optional]");
   wprintf(L"\n\t\t -iplp  \t Specify the IP_LOCAL_PORT to filter. [Optional]");
   wprintf(L"\n\t\t -icmpt \t Specify the ICMP_TYPE to filter. [Optional]");
   wprintf(L"\n\t\t -iprp  \t Specify the IP_REMOTE_PORT to filter. [Optional]");
   wprintf(L"\n\t\t -icmpc \t Specify the ICMP_CODE to filter. [Optional]");
 
   if(scenario == SCENARIO_BASIC_ACTION_RANDOM)
   {
      pRandomInfo = L"-rab 50 -rac 25 -rap 25 ";
 
      wprintf(L"\n\t\t -rab   \t Percentage chance of returning FWP_ACTION_BLOCK. [Optional]");
      wprintf(L"\n\t\t -rac   \t Percentage chance of returning FWP_ACTION_CONTINUE. [Optional]");
      wprintf(L"\n\t\t -rap   \t Percentage chance of returning FWP_ACTION_PERMIT. [Optional]");
   }
 
   wprintf(L"\n");
   wprintf(L"\n\t i.e.");
   wprintf(L"\n\t\t WFPSampler.Exe -s %s -l FWPM_LAYER_INBOUND_TRANSPORT_V4 -ipla 1.0.0.1 -ipra 1.0.0.254 -ipp TCP -c %s",
           pScenario,
           pRandomInfo);
   wprintf(L"\n\t\t WFPSampler.Exe -s %s -l FWPM_LAYER_INBOUND_TRANSPORT_V4 -ipla 1.0.0.1 -ipra 1.0.0.254 -ipp TCP -c %s-r",
           pScenario,
           pRandomInfo);
   wprintf(L"\n");
 
   return;
}

Our Services

  • What our customers say about us?

© 2011-2025 All Rights Reserved. Joya Systems. 4425 South Mopac Building II Suite 101 Austin, TX 78735 Tel: 800-DEV-KERNEL

Privacy Policy. Terms of use. Valid XHTML & CSS