Skip to content

Commit

Permalink
Merge pull request #6 from sparrow-cloud/stag
Browse files Browse the repository at this point in the history
merge stag
  • Loading branch information
Sparrow-Co-Ltd authored Jul 31, 2024
2 parents 1759c7d + 7667655 commit 8423690
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
10 changes: 5 additions & 5 deletions Writerside/topics/Analysis-Option.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ Sparrow Cloud has prepared various options especially for web app analysis. You

**Detailed Execution Log**

Detailed Execution Log means whether to **store the detailed actions of the Browser, HTTP client, etc. that were executed when collecting the URL in the Log.(Default: `OFF`)
Detailed Execution Log means whether to **store the detailed actions of the Browser, HTTP client, etc. that were executed when collecting the URL in the Log**.(Default: `OFF`)

If this Option is set to `ON`, you can check the actions you started when collecting in the Log, so you can **OK if you collected the URL correctly**, but it will increase the size of the Log. If this Option is set to `OFF`, the Log volume will be smaller, but it will be harder to check if the URL was collected normally.

Expand Down Expand Up @@ -260,7 +260,7 @@ If this option is set to `ON`, it will **look for URLs Included in HTML comments

Detect Storage Vulnerability refers to whether **additionally performs actions to detect storage-based vulnerabilities**. A storage-based vulnerability is a vulnerability that is stored in the DB, such as Stored XSS (Persistent XSS) or Stored SQL Injection (Persistent SQL Injection), and affects other pages without being reflected on the page immediately after the attack.(Default: `OFF`)

If this option is Setting to `ON`, it will **Start Work extra to Detect Storage Vulnerability and Enable Checker to Detect Storage Vulnerability. This slows down the analysis, but allows for the detection of storage-based vulnerabilities. If this option is set to `OFF`, **Does not perform any additional work to detect storage-based vulnerabilities, and disables the checker to detect storage-based vulnerabilities**. This will speed up the analysis, but will not detect storage-based vulnerabilities.
If this option is Setting to `ON`, it will **start extra work to detect storage vulnerability and enable checker to detect storage vulnerability**. This slows down the analysis, but allows for the detection of storage-based vulnerabilities. If this option is set to `OFF`, **Does not perform any additional work to detect storage-based vulnerabilities, and disables the checker to detect storage-based vulnerabilities**. This will speed up the analysis, but will not detect storage-based vulnerabilities.


**URL Crawling Depth**
Expand All @@ -274,7 +274,7 @@ If this option is set to `High`, we will **crawl URLs farther away from the Star

DOM Crawling Depth means **how far away the DOM to be harvested is from the first DOM generated from the same URL**. The farther the DOM is, the more minimal actions the first DOM needs to perform to reach a specific DOM from the same URL.(Default: `Medium`)

If this option is set to `High`, it will **crawl DOMs from the first DOM to the farthest DOM** that are created when navigating to a URL, but it will take **more h** to do so. If this option is set to `Low`, the Project will **crawl DOMs in less time**, but will not collect the farther DOMs.
If this option is set to `High`, it will **crawl DOMs from the first DOM to the farthest DOM** that are created to navigate to a URL, but it will take **more time** to do so. If this option is set to `Low`, the Project will **crawl DOMs in less time**, but will not collect the farther DOMs.


**Level of Conducted Events**
Expand All @@ -288,7 +288,7 @@ If this option is set to `High`, you will **have more events on the page**, but

Resource Loading Timeout refers to the maximum time **waiting for resources that require a long time to load when the Partial Page Loading Option is set to ON**. You can Input a number of `1` and more than or less than `600000`, and if no Value is Input, the Default is `10000`.(Unit: Milliseconds, Default: `10000`)

The lower the **Value** entered for this Option, the more resources it will Start Crawling without waiting for them to load, so there is a possibility that pages that absolutely need resources may not be able to be crawled properly. The higher the **Value** input for this Option, the longer we wait for resources to load**, and therefore the longer it takes to Crawl.
**The lower the value entered for this option, the more resources it will start crawling without waiting for them to load**, so there is a possibility that pages that absolutely need resources may not be able to be crawled properly. **The higher the value input for this Option, the longer we wait for resources to load**, and therefore the longer it takes to Crawl.


**Event Timeout**
Expand All @@ -302,7 +302,7 @@ The larger the value entered for this Option, the slower it will be to **Crawled

Number of Requests refers to **the number of HTTP Requests per Sec that can be sent when collecting URLs**. You can Input a number that is more than `-1` and less than `10000`, and if no Option is entered, the Default is `-1`, in which case you will not limit the number of HTTP Requests that can be sent.(Unit: item(s), Default: `-1`)

A **higher** value entered for this Option will increase the number of HTTP Request(s) that can be sent in a second, which will make Analyzing Target URLs faster**, but may also increase the amount of traffic, which will **increase the load on the Analyzing Target Web Application server**. The **lower the value entered for this option, the lower the traffic volume, which will reduce the load on the Analyzing Target Web application server**, but will slow down the speed of collecting the URL.
A **higher value entered for this Option will increase the number of HTTP Request(s) that can be sent in a second, which will make Analyzing Target URLs faster**, but may also increase the amount of traffic, which will increase the load on the Analyzing Target Web Application server. **The lower the value entered for this option, the lower the traffic volume, which will reduce the load on the Analyzing Target Web application server**, but will slow down the speed of collecting the URL.


**HTTP Client Timeout**
Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/Change-Password.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ switcher-label: Language

1. Click on your **username** in the top right corner
2. Select **My Account**.
3. Click on **Show Options*.
3. Click on **Show Options**.

<img src="myaccount_info.png" alt="Alt text"/>

Expand Down
4 changes: 2 additions & 2 deletions Writerside/topics/GitHub.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ GitHub 계정으로 Sparrow Cloud에 등록하거나 분석할 GitHub 리포지

<img src="signup_Github00.png" alt="Alt text"/>

2. **Authorise Sparrow Cloud** 버튼을 클릭하여 권한을 부여합니다.
2. **Authorize Sparrow Cloud** 버튼을 클릭하여 권한을 부여합니다.

<img src="signup_Github01.png" alt="Alt text"/>

Expand Down Expand Up @@ -51,7 +51,7 @@ To register for Sparrow Cloud with a GitHub account or to connect a GitHub repos

<img src="signup_Github00.png" alt="Alt text"/>

2. Click **Authorise Sparrow Cloud** button to grant permission.
2. Click **Authorize Sparrow Cloud** button to grant permission.

<img src="signup_Github01.png" alt="Alt text"/>

Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/analysisSetting.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ GitHub 저장소나 URL을 분석하려면 **프로젝트**에서 분석 대상

## Setting up analyses {switcher-key="English"}

To analyse a GitHub repository or URL, you need to set up a **Source repository** or **Web page to analyse** in your **Project**. **Source repository refers to the repository you created with your GitHub account and points to the specific repository you set up in your project. When you perform an analysis, all files contained in that repository will be analysed. The **Web page to analyse** is a web page in the form of a URL that is accessible over the internet and is set by you. When you perform an analysis, you can analyse 1) the subpages that you can navigate to from that URL, and 2) the pages that you set as analysis options.
To analyse a GitHub repository or URL, you need to set up a **Source repository** or **Web page to analyse** in your **Project**. Source repository refers to the repository you created with your GitHub account and points to the specific repository you set up in your project. When you perform an analysis, all files contained in that repository will be analysed. The **Web page to analyse** is a web page in the form of a URL that is accessible over the internet and is set by you. When you perform an analysis, you can analyse 1) the subpages that you can navigate to from that URL, and 2) the pages that you set as analysis options.


1. Sign in to **Sparrow Cloud**, then click the project you want to analyse.
Expand Down

0 comments on commit 8423690

Please sign in to comment.