tasks/common/authorization/claim_mapper.go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

//go:generate mockgen -copyright_file ../../LICENSE -package $GOPACKAGE -source $GOFILE -destination claim_mapper_mock.go

package authorization

import (
	"crypto/x509/pkix"
	"fmt"
	"strings"

	"go.temporal.io/server/common/config"
	"go.temporal.io/server/common/log"
	"google.golang.org/grpc/credentials"
)

// @@@SNIPSTART temporal-common-authorization-authinfo
// Authentication information from subject's JWT token or/and mTLS certificate
type AuthInfo struct {
	AuthToken     string
	TLSSubject    *pkix.Name
	TLSConnection *credentials.TLSInfo
	ExtraData     string
	Audience      string
}

// @@@SNIPEND

// @@@SNIPSTART temporal-common-authorization-claimmapper-interface
// ClaimMapper converts authorization info of a subject into Temporal claims (permissions) for authorization
type ClaimMapper interface {
	GetClaims(authInfo *AuthInfo) (*Claims, error)
}

// @@@SNIPEND

// Normally, GetClaims will never be called without either an auth token or TLS metadata set in
// AuthInfo. However, if you want your ClaimMapper to be called in all cases, you can implement
// this additional interface and return false.
type ClaimMapperWithAuthInfoRequired interface {
	AuthInfoRequired() bool
}

// No-op claim mapper that gives system level admin permission to everybody
type noopClaimMapper struct{}

var _ ClaimMapper = (*noopClaimMapper)(nil)
var _ ClaimMapperWithAuthInfoRequired = (*noopClaimMapper)(nil)

func NewNoopClaimMapper() ClaimMapper {
	return &noopClaimMapper{}
}

func (*noopClaimMapper) GetClaims(_ *AuthInfo) (*Claims, error) {
	return &Claims{System: RoleAdmin}, nil
}

// This implementation can run even without auth info.
func (*noopClaimMapper) AuthInfoRequired() bool {
	return false
}

func GetClaimMapperFromConfig(config *config.Authorization, logger log.Logger) (ClaimMapper, error) {

	switch strings.ToLower(config.ClaimMapper) {
	case "":
		return NewNoopClaimMapper(), nil
	case "default":
		return NewDefaultJWTClaimMapper(NewDefaultTokenKeyProvider(config, logger), config, logger), nil
	}
	return nil, fmt.Errorf("unknown claim mapper: %s", config.ClaimMapper)
}