Sample Code
Windows Driver Samples/ Windows Filtering Platform Sample/ C++/ lib/ HelperFunctions_FwpmCallout.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 | //////////////////////////////////////////////////////////////////////////////////////////////////////// Copyright (c) 2012 Microsoft Corporation. All Rights Reserved.//// Module Name:// HelperFunctions_FwpmCallout.cpp//// Abstract:// This module contains functions which assist in actions pertaining to FWPM_CALLOUT objects.//// Naming Convention://// <Scope><Module><Object><Action><Modifier>// // i.e.//// <Scope>// {// - Function is likely visible to other modules.// }// <Module>// {// Hlpr - Function is from HelperFunctions_* Modules.// }// <Object>// {// FwpmCallout - Function pertains to FWPM_CALLOUT objects.// }// <Action>// {// Add - Function adds and object to BFE.// Create - Function allocates memory for an object.// Delete - Function deletes an object from BFE.// Destroy - Function frees memory for an object// Enum - Function returns list of requested objects.// Remove - Function deletes objects from BFE.// }// <Modifier>// {// All - Function acts on all FWPM_CALLOUT objects.// ByKey - Function takes a runtime ID.// EnumHandle - Function acts on the enumeration Handle.// }//// Private Functions://// Public Functions:// HlprFwpmCalloutAdd(),// HlprFwpmCalloutCreateEnumHandle(),// HlprFwpmCalloutDeleteByKey(),// HlprFwpmCalloutDestroyEnumHandle(),// HlprFwpmCalloutEnum(),// HlprFwpmCalloutRemoveAll(),//// Author:// Dusty Harper (DHarper)//// Revision History://// [ Month ][Day] [Year] - [Revision]-[ Comments ]// May 01, 2010 - 1.0 - Creation//////////////////////////////////////////////////////////////////////////////////////////////////////#include "HelperFunctions_Include.h" /// ./** @helper_function="HlprFwpmCalloutDeleteByKey" Purpose: Wrapper for the FwpmCalloutDeleteByKey API <br> <br> Notes: <br> <br> MSDN_Ref: HTTP://MSDN.Microsoft.com/En-US/Library/AA364016.aspx <br>*/_Success_(return == NO_ERROR)UINT32 HlprFwpmCalloutDeleteByKey(_In_ const HANDLE engineHandle, _In_ const GUID* pCalloutKey){ UINT32 status = NO_ERROR; if(engineHandle && pCalloutKey) { status = FwpmCalloutDeleteByKey(engineHandle, pCalloutKey); if(status != NO_ERROR) { if(status != FWP_E_IN_USE && status != FWP_E_BUILTIN_OBJECT && status != FWP_E_CALLOUT_NOT_FOUND) HlprLogError(L"HlprFwpmCalloutDeleteByKey : FwpmCalloutDeleteByKey() [status: %#x]", status); else { HlprLogInfo(L"HlprFwpmCalloutDeleteByKey : FwpmCalloutDeleteByKey() [status: %#x]", status); status = NO_ERROR; } } } else { status = ERROR_INVALID_PARAMETER; HlprLogError(L"HlprFwpmCalloutDeleteByKey() [status: %#x][engineHandle: %#p][pCalloutKey: %#p]", status, engineHandle, pCalloutKey); } return status;}/** @helper_function="HlprFwpmCalloutAdd" Purpose: Wrapper for the FwpmCalloutAdd API <br> <br> Notes: Callout ID is written to pCallout->calloutId. <br> <br> MSDN_Ref: HTTP://MSDN.Microsoft.com/En-US/Library/AA364010.aspx <br>*/_Success_(return == NO_ERROR)UINT32 HlprFwpmCalloutAdd(_In_ const HANDLE engineHandle, _Inout_ FWPM_CALLOUT* pCallout){ UINT32 status = NO_ERROR; if(engineHandle && pCallout) { status = FwpmCalloutAdd(engineHandle, pCallout, 0, &(pCallout->calloutId)); if(status != NO_ERROR) { if(status == FWP_E_ALREADY_EXISTS) { HlprLogInfo(L"Callout Already Exists"); status = NO_ERROR; } else HlprLogError(L"HlprFwpmCalloutAdd : FwpmCalloutAdd() [status: %#x]", status); } } else { status = ERROR_INVALID_PARAMETER; HlprLogError(L"HlprFwpmCalloutAdd() [status: %#x][engineHandle: %#p][pCallout: %#p]", status, engineHandle, pCallout); } return status;}/** @helper_function="HlprFwpmCalloutRemoveAll" Purpose: Remove all callouts associated with the specified provider. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/_Success_(return == NO_ERROR)UINT32 HlprFwpmCalloutRemoveAll(_In_opt_ HANDLE* pEngineHandle, _In_ const GUID* pProviderKey){ UINT32 status = NO_ERROR; HANDLE engineHandle = 0; BOOLEAN isLocal = FALSE; if(pEngineHandle && *pEngineHandle) engineHandle = *pEngineHandle; else { status = HlprFwpmEngineOpen(&engineHandle); HLPR_BAIL_ON_FAILURE(status); isLocal = TRUE; } HANDLE enumHandle = 0; FWPM_CALLOUT** ppCallouts = 0; UINT32 calloutCount = 0; FWPM_CALLOUT_ENUM_TEMPLATE enumTemplate; enumTemplate.providerKey = (GUID*)pProviderKey; status = HlprFwpmCalloutCreateEnumHandle(engineHandle, &enumTemplate, &enumHandle); HLPR_BAIL_ON_FAILURE(status); status = HlprFwpmCalloutEnum(engineHandle, enumHandle, 0xFFFFFFFF, &ppCallouts, &calloutCount); if(ppCallouts && calloutCount) { for(UINT32 calloutIndex = 0; calloutIndex < calloutCount; calloutIndex++) { HlprFwpmCalloutDeleteByKey(engineHandle, &(ppCallouts[calloutIndex]->calloutKey)); } FwpmFreeMemory((VOID**)&ppCallouts); } HlprFwpmCalloutDestroyEnumHandle(engineHandle, &enumHandle); HLPR_BAIL_LABEL: if(engineHandle && isLocal) HlprFwpmEngineClose(&engineHandle); return status;}/** @helper_function="HlprFwpmCalloutEnum" Purpose: Wrapper for the FwpmCalloutEnum API <br> <br> Notes: <br> <br> MSDN_Ref: HTTP://MSDN.Microsoft.com/En-US/Library/AA364020.aspx <br>*/_At_(*pppEntries, _Pre_ _Null_)_When_(return != NO_ERROR, _At_(*pppEntries, _Post_ _Null_))_Success_(return == NO_ERROR)UINT32 HlprFwpmCalloutEnum(_In_ const HANDLE engineHandle, _In_ const HANDLE enumHandle, _In_ const UINT32 numEntriesRequested, _Outptr_result_buffer_maybenull_(*pNumEntriesReturned) FWPM_CALLOUT*** pppEntries, _Out_ UINT32* pNumEntriesReturned){ UINT32 status = NO_ERROR; if(engineHandle && enumHandle && numEntriesRequested && pppEntries && pNumEntriesReturned) { status = FwpmCalloutEnum(engineHandle, enumHandle, numEntriesRequested, pppEntries, pNumEntriesReturned); if(status != NO_ERROR && status != FWP_E_CALLOUT_NOT_FOUND && status != FWP_E_NOT_FOUND) HlprLogError(L"HlprFwpmCalloutEnum : FwpmCalloutEnum() [status: %#x]", status); } else { if(pppEntries) *pppEntries = 0; if(pNumEntriesReturned) *pNumEntriesReturned = 0; status = ERROR_INVALID_PARAMETER; HlprLogError(L"HlprFwpmCalloutEnum() [status: %#x][engineHandle: %#p][enumHandle: %#p][numEntriesRequested: %d][pppEntries: %#p][pNumEntriesReturned: %#p]", status, engineHandle, enumHandle, numEntriesRequested, pppEntries, pNumEntriesReturned); } return status;}/** @helper_function="HlprFwpmCalloutDestroyEnumHandle" Purpose: Wrapper for the FwpmCalloutDestroyEnumHandle API <br> <br> Notes: <br> <br> MSDN_Ref: HTTP://MSDN.Microsoft.com/En-US/Library/AA364017.aspx <br>*/_When_(return != NO_ERROR, _At_(*pEnumHandle, _Post_ _Notnull_))_When_(return == NO_ERROR, _At_(*pEnumHandle, _Post_ _Null_))_Success_(return == NO_ERROR)UINT32 HlprFwpmCalloutDestroyEnumHandle(_In_ const HANDLE engineHandle, _Inout_ HANDLE* pEnumHandle){ UINT32 status = NO_ERROR; if(engineHandle && pEnumHandle) { if(*pEnumHandle) { status = FwpmCalloutDestroyEnumHandle(engineHandle, *pEnumHandle); if(status != NO_ERROR) { HlprLogError(L"HlprFwpmCalloutDestroyEnumHandle : FwpmCalloutDestroyEnumHandle() [status: %#x]", status); HLPR_BAIL; } *pEnumHandle = 0; } } else { status = ERROR_INVALID_PARAMETER; HlprLogError(L"HlprFwpmCalloutDestroyEnumHandle() [status: %#x][engineHandle: %#p][pEnumHandle: %#p]", status, engineHandle, pEnumHandle); } HLPR_BAIL_LABEL: return status;}/** @helper_function="HlprFwpmCalloutCreateEnumHandle" Purpose: Wrapper for the FwpmCalloutCreateEnumHandle API <br> <br> Notes: <br> <br> MSDN_Ref: HTTP://MSDN.Microsoft.com/En-US/Library/AA364012.aspx <br>*/_When_(return != NO_ERROR, _At_(*pEnumHandle, _Post_ _Null_))_When_(return == NO_ERROR, _At_(*pEnumHandle, _Post_ _Notnull_))_Success_(return == NO_ERROR)UINT32 HlprFwpmCalloutCreateEnumHandle(_In_ const HANDLE engineHandle, _In_opt_ const FWPM_CALLOUT_ENUM_TEMPLATE* pEnumTemplate, _Out_ HANDLE* pEnumHandle){ UINT32 status = NO_ERROR; if(engineHandle && pEnumHandle) { status = FwpmCalloutCreateEnumHandle(engineHandle, pEnumTemplate, pEnumHandle); if(status != NO_ERROR) { *pEnumHandle = 0; HlprLogError(L"HlprFwpmCalloutCreateEnumHandle : FwpmCalloutCreateEnumHandle() [status: %#x]", status); } } else { status = ERROR_INVALID_PARAMETER; HlprLogError(L"HlprFwpmCalloutCreateEnumHandle() [status: %#x][engineHandle: %#p][pEnumHandle: %#p]", status, engineHandle, pEnumHandle); } return status;} |
Our Services
-
What our customers say about us?
Read our customer testimonials to find out why our clients keep returning for their projects.
View Testimonials
