config

Documentation

Index

• Constants
• type Application
  • func (a *Application) UpdateEnvironmentVariables(viperEnv *viper.Viper) error
• type Certificate
• type Challenge
• type Content
  • func (c Content) GetDomains(basePath string) ([]string, error)
  • func (c Content) GetDomainsFromFile(basePath string) ([]string, error)
• type Daemon
• type EnvironmentVariable
• type ExternalAccountBinding
• type Installation
• type ProviderParameters
  • func (p ProviderParameters) ApplyEnvironmentVariables() error
  • func (p ProviderParameters) ResetEnvironmentVariables() error
• type Request
  • func (r Request) GetChallengeProvider(environment registry.Environment, timestamp string) (challenge.Provider, error)
  • func (r Request) GetDomains() ([]string, error)
  • func (r Request) GetKeyType() certcrypto.KeyType
  • func (r Request) GetServiceUrl() string
  • func (r Request) SetPath(path string) Request
• type Target
• type User

Constants

const (
	ACME_SERVICE_LETSENCRYPT_PRODUCTION     = "LE_PRODUCTION"
	ACME_SERVICE_LETSENCRYPT_PRODUCTION_URL = "https://acme-v02.api.letsencrypt.org/directory"
	ACME_SERVICE_LETSENCRYPT_STAGING        = "LE_STAGING"
	ACME_SERVICE_LETSENCRYPT_STAGING_URL    = "https://acme-staging-v02.api.letsencrypt.org/directory"
)

Let's Encrypt Service Environments

const (
	// NetScaler specific challenge types are defined in package netscaleradc
	ACME_CHALLENGE_TYPE_HTTP     = "http-01"
	ACME_CHALLENGE_TYPE_DNS      = "dns-01"
	ACME_CHALLENGE_TYPE_TLS_ALPN = "tls-alpn-01"
)

ACME Protocol challenge types

const (
	ACME_KEY_TYPE_EC256   = "EC256"
	ACME_KEY_TYPE_EC384   = "EC384"
	ACME_KEY_TYPE_RSA2048 = "RSA2048"
	ACME_KEY_TYPE_RSA4096 = "RSA4096"
	ACME_KEY_TYPE_RSA8192 = "RSA8192"
)

const (
	ACME_CHALLENGE_PROVIDER_WEBSERVER = "webserver"
)

Generic webserver provider Other providers constants are defined in their respective codebase

Types

type Application

type Application struct {
	ConfigPath string `json:"configPath" yaml:"configPath" mapstructure:"configPath"`
	// Daemon        Daemon                  `json:"daemon" yaml:"daemon" mapstructure:"daemon"`
	Organizations []registry.Organization `json:"organizations" yaml:"organizations" mapstructure:"organizations"`
	Users         []User                  `json:"users" yaml:"users" mapstructure:"users"`
	Parameters    []ProviderParameters    `json:"providerParameters" yaml:"providerParameters" mapstructure:"providerParameters"`
}

func (*Application) UpdateEnvironmentVariables

func (a *Application) UpdateEnvironmentVariables(viperEnv *viper.Viper) error

type Certificate

type Certificate struct {
	Name         string                `json:"name" yaml:"name" mapstructure:"name"`
	Request      Request               `json:"request" yaml:"request" mapstructure:"request"`
	Installation []Installation        `json:"installation" yaml:"installation" mapstructure:"installation"`
	Resource     *certificate.Resource `json:"-" yaml:"-" mapstructure:"-"`
}

type Challenge

type Challenge struct {
	Service                    string `json:"service" yaml:"service" mapstructure:"service"`
	Type                       string `json:"type" yaml:"type" mapstructure:"type"`
	Provider                   string `json:"provider" yaml:"provider" mapstructure:"provider"`
	DisableDnsPropagationCheck bool   `json:"disableDnsPropagationCheck" yaml:"disableDnsPropagationCheck" mapstructure:"disableDnsPropagationCheck"`
	ProviderParameters         string `json:"providerParameters" yaml:"providerParameters" mapstructure:"providerParameters"`
}

type Content

type Content struct {
	CommonName                  string   `json:"commonName" yaml:"commonName" mapstructure:"commonName"`
	SubjectAlternativeNames     []string `json:"subjectAlternativeNames" yaml:"subjectAlternativeNames" mapstructure:"subjectAlternativeNames"`
	SubjectAlternativeNamesFile string   `json:"subjectAlternativeNamesFile" yaml:"subjectAlternativeNamesFile" mapstructure:"subjectAlternativeNamesFile"`
}

func (Content) GetDomains

func (c Content) GetDomains(basePath string) ([]string, error)

func (Content) GetDomainsFromFile

func (c Content) GetDomainsFromFile(basePath string) ([]string, error)

type Daemon

type Daemon struct {
	Address string `json:"address" yaml:"address" mapstructure:"address"`
	Port    int    `json:"port" yaml:"port" mapstructure:"port"`
}

type EnvironmentVariable

type EnvironmentVariable struct {
	Name  string `json:"name" yaml:"name" mapstructure:"name"`
	Value string `json:"value" yaml:"value" mapstructure:"value"`
}

type ExternalAccountBinding

type ExternalAccountBinding struct {
	Kid         string `json:"kid" yaml:"kid" mapstructure:"kid"`
	HmacEncoded string `json:"hmacEncoded" yaml:"hmacEncoded" mapstructure:"hmacEncoded"`
}

type Installation

type Installation struct {
	Target                    Target             `json:"target" yaml:"target" mapstructure:"target"`
	ReplaceDefaultCertificate bool               `json:"replaceDefaultCertificate" yaml:"replaceDefaultCertificate" mapstructure:"replaceDefaultCertificate"`
	SslVirtualServers         []sslVirtualServer `json:"sslVirtualServers" yaml:"sslVirtualServers" mapstructure:"sslVirtualServers"`
	SslServices               []sslService       `json:"sslServices" yaml:"sslServices" mapstructure:"sslServices"`
}

type ProviderParameters

type ProviderParameters struct {
	Name      string                `json:"name" yaml:"name" mapstructure:"name"`
	Variables []EnvironmentVariable `json:"variables" yaml:"variables" mapstructure:"variables"`
}

func (ProviderParameters) ApplyEnvironmentVariables

func (p ProviderParameters) ApplyEnvironmentVariables() error

func (ProviderParameters) ResetEnvironmentVariables

func (p ProviderParameters) ResetEnvironmentVariables() error

type Request

type Request struct {
	Target    Target    `json:"target" yaml:"target" mapstructure:"target"`
	User      string    `json:"user" yaml:"user" mapstructure:"user"`
	Challenge Challenge `json:"challenge" yaml:"challenge" mapstructure:"challenge"`
	KeyType   string    `json:"keyType" yaml:"keyType" mapstructure:"keyType"`
	Content   Content   `json:"content" yaml:"content" mapstructure:"content"`
	// contains filtered or unexported fields
}

func (Request) GetChallengeProvider

func (r Request) GetChallengeProvider(environment registry.Environment, timestamp string) (challenge.Provider, error)

func (Request) GetDomains

func (r Request) GetDomains() ([]string, error)

func (Request) GetKeyType

func (r Request) GetKeyType() certcrypto.KeyType

func (Request) GetServiceUrl

func (r Request) GetServiceUrl() string

func (Request) SetPath

func (r Request) SetPath(path string) Request

type Target

type Target struct {
	Organization string `json:"organization" yaml:"organization" mapstructure:"organization"`
	Environment  string `json:"environment" yaml:"environment" mapstructure:"environment"`
}

type User

type User struct {
	Name                   string                 `json:"name" yaml:"name" mapstructure:"name"`
	Email                  string                 `json:"email" yaml:"email" mapstructure:"email"`
	ExternalAccountBinding ExternalAccountBinding `json:"eab" yaml:"eab" mapstructure:"eab"`
}