Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

droplet create command: Support ed25519 SSH keys #328

Merged
merged 1 commit into from
Oct 17, 2022
Merged

droplet create command: Support ed25519 SSH keys #328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
186 changes: 101 additions & 85 deletions cmd/droplet_create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
)

var client *digitalocean.Client
var defaultSshKeys = []string{"~/.ssh/id_ed25519.pub", "~/.ssh/id_rsa.pub"}

func NewDropletCreateCommand(ui cli.Ui, trellis *trellis.Trellis) *DropletCreateCommand {
c := &DropletCreateCommand{UI: ui, Trellis: trellis}
Expand All @@ -44,7 +45,7 @@ type DropletCreateCommand struct {
func (c *DropletCreateCommand) init() {
c.flags = flag.NewFlagSet("", flag.ContinueOnError)
c.flags.Usage = func() { c.UI.Info(c.Help()) }
c.flags.StringVar(&c.sshKey, "ssh-key", "~/.ssh/id_rsa.pub", "Path to SSH public key to automatically add to new server")
c.flags.StringVar(&c.sshKey, "ssh-key", "", "Path to SSH public key to automatically add to new server")
c.flags.StringVar(&c.region, "region", "", "Region to create the server in")
c.flags.StringVar(&c.image, "image", "ubuntu-20-04-x64", "Server image")
c.flags.StringVar(&c.size, "size", "", "Server size/type to create")
Expand Down Expand Up @@ -94,24 +95,20 @@ func (c *DropletCreateCommand) Run(args []string) int {

client = digitalocean.NewClient(accessToken)

if c.sshKey == "" {
c.UI.Error("Error: --ssh-key option is empty")
return 1
sshKeyPath, contents, publicKey, err := c.loadSSHKey(defaultSshKeys)
if err == nil {
err = c.checkSSHKey(sshKeyPath, contents, publicKey)
}

keyString, publicKey, err := loadSSHKey(c.sshKey)
if err != nil {
c.UI.Error(fmt.Sprintf("Error: no valid SSH public key found at %s", c.sshKey))
return 1
}

err = checkSSHKey(c.UI, keyString, publicKey)

if err != nil {
c.UI.Error("Error: can't continue without an SSH key")
c.UI.Error(err.Error())
c.UI.Error("\nThe --ssh-key option can be used to specify the path of a valid SSH key.")
return 1
}

c.UI.Info(fmt.Sprintf("Using SSH key at %s\n", sshKeyPath))

var region *godo.Region

if c.region == "" {
Expand Down Expand Up @@ -172,6 +169,69 @@ func (c *DropletCreateCommand) Run(args []string) int {
return 0
}

func (c *DropletCreateCommand) Synopsis() string {
return "Creates a DigitalOcean Droplet server and provisions it"
}

func (c *DropletCreateCommand) Help() string {
helpText := `
Usage: trellis droplet create [options] ENVIRONMENT

Creates a droplet (server) on DigitalOcean for the environment specified.

Only remote servers (for staging and production) are currently supported.
Development should be managed separately through Vagrant.

This command requires a DigitalOcean personal access token.
Link: https://cloud.digitalocean.com/account/api/tokens/new

If the DIGITALOCEAN_ACCESS_TOKEN environment variable is not set, the command
will prompt for one.

Create a production server (region and size will be prompted):

$ trellis droplet create production

Create a 1gb server in the nyc3 region:

$ trellis droplet create --region=nyc3 --size=s-1vcpu-1gb production

Create a 1gb server with a specific Ubuntu image:

$ trellis droplet create --region=nyc3 --image=ubuntu-18-04-x64 --size=s-1vcpu-1gb production

Create a server but skip provisioning:

$ trellis droplet create --skip-provision production

Arguments:
ENVIRONMENT Name of environment (ie: production)

Options:
--region Region to create the server in
--image (default: ubuntu-20-04-x64) Server image (ie: Linux distribution)
--size Server size/type
--skip-provision Skip provision after server is created
--ssh-key (default: ~/.ssh/id_rsa.pub or ~/.ssh/id_ed25519.pub) path to SSH public key to be added on the server
-h, --help show this help
`

return strings.TrimSpace(helpText)
}

func (c *DropletCreateCommand) AutocompleteArgs() complete.Predictor {
return c.Trellis.PredictEnvironment(c.flags)
}

func (c *DropletCreateCommand) AutocompleteFlags() complete.Flags {
return complete.Flags{
"--region": complete.PredictNothing,
"--size": complete.PredictNothing,
"--skip--provision": complete.PredictNothing,
"--ssh-key": complete.PredictFiles("*.pub"),
}
}

func askDropletName(ui cli.Ui, siteName string) (name string, err error) {
name, err = ui.Ask(fmt.Sprintf("Droplet name [%s]:", color.GreenString(siteName)))
if err != nil {
Expand Down Expand Up @@ -280,12 +340,33 @@ func checkSSH(host string, ctx context.Context) (err error) {
}
}

func checkSSHKey(ui cli.Ui, keyString string, publicKey ssh.PublicKey) error {
func (c *DropletCreateCommand) loadSSHKey(sshKeys []string) (keyPath string, contents []byte, publicKey ssh.PublicKey, err error) {
if c.sshKey != "" {
sshKeys = []string{c.sshKey}
}

for _, path := range sshKeys {
keyPath = path
contents, publicKey, err = loadPublicKey(path)

if err == nil {
break
}
}

if publicKey == nil {
return "", nil, nil, fmt.Errorf("No valid SSH public key found. Attempted paths: %s", strings.Join(sshKeys, ", "))
}

return keyPath, contents, publicKey, err
}

func (c *DropletCreateCommand) checkSSHKey(path string, contents []byte, publicKey ssh.PublicKey) error {
response, err := client.GetSSHKey(publicKey)

switch response.StatusCode {
case 404:
ui.Info("SSH Key does not exist in DigitalOcean.")
c.UI.Info(fmt.Sprintf("SSH Key [%s] does not exist in DigitalOcean.", path))

prompt := promptui.Prompt{
Label: "Add SSH key to account",
Expand All @@ -298,29 +379,27 @@ func checkSSHKey(ui cli.Ui, keyString string, publicKey ssh.PublicKey) error {
return errors.New("Can't continue without an SSH key on your account.")
}

return client.CreateSSHKey(keyString)
return client.CreateSSHKey(string(contents))
case 200:
return nil
default:
return err
return fmt.Errorf("Could not create SSH key on DigitalOcean: %v", err)
}
}

func loadSSHKey(path string) (keyString string, publicKey ssh.PublicKey, err error) {
func loadPublicKey(path string) (contents []byte, publicKey ssh.PublicKey, err error) {
path, err = homedir.Expand(path)
key, err := os.ReadFile(path)
if err != nil {
return "", nil, err
return nil, nil, err
}

publicKey, _, _, _, err = ssh.ParseAuthorizedKey(key)
if err != nil {
return "", nil, err
return nil, nil, err
}

keyString = string(key)

return keyString, publicKey, nil
return key, publicKey, nil
}

func selectRegion() (region *godo.Region, err error) {
Expand Down Expand Up @@ -382,66 +461,3 @@ func selectSize(region *godo.Region) (size string, err error) {

return sizes[i].Slug, nil
}

func (c *DropletCreateCommand) Synopsis() string {
return "Creates a DigitalOcean Droplet server and provisions it"
}

func (c *DropletCreateCommand) Help() string {
helpText := `
Usage: trellis droplet create [options] ENVIRONMENT

Creates a droplet (server) on DigitalOcean for the environment specified.

Only remote servers (for staging and production) are currently supported.
Development should be managed separately through Vagrant.

This command requires a DigitalOcean personal access token.
Link: https://cloud.digitalocean.com/account/api/tokens/new

If the DIGITALOCEAN_ACCESS_TOKEN environment variable is not set, the command
will prompt for one.

Create a production server (region and size will be prompted):

$ trellis droplet create production

Create a 1gb server in the nyc3 region:

$ trellis droplet create --region=nyc3 --size=s-1vcpu-1gb production

Create a 1gb server with a specific Ubuntu image:

$ trellis droplet create --region=nyc3 --image=ubuntu-18-04-x64 --size=s-1vcpu-1gb production

Create a server but skip provisioning:

$ trellis droplet create --skip-provision production

Arguments:
ENVIRONMENT Name of environment (ie: production)

Options:
--region Region to create the server in
--image (default: ubuntu-20-04-x64) Server image (ie: Linux distribution)
--size Server size/type
--skip-provision Skip provision after server is created
--ssh-key (default: ~/.ssh/id_rsa.pub) path to SSH public key to be added on the server
-h, --help show this help
`

return strings.TrimSpace(helpText)
}

func (c *DropletCreateCommand) AutocompleteArgs() complete.Predictor {
return c.Trellis.PredictEnvironment(c.flags)
}

func (c *DropletCreateCommand) AutocompleteFlags() complete.Flags {
return complete.Flags{
"--region": complete.PredictNothing,
"--size": complete.PredictNothing,
"--skip--provision": complete.PredictNothing,
"--ssh-key": complete.PredictFiles("*.pub"),
}
}
3 changes: 2 additions & 1 deletion digitalocean/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package digitalocean

import (
"context"
"fmt"
"os/user"
"sort"
"strings"
Expand Down Expand Up @@ -70,7 +71,7 @@ func (do *Client) CreateSSHKey(key string) error {
_, _, err = do.Client.Keys.Create(ctx, createRequest)

if err != nil {
return err
return fmt.Errorf("Could not create SSH key on DigitalOcean: %v", err)
}

return nil
Expand Down