Lawliet LAWLIET
Book a demo

Appendix A. Action index

This guide describes Lawliet 1.5.13.s (the current release). Screens, commands and procedures may change in later versions; the usage guide is updated with each release. Check the version your server runs under Settings > Platform or with ./lawliet version, and see the Releases page for what changed.

Every action an operator can take in Lawliet 1.5.13.s - on the server's command line, on a monitored host, and in every page, tab, button, menu, dialog, form, toggle, export and data-changing filter of the console - with where it is, the permission it needs, whether a second administrator must approve it, and the section of this guide with its step-by-step procedure.


A.1 How to read this index#

ColumnMeaning
ActionWhat you want to do. Related buttons on the same screen share a row
WhereSidebar entry > Page or tab > Control, with the exact labels on screen; a command for the CLI and host rows
PermissionThe role-editor name of the permission (Appendix B). "Administrator role" means a built-in administrator-level role. "-" means any signed-in user
Four-eyes"yes (<critical action>)" when a second administrator must approve it with the default policy; "policy (off by default)" when your policy may turn it on; "no" when it never does; "-" for screens that only show information
Guide sectionThe section with the procedure: numbered steps, what you see, and what to do if it fails. For a screen that only shows information, the section that describes it; opening it is the path itself

How it was made. The index was built from the code of release 1.5.13.s, not from memory: every <button>, check box, confirmation question and download in the console's pages and components (about 630 controls on 57 routes), every write call the console makes to the server (about 190 distinct ones), every ./lawliet command and option, and the agent installers. Controls that only move around a list (paging, closing a panel, Retry after a load error) are not listed separately. Each row was then matched to a procedure; where none existed, the procedure was written into its chapter. Objects that can be created are listed again in A.25 with how each is viewed, changed, paused and removed - or what to do where the console has no such button.

Contents: A.2 CLI, A.3 hosts, A.4 sign-in, A.5 Overview, A.6 Environment, A.7 Assets and Stories, A.8 Compliance, A.9 Hardening, A.10 Evidence, A.11 Operations, A.12 Review queue, A.13 Forensics, A.14 Defense, A.15 Honeypots, A.16 FIM, A.17 Logs, A.18 DLP, A.19 Network, A.20 Firewall, A.21 AD assessment, A.22 Playbooks, A.23 Approvals, A.24 Settings, A.25 lifecycle, A.26 not in the console.


A.2 The ./lawliet command#

Run in the installation directory as root (sudo). None of these goes through four-eyes: whoever has root on the server has full control of it (9.4).

ActionWherePermissionFour-eyesGuide section
Install Lawliet (install)sudo ./lawliet installRoot on the serverno2: Step by step
Show health, licence, schema, estate size (status, st)sudo ./lawliet statusRoot on the serverno3.3 status
Start everything or one service (start [service], up)sudo ./lawliet startRoot on the serverno3.4 start
Stop the containers, data untouched (stop [service], down)sudo ./lawliet stopRoot on the serverno3.5 stop
Restart and wait for health (restart [service])sudo ./lawliet restartRoot on the serverno3.6 restart
Read logs (logs [service] [-f] [-n N])sudo ./lawliet logs backend -fRoot on the serverno3.7 logs
Take a database backup (backup [dir])sudo ./lawliet backupRoot on the serverno5.2 Take a backup now
Schedule backups and copy them off the servercron + backupRoot on the serverno5.3 Schedule backups and copy them off the server
Restore a dump (restore <dump>)sudo ./lawliet restore <dump>Root on the serverno5: Procedure
Restore onto a new serverinstall then restoreRoot on the serverno5: Procedure
Test a backuprestore on a test serverRoot on the serverno5.6 Test your backups
Update from a bundle, a delta or a directory (update <file>, upgrade)sudo ./lawliet update <file>Root on the serverno4.3 Update from a file (the standard route)
Install the update the console staged (update --staged)sudo ./lawliet update --stagedRoot on the serverno4: Route A: upload a bundle (air-gapped sites)
Skip the certificate check after an update (update --no-cert-repair)update <file> --no-cert-repairRoot on the serverno4.3 Update from a file (the standard route)
Apply a delta updateupdate <delta>Root on the serverno4.7 Delta updates
Roll back the last update (rollback [--yes] [--to DIR] [--backup DUMP])sudo ./lawliet rollbackRoot on the serverno4: Procedure
Diagnose (doctor, diagnostics)sudo ./lawliet doctorRoot on the serverno7: Report only
Apply the safe fixes (doctor --fix [--yes])sudo ./lawliet doctor --fixRoot on the serverno7: Apply the safe fixes
Make the redacted support archive (diag [--since 24h] [--output P] [--lines N] [--keep-emails])sudo ./lawliet diagRoot on the serverno7.2 diag
Show the enrolment secret and install commands (token)sudo ./lawliet tokenRoot on the serverno3.15 token
Replace the enrolment secret (token --rotate)sudo ./lawliet token --rotateRoot on the serverno16.6 The enrolment secret and enrolment codes
Make an offline agent package (agent-package --os linux|windows [--arch] [--hosts] [--days] [--label] [--server] [--out])sudo ./lawliet agent-package --os linuxRoot on the serverno11.3.2 Or make the package on the server
Make the Windows MSI and transform for Group Policy (agent-package --os windows --gpo)sudo ./lawliet agent-package --os windows --gpoRoot on the serverno12.4 Group Policy: make the rollout package
Reset the installation administrator's password, or turn its two-factor off (passwd)sudo ./lawliet passwdRoot on the serverno3.17 passwd
Check the certificate (tls status, tls)sudo ./lawliet tls statusRoot on the serverno6: On the server
Export the certificate for agent hosts (tls --export [path])sudo ./lawliet tls --exportRoot on the serverno6.3 Export the certificate for agent hosts
Install a certificate from your CA (tls, cert)sudo ./lawliet tlsRoot on the serverno6: Procedure
Re-issue the self-signed certificate (tls repair [--yes] [--force] [--timeout S] [--ack P] [--allow-public-root])sudo ./lawliet tls repairRoot on the serverno6: With agents enrolled
Hand a public CA's root to agents (--allow-public-root)tls / tls repairRoot on the serverno6: Handing a public CA's root to agents
Withdraw a staged certificate (tls cancel)sudo ./lawliet tls cancelRoot on the serverno6.7 Withdraw a staged certificate (tls cancel)
Turn encryption off (tls off)sudo ./lawliet tls offRoot on the serverno6: Turn encryption off
Turn encryption on (tls on)sudo ./lawliet tls onRoot on the serverno6: Turn encryption on
Move a plain-HTTP install to HTTPStls on and agent reinstallRoot on the serverno6.9 Move a plain-HTTP install to HTTPS
Show the licence and fingerprint, or install a key (licence [key], license)sudo ./lawliet licenceRoot on the serverno2: Step 2: install the key you receive
Delete containers and volumes (uninstall)sudo ./lawliet uninstallRoot on the serverno3.21 uninstall
Show the version, or the help (version, --version, help)./lawliet versionRoot on the serverno3.22 version and help
Add an address the server answers to (TRUSTED_HOSTS).env, then startRoot on the serverno8.9 Add an address to TRUSTED_HOSTS
Check and fix the server clocktimedatectlRoot on the serverno8: Check and fix the server clock

A.3 On the monitored hosts#

Run as root (Linux, macOS) or as Administrator (Windows) on the host. A protected agent needs an uninstall code or the recovery key to be removed.

ActionWherePermissionFour-eyesGuide section
Linux: install with the copy-paste commandShell on the hostRoot on the hostno11.2 Procedure: install with the copy-paste command
Linux: install from an offline packageShell on the hostRoot on the hostno11.3.3 Install the package on the host
Linux: installer options (--server, --token, --ca-cert, --reset-token, --refresh-ca, ...)install_linux.shRoot on the hostno11.4 Installer options
Linux: status, log, restart; files and servicessystemctl, journalctlRoot on the hostno11.5 Managing the agent on the host
Linux: upgrade or repair by re-running the installerinstall_linux.shRoot on the hostno11.5 Managing the agent on the host
Linux: uninstall the agentinstall_linux.sh --uninstallRoot on the hostno11.6 Procedure: uninstall the agent
Linux and macOS: change agent settings (config.env)/opt/lawliet-agent/config.envRoot on the hostno10.5 Agent configuration on the host
macOS: install, status, log, uninstall, new certificateinstall_macos.sh, launchctlRoot on the hostno11.7 macOS
Windows: install with the copy-paste commandElevated PowerShellAdministrator on the hostno12.2 Procedure: install with the copy-paste command
Windows: install from an offline package (ZIP)Elevated PowerShellAdministrator on the hostno12.3 Procedure: install from an offline package (ZIP)
Windows: roll out with Group Policy Software installation (MSI)Group Policy ManagementDomain administratorno12.5 Procedure: Group Policy with Software installation (MSI)
Windows: roll out with a computer startup scriptGroup Policy ManagementDomain administratorno12.6 Procedure: Group Policy with a computer startup script
Windows: MSI upgrade and removal, exit codes, event logmsiexecAdministrator on the hostno12.7 MSI results, upgrades and removal
Windows: prepare hosts for WinRM over HTTPS (5986)Elevated PowerShellAdministrator on the hostno12: WinRM over HTTPS on 5986 (recommended)
Windows: prepare hosts for WinRM over plain HTTP (5985, insecure)Elevated PowerShellAdministrator on the hostno12: WinRM over plain HTTP on 5985 (insecure)
Windows: uninstall the agentinstall_windows.ps1 -UninstallAdministrator on the hostno12.9 Procedure: uninstall the agent
Windows: installer parameters; status, log, restart, repairinstall_windows.ps1, Get-ScheduledTaskInfoAdministrator on the hostno12.10 Installer parameters (install_windows.ps1)
Any OS: uninstall a protected agent with an uninstall code--uninstall --code / -Uninstall -CodeRoot / Administrator, plus a code (Delete agents)no16.3 Uninstall codes
Any OS: uninstall a protected agent with the recovery key--recovery-key / -RecoveryKeyRoot / Administrator, plus the keyno16.4 The recovery key
Any OS: give an agent a new server certificate by hand--refresh-ca / -RefreshCaRoot on the host / Administrator on the hostno16.7 When the server certificate changes
Any OS: fix the host clockNTP / w32tm /resyncRoot on the host / Administrator on the hostno10.6 Host clocks
Any OS: a host does not appear or goes offlineHost and consoleRoot on the host / Administrator on the hostno10.9 If a host does not appear or goes offline

A.4 Sign-in and your own account#

ActionWherePermissionFour-eyesGuide section
Sign in with a local accountSign in page > Sign in-no2: Step 1: sign in
Enter the authenticator codeSign in page > Verify-no2: Step 1: sign in
Sign in with a recovery codeSign in page > Use a recovery code-no15.1 First sign-in of a local account
Sign in with a directory (AD) accountSign in page > Sign in with directory account-no14.2 Procedure: set up directory sign-in
Sign in with Windows (Kerberos)Sign in page > Sign in with Windows (Kerberos)-no14.4 Procedure: Windows sign-in (Kerberos single sign-on)
Ask for a password reset link; set the new passwordSign in page > Forgot? > Send link; Reset password page-no15: Procedure: a user forgot their password
Set a new password at first sign-inSet a new password > Set password-no2: Step 2: set a new password
Change your own password at any timehttps://<server>/change-password > Set password-no15: Procedure: change your own password
Turn on two-factor; copy or download the recovery codesTwo-factor page > Copy, Download, Turn on two-factor authentication-no2: Step 3: turn on two-factor authentication
Activate a licence on the activation screenActivation screen > Activate licenceManage the licenceyes (Change the licence)2: Step 2: install the key you receive
Sign out; switch theme; hide the sidebar; filter modulesSidebar and header-no20: Everyday controls
Read and clear notifications; open notification settingsHeader > bell > Mark all read, gear-no20.5 The notification bell
Send a request for approval from any module<action> needs a second signature > Send for approvalThe action's permissionas the action20.4 Four-eyes from inside a module

A.5 Overview and the wall#

ActionWherePermissionFour-eyesGuide section
Read the OverviewOverviewView the overview-20.6 The Overview page
Refresh the OverviewOverview > freshness stampView the overview-20.6 The Overview page
Run the protection drills nowOverview > Proof of protection > Run drills nowManage agentsno20: Procedure: run the drills now
Open and leave the wallOverview > Wall mode / Exit wallView the overview-20.8 The wall (full-screen operations view)
Integrate a detected domainOverview > Domains detected > Integrate (disabled: "Coming soon")--20.6 The Overview page

A.6 Environment: hosts, installation, remote deployment, agent versions#

ActionWherePermissionFour-eyesGuide section
See the hosts; filter by name or statusEnvironment > Hosts > Filter, status buttonsView agents-10.4 The Environment page
Open a host's drawerEnvironment > Hosts > rowView agents-10: The agent drawer
Get the install command for Linux, macOS or WindowsEnvironment > Hosts > Install agent > Install command > OS > copyManage agentsno11.2 Procedure: install with the copy-paste command
Request, create and download an offline packageEnvironment > Hosts > Install agent > Offline package > Request package, Check again, Create package, DownloadDeploy agents remotelyyes (Deploy agents remotely)11.3.1 Make the package in the console
Revoke an enrolment codeInstall agent > Offline package > Enrolment codes > RevokeDeploy agents remotelyno16: Procedure: revoke an enrolment code
Open remote deployment from the install dialogInstall agent > Remote deployment > Open remote deploymentManage deployment credentials-13.6 Other ways into remote deployment
Reinstall plain-HTTP agents over HTTPSEnvironment > Hosts > red banner > Show the HTTPS install commandManage agentsno6.9 Move a plain-HTTP install to HTTPS
Run drills on one hostHost drawer > Proof of protection > Run drills nowManage agentsno20: Procedure: run the drills now
Turn self-protection onHost drawer > Self-protection > Turn onManage agentsno16: Procedure: turn self-protection on
Turn self-protection offHost drawer > Self-protection > Turn offManage agentsno16: Procedure: turn self-protection off
Issue an uninstall codeHost drawer > Self-protection > Issue uninstall codeDelete agentsyes (Delete an agent)16.3 Uninstall codes
Issue a stop code (no host command accepts it in this release)Host drawer > Self-protection > Issue stop codeDelete agentsyes (Delete an agent)16.3 Uninstall codes
Remove a host with no recordsHost drawer > Remove agent > RemoveDelete agentsyes (Delete an agent)10.7 Removing a host from the console
Delete a host and all its recordsHost drawer > Remove agent > Delete it and its recordsDelete agentsyes (Delete an agent)10.7 Removing a host from the console
Keep a host's records, revoke its tokenHost drawer > Remove agent > Keep the records: revoke its tokenDelete agentsyes (Delete an agent)10.7 Removing a host from the console
Add a deployment credential (SSH or WinRM)Environment > Hosts > Deploy agents remotely > Add credential > Save credentialManage deployment credentialsonly weakening WinRM settings13.2 Procedure: add a credential
Change a WinRM credentialDeploy agents remotely > Credentials > Edit > Save changesManage deployment credentialsonly weakening WinRM settings13: Procedure: change or delete a credential
Delete a credentialDeploy agents remotely > Credentials > DeleteManage deployment credentialsno13: Procedure: change or delete a credential
Test a credential against one host; cancel the testCredentials > Test > Test connection; Approvals > Cancel testManage deployment credentials + Deploy agents remotelyyes (Deploy agents remotely)13.3 Procedure: test a credential against one host
Switch a credential back to HTTPSCredentials > EditManage deployment credentialsno13.7 Switch a credential back to HTTPS
Add, change or remove Kerberos realms; check the KDCsDeploy agents remotely > Kerberos realms > Add realm / Edit realms, Add another realm, Remove realm, Save realms, Check KDCsManage deployment credentialsyes (Deploy agents remotely) to save13.4 Procedure: configure Kerberos realms
Deploy agents to a list of hostsDeploy agents remotely > Deploy agentsDeploy agents remotelyyes (Deploy agents remotely)13.5 Procedure: deploy agents
Follow a deployment; show a host's checksDeployment > Checks (N failed, M warnings) / Hide checksManage deployment credentials-13.5 Procedure: deploy agents
Cancel the hosts of a deployment not yet startedDeployment > Cancel what has not startedManage deployment credentialsno13.5 Procedure: deploy agents
Retry a failed or cancelled hostDeployment > host > RetryDeploy agents remotelyyes (Deploy agents remotely)13.5 Procedure: deploy agents
See the fleet's versions and upgrade candidatesEnvironment > Agent versionsManage agents-10.8 Agent versions and upgrades
Import the agents shipped in the bundleAgent versions > Import bundled agentsPublish agent releasesno10: Procedure: upgrade agents on an air-gapped site
Register a release by hand; upload its artefactAgent versions > Register a release > Register as draft; Upload artefactPublish agent releasesno10: Procedure: register a release by hand
Publish a releaseAgent versions > release > PublishPublish agent releasesyes (Publish an agent release)10: Procedure: upgrade agents on an air-gapped site
Roll a release out to ten hostsAgent versions > release > Roll out 10Publish agent releasesyes (Publish an agent release)10: Procedure: upgrade agents on an air-gapped site
Upgrade one hostAgent versions > Upgrade candidates > Upgrade to <version>Publish agent releasesyes (Publish an agent release)10: Procedure: upgrade one host, stop a rollout, retire a release
Unpublish a releaseAgent versions > release > UnpublishPublish agent releasesno10: Procedure: upgrade one host, stop a rollout, retire a release
Delete a releaseAgent versions > release > DeletePublish agent releasesno10: Procedure: upgrade one host, stop a rollout, retire a release

A.7 Assets and Stories#

ActionWherePermissionFour-eyesGuide section
See the asset inventory and a host's riskAssets; filters Criticality, Environment, Internet-exposed only, High risk onlyView agents-38.1 The Assets page
Create asset profiles for every agentAssets > Sync from agentsManage agentsno38: Procedure: classify your assets
Set an asset's criticality and environmentAssets > rowManage assetsno38: Procedure: classify your assets
Read the stories; filter the window and multi-module hostsStories > Window, Only hosts seen by two or more modulesView the review queue-38.2 The Stories page
Open an investigation from a storyStories > host > Open an investigationRun forensicsno38: Procedure: turn a story into an investigation

A.8 Compliance#

ActionWherePermissionFour-eyesGuide section
See frameworks, scan history, active scansCompliance > OverviewView compliance-22.1 What the Overview tab shows
Run a scan on all or selected agentsCompliance > Overview > Run compliance scan > Run scan on ...Run scansno22.2 Procedure: run a scan
Choose a framework from the registryCompliance > Overview > Framework registry > SelectView compliance-22.2 Procedure: run a scan
Open a scan; filter its controls; read a control's evidenceCompliance > scan > filter buttons, Show all controls, Show all hosts, rowView compliance-22.3 Reading a scan
Start hardening from the Fix planScan > Fix plan > Start hardening (N)Run hardeningno (the run waits for approval)22.4 Procedure: start hardening from the fix plan
Create a compliance scheduleCompliance > Schedules > New schedule > Save scheduleRun scansno23: Procedure: create a schedule
Run a schedule now; disable or enable it; edit it; delete itCompliance > Schedules > Run now, Disable/Enable, Edit, Delete > YesRun scansno23: Procedure: run a schedule now, pause it, change it, delete it
Read drift; filter it; open a drift recordCompliance > Drift > filters, rowView compliance-23.2 The Drift tab
Compare two scans on demandCompliance > Drift > Compare scans on-demand > CompareRun scansno23: Procedure: compare two scans on demand
Find where a control fails (heatmap, cell detail, filters)Compliance > Heatmap > filters > Apply, cellView compliance-24: Procedure: find where a control fails
Show the trend for a period (filters, Apply, Reset)Compliance > Trends > FiltersView compliance-24: Procedure: show the trend for an audit period
Record an attestationCompliance > Attestations > New attestation > Record attestationRun scansno25: Procedure: record an attestation
Revoke an attestationCompliance > Attestations > RevokeRun scans or Manage complianceno25: Procedure: revoke an attestation
Request an exceptionCompliance > Attestations > exceptions > Request exception > Submit requestView complianceno (no effect until approved)25: Procedure: request an exception
Approve or revoke an exceptionCompliance > Attestations > exceptions > Approve / RevokeManage compliancebuilt in: never the requester25: Procedure: approve or revoke an exception
Generate a report now and download itCompliance > Reports > Generate now, DownloadView complianceno25: Procedure: generate a report now
Schedule a reportCompliance > Reports > New schedule > Create scheduleManage reportsno25: Procedure: schedule a report
Change or delete a report scheduleCompliance > Reports > Delete schedule <name>Manage reportsno25: Procedure: change or stop a report schedule

A.9 Hardening#

ActionWherePermissionFour-eyesGuide section
See runs; filter by ID, framework, status; open a runHardening > filters, DetailsView hardening-26.1 What the Hardening page shows
Approve and execute a runHardening > run > Approve & Execute > Confirm and executeRun hardeningyes (Execute remediation)26.2 Procedure: approve and execute a run
Roll back a runHardening > run > Rollback > Confirm rollbackRun hardeningyes (Execute remediation)26.3 Procedure: roll back a run
Cancel a runHardening > run > Cancel > Confirm cancelRun hardeningno26.4 Procedure: cancel a run
Issue and download a recovery artifactHardening > Recovery / break-glass > Issue, Download onceRun hardeningyes (Execute remediation)26: Procedure: issue and download a recovery artifact
Open failed steps in the review queueHardening > View in review queueView the review queue-26.1 What the Hardening page shows

A.10 Evidence#

ActionWherePermissionFour-eyesGuide section
See bundles; filter; open detailsEvidence > filters, View detailsView evidence-27.1 What you see
Create a bundleEvidence > New evidence bundle > Create bundleRun scansno27.2 Procedure: create a bundle
Export a bundle as JSON or HTMLEvidence > Export JSON / Export HTMLView evidenceno27.3 Procedure: export and hand over
Verify an exported JSON fileAPI POST /api/v1/evidence/verifyView evidence (API key)no27.4 Verify an exported JSON file
Delete a bundleEvidence > Delete bundle > confirmDelete evidenceno27.5 Procedure: delete a bundle

A.11 Operations#

ActionWherePermissionFour-eyesGuide section
Run a framework scan, discover network assets, scan paths for sensitive data, verify or baseline an agentOperations > Operation > fields > buttonAdministrator role; plus the module permissionno39: Procedure: run an operation
Auto-remediate an incidentOperations > Auto-remediate an incident > RemediateAdministrator role; Execute containmentyes (Run a containment action)39: Procedure: run an operation
Clear the execution logOperations > Execution log > ClearAdministrator roleno39: Procedure: run an operation

A.12 Review queue#

ActionWherePermissionFour-eyesGuide section
See the queue; filter by module, status, severity, priority; clear filtersReview queue > module chips, filters, Clear all xView the review queue-21.1 What you see
Change status, assign (or Assign to me), comment, resolve, accept risk, suppressReview queue > item > ActionsWork the review queueno21.2 Procedure: work an item
Move an item by dragging it to another laneReview queue > boardWork the review queueno21: Moving items on the board
Isolate a host from a tamper or silence itemReview queue > item > Isolate this hostExecute containmentyes (Run a containment action)21: Procedure: isolate a host from a tamper or silence item
Follow a context link (deploy an agent, open the credential)Review queue > item > Deploy an agent to this host, Open the credentialThe target page's permission-21.2 Procedure: work an item

A.13 Forensics and IOC hunts#

ActionWherePermissionFour-eyesGuide section
See the investigation queueForensicsView forensics-34.1 The Forensics page
Open a caseForensics > New investigation > Open caseRun forensicsno34: Procedure: open a case
Read a case (Overview tab, recent runs, findings)Forensics > case > OverviewView forensics-34.2 The case workspace
Run live-response collectors; open their recordsCase > Live response > Run collectors, OpenRun forensicsno34: Procedure: run live response
Collect files, build a triage package, capture memoryCase > Triage & files > Collect files / Build triage package / Capture memoryRun forensicsno34: Procedure: collect files, a triage package or memory
Attach a file from your computerCase > Triage & files > Choose fileRun forensicsno34: Procedure: attach a file from your computer
Browse artifacts and their chain of custodyCase > Artifacts > item; Table / Raw JSONView forensics-34.4 Artifacts and chain of custody
Download an artifactCase > Artifacts > item > DownloadRun forensicsno34: Procedure: download an artifact
Filter and export the super-timelineCase > Timeline > Apply, CSV, JSON, Load the next NView forensics (export: Run forensics)no34: Procedure: filter and export the timeline
Start an IOC hunt (indicators, Load file, Parse on server, YARA Validate, targets)Forensics > IOC hunts > New hunt > Start hunt (or case > Hunt)Run forensicsno34: Procedure: start a hunt
Stop a hunt; export its resultsHunt > Cancel hunt, CSV, JSON, RefreshRun forensicsno34: Procedure: stop a hunt or export its results
Take a response action on a case host; undo itCase > Response > Run; undo in Actions in this caseExecute containmentyes (Run a containment action)34.7 Response from a case

A.14 Defense#

ActionWherePermissionFour-eyesGuide section
See the engine, the catalog and dispatched actionsDefenseView active defence-36.1 What the Defense page shows
Dispatch a containment action (isolate, block, kill, quarantine, disable account, reset credentials)Defense > Remediation actions > action > Dispatch actionExecute containmentyes (Run a containment action)36.3 Procedure: dispatch a containment action
Undo an action (also under Still in place on hosts)Defense > Dispatched actions > Undo (<action>)Execute containmentyes (Run a containment action)36.4 Procedure: undo an action
Run a command on a hostDefense > Run a command > Review and run > Yes, run it via <interpreter>Execute containment (and DEFENSE_ALLOW_CUSTOM_COMMANDS=true)yes (Run a containment action)36.5 Run a command (operator live response)

A.15 Honeypots#

ActionWherePermissionFour-eyesGuide section
See decoys and trips; filter tripsHoneypotsView honeypots-35.2 What the Honeypots page shows
Create a decoyHoneypots > New decoy > Create decoyManage honeypotsno35.3 Procedure: create and deploy a decoy
Deploy a decoy to its hostsHoneypots > decoy > DeployManage honeypotsno35.3 Procedure: create and deploy a decoy
Undeploy a decoyHoneypots > decoy > UndeployManage honeypotsno35.6 Procedure: undeploy or delete a decoy
Delete a decoyHoneypots > decoy > DeleteManage honeypotsno35.6 Procedure: undeploy or delete a decoy
Handle a trip (Acknowledge, Resolve, False positive)Honeypots > Trips > trip > Set statusManage honeypotsno35.4 Procedure: handle a trip
Turn on auto-contain for a decoyNew decoy > Auto-contain the source on a tripManage honeypotsno (turning it on is the authorisation)35.3 Procedure: create and deploy a decoy
Lift an automatic blockDefense > Dispatched actions > Undo (unblock address)Execute containmentyes (Run a containment action)36.4 Procedure: undo an action

A.16 File integrity monitoring (FIM)#

ActionWherePermissionFour-eyesGuide section
See changes; filter by path and severityFIM > ChangesView FIM-33.4 Working the changes
Create a FIM policy (template, validation)FIM > Policies > New policy > Create policyManage FIMno33.2 Procedure: create a FIM policy
Change a FIM policyFIM > Policies > policy name > Save changesManage FIMno33: Procedure: change, disable or delete a FIM policy
Disable or enable a FIM policyFIM > Policies > Disable / EnableManage FIMno33: Procedure: change, disable or delete a FIM policy
Delete a FIM policyFIM > Policies > DeleteManage FIMno33: Procedure: change, disable or delete a FIM policy
Build a baseline; browse itFIM > Agents and baselines > Baseline now; Baseline cellManage FIMno33: Procedure: build a baseline
Verify one host or every host of a policyFIM > Agents and baselines > Verify now; Policies > Verify all agentsManage FIMno33: Procedure: verify a host against its baseline
Accept verified changes into the baselineVerification result > Accept / Accept all N change(s) into the baselineManage FIMno33: Procedure: accept verified changes into the baseline
Triage a changeFIM > Changes > event > Set status > SaveTriage findingsno33: Procedure: triage a change
Accept one change into the baselineFIM > Changes > event > Accept into baselineManage FIMno33: Procedure: accept a change into the baseline

A.17 Logs#

ActionWherePermissionFour-eyesGuide section
Search logs (query, time range, custom range, severity, break down, Only/Exclude a value, chart or table, paging)Logs > Search > SearchSearch logs-30: Procedure: investigate failed logins for one account
Save a searchLogs > Search > Save search > SaveSearch logsno30: Procedure: investigate failed logins for one account
Delete a saved searchLogs > Search > Saved > x (Delete saved search <name>)Search logsno30: Procedure: delete a saved search
Turn a search into a ruleLogs > Search > Make this a ruleManage detection rulesno31.2 Procedure: create a detection rule
Build a dashboard (also from a search: Add to dashboard)Logs > Dashboards > New dashboard > Add panel > Save dashboardSearch logsno30: Procedure: build a dashboard
Change, copy, delete a dashboard; copy a built-in oneLogs > Dashboards > Edit, Copy, Delete dashboard, Copy to editSearch logsno30: Procedure: change, copy or delete a dashboard
Add a syslog sourceLogs > Sources > Add source > CreateManage log sourcesno30: Procedure: add a syslog source
Add an HTTP shipper and store its tokenLogs > Sources > Add source > Create > Copy token > I have stored itManage log sourcesno30: Procedure: add an HTTP shipper
Delete a sourceLogs > Sources > Delete <name>Manage log sourcesno30: Procedure: delete a source
Create a detection rule (preview, test on sample lines)Logs > Rules > New rule > Preview, Run test, Create ruleManage detection rulesno31.2 Procedure: create a detection rule
Change a ruleLogs > Rules > rule name > Save as new versionManage detection rulesno31: Procedure: change a rule
Enable, disable or run a rule nowLogs > Rules > Enable / Disable, Run <rule> nowManage detection rulesno31: Procedure: enable, disable or run a rule now
Restore an earlier version of a ruleLogs > Rules > History of <rule> > Restore vN as a new versionManage detection rulesno31: Procedure: restore an earlier version
Delete a ruleLogs > Rules > Delete <rule>Manage detection rulesno31: Procedure: delete a rule
Triage alerts in bulk (status, assign)Logs > Alerts > tick > Set status, Assign selectedWork the review queueno31: Procedure: triage alerts in bulk
Escalate alerts to an investigationLogs > Alerts > tick > EscalateRun forensicsno31: Procedure: escalate alerts to an investigation
Work one alert (triage, assign, suppress its subject, escalate, search around it)Logs > Alerts > alertWork the review queue / Manage detection rules / Run forensicsno31: Procedure: work one alert
Install Sigma rules from the packLogs > Sigma > Rule pack > Install selectedManage detection rulesno31: Procedure: install rules from the pack
Translate and import your own Sigma YAMLLogs > Sigma > Paste YAML > Translate, Import NSearch logs (translate); Manage detection rules (import)no31: Procedure: import your own Sigma YAML
Rank entities; recompute scoresLogs > Entities > Find, RecomputeSearch logs (Recompute: Manage detection rules)no31.5 The Entities tab
See ATT&CK coverage; jump to rules or SigmaLogs > ATT&CK > technique > Rules for <technique>, Find a Sigma ruleSearch logs-31.6 The ATT&CK tab

A.18 Data loss prevention (DLP)#

ActionWherePermissionFour-eyesGuide section
See and filter incidentsDLP > Incident queueView DLP-32.2 Incidents
Triage an incidentDLP > incident > Set status > SaveTriage findingsno32: Procedure: triage an incident
Create a DLP policy (rules, channel actions, device control, egress programs, Reset to built-in list, Test text)DLP > Policies > New policy > Save policyManage DLPno32: Procedure: create a DLP policy
Change, disable or delete a DLP policyDLP > Policies > row; Enabled; binManage DLPno32: Procedure: change, disable or delete a DLP policy
Run a discovery scan; export the inventory (CSV, JSON)DLP > Discovery > Start scanManage DLP (export: View DLP)no32: Procedure: run a discovery scan
Schedule discoveryDLP > Discovery > Scheduled discovery > New schedule > Save scheduleManage DLPno32: Procedure: schedule discovery
Run, change, pause or delete a discovery scheduleDLP > Discovery > schedule > Run now, row, disable/enable, DeleteManage DLPno32: Procedure: run, change, pause or delete a discovery schedule
Find a file across hostsDLP > Where is this file > SearchManage DLPno32.5 Where is this file
Read a host's enforcement statusDLP > Enforcement status > Select host...View DLPno32.6 Enforcement status

A.19 Network#

ActionWherePermissionFour-eyesGuide section
See the map, nodes, discovery runs; filter the inventoryNetworkView network-28.1 What the Network page shows
Use the map (find, zoom, fit, node detail)Network > mapView network-28.2 Using the topology map
Rescan one hostNetwork > node > Rescan nowManage networkno28: Procedure: rescan one host
Run a server-side discovery scan (Plan scope, Run scan)Network > Trigger server-side network scanManage networkno28.3 Procedure: run a server-side discovery scan
Remove the hidden internet endpointsNetwork > Remove themManage networkno28: Procedure: remove the hidden internet endpoints
Seed or clear sandbox topology (sandbox accounts)Network > Sandbox / Demo topology > Seed sandbox topology / Clear sandbox topologyManage demo datapolicy (off by default)28.4 Sandbox topology
Read internet exposure per hostNetwork > ExposureView network-28.5 The Exposure page
Export the topology (Report, JSON, CSV; redaction options)Network > Export topology > Download <FORMAT>View networkno28.6 Procedure: export the topology

A.20 Firewall#

ActionWherePermissionFour-eyesGuide section
See the devices listFirewallView firewall-29.2 The devices list
Connect a live firewallFirewall > Connect a firewall > Connect, test and readManage firewallno29: Procedure: connect a live firewall
Import a configuration fileFirewall > Import a configuration > ImportManage firewallno29: Procedure: import a configuration file
Test the connection; read the policy againDevice > Test connection, Read now (also on the list row)Manage firewallno29: Procedure: test the connection and read the policy again
Stop using a device (no remove button)Device > Monitor > Stop monitoring; disable the account on the deviceManage firewallno29: Removing a device
Read the policy and the findings; compliance mappingDevice > Policy, FindingsView firewall-29.4 Findings
Make an optimisation planDevice > Optimise > Plan all M safe fixes / Plan the N chosen fixesManage firewallno29.5 Procedure: make an optimisation plan
Apply a plan to the firewall; approve, reject, run itDevice > Apply > Request apply; Approve / Reject; Run the approved applyPush firewall policyyes (Push a firewall policy)29.6 Procedure: apply a plan to the firewall (four-eyes)
Compare two versionsDevice > Versions > tick twoView firewall-29: Procedure: compare two versions
Set the baselineDevice > Versions > Set as baselineManage firewallno29: Procedure: set the baseline
Download the configuration or a plan (script, full config, model JSON)Device > ExportView firewallno29: Procedure: export a configuration or a plan
Start or stop live monitoringDevice > Monitor > Start monitoring / Stop monitoringManage firewallno29: Procedure: start or stop live monitoring
Count rule hits from logsDevice > Monitor > Count from logsManage firewallno29: Procedure: count hits from logs

A.21 AD assessment#

ActionWherePermissionFour-eyesGuide section
Register a domainAD assessment > Register a domain > AddManage complianceno14: Procedure: register a domain and collect
Collect a domain's objects and permissionsAD assessment > Collect permissions nowManage complianceno14: Procedure: register a domain and collect
Read coverage, findings, attack paths, complianceAD assessment > tabsView compliance-14: The tabs
Deploy agents via GPO (does not install the agent in 1.5.13.s; use the MSI)AD assessment > Coverage > Deploy agents via GPOWrite to Active Directoryyes (Write to Active Directory)14: Deploy agents via GPO (Coverage tab)

A.22 Playbooks#

ActionWherePermissionFour-eyesGuide section
See playbooks and runsPlaybooksView the review queue-37.2 The Playbooks page
Create a playbook (trigger, steps, Add step, Up/Down/Remove, Dry run)Playbooks > New playbook > Save playbookManage playbooksno (containment steps always need a signature)37.3 Procedure: create a playbook
Change a playbook; switch it on or offPlaybooks > Edit; Enabled tick boxManage playbooksno37.5 Procedure: change, switch off or retire a playbook
Approve a waiting containment step; ask againApprovals; run > Ask againApprove critical actions; Manage playbooksalways37.4 Procedure: a containment step is waiting

A.23 Approvals#

ActionWherePermissionFour-eyesGuide section
See requests (Waiting for me, My requests, History)Approvals--15.6 Approvals
Approve or reject a requestApprovals > Waiting for me > request > Approve / RejectApprove critical actions-15: Procedure: approve or reject (the approver)
Execute an approved requestApprovals > My requests > request > Execute nowThe action's permission-15: Procedure: execute (the requester)
Withdraw your requestApprovals > My requests > request > Withdraw request--15: Procedure: execute (the requester)

A.24 Settings#

ActionWherePermissionFour-eyesGuide section
Read deployment, licence, certificate, role permissionsSettings > PlatformAdministrator role-39.3 Settings > Platform
Activate or replace the licenceSettings > Platform > License > Enter a new licence key > Activate licenceManage the licenceyes (Change the licence)2: Step 2: install the key you receive
Check the certificate againSettings > Platform > Certificate > Check againAdministrator role (server details: Manage settings)no6: In the console
Check for updates; download and verify one (update feed)Settings > Platform > Platform updates > Check for updates, Download and verifyManage platform updatesyes (Stage a platform update)4: Route B: the update feed
Upload an update bundle; discard a staged update; copy the apply commandPlatform updates > Install from a file > Continue upload; Discard itManage platform updatesyes (Stage a platform update)4: Route A: upload a bundle (air-gapped sites)
Download diagnostics for supportPlatform updates > Download diagnosticsManage settingsno7.3 Diagnostics from the console
Decommission every agent (engagement close-out)Settings > Platform > Engagement > Decommission all agents > Remove the agentsDelete agentsyes (Delete an agent)16.8 Removing every agent at the end of an engagement
Re-check the setup stepsSettings > Setup > Re-checkAdministrator roleno39.4 Setup
Choose your notificationsSettings > Notifications > Save changes-no39.6 Settings > Notifications
Create a userSettings > Users > Create userManage usersyes (Change users)15: Procedure: create a user
Change a user's role; disable or re-enable a userSettings > Users > row > SaveManage usersyes (Change users)15: Procedure: change a user's role, or disable or re-enable a user
Grant or deny single permissionsSettings > Users > Adjust > Save permissionsManage usersyes (Change users)15: Procedure: grant or deny single permissions
Reset a user's two-factorSettings > Users > Reset 2FAManage usersyes (Change users)15: Procedure: reset a user's two-factor
Delete a userSettings > Users > DeleteManage usersyes (Change users)15: Procedure: delete a user
Create a custom role (New role, Copy this role)Settings > Access control > Roles > Create roleManage rolesyes (Change roles)15: Procedure: create a custom role
Change or delete a custom roleSettings > Access control > Roles > Save role, Delete roleManage rolesyes (Change roles)15: Procedure: change or delete a custom role
Change the dual-control policySettings > Access control > Dual control > Save policy / Discard changesConfigure dual controlalways15.4 Dual control (four-eyes)
Set up directory sign-in (Test connection, group rules Add rule/Up/Down/Remove, CA Remove, Save changes)Settings > AuthenticationManage usersyes (Change users)14.2 Procedure: set up directory sign-in
Sync directory users; apply held changesSettings > Authentication > Sync now, Apply anywayManage usersyes (Change users) for held changes14.3 Procedure: directory sync
Set up Windows sign-in (keytab, Offer Windows sign-in, RC4, two-factor opt-out)Settings > Authentication > Windows sign-in (Kerberos) > Upload keytab, SaveManage usersyes (Change users)14.4 Procedure: Windows sign-in (Kerberos single sign-on)
Replace or remove the keytab; turn Windows sign-in offWindows sign-in > Replace keytab, Remove keytabManage usersyes to replace; no to remove14: Procedure: replace or remove the keytab, or turn Windows sign-in off
Issue an API key; copy it onceSettings > API keys > New key > Create key > Copy keyManage API keysyes (Change API keys)15: Procedure: issue a key
Revoke an API key; show revoked keysSettings > API keys > Revoke; Show revokedManage API keysyes (Change API keys)15: Procedure: revoke a key
Add a SIEM destination; test itSettings > SIEM forwarding > Add destination > Create destination; TestManage SIEM forwardingpolicy (off by default)39: Procedure: add a destination
Change, pause or delete a SIEM destinationSettings > SIEM forwarding > name; Enabled; binManage SIEM forwardingpolicy (off by default)39: Procedure: change, pause or delete a destination
Read and filter the audit trail; open an eventSettings > Audit trailView the audit trail-15.8 Audit trail
Seed, re-seed or clear sandbox dataSettings > Sandbox > Seed sandbox data / Re-seed sandbox / Clear sandbox dataManage settings + Manage demo datapolicy (off by default)39.9 Settings > Sandbox

A.25 Lifecycle of every object you can create#

For each kind of object an operator can create: where to create, view, change, pause and remove it. Where the console has no such button in this release, the cell says so and links to what to do instead.

ObjectCreateViewChangeDisable or pauseDelete or remove
Agent (host)installHostshost settingsrevoke tokenremove / delete, uninstall
Offline package / enrolment coderequestInstall agent > Offline packageNo edit: make a new onerevokeKept as a record (revoke instead)
Agent releaseimport / registerAgent versionsNo edit: register a new oneunpublishdelete
Deployment credentialaddCredentials tableedit (WinRM)-delete
Kerberos realmaddKerberos realmsedit realms-remove realm
Deployment jobdeployDeploymentsretry a hostcancel what has not startedKept as a record
UsercreateSettings > Usersrole, permissions, two-factorinactivedelete
Custom rolecreateAccess control > Rolessave role-delete role
API keyissueIssued keysNo edit: issue a new onerevokeKept as a record (revoked)
Approval requestBy any critical actionApprovalsNo edit: file a new onewithdrawKept in History
Compliance scanrunscan pageNo editnone; scans time outno delete: kept as the record
Compliance schedulecreateScheduleseditdisabledelete
AttestationrecordAttestationsNo edit: revoke and record againrevokeKept as a record
ExceptionrequestAttestations > exceptionsNo edit: revoke and request againrevokeKept as a record
Report schedulecreateReportsNo edit: create the new one, delete the oldno pause: deletedelete
Generated reportgenerateReports--no delete in the console
Hardening runstart from Fix planHardeningNo editcancel, roll backKept as a record
Recovery artifactissueRecovery / break-glass--Purged after its one download
Evidence bundlecreatedetailsNo edit: create a new one-delete
Network nodeAgents and scansmaprescan-no delete (hidden internet endpoints: remove them)
Firewall deviceconnect / importDevices listNo edit: re-read or re-importstop monitoringno remove: do this instead
Firewall plan / versionmake a planVersionsNo edit: make a new planset another baselineKept as a record
Log sourceaddSourcesNo edit: add a new oneno pause: deletedelete
Saved searchsaveSearch > SavedNo edit: save again-delete
DashboardbuildDashboardsedit / copy-delete
Detection rulecreateRulessave as new versiondisabledelete
Alert suppressionsuppress---lapses at its end; no early removal
DLP policycreatePolicy catalogueedituntick Enableddelete (disable if it has incidents)
DLP discovery schedulecreateScheduled discoveryeditdisabledelete
FIM policycreatePolicieseditdisabledelete
FIM baselinebaseline nowAgents and baselinesaccept changesDisable its policyDeleted with its policy
Forensic caseopencase workspaceNo edit-no close or delete in the console
IOC huntstartIOC huntsNo edit: start a new onecancelKept as a record
Decoy (honeypot)createHoneypotsno edit: replace itundeploydelete
Containment actiondispatchDispatched actions-undoKept as a record
PlaybookcreatePlaybooksedituntick Enabledno delete: switch it off
Asset profilesync from agentsAssetscriticality, environment-no delete in the console
AD domainregisterAD assessment-Stop collectingno remove in the console
SIEM destinationaddSIEM forwardingedituntick Enableddelete
Review item, DLP incident, FIM event, trip, alertBy the modulesReview queuestatus, assign, commentsuppress / accept riskNever deleted by hand: close them
Sandbox dataseedSettings > SandboxRe-seed-clear
LicenceactivateSettings > Platformenter a new key-Replaced by a new key
TLS certificateinstallcheckreplace / repairtls offwithdraw a staged one
Backupbackupbackups/ directory--Delete old dump files by your own retention (5.3)
Installationinstallstatusupdatestopuninstall

A.26 Functions the console does not offer#

The server has a few functions that no console screen calls in this release. They are listed so that nobody looks for a button that does not exist.

FunctionIn the console insteadGuide
Rotate one agent's tokenRevoke the token (Remove agent > Keep the records: revoke its token); the API call is described in 16.516.5
Reveal the recovery keyNo console button; API call, once, by an administrator16.4
Verify an exported evidence fileAPI call with a service-account key27.4
Verify the audit trail's hash chainAPI call by an auditor15.8
Forget a pinned SSH host keyAPI call13.3
Delete a generated reportNone; reports are kept25.3
Edit or pause a report scheduleCreate the new one, delete the old one25.3
Remove a firewall deviceStop monitoring; disable Lawliet's account on the device29.2
Remove an AD domain; schedule AD collection; set an AD finding's statusNone; collect on demand14.5
Archive a DLP policyUntick Enabled32.3
Edit a log source; replace an HTTP shipper's tokenAdd a new source, move the sender, delete the old one30.5
Rename a saved searchSave it again under the new name, delete the old one30.2
Close or delete a forensic caseNone; cases are kept with their chain of custody34.1
Edit a decoyCreate a new decoy, then undeploy and delete the old one35.6
Delete a playbookUntick Enabled37.5
Create or change business processesNone in this release38.1
End an alert suppression earlyNone; it lapses at the end of its period31.3
Set another user's passwordPassword reset link, or delete and re-create the account15.2
Integrate a detected domain (Overview)The button is disabled ("Coming soon"); use AD assessment14.5