config

package

v0.18.0 Latest Latest Go to latest Published: Jun 23, 2026 License: Apache-2.0 Imports: 15 Imported by: 0

Details

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

Repository

github.com/andrewheberle/ssh-ca-client

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Variables
func ConfigDirs() (user, system string, err error)
func LogDir() (string, error)
type ClientOIDCConfig
type Config
- func LoadConfig(system, user string, opts ...ConfigOption) (*Config, error)
- func LoadUserConfigOnly(name string, opts ...ConfigOption) (*Config, error)
type ConfigOption
- func WithPersistence(p persistence.Persistence) ConfigOption
- func WithProtector(p protect.Protector) ConfigOption
type SystemConfig
- func (c *SystemConfig) CertificateAuthority() ssh.PublicKey

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNoPrivateKey   = errors.New("no private key found")
	ErrNoCertificate  = errors.New("no certificate found")
	ErrNoRefreshToken = errors.New("no refresh token found")
)

Functions ¶

func ConfigDirs ¶

func ConfigDirs() (user, system string, err error)

func LogDir ¶

func LogDir() (string, error)

Types ¶

type ClientOIDCConfig ¶

type ClientOIDCConfig struct {
	Issuer      string   `json:"issuer"`
	ClientID    string   `json:"client_id"`
	Scopes      []string `json:"scopes"`
	RedirectURL string   `json:"redirect_url"`
}

type Config ¶

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

func LoadConfig ¶

func LoadConfig(system, user string, opts ...ConfigOption) (*Config, error)

func LoadUserConfigOnly ¶

func LoadUserConfigOnly(name string, opts ...ConfigOption) (*Config, error)

func (*Config) CertificateAuthority ¶

func (c *Config) CertificateAuthority() ssh.PublicKey

CertificateAuthority returns the CA PublicKey

func (*Config) CertificateAuthorityURL ¶

func (c *Config) CertificateAuthorityURL() string

func (*Config) CertificateExpiry ¶ added in v0.17.7

func (c *Config) CertificateExpiry() time.Time

func (*Config) CertificateValid ¶

func (c *Config) CertificateValid() bool

func (*Config) GetCertificateBytes ¶

func (c *Config) GetCertificateBytes() ([]byte, error)

func (*Config) GetPrivateKeyBytes ¶

func (c *Config) GetPrivateKeyBytes() ([]byte, error)

GetPrivateKeyBytes returns a []byte slice that contains the users unencrypted SSH private key. It is up to the caller to ensure this is handled securely.

func (*Config) GetPublicKeyBytes ¶

func (c *Config) GetPublicKeyBytes() ([]byte, error)

func (*Config) GetRefreshToken ¶

func (c *Config) GetRefreshToken() (string, error)

func (*Config) HasCertificate ¶

func (c *Config) HasCertificate() bool

func (*Config) HasPrivateKey ¶

func (c *Config) HasPrivateKey() bool

func (*Config) Oidc ¶

func (c *Config) Oidc() ClientOIDCConfig

func (*Config) Save ¶

func (c *Config) Save() error

func (*Config) SetCertificateBytes ¶

func (c *Config) SetCertificateBytes(pemBytes []byte) error

func (*Config) SetPrivateKeyBytes ¶

func (c *Config) SetPrivateKeyBytes(pemBytes []byte) error

SetPrivateKeyBytes encrypts and persists the PEM private key []byte slice via [Persistence]

func (*Config) SetRefreshToken ¶

func (c *Config) SetRefreshToken(token string) error

func (*Config) Signer ¶

func (c *Config) Signer() (ssh.Signer, error)

Signer returns a ssh.Signer

func (*Config) System ¶

func (c *Config) System() *SystemConfig

CertificateAuthority returns the CA PublicKey

type ConfigOption ¶ added in v0.17.8

type ConfigOption func(*Config)

Options for *Config

func WithPersistence ¶ added in v0.17.8

func WithPersistence(p persistence.Persistence) ConfigOption

func WithProtector ¶ added in v0.17.8

func WithProtector(p protect.Protector) ConfigOption

type SystemConfig ¶

type SystemConfig struct {
	Issuer                      string   `json:"issuer"`
	ClientID                    string   `json:"client_id"`
	Scopes                      []string `json:"scopes"`
	RedirectURL                 string   `json:"redirect_url"`
	CertificateAuthorityURL     string   `json:"ca_url"`
	TrustedCertificateAuthority string   `json:"trusted_ca"`
	// contains filtered or unexported fields
}

func (*SystemConfig) CertificateAuthority ¶

func (c *SystemConfig) CertificateAuthority() ssh.PublicKey

Source Files ¶

View all Source files

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