signedurl

package

v2.41.0 Latest Latest Go to latest Published: Dec 15, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Package signedurl provides interfaces and implementations for signing and verifying URLs.

This section is empty.

View Source

var ErrInvalidKey = NewSignedURLError(nil, "invalid key provided")

This section is empty.

type JWTOption func(o *JWTOptions)

JWTOption defines a single option function.

func WithQueryParam(queryParam string) JWTOption

func WithSecret(secret string) JWTOption

type JWTOptions struct {
	// contains filtered or unexported fields
}

JWTOptions defines the available options for this package.

type JWTSignedURL struct {
	JWTOptions
}

JWTSignedURL implements the Signer and Verifier interfaces using JWT for signing URLs.

func NewJWTSignedURL(opts ...JWTOption) (*JWTSignedURL, error)

func (j *JWTSignedURL) Sign(unsignedURL, subject string, ttl time.Duration) (string, error)

Sign signs a URL using JWT with a specified time-to-live (ttl).

func (j *JWTSignedURL) Verify(signedURL string) (string, error)

Verify verifies a signed URL using a JWT. Returns the subject of the JWT if verification is successful.

type SignatureVerificationError struct {
	SignedURLError
}

func NewSignatureVerificationError(innerErr error) SignatureVerificationError

func (e SignatureVerificationError) Is(tgt error) bool

type SignedURLError struct {
	// contains filtered or unexported fields
}

func NewSignedURLError(innerErr error, message string) SignedURLError

NewSignedURLError creates a new SignedURLError with the provided inner error and message.

func (e SignedURLError) Error() string

Error implements the error interface for errorConst.

func (e SignedURLError) Unwrap() error

type Signer interface {
	// Sign signs a URL
	Sign(url, principal string, ttl time.Duration) (string, error)
}

type Verifier interface {
	// Verify verifies a signed URL
	Verify(signedURL string) (string, error)
}