fa3e5dcc6e
* Feature + Test + Documentation: added no-auth ssh health cheack feature, changed documentation to fit new behavior, added ssh test cases. * Refactor: refactored authenticate field to infer from username and password insted of specifying it inside config. * Refactor: removed non used field. * Refactor: changed error, removed spaces. * Refactor: added comments.
34 lines
1.0 KiB
Go
34 lines
1.0 KiB
Go
package ssh
|
|
|
|
import (
|
|
"errors"
|
|
)
|
|
|
|
var (
|
|
// ErrEndpointWithoutSSHUsername is the error with which Gatus will panic if an endpoint with SSH monitoring is configured without a user.
|
|
ErrEndpointWithoutSSHUsername = errors.New("you must specify a username for each SSH endpoint")
|
|
|
|
// ErrEndpointWithoutSSHPassword is the error with which Gatus will panic if an endpoint with SSH monitoring is configured without a password.
|
|
ErrEndpointWithoutSSHPassword = errors.New("you must specify a password for each SSH endpoint")
|
|
)
|
|
|
|
type Config struct {
|
|
Username string `yaml:"username,omitempty"`
|
|
Password string `yaml:"password,omitempty"`
|
|
}
|
|
|
|
// Validate the SSH configuration
|
|
func (cfg *Config) Validate() error {
|
|
// If there's no username and password, this endpoint can still check the SSH banner, so the endpoint is still valid
|
|
if len(cfg.Username) == 0 && len(cfg.Password) == 0 {
|
|
return nil
|
|
}
|
|
if len(cfg.Username) == 0 {
|
|
return ErrEndpointWithoutSSHUsername
|
|
}
|
|
if len(cfg.Password) == 0 {
|
|
return ErrEndpointWithoutSSHPassword
|
|
}
|
|
return nil
|
|
}
|