csp

Documentation

Overview

Package csp provide functionality needed to interfact with CSP OAuth provider

Package csp provides VMware Cloud Services Platform token utilities.

Index

• Constants
• Variables
• func GetAccessTokenFromAPIToken(apiToken, issuer string) (*common.Token, error)
• func GetIssuer(staging bool) string
• func GetIssuerUpdateFlagFromCentralConfig() bool
• func GetOrgNameFromOrgID(orgID, accessToken, issuer string) (string, error)
• func GetTokens(refreshOrAPIToken, accessToken, issuer, tokenType string) (*common.Token, error)
• func TanzuLogin(issuerURL string, opts ...common.LoginOption) (*common.Token, error)
• type TanzuCSPMetadata
  • func GetCSPMetadata() TanzuCSPMetadata

Constants

const (
	// StgIssuer is the VMware CSP(VCSP) staging issuer.
	StgIssuer = "https://console-stg.cloud.vmware.com/csp/gateway/am/api"

	// ProdIssuer is the VMware CSP(VCSP) issuer.
	ProdIssuer = "https://console.cloud.vmware.com/csp/gateway/am/api"

	// StgIssuerTCSP is the Tanzu CSP (TCSP) staging issuer.
	StgIssuerTCSP = "https://console-stg.tanzu.broadcom.com/csp/gateway/am/api"

	// ProdIssuerTCSP is the Tanzu CSP (TCSP) issuer
	ProdIssuerTCSP = "https://console.tanzu.broadcom.com/csp/gateway/am/api"

	// LocalTPSMIssuer is the test TPSM issuer
	LocalTPSMIssuer = "http://localhost:8080"
)

Variables

var (
	// DefaultKnownIssuers are known OAuth2 endpoints in each CSP environment.
	DefaultKnownIssuers = map[string]oauth2.Endpoint{
		StgIssuer: {
			AuthURL:   "https://console-stg.cloud.vmware.com/csp/gateway/discovery",
			TokenURL:  "https://console-stg.cloud.vmware.com/csp/gateway/am/api/auth/authorize",
			AuthStyle: oauth2.AuthStyleInHeader,
		},
		ProdIssuer: {
			AuthURL:   "https://console.cloud.vmware.com/csp/gateway/discovery",
			TokenURL:  "https://console.cloud.vmware.com/csp/gateway/am/api/auth/authorize",
			AuthStyle: oauth2.AuthStyleInHeader,
		},
		StgIssuerTCSP: {
			AuthURL:   "https://console-stg.tanzu.broadcom.com/csp/gateway/discovery",
			TokenURL:  "https://console-stg.tanzu.broadcom.com/csp/gateway/am/api/auth/authorize",
			AuthStyle: oauth2.AuthStyleInHeader,
		},
		ProdIssuerTCSP: {
			AuthURL:   "https://console.tanzu.broadcom.com/csp/gateway/discovery",
			TokenURL:  "https://console.tanzu.broadcom.com/csp/gateway/am/api/auth/authorize",
			AuthStyle: oauth2.AuthStyleInHeader,
		},
	}
)

Functions

func GetAccessTokenFromAPIToken

func GetAccessTokenFromAPIToken(apiToken, issuer string) (*common.Token, error)

GetAccessTokenFromAPIToken fetches CSP access token using the API-token.

func GetIssuer

func GetIssuer(staging bool) string

GetIssuer returns the appropriate CSP issuer based on the environment.

func GetIssuerUpdateFlagFromCentralConfig

func GetIssuerUpdateFlagFromCentralConfig() bool

GetIssuerUpdateFlagFromCentralConfig gets the issuer update flag (used to update the CLI config file) from Central config as best effort

func GetOrgNameFromOrgID

func GetOrgNameFromOrgID(orgID, accessToken, issuer string) (string, error)

GetOrgNameFromOrgID fetches CSP Org Name given the Organization ID.

func GetTokens

func GetTokens(refreshOrAPIToken, accessToken, issuer, tokenType string) (*common.Token, error)

GetTokens fetches the CSP access token

func TanzuLogin

func TanzuLogin(issuerURL string, opts ...common.LoginOption) (*common.Token, error)

Types

type TanzuCSPMetadata

type TanzuCSPMetadata struct {
	IssuerProduction string `json:"issuerProduction" yaml:"issuerProduction"`
	IssuerStaging    string `json:"issuerStaging" yaml:"issuerStaging"`
}

TanzuCSPMetadata to parse the CSP metadata from central config

func GetCSPMetadata

func GetCSPMetadata() TanzuCSPMetadata

GetCSPMetadata gets the CSP metadata from central config as best effort, If it fails to get the metadata from central config, it returns the default values