debian-mirror-gitlab/doc/user/application_security/terminology/index.md
2022-08-13 15:12:31 +05:30

11 KiB

stage group info type
Secure Static Analysis To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments reference

Secure and Protect terminology (FREE)

This terminology list for GitLab Secure and Protect aims to:

  • Promote a ubiquitous language for discussing application security.
  • Improve the effectiveness of communication regarding GitLab application security features.
  • Get new contributors up to speed faster.

This document defines application security terms in the specific context of GitLab Secure and Protect features. Terms may therefore have different meanings outside that context.

Terms

Analyzer

Software that performs a scan. The scan analyzes an attack surface for vulnerabilities and produces a report containing findings. Reports adhere to the Secure report format.

Analyzers integrate into GitLab using a CI job. The report produced by the analyzer is published as an artifact after the job is complete. GitLab ingests this report, allowing users to visualize and manage found vulnerabilities. For more information, see Security Scanner Integration.

Many GitLab analyzers follow a standard approach using Docker to run a wrapped scanner. For example, the Docker image bandit-sast is an analyzer that wraps the scanner Bandit. You can optionally use the Common library to assist in building an Analyzer.

Attack surface

The different places in an application that are vulnerable to attack. Secure products discover and search the attack surface during scans. Each product defines the attack surface differently. For example, SAST uses files and line numbers, and DAST uses URLs.

Corpus

The set of meaningful test cases that are generated while the fuzzer is running. Each meaningful test case produces new coverage in the tested program. It's advised to re-use the corpus and pass it to subsequent runs.

CVE

Common Vulnerabilities and Exposures (CVE®) is a list of common identifiers for publicly known cybersecurity vulnerabilities. The list is managed by the Mitre Corporation.

CVSS

The Common Vulnerability Scoring System (CVSS) is a free and open industry standard for assessing the severity of computer system security vulnerabilities.

CWE

Common Weakness Enumeration (CWE™) is a community-developed list of common software and hardware weakness types that have security ramifications. Weaknesses are flaws, faults, bugs, vulnerabilities, or other errors in software or hardware implementation, code, design, or architecture. If left unaddressed, weaknesses could result in systems, networks, or hardware being vulnerable to attack. The CWE List and associated classification taxonomy serve as a language that you can use to identify and describe these weaknesses in terms of CWEs.

Duplicate finding

A legitimate finding that is reported multiple times. This can occur when different scanners discover the same finding, or when a single scan inadvertently reports the same finding more than once.

False positive

A finding that doesn't exist but is incorrectly reported as existing.

Feedback

Feedback the user provides about a finding. Types of feedback include dismissal, creating an issue, or creating a merge request.

Finding

An asset that has the potential to be vulnerable, identified in a project by an analyzer. Assets include but are not restricted to source code, binary packages, containers, dependencies, networks, applications, and infrastructure.

Findings are all potential vulnerability items scanners identify in MRs/feature branches. Only after merging to default does a finding become a vulnerability.

Insignificant finding

A legitimate finding that a particular customer doesn't care about.

Location fingerprint

A finding's location fingerprint is a text value that's unique for each location on the attack surface. Each Secure product defines this according to its type of attack surface. For example, SAST incorporates file path and line number.

Package managers

A Package manager is a system that manages your project dependencies.

The package manager provides a method to install new dependencies (also referred to as "packages"), manage where packages are stored on your file system, and offer capabilities for you to publish your own packages.

Package types

Each package manager, platform, type, or ecosystem has its own conventions and protocols to identify, locate, and provision software packages.

The following table is a non-exhaustive list of some of the package managers and types referenced in GitLab documentation and software tools.

Package Type Package Manager
gem bundler
packagist composer
conan conan
go go
maven gradle
maven
sbt
npm npm
yarn
nuget nuget
pypi setuptools
pip
Pipenv
Poetry

Pipeline Security tab

A page that displays findings discovered in the associated CI pipeline.

Primary identifier

A finding's primary identifier is a value unique to that finding. The external type and external ID of the finding's first identifier combine to create the value.

Examples of primary identifiers include PluginID for OWASP Zed Attack Proxy (ZAP), or CVE for Trivy. Note that the identifier must be stable. Subsequent scans must return the same value for the same finding, even if the location has slightly changed.

Report finding

A finding that only exists in a report produced by an analyzer, and is yet to be persisted to the database. The report finding becomes a vulnerability finding once it's imported into the database.

Scan type (report type)

The type of scan. This must be one of the following:

  • cluster_image_scanning
  • container_scanning
  • dast
  • dependency_scanning
  • sast
  • secret_detection

Scanner

Software that can scan for vulnerabilities. The resulting scan report is typically not in the Secure report format. Examples include ESLint, Trivy, and ZAP.

Secure product

A group of features related to a specific area of application security with first-class support by GitLab. Products include Container Scanning, Dependency Scanning, Dynamic Application Security Testing (DAST), Secret Detection, Static Application Security Testing (SAST), and Fuzz Testing. Each of these products typically include one or more analyzers.

Secure report format

A standard report format that Secure products comply with when creating JSON reports. The format is described by a JSON schema.

Security Dashboard

Provides an overview of all the vulnerabilities for a project, group, or GitLab instance. Vulnerabilities are only created from findings discovered on the project's default branch.

Seed corpus

The set of test cases given as initial input to the fuzz target. This usually speeds up the fuzz target substantially. This can be either manually created test cases or auto-generated with the fuzz target itself from previous runs.

Vendor

The party maintaining an analyzer. As such, a vendor is responsible for integrating a scanner into GitLab and keeping it compatible as they evolve. A vendor isn't necessarily the author or maintainer of the scanner, as in the case of using an open core or OSS project as a base solution of an offering. For scanners included as part of a GitLab distribution or GitLab subscription, the vendor is listed as GitLab.

Vulnerability

A flaw that has a negative impact on the security of its environment. Vulnerabilities describe the error or weakness, and don't describe where the error is located (see finding). Each vulnerability maps to a unique finding.

Vulnerabilities exist in the default branch. Findings (see finding) are all potential vulnerability items scanners identify in MRs/feature branches. Only after merging to default does a finding become a vulnerability.

Vulnerability finding

When a report finding is stored to the database, it becomes a vulnerability finding.

Vulnerability tracking

Deals with the responsibility of matching findings across scans so that a finding's life cycle can be understood. Engineers and security teams use this information to decide whether to merge code changes, and to see unresolved findings and when they were introduced. Vulnerabilities are tracked by comparing the location fingerprint, primary identifier, and report type.

Vulnerability occurrence

Deprecated, see finding.