Skip to content

Commit a2b2fbb

Browse files
linad87gitbook-bot
authored andcommitted
GITBOOK-125: change request with no subject merged in GitBook
1 parent 1550c15 commit a2b2fbb

11 files changed

+134
-148
lines changed

jfrog-applications/SUMMARY.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,12 @@
7070
* [Setup Frogbot Using JFrog Pipelines](frogbot/setup-frogbot-using-jfrog-pipelines.md)
7171
* [Setup Frogbot Using GitLab CI](frogbot/setup-frogbot-using-gitlab-ci.md)
7272
* [Setup Frogbot Using Azure Pipelines](frogbot/setup-frogbot-using-azure-pipelines.md)
73-
* [Scan Pull Requests](frogbot/scan-pull-requests.md)
73+
* [Scan Pull Requests](jfrog-applications/frogbot/scan-pull-requests/README.md)
74+
* [Scan Github Pull Request](jfrog-applications/frogbot/scan-pull-requests/scan-github-pull-request.md)
75+
* [Scan Gitlab Pull Request](jfrog-applications/frogbot/scan-pull-requests/scan-gitlab-pull-request.md)
76+
* [Scan Azure Repos Pull Request](jfrog-applications/frogbot/scan-pull-requests/scan-azure-repos-pull-request.md)
77+
* [Scan Bitbucket Server Pull Request](jfrog-applications/frogbot/scan-pull-requests/scan-bitbucket-server-pull-request.md)
78+
* [Pull Request Scan Results](jfrog-applications/frogbot/scan-pull-requests/pull-request-scan-results.md)
7479
* [Scan Repositories](frogbot/scan-repositories.md)
7580
* [Frogbot Badge](frogbot/frogbot-badge.md)
7681

jfrog-applications/frogbot/scan-pull-requests.md

Lines changed: 0 additions & 142 deletions
This file was deleted.

jfrog-applications/frogbot/setup-frogbot-using-azure-pipelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Setup Frogbot Using Azure Pipelines
22

3-
**Important Notice**: For Scanning Pull Requests, it is advisable to refrain from setting up Frogbot using Azure Pipelines for open source projects. For further details, please refer to the [👮 Security Note for Pull Requests Scanning](./scan-pull-requests.md#security-note-for-pull-requests-scanning).
3+
**Important Notice**: For Scanning Pull Requests, it is advisable to refrain from setting up Frogbot using Azure Pipelines for open source projects. For further details, please refer to the [👮 Security Note for Pull Requests Scanning](../jfrog-applications/frogbot/scan-pull-requests/#security-note-for-pull-requests-scanning).
44

55
To install Frogbot on Azure Repos repositories, follow these steps.
66

jfrog-applications/frogbot/setup-frogbot-using-jenkins.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Setup Frogbot Using Jenkins
22

3-
**Important Notice**: For Scanning Pull Requests, it is advisable to refrain from setting up Frogbot using Jenkins for open source projects. For further details, please refer to the [👮 Security Note for Pull Requests Scanning](scan-pull-requests.md#security-note-for-pull-requests-scanning).
3+
**Important Notice**: For Scanning Pull Requests, it is advisable to refrain from setting up Frogbot using Jenkins for open source projects. For further details, please refer to the [👮 Security Note for Pull Requests Scanning](../jfrog-applications/frogbot/scan-pull-requests/#security-note-for-pull-requests-scanning).
44

55
#### 🖥️ Follow these steps to install Frogbot on Jenkins
66

@@ -489,11 +489,11 @@
489489
// Set the list of allowed licenses, The full list of licenses can be found in:
490490
// https://github.com/jfrog/frogbot/blob/master/docs/licenses.md
491491
// JF_ALLOWED_LICENSES: "MIT, Apache-2.0"
492-
492+
493493
// [Optional]
494494
// Avoid adding extra info to pull request comments. that isn't related to the scan findings.
495495
// JF_AVOID_EXTRA_MESSAGES: "TRUE"
496-
496+
497497
// [Optional]
498498
// Add a title to pull request comments generated by Frogbot.
499499
// JF_PR_COMMENT_TITLE: ""

jfrog-applications/frogbot/setup-frogbot-using-jfrog-pipelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Setup Frogbot Using JFrog Pipelines
22

3-
**Important Notice**: For Scanning Pull Requests, it is advisable to refrain from setting up Frogbot using JFrog Pipelines for open source projects. For further details, please refer to the [👮 Security Note for Pull Requests Scanning](./scan-pull-requests.md#security-note-for-pull-requests-scanning).
3+
**Important Notice**: For Scanning Pull Requests, it is advisable to refrain from setting up Frogbot using JFrog Pipelines for open source projects. For further details, please refer to the [👮 Security Note for Pull Requests Scanning](../jfrog-applications/frogbot/scan-pull-requests/#security-note-for-pull-requests-scanning).
44

55
* Make sure you have the connection details of your JFrog Platform.
66
* Inside JFrog Pipelines, save the JFrog connection details as a [JFrog Platform Access Token Integration](https://www.jfrog.com/confluence/display/JFROG/JFrog+Platform+Access+Token+Integration) named **jfrogPlatform**.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Scan Pull Requests
2+
3+
### General
4+
5+
Frogbot uses [JFrog Xray](https://jfrog.com/xray/) (version 3.29.0 and above is required) to scan your pull requests. It adds the scan results as a comment on the pull request. If no new vulnerabilities are found, Frogbot will also add a comment, confirming this.
6+
7+
The following features use the package manager used for building the project:
8+
9+
* Software Composition Analysis (SCA)
10+
* Vulnerability Contextual Analysis
11+
12+
### Security note for pull requests scanning
13+
14+
When installing Frogbot using JFrog Pipelines, Jenkins, and Azure DevOps, Frogbot will not wait for a maintainer's approval before scanning newly opened pull requests. Using Frogbot with these platforms is therefore not recommended for open-source projects.
15+
16+
When installing Frogbot using GitHub Actions and GitLab however, Frogbot will initiate the scan only after it is approved by a maintainer of the project. The goal of this review is to ensure that external code contributors don't introduce malicious code as part of the pull request. Since this review step is enforced by Frogbot when used with GitHub Actions and GitLab, it is safe to be used for open-source projects.
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Pull Request Scan Results
2+
3+
### Scan results
4+
5+
Frogbot adds the scan results to the pull request in the following format:
6+
7+
#### 👍 No issues
8+
9+
If no new vulnerabilities are found, Frogbot automatically adds the following comment to the pull request:
10+
11+
[![](https://raw.githubusercontent.com/jfrog/frogbot/master/resources/v2/noVulnerabilityBannerPR.png)](pull-request-scan-results.md#-no-issues)
12+
13+
#### 👎 Issues were found
14+
15+
**Software Composition Analysis (SCA)**
16+
17+
If new vulnerabilities are found, Frogbot adds them as a comment on the pull request. For example:
18+
19+
[![](https://raw.githubusercontent.com/jfrog/frogbot/master/resources/v2/vulnerabilitiesBannerPR.png)](pull-request-scan-results.md#-issues)
20+
21+
**VULNERABLE DEPENDENCIES**
22+
23+
| SEVERITY | CONTEXTUAL ANALYSIS | DIRECT DEPENDENCIES | IMPACTED DEPENDENCY | FIXED VERSIONS |
24+
| :---------------------------------------------------------------------------------------------------------------------------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------------: |
25+
| <p><img src="https://raw.githubusercontent.com/jfrog/frogbot/master/resources/v2/notApplicableCritical.png" alt=""><br>Critical</p> | Not Applicable | minimist:1.2.5 | minimist:1.2.5 | <p>[0.2.4]<br>[1.2.6]</p> |
26+
| <p><img src="https://raw.githubusercontent.com/jfrog/frogbot/master/resources/v2/applicableHighSeverity.png" alt=""><br>High</p> | Applicable | protobufjs:6.11.2 | protobufjs:6.11.2 | \[6.11.3] |
27+
| <p><img src="https://raw.githubusercontent.com/jfrog/frogbot/master/resources/v2/notApplicableHigh.png" alt=""><br>High</p> | Not Applicable | lodash:4.17.19 | lodash:4.17.19 | \[4.17.21] |
28+
29+
**Vulnerability Contextual Analysis**
30+
31+
![](https://raw.githubusercontent.com/jfrog/frogbot/master/images/pr-vuln-contextual-analysis.png)
32+
33+
**Static Application Security Testing (SAST)**
34+
35+
![](https://raw.githubusercontent.com/jfrog/frogbot/master/images/pr-sast.png)
36+
37+
**Infrastructure as Code scans (IaC)**
38+
39+
![](https://raw.githubusercontent.com/jfrog/frogbot/master/images/pr-iac.png)
40+
41+
**Validate Allowed Licenses**
42+
43+
When Frogbot scans newly opened pull requests, it checks the licenses of any new direct project dependencies introduced by the pull request. If Frogbot identifies licenses that are not listed in a predefined set of approved licenses, it appends a comment to the pull request providing this information. The list of allowed licenses is set up as a variable within the Frogbot workflow.
44+
45+
![](https://raw.githubusercontent.com/jfrog/frogbot/master/images/violated-licenses.png)
46+
47+
#### Secrets Detection
48+
49+
When Frogbot detects secrets that have been inadvertently exposed within the code of a pull request, it promptly triggers an email notification to the user who pushed the corresponding commit. The email address utilized for this notification is sourced from the committer's Git profile configuration. Moreover, Frogbot offers the flexibility to direct the email notification to an extra email address if desired. To activate email notifications, it is necessary to configure your SMTP server details as variables within your Frogbot workflows.
50+
51+
![](https://raw.githubusercontent.com/jfrog/frogbot/master/images/secrets-email.png)
52+
53+
xx
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Scan Azure Repos Pull Request
2+
3+
After you create a new pull request, Frogbot will automatically scan it.
4+
5+
_**NOTE:**_ The scan output will include only new vulnerabilities added by the pull request. Vulnerabilities that aren't new, and existed in the code before the pull request was created, will not be included in the report. In order to include all the vulnerabilities in the report, including older ones that weren't added by this PR, use the includeAllVulnerabilities parameter in the frogbot-config.yml file.
6+
7+
The Frogbot Azure Repos scan workflow is:
8+
9+
1. The developer opens a pull request.
10+
2. Frogbot scans the pull request and adds a comment with the scan results.
11+
3. Frogbot can be triggered again following new commits, by adding a comment with the `rescan` text.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Scan Bitbucket Server Pull Request
2+
3+
After you create a new pull request, Frogbot will automatically scan it.
4+
5+
_**NOTE:**_ The scan output will include only new vulnerabilities added by the pull request. Vulnerabilities that aren't new, and existed in the code before the pull request was created, will not be included in the report. In order to include all of the vulnerabilities in the report, including older ones that weren't added by this PR, use the includeAllVulnerabilities parameter in the frogbot-config.yml file.
6+
7+
The Frogbot scan on Bitbucket Server workflow:
8+
9+
1. The developer opens a pull request.
10+
2. Frogbot scans the pull request and adds a comment with the scan results.
11+
3. Frogbot can be triggered again following new commits, by adding a comment with the `rescan` text.

0 commit comments

Comments
 (0)