-
Notifications
You must be signed in to change notification settings - Fork 56
/
update.go
317 lines (295 loc) · 10.3 KB
/
update.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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
//(C) Copyright [2020] Hewlett Packard Enterprise Development LP
//
//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.
// Package role ...
package role
import (
"context"
"encoding/json"
"fmt"
"net/http"
"reflect"
"github.com/ODIM-Project/ODIM/lib-utilities/common"
l "github.com/ODIM-Project/ODIM/lib-utilities/logs"
roleproto "github.com/ODIM-Project/ODIM/lib-utilities/proto/role"
"github.com/ODIM-Project/ODIM/lib-utilities/response"
"github.com/ODIM-Project/ODIM/svc-account-session/asmodel"
"github.com/ODIM-Project/ODIM/svc-account-session/auth"
)
// Update defines the updation of the role details. Every role details can be
// updated other than the roleID if the session parameter have sufficient privileges.
//
// For updating an account, parameters need to be passed are RoleRequest and Session.
// New RoleID,AssignedPrivileges and OEMPrivileges will be part of RoleRequest,
// and Session parameter will have all session related data, especially the privileges.
//
// There will be two return values for the fuction. One is the RPC response, which contains the
// status code, status message, headers and body.
func Update(ctx context.Context, req *roleproto.UpdateRoleRequest, session *asmodel.Session) response.RPC {
var resp response.RPC
var updateReq asmodel.Role
json.Unmarshal(req.UpdateRequest, &updateReq)
errorLogPrefix := fmt.Sprintf("failed to update role %s: ", updateReq.ID)
l.LogWithFields(ctx).Infof("Validating the request to update the role %s", updateReq.ID)
// Validating the request JSON properties for case sensitive
invalidProperties, err := common.RequestParamsCaseValidator(req.UpdateRequest, updateReq)
if err != nil {
errMsg := errorLogPrefix + "Unable to validate request parameters: " + err.Error()
l.LogWithFields(ctx).Error(errMsg)
return common.GeneralError(http.StatusInternalServerError, response.InternalError, errMsg, nil, nil)
} else if invalidProperties != "" {
errorMessage := errorLogPrefix + "One or more properties given in the request body are not valid, ensure properties are listed in uppercamelcase "
l.LogWithFields(ctx).Error(errorMessage)
resp := common.GeneralError(http.StatusBadRequest, response.PropertyUnknown, errorMessage, []interface{}{invalidProperties}, nil)
return resp
}
//Get redfish roles from database
redfishRoles, gerr := asmodel.GetRedfishRoles()
if gerr != nil {
l.LogWithFields(ctx).Error(errorLogPrefix + "Unable to get redfish roles: " + gerr.Error())
errorMessage := errorLogPrefix + gerr.Error()
resp.CreateInternalErrorResponse(errorMessage)
return resp
}
//check if request role is predefined redfish role and set isPredfined to true
isPredefined := false
for _, redfishrole := range redfishRoles.List {
if req.Id == redfishrole {
isPredefined = true
}
}
if isPredefined {
l.LogWithFields(ctx).Error(errorLogPrefix + "Cannot update predefined role")
resp.StatusCode = http.StatusMethodNotAllowed
resp.StatusMessage = response.GeneralError
errorMessage := "Updating predefined role is restricted"
args := response.Args{
Code: response.GeneralError,
Message: errorMessage,
}
resp.Body = args.CreateGenericErrorResponse()
return resp
}
//check for ConfigureUsers privilege in session object
status, err := checkForPrivilege(session, common.PrivilegeConfigureUsers)
if err != nil {
errorMessage := "User does not have the privilege of updating the role"
resp.StatusCode = int32(status.Code)
resp.StatusMessage = status.Message
args := response.Args{
Code: response.GeneralError,
Message: "",
ErrorArgs: []response.ErrArgs{
response.ErrArgs{
StatusMessage: status.Message,
ErrorMessage: errorMessage,
MessageArgs: []interface{}{},
},
},
}
resp.Body = args.CreateGenericErrorResponse()
auth.CustomAuthLog(ctx, session.Token, errorMessage, resp.StatusCode)
return resp
}
role, gerr := asmodel.GetRoleDetailsByID(req.Id)
if gerr != nil {
errorMessage := errorLogPrefix + gerr.Error()
resp.StatusCode = http.StatusBadRequest
resp.StatusMessage = response.ResourceNotFound
args := response.Args{
Code: response.GeneralError,
Message: "",
ErrorArgs: []response.ErrArgs{
response.ErrArgs{
StatusMessage: resp.StatusMessage,
ErrorMessage: errorMessage,
MessageArgs: []interface{}{"Role", req.Id},
},
},
}
resp.Body = args.CreateGenericErrorResponse()
l.LogWithFields(ctx).Error(errorMessage)
return resp
}
// check any duplicate roles present in the request
privelege, duplicatePresent := isDuplicatePrivilegesPresent(updateReq)
if duplicatePresent {
errorMessage := errorLogPrefix + "Duplicate privileges can not be updated"
l.LogWithFields(ctx).Error(errorMessage)
resp.StatusCode = http.StatusBadRequest
resp.StatusMessage = response.PropertyValueConflict
args := response.Args{
Code: response.GeneralError,
Message: errorMessage,
ErrorArgs: []response.ErrArgs{
response.ErrArgs{
StatusMessage: resp.StatusMessage,
ErrorMessage: errorMessage,
MessageArgs: []interface{}{privelege, privelege},
},
},
}
resp.Body = args.CreateGenericErrorResponse()
return resp
}
errorMessage := validateUpdateRequest(&updateReq, &role, map[string]bool{
"AssignedPrivileges": true,
"OEMPrivileges": true,
})
if errorMessage != "" {
l.LogWithFields(ctx).Error(errorLogPrefix + errorMessage)
resp.StatusCode = http.StatusForbidden
resp.StatusMessage = response.InsufficientPrivilege
args := response.Args{
Code: response.GeneralError,
Message: "",
ErrorArgs: []response.ErrArgs{
response.ErrArgs{
StatusMessage: resp.StatusMessage,
ErrorMessage: errorMessage,
MessageArgs: []interface{}{},
},
},
}
resp.Body = args.CreateGenericErrorResponse()
return resp
}
if len(updateReq.AssignedPrivileges) == 0 && len(updateReq.OEMPrivileges) == 0 {
l.LogWithFields(ctx).Error(errorLogPrefix + "Assigned privileges or OEM privileges are empty")
errorMessage := "Assigned privileges or OEM privileges are empty"
resp.StatusCode = http.StatusBadRequest
resp.StatusMessage = response.PropertyMissing
args := response.Args{
Code: response.GeneralError,
Message: "",
ErrorArgs: []response.ErrArgs{
response.ErrArgs{
StatusMessage: resp.StatusMessage,
ErrorMessage: errorMessage,
MessageArgs: []interface{}{"AssignedPrivileges/OemPrivileges"},
},
},
}
resp.Body = args.CreateGenericErrorResponse()
return resp
}
if len(updateReq.AssignedPrivileges) != 0 {
status, messageArgs, err := validateAssignedPrivileges(ctx, updateReq.AssignedPrivileges)
if err != nil {
errorMessage := errorLogPrefix + err.Error()
resp.StatusCode = int32(status.Code)
resp.StatusMessage = status.Message
args := response.Args{
Code: response.GeneralError,
Message: "",
ErrorArgs: []response.ErrArgs{
response.ErrArgs{
StatusMessage: resp.StatusMessage,
ErrorMessage: errorMessage,
MessageArgs: messageArgs,
},
},
}
resp.Body = args.CreateGenericErrorResponse()
l.LogWithFields(ctx).Error(errorMessage)
return resp
}
role.AssignedPrivileges = updateReq.AssignedPrivileges
}
if len(updateReq.OEMPrivileges) != 0 {
status, messageArgs, err := validateOEMPrivileges(ctx, updateReq.OEMPrivileges)
if err != nil {
errorMessage := errorLogPrefix + err.Error()
resp.StatusCode = int32(status.Code)
resp.StatusMessage = status.Message
args := response.Args{
Code: response.GeneralError,
Message: "",
ErrorArgs: []response.ErrArgs{
response.ErrArgs{
StatusMessage: resp.StatusMessage,
ErrorMessage: errorMessage,
MessageArgs: messageArgs,
},
},
}
resp.Body = args.CreateGenericErrorResponse()
l.LogWithFields(ctx).Error(errorMessage)
return resp
}
role.OEMPrivileges = updateReq.OEMPrivileges
}
l.LogWithFields(ctx).Infof("Updating the role %s", updateReq.ID)
if uerr := role.UpdateRoleDetails(); uerr != nil {
errorMessage := errorLogPrefix + uerr.Error()
resp.CreateInternalErrorResponse(errorMessage)
return resp
}
resp.Body = role
resp.StatusCode = http.StatusOK
resp.StatusMessage = response.Success
return resp
}
// validateUpdateRequest validates user update request for role against store data in database
func validateUpdateRequest(req, data *asmodel.Role, exceptFields map[string]bool) string {
val := reflect.ValueOf(data).Elem()
reqFields := reflect.Indirect(reflect.ValueOf(req))
var field = make([]string, 0)
for i := 0; i < val.NumField(); i++ {
typeField := val.Type().Field(i)
if exceptFields[typeField.Name] {
continue
}
datavalue := val.Field(i)
reqValue := reqFields.FieldByName(typeField.Name)
if reqValue.Interface() != "" {
if datavalue.Interface() != reqValue.Interface() {
field = append(field, typeField.Name)
}
}
}
if len(field) <= 0 {
return ""
}
errorMessage := "error: user doesn't have privilege to edit this properties "
for i := 0; i < len(field); i++ {
errorMessage = errorMessage + field[i] + " "
}
return errorMessage
}
func isDuplicatePrivilegesPresent(updateReq asmodel.Role) (string, bool) {
// check assigned priveleges have duplicate privelege
privilege, duplicatePresent := checkDuplicatePrivileges(updateReq.AssignedPrivileges)
if duplicatePresent {
return privilege, true
}
// check OEM priveleges have duplicate privelege
privilege, duplicatePresent = checkDuplicatePrivileges(updateReq.OEMPrivileges)
if duplicatePresent {
return privilege, true
}
return "", false
}
// check if the privileges have duplicate privilege
func checkDuplicatePrivileges(privileges []string) (string, bool) {
duplicate := make(map[string]int)
for _, privilege := range privileges {
// check if the item/privilege exist in the duplicate map
_, exist := duplicate[privilege]
if exist {
return privilege, true
}
duplicate[privilege] = 1
}
return "", false
}