opentelemetry-collector/extension/extensionauth/client.go

// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package extensionauth // import "go.opentelemetry.io/collector/extension/extensionauth"

import (
	"net/http"

	"google.golang.org/grpc/credentials"

	"go.opentelemetry.io/collector/component"
	"go.opentelemetry.io/collector/extension"
)

// Client is an optional Extension interface that can be used as an HTTP and gRPC authenticator for the configauth.Authentication option.
// Authenticators are then included as part of OpenTelemetry Collector builds and can be referenced by their
// names from the Authentication configuration.
// Deprecated: [v0.122.0] Assert the use of HTTPClient and GRPCClient interfaces instead.
type Client interface {
	extension.Extension
	HTTPClient
	GRPCClient
}

// HTTPClient is an optional Extension interface that can be used as an HTTP authenticator for the configauth.Authentication option.
// Authenticators are then included as part of OpenTelemetry Collector builds and can be referenced by their
// names from the Authentication configuration.
type HTTPClient interface {
	// RoundTripper returns a RoundTripper that can be used to authenticate HTTP requests.
	RoundTripper(base http.RoundTripper) (http.RoundTripper, error)
}

// GRPCClient is an optional Extension interface that can be used as a gRPC authenticator for the configauth.Authentication option.
// Authenticators are then included as part of OpenTelemetry Collector builds and can be referenced by their
// names from the Authentication configuration.
type GRPCClient interface {
	// PerRPCCredentials returns a PerRPCCredentials that can be used to authenticate gRPC requests.
	PerRPCCredentials() (credentials.PerRPCCredentials, error)
}

// ClientOption represents the possible options for NewClient.
// Deprecated: [v0.122.0] This type is deprecated and will be removed in the next release.
type ClientOption interface {
	apply(*defaultClient)
}

type clientOptionFunc func(*defaultClient)

func (of clientOptionFunc) apply(e *defaultClient) {
	of(e)
}

var _ HTTPClient = (*ClientRoundTripperFunc)(nil)

// ClientRoundTripperFunc specifies the function that returns a RoundTripper that can be used to authenticate HTTP requests.
type ClientRoundTripperFunc func(base http.RoundTripper) (http.RoundTripper, error)

func (f ClientRoundTripperFunc) RoundTripper(base http.RoundTripper) (http.RoundTripper, error) {
	if f == nil {
		return base, nil
	}
	return f(base)
}

var _ GRPCClient = (*ClientPerRPCCredentialsFunc)(nil)

// ClientPerRPCCredentialsFunc specifies the function that returns a PerRPCCredentials that can be used to authenticate gRPC requests.
type ClientPerRPCCredentialsFunc func() (credentials.PerRPCCredentials, error)

func (f ClientPerRPCCredentialsFunc) PerRPCCredentials() (credentials.PerRPCCredentials, error) {
	if f == nil {
		return nil, nil
	}
	return f()
}

var _ Client = (*defaultClient)(nil)

type defaultClient struct {
	component.StartFunc
	component.ShutdownFunc
	clientRoundTripperFunc      ClientRoundTripperFunc
	clientPerRPCCredentialsFunc ClientPerRPCCredentialsFunc
}

// PerRPCCredentials implements Client.
func (d *defaultClient) PerRPCCredentials() (credentials.PerRPCCredentials, error) {
	if d.clientPerRPCCredentialsFunc == nil {
		return nil, nil
	}
	return d.clientPerRPCCredentialsFunc()
}

// RoundTripper implements Client.
func (d *defaultClient) RoundTripper(base http.RoundTripper) (http.RoundTripper, error) {
	if d.clientRoundTripperFunc == nil {
		return base, nil
	}
	return d.clientRoundTripperFunc(base)
}

// WithClientStart overrides the default `Start` function for a component.Component.
// The default always returns nil.
// Deprecated: [v0.122.0] This type is deprecated and will be removed in the next release.
func WithClientStart(startFunc component.StartFunc) ClientOption {
	return clientOptionFunc(func(o *defaultClient) {
		o.StartFunc = startFunc
	})
}

// WithClientShutdown overrides the default `Shutdown` function for a component.Component.
// The default always returns nil.
// Deprecated: [v0.122.0] This type is deprecated and will be removed in the next release.
func WithClientShutdown(shutdownFunc component.ShutdownFunc) ClientOption {
	return clientOptionFunc(func(o *defaultClient) {
		o.ShutdownFunc = shutdownFunc
	})
}

// WithClientRoundTripper provides a `RoundTripper` function for this client authenticator.
// The default round tripper is no-op.
// Deprecated: [v0.122.0] This type is deprecated and will be removed in the next release.
func WithClientRoundTripper(roundTripperFunc ClientRoundTripperFunc) ClientOption {
	return clientOptionFunc(func(o *defaultClient) {
		o.clientRoundTripperFunc = roundTripperFunc
	})
}

// WithClientPerRPCCredentials provides a `PerRPCCredentials` function for this client authenticator.
// There's no default.
// Deprecated: [v0.122.0] This type is deprecated and will be removed in the next release.
func WithClientPerRPCCredentials(perRPCCredentialsFunc ClientPerRPCCredentialsFunc) ClientOption {
	return clientOptionFunc(func(o *defaultClient) {
		o.clientPerRPCCredentialsFunc = perRPCCredentialsFunc
	})
}

// NewClient returns a Client configured with the provided options.
// Deprecated: [v0.122.0] This type is deprecated and will be removed in the next release.
// Manually implement the [HTTPClient] and/or [GRPCClient] interfaces instead.
func NewClient(options ...ClientOption) (Client, error) {
	bc := &defaultClient{}

	for _, op := range options {
		op.apply(bc)
	}

	return bc, nil
}