Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Add support for User SSH signing keys #2482

Merged
merged 1 commit into from Oct 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS
Expand Up @@ -59,6 +59,7 @@ Beyang Liu <beyang.liu@gmail.com>
Billy Keyes <bluekeyes@gmail.com>
Billy Lynch <wlynch92@gmail.com>
Björn Häuser <b.haeuser@rebuy.de>
Bjorn Neergaard <bjorn@neersighted.com>
boljen <bol.christophe@gmail.com>
Brad Harris <bmharris@gmail.com>
Brad Moylan <moylan.brad@gmail.com>
Expand Down
32 changes: 32 additions & 0 deletions github/github-accessors.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

40 changes: 40 additions & 0 deletions github/github-accessors_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 13 additions & 0 deletions github/github-stringify_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions github/users_keys_test.go
Expand Up @@ -138,12 +138,12 @@ func TestUsersService_CreateKey(t *testing.T) {
ctx := context.Background()
key, _, err := client.Users.CreateKey(ctx, input)
if err != nil {
t.Errorf("Users.GetKey returned error: %v", err)
t.Errorf("Users.CreateKey returned error: %v", err)
}

want := &Key{ID: Int64(1)}
if !cmp.Equal(key, want) {
t.Errorf("Users.GetKey returned %+v, want %+v", key, want)
t.Errorf("Users.CreateKey returned %+v, want %+v", key, want)
}

const methodName = "CreateKey"
Expand Down
108 changes: 108 additions & 0 deletions github/users_ssh_signing_keys.go
@@ -0,0 +1,108 @@
// Copyright 2022 The go-github AUTHORS. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package github

import (
"context"
"fmt"
)

// SSHSigningKey represents a public SSH key used to sign git commits.
type SSHSigningKey struct {
ID *int64 `json:"id,omitempty"`
Key *string `json:"key,omitempty"`
Title *string `json:"title,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
}

func (k SSHSigningKey) String() string {
return Stringify(k)
}

// ListSSHSigningKeys lists the SSH signing keys for a user. Passing an empty
// username string will fetch SSH signing keys for the authenticated user.
//
// GitHub API docs: https://docs.github.com/en/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user
// GitHub API docs: https://docs.github.com/en/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user
func (s *UsersService) ListSSHSigningKeys(ctx context.Context, user string, opts *ListOptions) ([]*SSHSigningKey, *Response, error) {
var u string
if user != "" {
u = fmt.Sprintf("users/%v/ssh_signing_keys", user)
} else {
u = "user/ssh_signing_keys"
}
u, err := addOptions(u, opts)
if err != nil {
return nil, nil, err
}

req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}

var keys []*SSHSigningKey
resp, err := s.client.Do(ctx, req, &keys)
if err != nil {
return nil, resp, err
}

return keys, resp, nil
}

// GetSSHSigningKey fetches a single SSH signing key for the authenticated user.
//
// GitHub API docs: https://docs.github.com/en/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user
func (s *UsersService) GetSSHSigningKey(ctx context.Context, id int64) (*SSHSigningKey, *Response, error) {
u := fmt.Sprintf("user/ssh_signing_keys/%v", id)

req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}

key := new(SSHSigningKey)
resp, err := s.client.Do(ctx, req, key)
if err != nil {
return nil, resp, err
}

return key, resp, nil
}

// CreateSSHSigningKey adds a SSH signing key for the authenticated user.
//
// GitHub API docs: https://docs.github.com/en/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user
func (s *UsersService) CreateSSHSigningKey(ctx context.Context, key *Key) (*SSHSigningKey, *Response, error) {
u := "user/ssh_signing_keys"

req, err := s.client.NewRequest("POST", u, key)
if err != nil {
return nil, nil, err
}

k := new(SSHSigningKey)
resp, err := s.client.Do(ctx, req, k)
if err != nil {
return nil, resp, err
}

return k, resp, nil
}

// DeleteKey deletes a SSH signing key for the authenticated user.
//
// GitHub API docs: https://docs.github.com/en/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user
func (s *UsersService) DeleteSSHSigningKey(ctx context.Context, id int64) (*Response, error) {
u := fmt.Sprintf("user/ssh_signing_keys/%v", id)

req, err := s.client.NewRequest("DELETE", u, nil)
if err != nil {
return nil, err
}

return s.client.Do(ctx, req, nil)
}