auth

Documentation

Overview

Package auth collects structures and functions around the generation and processing of credentials.

Index

• func CreateCertificate(ctx context.Context, cluster *kubernetes.Cluster, cert CertParam, ...) error
• func ExtendLocalTrust(certs string)
• func GetFirstUserAccount(ctx context.Context) (string, string, error)
• func GetUserAccounts(ctx context.Context) (*gin.Accounts, error)
• func GetUserSecretsByAge(ctx context.Context) ([]corev1.Secret, error)
• func HashBcrypt(password string) (hash string, err error)
• type CertParam
• type PasswordAuth
  • func RandomPasswordAuth() (*PasswordAuth, error)
  • func (auth *PasswordAuth) Htpassword() (string, error)
• type SecretsSortable
  • func (a SecretsSortable) Len() int
  • func (a SecretsSortable) Less(i, j int) bool
  • func (a SecretsSortable) Swap(i, j int)

Functions

func CreateCertificate

func CreateCertificate(
	ctx context.Context,
	cluster *kubernetes.Cluster,
	cert CertParam,
	owner *metav1.OwnerReference,
) error

CreateCertificate creates a certificate resource, for the given cluster issuer

func ExtendLocalTrust

func ExtendLocalTrust(certs string)

ExtendLocalTrust makes the certs found in specified PEM string available as root CA certs, beyond the standard certs. It does this by creating an in-memory pool of certs filled from both the system pool and the argument, and setting this as the cert origin for net/http's default transport. Ditto for the websocket's default dialer.

func GetFirstUserAccount

func GetFirstUserAccount(ctx context.Context) (string, string, error)

GetFirstUserAccount returns the credentials of the oldest Epinio user. This should normally be the one created during installation unless someone deleted that.

func GetUserAccounts

func GetUserAccounts(ctx context.Context) (*gin.Accounts, error)

GetUserAccounts returns all Epinio users as a gin.Accounts object to be passed to the BasicAuth middleware.

func GetUserSecretsByAge

func GetUserSecretsByAge(ctx context.Context) ([]corev1.Secret, error)

GetUserSecretsByAge returns the user BasicAuth Secrets sorted from older to younger by creationTimestamp.

func HashBcrypt

func HashBcrypt(password string) (hash string, err error)

HashBcrypt generates an Bcrypt hash for a password. See https://github.com/foomo/htpasswd for the origin of this code. MIT licensed, as per `blob/master/LICENSE.txt`

Types

type CertParam

type CertParam struct {
	Name      string
	Namespace string
	Domain    string
	Issuer    string
	Labels    map[string]string
}

CertParam describes the cert-manager certificate CRD. It's passed to CreateCertificate to create the cert-manager certificate CR.

type PasswordAuth

type PasswordAuth struct {
	Username string
	Password string
}

PasswordAuth wraps a set of password-based credentials

func RandomPasswordAuth

func RandomPasswordAuth() (*PasswordAuth, error)

RandomPasswordAuth generates a random user+password combination. Both elements are random 16-character hex strings.

func (*PasswordAuth) Htpassword

func (auth *PasswordAuth) Htpassword() (string, error)

Htpassword returns user+hash string suitable for use by Traefik's BasicAuth module.

type SecretsSortable

type SecretsSortable []corev1.Secret

func (SecretsSortable) Len

func (a SecretsSortable) Len() int

func (SecretsSortable) Less

func (a SecretsSortable) Less(i, j int) bool

func (SecretsSortable) Swap

func (a SecretsSortable) Swap(i, j int)