auth

Auth Package

The auth package provides modular authentication strategies for the remote client.

Authenticator Interface

All strategies implement the Authenticator interface, allowing them to be easily injected into any remote.Client.

type Authenticator interface {
    Apply(req *http.Request) error
}

Supported Strategies

API Key Authentication

Uses a custom header (e.g., X-API-Key) with a fixed value.

auth.NewAPIKey(auth.APIKeyConfig{
    Key:   "X-Custom-Key",
    Value: "my-secret-key",
})

Bearer Token Authentication

Uses the standard Authorization: Bearer <token> header.

auth.NewBearer(auth.BearerConfig{Token: "my-jwt-token"})

OAuth2 Client Credentials Flow

Implements the OAuth2 Client Credentials flow with the following features:

• Automatic token caching.
• Expiry handling with a 1-minute safety buffer.
• Synchronized token updates to prevent race conditions.
• Scope support.

auth.NewOAuth2(auth.OAuth2Config{
    TokenURL:     "https://identity.example.com/oauth2/token",
    ClientID:     "my-client-id",
    ClientSecret: "my-client-secret",
    Scopes:       []string{"read", "write"},
})

Strategy Configuration

APIKeyConfig

Used when the authentication type is "api_key".

BearerConfig

Used when the authentication type is "bearer".

OAuth2Config

Used when the authentication type is "oauth2".