summaryrefslogtreecommitdiff
path: root/network/trans/WFPSampler/exe/Scenarios_PendAuthorization.cpp
blob: 055c6acb7669cfbc450c49f07531fb3005f9f56d (plain)
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
////////////////////////////////////////////////////////////////////////////////////////////////////
//
//   Copyright (c) 2014 Microsoft Corporation.  All Rights Reserved.
//
//   Module Name:
//      Scenarios_PendAuthorization.cpp
//
//   Abstract:
//      This module contains functions which prepares and sends data for the PEND_AUTHORIZATION 
//         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>
//          {
//            PendAuthorizationScenario - Function pertains to all of the Pend Authorization
//                                           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>
//          {
//            AuthorizationData         - Function acts on the PC_PEND_AUTHORIZATION_DATA.
//            Help                      - Function provides usage information.
//          }
//
//   Private Functions:
//      PrvPendAuthorizationScenarioParseAuthorizationData(),
//
//   Public Functions:
//      PendAuthorizationScenarioExecute(),
//      PendAuthorizationScenarioLogHelp(),
//
//   Author:
//      Dusty Harper      (DHarper)
//
//   Revision History:
//
//      [ Month ][Day] [Year] - [Revision]-[ Comments ]
//      May       01,   2010  -     1.0   -  Creation
//      December  13,   2013  -     1.1   -  Add support for specifying a different sublayer, change 
//                                              parameter, and limit scenario to only supported 
//                                              layers
//
////////////////////////////////////////////////////////////////////////////////////////////////////

#include "Framework_WFPSampler.h" /// .

/**
 @private_function="PrvPendAuthorizationScenarioParseAuthorizationData"
 
   Purpose:  Parse the command line parameters for pending authorization data such as:          <br>
                delay before callout returns (-d DELAY_IN_MS)                                   <br>
                final action - BLOCK         (-fab)                                             <br>
                final action - PERMIT        (-fap)                                             <br>
                                                                                                <br>
   Notes:    If no final action is specified, the action will default to BLOCK.                 <br>
                                                                                                <br>
   MSDN_Ref:                                                                                    <br>
*/
_Success_(return == NO_ERROR)
UINT32 PrvPendAuthorizationScenarioParseAuthorizationData(_In_reads_(stringCount) PCWSTR* ppCLPStrings,
                                                          _In_ const UINT32 stringCount,
                                                          _Inout_ PC_PEND_AUTHORIZATION_DATA* pPCPendAuthorizationData)
{
   ASSERT(ppCLPStrings);
   ASSERT(stringCount);
   ASSERT(pPCPendAuthorizationData);

   UINT32       status         = NO_ERROR;
   const UINT32 MAX_PARAMETERS = 5;
   UINT32       found          = 0;

   for(UINT32 stringIndex = 0;
       stringIndex < stringCount &&
         found != MAX_PARAMETERS;
       stringIndex++)
   {
      /// Final Action BLOCK
      if(HlprStringsAreEqual(L"-fab",
                             ppCLPStrings[stringIndex]))
      {
         pPCPendAuthorizationData->finalAction = FWP_ACTION_BLOCK;

         found++;

         continue;
      }

      /// Final Action PERMIT
      if(HlprStringsAreEqual(L"-fap",
                             ppCLPStrings[stringIndex]))
      {
         pPCPendAuthorizationData->finalAction = FWP_ACTION_PERMIT;

         found++;

         continue;
      }

      if((stringIndex + 1) < stringCount)
      {
         /// Delay (in MS)
         if(HlprStringsAreEqual(L"-pcd",
                                ppCLPStrings[stringIndex]))
         {
            PCWSTR pString = ppCLPStrings[stringIndex + 1];

            if(iswdigit((wint_t)pString[0]))
            {
               UINT32 delay = wcstol(pString,
                                     0,
                                     0);

               pPCPendAuthorizationData->delay = delay;

               found++;
            }

            continue;
         }
      }

      /// Threaded DPC
      if(HlprStringsAreEqual(L"-tdpc",
                             ppCLPStrings[stringIndex]))
      {
         pPCPendAuthorizationData->useThreadedDPC = TRUE;
      
         found++;
      
         continue;
      }

      /// Work Items
      if(HlprStringsAreEqual(L"-wi",
                             ppCLPStrings[stringIndex]))
      {
         pPCPendAuthorizationData->useWorkItems = TRUE;

         found++;

         continue;
      }
   }

   /// Default Final Action BLOCK
   if(pPCPendAuthorizationData->finalAction == 0)
      pPCPendAuthorizationData->finalAction = FWP_ACTION_BLOCK;

   return status;
}

/**
 @scenario_function="PendAuthorizationScenarioExecute"

   Purpose:  Gather and package data neccessary to setup the PEND_AUTHORIZATION 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 PendAuthorizationScenarioExecute(_In_reads_(stringCount) PCWSTR* ppCLPStrings,
                                        _In_ UINT32 stringCount)
{
   ASSERT(ppCLPStrings);
   ASSERT(stringCount);

   UINT32                      status                   = NO_ERROR;
   BOOLEAN                     removeScenario           = FALSE;
   PC_PEND_AUTHORIZATION_DATA* pPCPendAuthorizationData = 0;
   FWPM_FILTER*                pFilter                  = 0;

   status = HlprFwpmFilterCreate(&pFilter);
   HLPR_BAIL_ON_FAILURE(status);

   pFilter->displayData.name = L"WFPSampler's Pend Authorization Scenario Filter";

   HlprCommandLineParseForScenarioRemoval(ppCLPStrings,
                                          stringCount,
                                          &removeScenario);

   status = HlprCommandLineParseForFilterInfo(ppCLPStrings,
                                              stringCount,
                                              pFilter,
                                              removeScenario);
   HLPR_BAIL_ON_FAILURE(status);

   if(!removeScenario)
   {
      HLPR_NEW(pPCPendAuthorizationData,
               PC_PEND_AUTHORIZATION_DATA);
      HLPR_BAIL_ON_ALLOC_FAILURE(pPCPendAuthorizationData,
                                 status);

      status = PrvPendAuthorizationScenarioParseAuthorizationData(ppCLPStrings,
                                                                  stringCount,
                                                                  pPCPendAuthorizationData);
      HLPR_BAIL_ON_FAILURE(status);
   }

   status = RPCInvokeScenarioPendAuthorization(wfpSamplerBindingHandle,
                                               SCENARIO_PEND_AUTHORIZATION,
                                               removeScenario ? FWPM_CHANGE_DELETE : FWPM_CHANGE_ADD,
                                               pFilter,
                                               pPCPendAuthorizationData);
   if(status != NO_ERROR)
      HlprLogError(L"PendAuthorizationScenarioExecute : RpcInvokeScenarioPendAuthorization() [status: %#x]",
                   status);
   else
      HlprLogInfo(L"PendAuthorizationScenarioExecute : RpcInvokeScenarioPendAuthorization() [status: %#x]",
                  status);

   HLPR_BAIL_LABEL:

   if(pFilter)
      HlprFwpmFilterDestroy(&pFilter);

   HLPR_DELETE(pPCPendAuthorizationData);

   return status;
}

/**
 @public_function="PendAuthorizationScenarioLogHelp"
 
   Purpose:  Log usage information for the PEND_AUTHORIZATION scenario to the console.          <br>
                                                                                                <br>
   Notes:                                                                                       <br>
                                                                                                <br>
   MSDN_Ref:                                                                                    <br>
*/
VOID PendAuthorizationScenarioLogHelp()
{
   wprintf(L"\n\t\t -s     \t PEND_AUTHORIZATION");
   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 -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 -tdpc  \t Use threaded DPCs for out of band. [Optional]");
   wprintf(L"\n\t\t -wi    \t Use work items for out of band. [Optional]");
   wprintf(L"\n\t\t -pcd   \t Introduce a delay (in ms) before the pend is completed. [Optional]");
   wprintf(L"\n\t\t -fab   \t Specify the final action to be block. [Optional][Default]");
   wprintf(L"\n\t\t -fap   \t Specify the final action to be permit. [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]");
   wprintf(L"\n");
   wprintf(L"\n\t i.e.");
   wprintf(L"\n\t\t  WFPSampler.Exe -s PEND_AUTHORIZATION -l FWPM_LAYER_ALE_AUTH_CONNECT_V4 -ipla 1.0.0.1 -ipra 1.0.0.254 -ipp TCP -d 10000 -fap -v");
   wprintf(L"\n\t\t  WFPSampler.Exe -s PEND_AUTHORIZATION -l FWPM_LAYER_ALE_AUTH_CONNECT_V4 -ipla 1.0.0.1 -ipra 1.0.0.254 -ipp TCP -d 10000 -fap -v -r");
   wprintf(L"\n");

   return;
}