Skip to content

Commit

Permalink
Various CCS fixes and improvements (#954)
Browse files Browse the repository at this point in the history
- reassign and style the bootstrap labels.
- fixed dark mode color problems.
- fixed styling of tabbed code blocks, incl. dark mode.
- fixed table styling, incl. dark mode.
- added fonts.
  • Loading branch information
predictiple authored Dec 3, 2024
1 parent 764013d commit d8f076f
Show file tree
Hide file tree
Showing 180 changed files with 338 additions and 400 deletions.
2 changes: 1 addition & 1 deletion content/docs/deployment/clients/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ know exactly what they are.
To repack the MSI with a custom config on the command line we use the `config`
command, and the `repack` subcommand, with the `--msi` flag.

In all cases we need to tell velociraptor which MSI we want to repack (usually
In all cases we need to tell Velociraptor which MSI we want to repack (usually
it's the [official release MSI](/downloads/): either 64-bit or 32-bit) and what
the output file should be named.

Expand Down
5 changes: 2 additions & 3 deletions content/vql_reference/basic/copy/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,8 @@ permissions|Required permissions (e.g. 'x').|string
append|If true we append to the target file otherwise truncate it|bool
create_directories|If true we ensure the destination directories exist|bool

Required Permissions:
<span class="linkcolour label label-success">FILESYSTEM_WRITE</span>
<span class="linkcolour label label-success">FILESYSTEM_READ</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">FILESYSTEM_WRITE</span>
<span class="permission_list linkcolour label label-important">FILESYSTEM_READ</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/basic/environ/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ Arg | Description | Type
----|-------------|-----
var|Extract the var from the environment.|string (required)

Required Permissions:
<span class="linkcolour label label-success">MACHINE_STATE</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">MACHINE_STATE</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/basic/expand/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ Arg | Description | Type
----|-------------|-----
path|A path with environment escapes|string (required)

Required Permissions:
<span class="linkcolour label label-success">MACHINE_STATE</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">MACHINE_STATE</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/basic/getpid/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ no_edit: true
<span class='vql_type label label-warning pull-right page-header'>Function</span>


Required Permissions:
<span class="linkcolour label label-success">MACHINE_STATE</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">MACHINE_STATE</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/basic/killkillkill/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ Arg | Description | Type
----|-------------|-----
client_id||string (required)

Required Permissions:
<span class="linkcolour label label-success">MACHINE_STATE</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">MACHINE_STATE</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/basic/read_file/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ offset|Where to read from the file.|int64
filename|One or more files to open.|OSPath (required)
accessor|An accessor to use.|string

Required Permissions:
<span class="linkcolour label label-success">FILESYSTEM_READ</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">FILESYSTEM_READ</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/basic/tempdir/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ Arg | Description | Type
----|-------------|-----
remove_last|If set we delay removal as much as possible.|bool

Required Permissions:
<span class="linkcolour label label-success">FILESYSTEM_WRITE</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">FILESYSTEM_WRITE</span>

### Description

Expand Down
5 changes: 2 additions & 3 deletions content/vql_reference/basic/unzip/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,8 @@ filename_filter|Only extract members matching this regex filter.|string
output_directory|Where to unzip to|string (required)
type|The type of file (default autodetected from file extension - zip or tgz or tar.gz).|string

Required Permissions:
<span class="linkcolour label label-success">FILESYSTEM_WRITE</span>
<span class="linkcolour label label-success">FILESYSTEM_READ</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">FILESYSTEM_WRITE</span>
<span class="permission_list linkcolour label label-important">FILESYSTEM_READ</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/basic/upload_sftp/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ privatekey|The private key to use|string (required)
endpoint|The Endpoint to use including port number (e.g. 192.168.1.1:22 )|string (required)
hostkey|Host key to verify. Blank to disable|string

Required Permissions:
<span class="linkcolour label label-success">FILESYSTEM_READ</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">FILESYSTEM_READ</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/basic/upload_webdav/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ noverifycert|Skip TLS Verification (deprecated in favor of SkipVerify)|bool
skip_verify|Skip TLS Verification|bool
user_agent|If specified, set a HTTP User-Agent.|string

Required Permissions:
<span class="linkcolour label label-success">FILESYSTEM_READ</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">FILESYSTEM_READ</span>

### Description

Expand Down
5 changes: 2 additions & 3 deletions content/vql_reference/event/send_event/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,8 @@ Arg | Description | Type
artifact|The artifact name to send the event to.|string (required)
row|The row to send to the artifact|ordereddict.Dict (required)

Required Permissions:
<span class="linkcolour label label-success">SERVER_ADMIN</span>
<span class="linkcolour label label-success">PUBLISH</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">SERVER_ADMIN</span>
<span class="permission_list linkcolour label label-important">PUBLISH</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/event/watch_csv/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ separator|Comma separator (default ',')|string
comment|The single character that should be considered a comment|string
columns|The columns to use|list of string

Required Permissions:
<span class="linkcolour label label-success">FILESYSTEM_READ</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">FILESYSTEM_READ</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/event/watch_evtx/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ accessor|The accessor to use.|string
messagedb|A Message database from https://github.com/Velocidex/evtx-data.|string
workers|If specified we use this many workers to parse the file in parallel (default 1).|int64

Required Permissions:
<span class="linkcolour label label-success">FILESYSTEM_READ</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">FILESYSTEM_READ</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/event/watch_monitoring/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ Arg | Description | Type
----|-------------|-----
artifact|The artifact to watch|string (required)

Required Permissions:
<span class="linkcolour label label-success">READ_RESULTS</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">READ_RESULTS</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/event/watch_syslog/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ filename|A list of log files to parse.|list of OSPath (required)
accessor|The accessor to use.|string
buffer_size|Maximum size of line buffer.|int

Required Permissions:
<span class="linkcolour label label-success">FILESYSTEM_READ</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">FILESYSTEM_READ</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/event/wmi_events/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ query|WMI query to run.|string (required)
namespace|WMI namespace|string (required)
wait|Wait this many seconds for events and then quit.|int64 (required)

Required Permissions:
<span class="linkcolour label label-success">MACHINE_STATE</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">MACHINE_STATE</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/linux/audit/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ no_edit: true
<span class='vql_type label label-warning pull-right page-header'>Plugin</span>


Required Permissions:
<span class="linkcolour label label-success">MACHINE_STATE</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">MACHINE_STATE</span>

### Description

Expand Down
5 changes: 2 additions & 3 deletions content/vql_reference/misc/artifact_set_metadata/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,8 @@ name|The Artifact to update|string (required)
hidden|Set to true make the artifact hidden in the GUI, false to make it visible again.|bool
basic|Set to true make the artifact a 'basic' artifact. This allows users with the COLLECT_BASIC permission able to collect it.|bool

Required Permissions:
<span class="linkcolour label label-success">ARTIFACT_WRITER</span>
<span class="linkcolour label label-success">SERVER_ARTIFACT_WRITER</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">ARTIFACT_WRITER</span>
<span class="permission_list linkcolour label label-important">SERVER_ARTIFACT_WRITER</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/carve_usn/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ accessor|The accessor to use.|string
mft_filename|A path to a raw $MFT file to use for path resolution.|OSPath
usn_filename|A path to a raw USN file to carve. If not provided we carve the image file or the device.|OSPath

Required Permissions:
<span class="linkcolour label label-success">FILESYSTEM_READ</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">FILESYSTEM_READ</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/client_create/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ hostname|The hostname of the system|string
client_id|if set we use this client id otherwise we make a new one|string
mac_addresses||list of string

Required Permissions:
<span class="linkcolour label label-success">SERVER_ADMIN</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">SERVER_ADMIN</span>

### Description

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ Arg | Description | Type
notebook_id|Notebook ID to export.|string (required)
filename|The name of the export. If not set this will be named according to the notebook id and timestamp|string

Required Permissions:
<span class="linkcolour label label-success">PREPARE_RESULTS</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">PREPARE_RESULTS</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/delete_events/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ start_time|Start time to be deleted|time.Time
end_time|End time to be deleted|time.Time
really_do_it|If not specified, just show what files will be removed|bool

Required Permissions:
<span class="linkcolour label label-success">DELETE_RESULTS</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">DELETE_RESULTS</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/delete_flow/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ flow_id||string (required)
client_id||string (required)
really_do_it||bool

Required Permissions:
<span class="linkcolour label label-success">DELETE_RESULTS</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">DELETE_RESULTS</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/efivariables/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ namespace|Variable namespace.|string
name|Variable name|string
value|Read variable value|bool

Required Permissions:
<span class="linkcolour label label-success">MACHINE_STATE</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">MACHINE_STATE</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/etw_sessions/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ Arg | Description | Type
----|-------------|-----
count|The count of sessions to retrieve (default 64) |uint64

Required Permissions:
<span class="linkcolour label label-success">MACHINE_STATE</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">MACHINE_STATE</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/flow_logs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ Arg | Description | Type
flow_id|The flow id to read.|string (required)
client_id|The client id to extract|string (required)

Required Permissions:
<span class="linkcolour label label-success">READ_RESULTS</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">READ_RESULTS</span>

### Description

Expand Down
5 changes: 2 additions & 3 deletions content/vql_reference/misc/get_flow/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,8 @@ Arg | Description | Type
client_id||string (required)
flow_id||string

Required Permissions:
<span class="linkcolour label label-success">COLLECT_CLIENT</span>
<span class="linkcolour label label-success">COLLECT_SERVER</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">COLLECT_CLIENT</span>
<span class="permission_list linkcolour label label-important">COLLECT_SERVER</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/host/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ server|A DNS server to query - if not provided uses the system resolver.|string
type|Type of lookup, can be CNAME, NS, SOA, TXT, DNSKEY, AXFR, A (default)|string
prefer_go|Prefer calling the native Go implementation rather than the system.|bool

Required Permissions:
<span class="linkcolour label label-success">MACHINE_STATE</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">MACHINE_STATE</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/hunt_delete/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ Arg | Description | Type
hunt_id||string (required)
really_do_it||bool

Required Permissions:
<span class="linkcolour label label-success">SERVER_ADMIN</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">SERVER_ADMIN</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/hunt_info/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ Arg | Description | Type
----|-------------|-----
hunt_id|Hunt Id to look up or a flow id created by that hunt (e.g. F.CRUU3KIE5D73G.H ).|string

Required Permissions:
<span class="linkcolour label label-success">READ_RESULTS</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">READ_RESULTS</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/hunt_update/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ expires|Update hunt expiry|time.Time
add_labels|Labels to be added to hunt|list of string
del_labels|Labels to be removed from hunt|list of string

Required Permissions:
<span class="linkcolour label label-success">START_HUNT</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">START_HUNT</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/leveldb/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ Arg | Description | Type
file|The path to the leveldb file.|OSPath
accessor|The accessor to use.|string

Required Permissions:
<span class="linkcolour label label-success">FILESYSTEM_READ</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">FILESYSTEM_READ</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/logging/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ Arg | Description | Type
----|-------------|-----
component||string

Required Permissions:
<span class="linkcolour label label-success">READ_RESULTS</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">READ_RESULTS</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/logscale_upload/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ tag_fields|Name of fields to be used as tags. Fields can be renamed using =<newn
stats_interval|Interval, in seconds, to post statistics to the log (default: 600, 0 to disable)|int
debug|Enable verbose logging.|bool

Required Permissions:
<span class="linkcolour label label-success">COLLECT_SERVER</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">COLLECT_SERVER</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/mail/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ auth_password|The SMTP username password we use to authenticate to the server.|s
skip_verify|Skip SSL verification(default: False).|bool
root_ca|As a better alternative to disable_ssl_security, allows root ca certs to be added here.|string

Required Permissions:
<span class="linkcolour label label-success">SERVER_ADMIN</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">SERVER_ADMIN</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/monitoring_logs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ source|An optional named source within the artifact|string
start_time|Start return events from this date (for event sources)|Any
end_time|Stop end events reach this time (event sources).|Any

Required Permissions:
<span class="linkcolour label label-success">READ_RESULTS</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">READ_RESULTS</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/notebook_create/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ public|If set the notebook will be public.|bool
artifacts|A list of NOTEBOOK artifacts to create the notebook with (Notebooks.Default)|list of string
env|An environment to initialize the notebook with|ordereddict.Dict

Required Permissions:
<span class="linkcolour label label-success">COLLECT_SERVER</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">COLLECT_SERVER</span>

### Description

Expand Down
3 changes: 1 addition & 2 deletions content/vql_reference/misc/notebook_export/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ notebook_id|The id of the notebook to export|string (required)
filename|The name of the export. If not set this will be named according to the notebook id and timestamp|string
type|Set the type of the export (html or zip).|string

Required Permissions:
<span class="linkcolour label label-success">PREPARE_RESULTS</span>
<span class="permission_list vql_type">Required permissions:</span><span class="permission_list linkcolour label label-important">PREPARE_RESULTS</span>

### Description

Expand Down
Loading

0 comments on commit d8f076f

Please sign in to comment.