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 GPG Keys API #429
Merged
+653
−5
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
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,200 @@ | ||
package tfe | ||
|
||
import ( | ||
"context" | ||
"fmt" | ||
"net/url" | ||
"strings" | ||
"time" | ||
) | ||
|
||
// Compile-time proof of interface implementation | ||
var _ GPGKeys = (*gpgKeys)(nil) | ||
|
||
// GPGKeys describes all the GPG key related methods that the Terraform Private Registry API supports. | ||
// | ||
// TFE API Docs: https://www.terraform.io/cloud-docs/api-docs/private-registry/gpg-keys | ||
type GPGKeys interface { | ||
// Uploads a GPG Key to a private registry scoped with a namespace. | ||
Create(ctx context.Context, registryName RegistryName, options GPGKeyCreateOptions) (*GPGKey, error) | ||
|
||
// Read a GPG key. | ||
Read(ctx context.Context, keyID GPGKeyID) (*GPGKey, error) | ||
|
||
// Update a GPG key. | ||
Update(ctx context.Context, keyID GPGKeyID, options GPGKeyUpdateOptions) (*GPGKey, error) | ||
|
||
// Delete a GPG key. | ||
Delete(ctx context.Context, keyID GPGKeyID) error | ||
} | ||
|
||
// gpgKeys implements GPGKeys | ||
type gpgKeys struct { | ||
client *Client | ||
} | ||
|
||
// GPGKey represents a signed GPG key for a TFC/E private provider. | ||
type GPGKey struct { | ||
ID string `jsonapi:"primary,gpg-keys"` | ||
AsciiArmor string `jsonapi:"attr,ascii-armor"` | ||
CreatedAt time.Time `jsonapi:"attr,created-at,iso8601"` | ||
KeyID string `jsonapi:"attr,key-id"` | ||
Namespace string `jsonapi:"attr,namespace"` | ||
Source string `jsonapi:"attr,source"` | ||
SourceURL *string `jsonapi:"attr,source-url"` | ||
TrustSignature string `jsonapi:"attr,trust-signature"` | ||
UpdatedAt time.Time `jsonapi:"attr,updated-at,iso8601"` | ||
} | ||
|
||
// GPGKeyID represents the set of identifiers used to fetch a GPG key. | ||
type GPGKeyID struct { | ||
RegistryName RegistryName | ||
Namespace string | ||
KeyID string | ||
} | ||
|
||
// GPGKeyCreateOptions represents all the available options used to create a GPG key. | ||
type GPGKeyCreateOptions struct { | ||
Type string `jsonapi:"primary,gpg-keys"` | ||
Namespace string `jsonapi:"attr,namespace"` | ||
AsciiArmor string `jsonapi:"attr,ascii-armor"` | ||
} | ||
|
||
// GPGKeyCreateOptions represents all the available options used to update a GPG key. | ||
type GPGKeyUpdateOptions struct { | ||
Type string `jsonapi:"primary,gpg-keys"` | ||
Namespace string `jsonapi:"attr,namespace"` | ||
} | ||
|
||
func (s *gpgKeys) Create(ctx context.Context, registryName RegistryName, options GPGKeyCreateOptions) (*GPGKey, error) { | ||
if err := options.valid(); err != nil { | ||
return nil, err | ||
} | ||
|
||
if registryName != PrivateRegistry { | ||
return nil, ErrInvalidRegistryName | ||
} | ||
|
||
u := fmt.Sprintf("/api/registry/%s/v2/gpg-keys", url.QueryEscape(string(registryName))) | ||
req, err := s.client.newRequest("POST", u, &options) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
g := &GPGKey{} | ||
err = s.client.do(ctx, req, g) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
return g, nil | ||
} | ||
|
||
func (s *gpgKeys) Read(ctx context.Context, keyID GPGKeyID) (*GPGKey, error) { | ||
if err := keyID.valid(); err != nil { | ||
return nil, err | ||
} | ||
|
||
u := fmt.Sprintf("/api/registry/%s/v2/gpg-keys/%s/%s", | ||
url.QueryEscape(string(keyID.RegistryName)), | ||
url.QueryEscape(keyID.Namespace), | ||
url.QueryEscape(keyID.KeyID), | ||
) | ||
req, err := s.client.newRequest("GET", u, nil) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
g := &GPGKey{} | ||
err = s.client.do(ctx, req, g) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
return g, nil | ||
} | ||
|
||
func (s *gpgKeys) Update(ctx context.Context, keyID GPGKeyID, options GPGKeyUpdateOptions) (*GPGKey, error) { | ||
if err := options.valid(); err != nil { | ||
return nil, err | ||
} | ||
|
||
if err := keyID.valid(); err != nil { | ||
return nil, err | ||
} | ||
|
||
u := fmt.Sprintf("/api/registry/%s/v2/gpg-keys/%s/%s", | ||
url.QueryEscape(string(keyID.RegistryName)), | ||
url.QueryEscape(keyID.Namespace), | ||
url.QueryEscape(keyID.KeyID), | ||
) | ||
req, err := s.client.newRequest("PATCH", u, &options) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
g := &GPGKey{} | ||
err = s.client.do(ctx, req, g) | ||
if err != nil { | ||
if strings.Contains(err.Error(), "namespace not authorized") { | ||
return nil, ErrNamespaceNotAuthorized | ||
} | ||
return nil, err | ||
} | ||
|
||
return g, nil | ||
} | ||
|
||
func (s *gpgKeys) Delete(ctx context.Context, keyID GPGKeyID) error { | ||
if err := keyID.valid(); err != nil { | ||
return err | ||
} | ||
|
||
u := fmt.Sprintf("/api/registry/%s/v2/gpg-keys/%s/%s", | ||
url.QueryEscape(string(keyID.RegistryName)), | ||
url.QueryEscape(keyID.Namespace), | ||
url.QueryEscape(keyID.KeyID), | ||
) | ||
req, err := s.client.newRequest("DELETE", u, nil) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
return s.client.do(ctx, req, nil) | ||
} | ||
|
||
func (o GPGKeyID) valid() error { | ||
if o.RegistryName != PrivateRegistry { | ||
return ErrInvalidRegistryName | ||
} | ||
|
||
if !validString(&o.Namespace) { | ||
return ErrInvalidNamespace | ||
} | ||
|
||
if !validString(&o.KeyID) { | ||
return ErrInvalidKeyID | ||
} | ||
|
||
return nil | ||
} | ||
|
||
func (o GPGKeyCreateOptions) valid() error { | ||
if !validString(&o.Namespace) { | ||
return ErrInvalidNamespace | ||
} | ||
|
||
if !validString(&o.AsciiArmor) { | ||
return ErrInvalidAsciiArmor | ||
} | ||
|
||
return nil | ||
} | ||
|
||
func (o GPGKeyUpdateOptions) valid() error { | ||
if !validString(&o.Namespace) { | ||
return ErrInvalidNamespace | ||
} | ||
|
||
return nil | ||
} |
Oops, something went wrong.
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.
When I was reading the docs, I noticed this line:
Only the namespace attribute can be updated, and namespace has to match an organization the user has permission to access.
I'm curious if the API returns an error if a namespace doesn't match an org the user has permission to access? Would this be something we would want to add a test for? The reason I suggest adding a test is because this detail could be overlooked by someone using this API, and they might see a test. I also admit that we don't want to cross a boundary if it doesn't make sense. What do you think? 🤔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.
Good catch and this makes way more sense here as we want to test for an error that's specific to this resource! I've added a check in the error handler for
client.do()
insideGPGKeys.Update()
where if the body's message containsnamespace is not authorized
it will returnErrNamespaceNotAuthorized
. I've also added the corresponding test.