Skip to content
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

### Bug Fixes:

- fix(auth): honor deprecated `--profile`/`-o` when resolving the API token; an unknown profile name is now a hard error instead of a silent fallback to the default token
- fix(text): send deprecation warnings to stderr instead of stdout ([#1782](https://github.com/fastly/cli/pull/1782))

### Enhancements:
Expand Down
6 changes: 5 additions & 1 deletion pkg/app/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ func Exec(data *global.Data) error {
data.AuthServer = authServer
}

if !data.Flags.Quiet && data.Flags.Token == "" && data.Env.APIToken == "" && data.Manifest != nil && data.Manifest.File.Profile != "" {
if !data.Flags.Quiet && data.Flags.Token == "" && data.Flags.Profile == "" && data.Env.APIToken == "" && data.Manifest != nil && data.Manifest.File.Profile != "" {
if data.Config.GetAuthToken(data.Manifest.File.Profile) == nil {
if defaultName, _ := data.Config.GetDefaultAuthToken(); defaultName != "" {
text.Warning(data.ErrOutput, "fastly.toml profile %q not found in auth config, using default token %q.\n", data.Manifest.File.Profile, defaultName)
Expand Down Expand Up @@ -397,6 +397,10 @@ func configureKingpin(data *global.Data) *kingpin.Application {
// Tokens from --token (raw, unavailable when FASTLY_DISABLE_AUTH_COMMAND is
// set) or FASTLY_API_TOKEN are assumed to be valid.
func processToken(data *global.Data) (token string, tokenSource lookup.Source, err error) {
if err := data.ValidateProfileFlag(); err != nil {
return "", lookup.SourceUndefined, err
}

token, tokenSource = data.Token()

switch tokenSource {
Expand Down
42 changes: 42 additions & 0 deletions pkg/commands/auth/metadata_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,48 @@ func TestAuthShow(t *testing.T) {
"(default)",
},
},
{
Name: "show with unknown --profile rejected",
Args: "show --profile bogus",
ConfigFile: &config.File{
Auth: config.Auth{
Default: "user",
Tokens: config.AuthTokens{
"user": &config.AuthToken{Type: config.AuthTokenTypeStatic, Token: "t"},
},
},
},
WantError: `profile "bogus"`,
WantRemediation: "fastly auth",
},
{
Name: "show with known --profile uses that profile",
Args: "show --profile alt",
ConfigFile: &config.File{
Auth: config.Auth{
Default: "user",
Tokens: config.AuthTokens{
"user": &config.AuthToken{Type: config.AuthTokenTypeStatic, Token: "t"},
"alt": &config.AuthToken{Type: config.AuthTokenTypeStatic, Token: "alt-token", Email: "a@example.com"},
},
},
},
WantOutputs: []string{"Name: alt", "a@example.com"},
},
{
Name: "show with --token raw --profile bogus skips profile validation",
Args: "show --token raw --profile bogus",
ConfigFile: &config.File{
Auth: config.Auth{
Default: "user",
Tokens: config.AuthTokens{
"user": &config.AuthToken{Type: config.AuthTokenTypeStatic, Token: "t"},
},
},
},
WantError: "current token is not stored",
DontWantOutput: "not found in auth config",
},
}

testutil.RunCLIScenarios(t, []string{"auth"}, scenarios)
Expand Down
4 changes: 4 additions & 0 deletions pkg/commands/auth/revoke.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ func (c *RevokeCommand) Exec(in io.Reader, out io.Writer) error {
return err
}

if err := c.Globals.ValidateProfileFlag(); err != nil {
return err
}

switch {
case c.current:
return c.revokeCurrent(in, out)
Expand Down
46 changes: 46 additions & 0 deletions pkg/commands/auth/revoke_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,52 @@ func TestAuthRevoke(t *testing.T) {
WantRemediation: "one token ID per line",
},

{
Name: "revoke --current with unknown --profile rejected",
Args: "revoke --current --profile bogus",
WantError: `profile "bogus"`,
WantRemediation: "fastly auth",
},
{
Name: "revoke --name with unknown --profile rejected",
Args: "revoke --name secondary --profile bogus",
WantError: `profile "bogus"`,
WantRemediation: "fastly auth",
},
{
Name: "revoke --token-value with unknown --profile rejected",
Args: "revoke --token-value tok-secondary --profile bogus",
WantError: `profile "bogus"`,
WantRemediation: "fastly auth",
},
{
Name: "revoke --id with unknown --profile rejected",
Args: "revoke --id some-id --profile bogus",
WantError: `profile "bogus"`,
WantRemediation: "fastly auth",
},
{
Name: "revoke --file with unknown --profile rejected",
Args: fmt.Sprintf("revoke --file %s --profile bogus", writeTokenIDFile(t, "id-1\n")),
WantError: `profile "bogus"`,
WantRemediation: "fastly auth",
},
{
Name: "revoke --current with --token flag wins over unknown --profile",
Args: "revoke --current --token tok-stored --profile bogus",
API: &mock.API{DeleteTokenSelfFn: deleteTokenSelfOK},
ConfigFile: &config.File{
Auth: config.Auth{
Default: "mytoken",
Tokens: config.AuthTokens{
"mytoken": &config.AuthToken{Type: config.AuthTokenTypeStatic, Token: "tok-stored"},
},
},
},
Stdin: []string{"y"},
WantOutputs: []string{"Revoked current token"},
},

// API client factory failure
{
Name: "API client factory failure on --name",
Expand Down
4 changes: 4 additions & 0 deletions pkg/commands/auth/show.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ func NewShowCommand(parent argparser.Registerer, g *global.Data) *ShowCommand {
}

func (c *ShowCommand) Exec(_ io.Reader, out io.Writer) error {
if err := c.Globals.ValidateProfileFlag(); err != nil {
return err
}

if c.name == "" {
_, src := c.Globals.Token()
switch src {
Expand Down
4 changes: 4 additions & 0 deletions pkg/commands/auth/token.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ func (c *TokenCommand) Exec(_ io.Reader, out io.Writer) error {
}
}

if err := c.Globals.ValidateProfileFlag(); err != nil {
return err
}

token, src := c.Globals.Token()
if src == lookup.SourceUndefined || token == "" {
return fsterr.RemediationError{
Expand Down
55 changes: 55 additions & 0 deletions pkg/commands/auth/token_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package auth_test
import (
"bytes"
"errors"
"strings"
"testing"

"github.com/fastly/kingpin"
Expand Down Expand Up @@ -69,3 +70,57 @@ func TestToken_NonTTY_NoToken(t *testing.T) {
t.Errorf("unexpected inner error: %v", re.Inner)
}
}

func TestToken_NonTTY_ProfileFlagUnknown(t *testing.T) {
var buf bytes.Buffer
g := globalDataWithToken("test-api-token-value")
g.Flags.Profile = "bogus"

cmd := newTokenCommand(g)
err := cmd.Exec(nil, &buf)
if err == nil {
t.Fatal("expected error for unknown --profile")
}
var re fsterr.RemediationError
if !errors.As(err, &re) {
t.Fatalf("expected RemediationError, got %T: %v", err, err)
}
if re.Inner == nil || !strings.Contains(re.Inner.Error(), `"bogus"`) {
t.Errorf("unexpected inner error: %v", re.Inner)
}
if buf.Len() != 0 {
t.Errorf("expected no token to be written, got: %q", buf.String())
}
}

func TestToken_NonTTY_ProfileFlagKnown(t *testing.T) {
var buf bytes.Buffer
g := globalDataWithToken("default-token")
g.Config.Auth.Tokens["alt"] = &config.AuthToken{Type: config.AuthTokenTypeStatic, Token: "alt-token"}
g.Flags.Profile = "alt"

cmd := newTokenCommand(g)
err := cmd.Exec(nil, &buf)
if err != nil {
t.Fatalf("expected no error, got: %v", err)
}
if got := buf.String(); got != "alt-token" {
t.Errorf("expected token %q, got %q", "alt-token", got)
}
}

func TestToken_NonTTY_TokenFlagBeatsProfileFlag(t *testing.T) {
var buf bytes.Buffer
g := globalDataWithToken("default-token")
g.Flags.Token = "raw-xyz"
g.Flags.Profile = "bogus"

cmd := newTokenCommand(g)
err := cmd.Exec(nil, &buf)
if err != nil {
t.Fatalf("expected no error, got: %v", err)
}
if got := buf.String(); got != "raw-xyz" {
t.Errorf("expected token %q, got %q", "raw-xyz", got)
}
}
8 changes: 8 additions & 0 deletions pkg/errors/remediation_error.go
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,14 @@ var ComputeBuildRemediation = strings.Join([]string{
"See more at https://www.fastly.com/documentation/reference/compute/fastly-toml",
}, " ")

// ErrProfileFlagNotFound is returned when --profile names an unknown auth token.
func ErrProfileFlagNotFound(name string) RemediationError {
return RemediationError{
Inner: fmt.Errorf("profile %q (from --profile) not found in auth config", name),
Remediation: ProfileRemediation(),
}
}

// ProfileRemediation suggests running auth commands.
func ProfileRemediation() string {
if env.AuthCommandDisabled() {
Expand Down
44 changes: 39 additions & 5 deletions pkg/global/global.go
Original file line number Diff line number Diff line change
Expand Up @@ -97,19 +97,25 @@ type Data struct {
// Order of precedence:
// - The --token flag (if it matches a stored auth token name, use that token).
// - The --token flag (treated as a raw API token).
// - The --profile/-o flag (must match a stored auth token name).
// - The FASTLY_API_TOKEN environment variable.
// - The `profile` manifest field mapped to an auth token name.
// - The default [auth] token (if configured).
func (d *Data) Token() (string, lookup.Source) {
// --token: check if it matches a stored auth token name first.
if d.Flags.Token != "" {
if at := d.Config.GetAuthToken(d.Flags.Token); at != nil && at.Token != "" {
return at.Token, lookup.SourceAuth
}
return d.Flags.Token, lookup.SourceFlag
}

// FASTLY_API_TOKEN
if d.Flags.Profile != "" {
if at, ok := d.profileFlagToken(); ok {
return at.Token, lookup.SourceAuth
}
return "", lookup.SourceUndefined
}

if d.Env.APIToken != "" {
return d.Env.APIToken, lookup.SourceEnvironment
}
Expand All @@ -120,31 +126,59 @@ func (d *Data) Token() (string, lookup.Source) {
}
}

// [auth] section default token.
if _, at := d.Config.GetDefaultAuthToken(); at != nil && at.Token != "" {
return at.Token, lookup.SourceAuth
}

return "", lookup.SourceUndefined
}

func (d *Data) profileFlagToken() (*config.AuthToken, bool) {
if d.Flags.Profile == "" {
return nil, false
}
at := d.Config.GetAuthToken(d.Flags.Profile)
if at == nil || at.Token == "" {
return nil, false
}
return at, true
}

// ValidateProfileFlag returns an error if --profile/-o is set to a name that
// does not resolve to a stored auth token. --token outranks --profile and
// short-circuits the check.
func (d *Data) ValidateProfileFlag() error {
if d.Flags.Token != "" || d.Flags.Profile == "" {
return nil
}
if _, ok := d.profileFlagToken(); ok {
return nil
}
return fsterr.ErrProfileFlagNotFound(d.Flags.Profile)
}

// AuthTokenName returns the name of the auth token being used, if any.
// This is used for display purposes and for SSO refresh of named tokens.
func (d *Data) AuthTokenName() string {
// If --token matches a stored auth token name, return that name.
if d.Flags.Token != "" {
if at := d.Config.GetAuthToken(d.Flags.Token); at != nil {
return d.Flags.Token
}
return ""
}

if d.Flags.Profile != "" {
if _, ok := d.profileFlagToken(); ok {
return d.Flags.Profile
}
return ""
}

if d.Manifest != nil && d.Manifest.File.Profile != "" {
if at := d.Config.GetAuthToken(d.Manifest.File.Profile); at != nil {
return d.Manifest.File.Profile
}
}
// Otherwise return the default auth token name.
name, _ := d.Config.GetDefaultAuthToken()
return name
}
Expand Down
Loading
Loading