105 lines
2.8 KiB
Go
105 lines
2.8 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package oidc
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"github.com/hashicorp/boundary/internal/auth/oidc/store"
|
|
"github.com/hashicorp/boundary/internal/errors"
|
|
"google.golang.org/protobuf/proto"
|
|
)
|
|
|
|
const (
|
|
// defaultAcctClaimMapTableName defines the default table name for an AccountClaimMap
|
|
defaultAcctClaimMapTableName = "auth_oidc_account_claim_map"
|
|
)
|
|
|
|
type AccountToClaim string
|
|
|
|
const (
|
|
ToSubClaim AccountToClaim = "sub"
|
|
ToEmailClaim AccountToClaim = "email"
|
|
ToNameClaim AccountToClaim = "name"
|
|
)
|
|
|
|
func ConvertToAccountToClaim(ctx context.Context, s string) (AccountToClaim, error) {
|
|
const op = "oidc.(AccountToClaim).convertToAccountToClaim"
|
|
switch s {
|
|
case string(ToSubClaim):
|
|
return ToSubClaim, nil
|
|
case string(ToEmailClaim):
|
|
return ToEmailClaim, nil
|
|
case string(ToNameClaim):
|
|
return ToNameClaim, nil
|
|
default:
|
|
return "", errors.New(ctx, errors.InvalidParameter, op, fmt.Sprintf("%s is not a valid ToAccountClaim value", s))
|
|
}
|
|
}
|
|
|
|
// AccountClaimMap defines optional OIDC scope values that are used to request
|
|
// claims, in addition to the default scope of "openid" (see: DefaultClaimsScope).
|
|
type AccountClaimMap struct {
|
|
*store.AccountClaimMap
|
|
tableName string
|
|
}
|
|
|
|
func NewAccountClaimMap(ctx context.Context, authMethodId, fromClaim string, toClaim AccountToClaim) (*AccountClaimMap, error) {
|
|
const op = "oidc.NewAccountClaimMap"
|
|
cs := &AccountClaimMap{
|
|
AccountClaimMap: &store.AccountClaimMap{
|
|
OidcMethodId: authMethodId,
|
|
FromClaim: fromClaim,
|
|
ToClaim: string(toClaim),
|
|
},
|
|
}
|
|
if err := cs.validate(ctx, op); err != nil {
|
|
return nil, err
|
|
}
|
|
return cs, nil
|
|
}
|
|
|
|
// validate the AccountClaimMap. On success, it will return nil.
|
|
func (s *AccountClaimMap) validate(ctx context.Context, caller errors.Op) error {
|
|
if s.OidcMethodId == "" {
|
|
return errors.New(ctx, errors.InvalidParameter, caller, "missing oidc auth method id")
|
|
}
|
|
if s.FromClaim == "" {
|
|
return errors.New(ctx, errors.InvalidParameter, caller, "missing from claim")
|
|
}
|
|
if _, err := ConvertToAccountToClaim(ctx, s.ToClaim); err != nil {
|
|
return errors.Wrap(ctx, err, caller)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// AllocClaimsScope makes an empty one in memory
|
|
func AllocAccountClaimMap() AccountClaimMap {
|
|
return AccountClaimMap{
|
|
AccountClaimMap: &store.AccountClaimMap{},
|
|
}
|
|
}
|
|
|
|
// Clone a AccountClaimMap
|
|
func (s *AccountClaimMap) Clone() *AccountClaimMap {
|
|
cp := proto.Clone(s.AccountClaimMap)
|
|
return &AccountClaimMap{
|
|
AccountClaimMap: cp.(*store.AccountClaimMap),
|
|
}
|
|
}
|
|
|
|
// TableName returns the table name.
|
|
func (s *AccountClaimMap) TableName() string {
|
|
if s.tableName != "" {
|
|
return s.tableName
|
|
}
|
|
return defaultAcctClaimMapTableName
|
|
}
|
|
|
|
// SetTableName sets the table name.
|
|
func (s *AccountClaimMap) SetTableName(n string) {
|
|
s.tableName = n
|
|
}
|