GitLabgitlab-org
cli
main
1package login
3import (
4 "net/url"
5 "os"
6 "path/filepath"
7 "strings"
8)
10// npmrcPathFor returns the .npmrc this command writes: npm's user config.
11//
12// npm_config_userconfig wins over ~/.npmrc, because npm reads it there: the
13// userconfig option defaults to "~/.npmrc" and "may be overridden by the
14// npm_config_userconfig environment variable or the --userconfig command line
15// option". Writing ~/.npmrc on a machine that sets it leaves the token in a
16// file npm never reads, and the command still prints a green check. The
17// command-line option is out of reach from here, so a user passing
18// --userconfig has to point this command at the same file themselves.
19func npmrcPathFor(home string) string {
20 // npm lower-cases every npm_config_* variable it reads, so both spellings
21 // reach it. Only the lower-cased one is authoritative when both are set:
22 // that is the spelling npm's own documentation uses.
23 for _, name := range []string{"npm_config_userconfig", "NPM_CONFIG_USERCONFIG"} {
24 if path := os.Getenv(name); path != "" {
25 return path
26 }
27 }
28 return filepath.Join(home, ".npmrc")
29}
31// npmDefaultPort returns the port the WHATWG URL parser omits from the host
32// for scheme, which is the port npm therefore leaves out of its .npmrc key.
33// An unrecognized scheme has none, and an absent port compares equal to that,
34// so the caller's comparison holds either way.
35func npmDefaultPort(scheme string) string {
36 switch strings.ToLower(scheme) {
37 case "https":
38 return "443"
39 case "http":
40 return "80"
41 default:
42 return ""
43 }
44}
46// loginNpm upserts a "//{host}{path}/:_authToken=" line in npm's user config
47// for registry, matched by exact line-prefix (not substring), so that
48// "//registry.example.com/" never matches
49// "//registry.example.com.evil.com/".
50//
51// The host keeps its port, unlike sbt's: npm's .npmrc keys are the registry
52// URL including the port, and npm matches on that.
53func loginNpm(registry *url.URL, token string) error {
54 // Lower-cased because npm derives this key by parsing the registry URL,
55 // which normalizes the host to lower case, while url.Parse preserves what
56 // the user typed. Writing "//AR.Example.com/:_authToken=" would leave npm
57 // looking up "//ar.example.com/:_authToken=" and finding nothing: a 401 at
58 // install time with nothing wrong at login time.
59 //
60 // The port survives for the same reason it is dropped when it is the
61 // scheme's default: npm's key is whatever the WHATWG URL parser calls the
62 // host, and that keeps ":8443" while omitting ":443" on https and ":80" on
63 // http. Writing the default port would be another key npm never looks up.
64 host := strings.ToLower(registry.Host)
65 if registry.Port() == npmDefaultPort(registry.Scheme) {
66 host = strings.ToLower(registry.Hostname())
67 }
69 // EscapedPath, not Path: npm builds the key from the URL's pathname, which
70 // keeps percent-encoding, and walks it up one segment at a time without
71 // ever decoding. For a GitLab package endpoint carrying an encoded project
72 // path, ".../projects/group%2Fproj/packages/npm/", the decoded spelling is
73 // a key npm never looks up, so the request goes out anonymous. URL paths
74 // are case-sensitive, so unlike the host this is left as typed.
75 path := strings.TrimSuffix(registry.EscapedPath(), "/")
77 prefix := "//" + host + path + "/:_authToken="
78 line := prefix + token
80 home, err := homeDir()
81 if err != nil {
82 return err
83 }
85 return upsertLines(npmrcPathFor(home), func(lines []string) ([]string, error) {
86 found := false
87 for i, l := range lines {
88 // Leading whitespace is skipped because npm's ini parser trims
89 // every key before matching it, so " //ar.example.com/:_authToken="
90 // is a live entry. Matching it strictly would append a second one
91 // per login and leave the superseded token in the file.
92 indent := l[:len(l)-len(strings.TrimLeft(l, " \t"))]
93 if !strings.HasPrefix(l[len(indent):], prefix) {
94 continue
95 }
96 lines[i] = indent + line
97 found = true
98 }
99 if !found {
100 lines = append(lines, line)
101 }
102 return lines, nil
103 })
104}
Diagnostics8 git calls · 204 ms
CallStatusSizeTime0204 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=3 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
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=44Open pack map
fetchtree:02001.8 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=1857 git.response.cache=HIT git.response.duration_ms=2 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:0200242 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=242 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=5da85e254ab77f5f6e7e1419be57d524a9f8208e 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=242 git.pkt.payload.max=215 git.sideband.band1.bytes=215 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=215 git.pack.trailer=bd426fb1ae09d9fdcf755902c6903cd2eea819b2Open pack map
fetchtree:0200494 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=494 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=400358373377bb8e4922d8b821520ebdf8130c4d 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=494 git.pkt.payload.max=467 git.sideband.band1.bytes=467 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=467 git.pack.trailer=363b27e4d94209a9331c11b44fe1ce6e5f4e6e81Open pack map
fetch2001.9 KiB192 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=192 git.response.bytes=1909 git.response.cache=MISS git.response.duration_ms=192 git.fetch.wants=b925ec83d62122f875cf95b9bac2874273b0dcf5 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=1909 git.pkt.payload.max=1882 git.sideband.band1.bytes=1882 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
- a5e2fb70fbe3cf81
- Request
- 0a8d4b8d…
- 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