-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Discover keypaths from ssh_config, update agent key selection logic (#73
) * Using an explicit path to a private key If the key is not passphrase protected, use it as-is If it is password protected, search for a public key in <path>.pub. If the file is found, look for the key in agent. (there's no way to check if an encrypted private key is known by the agent without decrypting it with a passphrase. Tools like ssh-keygen will also look for the .pub in similar cases) If there's no agent or the key is not found in it, use PasswordCallback if implemented, otherwise fail with an error. * Using an explicit path to a public key (new!) Now you can also give a path to a public key -- if agent is available and a private key for that public key is available on the agent, use it from the agent * Getting keypath from ssh_config (new!) If you give an empty/null keypath, ssh_config is queried for an IdentityFile (can be multiple). If it fails, fall back to using a list of hardcoded defaults (was just ~/.ssh/id_rsa, now it is [~/.ssh/identity, ~/.ssh/id_rsa, ~/.ssh/id_dsa]). * Auth method caching If the same keypath is used for multiple hosts, it will only be loaded once, so you don't have to enter passphrases multiple times for the same keys. * Agent fallback The whole list of keys from agent will only be used when the keypath wasn't explicitly set for the host either in KeyPath: or in ssh_config. * Integration test suite Added a simplistic integration test suite using footloose and cmd/rigtest. Signed-off-by: Kimmo Lehto <klehto@mirantis.com>
- Loading branch information
Showing
13 changed files
with
591 additions
and
114 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| test/rigtest | ||
| test/footloose.yaml | ||
| test/Library | ||
| test/.ssh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "flag" | ||
| "fmt" | ||
| goos "os" | ||
| "strconv" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/k0sproject/rig" | ||
| "github.com/k0sproject/rig/exec" | ||
| "github.com/k0sproject/rig/os" | ||
| "github.com/k0sproject/rig/os/registry" | ||
| _ "github.com/k0sproject/rig/os/support" | ||
| "github.com/kevinburke/ssh_config" | ||
| ) | ||
|
|
||
| type configurer interface { | ||
| WriteFile(os.Host, string, string, string) error | ||
| LineIntoFile(os.Host, string, string, string) error | ||
| ReadFile(os.Host, string) (string, error) | ||
| FileExist(os.Host, string) bool | ||
| DeleteFile(os.Host, string) error | ||
| Stat(os.Host, string, ...exec.Option) (*os.FileInfo, error) | ||
| } | ||
|
|
||
| // Host is a host that utilizes rig for connections | ||
| type Host struct { | ||
| rig.Connection | ||
|
|
||
| Configurer configurer | ||
| } | ||
|
|
||
| // LoadOS is a function that assigns a OS support package to the host and | ||
| // typecasts it to a suitable interface | ||
| func (h *Host) LoadOS() error { | ||
| bf, err := registry.GetOSModuleBuilder(*h.OSVersion) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| h.Configurer = bf().(configurer) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func main() { | ||
| dh := flag.String("host", "127.0.0.1", "target host [+ :port], can give multiple comma separated") | ||
| usr := flag.String("user", "root", "user name") | ||
| kp := flag.String("keypath", "", "keypath") | ||
| pc := flag.Bool("askpass", false, "ask passwords") | ||
|
|
||
| fn := fmt.Sprintf("test_%s.txt", time.Now().Format("20060102150405")) | ||
|
|
||
| flag.Parse() | ||
|
|
||
| if *dh == "" { | ||
| println("see -help") | ||
| goos.Exit(1) | ||
| } | ||
|
|
||
| if configPath := goos.Getenv("SSH_CONFIG"); configPath != "" { | ||
| f, err := goos.Open(configPath) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| cfg, err := ssh_config.Decode(f) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| rig.SSHConfigGetAll = func(dst, key string) []string { | ||
| res, err := cfg.GetAll(dst, key) | ||
| if err != nil { | ||
| return nil | ||
| } | ||
| return res | ||
| } | ||
| } | ||
|
|
||
| var passfunc func() (string, error) | ||
| if *pc { | ||
| passfunc = func() (string, error) { | ||
| var pass string | ||
| fmt.Print("Password: ") | ||
| fmt.Scanln(&pass) | ||
| return pass, nil | ||
| } | ||
| } | ||
|
|
||
| var hosts []Host | ||
|
|
||
| for _, address := range strings.Split(*dh, ",") { | ||
| port := 22 | ||
| if addr, portstr, ok := strings.Cut(address, ":"); ok { | ||
| address = addr | ||
| p, err := strconv.Atoi(portstr) | ||
| if err != nil { | ||
| panic("invalid port " + portstr) | ||
| } | ||
| port = p | ||
| } | ||
|
|
||
| h := Host{ | ||
| Connection: rig.Connection{ | ||
| SSH: &rig.SSH{ | ||
| Address: address, | ||
| Port: port, | ||
| User: *usr, | ||
| KeyPath: kp, | ||
| PasswordCallback: passfunc, | ||
| }, | ||
| }, | ||
| } | ||
| hosts = append(hosts, h) | ||
| } | ||
|
|
||
| for _, h := range hosts { | ||
| if err := h.Connect(); err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| if err := h.LoadOS(); err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| if err := h.Configurer.WriteFile(h, fn, "test\ntest2\ntest3", "0644"); err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| if err := h.Configurer.LineIntoFile(h, fn, "test2", "test4"); err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| if !h.Configurer.FileExist(h, fn) { | ||
| panic("file does not exist") | ||
| } | ||
|
|
||
| row, err := h.Configurer.ReadFile(h, fn) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| if row != "test\ntest4\ntest3" { | ||
| panic("file content is not correct") | ||
| } | ||
|
|
||
| stat, err := h.Configurer.Stat(h, fn) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| if !strings.HasSuffix(stat.FName, fn) { | ||
| panic("file stat is not correct") | ||
| } | ||
|
|
||
| if err := h.Configurer.DeleteFile(h, fn); err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| if h.Configurer.FileExist(h, fn) { | ||
| panic("file still exists") | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.