package hcloud import ( "bytes" "context" "encoding/json" "errors" "fmt" "net/url" "strconv" "time" "github.com/hetznercloud/hcloud-go/hcloud/schema" ) // SSHKey represents a SSH key in the Hetzner Cloud. type SSHKey struct { ID int Name string Fingerprint string PublicKey string Labels map[string]string Created time.Time } // SSHKeyClient is a client for the SSH keys API. type SSHKeyClient struct { client *Client } // GetByID retrieves a SSH key by its ID. If the SSH key does not exist, nil is returned. func (c *SSHKeyClient) GetByID(ctx context.Context, id int) (*SSHKey, *Response, error) { req, err := c.client.NewRequest(ctx, "GET", fmt.Sprintf("/ssh_keys/%d", id), nil) if err != nil { return nil, nil, err } var body schema.SSHKeyGetResponse resp, err := c.client.Do(req, &body) if err != nil { if IsError(err, ErrorCodeNotFound) { return nil, resp, nil } return nil, nil, err } return SSHKeyFromSchema(body.SSHKey), resp, nil } // GetByName retrieves a SSH key by its name. If the SSH key does not exist, nil is returned. func (c *SSHKeyClient) GetByName(ctx context.Context, name string) (*SSHKey, *Response, error) { if name == "" { return nil, nil, nil } sshKeys, response, err := c.List(ctx, SSHKeyListOpts{Name: name}) if len(sshKeys) == 0 { return nil, response, err } return sshKeys[0], response, err } // GetByFingerprint retreives a SSH key by its fingerprint. If the SSH key does not exist, nil is returned. func (c *SSHKeyClient) GetByFingerprint(ctx context.Context, fingerprint string) (*SSHKey, *Response, error) { sshKeys, response, err := c.List(ctx, SSHKeyListOpts{Fingerprint: fingerprint}) if len(sshKeys) == 0 { return nil, response, err } return sshKeys[0], response, err } // Get retrieves a SSH key by its ID if the input can be parsed as an integer, otherwise it // retrieves a SSH key by its name. If the SSH key does not exist, nil is returned. func (c *SSHKeyClient) Get(ctx context.Context, idOrName string) (*SSHKey, *Response, error) { if id, err := strconv.Atoi(idOrName); err == nil { return c.GetByID(ctx, int(id)) } return c.GetByName(ctx, idOrName) } // SSHKeyListOpts specifies options for listing SSH keys. type SSHKeyListOpts struct { ListOpts Name string Fingerprint string } func (l SSHKeyListOpts) values() url.Values { vals := l.ListOpts.values() if l.Name != "" { vals.Add("name", l.Name) } if l.Fingerprint != "" { vals.Add("fingerprint", l.Fingerprint) } return vals } // List returns a list of SSH keys for a specific page. // // Please note that filters specified in opts are not taken into account // when their value corresponds to their zero value or when they are empty. func (c *SSHKeyClient) List(ctx context.Context, opts SSHKeyListOpts) ([]*SSHKey, *Response, error) { path := "/ssh_keys?" + opts.values().Encode() req, err := c.client.NewRequest(ctx, "GET", path, nil) if err != nil { return nil, nil, err } var body schema.SSHKeyListResponse resp, err := c.client.Do(req, &body) if err != nil { return nil, nil, err } sshKeys := make([]*SSHKey, 0, len(body.SSHKeys)) for _, s := range body.SSHKeys { sshKeys = append(sshKeys, SSHKeyFromSchema(s)) } return sshKeys, resp, nil } // All returns all SSH keys. func (c *SSHKeyClient) All(ctx context.Context) ([]*SSHKey, error) { return c.AllWithOpts(ctx, SSHKeyListOpts{ListOpts: ListOpts{PerPage: 50}}) } // AllWithOpts returns all SSH keys with the given options. func (c *SSHKeyClient) AllWithOpts(ctx context.Context, opts SSHKeyListOpts) ([]*SSHKey, error) { allSSHKeys := []*SSHKey{} _, err := c.client.all(func(page int) (*Response, error) { opts.Page = page sshKeys, resp, err := c.List(ctx, opts) if err != nil { return resp, err } allSSHKeys = append(allSSHKeys, sshKeys...) return resp, nil }) if err != nil { return nil, err } return allSSHKeys, nil } // SSHKeyCreateOpts specifies parameters for creating a SSH key. type SSHKeyCreateOpts struct { Name string PublicKey string Labels map[string]string } // Validate checks if options are valid. func (o SSHKeyCreateOpts) Validate() error { if o.Name == "" { return errors.New("missing name") } if o.PublicKey == "" { return errors.New("missing public key") } return nil } // Create creates a new SSH key with the given options. func (c *SSHKeyClient) Create(ctx context.Context, opts SSHKeyCreateOpts) (*SSHKey, *Response, error) { if err := opts.Validate(); err != nil { return nil, nil, err } reqBody := schema.SSHKeyCreateRequest{ Name: opts.Name, PublicKey: opts.PublicKey, } if opts.Labels != nil { reqBody.Labels = &opts.Labels } reqBodyData, err := json.Marshal(reqBody) if err != nil { return nil, nil, err } req, err := c.client.NewRequest(ctx, "POST", "/ssh_keys", bytes.NewReader(reqBodyData)) if err != nil { return nil, nil, err } var respBody schema.SSHKeyCreateResponse resp, err := c.client.Do(req, &respBody) if err != nil { return nil, resp, err } return SSHKeyFromSchema(respBody.SSHKey), resp, nil } // Delete deletes a SSH key. func (c *SSHKeyClient) Delete(ctx context.Context, sshKey *SSHKey) (*Response, error) { req, err := c.client.NewRequest(ctx, "DELETE", fmt.Sprintf("/ssh_keys/%d", sshKey.ID), nil) if err != nil { return nil, err } return c.client.Do(req, nil) } // SSHKeyUpdateOpts specifies options for updating a SSH key. type SSHKeyUpdateOpts struct { Name string Labels map[string]string } // Update updates a SSH key. func (c *SSHKeyClient) Update(ctx context.Context, sshKey *SSHKey, opts SSHKeyUpdateOpts) (*SSHKey, *Response, error) { reqBody := schema.SSHKeyUpdateRequest{ Name: opts.Name, } if opts.Labels != nil { reqBody.Labels = &opts.Labels } reqBodyData, err := json.Marshal(reqBody) if err != nil { return nil, nil, err } path := fmt.Sprintf("/ssh_keys/%d", sshKey.ID) req, err := c.client.NewRequest(ctx, "PUT", path, bytes.NewReader(reqBodyData)) if err != nil { return nil, nil, err } respBody := schema.SSHKeyUpdateResponse{} resp, err := c.client.Do(req, &respBody) if err != nil { return nil, resp, err } return SSHKeyFromSchema(respBody.SSHKey), resp, nil }