GitLabgitlab-org

cli

main
ply7 git calls237 ms99 KiB5 cachedprotocol v2
76 lines3.0 KiBRaw

Check a package against the GitLab Dependency Firewall. (BETA)

Synopsis

Check a single package coordinate against the GitLab Dependency Firewall policy for the current project and report the outcome (allow, warning, blocked). No package manager binary is required.

Supported package URL (PURL) types are npm, pypi, maven, gem, nuget, cargo, and golang. The PURL must include a version, for example pkg:npm/left-pad@1.3.0. For golang, the module path keeps its case, for example pkg:golang/github.com/BurntSushi/toml@v1.4.0.

An allowed package prints one line, for example, left-pad@1.3.0: allowed by the Dependency Firewall. A warned or blocked package prints the same summary as the package manager commands.

This command does not write to the CI log at .gitlab/df/ci-log.json, so glab dependency-firewall ci-summary does not include its result.

Exit codes:

Exit codeMeaning
0Allowed or warned, or the Dependency Firewall is not evaluating the project.
1The PURL is invalid or has no version, the project or credentials can't be resolved, or the request to GitLab failed.
3Blocked.

An exit code of 0 does not always mean GitLab checked the package. If the Dependency Firewall is not evaluating the project, the command prints a line that ends with the Dependency Firewall is not evaluating this project; allowing.

Unlike the package manager commands, this command does not block the package when the request to GitLab fails. It exits with 1 instead.

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 package <purl> [flags]

Examples

console
# Check an npm package version
glab dependency-firewall package pkg:npm/left-pad@1.3.0

# Check a PyPI package version
glab dependency-firewall package pkg:pypi/requests@2.31.0

# Check a Maven package version
glab dependency-firewall package pkg:maven/org.slf4j/slf4j-api@2.0.13

# Check a RubyGems package version
glab dependency-firewall package pkg:gem/rails@7.1.3

# Check a NuGet package version
glab dependency-firewall package pkg:nuget/Newtonsoft.Json@13.0.1

# Check a Cargo package version
glab dependency-firewall package pkg:cargo/serde@1.0.197

# Check a Go module version
glab dependency-firewall package pkg:golang/github.com/pkg/errors@v0.9.1

Options inherited from parent commands

plaintext
  -h, --help   Show help for this command.
1---
2title: '`glab dependency-firewall package`'
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-->
13Check a package against the GitLab Dependency Firewall. (BETA)
15## Synopsis
17Check a single package coordinate against the GitLab Dependency Firewall policy for the current project and report the outcome (allow, warning, blocked). No package manager binary is required.
19Supported package URL (PURL) types are `npm`, `pypi`, `maven`, `gem`, `nuget`, `cargo`, and `golang`. The PURL must include a version, for example `pkg:npm/left-pad@1.3.0`. For `golang`, the module path keeps its case, for example `pkg:golang/github.com/BurntSushi/toml@v1.4.0`.
21An allowed package prints one line, for example, `left-pad@1.3.0: allowed by the Dependency Firewall.` A warned or blocked package prints the same summary as the package manager commands.
23This command does not write to the CI log at `.gitlab/df/ci-log.json`, so `glab dependency-firewall ci-summary` does not include its result.
25Exit codes:
27| Exit code | Meaning |
28|-----------|---------|
29| `0` | Allowed or warned, or the Dependency Firewall is not evaluating the project. |
30| `1` | The PURL is invalid or has no version, the project or credentials can't be resolved, or the request to GitLab failed. |
31| `3` | Blocked. |
33An exit code of `0` does not always mean GitLab checked the package. If the Dependency Firewall is not evaluating the project, the command prints a line that ends with `the Dependency Firewall is not evaluating this project; allowing.`
35Unlike the package manager commands, this command does not block the package when the request to GitLab fails. It exits with `1` instead.
37This feature is in beta and might not be ready for production use.
38It might be unstable and breaking changes can occur outside of major releases.
39For more information, see
40<https://docs.gitlab.com/policy/development_stages_support/>.
42```plaintext
43glab dependency-firewall package <purl> [flags]
44```
46## Examples
48```console
49# Check an npm package version
50glab dependency-firewall package pkg:npm/left-pad@1.3.0
52# Check a PyPI package version
53glab dependency-firewall package pkg:pypi/requests@2.31.0
55# Check a Maven package version
56glab dependency-firewall package pkg:maven/org.slf4j/slf4j-api@2.0.13
58# Check a RubyGems package version
59glab dependency-firewall package pkg:gem/rails@7.1.3
61# Check a NuGet package version
62glab dependency-firewall package pkg:nuget/Newtonsoft.Json@13.0.1
64# Check a Cargo package version
65glab dependency-firewall package pkg:cargo/serde@1.0.197
67# Check a Go module version
68glab dependency-firewall package pkg:golang/github.com/pkg/errors@v0.9.1
70```
72## Options inherited from parent commands
74```plaintext
75 -h, --help Show help for this command.
76```
Diagnostics7 git calls · 237 ms
CallStatusSizeTime0237 ms
discover200185 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
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=44
Open pack map
fetchtree:02001.7 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=1744
git.response.cache=HIT
git.response.duration_ms=2
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 · 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=603
git.response.cache=HIT
git.response.duration_ms=3
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.3 KiB227 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=227
git.response.bytes=1362
git.response.cache=MISS
git.response.duration_ms=227
git.fetch.wants=4bea9aee99009987805722e564a7fb3ac036fd1e
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=1362
git.pkt.payload.max=1335
git.sideband.band1.bytes=1335
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
a5e18fb39a6c5e37
Request
d38d6620…
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