-
Notifications
You must be signed in to change notification settings - Fork 206
[DOCS] Blocklist #1811
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
[DOCS] Blocklist #1811
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
e9a8a41
Create new Blocklist page
joepeeples a60fb61
Add Blocklist page to TOC
joepeeples 5e60a82
Add new Blocklist section on UI overview page for
joepeeples c999291
Correction
joepeeples e51c2c8
Align description on UI overview page
joepeeples f22830f
Update config integration policy page, image
joepeeples 104b80b
Add info about int policy to blocklist page
joepeeples f04cc52
Add Blocklist to UI list
joepeeples 1cb29e9
Adds prelim "coming" tag, some corrections
joepeeples 0e9ef08
Correction
joepeeples 4736009
Add info about multiple values, lists
joepeeples 9d90323
another. correction.
joepeeples 97d5d9a
Apply first round of feedback
joepeeples f32efe2
Apply a few more feedback edits
joepeeples a101dc0
Update docs/management/admin/blocklist.asciidoc
joepeeples e1f5936
Update docs/management/admin/blocklist.asciidoc
joepeeples 80e01ca
Apply suggestions from Janeen's review
joepeeples 0a5c004
Rename actions menu (prev button)
joepeeples d7dcac4
Update docs/management/admin/blocklist.asciidoc
joepeeples 591c89d
Update docs/getting-started/configure-integration-policy.asciidoc
joepeeples 5953ab7
Merge branch 'main' into issue-1783-blocklist
joepeeples 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
Binary file modified
BIN
+2.6 KB
(100%)
docs/getting-started/images/install-endpoint/malware-protection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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,82 @@ | ||
| [[blocklist]] | ||
| [chapter] | ||
| = Blocklist | ||
|
|
||
| coming[8.2.0] | ||
|
|
||
| The blocklist allows you to prevent specified applications from running on hosts, extending the list of processes that {endpoint-sec} considers malicious. This is especially useful for ensuring that known malicious processes aren't accidentally executed by end users. | ||
|
|
||
| [NOTE] | ||
| ===== | ||
| In addition to configuring specific entries on the **Blocklist** page, you must also ensure that the blocklist is enabled on the {endpoint-sec} integration policy in the <<malware-protection, Malware protection settings>>. This setting is enabled by default. | ||
|
|
||
| You must have the built-in `superuser` role to access the blocklist. For more information, refer to {ref}/built-in-users.html[Built-in users]. | ||
| ===== | ||
|
|
||
| By default, a blocklist entry is recognized globally across all hosts running {endpoint-sec}. If you have a https://www.elastic.co/pricing[Platinum or Enterprise subscription], you can also assign a blocklist entry to specific {endpoint-sec} integration policies, which blocks the process only on hosts assigned to that policy. | ||
|
|
||
| . Go to **Manage** -> **Blocklist**. | ||
|
|
||
| . Click **Add blocklist entry**. The **Add blocklist** flyout appears. | ||
|
|
||
| . Fill in these fields in the **Details** section: | ||
| .. `Name`: Enter a name to identify the application in the blocklist. | ||
| .. `Description`: Enter a description to provide more information on the blocklist entry (optional). | ||
|
|
||
| . In the **Conditions** section, enter the following information about the application you want to block: | ||
| .. `Select operating system`: Select the appropriate operating system from the drop-down. | ||
| .. `Field`: Select a field to identify the application being blocked: | ||
| * `Hash`: The MD5, SHA-1, or SHA-256 hash value of the application's executable. | ||
| * `Path`: The full file path of the application's executable. | ||
| * `Signature`: (Windows only) The name of the application's digital signer. | ||
| + | ||
| TIP: To find the signer's name for an application, go to *Kibana* -> *Discover* and query the process name of the application's executable (for example, `process.name : "mctray.exe"` for a McAfee security binary). Then, search the results for the `process.code_signature.subject_name` field, which contains the signer's name (for example, `McAfee, Inc.`). | ||
|
|
||
| .. `Operator`: The operator is `is one of` and cannot be modified. | ||
|
|
||
| .. `Value`: Enter the hash value, file path, or signer name. To enter multiple values (such as a list of known malicious hash values), you can enter each value individually or paste a comma-delimited list, then press **Return**. | ||
| + | ||
| NOTE: Hash values must be valid to add them to the blocklist. | ||
|
|
||
| . Select an option in the *Assignment* section to assign the blocklist entry to a specific integration policy: | ||
| + | ||
| * `Global`: Assign the blocklist entry to all {endpoint-sec} integration policies. | ||
| * `Per Policy`: Assign the blocklist entry to one or more specific {endpoint-sec} integration policies. Select each policy where you want the blocklist entry to apply. | ||
| + | ||
| NOTE: You can also select the `Per Policy` option without immediately assigning a policy to the blocklist entry. For example, you could do this to create and review your blocklist configurations before putting them into action with a policy. | ||
|
|
||
| . Click **Add blocklist**. The new entry is added to the **Blocklist** page. | ||
|
|
||
| . When you're done adding entries to the blocklist, ensure that the blocklist is enabled for the {endpoint-sec} integration policies that you just assigned: | ||
| .. Go to **Manage** -> **Policies**, then click on an integration policy. | ||
| .. On the **Policy settings** tab, ensure that the **Malware protections enabled** and **Blocklist enabled** toggles are switched on. Both settings are enabled by default. | ||
|
|
||
| [discrete] | ||
| [[manage-blocklist]] | ||
| == View and manage the blocklist | ||
|
|
||
| The *Blocklist* page displays all the blocklist entries that have been added to the {security-app}. To refine the list, use the search bar to search by name, description, or field value. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/blocklist.png[] | ||
|
|
||
| [discrete] | ||
| [[edit-blocklist-entry]] | ||
| === Edit a blocklist entry | ||
| You can individually modify each blocklist entry. With a Platinum or Enterprise subscription, you can also change the policies that a blocklist entry is assigned to. | ||
|
|
||
| To edit a blocklist entry: | ||
|
|
||
| . Click the actions menu (*...*) for the blocklist entry you want to edit, then select *Edit blocklist*. | ||
| . Modify details as needed. | ||
| . Click *Save*. | ||
|
|
||
| [discrete] | ||
| [[delete-blocklist-entry]] | ||
| === Delete a blocklist entry | ||
| You can delete a blocklist entry, which removes it entirely from all {endpoint-sec} policies. This allows end users to access the application that was previously blocked. | ||
|
|
||
| To delete a blocklist entry: | ||
|
|
||
| . Click the actions menu (*...*) for the blocklist entry you want to delete, then select *Delete blocklist*. | ||
| . On the dialog that opens, verify that you are removing the correct blocklist entry, then click *Delete*. A confirmation message displays. | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We talked about the possibility of putting the "block box" (can't think of the official term). Here's the syntax again just in case you want to try it.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since most of the pages for endpoint management are so similar, I'd like to make this update in a separate issue that includes adding the prerequisites box consistently across all the pages. I was already thinking of creating this issue for general consistency fixes, so I think the prereqs box would fall nicely into that issue's scope.