Create the automatic key when specified with -i #9881
+81
−37
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -20,7 +20,6 @@ import ( | |
| "github.com/cli/cli/v2/internal/codespaces/api" | ||
| "github.com/cli/cli/v2/internal/codespaces/portforwarder" | ||
| "github.com/cli/cli/v2/internal/codespaces/rpc" | ||
| "github.com/cli/cli/v2/pkg/cmdutil" | ||
| "github.com/cli/cli/v2/pkg/ssh" | ||
| "github.com/cli/safeexec" | ||
|
|
@@ -336,10 +335,20 @@ func selectSSHKeys( | |
| return nil, false, errors.New("missing value to -i argument") | ||
| } | ||
|
|
||
| privateKeyPath := args[i+1] | ||
|
|
||
| // The --config setup will set the automatic key with -i, but it might not actually be created, so we need to ensure that here | ||
| if automaticPrivateKeyPath, _ := automaticPrivateKeyPath(sshContext); automaticPrivateKeyPath == privateKeyPath { | ||
| _, err := generateAutomaticSSHKeys(sshContext) | ||
| if err != nil { | ||
| return nil, false, fmt.Errorf("generating automatic keypair: %w", err) | ||
| } | ||
| } | ||
|
|
||
| // User manually specified an identity file so just trust it is correct | ||
| return &ssh.KeyPair{ | ||
| PrivateKeyPath: privateKeyPath, | ||
| PublicKeyPath: privateKeyPath + ".pub", | ||
| }, false, nil | ||
| } | ||
|
|
||
|
|
@@ -636,7 +645,8 @@ func (a *App) printOpenSSHConfig(ctx context.Context, opts sshOptions) (err erro | |
| return fmt.Errorf("error formatting template: %w", err) | ||
| } | ||
|
|
||
| sshContext := ssh.Context{} | ||
| automaticIdentityFilePath, err := automaticPrivateKeyPath(sshContext) | ||
| if err != nil { | ||
| return fmt.Errorf("error finding .ssh directory: %w", err) | ||
| } | ||
|
|
@@ -683,8 +693,8 @@ func (a *App) printOpenSSHConfig(ctx context.Context, opts sshOptions) (err erro | |
| return status | ||
| } | ||
|
|
||
| func automaticPrivateKeyPath(sshContext ssh.Context) (string, error) { | ||
| sshDir, err := sshContext.SshDir() | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
This file contains hidden or 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,7 @@ import ( | |
| "context" | ||
| "fmt" | ||
| "os" | ||
| "path" | ||
| "path/filepath" | ||
| "strings" | ||
| "testing" | ||
|
|
@@ -68,9 +69,7 @@ func TestGenerateAutomaticSSHKeys(t *testing.T) { | |
| for _, tt := range tests { | ||
| dir := t.TempDir() | ||
|
|
||
| sshContext := ssh.NewContextForTests(dir, "") | ||
|
|
||
| for _, file := range tt.existingFiles { | ||
| f, err := os.Create(filepath.Join(dir, file)) | ||
|
|
@@ -125,6 +124,10 @@ func TestGenerateAutomaticSSHKeys(t *testing.T) { | |
| } | ||
|
|
||
| func TestSelectSSHKeys(t *testing.T) { | ||
| // This string will be subsituted in sshArgs for test cases | ||
| // This is to work around the temp test ssh dir not being known until the test is executing | ||
| substituteSSHDir := "SUB_SSH_DIR" | ||
|
|
||
| tests := []struct { | ||
| sshDirFiles []string | ||
| sshConfigKeys []string | ||
|
|
@@ -139,7 +142,7 @@ func TestSelectSSHKeys(t *testing.T) { | |
| wantKeyPair: &ssh.KeyPair{PrivateKeyPath: "custom-private-key", PublicKeyPath: "custom-private-key.pub"}, | ||
| }, | ||
| { | ||
| sshArgs: []string{"-i", path.Join(substituteSSHDir, automaticPrivateKeyName)}, | ||
| wantKeyPair: &ssh.KeyPair{PrivateKeyPath: automaticPrivateKeyName, PublicKeyPath: automaticPrivateKeyName + ".pub"}, | ||
| }, | ||
| { | ||
|
|
@@ -202,7 +205,7 @@ func TestSelectSSHKeys(t *testing.T) { | |
|
|
||
| for _, tt := range tests { | ||
| sshDir := t.TempDir() | ||
| sshContext := ssh.NewContextForTests(sshDir, "") | ||
|
|
||
| for _, file := range tt.sshDirFiles { | ||
| f, err := os.Create(filepath.Join(sshDir, file)) | ||
|
|
@@ -226,7 +229,12 @@ func TestSelectSSHKeys(t *testing.T) { | |
| t.Fatalf("could not write test config %v", err) | ||
| } | ||
|
|
||
| var subbedSSHArgs []string | ||
| for _, arg := range tt.sshArgs { | ||
| subbedSSHArgs = append(subbedSSHArgs, strings.Replace(arg, substituteSSHDir, sshDir, -1)) | ||
| } | ||
|
|
||
| tt.sshArgs = append([]string{"-F", configPath}, subbedSSHArgs...) | ||
|
|
||
| gotKeyPair, gotShouldAddArg, err := selectSSHKeys(context.Background(), sshContext, tt.sshArgs, sshOptions{profile: tt.profileOpt}) | ||
|
|
||
|
|
@@ -254,11 +262,24 @@ func TestSelectSSHKeys(t *testing.T) { | |
| } | ||
|
|
||
| // Strip the dir (sshDir) from the gotKeyPair paths so that they match wantKeyPair (which doesn't know the directory) | ||
| gotKeyPairJustFileNames := &ssh.KeyPair{ | ||
| PrivateKeyPath: filepath.Base(gotKeyPair.PrivateKeyPath), | ||
| PublicKeyPath: filepath.Base(gotKeyPair.PublicKeyPath), | ||
| } | ||
|
|
||
| if fmt.Sprintf("%v", gotKeyPairJustFileNames) != fmt.Sprintf("%v", tt.wantKeyPair) { | ||
| t.Errorf("Want selectSSHKeys result to be %v, got %v", tt.wantKeyPair, gotKeyPairJustFileNames) | ||
| } | ||
|
|
||
| // If the automatic key pair is selected, it needs to exist no matter what | ||
| if strings.Contains(tt.wantKeyPair.PrivateKeyPath, automaticPrivateKeyName) { | ||
| if _, err := os.Stat(gotKeyPair.PrivateKeyPath); err != nil { | ||
| t.Errorf("Expected automatic key pair private key to exist, but it did not") | ||
| } | ||
|
|
||
| if _, err := os.Stat(gotKeyPair.PublicKeyPath); err != nil { | ||
| t.Errorf("Expected automatic key pair public key to exist, but it did not") | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -14,8 +14,17 @@ import ( | |
| ) | ||
|
|
||
| type Context struct { | ||
| configDir string | ||
| keygenExe string | ||
| } | ||
|
|
||
| // NewContextForTests creates a new `ssh.Context` with internal properties set to the | ||
| // specified values. It should only be used to inject test-specific setup. | ||
| func NewContextForTests(configDir, keygenExe string) Context { | ||
| return Context{ | ||
| configDir, | ||
| keygenExe, | ||
| } | ||
| } | ||
|
|
||
| type KeyPair struct { | ||
|
|
@@ -26,7 +35,7 @@ type KeyPair struct { | |
| var ErrKeyAlreadyExists = errors.New("SSH key already exists") | ||
|
|
||
| func (c *Context) LocalPublicKeys() ([]string, error) { | ||
| sshDir, err := c.SshDir() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
@@ -45,7 +54,7 @@ func (c *Context) GenerateSSHKey(keyName string, passphrase string) (*KeyPair, e | |
| return nil, err | ||
| } | ||
|
|
||
| sshDir, err := c.SshDir() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
@@ -79,20 +88,20 @@ func (c *Context) GenerateSSHKey(keyName string, passphrase string) (*KeyPair, e | |
| return &keyPair, nil | ||
| } | ||
|
|
||
| func (c *Context) SshDir() (string, error) { | ||
| if c.configDir != "" { | ||
| return c.configDir, nil | ||
| } | ||
| dir, err := config.HomeDirPath(".ssh") | ||
| if err == nil { | ||
| c.configDir = dir | ||
| } | ||
| return dir, err | ||
| } | ||
|
|
||
| func (c *Context) findKeygen() (string, error) { | ||
| if c.keygenExe != "" { | ||
| return c.keygenExe, nil | ||
| } | ||
|
|
||
| keygenExe, err := safeexec.LookPath("ssh-keygen") | ||
|
|
@@ -107,7 +116,7 @@ func (c *Context) findKeygen() (string, error) { | |
| } | ||
|
|
||
| if err == nil { | ||
| c.keygenExe = keygenExe | ||
| } | ||
| return keygenExe, err | ||
| } |
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.