lego

Documentation

Index

• func CreateNonExistingFolder(path string) error
• func GenerateCertificate(ctx *global.CertcliOptions, domain []string) (*certificate.Resource, error)
• func GetKeyType(ctx *global.CertcliOptions) certcrypto.KeyType
• func LaunchHook(hook string, meta map[string]string) error
• func ReadCSRFile(filename string) (*x509.CertificateRequest, error)
• func SetupChallenges(ctx *global.CertcliOptions, client *lego.Client)
• type Account
  • func Setup(ctx *global.CertcliOptions, accountsStorage *AccountsStorage) (*Account, *lego.Client)
  • func (a *Account) GetEmail() string
  • func (a *Account) GetPrivateKey() crypto.PrivateKey
  • func (a *Account) GetRegistration() *registration.Resource
• type AccountsStorage
  • func NewAccountsStorage(ctx *global.CertcliOptions, domains []string) *AccountsStorage
  • func (s *AccountsStorage) ExistsAccountFilePath() bool
  • func (s *AccountsStorage) GetPrivateKey(keyType certcrypto.KeyType) crypto.PrivateKey
  • func (s *AccountsStorage) GetRootPath() string
  • func (s *AccountsStorage) GetRootUserPath() string
  • func (s *AccountsStorage) GetUserID() string
  • func (s *AccountsStorage) LoadAccount(privateKey crypto.PrivateKey) *Account
  • func (s *AccountsStorage) Save(account *Account) error
• type CertificatesStorage
  • func NewCertificatesStorage(ctx *global.CertcliOptions, domains []string) *CertificatesStorage
  • func (s *CertificatesStorage) CreateArchiveFolder()
  • func (s *CertificatesStorage) CreateRootFolder()
  • func (s *CertificatesStorage) ExistsFile(domain, extension string) bool
  • func (s *CertificatesStorage) GetFileName(domain, extension string) string
  • func (s *CertificatesStorage) GetRootPath() string
  • func (s *CertificatesStorage) MoveToArchive(domain string) error
  • func (s *CertificatesStorage) ReadCertificate(domain, extension string) ([]*x509.Certificate, error)
  • func (s *CertificatesStorage) ReadFile(domain, extension string) ([]byte, error)
  • func (s *CertificatesStorage) ReadResource(domain string) certificate.Resource
  • func (s *CertificatesStorage) SaveResource(certRes *certificate.Resource)
  • func (s *CertificatesStorage) WriteCertificateFiles(domain string, certRes *certificate.Resource) error
  • func (s *CertificatesStorage) WriteFile(domain, extension string, data []byte) error
  • func (s *CertificatesStorage) WritePFXFile(domain string, certRes *certificate.Resource) error
• type MyUser
  • func (u *MyUser) GetEmail() string
  • func (u *MyUser) GetPrivateKey() crypto.PrivateKey
  • func (u MyUser) GetRegistration() *registration.Resource

Functions

func CreateNonExistingFolder

func CreateNonExistingFolder(path string) error

func GenerateCertificate

func GenerateCertificate(ctx *global.CertcliOptions, domain []string) (*certificate.Resource, error)

func GetKeyType

func GetKeyType(ctx *global.CertcliOptions) certcrypto.KeyType

getKeyType the type from which private keys should be generated.

func LaunchHook

func LaunchHook(hook string, meta map[string]string) error

func ReadCSRFile

func ReadCSRFile(filename string) (*x509.CertificateRequest, error)

func SetupChallenges

func SetupChallenges(ctx *global.CertcliOptions, client *lego.Client)

Types

type Account

type Account struct {
	Email        string                 `json:"email"`
	Registration *registration.Resource `json:"registration"`
	// contains filtered or unexported fields
}

Account represents a users local saved credentials.

func Setup

func Setup(ctx *global.CertcliOptions, accountsStorage *AccountsStorage) (*Account, *lego.Client)

func (*Account) GetEmail

func (a *Account) GetEmail() string

GetEmail returns the email address for the account.

func (*Account) GetPrivateKey

func (a *Account) GetPrivateKey() crypto.PrivateKey

GetPrivateKey returns the private RSA account key.

func (*Account) GetRegistration

func (a *Account) GetRegistration() *registration.Resource

GetRegistration returns the server registration.

type AccountsStorage

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

AccountsStorage A storage for account data.

rootPath:

./.lego/accounts/
     │      └── root accounts directory
     └── "path" option

rootUserPath:

./.lego/accounts/localhost_14000/hubert@hubert.com/
     │      │             │             └── userID ("email" option)
     │      │             └── CA server ("server" option)
     │      └── root accounts directory
     └── "path" option

keysPath:

./.lego/accounts/localhost_14000/hubert@hubert.com/keys/
     │      │             │             │           └── root keys directory
     │      │             │             └── userID ("email" option)
     │      │             └── CA server ("server" option)
     │      └── root accounts directory
     └── "path" option

accountFilePath:

./.lego/accounts/localhost_14000/hubert@hubert.com/account.json
     │      │             │             │             └── account file
     │      │             │             └── userID ("email" option)
     │      │             └── CA server ("server" option)
     │      └── root accounts directory
     └── "path" option

func NewAccountsStorage

func NewAccountsStorage(ctx *global.CertcliOptions, domains []string) *AccountsStorage

NewAccountsStorage Creates a new AccountsStorage.

func (*AccountsStorage) ExistsAccountFilePath

func (s *AccountsStorage) ExistsAccountFilePath() bool

func (*AccountsStorage) GetPrivateKey

func (s *AccountsStorage) GetPrivateKey(keyType certcrypto.KeyType) crypto.PrivateKey

func (*AccountsStorage) GetRootPath

func (s *AccountsStorage) GetRootPath() string

func (*AccountsStorage) GetRootUserPath

func (s *AccountsStorage) GetRootUserPath() string

func (*AccountsStorage) GetUserID

func (s *AccountsStorage) GetUserID() string

func (*AccountsStorage) LoadAccount

func (s *AccountsStorage) LoadAccount(privateKey crypto.PrivateKey) *Account

func (*AccountsStorage) Save

func (s *AccountsStorage) Save(account *Account) error

type CertificatesStorage

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

CertificatesStorage a certificates' storage.

rootPath:

./.lego/certificates/
     │      └── root certificates directory
     └── "path" option

archivePath:

./.lego/archives/
     │      └── archived certificates directory
     └── "path" option

func NewCertificatesStorage

func NewCertificatesStorage(ctx *global.CertcliOptions, domains []string) *CertificatesStorage

NewCertificatesStorage create a new certificates storage.

func (*CertificatesStorage) CreateArchiveFolder

func (s *CertificatesStorage) CreateArchiveFolder()

func (*CertificatesStorage) CreateRootFolder

func (s *CertificatesStorage) CreateRootFolder()

func (*CertificatesStorage) ExistsFile

func (s *CertificatesStorage) ExistsFile(domain, extension string) bool

func (*CertificatesStorage) GetFileName

func (s *CertificatesStorage) GetFileName(domain, extension string) string

func (*CertificatesStorage) GetRootPath

func (s *CertificatesStorage) GetRootPath() string

func (*CertificatesStorage) MoveToArchive

func (s *CertificatesStorage) MoveToArchive(domain string) error

func (*CertificatesStorage) ReadCertificate

func (s *CertificatesStorage) ReadCertificate(domain, extension string) ([]*x509.Certificate, error)

func (*CertificatesStorage) ReadFile

func (s *CertificatesStorage) ReadFile(domain, extension string) ([]byte, error)

func (*CertificatesStorage) ReadResource

func (s *CertificatesStorage) ReadResource(domain string) certificate.Resource

func (*CertificatesStorage) SaveResource

func (s *CertificatesStorage) SaveResource(certRes *certificate.Resource)

func (*CertificatesStorage) WriteCertificateFiles

func (s *CertificatesStorage) WriteCertificateFiles(domain string, certRes *certificate.Resource) error

func (*CertificatesStorage) WriteFile

func (s *CertificatesStorage) WriteFile(domain, extension string, data []byte) error

func (*CertificatesStorage) WritePFXFile

func (s *CertificatesStorage) WritePFXFile(domain string, certRes *certificate.Resource) error

type MyUser

type MyUser struct {
	Email        string
	Registration *registration.Resource
	// contains filtered or unexported fields
}

func (*MyUser) GetEmail

func (u *MyUser) GetEmail() string

func (*MyUser) GetPrivateKey

func (u *MyUser) GetPrivateKey() crypto.PrivateKey

func (MyUser) GetRegistration

func (u MyUser) GetRegistration() *registration.Resource