Skip to content

Commit 3b2dc0a

Browse files
authored
update roles and scopes information (#2216)
1 parent b0dbe80 commit 3b2dc0a

File tree

4 files changed

+34
-7
lines changed

4 files changed

+34
-7
lines changed

docs/deployment/managed-scanning/gitlab.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,8 @@ You can enabled managed scanning for additional repositories after onboarding us
6666

6767
### If the page doesn't display any repositories
6868

69-
1. Ensure that you've connected your GitLab account by following the steps in [Connect a source code manager](/deployment/connect-scm) and confirm the PAT is created with the required `API` scope and [a role of, at minimum, Reporter](https://docs.gitlab.com/ee/user/permissions.html#roles).
69+
1. Ensure that you've connected your GitLab account by following the steps in [Connect a source code manager](/deployment/connect-scm) and confirm the [PAT is created with the required `API` scope](https://docs.gitlab.com/user/profile/personal_access_tokens/#personal-access-token-scopes) by someone assigned the [role of **Maintainer** or **Owner**](https://docs.gitlab.com/ee/user/permissions.html#roles).
70+
1. Once you successfully create the connection, the role for the person who owns the token can be downgraded to **Developer**.
7071
2. In Semgrep AppSec Platform, click **<i class="fa-solid fa-folder-open"></i> Projects**.
7172
3. If the page doesn't display the repository you want to add, click **Can't find your project? > Sync projects**.
7273
4. If the page doesn't display any repositories, click **Sync projects**.

docs/semgrep-appsec-platform/bitbucket-data-center-pr-comments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ PR comments appear for the following types of scans under these conditions:
4747
### Prerequisites
4848

4949
In addition to finishing the previous steps in your deployment journey, it is recommended that you complete a **full scan** on your **default branch** for the repository in which you want to receive comments.
50-
- You must have a Bitbucket Data Center HTTP access token. Ensure that the [token HTTP access token that you create](https://confluence.atlassian.com/bitbucketserver/http-access-tokens-939515499.html) has been granted **Project write** permissions. You'll provide this token to your CI provider during the setup process.
50+
- You must have a Bitbucket Data Center HTTP access token. Ensure that the [HTTP access token that you create](https://confluence.atlassian.com/bitbucketserver/http-access-tokens-939515499.html) has been granted **Project write** permissions. You'll provide this token to your CI provider during the setup process.
5151
- Semgrep has been tested with Bitbucket Data Center v8.19. If you are using a different version of BBDC and there are issues, please contact [<i class="fa-regular fa-envelope"></i> support@semgrep.com](mailto:support@semgrep.com).
5252

5353
### Confirm your Semgrep account's connection

docs/semgrep-appsec-platform/gitlab-mr-comments.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,11 @@ To enable MR comments, connect your GitLab organization to Semgrep AppSec Platfo
5757
1. Sign in to [<i class="fas fa-external-link fa-xs"></i> Semgrep AppSec Platform](https://semgrep.dev/login?return_path=/manage/projects).
5858
1. Go to **Settings > Source code managers**.
5959
1. Click **Add connection** and select **GitLab**.
60-
3. Create a GitLab personal access token (PAT) with `api` scope:
61-
1. Log in to your GitLab account, and go to [<i class="fas fa-external-link fa-xs"></i> Profile > Access Tokens](https://gitlab.com/-/profile/personal_access_tokens).
62-
2. Add a token with `api` scope.
63-
3. Copy the generated token.
60+
3. Create a GitLab [personal access token (PAT) with `api` scope](https://docs.gitlab.com/user/profile/personal_access_tokens/#personal-access-token-scopes):
61+
1. Ensure that you're using an account that has been [assigned a role of `Developer` or higher](https://docs.gitlab.com/user/permissions/#roles), and log in to GitLab.
62+
2. Go to [<i class="fas fa-external-link fa-xs"></i> Profile > Access Tokens](https://gitlab.com/-/profile/personal_access_tokens).
63+
3. Add a token with `api` scope.
64+
4. Copy the generated token.
6465
4. Return to Semgrep AppSec Platform, and in the **Add connection** form:
6566
1. Enter the **Name of your GitHub Organization**.
6667
2. Paste the PAT you created in **Access token**.

docs/semgrep-ci/network-broker.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Ensure that you are logged in to the server where you want to run Semgrep Networ
4848
4949
<TabItem value='current'>
5050

51-
Create a `config.yaml` file similar to the following snippet, or copy a starting config from the Semgrep AppSec Platform at **Settings > Broker**. The steps required to generate values for the placeholders `SEMGREP_LOCAL_ADDRESS`, `YOUR_PRIVATE_KEY`, and `YOUR_BASE_URL` are provided in subsequent steps of this guide.
51+
Create a `config.yaml` file similar to the following snippet, or copy a starting config from the Semgrep AppSec Platform at **Settings > Broker**. The steps required to generate values for the placeholders `SEMGREP_LOCAL_ADDRESS`, `YOUR_PRIVATE_KEY`, and `YOUR_BASE_URL`, as well as the scopes required for the access tokens, are provided in subsequent steps of this guide.
5252

5353
```yaml
5454
inbound:
@@ -153,6 +153,9 @@ azuredevops:
153153
&nbsp;&nbsp;token: <span className="placeholder">ADO_PAT</span>
154154
</code></pre>
155155

156+
:::info Access tokens
157+
Semgrep recommends providing the access token when you [connect the source code manager](/deployment/connect-scm#connect-to-cloud-hosted-orgs) instead of in the Network Broker configuration. However, if you must provide the token in the network broker configuration, see [Prerequisites](/semgrep-appsec-platform/azure-pr-comments#prerequisites) for access token requirements.
158+
:::
156159
</TabItem>
157160

158161
<TabItem value='bb'>
@@ -165,6 +168,12 @@ bitbucket:
165168
&nbsp;&nbsp;token: <span className="placeholder">BITBUCKET_ACCESS_TOKEN</span>
166169
</code></pre>
167170

171+
:::info Access tokens
172+
Semgrep recommends providing the access token when you [connect the source code manager](/deployment/connect-scm) instead of in the Network Broker configuration. However, if you must provide the token in the network broker configuration, see Prerequisites for access token requirements:
173+
- [Bitbucket Cloud](/semgrep-appsec-platform/bitbucket-cloud-pr-comments#create-and-add-a-workspace-access-token)
174+
- [Bitbucket Data Center](/semgrep-appsec-platform/bitbucket-data-center-pr-comments#prerequisites)
175+
:::
176+
168177
</TabItem>
169178
<TabItem value='gh'>
170179

@@ -183,6 +192,10 @@ gitlab:
183192
&nbsp;&nbsp;token: <span className="placeholder">GITLAB_PAT</span>
184193
</code></pre>
185194

195+
:::info Access token
196+
Semgrep recommends providing the access token when you [connect the source code manager](/deployment/connect-scm#connect-to-cloud-hosted-orgs) instead of in the Network Broker configuration. However, if you must provide the token in the network broker configuration, see [Prerequisites](/semgrep-appsec-platform/gitlab-mr-comments#prerequisites) for access token requirements.
197+
:::
198+
186199
</TabItem>
187200
</Tabs>
188201

@@ -275,6 +288,10 @@ azuredevops:
275288
&nbsp;&nbsp;allowCodeAccess: true
276289
</code></pre>
277290

291+
:::info Access tokens
292+
Semgrep recommends providing the access token when you [connect the source code manager](/deployment/connect-scm#connect-to-cloud-hosted-orgs) instead of in the Network Broker configuration. However, if you must provide the token in the network broker configuration, see [Prerequisites and permissions](/deployment/managed-scanning/azure#prerequisites-and-permissions) for access token requirements.
293+
:::
294+
278295
</TabItem>
279296

280297
<TabItem value='bb'>
@@ -286,6 +303,10 @@ bitbucket:
286303
&nbsp;&nbsp;allowCodeAccess: true
287304
</code></pre>
288305

306+
:::info Access tokens
307+
Semgrep recommends providing the access token when you [connect the source code manager](/deployment/connect-scm#connect-to-cloud-hosted-orgs) instead of in the Network Broker configuration. However, if you must provide the token in the network broker configuration, see [Prerequisites and permissions](/deployment/managed-scanning/bitbucket#prerequisites-and-permissions) for access token requirements.
308+
:::
309+
289310
</TabItem>
290311
<TabItem value='gh'>
291312

@@ -306,6 +327,10 @@ gitlab:
306327
&nbsp;&nbsp;allowCodeAccess: true
307328
</code></pre>
308329

330+
:::info Access tokens
331+
Semgrep recommends providing the access token when you [connect the source code manager](/deployment/connect-scm#connect-to-cloud-hosted-orgs) instead of in the Network Broker configuration. However, if you must provide the token in the network broker configuration, see [Prerequisites and permissions](/deployment/managed-scanning/gitlab#prerequisites-and-permissions) for access token requirements.
332+
:::
333+
309334
</TabItem>
310335
</Tabs>
311336

0 commit comments

Comments
 (0)