imgproxy

package

v0.250.1 Latest Latest Go to latest Published: Oct 15, 2026 License: AGPL-3.0 Imports: 29 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/immanent-tech/foragd

Links

Open Source Insights

Documentation ¶

Index ¶

func GenerateImageProxyURL(ctx context.Context, url, props string) string
func HandleImage(cache ImageCache, opts ...Option) http.HandlerFunc
type AppConfig
type Config
type ImageCache
type Option
- func WithSignatureVerifier(v SignatureVerifier) Option
type SignatureVerifier
- func NewSignatureVerifier(keyHex, saltHex string) (SignatureVerifier, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GenerateImageProxyURL ¶ added in v0.245.0

func GenerateImageProxyURL(ctx context.Context, url, props string) string

GenerateImageProxyURL generates an image proxy URL for the given remote image URL. If a proxy URL cannot be generated, the original remote image URL is returned.

func HandleImage ¶

func HandleImage(cache ImageCache, opts ...Option) http.HandlerFunc

HandleImage is handler that will attempt to proxy an image through the image proxy. It will fetch, store and retrieve the image from the cache as needed.

Types ¶

type AppConfig ¶ added in v0.235.0

type AppConfig interface {
	GetAppName() string
	GetAppVersion() string
}

type Config ¶

type Config struct {
	Key    string `koanf:"key"    validate:"required,base64rawurl"`
	Salt   string `koanf:"salt"   validate:"required,base64rawurl"`
	Prefix string `koanf:"prefix" validate:"required,url"`
}

type ImageCache ¶ added in v0.235.0

type ImageCache interface {
	GetImage(ctx context.Context, key string, buf *bytes.Buffer) error
	SaveImage(ctx context.Context, id string, data []byte) error
}

type Option ¶ added in v0.245.0

type Option func(*handler)

Option configures the image handler.

func WithSignatureVerifier ¶ added in v0.245.0

func WithSignatureVerifier(v SignatureVerifier) Option

WithSignatureVerifier enables signature verification of incoming requests. Strongly recommended when no image proxy prefix is configured, otherwise the handler is an open proxy.

type SignatureVerifier ¶ added in v0.245.0

type SignatureVerifier func(signature, path string) bool

SignatureVerifier checks the signature segment against the signed path. path is everything after the signature, including the leading slash (i.e. "/<options...>/<encoded url>"). Return true if the signature is valid. See NewSignatureVerifier for an imgproxy-compatible implementation.

func NewSignatureVerifier ¶ added in v0.245.0

func NewSignatureVerifier(keyHex, saltHex string) (SignatureVerifier, error)

NewSignatureVerifier returns a SignatureVerifier compatible with imgproxy's URL signing:

signature = base64url_raw(HMAC-SHA256(key, salt || path))

keyHex and saltHex are the hex-encoded values of IMGPROXY_KEY and IMGPROXY_SALT. path is the part of the URL after the signature, including the leading slash. Truncated signatures (IMGPROXY_SIGNATURE_SIZE) are supported.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL