GitLabgitlab-org

cli

main
ply10 git calls228 ms100 KiB8 cachedprotocol v2
241 lines5.6 KiBRaw
1package list
3import (
4 "encoding/json"
5 "fmt"
6 "io"
7 "os"
8 "path/filepath"
9 "time"
11 "github.com/MakeNowJust/heredoc/v2"
12 "github.com/spf13/cobra"
14 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
16 "gitlab.com/gitlab-org/cli/internal/cmdutils"
17 agentutils "gitlab.com/gitlab-org/cli/internal/commands/cluster/agent/agentutils"
18 "gitlab.com/gitlab-org/cli/internal/iostreams"
19 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
20 "gitlab.com/gitlab-org/cli/internal/tableprinter"
23type options struct {
24 io *iostreams.IOStreams
26 filesystem bool
27 keyring bool
28 agents []int64
29 repo string
32type cachedToken = agentutils.CachedToken
34func NewCmd(f cmdutils.Factory) *cobra.Command {
35 opts := options{
36 io: f.IO(),
37 }
39 cmd := &cobra.Command{
40 Use: "list [flags]",
41 Short: "List cached GitLab Agent tokens.",
42 Long: heredoc.Docf(`
43 By default, shows tokens from both keyring and filesystem cache.
44 Use %[1]s--keyring=false%[1]s or %[1]s--filesystem=false%[1]s to filter by cache type.
45 `, "`"),
46 Example: heredoc.Doc(`
47 # List all cached agent tokens
48 glab cluster agent token-cache list
50 # List tokens from filesystem cache only
51 glab cluster agent token-cache list --keyring=false`),
52 Args: cobra.NoArgs,
53 ValidArgsFunction: cobra.NoFileCompletions,
54 Annotations: map[string]string{
55 mcpannotations.Exclude: "true",
56 },
57 RunE: func(cmd *cobra.Command, args []string) error {
58 return opts.run()
59 },
60 }
62 fl := cmd.Flags()
63 fl.BoolVar(&opts.filesystem, "filesystem", true, "Include tokens from filesystem cache.")
64 fl.BoolVar(&opts.keyring, "keyring", true, "Include tokens from keyring cache.")
65 fl.Int64SliceVar(&opts.agents, "agent", nil, "Filter by specific agent IDs.")
66 fl.StringVarP(&opts.repo, "repo", "R", "", "Select another repository using the OWNER/REPO format.")
68 cmdutils.EnableRepoOverride(cmd, f)
70 return cmd
73func (o *options) run() error {
74 var tokens []cachedToken
75 var errors []error
77 if o.keyring {
78 keyringTokens, err := o.getKeyringTokens()
79 if err != nil {
80 errors = append(errors, fmt.Errorf("failed to read keyring tokens: %w", err))
81 } else {
82 tokens = append(tokens, keyringTokens...)
83 }
84 }
86 if o.filesystem {
87 fsTokens, err := o.getFilesystemTokens()
88 if err != nil {
89 errors = append(errors, fmt.Errorf("failed to read filesystem tokens: %w", err))
90 } else {
91 tokens = append(tokens, fsTokens...)
92 }
93 }
95 // Filter by agent IDs if specified
96 tokens = agentutils.FilterByAgents(tokens, o.agents)
98 if len(tokens) == 0 {
99 o.io.LogInfo("No cached tokens found.")
100 for _, err := range errors {
101 o.io.LogErrorf("Warning: %v\n", err)
102 }
103 return nil
104 }
106 for _, err := range errors {
107 o.io.LogErrorf("Warning: %v\n", err)
108 }
110 o.displayTokens(tokens)
111 return nil
114func (o *options) getKeyringTokens() ([]cachedToken, error) {
115 // The keyring library can't enumerate keys, and unlike clear, this path
116 // never builds cache keys from --agent, so keyring listing is unimplemented.
117 return nil, fmt.Errorf("keyring token listing requires --agent flag to specify agent IDs")
120func (o *options) getFilesystemTokens() ([]cachedToken, error) {
121 var tokens []cachedToken
123 cacheDir, err := os.UserCacheDir()
124 if err != nil {
125 return nil, err
126 }
128 gitlabCacheDir := filepath.Join(cacheDir, "gitlab")
130 // Use traversal-safe root to confine all file operations within the cache directory
131 root, err := os.OpenRoot(gitlabCacheDir)
132 if err != nil {
133 if os.IsNotExist(err) {
134 return nil, nil // No cache directory exists
135 }
136 return nil, err
137 }
138 defer func() {
139 if cerr := root.Close(); err == nil {
140 err = cerr
141 }
142 }()
144 dir, err := root.Open(".")
145 if err != nil {
146 return nil, err
147 }
148 defer func() {
149 if cerr := dir.Close(); err == nil {
150 err = cerr
151 }
152 }()
154 entries, err := dir.ReadDir(-1)
155 if err != nil {
156 return nil, err
157 }
159 for _, entry := range entries {
160 if entry.IsDir() {
161 continue
162 }
164 token, err := o.readTokenFromRoot(root, entry.Name())
165 if err != nil {
166 o.io.LogErrorf("Warning: Failed to read token from %s: %v\n", entry.Name(), err)
167 continue
168 }
170 tokens = append(tokens, *token)
171 }
173 return tokens, nil
176// readTokenFromRoot reads a token file by name from a confined root
177func (o *options) readTokenFromRoot(root *os.Root, name string) (*cachedToken, error) {
178 f, err := root.Open(name)
179 if err != nil {
180 return nil, err
181 }
182 defer func() {
183 if cerr := f.Close(); err == nil {
184 err = cerr
185 }
186 }()
188 data, err := io.ReadAll(f)
189 if err != nil {
190 return nil, err
191 }
193 var pat gitlab.PersonalAccessToken
194 if err := json.Unmarshal(data, &pat); err != nil {
195 return nil, err
196 }
198 // cache ID is simply the filename in this confined root
199 cacheID := name
201 // Parse cache ID to extract GitLab URL and agent ID
202 gitlabURL, agentID, err := agentutils.ParseCacheID(cacheID)
203 if err != nil {
204 return nil, err
205 }
207 token := &cachedToken{
208 ID: cacheID,
209 AgentID: agentID,
210 GitLabURL: gitlabURL,
211 Token: &pat,
212 Source: "filesystem",
213 Expired: pat.ExpiresAt != nil && time.Time(*pat.ExpiresAt).Before(time.Now().UTC()),
214 Revoked: pat.Revoked,
215 }
217 return token, nil
220func (o *options) displayTokens(tokens []cachedToken) {
221 tp := tableprinter.NewTablePrinter()
222 tp.AddRow("Agent ID", "GitLab URL", "Token Name", "Source", "Expires At", "Status")
224 for _, token := range tokens {
225 expiresAt := "Never"
226 if token.Token.ExpiresAt != nil {
227 expiresAt = time.Time(*token.Token.ExpiresAt).Format(time.RFC3339)
228 }
230 status := "Valid"
231 if token.Expired {
232 status = "Expired"
233 } else if token.Revoked {
234 status = "Revoked"
235 }
237 tp.AddRow(token.AgentID, token.GitLabURL, token.Token.Name, token.Source, expiresAt, status)
238 }
240 o.io.LogInfof("%s", tp.Render())
Diagnostics10 git calls · 228 ms
CallStatusSizeTime0228 ms
discover200185 B2 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=185
git.server.agent=git/2.56.g1891de4-Linux
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch server-option object-format
git.server.fetch=shallow wait-for-done filter
git.protocol.version=2
git.pkt.frames=9
git.pkt.data=7
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=185
git.pkt.payload.max=35
ls-refs20058 KiB · hit2 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=59849
git.response.cache=HIT
git.response.duration_ms=2
git.protocol.version=2
git.pkt.frames=731
git.pkt.data=730
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=59849
git.pkt.payload.max=143
git.ls_refs.count=730
git.ls_refs.head=refs/heads/main
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=4273
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=combine:blob:none+tree:2
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=1
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=7
git.pkt.data=5
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=4273
git.pkt.payload.max=4173
git.sideband.band1.bytes=4173
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=11
git.pack.bytes=4173
git.fetch.wide.objects=11
git.fetch.wide.extra_bytes=3930
git.fetch.wide.blobs=0
fetchtree:0 · deepen 1020032 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=32926
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=22
git.pkt.data=20
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=32926
git.pkt.payload.max=32046
git.sideband.band1.bytes=32046
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=80
git.pack.bytes=32046
git.pack.ofs_delta=36
git.pack.ref_delta=0
git.pack.chain.max=2
git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91
git.pack.full=44
Open pack map
fetchtree:02001.8 KiB · hit1 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=1
git.response.bytes=1857
git.response.cache=HIT
git.response.duration_ms=1
git.fetch.filter=tree:0
git.fetch.wants=dce174ff8c632a19d17eea99c8a9b7c37fb2b592
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1857
git.pkt.payload.max=1830
git.sideband.band1.bytes=1830
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1830
git.pack.trailer=fb03183b7909876778f740d196d7516811003517
Open pack map
fetchtree:0200200 B · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=200
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=9988d47506dcbe3004b8b72cbdb9d66d6d75cda4
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=200
git.pkt.payload.max=173
git.sideband.band1.bytes=173
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=173
git.pack.trailer=948ee807a1ee817af67f2df94421a202e82325f9
Open pack map
fetchtree:0200405 B · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=405
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=d271680e941992259de0ff84d4a04bcbba55f531
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=405
git.pkt.payload.max=378
git.sideband.band1.bytes=378
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=378
git.pack.trailer=adfacba5ff1f4fcf28dcaac12e2874f6d48a7934
Open pack map
fetchtree:0200175 B · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=175
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=b2f8b8171cc11242e253b76b9b852197f2ebc178
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=175
git.pkt.payload.max=148
git.sideband.band1.bytes=148
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=148
git.pack.trailer=e894e38a7c0abf202dc4cff099138af128997f53
Open pack map
fetchtree:0200166 B · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=166
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=92a9b75f424e03656d9e79de23b380ee6f603a90
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=166
git.pkt.payload.max=139
git.sideband.band1.bytes=139
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=139
git.pack.trailer=dbfeb102fb320f5a06d4db129610e55c3aee3b59
Open pack map
fetch2002.1 KiB214 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=214
git.response.bytes=2167
git.response.cache=MISS
git.response.duration_ms=214
git.fetch.wants=eb4a665dc2deaa4bdcefa38a7b89075ed518a159
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=2167
git.pkt.payload.max=2140
git.sideband.band1.bytes=2140
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://gitlab.com/gitlab-org/cli
Ref
refs/heads/main
Commit
0dd7574dce9e385c5c30540e6c15657adc6bdce9
cf-ray
a5eb14a81f95cf75
Request
c9df381c…
Protocol
v2 · sha1
Agent
git/2.56.g1891de4-Linux
Filter
advertised
Fetch
shallow wait-for-done filter
Capabilities
agent ls-refs fetch server-option object-format