net.Conn for pageant with example and tests #16
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| // based on [pageant](https://github.com/kbolino/pageant) of Kristian Bolino | ||
| package main | ||
|
|
||
| import ( | ||
| "log" | ||
| "os" | ||
|
|
||
| sshagent "github.com/xanzy/ssh-agent" | ||
| "golang.org/x/crypto/ssh" | ||
| ) | ||
|
|
||
| // This example requires all of the following to work: | ||
| // - environment variable PAGEANT_TEST_SSH_ADDR is set to a valid SSH | ||
| // server address (host:port) | ||
| // - environment variable PAGEANT_TEST_SSH_USER is set to a user name | ||
| // that the SSH server recognizes | ||
| // - Pageant is running on the local machine | ||
| // - Pageant has a key that is authorized for the user on the server | ||
| func main() { | ||
| sshAgent, pageantConn, err := sshagent.New() | ||
| if err != nil { | ||
| log.Fatalf("error on New: %s", err) | ||
| } | ||
| defer pageantConn.Close() | ||
| keys, err := sshAgent.List() | ||
| if err != nil { | ||
| log.Fatalf("error on agent.List: %s", err) | ||
| } | ||
| if len(keys) == 0 { | ||
| log.Fatalf("no keys listed by Pagent") | ||
| } | ||
| for i, key := range keys { | ||
| log.Printf("key %d: %s %s\n", i, key.Comment, ssh.FingerprintSHA256(key)) | ||
| } | ||
|
|
||
| signers, err := sshAgent.Signers() | ||
| if err != nil { | ||
| log.Fatalf("cannot obtain signers from SSH agent: %s", err) | ||
| } | ||
| sshUser := os.Getenv("PAGEANT_TEST_SSH_USER") | ||
| config := ssh.ClientConfig{ | ||
| Auth: []ssh.AuthMethod{ssh.PublicKeys(signers...)}, | ||
| HostKeyCallback: ssh.InsecureIgnoreHostKey(), | ||
| User: sshUser, | ||
| } | ||
| sshAddr := os.Getenv("PAGEANT_TEST_SSH_ADDR") | ||
| sshConn, err := ssh.Dial("tcp", sshAddr, &config) | ||
| if err != nil { | ||
| log.Fatalf("failed to connect to %s@%s due to error: %s", sshUser, sshAddr, err) | ||
| } | ||
| sshConn.Close() | ||
| } |
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 |
|---|---|---|
|
|
@@ -4,6 +4,6 @@ go 1.16 | |
|
|
||
| require ( | ||
| github.com/Microsoft/go-winio v0.5.2 | ||
| golang.org/x/crypto v0.19.0 | ||
| golang.org/x/sys v0.17.0 | ||
| ) | ||
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
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,40 @@ | ||
| // based on [pageant](https://github.com/kbolino/pageant) of Kristian Bolino | ||
|
|
||
| package sshagent | ||
|
|
||
| import ( | ||
| "testing" | ||
| ) | ||
|
|
||
| // Pageant must be running for this test to work. | ||
| func TestNew(t *testing.T) { | ||
| _, conn, err := New() | ||
| if err != nil { | ||
| t.Fatalf("error on New: %s", err) | ||
| } else if conn == nil { | ||
| t.Fatalf("New returned nil") | ||
| } | ||
| err = conn.Close() | ||
| if err != nil { | ||
| t.Fatalf("error on Conn.Close: %s", err) | ||
| } | ||
| } | ||
|
|
||
| // Pageant must be running and have at least 1 key loaded for this test to work. | ||
| func TestSSHAgentList(t *testing.T) { | ||
| sshAgent, conn, err := New() | ||
| if err != nil { | ||
| t.Fatalf("error on New: %s", err) | ||
| } | ||
| defer conn.Close() | ||
| keys, err := sshAgent.List() | ||
| if err != nil { | ||
| t.Fatalf("error on agent.List: %s", err) | ||
| } | ||
| if len(keys) == 0 { | ||
| t.Fatalf("no keys listed by Pagent") | ||
| } | ||
| for i, key := range keys { | ||
| t.Logf("key %d: %s", i, key.Comment) | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the point of returning a fake
net.Connhere instead of just returningnilto indicate to a user there is no underlyingnet.Connconnection to be managed/closed?I think we should omit this and also remove the methods you added
for similarity with net.Conn.I think