/
api.go
304 lines (280 loc) · 11.4 KB
/
api.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
package apikyc
import (
"context"
"encoding/json"
"strings"
cerrors "github.com/cloudtrust/common-service/errors"
"github.com/cloudtrust/common-service/validation"
"github.com/cloudtrust/keycloak-bridge/internal/constants"
"github.com/cloudtrust/keycloak-bridge/internal/dto"
"github.com/cloudtrust/keycloak-bridge/internal/keycloakb"
kc "github.com/cloudtrust/keycloak-client"
)
// ActionRepresentation struct
type ActionRepresentation struct {
Name *string `json:"name"`
Scope *string `json:"scope"`
}
// UserRepresentation contains user details
type UserRepresentation struct {
ID *string `json:"id,omitempty"`
Username *string `json:"username,omitempty"`
Gender *string `json:"gender,omitempty"`
FirstName *string `json:"firstName,omitempty"`
LastName *string `json:"lastName,omitempty"`
Email *string `json:"email,omitempty"`
EmailVerified *bool `json:"emailVerified,omitempty"`
PhoneNumber *string `json:"phoneNumber,omitempty"`
PhoneNumberVerified *bool `json:"phoneNumberVerified,omitempty"`
BirthDate *string `json:"birthDate,omitempty"`
BirthLocation *string `json:"birthLocation,omitempty"`
Nationality *string `json:"nationality,omitempty"`
IDDocumentType *string `json:"idDocumentType,omitempty"`
IDDocumentNumber *string `json:"idDocumentNumber,omitempty"`
IDDocumentExpiration *string `json:"idDocumentExpiration,omitempty"`
IDDocumentCountry *string `json:"idDocumentCountry,omitempty"`
Locale *string `json:"locale,omitempty"`
BusinessID *string `json:"businessId,omitempty"`
Comment *string `json:"comment,omitempty"`
Accreditations *[]AccreditationRepresentation `json:"accreditations,omitempty"`
Attachments *[]AttachmentRepresentation `json:"attachments,omitempty"`
}
// AccreditationRepresentation is a representation of accreditations
type AccreditationRepresentation struct {
Type *string `json:"type"`
ExpiryDate *string `json:"expiryDate"`
Expired *bool `json:"expired,omitempty"`
Revoked *bool `json:"revoked,omitempty"`
}
// AttachmentRepresentation is a representation of an attached file
type AttachmentRepresentation struct {
Filename *string `json:"filename,omitempty"`
ContentType *string `json:"contentType,omitempty"`
Content *[]byte `json:"content,omitempty"`
}
// Parameter references
const (
prmUserGender = "user_gender"
prmUserFirstName = "user_firstName"
prmUserLastName = "user_lastName"
prmUserBirthDate = "user_birthDate"
prmUserBirthLocation = "user_birthLocation"
prmUserNationality = "user_nationality"
prmUserIDDocumentType = "user_idDocType"
prmUserIDDocumentNumber = "user_idDocNumber"
prmUserIDDocumentExpiration = "user_idDocExpiration"
prmUserIDDocumentCountry = "user_idDocCountry"
prmUserLocale = "user_locale"
prmUserBusinessID = "user_businessId"
prmAttachments = "attachments"
prmFilename = "attachmentFilename"
prmContentType = "attachmentContentType"
prmContent = "attachmentContent"
regExpNames = `^([\wàáâäçèéêëìíîïñòóôöùúûüß]+([ '-][\wàáâäçèéêëìíîïñòóôöùúûüß]+)*){1,50}$`
regExpFirstName = regExpNames
regExpLastName = regExpNames
regExpBirthLocation = regExpNames
regExpNationality = constants.RegExpCountryCode
regExpIDDocumentNumber = constants.RegExpIDDocumentNumber
regExpIDDocumentCountry = constants.RegExpCountryCode
regExpGender = constants.RegExpGender
regExpLocale = constants.RegExpLocale
regExpBusinessID = constants.RegExpBusinessID
regExpMimeType = `^[a-z]+/[\w\d\.+]+$`
minAttachmentSize = 100
maxAttachmentSize = 5 * 1024 * 1024
)
var knownContentTypes = map[string]string{
"jpg": "image/jpeg",
"jpeg": "image/jpeg",
"pdf": "application/pdf",
}
// UserFromJSON creates a User using its json representation
func UserFromJSON(jsonRep string) (UserRepresentation, error) {
var user UserRepresentation
dec := json.NewDecoder(strings.NewReader(jsonRep))
dec.DisallowUnknownFields()
err := dec.Decode(&user)
return user, err
}
// UserToJSON returns a json representation of a given User
func (u *UserRepresentation) UserToJSON() string {
var bytes, _ = json.Marshal(u)
return string(bytes)
}
// ExportToDBUser exports user details into a dto.DBUser
func (u *UserRepresentation) ExportToDBUser(dbUser *dto.DBUser) {
dbUser.BirthLocation = u.BirthLocation
dbUser.Nationality = u.Nationality
dbUser.IDDocumentType = u.IDDocumentType
dbUser.IDDocumentNumber = u.IDDocumentNumber
dbUser.IDDocumentExpiration = u.IDDocumentExpiration
dbUser.IDDocumentCountry = u.IDDocumentCountry
}
// ExportToKeycloak exports user details into a Keycloak UserRepresentation
func (u *UserRepresentation) ExportToKeycloak(kcUser *kc.UserRepresentation) {
var bFalse = false
var bTrue = true
var attributes = make(kc.Attributes)
if kcUser.Attributes != nil {
attributes = *kcUser.Attributes
}
attributes.SetStringWhenNotNil(constants.AttrbGender, u.Gender)
if u.PhoneNumber != nil {
if value := attributes.GetString(constants.AttrbPhoneNumber); value == nil || *value != *u.PhoneNumber {
attributes.SetString(constants.AttrbPhoneNumber, *u.PhoneNumber)
attributes.SetBool(constants.AttrbPhoneNumberVerified, false)
}
}
attributes.SetDateWhenNotNil(constants.AttrbBirthDate, u.BirthDate, constants.SupportedDateLayouts)
attributes.SetStringWhenNotNil(constants.Locale, u.Locale)
attributes.SetStringWhenNotNil(constants.AttrbBusinessID, u.BusinessID)
if u.Username != nil {
kcUser.Username = u.Username
}
if u.Email != nil && (kcUser.Email == nil || *kcUser.Email != *u.Email) {
kcUser.Email = u.Email
kcUser.EmailVerified = &bFalse
}
if u.FirstName != nil {
kcUser.FirstName = u.FirstName
}
if u.LastName != nil {
kcUser.LastName = u.LastName
}
kcUser.Attributes = &attributes
kcUser.Enabled = &bTrue
}
// ImportFromKeycloak import details from Keycloak
func (u *UserRepresentation) ImportFromKeycloak(ctx context.Context, kcUser *kc.UserRepresentation, logger keycloakb.Logger) {
var phoneNumber = u.PhoneNumber
var phoneNumberVerified = u.PhoneNumberVerified
var gender = u.Gender
var birthdate = u.BirthDate
var accreditations = u.Accreditations
var locale = u.Locale
var businessID = u.BusinessID
if value := kcUser.GetAttributeString(constants.AttrbPhoneNumber); value != nil {
phoneNumber = value
}
if value, err := kcUser.GetAttributeBool(constants.AttrbPhoneNumberVerified); err == nil && value != nil {
phoneNumberVerified = value
}
if value := kcUser.GetAttributeString(constants.AttrbGender); value != nil {
gender = value
}
if value := kcUser.GetAttributeDate(constants.AttrbBirthDate, constants.SupportedDateLayouts); value != nil {
birthdate = value
}
if values := kcUser.GetAttribute(constants.AttrbAccreditations); len(values) > 0 {
var accreds []AccreditationRepresentation
var bFalse = false
for _, accredJSON := range values {
var accred AccreditationRepresentation
if json.Unmarshal([]byte(accredJSON), &accred) == nil {
accred.Expired = keycloakb.IsDateInThePast(accred.ExpiryDate)
if accred.Revoked == nil {
accred.Revoked = &bFalse
}
accreds = append(accreds, accred)
} else {
logger.Warn(ctx, "msg", "Can't unmarshall JSON", "json", accredJSON)
}
}
accreditations = &accreds
}
if value := kcUser.GetAttributeString(constants.AttrbLocale); value != nil {
locale = value
}
if value := kcUser.GetAttributeString(constants.AttrbBusinessID); value != nil {
businessID = value
}
u.ID = kcUser.ID
u.Username = kcUser.Username
u.Gender = gender
u.FirstName = kcUser.FirstName
u.LastName = kcUser.LastName
u.Email = kcUser.Email
u.EmailVerified = kcUser.EmailVerified
u.PhoneNumber = phoneNumber
u.PhoneNumberVerified = phoneNumberVerified
u.BirthDate = birthdate
u.Accreditations = accreditations
u.Locale = locale
u.BusinessID = businessID
}
// Validate checks the validity of the given User
func (u *UserRepresentation) Validate() error {
return validation.NewParameterValidator().
ValidateParameterRegExp(prmUserGender, u.Gender, regExpGender, true).
ValidateParameterRegExp(prmUserFirstName, u.FirstName, regExpFirstName, true).
ValidateParameterRegExp(prmUserLastName, u.LastName, regExpLastName, true).
ValidateParameterDate(prmUserBirthDate, u.BirthDate, constants.SupportedDateLayouts[0], true).
ValidateParameterRegExp(prmUserBirthLocation, u.BirthLocation, regExpBirthLocation, false).
ValidateParameterRegExp(prmUserNationality, u.Nationality, regExpNationality, false).
ValidateParameterIn(prmUserIDDocumentType, u.IDDocumentType, constants.AllowedDocumentTypes, false).
ValidateParameterRegExp(prmUserIDDocumentNumber, u.IDDocumentNumber, regExpIDDocumentNumber, true).
ValidateParameterDate(prmUserIDDocumentExpiration, u.IDDocumentExpiration, constants.SupportedDateLayouts[0], false).
ValidateParameterRegExp(prmUserIDDocumentCountry, u.IDDocumentCountry, regExpIDDocumentCountry, false).
ValidateParameterRegExp(prmUserLocale, u.Locale, regExpLocale, false).
ValidateParameterRegExp(prmUserBusinessID, u.BusinessID, regExpBusinessID, false).
ValidateParameterFunc(func() error {
var nbAttachments = 0
if u.Attachments != nil {
nbAttachments = len(*u.Attachments)
}
if nbAttachments == 0 {
return nil
}
if nbAttachments != 1 {
return cerrors.CreateBadRequestError(cerrors.MsgErrInvalidParam + "." + prmAttachments)
}
for _, attachment := range *u.Attachments {
if err := attachment.Validate(); err != nil {
return err
}
}
return nil
}).
Status()
}
// Validate an AttachmentRepresentation
func (a *AttachmentRepresentation) Validate() error {
var err = validation.NewParameterValidator().
ValidateParameterRegExp(prmContentType, a.ContentType, regExpMimeType, false).
ValidateParameterNotNil(prmContent, a.Content).
Status()
if err != nil {
return err
}
if a.ContentType == nil {
if a.Filename == nil {
return cerrors.CreateMissingParameterError(prmContentType)
}
a.ContentType = evaluateContentType(*a.Filename)
if a.ContentType == nil {
return cerrors.CreateBadRequestError(cerrors.MsgErrInvalidParam + "." + prmFilename)
}
} else if !isKnownContentType(*a.ContentType) {
return cerrors.CreateBadRequestError(cerrors.MsgErrInvalidParam + "." + prmContentType)
}
if len(*a.Content) < minAttachmentSize || len(*a.Content) > maxAttachmentSize {
return cerrors.CreateBadRequestError(cerrors.MsgErrInvalidParam + "." + prmContent)
}
return nil
}
func evaluateContentType(filename string) *string {
var fileSplits = strings.Split(filename, ".")
if contentType, ok := knownContentTypes[fileSplits[len(fileSplits)-1]]; ok {
return &contentType
}
return nil
}
func isKnownContentType(contentType string) bool {
for _, mimeType := range knownContentTypes {
if mimeType == contentType {
return true
}
}
return false
}