Documentation
¶
Overview ¶
Package ocular is a package to provide the Ocular application, a code scanning orchestration tool for static application security testing. It is designed to have easily swappable components depending on: what you want to scan with, how you want to enumerate targets, and where you want to upload results to.
Directories
¶
Path | Synopsis |
---|---|
cmd
|
|
api-server
Entrypoint for the API server.
|
Entrypoint for the API server. |
extractor
Utility image to transfer files between scanners and uploaders.
|
Utility image to transfer files between scanners and uploaders. |
hack
|
|
internal
|
|
config
Package config provides the global configuration for Ocular.
|
Package config provides the global configuration for Ocular. |
unittest/mocks
Package mocks will contain all the generated mocks for the unit tests.
|
Package mocks will contain all the generated mocks for the unit tests. |
unittest/mocks/internal/cluster
Package cluster is a generated GoMock package.
|
Package cluster is a generated GoMock package. |
unittest/mocks/pkg/cluster
Package cluster is a generated GoMock package.
|
Package cluster is a generated GoMock package. |
unittest/mocks/pkg/storage
Package storage is a generated GoMock package.
|
Package storage is a generated GoMock package. |
pkg
|
|
api/client
Package client is a package that provides a client for making HTTP requests to the Ocular API.
|
Package client is a package that provides a client for making HTTP requests to the Ocular API. |
api/middleware
Package middleware provides middleware for the Ocular API.
|
Package middleware provides middleware for the Ocular API. |
api/routes
Package routes (and sub-packages) provides the API routes for the Ocular application.
|
Package routes (and sub-packages) provides the API routes for the Ocular application. |
cluster
Package cluster provides function to interact with Kubernetes clusters.
|
Package cluster provides function to interact with Kubernetes clusters. |
errors
Package errors provides a way to create and handle errors with types and messages.
|
Package errors provides a way to create and handle errors with types and messages. |
identities
Package identities provides the Identity type which represents the identity of a user in the cluster.
|
Package identities provides the Identity type which represents the identity of a user in the cluster. |
pipelines
Package pipelines implements the logic to run a pipeline for a target using a profile.
|
Package pipelines implements the logic to run a pipeline for a target using a profile. |
resources
Package downloaders provides the Downloader type which represents the init container that will download a static asset (target) to be scanned.
|
Package downloaders provides the Downloader type which represents the init container that will download a static asset (target) to be scanned. |
runtime
Package runtime provides functions to manage the runtime environment of the application.
|
Package runtime provides functions to manage the runtime environment of the application. |
schemas
Package schemas provides types that will be used in the API and marshalled or unmarshalled from user data
|
Package schemas provides types that will be used in the API and marshalled or unmarshalled from user data |
searches
Package searches provides functions to manage invocation of a [Search].
|
Package searches provides functions to manage invocation of a [Search]. |
Click to show internal directories.
Click to hide internal directories.