caddy_ask_redis

README

caddy-ask-redis

Caddy Server v2 module for use in tls_on_demand ask property. The module will check if requested domain is a member of the Redis set defined by key.

Installation

xcaddy build \
    --with github.com/randock/caddy-ask-redis

Usage

Caddyfile

# Global config
{
   	on_demand_tls {
		permission redis {
			address {$REDIS_HOST_PORT}
            username {$REDIS_USERNAME}
            password {$REDIS_PASSWORD}
        }
	}
}

Documentation

Index

• Constants
• type PermissionByRedis
  • func (PermissionByRedis) CaddyModule() caddy.ModuleInfo
  • func (m PermissionByRedis) CertificateAllowed(ctx context.Context, name string) error
  • func (m *PermissionByRedis) Cleanup() error
  • func (m *PermissionByRedis) Provision(ctx caddy.Context) error
  • func (m *PermissionByRedis) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
  • func (m *PermissionByRedis) Validate() error

Constants

const (
	DefaultRedisAddress  = "127.0.0.1:6379"
	DefaultRedisUsername = "default"
)

Types

type PermissionByRedis

type PermissionByRedis struct {
	Client *redis.Client

	WwwRegex *regexp.Regexp

	Address  string `json:"address"`
	Username string `json:"username"`
	Password string `json:"password"`
	Prefix   string `json:"prefix"`
	// contains filtered or unexported fields
}

func (PermissionByRedis) CaddyModule

func (PermissionByRedis) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (PermissionByRedis) CertificateAllowed

func (m PermissionByRedis) CertificateAllowed(ctx context.Context, name string) error

func (*PermissionByRedis) Cleanup

func (m *PermissionByRedis) Cleanup() error

func (*PermissionByRedis) Provision

func (m *PermissionByRedis) Provision(ctx caddy.Context) error

Provision implements the caddy.Provisioner interface.

func (*PermissionByRedis) UnmarshalCaddyfile

func (m *PermissionByRedis) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile implements caddyfile.Unmarshaler. Syntax:

ask_redis <secret>

func (*PermissionByRedis) Validate

func (m *PermissionByRedis) Validate() error