Documentation
¶
Index ¶
- type SSHPublicKey
- func LoadPublicKeyFromString(keyMaterial string) (key *SSHPublicKey, err error)
- func LoadPublicKeysFromFile(ctx context.Context, sshKeysFile files.File) (sshKeys []*SSHPublicKey, err error)
- func MustLoadPublicKeyFromString(keyMaterial string) (key *SSHPublicKey)
- func MustLoadPublicKeysFromFile(ctx context.Context, sshKeysFile files.File) (sshKeys []*SSHPublicKey)
- func NewSSHPublicKey() (sshPublicKey *SSHPublicKey)
- func (k *SSHPublicKey) Equals(other *SSHPublicKey) (isEqual bool)
- func (k *SSHPublicKey) GetAsPublicKeyLine() (publicKeyLine string, err error)
- func (k *SSHPublicKey) GetKeyHostName() (hostName string, err error)
- func (s *SSHPublicKey) GetKeyMaterial() (keyMaterial string, err error)
- func (k *SSHPublicKey) GetKeyMaterialAsString() (keyMaterial string, err error)
- func (s *SSHPublicKey) GetKeyType() (keyType string, err error)
- func (k *SSHPublicKey) GetKeyUserAtHost() (userAtHost string, err error)
- func (s *SSHPublicKey) GetKeyUserHost() (keyUserHost string, err error)
- func (k *SSHPublicKey) GetKeyUserName() (keyUserName string, err error)
- func (k *SSHPublicKey) LoadFromSshDir(sshDirectory files.Directory, verbose bool) (err error)
- func (s *SSHPublicKey) MustGetAsPublicKeyLine() (publicKeyLine string)
- func (k *SSHPublicKey) MustGetKeyHostName() (hostName string)
- func (s *SSHPublicKey) MustGetKeyMaterial() (keyMaterial string)
- func (k *SSHPublicKey) MustGetKeyMaterialAsString() (keyMaterial string)
- func (s *SSHPublicKey) MustGetKeyUserAtHost() (userAtHost string)
- func (k *SSHPublicKey) MustGetKeyUserName() (keyUserName string)
- func (s *SSHPublicKey) MustLoadFromSshDir(sshDirectory files.Directory, verbose bool)
- func (k *SSHPublicKey) MustSetFromString(keyMaterial string)
- func (s *SSHPublicKey) MustSetKeyMaterial(keyMaterial string)
- func (s *SSHPublicKey) MustSetKeyUserHost(keyUserHost string)
- func (s *SSHPublicKey) MustSetKeyUserName(keyUserName string)
- func (s *SSHPublicKey) MustWriteToFile(ctx context.Context, outputFile files.File)
- func (k *SSHPublicKey) SetFromString(keyMaterial string) (err error)
- func (s *SSHPublicKey) SetKeyMaterial(keyMaterial string) (err error)
- func (s *SSHPublicKey) SetKeyUserHost(keyUserHost string) (err error)
- func (s *SSHPublicKey) SetKeyUserName(keyUserName string) (err error)
- func (k *SSHPublicKey) WriteToFile(ctx context.Context, outputFile files.File) (err error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type SSHPublicKey ¶
type SSHPublicKey struct {
// contains filtered or unexported fields
}
func LoadPublicKeyFromString ¶ added in v0.281.0
func LoadPublicKeyFromString(keyMaterial string) (key *SSHPublicKey, err error)
func LoadPublicKeysFromFile ¶
func MustLoadPublicKeyFromString ¶
func MustLoadPublicKeyFromString(keyMaterial string) (key *SSHPublicKey)
func MustLoadPublicKeysFromFile ¶
func MustLoadPublicKeysFromFile(ctx context.Context, sshKeysFile files.File) (sshKeys []*SSHPublicKey)
func NewSSHPublicKey ¶
func NewSSHPublicKey() (sshPublicKey *SSHPublicKey)
func (*SSHPublicKey) Equals ¶
func (k *SSHPublicKey) Equals(other *SSHPublicKey) (isEqual bool)
func (*SSHPublicKey) GetAsPublicKeyLine ¶
func (k *SSHPublicKey) GetAsPublicKeyLine() (publicKeyLine string, err error)
func (*SSHPublicKey) GetKeyHostName ¶
func (k *SSHPublicKey) GetKeyHostName() (hostName string, err error)
func (*SSHPublicKey) GetKeyMaterial ¶
func (s *SSHPublicKey) GetKeyMaterial() (keyMaterial string, err error)
func (*SSHPublicKey) GetKeyMaterialAsString ¶
func (k *SSHPublicKey) GetKeyMaterialAsString() (keyMaterial string, err error)
func (*SSHPublicKey) GetKeyType ¶ added in v0.294.0
func (s *SSHPublicKey) GetKeyType() (keyType string, err error)
Key type like "ssh-rsa" or "ssh-ed25519"
func (*SSHPublicKey) GetKeyUserAtHost ¶
func (k *SSHPublicKey) GetKeyUserAtHost() (userAtHost string, err error)
func (*SSHPublicKey) GetKeyUserHost ¶
func (s *SSHPublicKey) GetKeyUserHost() (keyUserHost string, err error)
func (*SSHPublicKey) GetKeyUserName ¶
func (k *SSHPublicKey) GetKeyUserName() (keyUserName string, err error)
func (*SSHPublicKey) LoadFromSshDir ¶
func (k *SSHPublicKey) LoadFromSshDir(sshDirectory files.Directory, verbose bool) (err error)
func (*SSHPublicKey) MustGetAsPublicKeyLine ¶
func (s *SSHPublicKey) MustGetAsPublicKeyLine() (publicKeyLine string)
func (*SSHPublicKey) MustGetKeyHostName ¶
func (k *SSHPublicKey) MustGetKeyHostName() (hostName string)
func (*SSHPublicKey) MustGetKeyMaterial ¶
func (s *SSHPublicKey) MustGetKeyMaterial() (keyMaterial string)
func (*SSHPublicKey) MustGetKeyMaterialAsString ¶
func (k *SSHPublicKey) MustGetKeyMaterialAsString() (keyMaterial string)
func (*SSHPublicKey) MustGetKeyUserAtHost ¶
func (s *SSHPublicKey) MustGetKeyUserAtHost() (userAtHost string)
func (*SSHPublicKey) MustGetKeyUserName ¶
func (k *SSHPublicKey) MustGetKeyUserName() (keyUserName string)
func (*SSHPublicKey) MustLoadFromSshDir ¶
func (s *SSHPublicKey) MustLoadFromSshDir(sshDirectory files.Directory, verbose bool)
func (*SSHPublicKey) MustSetFromString ¶
func (k *SSHPublicKey) MustSetFromString(keyMaterial string)
func (*SSHPublicKey) MustSetKeyMaterial ¶
func (s *SSHPublicKey) MustSetKeyMaterial(keyMaterial string)
func (*SSHPublicKey) MustSetKeyUserHost ¶
func (s *SSHPublicKey) MustSetKeyUserHost(keyUserHost string)
func (*SSHPublicKey) MustSetKeyUserName ¶
func (s *SSHPublicKey) MustSetKeyUserName(keyUserName string)
func (*SSHPublicKey) MustWriteToFile ¶
func (s *SSHPublicKey) MustWriteToFile(ctx context.Context, outputFile files.File)
func (*SSHPublicKey) SetFromString ¶
func (k *SSHPublicKey) SetFromString(keyMaterial string) (err error)
func (*SSHPublicKey) SetKeyMaterial ¶
func (s *SSHPublicKey) SetKeyMaterial(keyMaterial string) (err error)
func (*SSHPublicKey) SetKeyUserHost ¶
func (s *SSHPublicKey) SetKeyUserHost(keyUserHost string) (err error)
func (*SSHPublicKey) SetKeyUserName ¶
func (s *SSHPublicKey) SetKeyUserName(keyUserName string) (err error)
func (*SSHPublicKey) WriteToFile ¶
Source Files
Click to show internal directories.
Click to hide internal directories.