Skip to content
Open
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
9 changes: 9 additions & 0 deletions internal/cmd/token/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,13 @@ import (
func CreateCmd(ch *cmdutil.Helper) *cobra.Command {
var name string
var ttl int
var cidrs []string

cmd := &cobra.Command{
Use: "create",
Short: "create a service token for the organization",
Example: ` pscale service-token create --name ci --cidrs 10.0.0.0/8,192.168.1.1/32
pscale service-token create --name ci`,
RunE: func(cmd *cobra.Command, args []string) error {
ctx := cmd.Context()
client, err := ch.Client()
Expand All @@ -28,6 +31,10 @@ func CreateCmd(ch *cmdutil.Helper) *cobra.Command {
Name: stringPtrOrNil(name),
TTL: intPtrOrNil(ttl),
}
if cmd.Flags().Changed("cidrs") {
normalized := normalizeCIDRs(cidrs)
req.CIDRs = &normalized
}

end := ch.Printer.PrintProgress(fmt.Sprintf("Creating service token in org %s", printer.BoldBlue(ch.Config.Organization)))
defer end()
Expand All @@ -50,6 +57,8 @@ func CreateCmd(ch *cmdutil.Helper) *cobra.Command {

cmd.Flags().StringVar(&name, "name", "", "optional name for the service token")
cmd.Flags().IntVar(&ttl, "ttl", 0, "Time to live (in seconds) for the service token. The token will be invalid when TTL has passed")
cmd.Flags().StringSliceVar(&cidrs, "cidrs", nil,
"IP addresses and CIDR ranges allowed to use this service token. Omit to leave the token unrestricted")

return cmd
}
Expand Down
41 changes: 41 additions & 0 deletions internal/cmd/token/create_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ func TestServiceToken_CreateCmd(t *testing.T) {
CreateFn: func(ctx context.Context, req *ps.CreateServiceTokenRequest) (*ps.ServiceToken, error) {
c.Assert(req.Organization, qt.Equals, org)
c.Assert(req.Name, qt.IsNil)
c.Assert(req.CIDRs, qt.IsNil)
return orig, nil
},
}
Expand Down Expand Up @@ -109,6 +110,46 @@ func TestServiceToken_CreateCmdWithName(t *testing.T) {
c.Assert(buf.String(), qt.JSONEquals, res)
}

func TestServiceToken_CreateCmdWithCIDRs(t *testing.T) {
c := qt.New(t)

var buf bytes.Buffer
format := printer.JSON
p := printer.NewPrinter(&format)
p.SetResourceOutput(&buf)

org := "planetscale"
id := "123456"
createdAt := time.Date(2025, 1, 15, 10, 30, 0, 0, time.UTC)
cidrs := []string{"10.0.0.0/8", "192.168.1.1/32"}

orig := &ps.ServiceToken{ID: id, CreatedAt: createdAt, CIDRs: cidrs}

svc := &mock.ServiceTokenService{
CreateFn: func(ctx context.Context, req *ps.CreateServiceTokenRequest) (*ps.ServiceToken, error) {
c.Assert(req.CIDRs, qt.IsNotNil)
c.Assert(*req.CIDRs, qt.DeepEquals, cidrs)
return orig, nil
},
}

ch := &cmdutil.Helper{
Printer: p,
Config: &config.Config{Organization: org},
Client: func() (*ps.Client, error) {
return &ps.Client{ServiceTokens: svc}, nil
},
}

cmd := CreateCmd(ch)
cmd.SetArgs([]string{"--cidrs", "10.0.0.0/8,192.168.1.1/32"})
err := cmd.Execute()

c.Assert(err, qt.IsNil)
c.Assert(svc.CreateFnInvoked, qt.IsTrue)
c.Assert(buf.String(), qt.JSONEquals, &ServiceTokenWithSecret{orig: orig})
}

func TestServiceToken_CreateCmdWithTTL(t *testing.T) {
c := qt.New(t)

Expand Down
5 changes: 5 additions & 0 deletions internal/cmd/token/show_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ func TestServiceToken_ShowCmd(t *testing.T) {
lastUsedAt := time.Date(2025, 1, 20, 14, 45, 0, 0, time.UTC)
lastUsedIP := "203.0.113.5"
lastUsedOrganization := "Example Networks"
cidrs := []string{"10.0.0.0/8", "192.168.1.1/32"}
token := &ps.ServiceToken{
ID: id,
Name: &name,
Expand All @@ -37,6 +38,7 @@ func TestServiceToken_ShowCmd(t *testing.T) {
LastUsedAt: &lastUsedAt,
LastUsedIP: &lastUsedIP,
LastUsedAsnOrganization: &lastUsedOrganization,
CIDRs: cidrs,
}

svc := &mock.ServiceTokenService{
Expand All @@ -63,6 +65,7 @@ func TestServiceToken_ShowCmd(t *testing.T) {
"last_used_ip": "203.0.113.5",
"last_used_asn_organization": "Example Networks",
"expires_at": nil,
"cidrs": cidrs,
})
c.Assert(buf.String(), qt.Not(qt.Contains), token.Token)
}
Expand All @@ -88,6 +91,7 @@ func TestServiceToken_ShowCmdHuman(t *testing.T) {
CreatedAt: time.Date(2025, 1, 15, 10, 30, 0, 0, time.UTC),
LastUsedIP: &lastUsedIP,
LastUsedAsnOrganization: &lastUsedOrganization,
CIDRs: []string{"10.0.0.0/8", "192.168.1.1/32"},
}, nil
},
}
Expand All @@ -102,6 +106,7 @@ func TestServiceToken_ShowCmdHuman(t *testing.T) {
c.Assert(buf.String(), qt.Contains, "deploy-token")
c.Assert(buf.String(), qt.Contains, "203.0.113.5")
c.Assert(buf.String(), qt.Contains, "Example Networks")
c.Assert(buf.String(), qt.Contains, "10.0.0.0/8, 192.168.1.1/32")
c.Assert(buf.String(), qt.Not(qt.Contains), "must-not-be-printed")
}

Expand Down
14 changes: 14 additions & 0 deletions internal/cmd/token/token.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package token
import (
"encoding/json"
"fmt"
"strings"
"time"

"github.com/planetscale/cli/internal/cmdutil"
Expand Down Expand Up @@ -38,6 +39,7 @@ func TokenCmd(ch *cmdutil.Helper) *cobra.Command {
cmd.MarkPersistentFlagRequired("org") // nolint:errcheck

cmd.AddCommand(CreateCmd(ch))
cmd.AddCommand(UpdateCmd(ch))
cmd.AddCommand(DuplicateCmd(ch))
cmd.AddCommand(ListCmd(ch))
cmd.AddCommand(ShowCmd(ch))
Expand All @@ -52,6 +54,7 @@ func TokenCmd(ch *cmdutil.Helper) *cobra.Command {
type ServiceToken struct {
ID string `header:"id" json:"id"`
Name string `header:"name" json:"name"`
CIDRs string `header:"cidrs"`
LastUsedAt int64 `header:"last_used_at,timestamp(ms|utc|human)" json:"last_used_at"`
LastUsedIP string `header:"last_used_ip" json:"last_used_ip"`
LastUsedOrganization string `header:"last_used_organization" json:"last_used_organization"`
Expand Down Expand Up @@ -88,6 +91,7 @@ func toServiceToken(st *ps.ServiceToken) *ServiceToken {
return &ServiceToken{
ID: st.ID,
Name: name,
CIDRs: formatCIDRs(st.CIDRs),
LastUsedAt: lastUsedAt,
LastUsedIP: derefString(st.LastUsedIP),
LastUsedOrganization: derefString(st.LastUsedAsnOrganization),
Expand All @@ -97,6 +101,10 @@ func toServiceToken(st *ps.ServiceToken) *ServiceToken {
}
}

func formatCIDRs(cidrs []string) string {
return strings.Join(cidrs, ", ")
}

func derefString(value *string) string {
if value == nil {
return ""
Expand All @@ -107,6 +115,7 @@ func derefString(value *string) string {
type ServiceTokenDetails struct {
ID string `header:"id"`
Name string `header:"name"`
CIDRs string `header:"cidrs"`
LastUsedAt int64 `header:"last_used_at,timestamp(ms|utc|human)"`
LastUsedIP string `header:"last_used_ip"`
LastUsedOrganization string `header:"last_used_organization"`
Expand All @@ -125,6 +134,7 @@ func (s *ServiceTokenDetails) MarshalJSON() ([]byte, error) {
LastUsedIP *string `json:"last_used_ip"`
LastUsedAsnOrganization *string `json:"last_used_asn_organization"`
ExpiresAt *time.Time `json:"expires_at"`
CIDRs []string `json:"cidrs"`
}{
ID: s.orig.ID,
Name: s.orig.Name,
Expand All @@ -133,6 +143,7 @@ func (s *ServiceTokenDetails) MarshalJSON() ([]byte, error) {
LastUsedIP: s.orig.LastUsedIP,
LastUsedAsnOrganization: s.orig.LastUsedAsnOrganization,
ExpiresAt: s.orig.ExpiresAt,
CIDRs: s.orig.CIDRs,
}, "", " ")
}

Expand All @@ -142,6 +153,7 @@ func toServiceTokenDetails(st *ps.ServiceToken) *ServiceTokenDetails {
return &ServiceTokenDetails{
ID: token.ID,
Name: token.Name,
CIDRs: token.CIDRs,
LastUsedAt: token.LastUsedAt,
LastUsedIP: token.LastUsedIP,
LastUsedOrganization: token.LastUsedOrganization,
Expand All @@ -155,6 +167,7 @@ func toServiceTokenDetails(st *ps.ServiceToken) *ServiceTokenDetails {
type ServiceTokenWithSecret struct {
ID string `header:"id" json:"id"`
Name string `header:"name" json:"name"`
CIDRs string `header:"cidrs"`
Token string `header:"token" json:"token"`
ExpiresAt int64 `header:"expires_at,timestamp(ms|utc|human)" json:"expires_at"`
CreatedAt int64 `header:"created_at,timestamp(ms|utc|human)" json:"created_at"`
Expand All @@ -181,6 +194,7 @@ func toServiceTokenWithSecret(st *ps.ServiceToken) *ServiceTokenWithSecret {
return &ServiceTokenWithSecret{
ID: st.ID,
Name: name,
CIDRs: formatCIDRs(st.CIDRs),
Token: st.Token,
ExpiresAt: expiresAt,
CreatedAt: printer.GetMilliseconds(st.CreatedAt),
Expand Down
92 changes: 92 additions & 0 deletions internal/cmd/token/update.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
package token

import (
"errors"
"fmt"
"strings"

"github.com/planetscale/cli/internal/cmdutil"
"github.com/planetscale/cli/internal/planetscale"
"github.com/planetscale/cli/internal/printer"
"github.com/spf13/cobra"
)

// UpdateCmd replaces the IP restrictions on a service token.
func UpdateCmd(ch *cmdutil.Helper) *cobra.Command {
var cidrs []string

cmd := &cobra.Command{
Use: "update <id>",
Short: "Update a service token's IP restrictions",
Long: `Update the IP addresses and CIDR ranges allowed to use a service token.

This does not rotate the token. Pass an empty --cidrs value to remove all restrictions.`,
Example: ` pscale service-token update <token id> --cidrs 10.0.0.0/8,192.168.1.1/32
pscale service-token update <token id> --cidrs ""`,
Args: cmdutil.RequiredArgs("id"),
RunE: func(cmd *cobra.Command, args []string) error {
ctx := cmd.Context()
id := args[0]

if !cmd.Flags().Changed("cidrs") {
return errors.New("--cidrs must be provided")
}

client, err := ch.Client()
if err != nil {
return err
}

end := ch.Printer.PrintProgress(fmt.Sprintf("Updating service token %s in org %s",
printer.BoldBlue(id), printer.BoldBlue(ch.Config.Organization)))
defer end()

normalized := normalizeCIDRs(cidrs)
token, err := client.ServiceTokens.Update(ctx, &planetscale.UpdateServiceTokenRequest{
Organization: ch.Config.Organization,
ID: id,
CIDRs: &normalized,
})
if err != nil {
switch cmdutil.ErrCode(err) {
case planetscale.ErrNotFound:
return fmt.Errorf("service token %s does not exist in organization %s",
printer.BoldBlue(id), printer.BoldBlue(ch.Config.Organization))
default:
return cmdutil.HandleError(err)
}
}

end()

if ch.Printer.Format() == printer.Human {
ch.Printer.Printf("Service token %s was successfully updated.\n", printer.BoldBlue(token.ID))
if len(token.CIDRs) == 0 {
ch.Printer.Println("IP restrictions: none")
} else {
ch.Printer.Printf("IP restrictions: %s\n", strings.Join(token.CIDRs, ", "))
}
return nil
}

return ch.Printer.PrintResource(toServiceTokenDetails(token))
},
}

cmd.Flags().StringSliceVar(&cidrs, "cidrs", nil,
"Replace the IP addresses and CIDR ranges allowed to use this service token. Pass an empty value to remove all restrictions")

return cmd
}

// normalizeCIDRs drops the empty entries produced by flags like --cidrs "" so
// that clearing restrictions sends an empty list instead of a blank CIDR.
func normalizeCIDRs(cidrs []string) []string {
out := make([]string, 0, len(cidrs))
for _, cidr := range cidrs {
if trimmed := strings.TrimSpace(cidr); trimmed != "" {
out = append(out, trimmed)
}
}
return out
}
Loading
Loading