basicauthextension

README

Basic Authenticator

This extension implements configauth.ServerAuthenticator to authenticate clients using HTTP Basic Authentication. The authenticator type has to be set to basicauth.

If authentication is successful client.Info.Auth will expose the following attributes:

• username: The username of the authenticated user.
• raw: Raw base64 encoded credentials.

Configuration

extensions:
  basicauth:
    htpasswd: 
      file: .htpasswd
      inline: |
        ${BASIC_AUTH_USERNAME}:${BASIC_AUTH_PASSWORD}

receivers:
  otlp:
    protocols:
      http:
        auth:
          authenticator: basicauth

processors:

exporters:
  logging:
    logLevel: debug

service:
  extensions: [basicauth]
  pipelines:
    traces:
      receivers: [otlp]
      processors: []
      exporters: [logging]

htpasswd

• file: The path to the htpasswd file.
• inline: The htpasswd file inline content.

If both file and inline are configured, inline credentials take precedence.

Documentation

Index

• func NewFactory() component.ExtensionFactory
• type Config
• type HtpasswdSettings

Functions

func NewFactory

func NewFactory() component.ExtensionFactory

NewFactory creates a factory for the static bearer token Authenticator extension.

Types

type Config

type Config struct {
	config.ExtensionSettings `mapstructure:",squash"`

	// Htpasswd settings.
	Htpasswd HtpasswdSettings `mapstructure:"htpasswd"`
}

type HtpasswdSettings

type HtpasswdSettings struct {
	// Path to the htpasswd file.
	File string `mapstructure:"file"`
	// Inline contents of the htpasswd file.
	Inline string `mapstructure:"inline"`
}