GitLabgitlab-org
cli
main
1package authutils
3import (
4 "bytes"
5 "context"
6 "fmt"
7 "path/filepath"
8 "strings"
10 "charm.land/huh/v2"
11 "github.com/MakeNowJust/heredoc/v2"
12 "github.com/google/shlex"
14 "gitlab.com/gitlab-org/cli/internal/git"
15 "gitlab.com/gitlab-org/cli/internal/iostreams"
16 "gitlab.com/gitlab-org/cli/internal/run"
17)
19type GitCredentialFlow struct {
20 Executable string
22 shouldSetup bool
23 helper string
24}
26func (gc *GitCredentialFlow) Prompt(ctx context.Context, io *iostreams.IOStreams, hostname, protocol string) error {
27 gc.helper, _ = gitCredentialHelper(hostname, protocol)
28 if isOurCredentialHelper(gc.helper) {
29 return nil
30 }
32 gc.shouldSetup = true // default value
33 confirm := huh.NewConfirm().
34 Title("Authenticate Git with your GitLab credentials?").
35 Value(&gc.shouldSetup)
36 err := io.Run(ctx, confirm)
37 if err != nil {
38 return fmt.Errorf("could not prompt: %w", err)
39 }
41 return nil
42}
44func (gc *GitCredentialFlow) ShouldSetup() bool {
45 return gc.shouldSetup
46}
48func (gc *GitCredentialFlow) Setup(hostname, protocol, username, authToken string) error {
49 return gc.gitCredentialSetup(hostname, protocol, username, authToken)
50}
52// SetupHelper configures glab as the Git credential helper for hostname
53// without prompting, for callers that already know the user's intent: a
54// non-interactive login cannot answer Prompt, but still needs Git to
55// authenticate. It is safe to run again: the host key is rewritten rather than
56// appended to, whatever the executable is called.
57func (gc *GitCredentialFlow) SetupHelper(hostname, protocol string) error {
58 helper, _ := gitCredentialHelper(hostname, protocol)
59 if isOurCredentialHelper(helper) {
60 return nil
61 }
63 // An empty helper selects the branch in gitCredentialSetup that makes glab
64 // the helper for this host. Any other helper would only receive the
65 // credentials instead, which is not what the caller asked for.
66 gc.helper = ""
67 return gc.gitCredentialSetup(hostname, protocol, "", "")
68}
70func (gc *GitCredentialFlow) gitCredentialSetup(hostname, protocol, username, password string) error {
71 if gc.helper == "" {
72 // first use a blank value to indicate to git we want to sever the chain of credential helpers.
73 // --replace-all also collapses a key that holds several values, for example
74 // glab installed under another executable name by an earlier run, which a
75 // plain `git config` refuses to overwrite.
76 preConfigureCmd := git.GitCommand("config", "--global", "--replace-all", gitCredentialHelperKey(hostname, protocol), "")
77 if err := run.PrepareCmd(preConfigureCmd).Run(); err != nil {
78 return err
79 }
81 // use glab as a credential helper (for this host only)
82 configureCmd := git.GitCommand(
83 "config", "--global", "--add",
84 gitCredentialHelperKey(hostname, protocol),
85 fmt.Sprintf("!%s auth git-credential", shellQuote(gc.Executable)),
86 )
87 return run.PrepareCmd(configureCmd).Run()
88 }
90 // clear previous cached credentials
91 rejectCmd := git.GitCommand("credential", "reject")
93 rejectCmd.Stdin = bytes.NewBufferString(heredoc.Docf(`
94 protocol=%s
95 host=%s
96 `, protocol, hostname))
98 err := run.PrepareCmd(rejectCmd).Run()
99 if err != nil {
100 return err
101 }
103 approveCmd := git.GitCommand("credential", "approve")
105 approveCmd.Stdin = bytes.NewBufferString(heredoc.Docf(`
106 protocol=https
107 host=%s
108 username=%s
109 password=%s
110 `, hostname, username, password))
112 err = run.PrepareCmd(approveCmd).Run()
113 if err != nil {
114 return err
115 }
117 return nil
118}
120func gitCredentialHelperKey(hostname, protocol string) string {
121 return fmt.Sprintf("credential.%s://%s.helper", protocol, hostname)
122}
124func gitCredentialHelper(hostname, protocol string) (string, error) {
125 helper, err := git.Config(gitCredentialHelperKey(hostname, protocol))
126 if helper != "" {
127 return helper, err
128 }
129 return git.Config("credential.helper")
130}
132func isOurCredentialHelper(cmd string) bool {
133 if !strings.HasPrefix(cmd, "!") {
134 return false
135 }
137 args, err := shlex.Split(cmd[1:])
138 if err != nil || len(args) == 0 {
139 return false
140 }
142 return strings.TrimSuffix(filepath.Base(args[0]), ".exe") == "glab"
143}
145func shellQuote(s string) string {
146 if strings.ContainsAny(s, " $") {
147 return "'" + s + "'"
148 }
149 return s
150}
Diagnostics8 git calls · 252 ms
CallStatusSizeTime0252 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 · hit3 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=3 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
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=44Open pack map
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · 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=4273 git.response.cache=HIT git.response.duration_ms=3 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:02001.8 KiB · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=4 git.response.bytes=1857 git.response.cache=HIT git.response.duration_ms=4 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=fb03183b7909876778f740d196d7516811003517Open pack map
fetchtree:0200358 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=358 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=5d783fac547a70b19ca138c47d067b44febb52da 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=358 git.pkt.payload.max=331 git.sideband.band1.bytes=331 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=331 git.pack.trailer=22a484e5ecad6d6e62b224e8a7f90cf5ff085938Open pack map
fetchtree:0200182 B · hit5 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=5 git.response.bytes=182 git.response.cache=HIT git.response.duration_ms=5 git.fetch.filter=tree:0 git.fetch.wants=b401cd039a9466005aa37ac69d6905d8fe4b7505 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=182 git.pkt.payload.max=155 git.sideband.band1.bytes=155 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=155 git.pack.trailer=840999ffd917b821da1e8c0dc906c73b383f2afcOpen pack map
fetch2001.5 KiB234 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=234 git.response.bytes=1575 git.response.cache=MISS git.response.duration_ms=234 git.fetch.wants=13774ffe3b8284f652acf8317a8efab2275cbe58 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=1575 git.pkt.payload.max=1548 git.sideband.band1.bytes=1548 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
- a5e215f9af86984a
- Request
- 66fb9d52…
- 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