Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add HasActiveToken method to AuthConfig to refactor auth check for attestation trusted-root command #9635

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.

Sign up for GitHub

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

Merged
bdehamer merged 4 commits into from
Sep 18, 2024
Merged

Add HasActiveToken method to AuthConfig to refactor auth check for attestation trusted-root command #9635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e7403b8
Add HasActiveToken to AuthConfig.
BagToad Sep 18, 2024
88d48f2
Add HasActiveToken method to AuthConfig interface
BagToad Sep 18, 2024
d8e77d2
Use new HasActiveToken method in trustedroot.go
BagToad Sep 18, 2024
d24dfbe
Update comment formatting
BagToad Sep 18, 2024
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
26 changes: 25 additions & 1 deletion internal/config/auth_config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,32 @@ func TestTokenFromKeyringForUserErrorsIfUsernameIsBlank(t *testing.T) {
require.ErrorContains(t, err, "username cannot be blank")
}

func TestHasActiveToken(t *testing.T) {
// Given the user has logged in for a host
authCfg := newTestAuthConfig(t)
_, err := authCfg.Login("github.com", "test-user", "test-token", "", false)
require.NoError(t, err)

// When we check if that host has an active token
hasActiveToken := authCfg.HasActiveToken("github.com")

// Then there is an active token
require.True(t, hasActiveToken, "expected there to be an active token")
}

func TestHasNoActiveToken(t *testing.T) {
// Given there are no users logged in for a host
authCfg := newTestAuthConfig(t)

// When we check if any host has an active token
hasActiveToken := authCfg.HasActiveToken("github.com")

// Then there is no active token
require.False(t, hasActiveToken, "expected there to be no active token")
}

func TestTokenStoredInConfig(t *testing.T) {
// When the user has logged in insecurely
// Given the user has logged in insecurely
authCfg := newTestAuthConfig(t)
_, err := authCfg.Login("github.com", "test-user", "test-token", "", false)
require.NoError(t, err)
Expand Down
6 changes: 6 additions & 0 deletions internal/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,12 @@ func (c *AuthConfig) ActiveToken(hostname string) (string, string) {
return token, source
}

// HasActiveToken returns true when a token for the hostname is present.
func (c *AuthConfig) HasActiveToken(hostname string) bool {
token, _ := c.ActiveToken(hostname)
return token != ""
}

// HasEnvToken returns true when a token has been specified in an
// environment variable, else returns false.
func (c *AuthConfig) HasEnvToken() bool {
Expand Down
3 changes: 3 additions & 0 deletions internal/gh/gh.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,9 @@ type Migration interface {
// with knowledge on how to access encrypted storage when neccesarry.
// Behavior is scoped to authentication specific tasks.
type AuthConfig interface {
// HasActiveToken returns true when a token for the hostname is present.
HasActiveToken(hostname string) bool

// ActiveToken will retrieve the active auth token for the given hostname, searching environment variables,
// general configuration, and finally encrypted storage.
ActiveToken(hostname string) (token string, source string)
Expand Down
2 changes: 1 addition & 1 deletion pkg/cmd/attestation/trustedroot/trustedroot.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ func NewTrustedRootCmd(f *cmdutil.Factory, runF func(*Options) error) *cobra.Com
return err
}

if token, _ := c.Authentication().ActiveToken(opts.Hostname); token == "" {
if !c.Authentication().HasActiveToken(opts.Hostname) {
return fmt.Errorf("not authenticated with %s", opts.Hostname)
}

Expand Down
14 changes: 7 additions & 7 deletions pkg/cmd/attestation/trustedroot/trustedroot_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ func TestNewTrustedRootWithTenancy(t *testing.T) {
Config: func() (gh.Config, error) {
return &ghmock.ConfigMock{
AuthenticationFunc: func() gh.AuthConfig {
return &MockAuthConfig{Token: ""}
return &stubAuthConfig{hasActiveToken: false}
},
}, nil
},
Expand All @@ -136,7 +136,7 @@ func TestNewTrustedRootWithTenancy(t *testing.T) {
Config: func() (gh.Config, error) {
return &ghmock.ConfigMock{
AuthenticationFunc: func() gh.AuthConfig {
return &MockAuthConfig{Token: "TOKEN"}
return &stubAuthConfig{hasActiveToken: true}
},
}, nil
},
Expand Down Expand Up @@ -186,13 +186,13 @@ func TestGetTrustedRoot(t *testing.T) {

}

type MockAuthConfig struct {
type stubAuthConfig struct {
config.AuthConfig
Token string
hasActiveToken bool
}

var _ gh.AuthConfig = (*MockAuthConfig)(nil)
var _ gh.AuthConfig = (*stubAuthConfig)(nil)

func (c *MockAuthConfig) ActiveToken(host string) (string, string) {
return c.Token, ""
func (c *stubAuthConfig) HasActiveToken(host string) bool {
return c.hasActiveToken
}