security/pkg/stsservice/tokenmanager/tokenmanager.go

// Copyright Istio Authors
//
// 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 tokenmanager

import (
	"errors"
	"fmt"
)

import (
	"github.com/apache/dubbo-go-pixiu/pkg/bootstrap/platform"
	"github.com/apache/dubbo-go-pixiu/pkg/security"
	"github.com/apache/dubbo-go-pixiu/security/pkg/stsservice/tokenmanager/google"
)

const (
	// GoogleTokenExchange is the name of the google token exchange service.
	GoogleTokenExchange = "GoogleTokenExchange"
)

// Plugin provides common interfaces for specific token exchange services.
type Plugin interface {
	ExchangeToken(parameters security.StsRequestParameters) ([]byte, error)
	DumpPluginStatus() ([]byte, error)
	// GetMetadata returns the metadata headers related to the token
	GetMetadata(forCA bool, xdsAuthProvider, token string) (map[string]string, error)
}

type TokenManager struct {
	plugin Plugin
}

type Config struct {
	CredFetcher security.CredFetcher
	TrustDomain string
}

// GCPProjectInfo stores GCP project information, including project number,
// project ID, cluster location, cluster name
type GCPProjectInfo struct {
	Number          string
	id              string
	cluster         string
	clusterLocation string
	clusterURL      string
}

func GetGCPProjectInfo() GCPProjectInfo {
	info := GCPProjectInfo{}
	if platform.IsGCP() {
		md := platform.NewGCP().Metadata()
		if projectNum, found := md[platform.GCPProjectNumber]; found {
			info.Number = projectNum
		}
		if projectID, found := md[platform.GCPProject]; found {
			info.id = projectID
		}
		if clusterName, found := md[platform.GCPCluster]; found {
			info.cluster = clusterName
		}
		if clusterLocation, found := md[platform.GCPLocation]; found {
			info.clusterLocation = clusterLocation
		}
		if clusterURL, found := md[platform.GCPClusterURL]; found {
			info.clusterURL = clusterURL
		}
	}
	return info
}

// CreateTokenManager creates a token manager with specified type and returns
// that token manager
func CreateTokenManager(tokenManagerType string, config Config) (security.TokenManager, error) {
	tm := &TokenManager{
		plugin: nil,
	}
	switch tokenManagerType {
	case GoogleTokenExchange:
		if projectInfo := GetGCPProjectInfo(); len(projectInfo.Number) > 0 {
			if p, err := google.CreateTokenManagerPlugin(config.CredFetcher, config.TrustDomain,
				projectInfo.Number, projectInfo.clusterURL, true); err == nil {
				tm.plugin = p
			} else {
				return nil, err
			}
		} else {
			return nil, fmt.Errorf("%v token manager specified but failed to ready GCP project information", GoogleTokenExchange)
		}
	}
	return tm, nil
}

func (tm *TokenManager) GenerateToken(parameters security.StsRequestParameters) ([]byte, error) {
	if tm.plugin != nil {
		return tm.plugin.ExchangeToken(parameters)
	}
	return nil, errors.New("no plugin is found")
}

func (tm *TokenManager) DumpTokenStatus() ([]byte, error) {
	if tm.plugin != nil {
		return tm.plugin.DumpPluginStatus()
	}
	return nil, errors.New("no plugin is found")
}

func (tm *TokenManager) GetMetadata(forCA bool, xdsAuthProvider, token string) (map[string]string, error) {
	if tm.plugin != nil {
		return tm.plugin.GetMetadata(forCA, xdsAuthProvider, token)
	}
	// If no plugin, for an non-empty token, place the token in the authorization header.
	if len(token) > 0 {
		return map[string]string{
			"authorization": "Bearer " + token,
		}, nil
	}
	// Otherwise, return an error
	return nil, errors.New("no plugin is found and token is empty in token manager")
}

// SetPlugin sets token exchange plugin for testing purposes only.
func (tm *TokenManager) SetPlugin(p Plugin) {
	tm.plugin = p
}