Framework/Core/SVT/Services/ServiceBus.ps1

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
#using namespace Microsoft.Azure.Commands.ServiceBus.Models
Set-StrictMode -Version Latest 
class ServiceBus: SVTBase
{       
    hidden [PSObject[]] $NamespacePolicies = @() ;
    hidden [PSObject[]] $Queues = @() ;
    hidden [PSObject[]] $Topics = @() ;
    hidden [HashTable] $QueueAccessPolicies = @{};
    hidden [Hashtable] $TopicAccessPolicies = @{};

    ServiceBus([string] $subscriptionId, [string] $resourceGroupName, [string] $resourceName): 
        Base($subscriptionId, $resourceGroupName, $resourceName) 
    { 
    }

    ServiceBus([string] $subscriptionId, [SVTResource] $svtResource): 
        Base($subscriptionId, $svtResource) 
    { 
        $this.GetServiceBusDetails();
        $this.GetServiceBusAccessPolicies();
    }

    hidden [void] GetServiceBusDetails()
    {
        if (-not $this.NamespacePolicies) {
            try
            {
                $this.NamespacePolicies = (Get-AzServiceBusAuthorizationRule -ResourceGroup $this.ResourceContext.ResourceGroupName `
                            -NamespaceName $this.ResourceContext.ResourceName | Select-Object Id, Name, Rights)
            }
            catch
            {
                # This block is intentionally left blank to handle exception while fetching namespace access policy
            }
            
        }
        
        # Get All Queues
        if (-not $this.Queues) {
            try
            {
                $this.Queues = Get-AzServiceBusQueue -ResourceGroup $this.ResourceContext.ResourceGroupName -NamespaceName $this.ResourceContext.ResourceName
            }
            catch
            {
                # This block is intentionally left blank to handle exception while fetching queue in service bus
            }
            
        }

        # Get All Topics
        if (-not $this.Topics) {
            try
            {
                $this.Topics = Get-AzServiceBusTopic -ResourceGroup $this.ResourceContext.ResourceGroupName -NamespaceName $this.ResourceContext.ResourceName
            }
            catch
            {
                # This block is intentionally left blank to handle exception while fetching topic in service bus
            }
        }
    }

    hidden [void] GetServiceBusAccessPolicies()
    {
        #region "Queue"

        if(($this.Queues|Measure-Object).count -gt 0)
        {
            foreach ($queue in $this.Queues)
            {
                try
                {
                    $queuePolicies = Get-AzServiceBusAuthorizationRule -ResourceGroup $this.ResourceContext.ResourceGroupName `
                                        -NamespaceName $this.ResourceContext.ResourceName -Queue $queue.Name

                    $this.QueueAccessPolicies.Add($queue, ($queuePolicies | Select-Object Id, Name, Rights))    
                }
                catch
                {
                    # This block is intentionally left blank to handle exception while fetching queue access policies
                }
            }
        }
        
        #endregion
        
        #region "Topic"
        
        if(($this.Topics|Measure-Object).count -gt 0)
        {
            foreach ($topic in $this.Topics)
            {
                try
                {
                    $topicPolicies = Get-AzServiceBusAuthorizationRule -ResourceGroup $this.ResourceContext.ResourceGroupName `
                                        -NamespaceName $this.ResourceContext.ResourceName -Topic $topic.Name

                    $this.TopicAccessPolicies.Add($topic, ($topicPolicies| Select-Object Id, Name, Rights))    
                }
                catch
                {
                    # This block is intentionally left blank to handle exception while fetching topic access policies
                }
                
            }
        }

        #endregion
    }

    hidden [ControlResult[]] CheckServiceBusRootPolicy([ControlResult] $controlResult)
    {
        $isControlFailed = $false
        #region "NameSpace"

        if((($this.NamespacePolicies | Measure-Object).count -eq 1) -and (($this.NamespacePolicies.Id.substring($this.NamespacePolicies.Id.Length-25, 25) -eq "RootManageSharedAccessKey"))) {
            $controlResult.AddMessage([VerificationResult]::Passed, [MessageData]::new("Only default authorization rule present for namespace - ["+ $this.ResourceContext.ResourceName +"].", 
            $this.NamespacePolicies)); 
        }
        else {
            $controlResult.AddMessage([VerificationResult]::Failed, [MessageData]::new("Authorization rules for namespace - ["+ $this.ResourceContext.ResourceName +"]. All the authorization rules except 'RootManageSharedAccessKey' must be removed from namespace level. Also validate that 'RootManageSharedAccessKey' authorization rule must not be used at Queue/Topic level to send and receive messages.", 
            $this.NamespacePolicies)); 
        }

        $controlResult.SetStateData("Authorization rules for namespace entities", $this.NamespacePolicies);
        
        #endregion

        return $controlResult;
    }

    hidden [ControlResult[]] CheckServiceBusAuthorizationRule([ControlResult] $controlResult)
    {
        $isControlFailed = $false
        $fullPermissionQueues = @();
        $noPolicyQueues = @();
        $fullPermissionTopics = @();
        $noPolicyTopics = @();
        
        #region "Queue"
        
        if(($this.Queues|Measure-Object).count -gt 0)
        {
            foreach ($queue in $this.Queues)
            {
                if($this.QueueAccessPolicies.ContainsKey($queue) -and ($this.QueueAccessPolicies[$queue] |Measure-Object).count -gt 0)
                {
                    foreach ($policy in $this.QueueAccessPolicies[$queue])
                    {
                        if(($policy.Rights | Measure-Object).count -gt 2)
                        {
                            $fullPermissionQueues += $policy
                            $isControlFailed = $true
                        }
                    }
                }
                else
                {
                    $noPolicyQueues += $queue.Name
                    $isControlFailed = $true
                }
            }
        }
        else
        {
            $controlResult.AddMessage([MessageData]::new("Queue not available in namespace - ["+ $this.ResourceContext.ResourceName +"]"));
        }
        
        #endregion
           
        #region "Topic"
        
        if(($this.Topics|Measure-Object).count -gt 0)
        {
            foreach ($topic in $this.Topics)
            {
                if($this.TopicAccessPolicies.ContainsKey($topic) -and ($this.TopicAccessPolicies[$topic] |Measure-Object).count -gt 0)
                {
                    foreach ($policy in $this.TopicAccessPolicies[$topic])
                    {
                        if(($policy.Rights | Measure-Object).count -gt 2)
                        {
                            $fullPermissionTopics += $policy
                            $isControlFailed = $true
                        }
                    }
                }
                else
                {
                    $noPolicyTopics += $topic.Name
                    $isControlFailed = $true
                }
            }
        }
        else
        {
            $controlResult.AddMessage([MessageData]::new("Topics not available in namespace - ["+ $this.ResourceContext.ResourceName +"]"));
        }

        #endregion

        if($isControlFailed)
        {
            $controlResult.VerificationResult = [VerificationResult]::Failed;

            $faliedClients = New-Object -TypeName PSObject 
            if(($fullPermissionQueues | Measure-Object).count -gt 0)
            {
                $faliedClients | Add-Member -NotePropertyName FailedQueues -NotePropertyValue $fullPermissionQueues
                $controlResult.AddMessage([MessageData]::new("Validate the authorization rules for the Queue are defined with limited permissions.", $fullPermissionQueues));
            }
            if(($noPolicyQueues | Measure-Object).count -gt 0)
            {
                $faliedClients | Add-Member -NotePropertyName FailedQueues -NotePropertyValue $noPolicyQueues
                $controlResult.AddMessage([MessageData]::new("No Authorization rules defined for following Queue. Either Queue is not in use or namespace level access policy is used. Applications (senders/receivers) must not use access policies defined at Service Bus namespace level.", $noPolicyQueues));
            }
            if(($fullPermissionTopics | Measure-Object).count -gt 0)
            {
                $faliedClients | Add-Member -NotePropertyName FailedQueues -NotePropertyValue $fullPermissionTopics
                $controlResult.AddMessage([MessageData]::new("Validate the authorization rules for the Topic are defined with limited permissions.", $fullPermissionTopics));
            }
            if(($noPolicyTopics | Measure-Object).count -gt 0)
            {
                $faliedClients | Add-Member -NotePropertyName FailedQueues -NotePropertyValue $noPolicyTopics
                $controlResult.AddMessage([MessageData]::new("No Authorization rules defined for following Topic. Either Topic is not in use or namespace level access policy is used. Applications (senders/receivers) must not use access policies defined at Service Bus namespace level.", $noPolicyTopics));
            }

            $controlResult.SetStateData("Access policy with minimum required permission must be defined for the Queue/Topic", $faliedClients);
        }
        else
        {
            $controlResult.AddMessage([VerificationResult]::Passed, [MessageData]::new("Authorization rules for the Queue/Topic are defined at correct entity level and with limited permissions."));
        }

        return $controlResult;
    }
}