auth

Documentation

Overview

Package auth provides authentication for Google Cloud APIs.

It supports multiple authentication methods: - Application Default Credentials (for local development via gcloud). - GCP Metadata Server (for GCE, GKE, Cloud Run, Cloud Functions, App Engine).

Index

• func AccessToken(ctx context.Context) (string, error)
• func ProjectID(ctx context.Context) (string, error)
• func WithConfig(ctx context.Context, cfg *Config) context.Context
• type Config

Functions

func AccessToken

func AccessToken(ctx context.Context) (string, error)

AccessToken retrieves a GCP access token. It tries Application Default Credentials first, then falls back to the metadata server. Configuration can be provided via auth.WithConfig in the context.

func ProjectID

func ProjectID(ctx context.Context) (string, error)

ProjectID retrieves the project ID from the GCP metadata server.

func WithConfig

func WithConfig(ctx context.Context, cfg *Config) context.Context

WithConfig returns a new context with the given auth config.

Types

type Config

type Config struct {
	// MetadataURL is the URL for the GCP metadata server.
	// Defaults to the production metadata server if empty.
	MetadataURL string

	// SkipADC skips Application Default Credentials and goes straight to metadata server.
	// Useful for testing to ensure mock servers are used.
	SkipADC bool
}

Config holds auth configuration.