auth

Documentation

Index

• type Client
  • func NewClient(options ...ClientOption) Client
• type ClientOption
  • func WithClientPerRPCCredentials(perRPCCredentialsFunc ClientPerRPCCredentialsFunc) ClientOption
  • func WithClientRoundTripper(roundTripperFunc ClientRoundTripperFunc) ClientOption
  • func WithClientShutdown(shutdownFunc component.ShutdownFunc) ClientOption
  • func WithClientStart(startFunc component.StartFunc) ClientOption
• type ClientPerRPCCredentialsFunc
• type ClientRoundTripperFunc
• type Server
  • func NewServer(options ...ServerOption) Server
• type ServerAuthenticateFunc
• type ServerOption
  • func WithServerAuthenticate(authFunc ServerAuthenticateFunc) ServerOption
  • func WithServerShutdown(shutdownFunc component.ShutdownFunc) ServerOption
  • func WithServerStart(startFunc component.StartFunc) ServerOption

Types

type Client

type Client = extensionauth.Client

Client is an Extension that can be used as an 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.121.0] Use extensionauth.Client instead.

func NewClient

func NewClient(options ...ClientOption) Client

NewClient returns a Client configured with the provided options. Deprecated: [v0.121.0] Use extensionauth.NewClient instead.

type ClientOption

type ClientOption = extensionauth.ClientOption

ClientOption represents the possible options for NewClient. Deprecated: [v0.121.0] Use extensionauth.Client instead.

func WithClientPerRPCCredentials

func WithClientPerRPCCredentials(perRPCCredentialsFunc ClientPerRPCCredentialsFunc) ClientOption

WithClientPerRPCCredentials provides a `PerRPCCredentials` function for this client authenticator. There's no default. Deprecated: [v0.121.0] Use extensionauth.WithClientPerRPCCredentials instead.

func WithClientRoundTripper

func WithClientRoundTripper(roundTripperFunc ClientRoundTripperFunc) ClientOption

WithClientRoundTripper provides a `RoundTripper` function for this client authenticator. The default round tripper is no-op. Deprecated: [v0.121.0] Use extensionauth.WithClientRoundTripper instead.

func WithClientShutdown

func WithClientShutdown(shutdownFunc component.ShutdownFunc) ClientOption

WithClientShutdown overrides the default `Shutdown` function for a component.Component. The default always returns nil. Deprecated: [v0.121.0] Use extensionauth.WithClientShutdown instead.

func WithClientStart

func WithClientStart(startFunc component.StartFunc) ClientOption

WithClientStart overrides the default `Start` function for a component.Component. The default always returns nil. Deprecated: [v0.121.0] Use extensionauth.WithClientStart instead.

type ClientPerRPCCredentialsFunc

type ClientPerRPCCredentialsFunc = extensionauth.ClientPerRPCCredentialsFunc

ClientPerRPCCredentialsFunc specifies the function that returns a PerRPCCredentials that can be used to authenticate gRPC requests. Deprecated: [v0.121.0] Use extensionauth.ClientPerRPCCredentialsFunc instead.

type ClientRoundTripperFunc

type ClientRoundTripperFunc = extensionauth.ClientRoundTripperFunc

ClientRoundTripperFunc specifies the function that returns a RoundTripper that can be used to authenticate HTTP requests. Deprecated: [v0.121.0] Use extensionauth.ClientRoundTripperFunc instead.

type Server

type Server = extensionauth.Server

Server is an Extension that can be used as an 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. Each Server is free to define its own behavior and configuration options, but note that the expectations that come as part of Extensions exist here as well. For instance, multiple instances of the same authenticator should be possible to exist under different names. Deprecated: [v0.121.0] Use extensionauth.Server instead.

func NewServer

func NewServer(options ...ServerOption) Server

NewServer returns a Server configured with the provided options. Deprecated: [v0.121.0] Use extensionauth.NewServer instead.

type ServerAuthenticateFunc

type ServerAuthenticateFunc = extensionauth.ServerAuthenticateFunc

ServerAuthenticateFunc defines the signature for the function responsible for performing the authentication based on the given sources map. See Server.Authenticate. Deprecated: [v0.121.0] Use extensionauth.ServerAuthenticateFunc instead.

type ServerOption

type ServerOption = extensionauth.ServerOption

ServerOption represents the possible options for NewServer. Deprecated: [v0.121.0] Use extensionauth.ServerOption instead.

func WithServerAuthenticate

func WithServerAuthenticate(authFunc ServerAuthenticateFunc) ServerOption

WithServerAuthenticate specifies which function to use to perform the authentication. Deprecated: [v0.121.0] Use extensionauth.WithServerAuthenticate instead.

func WithServerShutdown

func WithServerShutdown(shutdownFunc component.ShutdownFunc) ServerOption

WithServerShutdown overrides the default `Shutdown` function for a component.Component. The default always returns nil. Deprecated: [v0.121.0] Use extensionauth.WithServerShutdown instead.

func WithServerStart

func WithServerStart(startFunc component.StartFunc) ServerOption

WithServerStart overrides the default `Start` function for a component.Component. The default always returns nil. Deprecated: [v0.121.0] Use extensionauth.WithServerStart instead.