Skip to content

Commit

Permalink
component 2 supply chain
Browse files Browse the repository at this point in the history
  • Loading branch information
HJ-sparrow committed Jun 23, 2024
1 parent 25af22f commit ded08a4
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 17 deletions.
2 changes: 1 addition & 1 deletion Writerside/topics/Analysis-Report.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Sparrow Cloud에서는 PDF 형식의 분석 보고서를 제공합니다. 다음
> **Tip**: 분석 보고서 파일이 너무 큰 경우 여러 개의 파일로 나뉘어서 출력됩니다.

## Analysis Report {switcher-key="English"}
## Export Report {switcher-key="English"}

Sparrow Cloud provides reports on the analysis in PDF format. Export the report in the following way

Expand Down
6 changes: 3 additions & 3 deletions Writerside/topics/Analysis-Results.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To see detailed results, click the four tabs on the right side of the project: *

### Issues {switcher-key="English"}

**Issues** are security vulnerabilities and quality issues found as a result of analysing your analytics targets. The **Issues list** displayed in the **Issues** tab contains the issues detected by Sparrow Cloud. Issues are categorised as source code issues, component issues, or web vulnerability issues, depending on the tool that detected them.
**Issues** are security vulnerabilities and quality issues found as a result of analysing your analytics targets. The **Issues list** displayed in the **Issues** tab contains the issues detected by Sparrow Cloud. Issues are categorised as source code issues, supply chain issues, or web vulnerability issues, depending on the tool that detected them.

For more information about the issues, see [Issue](Issue.md).

Expand All @@ -49,7 +49,7 @@ Sparrow Cloud는 **자산**이라는 분석 결과를 표시합니다. 자산은

### Assets {switcher-key="English"}

Sparrow Cloud displays analysis results called **Assets**. Assets are generated from the analytics target you used for analysis: It identifies the files or sub URLs contained in the analyse target and uses this information to show a list of **assets**. Depending on the analysis target, assets identified from repositories used for source code analysis and component analysis are shown as **Files**, while assets sourced from web pages used for web vulnerability analysis are shown as **URLs**.
Sparrow Cloud displays analysis results called **Assets**. Assets are generated from the analytics target you used for analysis: It identifies the files or sub URLs contained in the analyse target and uses this information to show a list of **assets**. Depending on the analysis target, assets identified from repositories used for source code analysis and supply chain analysis are shown as **Files**, while assets sourced from web pages used for web vulnerability analysis are shown as **URLs**.

For more information about assets, see [Asset](Asset.md).

Expand All @@ -63,6 +63,6 @@ For more information about assets, see [Asset](Asset.md).

### Components {switcher-key="English"}

**Component** is the smallest unit that can identify a specific program and refers to software that requires a licence, proprietary software, open source software, etc. Sparrow Cloud breaks down files into components to identify what software is included in the file being analysed, and organises the open source licences that the components are using into individual components on the Components tab. Components that are under a specific licence are also detected as issues in the issue list.
**Components** are the smallest units that can identify a specific program and refers to software that requires a licence, proprietary software, open source software, etc. Sparrow Cloud breaks down files into components to identify what software is included in the file being analysed, and organises the open source licences that the components are using into individual components on the Components tab. Components that are under a specific licence are also detected as issues in the issue list.

For more information about components, see [Component](Component.md).
2 changes: 0 additions & 2 deletions Writerside/topics/Component.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ switcher-label: Language
- **SBOM**: 소프트웨어를 구성하는 컴포넌트를 정리한 SBOM 파일을 분석한 경우를 가리킵니다.


# Component {switcher-key="English"}

## identification type {switcher-key="English"}

Displays the type of target used to identify the component: **Binary**, **Dependencies**, **Source Code**, **Snippets**, **SBOM**.
Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/Export-SBOM.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ switcher-label: Language

## Export SBOM {switcher-key="English"}

**A Software Bill of Materials (SBOM)** is a bill of materials for software that contains detailed information about the components that make up the software. In Sparrow Cloud, you can print and view the SBOMs included in one or more projects.
**A Software Bill of Materials (SBOM)** is a bill of materials for software that contains detailed information about the supply chains that make up the software. In Sparrow Cloud, you can print and view the SBOMs included in one or more projects.


1. Navigate to the **Project** you want to export the SBOM from.
Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/GitHub.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Sparrow Cloud는 GitHub 저장소에 연동하고, 업로드된 파일을 가져

## Connecting GitHub repository {switcher-key="English"}

Sparrow Cloud connects to your GitHub repository, pulls in uploaded files, and uses them for source code and component analysis. As mentioned in the previous guide, it is mandatory to create and authenticate a GitHub account to perform this analysis.
Sparrow Cloud connects to your GitHub repository, pulls in uploaded files, and uses them for source code and supply chain analysis. As mentioned in the previous guide, it is mandatory to create and authenticate a GitHub account to perform this analysis.
Please note that not all GitHub repositories are available to connect to Sparrow Cloud, depending on which plan you are on, and also depending on where you have installed the GitHub app, as follows


Expand Down
4 changes: 2 additions & 2 deletions Writerside/topics/Issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ switcher-label: Language

## Issue type {switcher-key="en"}

Issues can be categorised as Source Issues, Component Issues, or Web Vulnerability Issues, depending on the analysis engine that detected the issue.
Issues can be categorised as Source Issues, Supply Chain Issues, or Web Vulnerability Issues, depending on the analysis engine that detected the issue.

- Source issues: Issues detected through source code analysis.
- Security vulnerability: A potential vulnerability in the source code that is related to software security.
- Quality issues: Issues that do not cause security issues in the source code, but should be reviewed from a quality perspective.
- Component issues: Issues detected through component analysis.
- Supply Chain issues: Issues detected through supply chain analysis.
- Vulnerable component: An issue that is considered vulnerable because a vulnerability has been found in the component itself.
- Licence: Issues where the open source licence used by the component contains a copyleft or permissive licence.
- Web vulnerability issues: Issues detected through web vulnerability analysis.
Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/Register.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ To use the Sparrow Cloud service, you need to register a user account. Users can
<img src="로그인.png" alt="Alt text" width="450"/>.

2. Click the **Sign-up** button to create an account with your email. To use your GitHub account, click the **Sign in with GitHub account** button.
> **Tip**: Sparrow Cloud recommends that users who will be using GitHub repositories to perform source code or component analysis verify their GitHub account when creating an account.
> **Tip**: Sparrow Cloud recommends that users who will be using GitHub repositories to perform source code or supply chain analysis verify their GitHub account when creating an account.

### 이메일로 등록하기 {switcher-key="한국어"}
Expand Down
4 changes: 2 additions & 2 deletions Writerside/topics/Run-Analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Now go to the project you created earlier and perform an analysis. To analyse a
<img src="runAnalysis.png" alt="Alt text" width="450"/>

1. Click the **Start a new analysis** button.
2. Select a repository or compressed file to start analysing **Source code and components**.
2. Select a repository or compressed file to start analysing **Source code and supply chains**.
3. Select **URL** to start analysing **Web Vulnerabilities**.
4. The analysis will now start.

Expand All @@ -49,7 +49,7 @@ You can analyse compressed files up to 100 MB. Users without a subscription to t

#### SBOM file {switcher-key="English"}

You can compress an SBOM file that has already been generated, and then run the analysis to see the results. However, due to the various formats of SBOMs, files that do not fall into the following categories may not result in component analysis.
You can compress an SBOM file that has already been generated, and then run the analysis to see the results. However, due to the various formats of SBOMs, files that do not fall into the following categories may not result in supply chain analysis.

- SPDX (.spdx): version 2.2
- CycloneDX (.json): Version 1.4
Expand Down
8 changes: 4 additions & 4 deletions Writerside/topics/Subscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,18 +80,18 @@ During the beta period, you can use all services without a subscription.
{type="text"}


Sparrow Cloud offers three services: Source Code Analysis, Component Analysis, and Web Vulnerability Analysis, which you can subscribe to monthly or annually. Pricing varies depending on the type of analysis and length of service, so please check the payment window.
Sparrow Cloud offers three services: Source Code Analysis, Supply Chain Analysis, and Web Vulnerability Analysis, which you can subscribe to monthly or annually. Pricing varies depending on the type of analysis and length of service, so please check the payment window.
Sparrow Cloud pricing plans are as follows

<table>
<tr>
<td>Free</td>
<td>Source code analysis (Pro)</td>
<td>Component Analysis (Pro)</td>
<td>Supply Chain Analysis (Pro)</td>
<td>Web Vulnerability Analysis (Pro)</td>
</tr>
<tr>
<td>Source code, component and web vulnerability analysis for free</td>
<td>Source code, supply chain and web vulnerability analysis for free</td>
<td>Enhanced analysis results for static analysis
for static analysis</td>
<td>Identifies components and open source licences
Expand Down Expand Up @@ -135,7 +135,7 @@ per person/month</td>
If you are a free user, you can still experience all three services, but with some restrictions. Paid users get enhanced services in the following areas
- You are not limited to the number of analyses you can perform.
- The types of GitHub repositories that can be analysed are expanded to include private.
- You can see open source licences identified through component analysis.
- You can see open source licences identified through supply chain analysis.
- Web vulnerability analysis uses more rules and increases the depth of analysis.

> **Tip**: Even if you are a paid user, there may be differences in the types of repositories you can analyse depending on where you have installed the GitHub App. For more information, see [Where to install GitHub App](http://localhost:63342/Cloud_Guide/preview/%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8%EC%99%80-%EB%B6%84%EC%84%9D.html#github-app).
Expand Down

0 comments on commit ded08a4

Please sign in to comment.