OIDC: add support for account claim maps (#1186)

This commit is contained in:
Jim authored and GitHub committed 2021-05-04 08:41:04 -04:00
1 parent 4ae5003763
commit 2437cdcc8d
28 files changed
+1456 -200

No files matched your search

@@ -32,6 +32,7 @@ const (
AudClaimsField = "AudClaims"
CertificatesField = "Certificates"
ClaimsScopesField = "ClaimsScopes"
AccountClaimMapsField = "AccountClaimMaps"
)
// UpdateAuthMethod will retrieve the auth method from the repository,
@@ -89,17 +90,18 @@ func (r *Repository) UpdateAuthMethod(ctx context.Context, am *AuthMethod, versi
dbMask, nullFields := dbcommon.BuildUpdatePaths(
map[string]interface{}{
NameField: am.Name,
DescriptionField: am.Description,
IssuerField: am.Issuer,
ClientIdField: am.ClientId,
ClientSecretField: am.ClientSecret,
MaxAgeField: am.MaxAge,
SigningAlgsField: am.SigningAlgs,
ApiUrlField: am.ApiUrl,
AudClaimsField: am.AudClaims,
CertificatesField: am.Certificates,
ClaimsScopesField: am.ClaimsScopes,
NameField: am.Name,
DescriptionField: am.Description,
IssuerField: am.Issuer,
ClientIdField: am.ClientId,
ClientSecretField: am.ClientSecret,
MaxAgeField: am.MaxAge,
SigningAlgsField: am.SigningAlgs,
ApiUrlField: am.ApiUrl,
AudClaimsField: am.AudClaims,
CertificatesField: am.Certificates,
ClaimsScopesField: am.ClaimsScopes,
AccountClaimMapsField: am.AccountClaimMaps,
},
fieldMaskPaths,
nil,
@@ -164,10 +166,30 @@ func (r *Repository) UpdateAuthMethod(ctx context.Context, am *AuthMethod, versi
return nil, db.NoRowsAffected, errors.Wrap(err, op)
}
addMaps, deleteMaps, err := valueObjectChanges(origAm.PublicId, AccountClaimMapsVO, am.AccountClaimMaps, origAm.AccountClaimMaps, dbMask, nullFields)
if err != nil {
return nil, db.NoRowsAffected, errors.Wrap(err, op)
}
// we don't allow updates for "sub" claim maps, because we have no way to
// determine if the updated "from" claim in the map might create collisions
// with any existing account's subject.
for _, rawCm := range addMaps {
cm := rawCm.(*AccountClaimMap)
if cm.ToClaim == string(ToSubClaim) {
return nil, db.NoRowsAffected, errors.New(errors.InvalidParameter, op, fmt.Sprintf("you cannot update account claim map %s=%s for the \"sub\" claim", cm.FromClaim, cm.ToClaim))
}
}
for _, rawCm := range deleteMaps {
cm := rawCm.(*AccountClaimMap)
if cm.ToClaim == string(ToSubClaim) {
return nil, db.NoRowsAffected, errors.New(errors.InvalidParameter, op, fmt.Sprintf("you cannot update account claim map %s=%s for the \"sub\" claim", cm.FromClaim, cm.ToClaim))
}
}
var filteredDbMask, filteredNullFields []string
for _, f := range dbMask {
switch f {
case SigningAlgsField, AudClaimsField, CertificatesField, ClaimsScopesField:
case SigningAlgsField, AudClaimsField, CertificatesField, ClaimsScopesField, AccountClaimMapsField:
continue
default:
filteredDbMask = append(filteredDbMask, f)
@@ -175,7 +197,7 @@ func (r *Repository) UpdateAuthMethod(ctx context.Context, am *AuthMethod, versi
}
for _, f := range nullFields {
switch f {
case SigningAlgsField, AudClaimsField, CertificatesField, ClaimsScopesField:
case SigningAlgsField, AudClaimsField, CertificatesField, ClaimsScopesField, AccountClaimMapsField:
continue
default:
filteredNullFields = append(filteredNullFields, f)
@@ -192,7 +214,9 @@ func (r *Repository) UpdateAuthMethod(ctx context.Context, am *AuthMethod, versi
len(addAuds) == 0 &&
len(deleteAuds) == 0 &&
len(addScopes) == 0 &&
len(deleteScopes) == 0 {
len(deleteScopes) == 0 &&
len(addMaps) == 0 &&
len(deleteMaps) == 0 {
return origAm, db.NoRowsAffected, nil
}
@@ -336,6 +360,25 @@ func (r *Repository) UpdateAuthMethod(ctx context.Context, am *AuthMethod, versi
msgs = append(msgs, addScopesOplogMsgs...)
}
if len(deleteMaps) > 0 {
deleteMapsOplogMsgs := make([]*oplog.Message, 0, len(deleteMaps))
rowsDeleted, err := w.DeleteItems(ctx, deleteMaps, db.NewOplogMsgs(&deleteMapsOplogMsgs))
if err != nil {
return errors.Wrap(err, op, errors.WithMsg("unable to delete account claim maps"))
}
if rowsDeleted != len(deleteMaps) {
return errors.New(errors.MultipleRecords, op, fmt.Sprintf("account claim maps deleted %d did not match request for %d", rowsDeleted, len(deleteMaps)))
}
msgs = append(msgs, deleteMapsOplogMsgs...)
}
if len(addMaps) > 0 {
addMapsOplogMsgs := make([]*oplog.Message, 0, len(addMaps))
if err := w.CreateItems(ctx, addMaps, db.NewOplogMsgs(&addMapsOplogMsgs)); err != nil {
return errors.Wrap(err, op, errors.WithMsg("unable to add account claim maps"))
}
msgs = append(msgs, addMapsOplogMsgs...)
}
metadata := updatedAm.oplog(oplog.OpType_OP_TYPE_UPDATE)
if err := w.WriteOplogEntryWith(ctx, oplogWrapper, ticket, metadata, msgs); err != nil {
return errors.Wrap(err, op, errors.WithMsg("unable to write oplog"))
@@ -371,16 +414,17 @@ func (r *Repository) UpdateAuthMethod(ctx context.Context, am *AuthMethod, versi
type voName string
const (
SigningAlgVO voName = "SigningAlgs"
CertificateVO voName = "Certificates"
AudClaimVO voName = "AudClaims"
ClaimsScopesVO voName = "ClaimsScopes"
SigningAlgVO voName = "SigningAlgs"
CertificateVO voName = "Certificates"
AudClaimVO voName = "AudClaims"
ClaimsScopesVO voName = "ClaimsScopes"
AccountClaimMapsVO voName = "AccountClaimMaps"
)
// validVoName decides if the name is valid
func validVoName(name voName) bool {
switch name {
case SigningAlgVO, CertificateVO, AudClaimVO, ClaimsScopesVO:
case SigningAlgVO, CertificateVO, AudClaimVO, ClaimsScopesVO, AccountClaimMapsVO:
return true
default:
return false
@@ -408,6 +452,25 @@ var supportedFactories = map[voName]factoryFunc{
str := fmt.Sprintf("%s", i)
return NewClaimsScope(publicId, str)
},
AccountClaimMapsVO: func(publicId string, i interface{}) (interface{}, error) {
const op = "oidc.AccountClaimMapsFactory"
str := fmt.Sprintf("%s", i)
acm, err := ParseAccountClaimMaps(str)
if err != nil {
return nil, err
}
if len(acm) > 1 {
return nil, errors.New(errors.InvalidParameter, op, fmt.Sprintf("unable to parse account claim map %s", str))
}
var from, rawTo string
for from, rawTo = range acm {
}
to, err := ConvertToAccountToClaim(rawTo)
if err != nil {
return nil, errors.Wrap(err, op)
}
return NewAccountClaimMap(publicId, from, to)
},
}
// valueObjectChanges takes the new and old list of VOs (value objects) and
@@ -455,38 +518,38 @@ func valueObjectChanges(
var deletes []interface{}
if strutil.StrListContains(nullFields, string(valueObjectName)) {
deletes = make([]interface{}, 0, len(oldVOs))
for _, a := range oldVOs {
alg, err := factory(publicId, a)
for _, v := range oldVOs {
deleteObj, err := factory(publicId, v)
if err != nil {
return nil, nil, errors.Wrap(err, op)
}
deletes = append(deletes, alg)
delete(foundVOs, a)
deletes = append(deletes, deleteObj)
delete(foundVOs, v)
}
}
if strutil.StrListContains(dbMask, string(valueObjectName)) {
adds = make([]interface{}, 0, len(newVOs))
for _, a := range newVOs {
if _, ok := foundVOs[a]; ok {
delete(foundVOs, a)
for _, v := range newVOs {
if _, ok := foundVOs[v]; ok {
delete(foundVOs, v)
continue
}
alg, err := factory(publicId, a)
obj, err := factory(publicId, v)
if err != nil {
return nil, nil, errors.Wrap(err, op)
}
adds = append(adds, alg)
delete(foundVOs, a)
adds = append(adds, obj)
delete(foundVOs, v)
}
}
if len(foundVOs) > 0 {
for a := range foundVOs {
alg, err := factory(publicId, a)
for v := range foundVOs {
obj, err := factory(publicId, v)
if err != nil {
return nil, nil, errors.Wrap(err, op)
}
deletes = append(deletes, alg)
delete(foundVOs, a)
deletes = append(deletes, obj)
delete(foundVOs, v)
}
}
return adds, deletes, nil
@@ -508,6 +571,7 @@ func validateFieldMask(fieldMaskPaths []string) error {
case strings.EqualFold(AudClaimsField, f):
case strings.EqualFold(CertificatesField, f):
case strings.EqualFold(ClaimsScopesField, f):
case strings.EqualFold(AccountClaimMapsField, f):
default:
return errors.New(errors.InvalidParameter, op, fmt.Sprintf("invalid field mask: %s", f))
}
@@ -566,6 +630,14 @@ func applyUpdate(new, orig *AuthMethod, fieldMaskPaths []string) *AuthMethod {
cp.ClaimsScopes = make([]string, 0, len(new.ClaimsScopes))
cp.ClaimsScopes = append(cp.ClaimsScopes, new.ClaimsScopes...)
}
case AccountClaimMapsField:
switch {
case len(new.AccountClaimMaps) == 0:
cp.AccountClaimMaps = nil
default:
cp.AccountClaimMaps = make([]string, 0, len(new.AccountClaimMaps))
cp.AccountClaimMaps = append(cp.AccountClaimMaps, new.AccountClaimMaps...)
}
}
}
return cp