/
rights.go
250 lines (208 loc) · 7.95 KB
/
rights.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
/*
* Copyright 2021 VMware, Inc. All rights reserved. Licensed under the Apache v2 License.
*/
package govcd
import (
"fmt"
"net/url"
"strings"
"github.com/vmware/go-vcloud-director/v2/types/v56"
)
// getAllRights retrieves all rights. Query parameters can be supplied to perform additional
// filtering
func getAllRights(client *Client, queryParameters url.Values, additionalHeader map[string]string) ([]*types.Right, error) {
endpoint := types.OpenApiPathVersion1_0_0 + types.OpenApiEndpointRights
minimumApiVersion, err := client.checkOpenApiEndpointCompatibility(endpoint)
if err != nil {
return nil, err
}
urlRef, err := client.OpenApiBuildEndpoint(endpoint)
if err != nil {
return nil, err
}
typeResponses := []*types.Right{{}}
err = client.OpenApiGetAllItems(minimumApiVersion, urlRef, queryParameters, &typeResponses, additionalHeader)
if err != nil {
return nil, err
}
return typeResponses, nil
}
// GetAllRights retrieves all available rights.
// Query parameters can be supplied to perform additional filtering
func (client *Client) GetAllRights(queryParameters url.Values) ([]*types.Right, error) {
return getAllRights(client, queryParameters, nil)
}
// GetAllRights retrieves all available rights. Query parameters can be supplied to perform additional
// filtering
func (adminOrg *AdminOrg) GetAllRights(queryParameters url.Values) ([]*types.Right, error) {
tenantContext, err := adminOrg.getTenantContext()
if err != nil {
return nil, err
}
return getAllRights(adminOrg.client, queryParameters, getTenantContextHeader(tenantContext))
}
// getRights retrieves rights belonging to a given Role or similar container (global role, rights bundle).
// Query parameters can be supplied to perform additional filtering
func getRights(client *Client, roleId, endpoint string, queryParameters url.Values, additionalHeader map[string]string) ([]*types.Right, error) {
minimumApiVersion, err := client.checkOpenApiEndpointCompatibility(endpoint)
if err != nil {
return nil, err
}
urlRef, err := client.OpenApiBuildEndpoint(endpoint + roleId + "/rights")
if err != nil {
return nil, err
}
typeResponses := []*types.Right{{}}
err = client.OpenApiGetAllItems(minimumApiVersion, urlRef, queryParameters, &typeResponses, additionalHeader)
if err != nil {
return nil, err
}
return typeResponses, nil
}
// GetRights retrieves all rights belonging to a given Role. Query parameters can be supplied to perform additional
// filtering
func (role *Role) GetRights(queryParameters url.Values) ([]*types.Right, error) {
endpoint := types.OpenApiPathVersion1_0_0 + types.OpenApiEndpointRoles
return getRights(role.client, role.Role.ID, endpoint, queryParameters, getTenantContextHeader(role.TenantContext))
}
// getRightByName retrieves a right by given name
func getRightByName(client *Client, name string, additionalHeader map[string]string) (*types.Right, error) {
var params = url.Values{}
slowSearch := false
// When the right name contains commas or semicolons, the encoding is rejected by the API.
// For this reason, when one or more commas or semicolons are present (6 occurrences in more than 300 right names)
// we run the search brute force, by fetching all the rights, and comparing the names.
// This problem should be fixed in 10.3
// TODO: revisit this function after 10.3 is released
if strings.Contains(name, ",") || strings.Contains(name, ";") {
slowSearch = true
} else {
params.Set("filter", "name=="+name)
}
rights, err := getAllRights(client, params, additionalHeader)
if err != nil {
return nil, err
}
if len(rights) == 0 {
return nil, ErrorEntityNotFound
}
if slowSearch {
for _, right := range rights {
if right.Name == name {
return right, nil
}
}
return nil, ErrorEntityNotFound
}
if len(rights) > 1 {
return nil, fmt.Errorf("more than one right found with name '%s'", name)
}
return rights[0], nil
}
// GetRightByName retrieves right by given name
func (client *Client) GetRightByName(name string) (*types.Right, error) {
return getRightByName(client, name, nil)
}
// GetRightByName retrieves right by given name
func (adminOrg *AdminOrg) GetRightByName(name string) (*types.Right, error) {
tenantContext, err := adminOrg.getTenantContext()
if err != nil {
return nil, err
}
return getRightByName(adminOrg.client, name, getTenantContextHeader(tenantContext))
}
func getRightById(client *Client, id string, additionalHeader map[string]string) (*types.Right, error) {
endpoint := types.OpenApiPathVersion1_0_0 + types.OpenApiEndpointRights
minimumApiVersion, err := client.checkOpenApiEndpointCompatibility(endpoint)
if err != nil {
return nil, err
}
if id == "" {
return nil, fmt.Errorf("empty role id")
}
urlRef, err := client.OpenApiBuildEndpoint(endpoint, id)
if err != nil {
return nil, err
}
right := &types.Right{}
err = client.OpenApiGetItem(minimumApiVersion, urlRef, nil, right, additionalHeader)
if err != nil {
return nil, err
}
return right, nil
}
func (client *Client) GetRightById(id string) (*types.Right, error) {
return getRightById(client, id, nil)
}
func (adminOrg *AdminOrg) GetRightById(id string) (*types.Right, error) {
tenantContext, err := adminOrg.getTenantContext()
if err != nil {
return nil, err
}
return getRightById(adminOrg.client, id, getTenantContextHeader(tenantContext))
}
// getAllRightsCategories retrieves all rights categories. Query parameters can be supplied to perform additional
// filtering
func getAllRightsCategories(client *Client, queryParameters url.Values, additionalHeader map[string]string) ([]*types.RightsCategory, error) {
endpoint := types.OpenApiPathVersion1_0_0 + types.OpenApiEndpointRightsCategories
minimumApiVersion, err := client.checkOpenApiEndpointCompatibility(endpoint)
if err != nil {
return nil, err
}
urlRef, err := client.OpenApiBuildEndpoint(endpoint)
if err != nil {
return nil, err
}
typeResponses := []*types.RightsCategory{{}}
err = client.OpenApiGetAllItems(minimumApiVersion, urlRef, queryParameters, &typeResponses, additionalHeader)
if err != nil {
return nil, err
}
return typeResponses, nil
}
// GetAllRightsCategories retrieves all rights categories. Query parameters can be supplied to perform additional
// filtering
func (client *Client) GetAllRightsCategories(queryParameters url.Values) ([]*types.RightsCategory, error) {
return getAllRightsCategories(client, queryParameters, nil)
}
// GetAllRightsCategories retrieves all rights categories. Query parameters can be supplied to perform additional
// filtering
func (adminOrg *AdminOrg) GetAllRightsCategories(queryParameters url.Values) ([]*types.RightsCategory, error) {
tenantContext, err := adminOrg.getTenantContext()
if err != nil {
return nil, err
}
return getAllRightsCategories(adminOrg.client, queryParameters, getTenantContextHeader(tenantContext))
}
func getRightCategoryById(client *Client, id string, additionalHeader map[string]string) (*types.RightsCategory, error) {
endpoint := types.OpenApiPathVersion1_0_0 + types.OpenApiEndpointRightsCategories
minimumApiVersion, err := client.checkOpenApiEndpointCompatibility(endpoint)
if err != nil {
return nil, err
}
if id == "" {
return nil, fmt.Errorf("empty category id")
}
urlRef, err := client.OpenApiBuildEndpoint(endpoint, id)
if err != nil {
return nil, err
}
rightsCategory := &types.RightsCategory{}
err = client.OpenApiGetItem(minimumApiVersion, urlRef, nil, rightsCategory, additionalHeader)
if err != nil {
return nil, err
}
return rightsCategory, nil
}
// GetRightsCategoryById retrieves a rights category from its ID
func (adminOrg *AdminOrg) GetRightsCategoryById(id string) (*types.RightsCategory, error) {
tenantContext, err := adminOrg.getTenantContext()
if err != nil {
return nil, err
}
return getRightCategoryById(adminOrg.client, id, getTenantContextHeader(tenantContext))
}
// GetRightsCategoryById retrieves a rights category from its ID
func (client *Client) GetRightsCategoryById(id string) (*types.RightsCategory, error) {
return getRightCategoryById(client, id, nil)
}