GitLabgitlab-org

cli

main
ply7 git calls27 ms99 KiB6 cachedprotocol v2
70 lines3.2 KiBRaw

Run go through the GitLab Dependency Firewall. (BETA)

Synopsis

Run the go binary through the GitLab Dependency Firewall. The command checks each module download against the policy for the current project, refuses blocked modules, and summarizes the results after the run.

Module downloads go through a Go module proxy that the command starts on 127.0.0.1 for the run. No certificate is involved, so your system trust store is not changed.

For the run, GOPROXY points at that proxy, GONOPROXY is none, and GO111MODULE is on, so every module download is checked. Private modules matched by GOPRIVATE are also checked, then fetched the way your configuration fetches them.

If you set GOPROXY=off, the command keeps it.

Allowed modules are downloaded through your configured GOPROXY, from the environment or the go env file, in list order and with its fallbacks. Credentials for that proxy come from your .netrc file, GOAUTH, or the URL itself. A GOSUMDB with its own URL is reached through the proxy the command starts; credentials for that URL must be in the URL itself, because .netrc and GOAUTH apply only to GOPROXY.

The command checks only modules that go downloads during the run:

  • Modules already in your module cache are not checked. In CI, point GOMODCACHE at an empty directory to check every module.
  • Vendored code and replace directives that point at a local path are not checked.
  • Go toolchain downloads are not checked by policy. go verifies them against the checksum database.

Module paths and versions, including private ones, are sent to the policy API and written to .gitlab/df/ci-log.json. CI jobs that upload that file publish them with the job's artifacts.

Tests that make HTTPS requests can fail certificate checks under this command. Run go test outside the firewall if your tests reach the network.

All arguments are forwarded to go verbatim.

This feature is in beta and might not be ready for production use. It might be unstable and breaking changes can occur outside of major releases. For more information, see https://docs.gitlab.com/policy/development_stages_support/.

plaintext
glab dependency-firewall go <go args> [flags]

Examples

console
# Download modules through the Dependency Firewall
glab dependency-firewall go mod download

# Add a dependency, checking it against the policy first
glab dependency-firewall go get github.com/pkg/errors@v0.9.1

Environment variables

plaintext
HTTPS_PROXY: outbound proxy glab uses to reach package registries. Credentials in the URL are sent to the proxy.
NO_PROXY: hosts glab reaches directly instead of through HTTPS_PROXY.

Options inherited from parent commands

plaintext
  -h, --help   Show help for this command.
1---
2title: '`glab dependency-firewall go`'
3stage: AI Clients
4group: Developer Clients
5info: To determine the technical writer assigned to the Stage/Group associated with this page, see <https://handbook.gitlab.com/handbook/marketing/product-and-technical-marketing/technical-writing/#assignments>
6---
8<!--
9This documentation is auto generated by a script.
10Please do not edit this file directly. Run `make gen-docs` instead.
11-->
13Run go through the GitLab Dependency Firewall. (BETA)
15## Synopsis
17Run the go binary through the GitLab Dependency Firewall. The command checks each module download against the policy for the current project, refuses blocked modules, and summarizes the results after the run.
19Module downloads go through a Go module proxy that the command starts on `127.0.0.1` for the run. No certificate is involved, so your system trust store is not changed.
21For the run, `GOPROXY` points at that proxy, `GONOPROXY` is `none`, and `GO111MODULE` is `on`, so every module download is checked. Private modules matched by `GOPRIVATE` are also checked, then fetched the way your configuration fetches them.
23If you set `GOPROXY=off`, the command keeps it.
25Allowed modules are downloaded through your configured `GOPROXY`, from the environment or the `go env` file, in list order and with its fallbacks. Credentials for that proxy come from your `.netrc` file, `GOAUTH`, or the URL itself. A `GOSUMDB` with its own URL is reached through the proxy the command starts; credentials for that URL must be in the URL itself, because `.netrc` and `GOAUTH` apply only to `GOPROXY`.
27The command checks only modules that `go` downloads during the run:
29- Modules already in your module cache are not checked. In CI, point `GOMODCACHE` at an empty directory to check every module.
30- Vendored code and `replace` directives that point at a local path are not checked.
31- Go toolchain downloads are not checked by policy. `go` verifies them against the checksum database.
33Module paths and versions, including private ones, are sent to the policy API and written to `.gitlab/df/ci-log.json`. CI jobs that upload that file publish them with the job's artifacts.
35Tests that make HTTPS requests can fail certificate checks under this command. Run `go test` outside the firewall if your tests reach the network.
37All arguments are forwarded to `go` verbatim.
39This feature is in beta and might not be ready for production use.
40It might be unstable and breaking changes can occur outside of major releases.
41For more information, see
42<https://docs.gitlab.com/policy/development_stages_support/>.
44```plaintext
45glab dependency-firewall go <go args> [flags]
46```
48## Examples
50```console
51# Download modules through the Dependency Firewall
52glab dependency-firewall go mod download
54# Add a dependency, checking it against the policy first
55glab dependency-firewall go get github.com/pkg/errors@v0.9.1
57```
59## Environment variables
61```plaintext
62HTTPS_PROXY: outbound proxy glab uses to reach package registries. Credentials in the URL are sent to the proxy.
63NO_PROXY: hosts glab reaches directly instead of through HTTPS_PROXY.
64```
66## Options inherited from parent commands
68```plaintext
69 -h, --help Show help for this command.
70```
Diagnostics7 git calls · 27 ms
CallStatusSizeTime027 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 · 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:0 · deepen 1020032 KiB · hit6 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=32926
git.response.cache=HIT
git.response.duration_ms=6
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.7 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=1744
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=5e4007a5673eb3bf5d0d7f1a1463c3b2ca3fb3bd
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=1744
git.pkt.payload.max=1717
git.sideband.band1.bytes=1717
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1717
git.pack.trailer=3f1b9ccc7756e8941d6705e8187c87fd922113e6
Open pack map
fetchtree:0200603 B · 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=603
git.response.cache=HIT
git.response.duration_ms=1
git.fetch.filter=tree:0
git.fetch.wants=5176f4db5d2291e59ebb86e84c285997df7bb735
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=603
git.pkt.payload.max=576
git.sideband.band1.bytes=576
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=576
git.pack.trailer=d6a5813e7d910c309af173a8e72c7467abf35dc7
Open pack map
fetch2001.5 KiB · hit18 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=18
git.response.bytes=1586
git.response.cache=HIT
git.response.duration_ms=18
git.fetch.wants=495bad0a3ae134c6cd6d5de3a4ad7616673b57ed
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=1586
git.pkt.payload.max=1559
git.sideband.band1.bytes=1559
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
a5e1f1a13c3aefe9
Request
33b7cc58…
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