Blame vendor/github.com/Azure/go-autorest/autorest/adal/config.go

Packit 63bb0d
package adal
Packit 63bb0d
Packit 63bb0d
// Copyright 2017 Microsoft Corporation
Packit 63bb0d
//
Packit 63bb0d
//  Licensed under the Apache License, Version 2.0 (the "License");
Packit 63bb0d
//  you may not use this file except in compliance with the License.
Packit 63bb0d
//  You may obtain a copy of the License at
Packit 63bb0d
//
Packit 63bb0d
//      http://www.apache.org/licenses/LICENSE-2.0
Packit 63bb0d
//
Packit 63bb0d
//  Unless required by applicable law or agreed to in writing, software
Packit 63bb0d
//  distributed under the License is distributed on an "AS IS" BASIS,
Packit 63bb0d
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Packit 63bb0d
//  See the License for the specific language governing permissions and
Packit 63bb0d
//  limitations under the License.
Packit 63bb0d
Packit 63bb0d
import (
Packit 63bb0d
	"errors"
Packit 63bb0d
	"fmt"
Packit 63bb0d
	"net/url"
Packit 63bb0d
)
Packit 63bb0d
Packit 63bb0d
const (
Packit 63bb0d
	activeDirectoryEndpointTemplate = "%s/oauth2/%s%s"
Packit 63bb0d
)
Packit 63bb0d
Packit 63bb0d
// OAuthConfig represents the endpoints needed
Packit 63bb0d
// in OAuth operations
Packit 63bb0d
type OAuthConfig struct {
Packit 63bb0d
	AuthorityEndpoint  url.URL `json:"authorityEndpoint"`
Packit 63bb0d
	AuthorizeEndpoint  url.URL `json:"authorizeEndpoint"`
Packit 63bb0d
	TokenEndpoint      url.URL `json:"tokenEndpoint"`
Packit 63bb0d
	DeviceCodeEndpoint url.URL `json:"deviceCodeEndpoint"`
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// IsZero returns true if the OAuthConfig object is zero-initialized.
Packit 63bb0d
func (oac OAuthConfig) IsZero() bool {
Packit 63bb0d
	return oac == OAuthConfig{}
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func validateStringParam(param, name string) error {
Packit 63bb0d
	if len(param) == 0 {
Packit 63bb0d
		return fmt.Errorf("parameter '" + name + "' cannot be empty")
Packit 63bb0d
	}
Packit 63bb0d
	return nil
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// NewOAuthConfig returns an OAuthConfig with tenant specific urls
Packit 63bb0d
func NewOAuthConfig(activeDirectoryEndpoint, tenantID string) (*OAuthConfig, error) {
Packit 63bb0d
	apiVer := "1.0"
Packit 63bb0d
	return NewOAuthConfigWithAPIVersion(activeDirectoryEndpoint, tenantID, &apiVer)
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// NewOAuthConfigWithAPIVersion returns an OAuthConfig with tenant specific urls.
Packit 63bb0d
// If apiVersion is not nil the "api-version" query parameter will be appended to the endpoint URLs with the specified value.
Packit 63bb0d
func NewOAuthConfigWithAPIVersion(activeDirectoryEndpoint, tenantID string, apiVersion *string) (*OAuthConfig, error) {
Packit 63bb0d
	if err := validateStringParam(activeDirectoryEndpoint, "activeDirectoryEndpoint"); err != nil {
Packit 63bb0d
		return nil, err
Packit 63bb0d
	}
Packit 63bb0d
	api := ""
Packit 63bb0d
	// it's legal for tenantID to be empty so don't validate it
Packit 63bb0d
	if apiVersion != nil {
Packit 63bb0d
		if err := validateStringParam(*apiVersion, "apiVersion"); err != nil {
Packit 63bb0d
			return nil, err
Packit 63bb0d
		}
Packit 63bb0d
		api = fmt.Sprintf("?api-version=%s", *apiVersion)
Packit 63bb0d
	}
Packit 63bb0d
	u, err := url.Parse(activeDirectoryEndpoint)
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, err
Packit 63bb0d
	}
Packit 63bb0d
	authorityURL, err := u.Parse(tenantID)
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, err
Packit 63bb0d
	}
Packit 63bb0d
	authorizeURL, err := u.Parse(fmt.Sprintf(activeDirectoryEndpointTemplate, tenantID, "authorize", api))
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, err
Packit 63bb0d
	}
Packit 63bb0d
	tokenURL, err := u.Parse(fmt.Sprintf(activeDirectoryEndpointTemplate, tenantID, "token", api))
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, err
Packit 63bb0d
	}
Packit 63bb0d
	deviceCodeURL, err := u.Parse(fmt.Sprintf(activeDirectoryEndpointTemplate, tenantID, "devicecode", api))
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, err
Packit 63bb0d
	}
Packit 63bb0d
Packit 63bb0d
	return &OAuthConfig{
Packit 63bb0d
		AuthorityEndpoint:  *authorityURL,
Packit 63bb0d
		AuthorizeEndpoint:  *authorizeURL,
Packit 63bb0d
		TokenEndpoint:      *tokenURL,
Packit 63bb0d
		DeviceCodeEndpoint: *deviceCodeURL,
Packit 63bb0d
	}, nil
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// MultiTenantOAuthConfig provides endpoints for primary and aulixiary tenant IDs.
Packit 63bb0d
type MultiTenantOAuthConfig interface {
Packit 63bb0d
	PrimaryTenant() *OAuthConfig
Packit 63bb0d
	AuxiliaryTenants() []*OAuthConfig
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// OAuthOptions contains optional OAuthConfig creation arguments.
Packit 63bb0d
type OAuthOptions struct {
Packit 63bb0d
	APIVersion string
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (c OAuthOptions) apiVersion() string {
Packit 63bb0d
	if c.APIVersion != "" {
Packit 63bb0d
		return fmt.Sprintf("?api-version=%s", c.APIVersion)
Packit 63bb0d
	}
Packit 63bb0d
	return "1.0"
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// NewMultiTenantOAuthConfig creates an object that support multitenant OAuth configuration.
Packit 63bb0d
// See https://docs.microsoft.com/en-us/azure/azure-resource-manager/authenticate-multi-tenant for more information.
Packit 63bb0d
func NewMultiTenantOAuthConfig(activeDirectoryEndpoint, primaryTenantID string, auxiliaryTenantIDs []string, options OAuthOptions) (MultiTenantOAuthConfig, error) {
Packit 63bb0d
	if len(auxiliaryTenantIDs) == 0 || len(auxiliaryTenantIDs) > 3 {
Packit 63bb0d
		return nil, errors.New("must specify one to three auxiliary tenants")
Packit 63bb0d
	}
Packit 63bb0d
	mtCfg := multiTenantOAuthConfig{
Packit 63bb0d
		cfgs: make([]*OAuthConfig, len(auxiliaryTenantIDs)+1),
Packit 63bb0d
	}
Packit 63bb0d
	apiVer := options.apiVersion()
Packit 63bb0d
	pri, err := NewOAuthConfigWithAPIVersion(activeDirectoryEndpoint, primaryTenantID, &apiVer)
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, fmt.Errorf("failed to create OAuthConfig for primary tenant: %v", err)
Packit 63bb0d
	}
Packit 63bb0d
	mtCfg.cfgs[0] = pri
Packit 63bb0d
	for i := range auxiliaryTenantIDs {
Packit 63bb0d
		aux, err := NewOAuthConfig(activeDirectoryEndpoint, auxiliaryTenantIDs[i])
Packit 63bb0d
		if err != nil {
Packit 63bb0d
			return nil, fmt.Errorf("failed to create OAuthConfig for tenant '%s': %v", auxiliaryTenantIDs[i], err)
Packit 63bb0d
		}
Packit 63bb0d
		mtCfg.cfgs[i+1] = aux
Packit 63bb0d
	}
Packit 63bb0d
	return mtCfg, nil
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
type multiTenantOAuthConfig struct {
Packit 63bb0d
	// first config in the slice is the primary tenant
Packit 63bb0d
	cfgs []*OAuthConfig
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (m multiTenantOAuthConfig) PrimaryTenant() *OAuthConfig {
Packit 63bb0d
	return m.cfgs[0]
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
func (m multiTenantOAuthConfig) AuxiliaryTenants() []*OAuthConfig {
Packit 63bb0d
	return m.cfgs[1:]
Packit 63bb0d
}