Added callout key.

Author: tyranid

NtApiDotNet/Net/Firewall/FirewallUtils.cs

@@ -147,6 +147,16 @@ public static Guid GetKnownLayerGuid(string name)
             return NamedGuidDictionary.LayerGuids.Value.GuidFromName(name);
         }
 
+        /// <summary>
+        /// Get a known callout GUID from its name.
+        /// </summary>
+        /// <param name="name">The name of the callout.</param>
+        /// <returns>The known callout GUID.</returns>
+        public static Guid GetKnownCalloutGuid(string name)
+        {
+            return NamedGuidDictionary.CalloutGuids.Value.GuidFromName(name);
+        }
+
         /// <summary>
         /// Get a list of known sub-layer names.
         /// </summary>
@@ -156,6 +166,15 @@ public static IEnumerable<string> GetKnownSubLayerNames()
             return NamedGuidDictionary.SubLayerGuids.Value.Values;
         }
 
+        /// <summary>
+        /// Get a list of known callout names.
+        /// </summary>
+        /// <returns>The list of known callout names.</returns>
+        public static IEnumerable<string> GetKnownCalloutNames()
+        {
+            return NamedGuidDictionary.CalloutGuids.Value.Values;
+        }
+
         /// <summary>
         /// Get a list of known sub-layer guids.
         /// </summary>

NtObjectManager/FirewallFunctions.ps1

@@ -22,6 +22,11 @@ $sublayer_completer = {
     [NtApiDotNet.Net.Firewall.FirewallUtils]::GetKnownSubLayerNames() | Where-Object { $_ -like "$wordToComplete*" }
 }
 
+$callout_completer = {
+    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters)
+    [NtApiDotNet.Net.Firewall.FirewallUtils]::GetKnownCalloutNames() | Where-Object { $_ -like "$wordToComplete*" }
+}
+
 $Script:GlobalFwEngine = $null
 
 function Get-FwEngineSingleton {
@@ -1393,7 +1398,7 @@ function Get-FwCallout {
     param(
         [NtApiDotNet.Net.Firewall.FirewallEngine]$Engine,
         [parameter(Mandatory, ParameterSetName="FromKey")]
-        [Guid]$Key
+        [NtObjectManager.Utils.Firewall.FirewallCalloutGuid]$Key
     )
 
     try {
@@ -1404,10 +1409,12 @@ function Get-FwCallout {
                 $Engine.EnumerateCallouts() | Write-Output
             }
             "FromKey" {
-                $Engine.GetCallout($Key)
+                $Engine.GetCallout($Key.Id)
             }
         }
     } catch {
         Write-Error $_
     }
-}
+}
+
+Register-ArgumentCompleter -CommandName Get-FwCallout -ParameterName Key -ScriptBlock $callout_completer

NtObjectManager/NtObjectManager.csproj

@@ -81,6 +81,7 @@
     <Compile Include="Cmdlets\Win32\ClearAuthZSidCmdlet.cs" />
     <Compile Include="Cmdlets\Win32\GetWin32GrantedAccessCmdlet.cs" />
     <Compile Include="Cmdlets\Win32\SetWin32ServiceConfigCmdlet.cs" />
+    <Compile Include="Utils\Firewall\FirewallCalloutGuid.cs" />
     <Compile Include="Utils\Firewall\FirewallLayerGuid.cs" />
     <Compile Include="Utils\Firewall\FirewallObjectGuid.cs" />
     <Compile Include="Utils\Firewall\FirewallPackageSid.cs" />

NtObjectManager/Utils/Firewall/FirewallCalloutGuid.cs

@@ -0,0 +1,33 @@
+//  Copyright 2021 Google LLC. All Rights Reserved.
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+
+using NtApiDotNet.Net.Firewall;
+
+namespace NtObjectManager.Utils.Firewall
+{
+    /// <summary>
+    /// Firewall callout GUID.
+    /// </summary>
+    public sealed class FirewallCalloutGuid : FirewallObjectGuid
+    {
+        /// <summary>
+        /// Constructor.
+        /// </summary>
+        /// <param name="name">Name of the callout or a GUID</param>
+        public FirewallCalloutGuid(string name)
+            : base(name, FirewallUtils.GetKnownCalloutGuid)
+        {
+        }
+    }
+}