-
Notifications
You must be signed in to change notification settings - Fork 10.4k
[Email Security (formerly Area 1)] Restructure Gmail BCC setup and retraction page #17700
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
e212469
[Email Security (formerly Area 1)] Restructure Gmail BCC setup and re…
Maddy-Cloudflare 06e6021
Deleting page
Maddy-Cloudflare 714047e
Removing spaces
Maddy-Cloudflare 57affce
Fixing redirects and broken links
Maddy-Cloudflare 107cd7d
Update src/content/docs/email-security/deployment/api/setup/gsuite-bc…
Maddy-Cloudflare 799fa1c
Apply suggestions from code review
Maddy-Cloudflare 89ff610
Addressing Pedro suggestion
Maddy-Cloudflare a841cbf
Clarify order of completion
Maddy-Cloudflare 5175da8
adding next steps
Maddy-Cloudflare 65829eb
minor language change
Maddy-Cloudflare 719a254
Update src/content/docs/email-security/deployment/api/setup/gsuite-bc…
Maddy-Cloudflare File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
19 changes: 19 additions & 0 deletions
19
...ontent/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-domain.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| title: Find BCC address and add domain | ||
| pcx_content_type: how-to | ||
| sidebar: | ||
| order: 2 | ||
| --- | ||
|
|
||
| import { Render } from "~/components" | ||
|
|
||
| :::caution[Area 1 has been renamed] | ||
| <Render file="rename-area1-to-ces" /> | ||
| ::: | ||
|
|
||
| To set up Email Security (formerly Area 1) for Gmail: | ||
|
|
||
| 1. Log in to the [Email Security (formerly Area 1) dashboard](https://horizon.area1security.com/). | ||
| 2. Select the question mark, where you will be able to find your BCC address. | ||
| 3. Once you found your address, select **Settings** (the gear icon), then select **New Domain**. | ||
| 4. Fill in the information needed to add your domain, then select **Publish Domain**. |
26 changes: 26 additions & 0 deletions
26
...nt/docs/email-security/deployment/api/setup/gsuite-bcc-setup/add-retraction.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| --- | ||
| title: Add retraction | ||
| pcx_content_type: how-to | ||
| sidebar: | ||
| order: 5 | ||
| --- | ||
|
|
||
| import { Render } from "~/components" | ||
|
|
||
| 1. On the [Email Security (formerly Area 1) dashboard](https://horizon.area1security.com/), select **Domains** under **DOMAINS & ROUTING**, then select **NEW DOMAIN**. Fill in the information to add a new domain: | ||
| - On **FORWARDING TO**: Enter **Google.com**. | ||
| - Adjust **Hops** to 2. | ||
| - On **Outbound TLS**: Ensure you select **Forward all messages over TLS**. | ||
| 2. Select **Publish Domain**. | ||
| 3. Select **RETRACT SETTINGS** > **Authorize Gmail**. | ||
| 4. Upload the JSON file [previously generated](/email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account/). | ||
| 5. Under **DOMAINS**, select the domain you added previously, then select **SAVE**. | ||
|
|
||
| ## Post delivery retractions for new threats | ||
|
|
||
| Email Security (formerly Area 1) is continuously gathering new information about phishing campaigns. Users might have email messages in their inboxes that were scanned by Email Security (formerly Area 1) but not retracted initially because, at the time of scan, these email messages had not been identified as a threat. To mitigate risk, Email Security (formerly Area 1) offers you tools to re-evaluate email messages at a fixed time interval based on knowledge Cloudflare may have acquired since initial delivery. Any email messages that fit this new threat knowledge will be retracted. | ||
Maddy-Cloudflare marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| You can enable two options: | ||
|
|
||
| - **Post Delivery Response**: Email Security (formerly Area 1) will continue to re-evaluate emails already delivered to your users’ inboxes at a fixed time interval in search for phishing sites or campaigns not previously known to Cloudflare. If any email messages fitting these new criteria are found, Email Security (formerly Area 1) retracts them. | ||
Maddy-Cloudflare marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - **Phish Submission Response**: Email Security (formerly Area 1) will retract emails already delivered that are reported by your users as phishing, and are found to be malicious by Email Security (formerly Area 1). Retraction will occur according to your configuration. | ||
27 changes: 27 additions & 0 deletions
27
...ocs/email-security/deployment/api/setup/gsuite-bcc-setup/bcc-rules-to-area1.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
| title: Add BCC rules to Area 1 | ||
Maddy-Cloudflare marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| pcx_content_type: how-to | ||
| sidebar: | ||
| order: 3 | ||
| --- | ||
|
|
||
| import { Render } from "~/components" | ||
|
|
||
| 1. In the [Google Admin console](https://admin.google.com/), go to **Menu** > **Apps** > **Google Workspace** > **Gmail** > **Compliance**. | ||
| 2. Go to **Content Compliance** > Select **Edit**. | ||
| 3. Add a **Content Compliance** filter, and name it `Email Security (Area 1) - BCC`. | ||
| 4. In **Email messages to affect**, select **Inbound**. | ||
| 5. Select the recipients you want to send emails to Area 1 via BCC: | ||
Maddy-Cloudflare marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. Select **Add** to configure the expression. | ||
| 2. Select **Advanced content match**. | ||
| 3. In **Location**, select **Headers + Body**. | ||
| 4. In **Match type**, select **Matches regex**. | ||
| 5. In **Regexp** input `.*`. You can customize the regex as needed and test within the admin page or on sites like [Regexr](https://regexr.com/). | ||
| 6. Select **SAVE**. | ||
| 6. In **If the above expressions match, do the following**, select **Modify message**, select **Add more recipients** > Select **ADD** > Choose **Advanced**: | ||
| 1. Under **Envelope recipient**, select **Change envelope recipient** > **Replace recipient** > Enter the email of the recipient. | ||
| 2. Under **Spam and delivery options**, select **Suppress bounces from this recipient**. | ||
| 3. Under **Headers**, select **Add X-Gm-Spam and X-Gm-Phishy headers**. | ||
| 4. Select **SAVE**. | ||
| 7. In **Account types to affect**, select **Users** and **Groups**. | ||
| 8. Select **SAVE**. | ||
16 changes: 16 additions & 0 deletions
16
...ocs/email-security/deployment/api/setup/gsuite-bcc-setup/create-project-gcp.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| title: Create a project on Google Cloud Console | ||
| pcx_content_type: how-to | ||
| updated: 2022-10-11 | ||
| sidebar: | ||
| order: 4 | ||
| --- | ||
|
|
||
| import { Render } from "~/components" | ||
|
|
||
| 1. Log in to the [Google Cloud Console](https://console.cloud.google.com/welcome/new). From the dashboard, select **CREATE OR SELECT PROJECT**. | ||
| 2. Provide the details for the new project, and select **CREATE** to start your new project. | ||
| 3. Once the new project has been created, the Google Cloud Platform console will automatically redirect you to the Project console. If not, you can use the Project selector to change to the project you created. | ||
| 4. In **Getting Started**, select **Explore and enable APIs** > Select **ENABLE APIs & SERVICES**. | ||
| 5. On search bar, search for "Admin SDK API". Select **Admin SDK API**, then select **ENABLE**. | ||
Maddy-Cloudflare marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 6. Go back to the sidebar, select **Library**, and search for Gmail API. Select **Gmail API**, then select **ENABLE**. | ||
32 changes: 32 additions & 0 deletions
32
...email-security/deployment/api/setup/gsuite-bcc-setup/create-service-account.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| --- | ||
| title: Create service account | ||
| pcx_content_type: how-to | ||
| updated: 2022-10-11 | ||
| sidebar: | ||
| order: 4 | ||
| --- | ||
|
|
||
| import { Render } from "~/components" | ||
|
|
||
| 1. On the [Google Cloud Console](https://console.cloud.google.com/welcome/new), select **Credentials**. | ||
| 2. Select **CREATE CREDENTIALS** > **Service account**. | ||
| 3. Fill in the details to create a service account: | ||
| - **Service account name**: Enter **Message Retraction Service Account**. | ||
| - **Service account ID**: Enter **message-retraction-service-acc**. | ||
| - **Service account description**: Enter **Email Security Message Retraction**. | ||
Maddy-Cloudflare marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Select **CREATE AND CONTINUE**. | ||
| 4. In **Grant this service account access to project**, select **Select a role** > Choose **Owner**. Select **CONTINUE**, then **DONE**. | ||
| 5. Go back to **Credentials**, and select your service account under **Service Accounts**. In **Details**, take note of the **Unique ID**. | ||
| 6. Select **Advanced settings** > **VIEW GOOGLE WORKSPACE ADMIN CONSOLE**, then enter your password. | ||
| 7. On the sidebar, select **Security** > **Access and data control** > **API controls** > Select **MANAGE DOMAIN WIDE DELEGATION**. | ||
| 8. Select **Add new** > Add a new client ID: | ||
| - **Client ID**: Enter the **Unique ID** you took note of. | ||
| - **OAuth scopes**: Enter the following URL: | ||
Maddy-Cloudflare marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```txt | ||
| https://www.googleapis.com/auth/admin.directory.user.readonly, https://www.googleapis.com/auth/admin.directory.group.readonly, https://www.googleapis.com/auth/admin.directory.user.alias.readonly, https://www.googleapis.com/auth/gmail.labels, https://mail.google.com/ | ||
| ``` | ||
| - Select **AUTHORIZE**. | ||
|
|
||
| 9. Go back to the sidebar > **Service Accounts**. | ||
| 10. Select the three dots > **Manage keys** > **ADD KEY** > **Create new key** > Select **JSON** > Select **CREATE**. This downloads a `.json` file which you will use at a later stage. | ||
10 changes: 10 additions & 0 deletions
10
...s/email-security/deployment/api/setup/gsuite-bcc-setup/geographic locations.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| title: Geographic locations | ||
| pcx_content_type: reference | ||
| sidebar: | ||
| order: 6 | ||
| --- | ||
|
|
||
| import { Render } from "~/components" | ||
|
|
||
| <Render file="deployment/bcc-table-geographic-locations" /> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.