-
Notifications
You must be signed in to change notification settings - Fork 20
/
azure.go
299 lines (256 loc) · 10.1 KB
/
azure.go
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
// Copyright 2021 Fraunhofer AISEC
//
// 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.
//
// $$\ $$\ $$\ $$\
// $$ | $$ |\__| $$ |
// $$$$$$$\ $$ | $$$$$$\ $$\ $$\ $$$$$$$ |$$\ $$$$$$\ $$$$$$\ $$$$$$\
// $$ _____|$$ |$$ __$$\ $$ | $$ |$$ __$$ |$$ |\_$$ _| $$ __$$\ $$ __$$\
// $$ / $$ |$$ / $$ |$$ | $$ |$$ / $$ |$$ | $$ | $$ / $$ |$$ | \__|
// $$ | $$ |$$ | $$ |$$ | $$ |$$ | $$ |$$ | $$ |$$\ $$ | $$ |$$ |
// \$$$$$$\ $$ |\$$$$$ |\$$$$$ |\$$$$$$ |$$ | \$$$ |\$$$$$ |$$ |
// \_______|\__| \______/ \______/ \_______|\__| \____/ \______/ \__|
//
// This file is part of Clouditor Community Edition.
package azure
import (
"context"
"errors"
"fmt"
"strings"
"github.com/Azure/azure-sdk-for-go/sdk/azcore"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/arm"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/policy"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/runtime"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v2"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v3"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/subscription/armsubscription"
"github.com/sirupsen/logrus"
"clouditor.io/clouditor/internal/util"
)
const (
StorageComponent = "storage"
ComputeComponent = "compute"
NetworkComponent = "network"
)
var (
log *logrus.Entry
ErrCouldNotAuthenticate = errors.New("could not authenticate to Azure")
ErrCouldNotGetSubscriptions = errors.New("could not get azure subscription")
ErrNoCredentialsConfigured = errors.New("no credentials were configured")
ErrGettingNextPage = errors.New("error getting next page")
)
type DiscoveryOption func(a *azureDiscovery)
func WithSender(sender policy.Transporter) DiscoveryOption {
return func(a *azureDiscovery) {
a.clientOptions.Transport = sender
}
}
func WithAuthorizer(authorizer azcore.TokenCredential) DiscoveryOption {
return func(a *azureDiscovery) {
a.cred = authorizer
}
}
func WithCloudServiceID(csID string) DiscoveryOption {
return func(a *azureDiscovery) {
a.csID = csID
}
}
// WithResourceGroup is a [DiscoveryOption] that scopes the discovery to a specific resource group.
func WithResourceGroup(rg string) DiscoveryOption {
return func(a *azureDiscovery) {
a.rg = &rg
}
}
func init() {
log = logrus.WithField("component", "azure-discovery")
}
type azureDiscovery struct {
isAuthorized bool
sub armsubscription.Subscription
cred azcore.TokenCredential
// rg optionally contains the name of a resource group. If this is not nil, all discovery calls will be scoped to the particular resource group.
rg *string
clientOptions arm.ClientOptions
discovererComponent string
clients clients
csID string
}
type clients struct {
blobContainerClient *armstorage.BlobContainersClient
fileStorageClient *armstorage.FileSharesClient
accountsClient *armstorage.AccountsClient
networkInterfacesClient *armnetwork.InterfacesClient
loadBalancerClient *armnetwork.LoadBalancersClient
functionsClient *armappservice.WebAppsClient
virtualMachinesClient *armcompute.VirtualMachinesClient
blockStorageClient *armcompute.DisksClient
diskEncSetClient *armcompute.DiskEncryptionSetsClient
}
func (a *azureDiscovery) CloudServiceID() string {
return a.csID
}
func (a *azureDiscovery) authorize() (err error) {
if a.isAuthorized {
return
}
if a.cred == nil {
return ErrNoCredentialsConfigured
}
// Create new subscriptions client
subClient, err := armsubscription.NewSubscriptionsClient(a.cred, &a.clientOptions)
if err != nil {
err = fmt.Errorf("could not get new subscription client: %w", err)
return err
}
// Get subscriptions
subPager := subClient.NewListPager(nil)
subList := make([]*armsubscription.Subscription, 0)
for subPager.More() {
pageResponse, err := subPager.NextPage(context.TODO())
if err != nil {
err = fmt.Errorf("%s: %w", ErrCouldNotGetSubscriptions, err)
log.Error(err)
return err
}
subList = append(subList, pageResponse.ListResult.Value...)
}
// check if list of subscriptions is empty
if len(subList) == 0 {
err = errors.New("list of subscriptions is empty")
return
}
// get first subscription
a.sub = *subList[0]
log.Infof("Azure %s discoverer uses %s as subscription", a.discovererComponent, *a.sub.SubscriptionID)
a.isAuthorized = true
return nil
}
// NewAuthorizer returns the Azure credential using one of the following authentication types (in the following order):
//
// EnvironmentCredential
// ManagedIdentityCredential
// AzureCLICredential
func NewAuthorizer() (*azidentity.DefaultAzureCredential, error) {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Errorf("%s: %+v", ErrCouldNotAuthenticate, err)
return nil, fmt.Errorf("%s: %w", ErrCouldNotAuthenticate, err)
}
return cred, nil
}
func resourceGroupName(id string) string {
return strings.Split(id, "/")[4]
}
// labels converts the resource tags to the vocabulary label
func labels(tags map[string]*string) map[string]string {
l := make(map[string]string)
for tag, i := range tags {
l[tag] = util.Deref(i)
}
return l
}
// ClientCreateFunc is a type that describes a function to create a new Azure SDK client.
type ClientCreateFunc[T any] func(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*T, error)
// initClient creates an Azure client if not already exists
func initClient[T any](existingClient *T, d *azureDiscovery, fun ClientCreateFunc[T]) (client *T, err error) {
if existingClient != nil {
return existingClient, nil
}
client, err = fun(util.Deref(d.sub.SubscriptionID), d.cred, &d.clientOptions)
if err != nil {
err = fmt.Errorf("could not get %T client: %w", new(T), err)
log.Debug(err)
return nil, err
}
return
}
// listPager loops all values from a [runtime.Pager] object from the Azure SDK and issues a callback for each item. It
// takes the following arguments:
// - d, an [azureDiscovery] struct,
// - newListAllPager, a function that supplies a [runtime.Pager] listing all resources of a specific Azure client,
// - newListByResourceGroupPager, a function that supplies a [runtime.Pager] listing all resources of a specific resource group,
// - resToValues1, a function that takes the response from a single page of newListAllPager and returns its values,
// - resToValues2, a function that takes the response from a single page of newListByResourceGroupPager and returns its values,
// - callback, a function that is called for each item in every page.
//
// This function will then decide to use newListAllPager or newListByResourceGroupPager depending on whether a resource
// group scope is set in the [azureDiscovery] object.
//
// This function makes heavy use of the following type constraints (generics):
// - O1, a type that represents an option argument to the newListAllPager function, e.g. *[armcompute.VirtualMachinesClientListAllOptions],
// - R1, a type that represents the return type of the newListAllPager function, e.g. [armcompute.VirtualMachinesClientListAllResponse],
// - O2, a type that represents an option argument to the newListByResourceGroupPager function, e.g. *[armcompute.VirtualMachinesClientListOptions],
// - R1, a type that represents the return type of the newListAllPager function, e.g. [armcompute.VirtualMachinesClientListResponse],
// - T, a type that represents the final resource that is supplied to the callback, e.g. *[armcompute.VirtualMachine].
func listPager[O1 any, R1 any, O2 any, R2 any, T any](
d *azureDiscovery,
newListAllPager func(options O1) *runtime.Pager[R1],
newListByResourceGroupPager func(resourceGroupName string, options O2) *runtime.Pager[R2],
allPagerResponseToValues func(res R1) []*T,
allByResourceGroupPagerResponseToValues func(res R2) []*T,
callback func(disk *T) error,
) error {
// If the resource group is empty, we invoke the all-pager
if d.rg == nil {
pager := newListAllPager(*new(O1))
// Invoke a callback for each page
return allPages(pager, func(page R1) error {
// Retrieve all resources of every page
values := allPagerResponseToValues(page)
for _, resource := range values {
// Invoke the outer callback for each resource
err := callback(resource)
// We abort with the supplied error, if the callback issued an error
if err != nil {
return err
}
}
return nil
})
} else {
// Otherwise, we ivnoke the by-resource-group-pager
pager := newListByResourceGroupPager(*d.rg, *new(O2))
// Invoke a callback for each page
return allPages(pager, func(page R2) error {
// Retrieve all resources of every page
values := allByResourceGroupPagerResponseToValues(page)
for _, resource := range values {
// Invoke the outer callback for each resource
err := callback(resource)
// We abort with the supplied error, if the callback issued an error
if err != nil {
return err
}
}
return nil
})
}
}
// allPages loops through all pages of a [runtime.Pager] and issues a callback to each page.
func allPages[T any](pager *runtime.Pager[T], callback func(page T) error) error {
for pager.More() {
page, err := pager.NextPage(context.TODO())
if err != nil {
return fmt.Errorf("%s: %w", ErrGettingNextPage, err)
}
err = callback(page)
if err != nil {
return err
}
}
return nil
}