Directories
¶
| Path | Synopsis |
|---|---|
|
Package app wires configuration, the stores and the HTTP server together.
|
Package app wires configuration, the stores and the HTTP server together. |
|
Package archive reads zip, tar and tar.gz archives: the walker the item service explodes and serves archive entries with, and a bounded walker and reader the format handlers (decision 0032) read packages with, such as an npm tarball's package.json and file count, a Go module zip's go.mod or a jar's POM.
|
Package archive reads zip, tar and tar.gz archives: the walker the item service explodes and serves archive entries with, and a bounded walker and reader the format handlers (decision 0032) read packages with, such as an npm tarball's package.json and file count, a Go module zip's go.mod or a jar's POM. |
|
Package auth authenticates requests and seeds the built-in principals (decision 0005).
|
Package auth authenticates requests and seeds the built-in principals (decision 0005). |
|
idtoken
Package idtoken verifies ID tokens that an external OpenID Connect provider, typically a CI system, signed: the subject tokens of the Access OIDC token exchange (POST /access/api/v1/oidc/token, research 21).
|
Package idtoken verifies ID tokens that an external OpenID Connect provider, typically a CI system, signed: the subject tokens of the Access OIDC token exchange (POST /access/api/v1/oidc/token, research 21). |
|
idtoken/idtokentest
Package idtokentest is a fake OpenID Connect provider for tests: it serves a discovery document and a JWKS, as GitHub Actions, GitLab and other CI systems do, and mints ID tokens signed with its current key.
|
Package idtokentest is a fake OpenID Connect provider for tests: it serves a discovery document and a JWKS, as GitHub Actions, GitLab and other CI systems do, and mints ID tokens signed with its current key. |
|
token
Package token issues and verifies Access tokens (decision 0005): RS256 JWTs signed with a per-instance key, reference tokens and refresh tokens.
|
Package token issues and verifies Access tokens (decision 0005): RS256 JWTs signed with a per-instance key, reference tokens and refresh tokens. |
|
Package authz evaluates Artifactory's permission model (decision 0006): the admin flag, the union of grants to a user and their groups, permission targets with Ant include and exclude patterns, the anonymous user, and token scopes, which only ever remove actions but for applied-permissions/admin, an administrator's token whatever its subject.
|
Package authz evaluates Artifactory's permission model (decision 0006): the admin flag, the union of grants to a user and their groups, permission targets with Ant include and exclude patterns, the anonymous user, and token scopes, which only ever remove actions but for applied-permissions/admin, an administrator's token whatever its subject. |
|
Package buildinfo carries version metadata injected with -ldflags -X (see LDFLAGS in the Makefile).
|
Package buildinfo carries version metadata injected with -ldflags -X (see LDFLAGS in the Makefile). |
|
Package config loads the application configuration described in docs/operations/configuration-reference.md and decision record 0009.
|
Package config loads the application configuration described in docs/operations/configuration-reference.md and decision record 0009. |
|
Package crypt seals secret columns at rest (decision record 0017): remote repository and proxy passwords, LDAP and mail credentials, webhook secrets, key pair private keys, OIDC secrets and the token signing key.
|
Package crypt seals secret columns at rest (decision record 0017): remote repository and proxy passwords, LDAP and mail credentials, webhook secrets, key pair private keys, OIDC secrets and the token signing key. |
|
Package descriptor reads Artifactory's YAML configuration descriptor and applies it (decision 0009): the body of PATCH /api/system/configuration, `artifactweave config apply` and the bootstrap descriptor.
|
Package descriptor reads Artifactory's YAML configuration descriptor and applies it (decision 0009): the body of PATCH /api/system/configuration, `artifactweave config apply` and the bootstrap descriptor. |
|
Package format is the contract between the item service and the package formats (decision 0032): the hooks every format implements, the optional interfaces a format adds for what it needs, the environment they run in, and the Rejection a format refuses a request with.
|
Package format is the contract between the item service and the package formats (decision 0032): the hooks every format implements, the optional interfaces a format adds for what it needs, the environment they run in, and the Rejection a format refuses a request with. |
|
docker
Package docker is the storage layout of Docker and OCI images in a repository's item tree (decision 0031), which the JFrog CLI reads with AQL and the storage API: an image is a folder, each tag a folder of its own below it and each manifest pushed by digest a folder named sha256:<hex>, and every blob a file named sha256__<hex> in the folders of the images that use it.
|
Package docker is the storage layout of Docker and OCI images in a repository's item tree (decision 0031), which the JFrog CLI reads with AQL and the storage API: an image is a folder, each tag a folder of its own below it and each manifest pushed by digest a folder named sha256:<hex>, and every blob a file named sha256__<hex> in the folders of the images that use it. |
|
formats
Package formats picks the format of a package type.
|
Package formats picks the format of a package type. |
|
formattest
Package formattest is the contract suite for package formats (decision 0032).
|
Package formattest is the contract suite for package formats (decision 0032). |
|
generic
Package generic is the format of generic repositories: files without package metadata, so nothing is indexed.
|
Package generic is the format of generic repositories: files without package metadata, so nothing is indexed. |
|
golang
Package golang is the format of Go module repositories (decision 0035).
|
Package golang is the format of Go module repositories (decision 0035). |
|
maven
Package maven is the format of maven, gradle, ivy and sbt repositories (decision 0036): Maven's naming predicates, the coordinates a repository's layout reads from a path, and the package index of decision 0018, kept by the hooks on every write path and rebuilt by Reindex.
|
Package maven is the format of maven, gradle, ivy and sbt repositories (decision 0036): Maven's naming predicates, the coordinates a repository's layout reads from a path, and the package index of decision 0018, kept by the hooks on every write path and rebuilt by Reindex. |
|
npm
Package npm is the format of npm repositories (decision 0034).
|
Package npm is the format of npm repositories (decision 0034). |
|
Package keymaterial checks the key material the security API stores: that the private and public halves of an RSA or GPG key pair belong together, and that a client certificate bundle carries its own private key.
|
Package keymaterial checks the key material the security API stores: that the private and public halves of an RSA or GPG key pair belong together, and that a client certificate bundle carries its own private key. |
|
Package openapibundle merges the per-family spec fragments under api/src/<service>/ into the one document oapi-codegen and the parity test read.
|
Package openapibundle merges the per-family spec fragments under api/src/<service>/ into the one document oapi-codegen and the parity test read. |
|
Package repos holds the repository operations that more than one entry point performs: the repositories API, the configuration descriptor (PATCH /api/system/configuration, config apply and the bootstrap descriptor).
|
Package repos holds the repository operations that more than one entry point performs: the repositories API, the configuration descriptor (PATCH /api/system/configuration, config apply and the bootstrap descriptor). |
|
Package server builds the single chi router that serves every JFrog path prefix: /artifactory, /access, /event, /router, /jfconnect and /v2.
|
Package server builds the single chi router that serves every JFrog path prefix: /artifactory, /access, /event, /router, /jfconnect and /v2. |
|
apierror
Package apierror renders errors in the envelope each client surface expects.
|
Package apierror renders errors in the envelope each client surface expects. |
|
baseurl
Package baseurl resolves the public base URL a response must embed.
|
Package baseurl resolves the public base URL a response must embed. |
|
docker
Package docker serves the registry protocol, the OCI Distribution Specification v1.1 with Docker's extensions, for docker, oci and helmoci repositories (decisions 0003 and 0031).
|
Package docker serves the registry protocol, the OCI Distribution Specification v1.1 with Docker's extensions, for docker, oci and helmoci repositories (decisions 0003 and 0031). |
|
gen/access
Package access provides primitives to interact with the openapi HTTP API.
|
Package access provides primitives to interact with the openapi HTTP API. |
|
gen/artifactory
Package artifactory provides primitives to interact with the openapi HTTP API.
|
Package artifactory provides primitives to interact with the openapi HTTP API. |
|
gen/distribution
Package distribution provides primitives to interact with the openapi HTTP API.
|
Package distribution provides primitives to interact with the openapi HTTP API. |
|
gen/event
Package event provides primitives to interact with the openapi HTTP API.
|
Package event provides primitives to interact with the openapi HTTP API. |
|
gen/grid
Package grid provides primitives to interact with the openapi HTTP API.
|
Package grid provides primitives to interact with the openapi HTTP API. |
|
gen/pfed
Package pfed provides primitives to interact with the openapi HTTP API.
|
Package pfed provides primitives to interact with the openapi HTTP API. |
|
gen/worker
Package worker provides primitives to interact with the openapi HTTP API.
|
Package worker provides primitives to interact with the openapi HTTP API. |
|
golang
Package golang serves Go module repositories at /artifactory/api/go/{repoKey}/ through the router kit (decisions 0032 and 0035): the GOPROXY reads the go command makes, and the deploys of jf go-publish.
|
Package golang serves Go module repositories at /artifactory/api/go/{repoKey}/ through the router kit (decisions 0032 and 0035): the GOPROXY reads the go command makes, and the deploys of jf go-publish. |
|
npm
Package npm serves the npm registry of npm repositories at /artifactory/api/npm/{repoKey}/ (decision 0034), mounted through the router kit (decision 0032).
|
Package npm serves the npm registry of npm repositories at /artifactory/api/npm/{repoKey}/ (decision 0034), mounted through the router kit (decision 0032). |
|
pkgroute
Package pkgroute is the router kit for package formats with a protocol of their own: npm and Go in P7, then PyPI, NuGet, Helm and Terraform (decision 0032).
|
Package pkgroute is the router kit for package formats with a protocol of their own: npm and Go in P7, then PyPI, NuGet, Helm and Terraform (decision 0032). |
|
service
|
|
|
build
Package build implements the Builds API (decision 0014): publishing, reading, appending to, renaming and deleting build-info runs, and finding the items a run's artifacts are.
|
Package build implements the Builds API (decision 0014): publishing, reading, appending to, renaming and deleting build-info runs, and finding the items a run's artifacts are. |
|
gc
Package gc reclaims storage (decision 0010).
|
Package gc reclaims storage (decision 0010). |
|
identity
Package identity manages internal users and groups and the account policies (decision 0005): creation and replacement with hashed passwords, group membership and auto-join, the user lock and password expiration policies, locks and forced password changes.
|
Package identity manages internal users and groups and the account policies (decision 0005): creation and replacement with hashed passwords, group membership and auto-join, the user lock and password expiration policies, locks and forced password changes. |
|
item
Package item writes and removes items: the deploy flow of decision 0004 (content into the blob store, then the item and its blob reference in one transaction), checksum deploy, folders, client checksums and deletion into the trash can (decision 0010).
|
Package item writes and removes items: the deploy flow of decision 0004 (content into the blob store, then the item and its blob reference in one transaction), checksum deploy, folders, client checksums and deletion into the trash can (decision 0010). |
|
multipart
Package multipart serves the JFrog CLI's multipart upload protocol, as the pinned jfrog-client-go drives it (artifactory/services/utils/ multipartupload.go): create a session, get a URL per part, PUT the parts concurrently, complete with the file's SHA-1, poll the status, and abort on failure.
|
Package multipart serves the JFrog CLI's multipart upload protocol, as the pinned jfrog-client-go drives it (artifactory/services/utils/ multipartupload.go): create a session, get a URL per part, PUT the parts concurrently, complete with the file's SHA-1, poll the status, and abort on failure. |
|
oidc
Package oidc is Access's OpenID Connect integration (research 21): the providers whose ID tokens artifactweave trusts, the identity mappings that turn a token's claims into an access token, and the token exchange that CI systems call (POST /access/api/v1/oidc/token).
|
Package oidc is Access's OpenID Connect integration (research 21): the providers whose ID tokens artifactweave trusts, the identity mappings that turn a token's claims into an access token, and the token exchange that CI systems call (POST /access/api/v1/oidc/token). |
|
permission
Package permission manages permission documents (decision 0006): the single internal shape behind the v1 and v2 permission-target APIs and the Access v2 permissions API.
|
Package permission manages permission documents (decision 0006): the single internal shape behind the v1 and v2 permission-target APIs and the Access v2 permissions API. |
|
pkgindex
Package pkgindex maintains the package index of decision 0018 for the format handlers: which package and version each file belongs to.
|
Package pkgindex maintains the package index of decision 0018 for the format handlers: which package and version each file belongs to. |
|
registry
Package registry runs the Docker registry's blob uploads (decision 0031).
|
Package registry runs the Docker registry's blob uploads (decision 0031). |
|
roles
Package roles manages global roles and global environments: the Access API's /api/v1/roles and /api/v1/environments (issue #77, decision 0013).
|
Package roles manages global roles and global environments: the Access API's /api/v1/roles and /api/v1/environments (issue #77, decision 0013). |
|
trash
Package trash restores, cleans and purges the trash can (decision 0010).
|
Package trash restores, cleans and purges the trash can (decision 0010). |
|
usage
Package usage computes the storage summary (GET /api/storageinfo): blob totals, item totals per repository and for the trash can, and the capacity of the volume a local blob store lives on.
|
Package usage computes the storage summary (GET /api/storageinfo): blob totals, item totals per repository and for the trash can, and the capacity of the volume a local blob store lives on. |
|
work
Package work runs the persistent work queue (decision 0033): a pool of workers that lease due items, run the handler registered for each item's kind, and complete, retry or park it.
|
Package work runs the persistent work queue (decision 0033): a pool of workers that lease due items, run the handler registered for each item's kind, and complete, retry or park it. |
|
Package specoracle keeps a local, gitignored cache of the OpenAPI blocks JFrog embeds on each docs.jfrog.com endpoint page and compares them with the specs this project authors under api/.
|
Package specoracle keeps a local, gitignored cache of the OpenAPI blocks JFrog embeds on each docs.jfrog.com endpoint page and compares them with the specs this project authors under api/. |
|
sqlstore
|
|
|
postgres
Package postgres opens an artifactweave store on PostgreSQL through pgx's database/sql adapter (decision 0004).
|
Package postgres opens an artifactweave store on PostgreSQL through pgx's database/sql adapter (decision 0004). |
|
sqlcommon
Package sqlcommon implements pkg/store over database/sql for any SQL dialect (decision 0004), following hostweave's dialect layer: one store implementation, a Dialect describing what differs between engines, and embedded per-dialect migrations.
|
Package sqlcommon implements pkg/store over database/sql for any SQL dialect (decision 0004), following hostweave's dialect layer: one store implementation, a Dialect describing what differs between engines, and embedded per-dialect migrations. |
|
sqlite
Package sqlite opens an artifactweave store on SQLite through the pure-Go modernc.org/sqlite driver, so the server builds without CGO on every platform (decision 0004).
|
Package sqlite opens an artifactweave store on SQLite through the pure-Go modernc.org/sqlite driver, so the server builds without CGO on every platform (decision 0004). |
|
sqltest
Package sqltest provides PostgreSQL for the store contract runs.
|
Package sqltest provides PostgreSQL for the store contract runs. |
|
Package stubgen writes a type that implements a generated strict server interface by answering 501 for every operation.
|
Package stubgen writes a type that implements a generated strict server interface by answering 501 for every operation. |
Click to show internal directories.
Click to hide internal directories.