Interactive shell event detection
11720669 · 2023-08-08
Assignee
Inventors
Cpc classification
G06F11/3093
PHYSICS
International classification
Abstract
Telemetry associated with an Exec( ) Event denoting that a program has been invoked via a process is received. A determination is made that the process is a shell. Subsequent to determining that the invoked program is a shell, additional information comprising information that the program has attempted to obtain terminal information is received. Based at least in part on the received additional information, a determination is made that the program is an interactive shell. An action is taken in response to the determination that the program is an interactive shell.
Claims
1. A system, comprising: a first processor; and a memory coupled to the first processor, the memory storing instructions that configure the first processor to: receive telemetry denoting that a program has been invoked on a node via a process; determine that the invoked program is a shell based at least on a program path and name information associated with the process; subsequent to determining that the invoked program is a shell, receive additional information including timing information associated with commands entered into the shell; based at least in part on the received additional information, determine that the program is an interactive shell interactively operated by a user; in response to determining that the program is an interactive shell, configure the node to tag one or more commands entered into the interactive shell for storage and query with a tag identifying the one or more commands as interactive shell commands associated with the program; and manage a security policy for the node based on the tagged interactive shell commands.
2. The system of claim 1 wherein the first processor is further configured to insert data associated with the process into a process tree.
3. The system of claim 2 wherein the data includes the current state of the program executing.
4. The system of claim 1 wherein determining that the program is a shell includes determining if the program is descendent of another program.
5. The system of claim 4 wherein determining that the program is a shell includes matching a program path against a list of known shell programs.
6. The system of claim 1 wherein, in response to determining that that program is a shell, a shell tag is associated with the process in a process tree.
7. The system of claim 1 wherein the additional information comprises a system input/output control event.
8. The system of claim 1 wherein the additional information is obtained using a programmatic filter that collects process data.
9. The system of claim 1 wherein the additional information is obtained through kernel subsystem data collection.
10. The system of claim 1 wherein the additional information comprises a keystroke timing of a command.
11. The system of claim 1 wherein the first processor is further configured to propagate a tag associated with the process on at least one of an invocation of the process or an invocation of a child process.
12. The system of claim 1 wherein the first processor is configured to generate an alert in response to determining that the program is an interactive shell.
13. The system of claim 1 wherein the first processor is further configured to determine a command being executed in the interactive shell.
14. The system of claim 1 further comprising a second processor configured by computer executable code to display the interactive shell commands for the node in real time based on the one or more tags.
15. The system of claim 1 further comprising a second processor configured by computer executable code to query the interactive shell commands based on the one or more tags.
16. The system of claim 1 wherein the memory stores instructions that configure the first processor to analyze keystroke timing of commands entered into the interactive shell.
17. The system of claim 1 wherein the memory stores instructions that configure the first processor to tag the interactive shell with a tag that stores state information related to the interactive shell.
18. The system of claim 17, wherein the tag includes propagation logic permitting subsequent interactive shells descending from the interactive shell based on one or more predetermined process events.
19. A method, comprising: receiving telemetry denoting that a program has been invoked on a node via a process; determining that the invoked program is a shell based at least on a program path and name information associated with the process; subsequent to determining that the invoked program is a shell, receiving additional information including timing information associated with commands entered into the shell; based at least in part on the received additional information, determining that the program is an interactive shell interactively operated by a user; in response to determining that the program is an interactive shell, configuring the node to tag one or more commands entered into the interactive shell for storage and query with a tag identifying the one or more commands as interactive shell commands associated with the program; and managing a security policy for the node based on the tagged interactive shell commands.
20. A computer program product embodied in a non-transitory computer readable storage medium and comprising computer instructions executable on one or more computing devices to perform the steps of for: receiving telemetry denoting that a program has been invoked on a node via a process; determining that the invoked program is a shell based at least on a program path and name information associated with the process; subsequent to determining that the invoked program is a shell, receiving additional information including timing information associated with commands entered into the shell; based at least in part on the received additional information, determining that the program is an interactive shell interactively operated by a user; in response to determining that the program is an interactive shell, configuring the node to tag one or more commands entered into the interactive shell for storage and query with a tag identifying the one or more commands as interactive shell commands associated with the program; and managing a security policy for the node based on the tagged interactive shell commands.
Description
BRIEF DESCRIPTION OF THE DRAWINGS
(1) Various embodiments of the invention are disclosed in the following detailed description and the accompanying drawings.
(2)
(3)
(4)
(5)
(6)
(7)
(8)
(9)
(10)
(11)
(12)
(13)
(14)
(15)
(16)
(17)
(18)
(19)
(20)
(21)
(22)
(23)
(24)
(25)
(26)
(27)
(28)
(29)
(30)
(31)
(32)
(33)
(34)
(35)
(36)
(37)
(38)
(39)
(40)
(41)
(42)
DETAILED DESCRIPTION
(43) The invention can be implemented in numerous ways, including as a process; an apparatus; a system; a composition of matter; a computer program product embodied on a computer readable storage medium; and/or a processor, such as a processor configured to execute instructions stored on and/or provided by a memory coupled to the processor. In this specification, these implementations, or any other form that the invention may take, may be referred to as techniques. In general, the order of the steps of disclosed processes may be altered within the scope of the invention. Unless stated otherwise, a component such as a processor or a memory described as being configured to perform a task may be implemented as a general component that is temporarily configured to perform the task at a given time or a specific component that is manufactured to perform the task. As used herein, the term ‘processor’ refers to one or more devices, circuits, and/or processing cores configured to process data, such as computer program instructions.
(44) A detailed description of one or more embodiments of the invention is provided below along with accompanying figures that illustrate the principles of the invention. The invention is described in connection with such embodiments, but the invention is not limited to any embodiment. The scope of the invention is limited only by the claims and the invention encompasses numerous alternatives, modifications and equivalents. Numerous specific details are set forth in the following description in order to provide a thorough understanding of the invention. These details are provided for the purpose of example and the invention may be practiced according to the claims without some or all of these specific details. For the purpose of clarity, technical material that is known in the technical fields related to the invention has not been described in detail so that the invention is not unnecessarily obscured.
I. Introduction and Architecture Overview
(45)
(46) Environment 101 includes a set of workload instances 102-104 hosted by a third party (e.g., cloud) provider. Example providers of such cloud-based infrastructure include Amazon (e.g., as Amazon Web Services), Google (e.g., as Google Cloud), and Microsoft (e.g., as Microsoft Azure). Environment 101 also includes a set of legacy computing systems 106-108 (e.g., a legacy database server, a legacy web server, etc. executing on hardware owned by ACME). Factors such as regulatory, performance, and cost considerations will impact how various embodiments of techniques described herein are deployed in various environments. The techniques described herein can also be used in other types of environments (e.g., purely self-hosted, purely third-party hosted, containerized, etc.).
(47) Each of systems 102-108 has an associated sensor/analytics component (e.g., Sensor 112)—one per kernel. An example way of implementing Sensor 112 is using Go. The Sensor is configured to employ a variety of techniques to capture telemetry data. The analytics component can be collocated with the Sensor and can also be located remotely (e.g., on a different node). Telemetry and other data (e.g., as collected by the Sensor) are analyzed to generate events. Events (and combinations of events, as applicable) that match a Strategy pattern can be used to trigger real-time alerts and take other actions as applicable, such as strategically and automatically killing attacker connections and restarting workloads.
(48) Further, analytics can also be optionally performed cluster wide (i.e., across multiple workload instances/servers) by using an optional security server 110 configured to harvest alerts and perform analytics on information received from each of systems 102-108. One example of a cross-node Strategy is a segfault, where, e.g., Apache is seen to crash five times. In a modern environment, e.g., with load balancers, connections may come in and Apache may crash in a variety of different locations. Attackers may intentionally try to spread out an attack across multiple nodes, hoping to hide among the occasional segfaults that happen in a production environment (and are sophisticated enough to avoid trying to segfault a single node 50 times). With a cross node strategy, Alerts can be accumulated until, e.g., a triggering threshold is reached (e.g., more than five crashes in an hour indicates the cluster is under attack). In this example, a local (to a single node) segfault strategy could be used to emit segfault events, and the cross node strategy could consume those events and generate its own (e.g., as thresholds are met), applying Tags to hosts indicating number of segfaults reported, etc. Other cross node strategies can also be used, e.g., with individual nodes providing information to security server 110, and security server 110 including Strategies that leverage the alerts produced by multiple nodes. A second example of a cross node strategy is a lateral movement strategy (e.g., where a report of compromise associated with a first node and a connection reported from a second internal node), can be matched to indicate that the compromised node is communicating with a different node.
(49) Server 110 also can perform other tasks, such as providing an administrative console/dashboard, deploying configuration, etc. An example dashboard is shown in
(50) Sensors 102-108 and optional Security Server 110 are collectively referred to herein as a Platform. In various embodiments, the Platform comprises middleware using go-micro and is built in a moonrepo structure that simplifies deployment and optimizes infrastructure to support automation (including integration testing and load/performance testing). An example representation of a Platform (100) is shown in
(51)
(52) An illustration of various logical roles provided by Platform 100 are shown in
(53) One way of implementing backend services 162 is as microservices defined using go-micro. A generic example of a go-micro microservice is illustrated in
(54) In various embodiments, go-micro RPCs with selectors (relying on metadata) are used for individually calling RPCs on services and groups of services. Services that are configurable provide a Config method that takes their configuration as an argument and returns a response with a status code and any errors. Multiple components can be accomplished using go-micro selectors (e.g., selector 166) to direct queries to multiple components. An example of a configuration that can be made is, “cause these four Responders to ignore remote interactive shell alerts.” Group commands can be sent using subscriptions to topics. A telemetry subscription example is “cause all sensors attached to this API server to start publishing data related to this subscription.” In various embodiments, a reserved namespace (e.g., capsule8.*) is used for topics. Four example topics include: capsule8.<service>.commands: asynchronous commands that a service takes (e.g., capsule8.sensors.commands) capsule8.alerts: all Alerts are published here capsule8.alerts.responses: all Alert responses are published here capsule8.events: all status and error notifications are published here.
(55)
(56)
II. Sensors
(57) In the following discussion, suppose Alice is a computer administrator of infrastructure 100 or portions thereof (e.g., in a security operations role). One way that Alice can deploy a Sensor (e.g., Sensor 112) to a node (e.g., workload instance 102) is by obtaining a package (e.g., a statically compiled binary) and installing it using whatever manner is appropriate to the existing deployment management infrastructure used by environment 100 (e.g., using “rpm -i”). The installer for Sensor 112 does not modify the kernel of workload instance 102 (i.e., Sensor 112 is deployed in userland) and places configuration/binary files in an appropriate location, such as /etc/capsule8 (for configuration files), /var/lib/capsule8 (for library files), and /user/local/bin (for binary files). Capabilities such as CAP_SYS_ADMIN and CAP_DAC_OVERRIDE are used (without root) to set kernel probes. As applicable, Sensor 112 can also be deployed as a container.
(58) A. Initialization
(59) Sensor 112 will be started at boot time and loads an appropriate configuration. If a Sensor is deployed in a container environment, it can be run as a daemon set. An example way that Sensor 112 can initialize itself is in accordance with the process shown in
(60) 1. Common Steps
(61) a. Creating the Logger and Config
(62) After initial execution (202), a logger object is created (204). One example way to implement the logger is using a logrus instance. An optional local configuration is read (206), and if valid (208), a configuration object is created to store the configuration.
(63) b. Determining Metadata
(64) The Sensor then enumerates its environment and configuration for metadata (210). This metadata is later fed to the go-micro service and/or embedded analytics instance described in more detail below. Examples of metadata that can be collected include: Cloud metadata such as AZ and region the Sensor is running in, The container runtime that the Sensor is running in, if any, Reading files from the file system to determine OS, OS Version, Host networking interfaces, Underlying node hostname, and Kernel version.
(65) Additionally, these properties can be defined as a set of key value pairs via the configuration or CAPSULE8_LABELS environment variable. Additional information on Environmental Variables is provided below. These properties are then stored internally in a go map of type map[string]string in which a normalized key value stores the value (e.g., CAPSULE8_SENSOR_ID) to store the Sensor ID.
(66) c. Go-Micro Service Initialization and Command Arg Processing
(67) The next major step is the configuration of the go-micro Service options. This can include NATS options and other PubSub options, as applicable, used by go-micro's Broker, Transport and Service Registry. This can be abstracted away using the micro_options package to facilitate using other PubSub or other go-micro supported transport protocols, such as consul or Google PubSub.
(68) A go-micro Service instance is initialized with the metadata (214) and the command line options are parsed (216), e.g., using go-micro's Flag module. In embodiments where the Sensor-Core is using glog, go-micro's command line processing is used to set go's flag packages options. The config can also be checked to see if an OpenTracing tracer should be created, and if so (212) added to the service so that it may be used for debugging. At this point, command line arguments are parsed using the go-micro Services' Init method.
(69) d. Sensor-Core Initialization & Unix Socket API
(70) After creating the service and parsing the command line options, the Sensor-Core is initialized (218). The Sensor-Core instance instruments the kernel, and provides telemetry. This is started with an ID that is shared with the go-micro service. Additionally the Sensor's API server is started on a Unix socket at /var/run/capsule8/sensor.sock. This server handles the API presented by the Open Source Sensor.
(71) After initializing the Sensor-core the Sensor checks its configuration to see if it is configured to run with a security server (e.g., security server 110) (220). In various embodiments, this step is replaced by one that does instrumentation initialization based on the metadata values enumerated earlier.
(72) 2. Running without the Server
(73) By default Sensor 112 does not attempt to connect to server 110. If the config option in use_analytics is set to true in /etc/capsule8/capsule8-sensor.yaml or the environment variable CAPSULE8_USE_ANALYTICS=true (222), then the embedded analytics is started (224). Otherwise, initialization is complete (226).
(74) a. Initializing Analytics
(75) If the embedded Analytics was enabled via configuration, the function startEmbeddedProtect is called. This function first reads the Analytics configuration file /etc/capsule8/capsule8-analytics.yaml (228). If it encounters an error parsing the file the error is returned and it is treated as a fatal error.
(76) After parsing the Analytics config, a standalone in a Sensor Analytics CommsClient instance is created, with a reference to the Sensor-Core instance, and the Analytics varz handler. The CommsClient is responsible for connecting the embedded Analytics to the Sensor and ensuring that Alerts and MetaEvents are emitted somewhere that they can be retrieved or published on the backend. Alerts are a special kind of Event created from one or more Events that entities may wish to receive notifications of. MetaEvents are Events of interest that are published back to the platform via the API. The CommsClient's constructor takes an argument for a NATS client in the event that this function was called with the server option (248). In that case the CommsClient would use that to publish the Alerts and MetaEvents to server 110.
(77) Upon successful creation of the CommsClient, an instance of the Analytics Gateway 404 is created with a reference to the CommsClient and the Analytics config. The Gateway is responsible for creating and configuring Strategies used by the embedded Analytics. It provides an internal API for Strategies and also acts as an intermediary with a Platform API and Arbiter (e.g., Arbiter 408). In the event that the Gateway failed to be created an error is returned by the function and treated as a fatal error.
(78) After the Gateway is created, its Run method is called to start the Analytics instance. An example way to do this is as a go routine with a recover so that any unexpected panics do not crash the whole Sensor. Instead, such errors will merely cancel the subscription of events used by the Analytics at which point it will be restarted, and resubscribe in the new instance, as all previous state will have been lost. These errors are logged to stderr.
(79) After starting the Analytics instance (232), the monitoring server is started and the Sensor waits for a SIGINT, or a SIGTERM to signal shutdown. At this point initialization without the server is finished (226).
(80) b. Starting the Monitoring Server
(81) The Sensor runs an embedded webserver to serve version (/version), healthcheck (/healthz), and metrics information (/varz). This server is started (230, 242) on a port specified by the monitor_port config option in /etc/capsule8/capsule8-sensor.yaml or the environment variable CAPSULE8_MONITOR_PORT.
(82) If the Sensor was configured to run with a server, then the/healthz endpoint reports on its connected status returning a 200 HTTP status code if it is successfully connected to the Capsule8-Server or 500 otherwise.
(83) If the Sensor was configured to run without the server this returns a 200 status code as its health is essentially represented by whether or not the process is running.
(84) The/varz endpoint contains memory allocation statistics and other metrics specific to the Analytics. If the Sensor was configured to run without the embedded Analytics then these metrics will be blank.
(85) 3. Running with the Server
(86) The following section describes how the Sensor is initialized if it was configured to run with the server after the common initialization steps (202-220). Two ways to connect the Sensor (e.g., Sensor 112) to the Security Server (e.g., Security Server 110) are to set either the config option run without server or the environment variable CAPSULE8_RUN_WITHOUT_SERVER to the string true.
(87) a. Connecting to the Server Backend
(88) If the Sensor is configured to run with the server after completing the common initialization steps, it then creates an embedded NATS client (248). This is a wrapper around the official NATS golang client library that reads in the configuration object and updates the settings accordingly, for things like TLS certificates.
(89) The constructor for the embedded_nats client immediately attempts to connect to the Server specified by the nats.url config option (also ‘CAPSULE8NATS_SERVER’ env var) and returns an error if it is unable to connect. The Sensor by default attempts to connect three times to the specified Server, waiting 10 seconds in between attempts. If the Sensor is unable to connect to its Server, then this is considered a fatal error and the Sensor exits, logging that it could not connect (234). If the connection to the NATS server was successful then the embedded Analytics is started (238), if configured to do so (236).
(90) b. Starting the Handler and the Watchdog
(91) A request handler is created that contains all of the logic for handling telemetry API subscriptions from the Server (240). This provides the session handling and Telemetry serialization and bundling logic and tracks subscriptions. This is then passed to a WatchDog instance which supervises these subscriptions and any errors they may produce, logging the errors. The WatchDog contains one method and a reference to the Sensor-Core instance. This is used primarily to connect go-micro events on the topic capsule8.sensor.commands to the request handler which starts the subscriptions via the Sensor-Core instance tracking their subscriptions in the specified session. After the WatchDog is created, it is then registered to listen to the capsule8.sensor.commands topic (244).
(92) c. Starting the go-Micro Service
(93) The go-micro service (capsule8.sensor service) is then started when the .Run( ) method is called and executed until an error is encountered. This should not happen unless actively terminated. The Sensor is now started (246).
(94) B. Environmental Variables
(95) This section describes example environment variables and configuration file values used by embodiments of sensor 112. By default, the Sensor looks in /etc/capsule8 for a capsule8-sensor.yaml file, an example of which is shown in
(96) nats:
(97) url: nats://localhost:4222
(98) is written as nats.url.
(99) Various example environmental variables and default values used by a Sensor (e.g., Sensor 112) are as follows:
(100) TABLE-US-00001 Configuration Variable Name File Value Type Meaning Default Example CAPSULE8_ N/A string Alternate /etc/capsule8/ca CAPSULE8_ CONFIG location and psule8- CONFIG = /var/run/ name of the sensor.yaml myconfig.yaml capsule8- sensor.yaml file CAPSULE8_ service.labels string a string of key ″″ CAPSULE8_ LABELS value pairs LABELS = separated by = ″mtahost = true″ metadata about the sensor host CAPSULE8_ debug boolean whether or not false CAPSULE8_ DEBUG to enable DEBUG = true debugging/ profiling features and logging CAPSULE8NAT nats.url string The address of nats://localhost: SURL the Capsule8 4222 Server's NATS instance CAPSULE8NATSMAX_ nats.max_ integer number of times 10000 CAPSULE8NATSMAX_ RECONNECTS reconnects the client should RECONNECTS = 3 attempt to reconnect after it's already been connected CAPSULE8NAT nats.reconnectbu integer amount of data 10 CAPSULE8NAT SRECONNECT fsizeinmb to buffer in the SRECONNECT BUFSIZEINMB event of a BUFSIZEINMB = 1 disconnection in megabytes CAPSULE8NAT nats.reconnect_ integer number of 10 CAPSULE8NAT SRECONNECT_ wait seconds the SRECONNECT_ WAIT NATS client WAIT = 3 should wait between connection attempts CAPSULE8NAT nats.clientcertfile string path to A TLS client ″″ CAPSULE8NAT SCLIENTCERT x509 certificate certificate to SCLIENTCERT FILE present to the FILE = /home/ Capsule8 Server user/client.crt NATS instance (must be used with CAPSULE8NAT SCLIENTCERT KEY_FILE) CAPSULE8NAT nats.clientcertkey_ string path to The path to the ″″ CAPSULE8NAT SCLIENTCERT file x509 certificate key for the SCLIENTCERT KEY_FILE key certificate in KEY_FILE = /home/ CAPSULE8NAT user/client.crt SCLIENTCERT FILE (must be used with CAPSULE8NAT SCLIENTCERT FILE) CAPSULE8NAT nats.clientcacert string path to An additional ″″ CAPSULE8NAT SCLIENTCACE x509 CA TLSCA SCLIENTCACE RT certificate certificate to use RT = /usr/local/cas/ to verify the myCA.crt client. By default the system CAs are used CAPSULESINI initialreconnecta integer the number of 3 CAPSULESINI TIALRECONNECT_ ttempts times the sensor TIALRECONNE ATTEMPTS attempts to CT_ATTEMPTS = 8 connect to the server before giving up at startup CAPSULE8MO monitor_port integer TCP port to 9010 CAPSULE8MO NITORPORT serve health NITORPORT = 9999 checks, version, varz and profiling endpoints CAPSULE8LIS listen_addr string socket address unix://var/run/ca CAPSULE8LIS TENADDR for the sensor psule8/sensor.sock TENADDR = telemetry localhost:8443 service to listen on (can be a unix socket) CAPSULE8EVE bundler.eventsp integer number of 1 CAPSULE8EVE NTSPER_MESSAGE ermessage telemetry events NTSPER_MESSAGE = to send to the 250 server at a time, useful for microbatching/ controlling network impact of the sensor CAPSULE8EVE bundler.flush_ duration string maximum ″100 ms″ CAPSULE8EVE NTSFLUSH_ timeout amount of time NTSFLUSH_ TIMEOUT Telemetry TIMEOUT = ″250 ms″ Events can stay buffered in the sensor before being sent to the Capsule8 Server CAPSULE8OP opentracing.tracer_ string a supported ″″ CAPSULE80P ENTRACINGTR type open tracing ENTRACINGTRACER_ ACER_TYPE implementation TYPE = jaeger right now only jaeger is supported CAPSULE8OP opentracing.tracer_ boolean log opentracing false CAPSULE8OP ENTRACINGTR log information to ENTRACINGTRACER_ ACER_LOG standard out LOG = true CAPSULE8USE use_analytics boolean activate true CAPSULE8USE ANALYTICS embedded ANALYTICS = false analytics package (activate’s further configuration for analytics) CAPSULE8TRI trigger_on boolean enable the event true CAPSULE8TRI GGERON trigger GGERON = false CAPSULE8TRI trigger_interval time.Duration set the event 10 s CAPSULE8TRI GGERINTERVAL trigger interval GGERINTERVAL = 1 s CAPSULE8TRI trigger_syscall enum string set the event ″setxattr″ CAPSULE8TRI GGERSYSCALL trigger syscall GGERSYSCALL = setxattr
(101) C. Hard Resource Limits
(102) As applicable, Sensor 112 can be configured to stay under CPU/RAM/other resource thresholds. A hard stop can be used (e.g., at a certain amount of CPU or RAM usage) at which point throttling/dropping of data can be performed so that performance of the node being monitored is not adversely impacted. This section describes the design, implementation, and usage of the Sensor's hard resource limiting capabilities. One example way to enforce such limitations is by using Linux cgroups under the CPU and Memory subsystems. The cgroup the Sensor uses is called capsule8-sensor. The implementation uses a supervisor process which executes and monitors the actual sensor. This accomplishes multiple desired behaviors. First, this forces all routines of the Sensor process to reside in the cgroups. Since the supervisor process must be done as the root user, this design also allows for dropping privileges of the Sensor by executing the child process as a separate user. It also allows the supervisor process to restart the child sensor process when it exits and to monitor the sensor process for performance and violations.
(103) 1. Usage
(104) The resource configurations are read in from the sensor's configuration file. This is by default at/etc/capsule8/capsule8-sensor.yaml. The path can be changed using the configuration file with the CAPSULE8_CONFIG environment variable. The following section describes the hard resource limit configuration fields.
(105) a. Configuration
(106) The following are fields that can and should be set in the Sensor configuration file. They are also bound to environment variables. use_supervisor—A Boolean value specifying whether or not to use the supervisor, and therefore the hard resource limits. Environment Variable: CAPSULE8_USE_SUPERVISOR Example: true, false Default: false use_resource_limits—A Boolean value specifying whether or not to use the hard resource limiter functionality of the supervisor. Environment Variable: CAPSULE8_USE_RESOURCE_LIMITS Example: true, false Default: false memory limit—The exact amount of memory that the Sensor process is allowed to consume. This is a string ending in G (gigabyte) or M (megabyte). A special value of “0” indicates no limit. Environment Variable: CAPSULE8_MEMORY_LIMIT Example: 512M, 1G, 0 Default: 256M cpu_limit—The percentage of total CPU time that the Sensor will be allowed to be scheduled for. This is a float value with no suffix. A special value of 0 indicates no limit. Environment Variable: CAPSULE8_CPU_LIMIT Example: 10.0, 15, 20.5, 0 Default: 10.0 sensor user—The user that the Sensor process will run as. This is a string of the user name. Environment Variable: CAPSULE8_SENSOR_USER Example: myuser, root, grant Default: capsule8 log_cgroup_metrics— A Boolean value specifying whether or not to log cgroup metrics to stderr. This is on two minute intervals. Environment Variable: CAPSULE8_LOG_CGROUP_METRICS Example: true, false Default: false
(107) b. Verification
(108) One way to determine that the cgroup configuration is properly working is by using the “top” utility. When running, the memory and CPU usage of the Sensor process should be shown in the form of percentages of total resources. For CPU, the Sensor should never go above the configured CPU limit multiplied by the amount of cores on the machine (the shell utility nproc will print number of cores). For memory the percentage of the machine's total memory can be calculated, which is displayed in top in KiB by default.
(109) 2. Violations and Monitoring
(110) The cgroups for memory and CPU handle violations differently. When the sensor process runs out of memory it will be killed by the kernel and restarted by the supervisor process. The CPU cgroup uses a concept of periods and quotas. The period is a configured amount of time and the quota refers to a number of microseconds per period. The Sensor uses a period of one second and the quota is based on the configured percentage. When the Sensor process has used up its quota of CPU time it will be throttled, meaning it will not be scheduled on the CPU until the end of the period. Both of these will have effects on the Sensor's coverage of telemetry events. The cgroup exposes statistics about CPU throttling which are then exposed by the supervisor process via logs to stderr. This can be turned on via the log_cgroup_metrics configuration option.
(111) 3. Restarts
(112) When the Sensor child process exits for cgroup violations, or otherwise, the supervisor process will restart it. This event is logged to stderr.
(113) D. Analytics Framework
(114)
(115) CommsClient 402 contains logic for retrieving telemetry subscriptions and for publishing Alerts and Events of interest. It interfaces with an API server or other mechanism configured to generate Events. It gathers external data that a Factory can translate into/produce Events for consumption by other components of Framework 400 (and/or components of Platform 100, as applicable). One way of implementing CommsClient 402 is as a callback paradigm, to allow Gateway 404 to register callbacks for when Events are received on different topics. CommsClient 402 is also responsible for discovering the API server, which it does via configuration 406. Config 406 is a configuration package that provides a configuration registry built (in an example embodiment) on top of the Go configuration tool, Viper. Strategies or other components register their configuration within a section of a configuration instance from the configuration package.
(116) Gateway 404 is used to initiate each of the components of the framework and their respective configurations. It is at this initiation time that each component registers its default configuration values with the Config instance. After initialization is complete, Gateway 404 collects all of the Event types needed by each of the Strategies and components and creates a subscription with Platform 100 via CommsClient 402. It is then used to route Events from the Comms instance to each of the Strategies and to relay any subsequent Alerts or Events of interest to the Arbiter. It then passes any Alerts from Arbiter 408 to the CommsClient instance to publish them on the given alerting topic. Gateway 404 also provides services for Strategies 410 to use so as to consolidate logic that would be used across multiple Strategies, such as Process Tree 414, which consumes Events and maintains a map of process relationships using the Events.
(117) Event Utilities 412 is a set of utilities used by Gateway 404 that consume and enrich data that will be used by Strategies 410, producing higher level Events and/or updates to durable storage. Event Utilities can take actions such as generating additional Events, Generating MetaEvents, and augmenting Process Tree 414. Each Utility included in the set of Event Utilities 412 provides a single-source for state tracking that would otherwise need to be repeated across multiple Strategies, significantly reducing overhead.
(118) An example prototype for HandleEvent for each Utility is: HandleEvent(event *ProtectEvent, utilities *UtilityInterface) ([ ]ProtectEvent.Event, [ ]metaevent.Event, error). Examples of different Utilities included in Event Utilities 412 are as follows:
(119) EventCombinator: Combines call (enter) Events and return (exit) Events from telemetry for a variety of syscall and network events, in order to match caller arguments with the returned value, and to know that the call completed and how long it took. Every received XXXEnter Event is stored in ProcessTree 414 using its ProcessUUID, ThreadID, and XXXEventTag. When an XXXExit Event is received, the corresponding Enter event is retrieved using ProcessUUID, ThreadID and XXXEventTag, and then XXX Event (combined of XXXEnter and XXXExit) is returned. If two consecutive Enter events occur, the first is ignored. If an Exit occurs before an Enter the Event is also ignored. Examples of Events combined by EventCombinator include: DUP, DUP2, DUP3, Mprotect, Mmap, Brk, Connect, Accept, Bind, Sendto, and Recvfrom. An example state diagram for the EventCombinator Utility is shown in
(120) CurrentWorkingDirectory: Collects directory related events and manages the current-working-directory tags for processes in Process Tree 414.
(121) Interactivity: Monitors for behaviors indicating that a process is TTY-aware or otherwise interactive, and applies a tag appropriately.
(122) Shell: Monitors executed programs to determine if they are shells, and tags them appropriately.
(123) Network Bound I/O: Uses tags to track the socket descriptors and use of descriptor mapping functions to determine if a process has its Standard Input/Output descriptors mapped to sockets. In particular, the Network Bound I/O Utility consumes FORK, DUP, DUP2, DUP3, Accept, Connect, and Close Events. It correlates I/O file descriptors to network file descriptors, and generates Compound Events and MetaEvents. An example state diagram for the Network Bound I/O Utility is shown in
(124) Network Event: Tracks network connections by consuming network related Event data and emitting higher-level network Events. The following is an example list of Events consumed (e.g., scalar sys call hooks), and can vary based on the amount of Sensor information available: sys_connect, sys_connect return, sys_accept, sys_accept return, sys_bind, sys_bind return, sys_listen, sys_listen return, and sys_close. Example logic for handling network information is as follows. From the sys_connect, the socket descriptor (and in the future sockaddr struct) is recorded. On return of sys_connect, one of the following would be generated: (1) if the connect was successful, emit a NETWORK_EVENT_CONNECT describing all information recorded; (2) if the connect was not successful, emit a NETWORK_EVENT_CONNECT ATTEMPT describing information recorded and reason for failure. Both of these can also be a MetaEvent. From the sys_bind, the socket descriptor (and, as applicable, sockaddr struct) is recorded. On return of sys_bind: (1) if successful, the information would be stored for future tracking across sys_listen and sys_accept; (2) if not successful, emit a MetaEvent indicating a failed attempt to bind. From the sys_listen: on sys_listen success, emit a NETWORK_EVENT_LISTEN event, and matching MetaEvent. From the sys_accept record the socket descriptor (and, as applicable, record client sockaddr): on sys_accept emit a NETWORK_EVENT_ACCEPT describing the socket descriptor. From sys_close, retrieve the argument: if the argument is a socket descriptor emit a NETWORK_EVENT_CLOSE.
(125) Network Service: Observes calls to listen on a port, and tags the process as a network service.
(126) Privileges/UID: Tracks the user ID/group ID and related IDs for a process, along with Events to change those, and thus tracks if a process has gained privileges legitimately.
(127) Process Tree: A mechanism for keeping track of processes and their tags. Process Tree 414 is a special case Event Utility. It is the first component to consume Events, so that it can be aware of processes prior to any other component and be prepared for queries on those processes. Process Tree 414 is exposed to the other Event Utilities 412 and Strategies 410 through interface(s) that allow the other Event Utilities and Strategies so that they can query the tree and add information (e.g., tags) to the processes in the tree. Tags are used to associate information to processes. There are two types of tags: “Tags,” and “Private Tags.” Tags are used by almost all components to associate and query information about processes. Tags can be associated to a process in three ways: (1) Process only: this associates data to a process which is not inheritable by descendants (e.g., “has touched filesystem”); (2) Inheritable: an attribute which begins with this process and is inherited by its descendants during process creation (e.g., “Network Service” or “Interactive Shell”); and (3) Inherited: attributes which were inheritable at some point in the process's lineage. Private Tags are only exposed to Utilities themselves, so that they can store additional (potentially incomplete) state information without exposing it to other components. Private Tags are all process-only (no automatic propagation is performed by the Process Tree). Process Tree 414 includes a Gateway Interface 416 and a Strategy Interface 418. Gateway Interface 416 is used by Gateway 404 and other components, such as Event Utilities 412 to perform special operations which are not exposed to Strategies. These operations include: private tagging, process lineage, and the ability to manipulate core Process Tree components. Strategy Interface 418 allows Strategies to query process tags and associate new tags.
(128) Stack Bounds: Tracks the recorded start/stop of the stack, updating it as the kernel may grow the stack, to determine acceptable bounds for the stack pointer (to detect exploitation).
(129) Strategies 410 represent the functional logic used to convert a stream of Events into a set of Alerts. Strategies follow a strategy pattern, and implement an interface that abstracts how a given Strategy handles Events via a HandleEvents method which can return a slice of Alerts, a slice of MetaEvents, or an error. Gateway 404 will call the HandleEvents method when it has received an Event from CommsClient 402. Additionally, the interface defines the Events needed by the Strategy, and its configuration options. A Strategy registers its configuration options with Config 406's registry when it is created. By default, all Strategies have at least one configuration option, which indicates whether the Strategy is enabled or not. A SetConfig method of the Strategy interface is called once at startup and then subsequently when a configuration message is received from Gateway 404.
(130) Arbiter 408 provides logic for Alert filtering and is ultimately what determines whether an Alert should be emitted. It is a rule system and uses an Alert filter to discard Alerts generated by Strategies. An instance of Arbiter 408 is created when the analytics framework starts and a reference to it is held by Gateway 404. During this startup phase, Arbiter 408 gets its configuration from the Config 406. Arbiter 408 uses its own filter language which is configured via the Arbiter's configuration filters value. It expects one filter per string entry in the filters configuration value.
(131) Additional detail regarding various components of the analytics framework are provided in various sections below.
III. Process Tree and Tags
(132) A. Process Tree
(133) As mentioned above, Process Tree 414 is both a core data structure and a utility in Event Utilities 412. The Process Tree is used by other utilities in Event Utilities 412, and by Strategies 410 to assign and retrieve process and program information, and to track program state via Tags.
(134) All Event Utilities and Strategies implement a HandleEvent callback function, and the Process Tree is special in that it is the first of any to have its HandleEvent callback called for all telemetry and Events. This is to ensure that it has pre-populated process and program structures before any other Event Utilities or Strategies attempt to query the Process Tree or set/retrieve Tags.
(135) Basic Process Tree structures and their relationships are depicted at a high level in
(136) The ProcessInfo structure tracks information about the process, which is treated separately from the program currently running in that process. The ProcessInfo entries in the hash map are keyed by each respective process' unique identifier string (e.g., process UUID). Event Utilities 412 and Strategies 410 access information about processes in the tree by specifying the respective process UUID when calling Process Tree functions. The timeout-driven hash map is used to expire entries if they have not been accessed within a given time window. Additional detail about the design and operation of these timeout-driven hash maps is provided below. Each ProcessInfo structure tracks information relevant to the process, such as PID, time of creation, and (among other things) a structure member Program (706) which is a pointer to a ProgramInfo structure (708) representing the currently running program. The ProgramInfo structure contains information about programs currently running in processes. This structure is where Tags (710) are stored, which are used for tracking the state of the program and the process in whole. The ProgramInfo structure is separate from the ProcessInfo structure because a process is not bound to host one program during its existence—calling the exec system call invokes a new program into the calling process (and processes may exec an arbitrary amount of times).
(137) B. Tags
(138) Event Utilities 412 and Strategies 410 can store and access state information related to processes and programs using Tags. Tags are accessed via a data structure called the TagMap, a pointer to which is stored in the ProgramInfo structure member named Tags (710). External operation and access to the TagMap is similar to a hash map, in that each is Tag in the TagMap keyed by a unique string, which is used to store and retrieve the tag.
(139) Tags are designed to support state transitions and propagations between processes and programs. For a structure to be a Tag it must conform to the Tag Interface, which defines that Tags must implement a Fork( ) and Exec( ) callback, each of which also returns a Tag (or nil), and are called by the Process Tree during Fork and Exec process events respectively. These events may trigger state transitions or propagations: a program Tag may want to create and a new or different Tag to a subprogram upon Exec, or create a copy of itself, or any number of possibilities. For example, since the default POSIX behavior is to propagate file descriptors on to subprocesses and subprograms, Tags can be used to track the state of file descriptors: on Fork( ), the file descriptor tag returns a copy of itself, and on Exec( ) it returns itself (the same pointer already referring to the tag). For another example, consider that a program tagged with an Interactive Shell Tag can label subprograms as Commands by returning a new Command Tag upon Exec( ). Tags can optionally also implement a callback for Exit( ), which is useful if multiple Tags share state across multiple processes.
(140) An abstraction of the internal structure of the TagMap and its relation to Tags is depicted in
(141) TagMap 902 is an abstraction over a set of arrays and maps used for organizing and retrieving pointers to Tag structures. Most of this organization internally is for optimization, to only call handlers on Tags that exhibit non-default/specialized behavior on Fork and Exec. Tags are retrieved by name from the TagMap using a Lookup( ) function, which retrieves the tag from its own internal map (labeled in
(142) The Tag structure is an interface Type which implements a callback for Fork( ) and Exec( ) callbacks, both of which themselves return a Tag interface (or NIL). Logic here determines if/how a Tag propagates between new processes (forks) or new programs (execs). If a Tag implements an Exit( ) callback, that callback is called by the Process Tree on Exit process events.
(143) C. Event Driven and Context-Aware Tag Propagation Examples
(144) 1. Interactive Shell
(145) Detecting that a shell program (e.g., /bin/bash) is being used interactively, as opposed to being used to execute a subprogram or script, is a capability that Platform 100 can provide. Additional detail on approaches to detecting such a shell is provided in more detail in Section IV below. By detecting interactive shells, users are able to write rules around the conditions in which an interactive shell is permitted by their security policies. To make the user experience less cumbersome, built in logic permits subsequent interactive shells to be executed as long as they descend from an alive instance of a permitted interactive shell. In various embodiments, this is tracked using a tag with specific propagation logic.
(146) In the following scenario, suppose that policy declares that /usr/sbin/sshd can execute /bin/bash. As shown in
(147)
(148) On Fork & Exec Events: If the Tag is the original authorized shell Tag (1006), it returns a new authorized shell heir Tag (1008). If the Tag is an authorized shell heir Tag (1008), it will check its pointer back to the authorized shell Tag (1006), to determine if the original authorized shell process is still alive, and if so, it returns itself (literally its own pointer) for the Process Tree to propagate to the newly forked process (1010). If the original authorized shell is dead, it returns NIL.
(149) On Exit Event: The original authorized shell Tag updates its state to reflect that the original authorized shell is now dead, so that heir Tags can see this state should they receive fork/exec events.
(150) The logic is that the permission to execute subsequent shells is transitive so long as the original source of the permission exists. This behavior permits scenarios like a user transitioning to another subshell during their session, without making themselves accidentally vulnerable to allowing programs they started during their session to spawn interactive shells after they log out. As an example, suppose the user logged in to launch Apache, then logged out. The user would not want Apache to then be allowed to spawn interactive shells. In various embodiments, re-parenting is also provided for, and the same event-driven context-awareness remains present.
(151) 2. Original User Tag
(152) Process Tree 414 tracks UID (GID, etc.) using tags, which it updates based on specific events, in order to understand the state of the process and how/why its UID (or GID, etc.) might have changed. Such information can be particularly interesting when processes become root. By tracking the events related to legitimate privilege transitions, privilege-escalation by way of exploitation can be detected. For example, if a tag indicates that a process was UID 1000, and was not currently engaged in any calls to setuid to change its UID, a Strategy (e.g., Strategy 420) can alert that there has been an illegitimate transition to root.
(153) Additionally, the UID (GID, etc.) tags allow Process Tree 414 (and thus Strategies 410) to track who was originally the user involved. If someone logs in as a UID associated with Mallory, sudo's to root, then su's to Alice and performs some other nefarious action, the fact that it was actually Mallory performing all of the actions (and not Alice) can be surfaced.
(154) 3. Alert Grouping
(155) Tags facilitate grouping of Alerts once there has been an Alert where the scope-of-damage is process-wide. Once there has been a security event where the whole process is deemed to be malicious (e.g., a blacklisted program, exploited service, or non-permitted shell), then any other Alert by that process or its children will inherit the same Alert grouping. This is desirable because these subprocesses and their events are necessarily associated with the initial malice. Even if there is an alert which is not necessarily process-wide (e.g., a connection being made to a non-whitelisted IP, which could be misconfiguration etc.), it can be grouped with others so long as a process-wide alert has previously been established. This allows analytics framework 400 to not only group Alerts, but also group Events (which themselves didn't necessarily trigger Alerts) with the Alert.
(156) D. Example Process
(157)
(158) A variety of additional actions can be taken in response to Alert generation. As one example, a bot can be used to interrogate interactive shell users when Alerts are raised. Suppose that a determination is made (i.e., a Strategy is matched) that an interactive shell does not match a whitelist entry. An Alert is generated (1202), and the implicated user is queried (1204), e.g., by a Slackbot (as depicted in
IV. Interactive Shell Event Detection
(159) A. Introduction
(160) This section provides a detailed discussion of analytics framework 400's ability to detect and tag interactive shells and commands. This capability is the basis for the Interactive Shell policy type, and for the Shell Command MetaEvents used by other mechanisms, such as the flight recorder. The following discussion is framed from the perspective of Gateway 404, which is the component of framework 400 responsible for instantiating all Strategies 410 and Event Utilities 412, including Process Tree 414. Upon receiving telemetry events (or abstractions of telemetry events emitted by various Event Utilities 412), Gateway 404 calls the HandleEvent callback function of the specific Event Utilities and Strategies which subscribe to that Event type. Process Tree 414 is unique in that it has its HandleEvent function called on all Events, to ensure it is informed of the processes and programs, and is prepared for queries on those processes and programs by other Event Utilities and Strategies.
(161) This section makes use of two types of diagrams. The first type are code component diagrams, which show abstractions of which function is called at which point in the process. The second type are visualizations of data structures affected by/used by the code to complete the operation.
(162) B. Detection of Interactivity
(163) 1. Pass Event to the Process Tree
(164) This walkthrough starts from the point of the Gateway having received telemetry for an Exec( ) Event, which denotes a program being invoked by a process via the execve system call.
(165) The HandleEvent function in Process Tree 414 begins by looking up the process' unique ID (e.g., “ABCD”), and if no ProcessInfo structure is present, a new one is created and populated in the hash map. After ensuring that a ProcessInfo object exists, Process Tree 414 then calls its own internal HandleExec( ) method, which then calls the ProcessInfo object's Exec( ) function, as illustrated in
(166) Next, the ProcessInfo object accesses its *Program member (a ProgramInfo object instance), and calls its Exec( ) function. The ProgramInfo object's Exec( ) function returns a pointer to a new ProgramInfo object instance populated with information from the Exec( ) event. The ProgramInfo object then replaces its existing ProgramInfo pointer with the pointer to the new instance.
(167)
(168) 2. Pass Event to Other Event Utilities
(169) Once the Process Tree HandleEvent function returns back to Gateway 404, it moves on to other components, as depicted by the component diagrams of
(170) The Shell Utility has logic for identifying when telemetry indicates a program is a shell. For simplicity, the logic in this example matches on the program path of “/bin/bash” as being a known shell program. Upon detecting a shell, it calls the Process Tree function SetProcessTag (1702) to set a ShellTag on the process.
(171)
(172) 3. Context-Aware, Event-Driven Tag State Change
(173)
(174)
(175) 4. Tag Propagation & Shell Tag
(176) At the beginning of this section, a cascading sequence of calls was shown taking place when handling an Exec event. The sequence was (1) Gateway 404 calls Process Tree 404's HandleEvent( ); (2) HandleEvent( ) calls HandleExec( ); (3) HandleExec calls the Exec( ) function of the corresponding ProcessInfo object; and (4) the ProcessInfo Exec( ) calls Exec( ) on the corresponding ProgramInfo object. This cascade goes further: the TagMap in the ProgramInfo also has an Exec( ) and Fork( ) callback, which is called on each Event respectively, and which returns a new TagMap containing Tags which exhibit Exec( ) or Fork( ) propagation behavior. This propagation could be to propagate the same Tag, a copy of the Tag, a completely different Tag, or nothing at all (NIL). As illustrated in
(177) ShellTag.Exec( ) has more logic-based behavior: if the Shell Tag reflects the state of being interactive, it returns a ShellCommandTag, indicating that this newly executed program is the result of a command being issued at the shell. If the Shell Tag is not interactive, it returns a Shell Automation Tag indicating that the newly executed program is involved in some form of non-human-driven automation, such as a shell script.
(178)
(179)
(180) A variety of actions can be taken in response to determining that an interactive shell is executing. As one example, commands entered into the interactive shell can be tagged (e.g., as described above) as interactive shell commands. Such commands can then be surfaced (e.g., via Alerts), made queryable, etc., so that a real-time view of which commands are being executed in interactive shells can be made available.
V. Events
(181) Events are platform 100's internal data representation of data supplied to it from a source. This representation is aimed at simplifying analysis and to facilitate Strategy writing.
(182) A. Creating New Types of Events
(183) One example way to create new Events is as follows:
(184) 1. Create a new .go file in the pkg/protectevents directory.
(185) 2. Add a new Event type in the consts of pkg/protectevents/event types.go, making sure that BaseEvent (e.g., *BaseEvent) is embedded in the new type.
(186) 3. Write unit tests for any new methods provided by the new type (e.g., syscall name to number translation).
(187) 4. Update the factories in pkg/protectevents/factory to create Events if necessary.
(188) B. Specific Event Types
(189) Events contain a BaseEvent defined in pkg/protectevent/events.go which defines most of the protectevent.Event interface. This contains common fields such as:
(190) TABLE-US-00002 Always Filled In? Field Type Meaning (Y/N) Id string Unique Identifier Y for this specific Event ProcessUUID string UUID for the N process this event occurred in ProcessPID int the PID/TGID of Y the process this event occurred in ThreadID int32 the thread ID of the Y task Uid uint32 the user ID of the N task/thread Gid uint32 the group ID of the N task/thread Euid uint32 the effective user N ID of the task/thread Egid uint32 the effective group N ID of the task/thread Suid uint32 the saved user ID N of the task/thread Sgid uint32 the save group ID N of the task/thread FsUid uint32 the file system user N ID of the task/thread FsGid uint32 the file system N group ID of the task/thread ContainerID string the UUID of the Y container where this Event occurred (often a hex- encoded SHA256) ContainerName string the string name of N the container where this Event occurred SensorID string theUUID of the Y Sensor where this event occurred (meaning the container was running on the host monitored by the sensor with the given ID) ImageID string theUUID of the N Image used to build the container where this event occurred (often a hex- encoded SHA256) ImageName string the string name of N the Image used to build the container where the Event occurred SequenceNum uint64 the sequence Y number for events emitted as part of a subscription. MonotimeNanos the monotime from Y the Sensor’s host’s clock at the time of the Event
(191) Specific events assume these fields as well, where appropriate. The following are various example Events, as well as corresponding example JSON.
(192) 1. Container Created
(193) This Event represents when a Container is created but not yet started, on a host monitored by platform 100.
(194) Event Type constant: protectevent.CONTAINER_EVENT_TYPE_CREATED
(195) Additional Fields:
(196) TABLE-US-00003 Always Present Fields Type Meaning (Y/N) DockerConfigJSON string The Docker Config N JSON from the Docker Socket Contains additional information OCIConfigJSON string The Container N Config JSON from the OCI compliant container engine
(197) The JSON Factory checks the type field for a string value “cont-create” for container creation events. They include all of the BaseFields and can optionally include the DockerConfigJSON or OCIConfigJSON fields as strings: {“type”: “cont-create”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “monotime_nanos”: 58800000000, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”}
(198) 2. Container Started
(199) This Event represents when a previously created Container is started on a host monitored by a Capsule8's platform.
(200) Event Type constant: protectevent.CONTAINER_EVENT_TYPE_RUNNING
(201) Additional Fields
(202) TABLE-US-00004 Always Present Fields Type Meaning (Y/N) InitHostPid int The PID of the init process in the Container, in the host namespace.
(203) The JSON Factory checks the type field for a string value “cont-create” for container creation events. They include all of the BaseEvent fields and can optionally include the DockerConfigJSON or OCIConfigJSON fields as strings: {“type”: “cont-start”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “monotime_nanos”: 58800000000, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “init_host_pid”: 2222}
(204) 3. Container Exited
(205) This Event represents when a previously started Container's Init PID has exited but the container's resources have not yet been reclaimed.
(206) Event Type constant: protectevent.CONTAINER_EVENT_TYPE_EXITED
(207) Additional Fields
(208) TABLE-US-00005 Always Present Fields Type Meaning (Y/N) ExitCode int The ExitCode that Y the Init Process Exited with
(209) The JSON Factory checks the type field for a string value of “cont-create” for container exit events. They include all of the BaseEvent fields and include the field exit_code which indicates the integer exit code of the init process in the container: {“type”: “cont-exit”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “monotime_nanos”: 58800000000, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “exit_code”: 0}
(210) 4. Container Destroyed
(211) This Event represents when a previously exited Container's resources have been reclaimed and thus no longer exist.
(212) Event Type constant: protectevent.CONTAINER_EVENT_TYPE_DESTROYED
(213) Additional Fields
(214) TABLE-US-00006 Always Present Fields Type Meaning (Y/N) None
(215) The JSON Factory checks the type field for a string value of “cont-destroy” for container reaped events. They include only the BaseEvent fields: {“type”: “cont-destroy”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “monotime_nanos”: 58800000000, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”}
(216) 5. Process Fork
(217) This Event represents when a process in a monitored Container forks a new process.
(218) Event Type constant: protectevent.PROCESS_EVENT_TYPE_FORK
(219) Additional Fields
(220) TABLE-US-00007 Always Present Fields Type Meaning (Y/N) ProcessUUID string ProcessUUID in Y base event is filled in ProcessPID int the PID of the Y process that called the fork ChildPID int The PID of the Y Child process from the fork UpdateCWD string The CWD at the Y time of the fork
(221) The JSON Factory checks the type field for a string value of proc-fork. It contains the BaseEvent fields and all of the fields in the table above: {“type”: “proc-fork”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “process_uuid”: “394bd04468b541bdbe132a71de3671cb”, “monotime_nanos”: 58800000000, “process_pid”: 2222, “child_pid”: 3333}
(222) 6. Process Exec
(223) This Event represents when a process in a monitored Container calls the execve family of syscalls to start a new program.
(224) Event Type constant: protectevent.PROCESS_EVENT_TYPE_EXEC
(225) Additional Fields
(226) TABLE-US-00008 Always Present Fields Type Meaning (Y/N) ProcessUUID string ProcessUUID in Y base event is filled in ProcessPID int the PID of the Y process that called the fork ProgramName string the path of the Y program being executed
(227) The JSON Factory checks the type field for a string value of proc-exec. It contains the BaseEvent fields and all of the fields in the table above: {“type”: “proc-exec”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “monotime_nanos”: 58800000000, “process_uuid”: “a856880a77274d238a5a9d1057831dec”, “process_pid”: 3333, “filename”: “′exit 1”}
(228) 7. Process Exit
(229) This Event represents when a process in a monitored Container exits.
(230) Event Type constant: protectevent.PROCESS_EVENT_TYPE_EXIT
(231) Additional Fields
(232) TABLE-US-00009 Always Present Fields Type Meaning (Y/N) ProcessUUID string ProcessUUID in Y base event is filled in ProcessPID int the PID of the Y process that called the fork ExitCode int the Return code Y returned by the process that is terminating
(233) The JSON Factory checks the type field for a string value of proc-exit. It contains the BaseEvent fields and all of the fields in the table above: {“type”: “proc-exit”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “monotime_nanos”: 58800000000, “process_uuid”: “a856880a77274d238a5a9d1057831dec”, “process_pid”: 3333, “exit_code”: 1}
(234) 8. Syscall Enter
(235) This represents that a given system call is about to be executed in a monitored Container. This is used to get scalar arguments and other values but does not tell if the system call was successful.
(236) Event Type constant: protectevent.PROCESS_EVENT_TYPE_ENTER
(237) Additional Fields
(238) TABLE-US-00010 Always Present Fields Type Meaning (Y/N) ProcessUUID string ProcessUUID in Y base event is filled in ProcessPID int the PID of the Y process that called the fork Number int the syscall number Y Name string the name of the Y syscall Args [ ]uint64 the scalar Y arguments to the syscall
(239) The JSON Factory checks the type field for a string value of syscall. It contains the BaseEvent fields and all of the fields in the table above. One of the field's number or name may be omitted but not both. At the time of creation the JSON Event Factory will fill in both the name and number provided that one of the fields is present: {“type”: “syscall”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “monotime_nanos”: 58800000000, “process_uuid”: “394bd04468b541bdbe132a71de3671cb”, “process_pid”: 3333, “number”: 0, “name”: “sys_read”, “args”: [0, 1203740476025595838784, 20]}
(240) 9. Syscall Exit
(241) This represents that a given syscall is about to return in a monitored Container. This is used to get the return values of syscalls which can indicate if the syscall was successful.
(242) Event Type constant: protectevent.PROCESS_EVENT_TYPE_EXIT
(243) Additional Fields
(244) TABLE-US-00011 Always Present Fields Type Meaning (Y/N) ProcessUUID string ProcessUUID in Y base event is filled in ProcessPID int the PID of the Y process that called the fork Number int the syscall number Y Name string the name of the Y syscall Ret int64 the scalar return Y value for the syscall
(245) The JSON Factory checks the type field for a string value of syscall-exit. It contains the BaseEvent fields and all of the fields in the table above. One of the field's number or name may be omitted but not both. At the time of creation the JSON Event Factory will fill in both the name and number provided that one of the fields is present: {“type”: “syscall-exit”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “monotime_nanos”: 58800000000, “process_uuid”: “394bd04468b541bdbe132a71de3671cb”, “process_pid”: 3333, “number”: 0, “name”: “sys_read”, “ret”: 23}
(246) This Event represents when a File is opened inside of a Container/Monitored Host.
(247) Event Type constant: protectevent.FILE_EVENT_TYPE_OPEN
(248) Additional Fields
(249) TABLE-US-00012 Always Present Fields Type Meaning (Y/N) Filename string The path to the file Y that was opened OpenFlags int32 The flags passed to Y the open syscall OpenMode int32 The mode the file Y was opened with
(250) The JSON Factory checks the type field for a string value of file-open. It contains the BaseEvent fields and all of the fields in the table above: {“type”: “file-open”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “monotime_nanos”: 58800000000, “process_uuid”: “394bd04468b541bdbe132a71de3671cb”, “process_pid”: 2222, “filename”: “/tmp/foo.txt”, “flags”: 0, “mode”: 700}
(251) Event Type constant: protectevent.FILE_EVENT_CLOSE
(252) Additional Fields
(253) TABLE-US-00013 Always Present Fields Type Meaning (Y/N) FD int32 passed file Y Descriptor to be closed Ret int32 Return value of the Y syscall close
(254) The JSON Factory checks the type field for a string value of syscall-close. It contains the BaseEvent fields and all of the fields in the table above: {“type”: “syscall-close”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “monotime_nanos”: 58800000000, “process_uuid”: “394bd04468b541bdbe132a71de3671cb”, “Fd”: 23, “Ret”: 0}
(255) 12. Syscall Dup
(256) This event represents the combined event of ENTER and EXIT for syscall DUP event inside of a Container.
(257) Event Type constant: protectevent.SYSCALL_EVENT_DUP
(258) Additional Fields
(259) TABLE-US-00014 Always Present Fields Type Meaning (Y/N) OldFD int32 passed file Y Descriptor to be copied Ret int32 Return value of the Y syscall dup/ represents duplicate file descriptor of OldFD
(260) The JSON Factory checks the type field for a string value of syscall-dup. It contains the BaseEvent fields and all of the fields in the table above: {“type”: “syscall-dup”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “monotime_nanos”: 58800000000, “process_uuid”: “394bd04468b541bdbe132a71de3671cb”, “OldFd”: 23, “Ret”: 32}
(261) 13. Syscall DUP2
(262) This Event represents the combined event of ENTER and EXIT for syscall DUP2 event inside of a Container.
(263) Event Type constant: protectevent.SYSCALL_EVENT_DUP2
(264) Additional Fields
(265) TABLE-US-00015 Always Present Fields Type Meaning (Y/N) OldFD int32 passed file Y Descriptor to be copied NewFD int32 passed file Y Descriptor to be copied to Ret int32 Return value of the Y syscall dup2/ represents new descriptor for OldFD
(266) The JSON Factory checks the type field for a string value of syscall-dup2. It contains the BaseEvent fields and all of the fields in the table above: {“type”: “syscall-dup2”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “monotime_nanos”: 58800000000, “process_uuid”: “394bd04468b541bdbe132a71de3671cb”, “OldFd”: 23, “NewFd”: 32, “Ret”: 0}
(267) 14. Syscall DUP3
(268) This Event represents the combined event of ENTER and EXIT for syscall DUP3 event inside of a Container.
(269) Event Type constant: protectevent.SYSCALL_EVENT_DUP3
(270) Additional Fields
(271) TABLE-US-00016 Always Present Fields Type Meaning (Y/N) OldFD int32 passed file Y descriptor to be copied NewFD int32 passed file Y descriptor to be copied to Flags int32 passed flags passed Y for new file descriptor Ret int32 Return value of the Y syscall dup3/ represents duplicate descriptor for OldFD
(272) The JSON Factory checks the type field for a string value of syscall-dup3. It contains the BaseEvent fields and all of the fields in the table above: {“type”: “syscall-dup3”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “monotime_nanos”: 58800000000, “process_uuid”: “394bd04468b541bdbe132a71de3671cb”, “OldFd”: 23, “NewFd”: 32, “Flags”: 444, “Ret”: 0}
(273) 15. Type NetworkAddress
(274) This struct defines fields for NetworkAddress.
(275) TABLE-US-00017 Always Present Fields Type Meaning (Y/N) Family NetworkAddressFamily Represents family Y one of UNKNOWN, IPV4, IPV6, LOCAL Address string network address of Y type CIDR
(276) 16. Syscall Connect
(277) This Event represents combined event of ENTER and EXIT for syscall connect event inside of a Container.
(278) Event Type constant: protectevent.SYSCALL_EVENT_CONNECT
(279) Additional Fields
(280) TABLE-US-00018 Always Present Fields Type Meaning (Y/N) MonotimeNanosEnter int64 Timestamp of Y syscall connect enter event Fd int32 passed socket file Y descriptor NetworkAddr NetworkAddress passed network Y address Port int32 Passed port number Y Ret int32 Return value of the Y syscall connect
(281) The JSON Factory checks the type field for a string value of syscall-connect. It contains the BaseEvent fields and all of the fields in the table above: {“type”: “syscall-connect”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “monotime_nanos”: 58800000000, “process_uuid”: “394bd04468b541bdbe132a71de3671cb”, “Fd”: 23, “SockAddrPtr”: 40404040, “AddrLen”: 4, “Ret”: 0}
(282) 17. Syscall Accept
(283) This Event represents the combined event of ENTER and EXIT for syscall accept event inside of a Container.
(284) Event Type constant: protectevent.SYSCALL_EVENT_ACCEPT
(285) Additional Fields
(286) TABLE-US-00019 Always Present Fields Type Meaning (Y/N) MonotimeNanosEnter int64 Timestamp of Y syscall connect enter event Fd int32 passed socket file Y descriptor NetworkAddr NetworkAddress passed network Y address Port int32 Passed port number Y Ret int32 Return value of the Y syscall accept/new socket descriptor for connection
(287) The JSON Factory checks the type field for a string value of syscall-accept. It contains the BaseEvent fields and all of the fields in the table above: {“type”: “syscall-accept”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “monotime_nanos”: 58800000000, “process_uuid”: “394bd04468b541bdbe132a71de3671cb”, “Fd”: 23, “networkaddress”: {“family”: 0, “address”: “192.168.0.1./24”}, “Ret”: 32}
(288) 18. Syscall Bind
(289) This Event represents the combined event of ENTER and EXIT for syscall bind event inside of a Container.
(290) Event Type constant: protectevent.SYSCALL_EVENT_BIND
(291) Additional Fields
(292) TABLE-US-00020 Always Present Fields Type Meaning (Y/N) MonotimeNanosEnter int64 Timestamp of Y syscall connect enter event Fd int32 passed socket file Y descriptor NetworkAddr NetworkAddress passed network Y address Port int32 Passed port number Y Ret int32 Return value of the Y syscall bind
(293) 19. Syscall Listen
(294) This Event represents the combined event of ENTER and EXIT for syscall listen event inside of a Container.
(295) Event Type constant: protectevent.SYSCALL_EVENT_LISTEN
(296) Additional Fields
(297) TABLE-US-00021 Always Present Fields Type Meaning (Y/N) MonotimeNanosEnter int64 Timestamp of Y syscall connect enter event Fd int32 passed socket file Y descriptor Backlog int32 passed maximum Y number of pending connections Ret int32 Return value of the Y syscall listen/new socket descriptor for connection
(298) Example JSON: {“type”: “syscall-accept”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “monotime_nanos”: 58800000000, “process_uuid”: “394bd04468b541bdbe132a71de3671cb”, “Fd”: 23, “SockAddrPtr”: 40404040, “AddrLenPtr”: 41414141, “Ret”: 32}
(299) 20. KProbe SMEP SMAP
(300) This Event represents when the function native_write_cr4 was called in the kernel, by using a kprobe. It contains the new CR4 value (the first argument to that function) and is used to determine if the new value disables SMEP/SMAP in the CR4 register of a given processor.
(301) Event Type constant: protectevent.KPROBE_EVENT_SMEP_SMAP_TYPE
(302) Additional Fields
(303) TABLE-US-00022 Always Present Fields Type Meaning (Y/N) NewCR4Value uint64 The Value of CR4 Y that will be set
(304) This type also defines helper functions to determine if the NewCR4Value disables SMEP and SMAP. They are: DisablesSMEP( ) bool DisablesSMAP( ) bool
(305) The JSON Factory checks the type field for a string value of smep-smap for container reaped events. They include only the BaseEvent fields and a cr4 field which is the integer value that the CR4 register would be set to: {“type”: “smep-smap”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “monotime_nanos”: 58800000000, “cr4”: 4226827}
(306) 21. KProbe AppArmor
(307) This Event represents when a KProbe has been used to scan Kernel Memory to check if AppArmor is enabled and enforcing its policies. It returns the value of the memory used for the configuration variable.
(308) Event Type constant: protectevent.KPROBE_EVENT_APP_ARMOR_TYPE
(309) Additional Fields
(310) TABLE-US-00023 Always Present Fields Type Meaning (Y/N) None
(311) 22. KProbe SELinux
(312) This Event represents when a KProbe has been used to scan Kernel Memory to check if SELinux is enabled and enforcing its policies. It returns the values of the variables that control SELinux.
(313) Event Type constant:
(314) Additional Fields
(315) TABLE-US-00024 Always Present Fields Type Meaning (Y/N) None
(316) 23. KProbe Stack Create
(317) This Event represents when the KProbe on arch_align_stack has fired, which means a program's stack has been created.
(318) Event Type constant: protectevent.KPROBE_EVENT_STACK_CREATE
(319) Additional Fields
(320) TABLE-US-00025 Always Present Fields Type Meaning (Y/N) stackhighaddr uint64 The high bound of Y the stack
(321) 24. KProbe Stack Expand
(322) This Event represents when the KProbe on expand_stack has fired, which means a program's stack has been expanded down.
(323) Event Type constant: protectevent.KPROBE_EVENT_STACK_EXPAND
(324) Additional Fields
(325) TABLE-US-00026 Always Present Fields Type Meaning (Y/N) Stack_low_addr uint64 The new low bound Y of the stack
(326) 25. KProbe Load Kernel Module
(327) This Event represents when the KProbe on do_init_module has fired, which means a new kernel module is being loaded.
(328) Event Type constant:
(329) protectevent.KPROBE_EVENT_LOAD_KERNEL_MODULE_TYPE
(330) Additional Fields
(331) TABLE-US-00027 Always Present Fields Type Meaning (Y/N) Do_init_module_module_name string The name of Y the module being loaded
(332) 26. KProbe Permissions Modification
(333) This Event represents when the KProbe on sys_fchmodat has fired, which means a permissions change has been requested.
(334) Event Type constant: protectevent.KPROBE_EVENT_CHMOD_TYPE
(335) Additional Fields
(336) TABLE-US-00028 Always Present Fields Type Meaning (Y/N) Sys_fchmodatf_name string The name of the Y file/directory whose permissions are changed sysfchmodatmode uint64 The new Y permissions mask
(337) 27. Ticker
(338) This Event represents the state of the host clock on a given sensor.
(339) Event Type constant: protectevent.TICKEREVENTTYPE
(340) Additional Fields
(341) TABLE-US-00029 Always Present Fields Type Meaning (Y/N) nanoseconds int64 The number of Y nanoseconds since the UNIX epoch according to the sensor's clock seconds int64 The number of Y seconds since the UNIX epoch according to the sensor's clock
(342) The JSON Factory checks the type field for a string value “ticker” for container creation events. They include all of the BaseFields and the fields mentioned above. optionally includes the DockerConfigJSON or OCIConfigJSON fields as strings: {“type”: “ticker”, “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4”, “monotime_nanos”: 58800000000, “nanoseconds”: 1257894000000000000, “seconds”: 1257894000}
(343) 28. Configuration Event
(344) This Event is used by the JSON Factory to simulate a Platform API message indicating a configuration change, since the platform provides configuration files for each strategy/component.
(345) Event Type constant: protectevent.CONFIG_EVENT
(346) Additional Fields
(347) TABLE-US-00030 Always Present Fields Type Meaning (Y/N) topic string The string topic Y name of the configurations, it is effectively a section prefix. for all values values string a list of Javascript Y objects with keys “name”, and “value”: as strings
(348) Example JSON: {“type”: “config”,
(349) “topic”: “strategy.dummy”,
(350) “values”: [{“name”: “enabled”, “value”: “true”}]
(351) }
(352) A more complicated example follows. Arbiter 408 requires that filters be applied. The below JSON example shows how to apply two filters: one that says only alerts from the container where the ID is 98e73918fad6, and one that says any Alerts that are have a priority lower than HIGH should be provided:
(353) {“type”: “config”,
(354) “topic”: “arbiter”,
(355) “values”: [{“name”: “enabled”, “value”: “true”}, {“filters”: “container_id==98e73918fad6, priority <HIGH”}]
}
VI. Strategies
(356) Analytics framework 400 provides security monitoring capabilities through modular components called Strategies. As discussed above, a Strategy is a piece of detection logic that consumes Events and produces either Alerts or Events of Interest, in various embodiments.
(357) A. Overview
(358) Strategies are designed to provide diverse, overlapping layers of system security monitoring to cover the many facets of an attack. Attack categories and entire vulnerability classes are covered by detecting the low-level behaviors required to carry out an exploit or other security violation. Therefore, Strategies are geared towards low-level system monitoring, providing a lightweight mechanism for the observation and detection of behavioral events which may be indications of unauthorized or malicious behavior within an organization's environment.
(359) Individual Strategies are mechanisms for defining policies or sets of rules for a specific class of security-related Events which may occur on a system. A Strategy is defined by a policy type and a set of rules; each Strategy is responsible for monitoring a certain set of behaviors defined by its policy type and for raising an alert if any of these behaviors violate its rules. For instance, Strategies having a policy of type “connect” monitor network connections. If the rules specified in a given Strategy configuration match the behavior observed (e.g., if a connection to a blacklisted domain is performed), then an Alert is raised. Each Strategy will generate a single Alert when it detects a violation. Users may deploy multiple Strategies of the same policy concurrently, so as to have granular control of how many Alerts are to be generated and how these Alerts shall be generated for different contexts. For example, an unexpected outbound connection to an internal subnet could raise a lower-priority alert than an outbound connection to an unknown host on the Internet.
(360) The types of Events that Strategies monitor vary, ranging from common system operations (such as network connections and program execution) to Events which are explicitly impactful on security (such as unauthorized privilege escalation or the disabling of Linux Security Modules). Detection of low-level system Events is carried out by a Sensor; this Event stream is then sent to Analytics framework 400, which processes the Events and extracts data to be used by the Strategies. Each Strategy receives Event data relevant to its policy type, determines if the operation observed matches any of its rules, and raises an Alert if necessary.
(361) B. Strategy Configuration
(362) The rules that are set for a Strategy define whether an observed behavior is authorized or unauthorized. For example, a strategy may be built upon the program policy, which monitors program execution, and have a set of rules that authorize commands issued only from a certain list of whitelisted programs. This Strategy will raise Alerts whenever a command is executed from a program not on this list. The nature of the rules that can be defined in various Strategies depends on the policy of the respective strategy. Thus, IP addresses present in rules might only be relevant for Strategies based on connect or sendto policies, whereas program/parent program names might only be relevant for policies involving process interactions.
(363) Below is an example of a configuration file that defines a single Strategy which monitors program execution:
(364) Program Execution Whitelist Strategy:
(365) policy: program
(366) alertMessage: Unauthorized Program Execution
(367) comments: This strategy detects when an unauthorized program has issued a command.
(368) priority: High
(369) enabled: true
(370) rules: ignore programName in $ProgramWhitelist default match
ProgramWhitelist:
(371) type: paths
(372) description: whitelist of authorized programs
(373) list: /bin/ls /bin/sh
(374) In the example above, a Strategy named “Program Execution Whitelist Strategy” is defined, which is of policy “program.” The message to appear in the generated Alert should this Strategy fire in the alertMessage field is also specified, as well as the priority of this Alert, priority. The Strategy rules denoting when and how this Strategy will fire alerts are listed under rules. The rules defined above are denoting that an Alert should always be fired unless the program name of the executing program is in the “ProgramWhitelist” list. The defined list “ProgramWhitelist” is a list of paths (as denoted by its type) of programs in the system that are allowed to execute commands.
(375) The aforementioned example is a simple use case of the supported policies. Different types of lists and policies are supported, and a configuration file may define any number of Strategies and lists. More information on list and Strategy configurations is defined later in this section.
(376) Strategies may refer to lists when constructing rules, and multiple Strategies may refer to the same list; any list referenced by a Strategy must be defined within the same configuration file. A Strategy rule refers to a list by prepending the list name with the special character $.
(377) A strategy is uniquely identified, in various embodiments, as a YAML key containing a policy sub-key. The top-level key, which essentially denotes the start of a Strategy configuration, also serves as the name of the Strategy for the given configuration (see “Program Execution Whitelist Strategy” in the previous example).
(378) 1. List Definitions
(379) Lists are defined to be used in Strategy rules, controlling when and how Alerts should be fired.
(380) a. List Types
(381) Configuration lists can have the following types, in various embodiments:
(382) i. names
(383) Name lists store strings. The following is an example of a valid name list:
(384) ContainerWhitelist:
(385) type: “names”
(386) description: “ignore all activity from these containers”
(387) list: “/test-container-001”: “this is a test container” “/test-container-002”: “this is a second test container”
(388) ii. hosts
(389) Host lists store IP addresses as CIDR blocks. Additionally, host lists have a required lookupDNS variable, which will resolve a domain name to an IP address if set to true. Users may add domain names to their host list only if lookupDNS is true; a host list with lookupDNS set to false and a domain name in its list will not be a valid list and return a configuration error. The following are examples of valid host lists:
(390) SampleHostlist_1:
(391) type: “hosts”
(392) lookupDNS: false
(393) list: “1.0.0.0/8” “3.3.3.0/16”
(394) SampleHostlist_2:
(395) type: “hosts”
(396) lookupDNS: true
(397) list: “www.capsule8.com”: “our website!”
(398) iii. paths
(399) Path lists store program or file paths. Paths may be written with the wildcard operator *, which will match on all paths that fit the pattern. The following is an example of a valid path list:
(400) AuthorizedPrograms
(401) type: “paths”
(402) description: whitelist of authorized programs
(403) list: “Thin/bash” “/bin/sh” “/usr/sbin/*”: “this will match all programs beginning with /usr/sbin/”
(404) iv. numbers
(405) Number lists store integers. The following is an example of a valid number list:
(406) PortList
(407) type: “numbers”
(408) list: 80 443
(409) 2. Strategy Definitions
(410) In addition to default fields, Strategies may have extra configuration options that are specific to the operation of their policy. These are documented in each policy's respective documentation file.
(411) a. Strategy Rules
(412) Each policy exposes a set of valid fields that can be used for the construction of higher-level rules in strategies. Thus, in each strategy's definition, the rules option determines how an alert will be generated upon the receipt of an event.
(413) i. Match and Ignore Rules
(414) Each rule begins with either the keyword match or ignore. If the predicate following a match rule is satisfied, that will result in an alert being fired by the respective strategy, whereas a predicate that satisfies an ignore rule will not. The only cases of rules that do not start with either a match or ignore directive are default rules, which are always defined at the end of any given ruleset, and specify what action should be taken if none of the predicates up to that point were satisfied.
(415) A ruleset may have any number of match or ignore rules, but must have at least a default match or a default ignore. A default match operates as a whitelist: the Strategy will alert on all cases, unless the behavior event satisfied a previous ignore rule. A default ignore operates as a blacklist: the Strategy will not alert on any cases, unless the behavior event satisfied a previous match rule.
(416) If a Strategy has multiple rules, all rules are evaluated in order beginning from the top of the list. If the rule predicate evaluates to true on a certain behavior event, further evaluation for that event stops and the Strategy either raises an alert (if it was a match rule) or ignores (if it was an ignore rule). Otherwise the Strategy proceeds to evaluation of the following rule, until it reaches the default match or the default ignore at the end of the ruleset.
(417) ii. Predicates
(418) A predicate may be constructed from operations on valid event fields of each policy, or from operations on other predicates. Predicate operations on event fields take two operands: the field name and a value to be checked against. The value may be a literal (e.g., string, int) or a list.
(419) iii. Valid Event Fields
(420) Each policy type has valid Event fields on which to filter behavioral Events.
(421) iv. Examples
(422) The following ruleset will alert on every event:
(423) rules: default match
(424) The following ruleset will not alert on any event:
(425) rules: default ignore
(426) The following two rulesets are equivalent:
(427) rules: ignore containerName “test-container” default match
(428) rules: match containerName !=“test-container” default ignore
(429) These rules will raise an alert on every event except those where containerName is test-container (equivalent to whitelisting test-container). The following is an example of nested rules:
(430) rules: ignore programName “/foo/bar/*” match programName “/foo/*” default ignore
(431) These rules effectively blacklist the directory /foo/, except for the subdirectory /foo/bar/ within it. To match all containers whose names start with “gcp” and end with “_Europe”:
(432) rules: match containerName like {circumflex over ( )}gcp.*_Europe$ default ignore
(433) To match all containers except those whose names start with “gcp” and end with “_Europe”,
(434) rules: match containerName not_like {circumflex over ( )}gcp.*_Europe$ default ignore
(435) 3. Alerts
(436) The following is a sample Alert, generated by a strategy which alerts on execution of newly created files:
(437) TABLE-US-00031 { “timestamp”: “2018-10-03T15:31:41.849692582Z”, “scope”: “PROCESS”, “priority”: “HIGH”, “confidence”: 1, “notifications”: [ { “timestamp”: “2018-10-03T15:31:41.849692582Z”, “name”: “NewFilesShouldNeverBeExecdByNginx”, “uuid”: “806d2e1b-ba46-453e-9458-d441a685d9e6”, “message”: “The program \“/usr/bin/nginx\” with PID 850174 in container \“/k8s_capsule8- server_capsule8-server-85b5dc8568-86c88_ default_d8ee4a59-c35e-11e8-abbe- 42010a800037_0\” executed newly created file \“./ privesc.sh\”. This action matched the \“match parentProgramName == /usr/bin/nginx\“ policy rule (where parentProgramName (/usr/bin/nginx) == /usr/bin/nginx).” } ], “matched_rule”: “match parentProgramName == /usr/bin/nginx”, “matched_objects”: [ { “matched_field”: “parentProgramName”, “matched_value”: “/usr/bin/nginx”, “matched_pattern”: “/usr/bin/nginx”, “matched_description”: “” } ], “alert_group_id”: “”, “description”: “New File executed by web server”, “uuid”: “NewFilesShouldNeverBeExecdByNginx- c2c481cbe8370168041cc7ebf2dd5864fe- 25aa4abf6e4d4d66dce0bc03ed016d”, “location”: { “node_name”: “capsule8-sensor-4vfk7”, “container_id”: “f6e3e1da2878c27b35df874d486e701da- b5b3f4776c8b578cde89dcfc90e4760”, “container_name”: “/k8s_capsule8- server_capsule8-server-85b5dc8568-86c88_ default_d8ee4a59-c35e-11e8-abbe-42010a800037_0”, “image_id”: “14dbf0b16f71ae7736dbae04a023- f8212c912178c318511cb96f9c603b501478”, “image_name”: “us.gcr.io/testing- playground-214818/ capsule8-server@sha256:b521ea40d7cf311cc9f7bdfc- 01dd44f2b8542c88ef445ef9fec7487ed9caec12”, “sensor_id”: “7f61568de0df2240e20e7932781d782- ae72d9db128f3ce826fd7bb59c1e25db4” }, “process_info”: { “pid”: 873136, “ppid”: 850174, “pid_uuid”: “5900db11-aab6-481c-b8cc- fc6fa5a3b76a-873136-3005012116940388”, “name”: “./privesc.sh”, “args”: [ “./privesc.sh” ], “children”: null, “parent”: null, “cwd”: “”, “uid”: 0, “gid”: 0, “euid”: 100, “egid”: 65533, “suid”: 0, “sgid”: 1131636068, “fsuid”: 100, “fsgid”: 65533 }, “strategy_name”: “NewFilesShould- NeverBeExecdByNginx”, “policy_type”: “newFileExec”, “metadata”: { “arch”: “x86_64”, “container_runtime”: “not-found”, “in_container”: “false”, “kernel_release”: “4.4.0-134-generic”, “kernel_version”: “#160-Ubuntu SMP Wed Aug 15 14:58:00 UTC 2018”, “network_interface_br-aa43deac176c_ flags”: “up|broadcast|multicast”, “network_interface_br-aa43deac176c_ hardware_addr”: “02:42:26:50:f3:47” “network_interface_br-aa43deac176c_index”: “4”, “network_interface_br-aa43deac176c_mtu”: “1500”, “network_interface_docker0_flags”: “up|broadcast|multicast”, “network_interface_docker0_hardware_ addr”: “02:42:1b:7a:8e:6e”, “network_interface_docker0_index”: “3”, “network_interface_docker0_mtu”: “1500”, “network_interface_enp0s3_flags”: “up|broadcast|multicast”, “network_interface_enp0s3_hardware_addr”: “02:fe:a1:ea:7d:d1”, “network_interface_enp0s3_index”: “2”, “network_interface_enp0s3_mtu”: “1500”, “network_interface_lo_flags”: “up|loopback”, “network_interface_lo_index”: “1”, “network_interface_lo_mtu”: “65536”, “network_interface_vethc468d59_flags”: “up|broadcast|multicast”, “network_interface_vethc468d59_ hardware_addr”: “ca:de:c2:f7:27:79”, “network_interface_vethc468d59_index”: “17576”, “network_interface_vethc468d59_mtu”: “1500”, “node_hostname”: “ubuntu-xenial”, “starttime”: “2018-10-18T19:22:13.620487107Z”, “uname_hostname”: “ubuntu-xenial”, “uname_os”: “Linux” } }
(438) The Strategy deployed to create an Alert on the above activity is shown below:
(439) NewFilesShouldNeverBeExecdByNginx:
(440) alertMessage: New File executed by web server comments: New files should never be executed by a web server, this indicated potential compromise through a web shell enabled: true fileTimeout: 30 policy: newFileExec priority: High rules: match parentProgramName==/usr/bin/nginx default ignore
(441) Upon detecting an attack or policy violation, Strategies generate output in the form of Alerts. Alerts can be grouped together by Strategies based on properties of interest (e.g., in case they belong to the same node or Process Tree).
(442) a. Scope
(443) The scope is intended to identify the “blast radius” of an attack, which aims to act as guidance for the amount of remediation or forensic response required. For example, if the Alert scope is “container,” it indicates that other containers on the same host are not affected, and so a response action could be as simple as destroying the offending container. Another example is if the scope is “process,” the impact is scoped to a single process, and killing that process would mitigate the attack or policy violation. In the case of a Strategy detecting kernel-level exploitation, the scope will be “node,” indicating that the entire node should be distrusted (where an appropriate response might be to bring the node offline).
(444) b. Location
(445) The Alert location describes the most specific entity that produced the Alert. Note that locations are container-aware and as such may have empty values for container/image when not in a containerized environment. For example, not all of the location fields will be present for alerts relating to kernel attacks, as those attacks apply to the node (existing outside of the container) and thus do not have corresponding container information.
(446) TABLE-US-00032 Field Description sensor_id The ID of the Sensor running on the node responsible for the events described in the Alert container_ The ID of the container id responsible for the events described in the alert container_ The name of the name container described by container_id image_id The ID of the container image for the container described by container_id image_ The name of the image name described by the image_id
(447) c. Process Information
(448) The process_info field describes the process and any parent processes of the process that generated the Alert. It is used as a further refinement of the Alert location and allows for further context to be included as part of the Alert. As with Alert location, note that the process_info fields will not be present for Alerts for which there is no associated process.
(449) TABLE-US-00033 Field Description pid The process ID ppid The parent process ID pid_uuid Unique process identifier; as PIDs can be reused, this identifier uniquely describes a process instance name The program running in the process at time of Alert args Program arguments of the process this Alert occurred in children Child processes of the process parent Parent process of this process cwd Current working directory of this process uid User ID of the task/thread gid Group ID of the task/thread euid Effective user ID of the task/thread egid Effective group ID of the task/thread suid Set user ID of the task/thread sgid Set group ID of the task/thread fsuid File system user ID of the task/thread fsgid File system group ID of the task/thread
(450) d. Notifications
(451) In Analytics framework 400, multiple pieces of the system may modify or take actions related to a specific Alert. To accommodate this, the Alert format contains a notifications field to allow for updates to a specific Alert. At a minimum there is always one notification from the strategy that created the Alert. The information in the notifications field contains more detailed information about what action was taken and when. In the case of Strategies this is the initial reason that an Alert was created.
(452) Example notifications subfields include:
(453) TABLE-US-00034 Field Description timestamp notification-specific Unix timestamp in nanoseconds, generated by protect at time of notification creation name name of the notification (commonly the name of the strategy) uuid notification-specific unique identifier message the message text of the notification, most commonly for describing the specific details of an alert
(454) 4. Caveats
(455) a. YAML Special Characters
(456) Since configuration for Strategies follows the YAML specification, an assumption can be made that any characters with a special YAML functionality will be escaped with quotes whenever they are to be used in list or Strategy definitions. For instance, the following path list will result in an error, since, according to the YAML specification, *x is used as a reference, and the YAML parser will look for the appropriate anchor.
(457) FailingList:
(458) type: paths
(459) description: this fails since x is treated as a reference to an anchor
(460) list:
(461) *x
(462) Thus, if *x is to act as a wildcard for any path ending in x, the respective entry in the list should be “*x”. The same principle applies to the following: Any of the characters :, {,}, [,], &, *, #, ?, |, -, <, >, =, !, %, @, ′ Any of the control characters \0, \x01, \x02, \x03, \x04, \x05, \x06, \a, \b, \t, \n, \v, \f, \r, \x0e, \x0f, \x10, \x11, \x12, \x13, \x14, \x15, \x16, \x17, \x18, \x19, \x1a, \e, \x1c, \x1d, \x1e, \x1f, \N, \L, \P The strings true and false Null and ˜
(463) In the same spirit, attention should be given to strings that could be parsed as numbers (e.g., 12e7, 3.4) and vice-versa, or strings that could be parsed as dates (2018 Jan. 8).
(464) b. Regular Expression Matching
(465) Path comparisons follow the glob format. However, advanced cases requiring regular expression matching can be used using the like and not like operators.
(466) Regular expressions used in the filter rules match the POSIX ERE (egrep) syntax and the match semantics follow the leftmost-longest convention. That is, when matching against text, the regexp returns a match that begins as early as possible in the input (leftmost), and among those it chooses a match that is as long as possible. There can be multiple leftmost-longest matches, with different submatch choices: among the possible leftmost-longest matches, in various embodiments, the one that a backtracking search would have found first is selected, per Golang's POSIX-compliant regular expression matching.
(467) C. Strategy Telemetry Collection Map
(468) 1. Introduction
(469) This section describes example data collected by Strategies and can be used to identify which Strategies may result in a higher rate of data collection (and thus also additional processing time/resource requirements) based on different workload types.
(470) The Sensor employs multiple methods of telemetry collection from different data sources based on data-source availability, which is usually dependent on kernel version and build options. The primary mechanisms used for telemetry collection are: Tracepoints: data-collection taps built into various kernel subsystems. Kprobes: on-demand collection “hooks” capable of being placed on almost any of the exported kernel symbols, and can be set to collect data on function entry or on function return, which are called Kretprobes. Kprobes allow for basic filters to be set to limit collection to occur only when the conditions of the filter match. Perf Counters: these are the hardware-enabled performance counters, accessed through the perf subsystem. Specifically, the performance counters for cache fetch and cache miss are used for detecting side-channel attacks.
(471) In various embodiments, the Sensor attempts to use the highest performing and modern collection mechanisms whenever possible, falling back on using older or less well performing data sources in the presence of less equipped kernels or unsupported mechanisms. For example, Tracepoints are used instead of Kretprobes to collect return-values from syscalls; however, Kretprobes must often be used for collecting other (non-syscall) return-values where Tracepoint support is not available.
(472) One approach attackers often use when attempting to compromise a server (e.g., workload instance 102 or legacy system 106) is to exploit the server's kernel. One such technique is to disable Supervisor Mode Execution Prevention (SMEP) and/or Supervisor Mode Access Prevention (SMAP) by modifying the corresponding bit in the CR4 control register. Another such technique is, on servers protected with SELinux and/or AppArmor, for attackers to attempt to disable those protection modules. Yet another technique attackers use is to call sensitive kernel functions with a return-address in userland. Another technique includes accessing/reaching internal kernel functions or states without the requisite predecessor functions or states having taken place. An example is the behavior of calling a sensitive internal kernel function used to modify a process's privileges, which was not first preceded by calling the functions which determine if such authorization is granted. An analogy is that under normal circumstances, one should never observe a bank vault door opening if no one is signed into the bank/if no one has used the front door to first get inside the bank (as is the normal route). Each of these types of attacks, and similar types of attacks, can be detected by embodiments of analytics framework 400.
(473)
(474) 2. Internal Sensor Telemetry Collection
(475) By default, the Sensor collects a set of limited telemetry to establish a core capability of system monitoring focused on processes and containers; this collection is independent of any externally requested or strategy-defined subscriptions. The sources for this data vary depending on kernel version and availability.
(476) 3. Strategy Telemetry Subscriptions
(477) This section details example telemetry collected by various Strategies.
(478) a. Ptrace Strategy
(479) The Ptrace Strategy produces an alert when ptrace (or ptrace-related) functions are used in a non-whitelisted process. Ptrace is intended to provide debugging facilities on Linux, but can be used as a means of stealthy lateral movement between processes, such as in injecting malicious code into services such as SSH. This use of ptrace functions also serves as a signal that someone is using debugging functionality, which may violate production-environment policies.
(480) Kprobes: sys_ptrace, sys_process_vm_writev
(481) Tracepoint (return): sys_ptrace
(482) b. Memory Protection Strategy
(483) The Memory Protection Strategy provides monitoring for attempts to exploit memory-mismanagement software vulnerabilities. Attempts to exploit these vulnerabilities to execute arbitrary code (also known as shellcode) commonly involve a step to modify the permissions on memory containing attacker-controlled data, so that the attacker-controlled data can be executed as program code.
(484) Kprobes: sys_mprotect, sys_brk, sys_sigaltstack, expand_stack
(485) Kretprobes: arch_align_stack
(486) Tracepoint (return): sys_mprotect, sys_brk
(487) c. Stack Pivot Strategy
(488) The stack pivot detection Strategy examines the stack pointer on certain syscalls and ensures that it is within normal stack bounds. Having a stack pointer reference an address outside the bounds of the stack is normally indicative of a stack pivot as part of an exploit chain.
(489) Kprobes: sys_execve, sys_mprotect, sys_sigaltstack, expand_stack
(490) Kretprobes: arch_align_stack
(491) d. New File Exec
(492) The new file exec Strategy watches for execution of newly created files by non-whitelisted programs and if such created files are executed within the configured timeout.
(493) Kprobes: sys_execve, do_sys_open with a filter for O_CREAT
(494) e. Privilege Escalation
(495) The Privilege Escalation Strategy monitors for privilege escalation attacks that overwrite process privileges without going through a setuid or setgid call.
(496) Kprobes: sys_setuid, sys_setgid, sys_setreuid, sys_setregid, sys_setresuid, sys_setresgid, commit_creds, install_exec_creds
(497) Kretprobes: install_exec_creds
(498) Tracepoint (return): sys_setuid, sys_setgid, sys_setreuid, sys_setregid, sys_setresuid, sys_setresgid
(499) f. Sendto Blacklist/Whitelist
(500) The connection blacklist and whitelist strategies monitor calls to sendto( ) and sendmsg( ) (most commonly UDP) and compare the destination host to its configured blacklists or whitelists.
(501) Kprobes: sys_sendto, sys_sendmsg
(502) Tracepoint (return): sys_sendto, sys_sendmsg
(503) g. Connect Blacklist/Whitelist
(504) The connection blacklist and whitelist Strategies monitor calls to connect( ) (most commonly TCP) and compare the destination host to its configured blacklists or whitelists.
(505) Kprobes: sys_connect
(506) Tracepoint (return): sys_connect
(507) h. Program Blacklist/Whitelist
(508) The program execution blacklist and whitelist Strategies monitor program execution and compare the program name to its configured blacklists or whitelists.
(509) Kprobes: sys_execve
(510) i. Interactive Shell
(511) The Interactive Shell Strategy observes the execution of shell programs (such as /bin/sh, /bin/bash, etc.) and monitors for activity indicative of shell interactivity (vs being used to run a shell script, for example).
(512) Kprobes: sys_execve, sys_ioctl with FD=2 or FD=10
(513) j. Remote Interactive Shell
(514) The Remote Interactive Shell Strategy is similar to the functionality of the Interactive Shell Strategy, but specifically monitors for interactive shells processing input/output from a network connection, such as the behavior exhibited by exploit payloads using mechanisms like bash's /dev/tcp to connect back to an attacker's machine.
(515) Kprobes: sys_execve, sys_dup, sys_dup2, sys_dup3, sys_bind, sys_connect, sys_ioctl with FD=2 or FD=10
(516) Tracepoint: sys_accept, sys_accept4
(517) Tracepoint (return): sys_dup, sys_dup2, sys_dup3, sys_accept, sys_accept4, sys_connect, sys_bind
(518) k. Kernel Payload
(519) The kernel payload Strategy observes sensitive kernel functions, to determine if a function is being called with a return-address in userland.
(520) Kprobes: prepare_creds, prepare_kernel_cred
(521) 1. SMEP/SMAP
(522) The SMEP/SMAP Strategy monitors a function used to set the CR4 register, which is inlined in its legitimate uses, but still exported as a symbol, and which has become a popular target for disabling SMEP/SMAP.
(523) Kprobes: native_write_cr4
(524) m. SELinux & AppArmor
(525) These two Strategies scan kernel memory to determine if these mechanisms have been disabled (if the strategies were configured to expect that these security mechanisms were on). The scanning of kernel memory for these strategies is done by a kprobe which is triggered by a specific syscall, which the sensor triggers periodically.
(526) Kprobes: sys_uname with filter for a magic cookie value as the function argument
(527) n. Kernel Module Loading
(528) The kernel module load Strategy allows whitelisting of which kernel modules can be loaded.
(529) Kprobes: do_init_module
(530) o. Spectre/Meltdown
(531) The Spectre/Meltdown strategy employs performance counters to detect side-channel attacks by examining cache fetch and cache miss ratios.
(532) PerfCounters: PerfEvent CacheReferences, PerfEvent CacheMiss, PerfEvent BranchMisses
(533) D. Strategy Examples
(534) 1. General Policies
(535) a. File Policy (policy identifier: file)
(536) Valid filter rule fields for this policy are listed below:
(537) TABLE-US-00035 Type Description containerId names containerName names sensorId names imageId names imageName names filePath paths programName paths
(538) Description: This Strategy monitors calls to create files and generates Alerts for creation of file names in disallowed locations. An example configuration is presented below:
(539) File Policy Example: policy: file enabled: true alertMessage: Blacklisted File Created comments: Example strategy using the file policy priority: High rules: match filePath in $filepathlist default ignore timeout: 10
FilePathList: type: paths list: /*/trustme:“example”
(540) A sample generated Alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(541) TABLE-US-00036 { “alert_group_id”: “”, “confidence”: “Max”, “description”: “Blacklisted File Created”, “location”: { “container_id”: “9873918fad6ce45d2f84f76b0e61d2bf- 789fe6cda74b24184918133c3a32863”, “container_name”: “/test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e- 7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “TEST_IMAGE”, “node_name”: “”, “sensor_id”: “0d76a2a9ede1bc3df805d- 26e90501af54b11eabe180e963c56d27f065d9243f4” }, “matched_objects”: null, “matched_rule”: “”, “metadata”: null, “notifications”: [ { “message”: “The program \“/usr/bin/ trustme\” with PID 1001 in container \“/test- container\” created the file \“/usr/bin/trustme\”. This action matched the \“match filePath in $filepathlist\” policy rule (where filePath (/usr/bin/trustme) in /*/trustme (pattern description: example)).”, “name”: “File Policy Example”, “timestamp”: 1509474507990963973, “uuid”: “ZZZ” } ], “policy_type”: “”, “priority”: “High”, “process_info”: { “args”: [], “children”: null, “cwd”: “”, “egid”: 15, “euid”: 12, “fsgid”: 15, “fsuid”: 12, “gid”: 15, “name”: “/usr/bin/trustme”, “parent”: null, “pid”: 1001, “pid_uuid”: “/usr/bin/trustme-YYY”, “ppid”: 0, “sgid”: 15, “suid”: 12, “uid”: 12 }, “scope”: “Process”, “strategy_name”: “File Policy Example”, “timestamp”: 1509474507990963973, “uuid”: “File Policy Example-XXX” }
(542) b. PTrace Policy (Policy Identifier: Ptrace)
(543) Valid filter rule fields for this policy are listed below:
(544) TABLE-US-00037 Type Description containerId names containerName names sensorId names imageId names imageName names programName paths parentProgramName paths
(545) Description: This Strategy triggers an Alert if ptrace policy is violated by a non-whitelisted program. An example configuration is presented below:
(546) Ptrace Policy Example: policy: ptrace enabled: true alertMessage: Ptrace Invoked comments: Example strategy using the ptrace policy priority: High rules: ignore programName==/tmp/safe/* default match
(547) A sample generated Alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(548) TABLE-US-00038 { “alert_group_id”: “”, “confidence”: “Max”, “description”: “Ptrace Invoked”, “location”: { “container_id”: “98e73918fad6ce45d2f84f76b0e61d2- bf789fe6cda74b24184918133c3a32863”, “container_name”: “/test-container”, “image_id”: “7328f6f8b41890597575cbaadc884e- 7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “TEST_IMAGE”, “node_name”: “”, “sensor_id”: “0d76a2a9ede1bc3df805d26e9050- 1af54b11eabe180e963c56d27f065d9243f4” }, “matched_objects”: null, “matched_rule″: “”, “metadata”: null, “notifications”: [ { “message”: “The program \“/usr/bin/trustme\” with PID 1001 in container \“/test- container\” attempted to write memory in the process with PID 10032. This action matched the \“default match\” policy rule.”, “name”: “testPtracePolicy1”, “timestamp”: 1509474507990963973, “uuid”: “ZZZ” } ], “policy_type”: “”, “priority”: “High”, “process_info”: { “args”: [], “children”: null, “cwd”: “”, “egid”: 15, “euid”: 12, “fsgid”: 15, “fsuid”: 12, “gid”: 15, “name”: “/usr/bin/trustme”, “parent”: null, “pid”: 1001, “pid_uuid”: “YYY”, “ppid”: 0, “sgid”: 15, “suid”: 12, “uid”: 12 }, “scope”: “Process”, “strategy_name”: “Ptrace Policy Example”, “timestamp”: 1509474507990963973, “uuid”: “XXX” }
(549) c. Permissions Modification Policy (Policy Identifier: chmod)
(550) Valid filter rule fields for this policy are listed below:
(551) TABLE-US-00039 Type Description containerId names containerName names sensorId names imageId names imageName names filePath paths fileMode — programName paths
(552) Additional configuration options for this policy are listed below:
(553) TABLE-US-00040 Config- uration Option Type Default Description suid bool True Alert if set-user-id set sgid bool False Alert if set-group- id set svtx bool False Alert if sticky bit set rusr bool False Alert if read by owner set wusr bool False Alert if write by owner set xusr bool False Alert if execute/ search by owner (search for directories) set rgrp bool False Alert if read by group set wgrp bool False Alert if write by group set xgrp bool False Alert if execute/ search by group set roth bool False Alert if read by others set woth bool False Alert if write by others set xoth bool False Alert if execute/ search by others set
(554) Description: This Strategy produces an Alert if a permission change matching the rules set occurs. An example configuration is presented below:
(555) Permissions Modification Policy Example: policy: chmod enabled: true alertMessage: Permissions Modification Strategy Fired comments: Example strategy using the chmod policy priority: High rules: ignore programName==/tmp/safe/* default match suid: true sgid: false svtx: false rusr: false wusr: false xusr: false rgrp: false wgrp: false xgrp: false roth: false woth: false xoth: false
(556) A sample generated Alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(557) TABLE-US-00041 { “confidence”: “Max”, “description”: “Permissions Modification Strategy Fired”, “location”: { “container_id”: “4cb5b14f2f6b8e02a3e57188e230d140f2- a8880d236a5f21face723678a2c50a”, “container_name”: “test-container”, “image_id”: “7328f6f8b41890597575cbaadc- 884e7386ae0acc53b747401ebce5cf0d624560”, “image_name”: “alpine:3.6”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501af54- b11eabe180e963c56d27f065d9243f4” }, “notifications”: [ { “actor_uuid”: “3ad2bfe3-8665- 4d6b-a2d6-60238b05d02e”, “message”: “Permissions Modification Strategy Fired for \“testfile\”. New permissions: 4000 (suid). This action matched the \“default match\” policy rule.”, “name”: “Permissions Modification Policy Example”, “timestamp”: 12434343435 } ], “priority”: “High”, “process_info”: { “args”: [], “name”: “”, “pid”: 22059, “pid_uuid”: “080a6767-9f37- 4d70-b00d-015a9edf9099”, “ppid”: 0 }, “scope”: “Process”, “strategy_name”: “Permissions Modification Policy Example”, “timestamp”: 134334343, “uuid”: “Permissions-Modification-Policy-Example-” }
(558) d. Program Policy (Policy Identifier: Program)
(559) Valid filter rule fields for this policy are listed below:
(560) TABLE-US-00042 Type Description containerId names containerName names sensorId names imageId names imageName names programName paths parentProgramName paths
(561) Description: This Strategy monitors program execution and compares the program name to its configured filters. It generates Alerts when a program matches an entry in one of the configured filters. An example configuration is presented below:
(562) Program Policy Example: policy: program enabled: true alertMessage: Unauthorized Program Executed comments: Example strategy using the program policy priority: High rules: default match
(563) A sample generated Alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(564) TABLE-US-00043 { “alert_group_id”: “”, “confidence”: “Max”, “description”: “Unauthorized Program Executed”, “location”: { “container_id”: “N/A”, “container_name”: “N/A”, “image_id”: “N/A”, “image_name”: “N/A”, “node_name”: “”, “sensor_id”: “0d76a2a9ede1bc3df805d26e90501- af54b11eabe180e963c56d27f065d9243f4” }, “matched_objects”: null, “matched_rule”: “”, “metadata”: null, “notifications”: [ { “message”: “The program (name unknown) with PID 0 executed the program \“/usr/bin/bash\”. This action matched the \“default match\” policy rule.”, “name”: “testProgramPolicy1”, “timestamp”: 1509474507990963973, “uuid”: “ZZZ” } ], “policy_type”: “”, “priority”: “High”, “process_info”: { “args”: [], “children”: null, “cwd”: “”, “egid”: 15, “euid”: 12, “fsgid”: 15, “fsuid”: 12, “gid”: 15, “name”: “/usr/bin/bash”, “parent”: null, “pid”: 1001, “pid_uuid”: “YYY/usr/bin/bash”, “ppid”: 0, “sgid”: 15, “suid”: 12, “uid”: 12 }, “scope”: “Process”, “strategy_name”: “Program Policy Example”, “timestamp”: 1509474507990963973, “uuid”: “XXX” }
(565) e. Sendto Policy (policy identifier: sendto)
(566) Valid filter rule fields for this policy are listed below:
(567) TABLE-US-00044 Type Description containerId names containerName names sensorId names imageId names imageName names remoteHost host outboundPort numbers programName paths
(568) Description: This Strategy provides network-level IP-based policy monitoring for TCP connections, comparing the destination IP of outbound TCP connections against its configured filters. An example configuration is presented below:
(569) SendTo Example Policy: policy: sendto enabled: true alertMessage: Sendto Blacklist Alert comments: Example strategy using the sendto policy priority: High rules: default match
(570) A sample generated Alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(571) TABLE-US-00045 { ″alert_group_id″: ″confidence″: ″Max″, ″description″: ″Sendto Blacklist Alert″, ″location″: { ″container_id″: ″98e73918fad6ce45d2f84f76b0e61d2bf789fe6cda74b24184918133c3a32863″, ″container_name″: ″/test-container″, ″image_id″: ″7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560″, ″image_name″: ″TEST_IMAGE″, ″node_name″: ″″, ″sensor_id″: ″0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4″ }, ″matched_objects″: null, ″matched_rule″: ″″, ″metadata″: null, ″notifications″: [ { ″message″: ″The program (name unknown) with PID 1001 in container \″/test-container\″ communicated with 192.168.1.2 on UDP port 30030. This attempt was not successful. This action matched the \″default match\″ policy rule.″, ″name″: ″SendTo Example Policy″, ″timestamp″: 1509474507990963973, ″uuid″: ″ZZZ″ } ], ″policy_type″: ″″, ″priority″: ″High″, ″process_info″: { ″args″: [ ], ″children″: null, ″cwd″: ″″, ″egid″: 15, ″euid″: 12, ″fsgid″: 15, ″fsuid″: 12, ″gid″: 15, ″name″: ″″, ″parent″: null, ″pid″: 1001, ″pid_uuid″: ″YYY″, ″ppid″: 0, ″sgid″: 15, ″suid″: 12, ″uid″: 12 }, ″scope″: ″Process″, ″strategy_name″: ″SendTo Example Policy″ ″timestamp″: 1509474507990963973, ″uuid″: ″XXX″ }
(572) f. Sensor Timeout Policy (policy identifier: sensorTimeout)
(573) Valid filter rule fields for this policy are listed below:
(574) TABLE-US-00046 Type Description containerId names containerName names sensorId names imageId names imageName names
(575) Configuration options for this policy are listed below:
(576) TABLE-US-00047 Configuration Option Type Default Description timeout int 1 Minutes since last event from the sensor was received
(577) Description: This Strategy sends an Alert on sensor timeout. An example configuration is presented below:
(578) Sensor Timeout Example Policy: policy: sensorTimeout enabled: true alertMessage: Sensor Timeout Alert comments: Example strategy using the sensorTimeout policy priority: High rules: ignore sensorId==aabbccddeeff default match timeout: 20
(579) A sample generated alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(580) TABLE-US-00048 { ″alert_group_id″: ″″, ″confidence″: ″Max″, ″description″: ″Sensor Timeout Alert″ ″location″: { ″container_id″: ″test-container″, ″container_name″: ″test-container-name″, ″image_id″: ″test-image″, ″image_name″: ″test-image-name″, ″node_name″: ″″, ″sensor_id″: ″0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f06549243f4″ }, ″matched_objects″: null, ″matched_rule″: ″default match″, ″metadata″: null, ″notifications″: [ { ″message″: ″The sensor has not received any process telemetry in the past \u0014 minutes. This action matched the \″default match\″ policy rule.″, ″name″: ″Sensor Timeout Example Policy″, ″timestamp″: 1539804600351876590, ″uuid″: ″2a34c683-83e3-4653-97bc-4224b0baa757″ } ], ″policy_type″: ″sensorTimeout″, ″priority″: ″High″, ″process_info″: { ″args″: null, ″children″: null, ″cwd″: ″″, ″egid″: 0, ″euid″: 0, ″fsgid″: 0, ″fsuid″: 0, ″gid″: 0, ″name″: ″″, ″parent″: null, ″pid″: 0, ″pid_uuid″: ″″, ″ppid″: 0, ″sgid″: 0, ″suid″: 0, ″uid″: 0 }, ″scope″: ″Node″, ″strategy_name″: ″Sensor Timeout Example Policy″, ″timestamp″: 1539727643594264759, ″uuid″: ″Sensor-Timeout-Example-Policy-XXX″ }
(581) 2. Local Exploitation Policies
(582) a. BPF Protection Policy (policy identifier: bpfexec)
(583) Valid filter rule fields for this policy are listed below:
(584) TABLE-US-00049 Type Description containerId names containerName names sensorId names imageId names imageName names programName paths
(585) Description: This Strategy provides monitoring for attempts to call the BPF subsystem. An example configuration is presented below:
(586) BPF Example Policy: policy: bpfexec enabled: true comments: Example strategy using the bpf policy priority: Medium rules: ignore programName in $exampleWhitelist default match alertMessage: BPF was called
exampleWhitelist: type: paths list: /usr/share/bcc/tools/*: “bcc tools”
(587) A sample generated Alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(588) TABLE-US-00050 { ″alert_group_id″: ″″, ″confidence″: ″Max″, ″description″: ″BPF was called″, ″location″: { ″container_id″: ″N/A″, ″container_name″: ″N/A″, ″image_id″: ″N/A″, ″image_name″: ″N/A″, ″node_name″: ″″, ″sensor_id″: ″0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f06549243f4″ }, ″matched_objects″: null, ″matched_rule″: ″″, ″metadata″: null, ″notifications″: [ { ″message″: ″BPF was invoked! This action matched the \″default match\″ policy rule.″, ″name″: ″BPF″, ″timestamp″: 1509474507990963973, ″uuid″: ″ZZZ″ } ], ″policy_type″: ″″, ″priority″: ″Medium″, ″process_info″: { ″args″: [ ], ″children″: null, ″cwd″: ″/tmp/non-whitelisted program″, ″egid″: 0, ″euid″: 0, ″fsgid″: 0, ″fsuid″: 0, ″gid″: 0, ″name″: ″″, ″parent″: null, ″pid″: 0, ″pid_uuid″: ″394bd04468b541bdbe132a71de3671cb″, ″ppid″: 0, ″sgid″: 0, ″suid″: 0, ″uid″: 0 }, ″scope″: ″Process″, ″strategy_name″: ″BPF Example Policy″, ″timestamp″: 1509474507990963973, ″uuid″: ″XXX″ }
(589) 3. Local and Post-Exploitation Policies
(590) a. AppArmor Policy (policy identifier appArmor)
(591) Valid filter rule fields for this policy are listed below:
(592) TABLE-US-00051 Type Description containerId names containerName names sensorId names imageId names imageName names
(593) Additional configuration options for this policy are listed below:
(594) TABLE-US-00052 Configuration Option Type Default Description defaultAppArmorState bool False If true, any event that either disables AppArmor at startup or disables AppArmor enforcement will trigger an alert. If false, will only trigger alerts if whatever setting existed at startup is modified.
(595) Description: AppArmor is a Linux Security Module implementation and confines individual programs to a set of listed files and run-time capabilities. This Strategy will generate an alert if AppArmor settings are illegally modified. An example configuration is presented below:
(596) AppArmor Example Policy: policy: apparmor enabled: true alertMessage: AppArmor settings were modified! defaultAppArmorState: false comments: Example strategy using the apparmor policy priority: High rules: default match
(597) A sample generated Alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(598) TABLE-US-00053 { ″alert_group_id″: ″″, ″confidence″: ″Max″, ″description″: ″AppArmor settings were modified!″, ″location″: { ″container_id″: ″4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a″, ″container_name″: ″test-container″, ″image_id″: ″7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560″.sub., ″image_name″: ″alpine:3.6″, ″sensor_id″: ″0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4″ }, ″notifications″: [ { ″message″: ″The AppArmor security mechanism, which was previously enabled, has been disabled. This action matched the \″default match\″ policy rule.″, ″name″: ″AppArmor Example Policy″, ″timestamp″: 1536090770072590607, ″uuid″: ″7512f16f-9b3c-4b50-b53d-75d90d0f8468″ } ], ″priority″: ″High″, ″process_info″: { ″args″: null, ″children″: null, ″cwd″: ″″, ″egid″: 0, ″euid″: 0, ″fsgid″: 0, ″fsuid″: 0, ″gid″: 0, ″name″: ″″, ″parent″: null, ″pid″: 0, ″pid_uuid″: ″″, ″ppid″: 0, ″sgid″: 0, ″suid″: 0, ″uid″: 0 }, ″scope″: ″Node″, ″strategy_name″: ″AppArmor Example Policy″, ″timestamp″: 1536090770072588478, ″uuid″: ″Apparmor-Policy-Enabled-Sample-Config-cf30c7fd-c138-4957-bf87-6722afe5cd4a″ }
(599) b. Kernel Module Loading Policy (policy identifier: loadkernelmodule)
(600) Valid filter rule fields for this policy are listed below:
(601) TABLE-US-00054 Type Description containerId names containerName names sensorId names imageId names imageName names programName paths uid numbers gid numbers kernelModuleName names
(602) Description: This Strategy produces an Alert whenever a kernel module is loaded. An example configuration is presented below:
(603) Kernel Module Example Policy: policy: loadKernelModule enabled: true alertMessage: A kernel module was loaded comments: Example strategy using the loadKernelModule policy priority: Medium rules: default match
(604) A sample generated Alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(605) TABLE-US-00055 { ″confidence″: ″Max″, ″description″: ″A kernel module was loaded″, ″location″: { ″container_id″: ″4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a″, ″container_name″: ″test-container″, ″image_id″: ″7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560″.sub., ″image_name″: ″alpine:3.6″, ″sensor_id″: ″0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4″ }, ″notifications″: [ { ″actor_uuid″: ″3ad2bfe3-8665-4d6b-a2d6-60238b05d02e″, ″message″: ″Kernel Module \″sampleModule\″ was loaded. This action matched the \″default match\″ policy rule.″, ″name″: ″Kernel Module Example Policy″, ″timestamp″: 12434343435 } ], ″priority″: ″Medium″, ″process_info″: { ″args″: [ ], ″name″: ″″, ″pid″: 22059, ″pid_uuid″: ″080a6767-9f37-4d70-b00d-015a9edf9099″, ″ppid″: 0 }, ″scope″: ″Node″, ″strategy_name″: ″Kernel Module Example Policy″, ″timestamp″: 134334343, ″uuid″: ″4ba42670-4790-460e-b3cf-9f40ab3f197a″ }
(606) c. Kernel Payload Policy (policy identifier kernelPayload)
(607) Valid filter rule fields for this policy are listed below:
(608) TABLE-US-00056 Type Description containerId names containerName names sensorId names imageId names imageName names programName paths
(609) Additional configuration options for this policy are listed below:
(610) TABLE-US-00057 Configuration Option Type Default Description extraLargeMemory bool False Whether or not Systems hosts are using 5- level page tables
(611) Description: This Strategy detects when kernel functions commonly used by kernel-based exploits are called in unusual ways, in patterns that are unique to kernel exploitation. An example configuration is presented below:
(612) Kernel Payload Example Strategy: policy: kernelPayload enabled: true alertMessage: Kernel Exploitation comments: test strategy for the kernelPayload policy priority: High rules: default match extraLargeMemorySystems: false
(613) A sample generated alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(614) TABLE-US-00058 { ″alert_group_id″: ″″, ″confidence″: ″Max″, ″description″: ″Kernel Exploitation″, ″location″: { ″container_id″: ″N/A″, ″container_name″: ″N/A″, ″image_id″: ″N/A″, ″image_name″: ″N/A″, ″node_name″: ″″, ″sensor_id″: ″0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f06549243f4″ }, ″matched_objects″: null, ″matched_rule″: ″″, ″metadata″: null, ″notifications″: [ { ″message″: ″The kernel function prepare kernel cred with a return address in userland was invoked during the execution of the program \″/sbin/tcpping\″ with PID 1001. This action matched the \″default match\″ policy rule.″, ″name″: ″Kernel Payload Example Strategy″, ″timestamp″: 1509474507990963973, ″uuid″: ″ZZZ″ } ], ″policy_type″: ″″, ″priority″: ″High″, ″process_info″: { ″args″: [ ], ″children″: null, ″cwd″: ″″, ″egid″: 15, ″euid″: 12, ″fsgid″: 15, ″fsuid″: 12, ″gid″: 15, ″name″: ″/sbin/tcpping″, ″parent″: null, ″pid″: 1001, ″pid_uuid″: ″YYY″, ″ppid″: 0, ″sgid″: 15, ″suid″: 12, ″uid″: 12 }, ″scope″: ″Node″, ″strategy_name″: ″Kernel Payload Example Strategy″, ″timestamp″: 1509474507990963973, ″uuid″: ″XXX″ }
(615) d. Privilege Escalation Policy (policy identifier: privilegeEscalation)
(616) Valid filter rule fields for this policy are listed below:
(617) TABLE-US-00059 Type Description containerId names containerName names sensorId names imageId names imageName names
(618) Description: This Strategy monitors for privilege escalation attacks that overwrite process privileges without going through a setuid or setgid call. If there is an attempt to set a privilege to root without a matching open privilege-related syscall, the strategy raises an alert. An example configuration is presented below:
(619) Privilege Escalation Strategy: policy: privilegeEscalation enabled: true alertMessage: Privilege Escalation Attempt comments: Example strategy using the privilegeEscalation policy priority: High rules: default match
(620) A sample generated Alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(621) TABLE-US-00060 { ″alert_group_id″: ″confidence″: ″Max″, ″description″: ″Privilege Escalation Alert″, ″location″: { ″container_id″: ″4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a″, ″container name″: ″test-container″, ″image_id″: ″7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560″.sub.: ″image_name″: ″alpine:3.6″, ″node_name″: ″sensor_id″: ″0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4″ }, ″notifications″: [ { ″message″: ″A privilege escalation exploit was detected in unknown program with PID 12 in container \″test-container\″. This action matched the ″default match\″ policy rule.″, ″name″: ″Privilege Escalation Strategy″, ″timestamp″: 1536602201654990745, ″uuid″: ″3ebf360f-f915-4422-afc1-3e7561779b5c″ } ], ″priority″: ″High″, ″process_info″: { ″args″: [ ″no open syscall for attempted set of uid, no open syscall for attempted set of gid, ″ ], ″children″: null, ″cwd″: ″egid″: 0, ″euid″: 1000, ″fsgid″: 0, ″fsuid″: 0, ″gid″: 1000, ″name″: ″parent″: null, ″pid″: 12, ″pid_uuid″: ″394bd04468b541bdbe132a71de3671cb″, ″ppid″: 0, ″sgid″: 1000, ″suid″: 1000, ″uid″: 0 }, ″scope″: ″Process″, ″strategy_name″: ″Privilege Escalation Strategy″, ″timestamp″: 1536602201654985695, ″uuid″: ″Privilege-Escalation-Strategy-″ }
(622) e. Resource Limit Policy (policy identifier: setrlimit)
(623) Valid filter rule fields for this policy are listed below:
(624) TABLE-US-00061 Type Description containerId names containerName names sensorId names imageId names imageName names parentProgramName paths programName paths
(625) Description: This Strategy alerts when a process's resource limits are set to an unusually high value (for example, an unlimited stack size). This operation is performed by some exploits and may indicate an attempted privilege escalation exploit. This Strategy can be triggered by the “make” program. As such, it is recommended to include “ignore programName /usr/*make” in the rules for this strategy to reduce false positives, or to disable this strategy on hosts that regularly perform software builds. An example configuration is presented below:
(626) SetRlimit Example Policy: policy: setrlimit enabled: true alertMessage: Resource Limit Policy comments: Example strategy using the setrlimit policy priority: Low rules: default match
(627) A sample generated Alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(628) TABLE-US-00062 { ″alert_group_id″: ″confidence″: ″Max″, ″description″: ″Resource Limit Policy″, ″location″: { ″container_id″: ″9873918fad6ce45d2f84f76b0e61d2bf789fe6cda74b24184918133c3a32863″, ″container_name″: ″/test-container″, ″image_id″: ″7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560″, ″image_name″: ″TEST IMAGE″, ″node_name″: ″sensor_id″: ″0d76a2a9edelbc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4″ }, ″matched_objects″: null, ″matched_rule″: ″metadata″: null, ″notifications″: [ { ″message″: ″The program \″/tmp/badprog\″ with PID 1001 in container \″/test-container\″ has increased its resource limits. This may be performed as part of an exploitation attempt. This action matched the ″default match\″ policy rule.″, ″name″: ″ResourceLimits″, ″timestamp″: 1509474507990963973, ″uuid″: ″ZZZ″ } ], ″policy_type″: ″priority″: ″Low″, ″process_info″: { ″args″: [ ], ″children″: null, ″cwd″: ″″, ″egid″: 15, ″euid″: 12, ″fsgid″: 15, ″fsuid″: 12, ″gid″: 15, ″name″: ″/tmp/badprog″, ″parent″: null, ″pid″: 1001, ″pid uuid″: ″YYY″, ″ppid″: 0, ″sgid″: 15, ″suid″: 12, ″uid″: 12 }, ″scope″: ″Process″, ″strategy_name″: ″SetRlimit Example Policy″ ″timestamp″: 1509474507990963973, ″uuid″: ″XXX″ }
(629) f. SELinux Policy (policy identifier: selinux)
(630) Valid filter rule fields for this policy are listed below:
(631) TABLE-US-00063 Type Description containerId names containerName names sensorId names imageId names imageName names
(632) Additional configuration options for this policy are listed below:
(633) TABLE-US-00064 Configuration Option Type Default Description default bool False If true, any event that either disables SELinux at startup or disables SELinux enforcement will trigger an alert. If false, will only trigger alerts if whatever setting existed at startup is modified.
(634) Description: Security-Enhanced Linux (SELinux) is a Linux kernel security module that provides a mechanism for supporting access control security policies. This Strategy will generate an Alert if a kernel exploit illegally modified the SELinux settings. An example configuration is presented below:
(635) SELinux Example Strategy: policy: selinux enabled: true alertMessage: SELinux Disabled comments: Example strategy using the selinux policy priority: High rules: ignore sensorId==aabbccddeeff default match default: false
(636) A sample generated Alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(637) TABLE-US-00065 { ″confidence″: ″Max″, ″description″: ″SELinuxDisabled″, ″location″: { ″container_id″: ″4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a″, ″container_name″: ″test-container″, ″image_id″: ″7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560″, ″image_name″: ″alpine:3.6″, ″sensor_id″: ″0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4″ }, ″notifications″: [ { ″actor_uuid″: ″6f4d23d6-686b-4bf6-9401-86d339485f6a″, ″message″: ″The SELinux security mechanism, which was previously enabled, has been disabled. This action matched the ″default match\″ policy rule.″, ″name″: ″SELinuxDisabled″, ″timestamp″: 1535569121667980508 } ], ″priority″: ″High″, ″scope″: ″Node″, ″ strategy _name″: ″SELinux Example Strategy″, ″timestamp″: 1535569121667976757, ″uuid″: ″Example-SELinux″ }
(638) g. SMEP/SMAP Policy (policy identifier: smepSmap)
(639) Valid filter rule fields for this policy are listed below:
(640) TABLE-US-00066 Type Description sensorId names
(641) Description: The SMEP SMAP Strategy monitors for kernel exploitation attempts which involve disabling specific kernel memory protection mechanisms (as is common in kernel-based local-privilege-escalation exploits). The Supervisor-Mode-Execution-Prevention (SMEP) and Supervisor-Mode-Access-Prevention (SMAP) are mechanisms on modern CPUs to protect the kernel from exploitation techniques involving userland memory. This Strategy alerts on detection of kernel behavior disabling these protection mechanisms. An example configuration is presented below:
(642) SMEP SMAP Policy: policy: smepSmap enabled: true alertMessage: SMEP/SMAP was disabled comments: Example strategy using the smepSmap policy priority: High rules: ignore sensorId==aabbccddeeff default match
(643) A sample generated Alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(644) TABLE-US-00067 { ″confidence″: ″Max″, ″description″: ″SMEP/SMAP was disabled″, ″location″: { ″container_id″: ″4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a″ ″container_name″: ″test-container″, ″image_id″: ″7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560″ ″image_name″: ″alpine:3.6″, ″sensor_id″: ″0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f06549243f4″ }, ″notifications″: [ { ″message″: ″The SMEP/SMAP security mechanism, which was previously enabled, has been disabled. This action matched the ″default match\″ policy rule.″, ″name″: ″SMEP/SMAP was disabled″, ″timestamp″: 1535569121667980508, ″uuid″: ″6f4d23d6-686b-4bf6-9401-86d339485f6a″ } ], ″priority″: ″High″, ″scope″: ″Node″, ″ strategy _name″: ″SMEP SMAP Policy″, ″timestamp″: 1535569121667976758, ″uuid″: ″Default-SmepSmap-Config-Example″ }
(645) h. Set Privilege Policy (policy identifier: setPrivilege)
(646) Valid filter rule fields for this policy are listed below:
(647) TABLE-US-00068 Type Description containerId names containerName names sensorId names imageId names imageName names programName paths parentProgramName paths uid numbers targetuid — targeteuid — targetsuid — targetfsuid — gid numbers targetgid — targetegid — targetsgid — targetfsgid —
(648) Additional configuration options for this policy are listed below:
(649) TABLE-US-00069 Configuration Option Type Default Description setuid bool True Alert if setuid is called setreuid bool True Alert if setreuid is called setresuid bool True Alert if setresuid is called setfsuid bool True Alert if setfsuid is called setgid bool True Alert if setgid is called setregid bool True alert if setregid is called setresgid bool True alert if setresgid is called setfsgid bool True Alert if setfsgid is called
(650) Description: This Strategy monitors calls to the setuid and setgid family of system calls used by processes to run with the privileges of a specific user or group. This can be used to alert on unusual usage of these system calls (e.g., usage as part of an exploit) as well as to monitor usage of privilege-altering commands such as “sudo”. An example configuration is presented below:
(651) SetPrivilegeTest: policy: setPrivilege enabled: true alertMessage: set privilege alert comments: testStratDescription priority: Medium rules: default match setuid: true setreuid: true setresuid: true setfsuid: true setgid: true setregid: true setresgid: true setfsgid: true
(652) A sample generated Alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(653) TABLE-US-00070 { ″alert_group_id″: ″confidence″: ″Max″, ″description″: ″set privilege alert″, ″location″: { ″container_id″: ″98e73918fad6ce45d2f84f76b0e61d2bf789fe6cda74b24184918133c3a32863″, ″container_name″: ″/test-container″, ″image_id″: ″7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560″, ″image name″: ″TEST_IMAGE″, ″node name″: ″sensor_id″: ″0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4″ }, ″matched_objects″: null, ″matched_rule″: ″metadata″: null, ″notifications″: [ { ″message″: ″The program (name unknown) with PID 1001 in container \″/test-container\″ made an unauthorized call to setuid to set uid: 1000. This action matched the ″default match\″ policy rule.″, ″name″: ″SetPrivilegeTest″, ″timestamp″: 1509474507990963973, ″uuid″: ″ZZZ″ } ], ″policy_type″: ″″, ″priority″: ″Medium″, ″process_info″: { ″args″: [ ], ″children″: null, ″cwd″: ″″, ″egid″: 10, ″euid″: 10, ″fsgid″: 10, ″fsuid″: 10, ″gid″: 10, ″name″: ″parent″: null, ″pid″: 1001, ″pid_uuid″: ″YYY/bin/bash″, ″ppid″: 0, ″sgid″: 10, ″suid″: 10, ″uid″: 10 }, ″scope″: ″Process″, ″strategy_name″: ″SetPrivilegeTest″, ″timestamp″: 1509474507990963973, ″uuid″: ″XXX″ }
(654) i. Spectre Meltdown Policy (policy identifier: spectreMeltdown)
(655) Valid filter rule fields for this policy are listed below:
(656) TABLE-US-00071 Type Description sensorId names
(657) Additional configuration options for this policy are listed below:
(658) TABLE-US-00072 Configuration Option Type Default Description cacheMissRatioThr float64 0.97 Maximum allowed eshold ratio of cache reads to cache misses
(659) Description: This Strategy monitors for spectre or meltdown attacks by monitoring hardware performance counters. If the cachemiss ratio and cachemiss-branchmiss ratio fall under a certain threshold derived through stocastic modeling (SVM), the Strategy raises an alert. An example configuration is presented below:
(660) Spectre Meltdown Policy: policy: spectreMeltdown enabled: true alertMessage: Spectre/Meltdown Exploit Detected comments: Example strategy using the spectreMeltdown policy priority: High rules: ignore sensorId==aabbccddeeff default match cacheMissRatioThreshold: 0.97
(661) A sample generated alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(662) TABLE-US-00073 { ″confidence″: ″Max″, ″description″: ″Spectre / Meltdown Exploit Detected″, ″location″: { ″container_id″: ″4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a″, ″container_name″: ″test-container″, ″image_id″: ″7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560″, ″image_name″: ″alpine:3.6″, ″sensor_id″: ″0d76a2a9edelbc3dre05d26e90501af54b11eabe180e963c56d27fo65d9243f4″ }, ″notifications″: [ { ″actor_uuid″: ″6f4d23d6-686b-4bf6-9401-86d339485f6a″, ″message″: ″Spectre Meltdown Attack noticed on sensor ID 0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4. This action matched the \″default match\″ policy rule″, ″name″: ″Spectre / Meltdown Exploit Detected″, ″timestamp″: 1535569121667980508 } ], ″priority″: ″High″, ″scope″: ″Node″, ″strategy_name″: ″Spectre Meltdown Policy″, ″timestamp″: 1535569121667976755, ″uuid″: ″Default-Spectre-Config-1″ }
(663) 4. Remote Exploitation Policies
(664) a. Connect Policy (policy identifier: connect)
(665) Valid filter rule fields for this policy are listed below:
(666) TABLE-US-00074 Type Description containerId names containerName names sensorId names imageId names imageName names remoteHost host outboundPort numbers programName paths
(667) Description: This Strategy provides network-level IP-based policy monitoring for TCP connections. An example configuration is presented below:
(668) Connect Policy Example: policy: connect enabled: true alertMessage: Illegal Connection Attempted comments: Example strategy using the connect policy priority: High rules: match remoteHost in $connecthosts default ignore
CONNECTHOSTS: type: hosts description: Connectable Hosts list: 192.168.1.0/24
(669) A sample generated alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(670) TABLE-US-00075 { ″alert_group_id″: ″″, ″confidence″: ″Max″, ″description″: ″Illegal Connection Attempted″, ″location″: { ″container_id″: ″987391 8fad6ce45d2f84f76b0e61d2bf789fe6cda74b24184918133c3a32863″, ″container_name″: ″/test-container″, ″image_id″: ″7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560″, ″image_name″: ″TEST_IMAGE″, ″node_name″: ″″, ″sensor_id″: ″0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4″ }, ″matched_objects″: null, ″matched_rule″: ″″, ″metadata″: null, ″notifications″: [ { ″message″: ″The program \″/sbin/tcpping\″ with PID 1001 in container \″/test-container\″ communicated with 192.168.1.2 on TCP port 8080. This attempt was not successful. This action matched the \″match remoteHost in $connecthosts\″ policy rule (where remoteHost (192.168.1.2) in 192.168.1.0/24).″, ″name″: ″testconnectpolicy1″, ″timestamp″: 1509474507990963973, ″uuid″: ″ZZZ″ } ], ″policy_type″: ″″, ″priority″: ″High″, ″process_info″: { ″args″: [ ], ″children″: null, ″cwd″: ″″, ″egid″: 15, ″euid″: 12, ″fsgid″: 15, ″fsuid″: 12, ″gid″: 15, ″name″: ″/sbin/topping″, ″parent″: null, ″pid″: 1001, ″pid_uuid″: ″YYY″, ″ppid″: 0, ″sgid″: 15, ″suid″: 12, ″uid″: 12 }, ″scope″: ″Process″, ″strategy_name″: ″Connect Policy Example″, ″timestamp″: 1509474507990963973, ″uuid″: ″testconnectpolicy 1-XXX″ }
(671) b. Interactive Shell Policy (policy identifier: interactiveShell)
(672) Valid filter rule fields for this policy are listed below:
(673) TABLE-US-00076 Type Description containerld names containerName names sensorld names imageld names imageName names programName paths parentProgramName paths
(674) Additional configuration options for this policy are listed below:
(675) TABLE-US-00077 Configuration Option Type Default Description alertOnlncompl ete bool True Generate an alert Data even if some of the alert info is absent
(676) Description: This Strategy provides policy monitoring of interactive shell sessions (like/bin/bash). The premise for this Strategy is that security and operational best-practices generally discourage direct system shell interaction with containers running in production, such as logging-in over SSH to a production container. In addition to being generally discouraged, the presence of an interactive shell can also be an indicator of an attack, such as one delivering a payload that “pops” a shell for the attacker. This Strategy employs a whitelist of programs which are permitted to spawn interactive shells, and generates an alert if an interactive shell is executed by a non-whitelisted parent process. One caveat is that a whitelisted interactive-shell can spawn other interactive-shells without triggering an alert. The identification of permitted sub-shells is made by their relationship to a whitelist-permitted parent process. An example configuration is presented below:
(677) Interactive Shell Policy Example: policy: interactiveShell enabled: true alertMessage: An interactive shell was spawned! comments: Example of interactive shell policy with a whitelist priority: High rules: ignore parentProgramName in $authorizedprograms default match alertOnIncompleteData: true
AUTHORIZEDPROGRAMS: type: paths list: “/usr/sbin/sshd”: “ssh”
(678) A sample generated Alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(679) TABLE-US-00078 { ″confidence″:″MediumHigh″, ″description″:″An interactive shell was spawned!″, ″location″:{ ″container_id″: ″b56b34be-aba8-439e-b488-827cdd869446″. ″container_name″: ″container_1507908229.024124″, ″image_id″: ″4ba42670-4790-460e-b3cf-9f40ab3f197a″, ″image_name″: ″unit_test: 1507908229.024146″, ″sensor_id″: ″2862d402-9814-4d14-9996-f4d97c675cd5″ }, ″notifications″: [ { ″message″: ″The interactive shell \″/bin/bash\″ with PID 3 was executed by the program (name unknown). The current configuration of Capsule8 is to alert on interactive shells even if the parent program is unknown. This action matched the \″default match\″ policy rule.″, ″name″: ″Interactive Shell Policy Example″, ″timestamp″: 12434343435, ″uuid″: ″3ad2bfe3-8665-4d6b-a2d6-60238b05d02e″ } ], ″priority″: ″High″, ″process_info″: { ″args″: [ ″/bin/bash″ ], ″name″: ″/bin/bash″, ″pid″: 3, ″pid_uuid″: ″cccc″, ″ppid″: 2 }, ″scope″: ″Process″, ″strategy_name″: ″Interactive Shell Policy Example″, ″timestamp″: 134334343, ″uuid″: ″3ad2bfe3-8665-4d6b-a2d6-60238b05d10b″ }
(680) c. Memory Protection Policy (policy identifier: memoryProtection)
(681) Valid filter rule fields for this policy are listed below:
(682) TABLE-US-00079 Type Description containerId names containerName names sensorId names imageId names imageName names programName paths
(683) Description: This Strategy provides monitoring for attempts to exploit memory-mismanagement software vulnerabilities. Attempts to exploit these vulnerabilities to execute arbitrary code (also known as shellcode) commonly involve a step to modify the permissions on memory containing attacker-controlled data, so that the attacker-controlled data can be executed as program code. This Strategy specifically monitors for attempts to modify heap memory to be executable, and if that behavior is observed, an Alert is generated informing which process is under attack. Alerts include related container information. An example configuration is presented below:
(684) MemProtect Example Policy: policy: memoryprotection enabled: true comments: Example strategy using the memoryprotection policy priority: High rules: ignore programName in $exampleWhitelist default match alertMessage: Memory Protection Alert
exampleWhitelist: type: paths list: “/tmp/whitelisted_program”: “example of whitelisted program”
(685) A sample generated Alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(686) TABLE-US-00080 { ″alert_group id″: ″″, ″confidence″: ″Max″, ″description″: ″Memory Protection Alert″, ″location″: { ″container_id″: ″4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a″, ″container_name″: ″test-container″, ″image_id″: ″7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560″, ″image_name″: ″alpine:3.6″, ″node_name″: ″″, ″sensor_id″: ″0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4″ }, ″matched_objects″: null, ″matched_rule″: ″″, ″metadata″: null, ″notifications″: [ { ″message″: ″A memory corruption exploit was detected in the program \″/tmp/non- whitelisted_program\″ with PID 3333 in container \″test-container\″. This action matched the \″default match\″ policy rule.″, ″name″: ″MemProtect Example Policy″, ″timestamp″: 1509474507990963973, ″uuid″: ″ZZZ″ } ], ″policy_type″: ″″, ″priority″: ″High″, ″process_info″: { ″args″: [ ], ″children″: null, ″cwd″: ″″, ″egid″: 0, ″euid″: 0, ″fsgid″: 0, ″fsuid″: 0, ″gid″: 0, ″name″: ″/tmp/non-whitelisted_program″, ″parent″: null, ″pid″: 3333, ″pid_uuid″: ″a856880a77274d238a5a9dl057831dec″, ″ppid″: 0, ″sgid″: 0, ″suid″: 0, ″uid″: 0 }, ″scope″: ″Process″, ″strategy_name″: ″MemProtect Example Policy″, ″timestamp″: 1509474507990963973, ″uuid″: ″XXX″ }
(687) d. New File Exec Policy (policy identifier: newFileExec)
(688) Valid filter rule fields for this policy are listed below:
(689) TABLE-US-00081 Type Description containerId names containerName names sensorId names imageId names imageName names parentProgramName paths programName paths
(690) Additional configuration options for this policy are listed below:
(691) TABLE-US-00082 Configuration Option Type Default Description fileTimeout int 30 Minutes after which newly created files can be executed without triggering an alert
(692) Description: This Strategy watches for execution of newly-created files by non-whitelisted programs. If such created files are executed within the configured timeout, the Strategy produces Alerts. This behavior is often associated with webshells. An example configuration is presented below:
(693) New File Exec Policy Example: policy: newFileExec enabled: true alertMessage: A file not previously present in the system was executed comments: Example strategy using the newFileExec policy priority: High rules: ignore programName==/tmp/safe/* default match fileTimeout: 30
(694) A sample generated alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(695) TABLE-US-00083 { ″confidence″: ″Max″, ″description″: ″A kernel module was loaded″, ″location″: { ″container_id″: ″4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a″, ″container_name″: ″test-container″, ″image_id″: ″7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560″, ″image_name″: ″alpine:3.6″, ″sensor_id″: ″0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4″ }, ″notifications″: [ { ″actor_uuid″: ″3ad2bfe3-8665-4d6b-a2d6-60238b05d02e″, ″message″: ″Kernel Module \″sampleModule\″ was loaded. This action matched the following policy rule: ″default match\″″, ″name″: ″Kernel Module Example Policy″, ″timestamp″: 12434343435 } ], ″priority″: ″Medium″, ″process_info″: { ″args″: [ ], ″name″: ″″, ″pid″: 22059, ″pid_uuid″: ″080a6767-9f37-4d70-b00d-015a9edf9099″, ″ppid″: 0 }, ″scope″: ″Node″, ″strategy name″: ″Kernel Module Example Policy″, ″timestamp″: 134334343, ″uuid″: ″4ba42670-4790-460e-b3cf-9f40ab3f197a″ }
(696) e. Remote Interactive Shell Policy (policy identifier: remoteInteractiveShell)
(697) Valid filter rule fields for this policy are listed below:
(698) TABLE-US-00084 Type Description containerId names containerName names sensorId names imageId names imageName names remoteHost host outboundPort numbers inboundPort numbers uid numbers gid numbers programName paths parentProgramName paths
(699) Description: This Strategy is similar to the functionality of the Interactive Shell strategy, but specifically monitors for interactive shells processing input/output from a network connection, such as the behavior exhibited by exploit payloads using mechanisms like the bash shell's /dev/tcp to connect back to an attacker's machine. An example configuration is presented below:
(700) Remote Interactive Shell Strategy Example: policy: remoteInteractiveShell enabled: true alertMessage: Remote Interactive Shell Executed comments: Example strategy using the remoteInteractiveShell policy priority: High rules: ignore parentProgramName in $programlist default match alertOnIncompleteData: true
PROGRAMLIST: type: paths list: /bin/baz: “ ”
(701) A sample generated alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(702) TABLE-US-00085 { ″confidence″: ″Max″ ″description″: ″Remote Interactive Shell Executed″, ″location″: { ″container_id″: ″b56b34be-aba8-439e-b488-827cdd869446″, ″container_name″: ″container_1507908229.024124″, ″image_id″: ″4ba42670-4790-460e-b3cf-9f40ab3f197a″, ″image_name″: ″unit_test: 1507908229.024146″, ″sensor_id″: ″2862d402-9814-4dl4-9996-f4d97c675cd5″ }, ″notifications″: [ { ″actor_uuid″: ″3ad2bfe3-8665-4d6b-a2d6-60238b05d02e″, ″message″: ″The interactive shell \″/bin/bash\″ with PID 2 in container \″container_1507908229.024124\″ was spawned with remote-control operation through an outbound connection to 192.168.0.1. This action matched the \″default match\″ policy rule.″, ″name″: ″Remote Interactive Shell Strategy Example″, ″timestamp″: 12434343435 } ], ″priority″: ″High″, ″process_info″: { ″args″: [ ″/bin/bash″ ], ″name″: ″/bin/bash″, ″pid″: 2, ″pid_uuid″: ″080a6767-9f37-4d70-b00d-015a9edf9099″, ″ppid″: 0 }, ″scope″: ″Process″, ″strategy name″: ″Remote Interactive Shell Strategy Example″, ″timestamp″: 134334343, ″uuid″: ″XXXX″ }
(703) f. Stack Pivot Detection Policy (policy identifier: stackPivotDetection)
(704) Valid filter rule fields for this policy are listed below:
(705) TABLE-US-00086 Type Description containerId names containerName names sensorId names imageId names imageName names programName paths
(706) Description: This Strategy examines the stack pointer on certain syscalls and ensures that it is within normal stack bounds. If it is not, it raises an Alert. The stack pointer being outside the bounds of the stack is normally indicative of a stack pivot as part of an exploit chain. An example configuration is presented below:
(707) Example Stack Pivot Policy: policy: stackPivotDetection enabled: true alertMessage: Stack Pivot Detected comments: Example strategy using the stackPivotDetection policy priority: Medium rules: default match
(708) A sample generated alert for the above configuration (dummy values shown where normally real pids/uuids/timestamps etc. would be present) is presented below:
(709) TABLE-US-00087 { ″confidence″: ″High″, ″description″: ″Stack Pivot Detected″, ″location″: { ″container_id″: ″4cb5b14f2f6b8e02a3e57188e230d140f2a8880d236a5f21face723678a2c50a″, ″container name″: ″test-container″, ″image_id″: ″7328f6f8b41890597575cbaadc884e7386ae0acc53b747401ebce5cf0d624560″.sub.: ″image_name″: ″alpine:3.6″, ″sensor_id″: ″0d76a2a9ede1bc3df805d26e90501af54b11eabe180e963c56d27f065d9243f4″ }, ″notifications″: [ { ″actor_uuid″: ″6f4d23d6-686b-4bf6-9401-86d339485f6a″, ″message″: ″A stack pivot was detected in the program with PID 3333 in container \″test-container\″. This action matched the \″default match\″ policy rule.″, ″name″: ″Stack Pivot Detected″, ″timestamp″: 1535569121667980508 } ], ″priority″: ″Medium″, ″process_info″: { ″args″: [ ], ″name″: ″″, ″pid″: 3333, ″pid_uuid″: ″a856880a77274d238a5a9d1057831dec″, ″ppid″: 0 }, ″scope″: ″Process″, ″strategy_name″: ″Example Stack Pivot Policy″, ″timestamp″: 1535569121667976755, ″uuid″: ″Example-StackPivot-Config-1″ }
VII. Alerts
(710) A. Getting Events from the Platform
(711) At startup, Gateway 404's instance registers its HandleEvent function as a callback with CommsClient 402's instance. It then gets the list of Events each Strategy needs by calling each Strategy's GetSubscription( ) method and combines them into a set to form a single telemetry subscription. Any time an Event is received via this telemetry subscription, it does the following. First, CommsClient 402 invokes its factory and creates a corresponding Event as a Platform Event. Second, it calls Gateway 404's HandleEvent method as a callback.
(712) B. Passing Events to Strategies
(713)
(714) The MetaEvents produced by the call to a Strategy's HandleEvent method are sent back to analytics framework 400 to be published by invoking Gateway 404's SendEventOflnterestToPlatform method, which sends it to CommsClient 402. Comms Client 402 translates this to a protobuf message and publishes it on a topic supplied inside of the specific MetaEvent struct.
(715) Each Alert is sent back to analytics framework 400 by calling Gateway 404's SendAlertToPlatform. This method does a few things. First, it applies any registered Alert Utilities to enrich the Alert data by calling their HandleAlert methods. Examples include things like adding process lineage, annotating an Alert with other metadata such as number of alerts for the sensor node, etc. This passes the Alert to Arbiter 408, by calling its HandleAlert method. This either returns the Alert or nil. If Arbiter 408 returns the Alert, then it is sent back to CommsClient 402 which converts it to an API protobuf format and then publishes it on the Alerting topic. If CommsClient 402 is a standalone or Embedded Server Library Client, then the Alert has the ability to be printed to Stdout, a local file, or a BLOB storage provider.
(716) C. Alert Filtering and the Arbiter
(717) In order to keep false positives from becoming an issue, Arbiter 408 supports filtering in the form of Alert filter logic, as follows: A set of filters are passed as strings and then compiled into an evaluation format. When an Alert is passed to Arbiter 408 it evaluates each filter in the list against the Alert. If any of the filters match then the Alert is discarded. The filters themselves are described using the following Alert filter language.
(718) Arbiter 408's Alert filter language works by evaluating the predicate rule against a given Alert. If any of the rules evaluate to true then the Alert is filtered. Rules start with an Alert field identifier that identifies the specific field in the Alert to compare. Rules may be combined into more compound statements using special “and” and “or” operators.
(719) 1. Value Types
(720) a. Alert Field Identifiers
(721) The Alert Field Identifiers type identifies a specific property of an Alert to check.
(722) The following are examples of supported fields:
(723) TABLE-US-00088 Identifier Alert Field Type ″container_Id″ alert.Location.ContainerID string (hex_string) ″image_id″ alert.Location.ImageID string (hex_string) ″sensor_id″ alert. Location. SensorID string (hex_string) ″container_name″ alert.Location.ContainerName string ″image_name″ alert.Location.ImageName string ″program_name″ alert.ProcessInfo.ProgamName string ″strategy″ alert. StrategyName string ″priority″ alert.Priority int ″confidence″ alert.Confidence float64
(724) b. String
(725) Strings are identifiers that are not keywords or operators, and do not need quotes. For example:
(726) foobar
(727) baz
(728) basil
(729) Example Usage:
(730) container_name in foobar baz basil
(731) program_name==/bin/sh
(732) c. Hex String
(733) A hex string represents a string of only hexidecimal characters. It can be either 64 characters or 12 characters long. It is used to represent UUIDs that are commonly SHA256 hashes such as container IDs, image IDs, and sensor IDs. If a short form is specified only the first 12 characters of the specified field will be compared. For example:
(734) 98e73918fad6ce45d2f84f76b0e61d2bf789fe6cda74b24184918133c3a32863 0d76a2a9ede1
(735) Example Usage:
(736) sensor_id in 0d76a2a9ede17ef86f8e8b85
(737) container_id==0d76a2a9ede1
(738) d. FLOAT64
(739) The FLOAT64 type represents a 64-bit signed floating point number. It is used only with the alert confidence field. All operators are valid for the float. For example:
(740) 3.145962
(741) Example Usage:
(742) confidence >=0.95 and confidence <0.971245
(743) e. Integer
(744) The integer type represents a 64-bit integer. This is used only for the priority field. Additionally there are special keywords such as LOW, MEDIUM, and HIGH which represent 1, 2, and 3.
(745) Example Usage:
(746) priority in HIGH LOW
(747) priority <HIGH
(748) 2. Operators
(749) in: The “in” operator tests whether the Alert field's value is in the specified list of values. Example Usage:
(750) priority in HIGH LOW
(751) sensor_id in 0d76a2a9ede17ef86f8e8b85
(752) not in: The “not in” operator tests whether the Alert field's value is not in the specified list of values. Example Usage:
(753) sensor_id not in 0d76a2a9ede17ef86fe8b85
(754) ==: The equality operator (“==”) tests whether the Alert field's value is equal to the specified value. Example Usage:
(755) program_name==/bin/zsh
(756) !=: The negative equality operator (“!=”) tests whether the Alert field's value is not equal to the specified value. Example Usage:
(757) container_name !=steve
(758) >: The greater than operator (“>”) tests whether the Alert field's value is greater than the value specified. Example Usage:
(759) priority >1
(760) priority >LOW
(761) >=: The greater than or equal operator (“>=”) tests whether the Alert field's value is greater than or equal to the value specified. Example Usage:
(762) confidence >=0.90
(763) <: The less than operator(“<”) tests whether the Alert field's value is less than the value specified. Example Usage:
(764) priority <3
(765) priority <HIGH
(766) confidence <0.942
(767) <=: The less than or equal operator (“<=”) tests whether the Alert field's value is less than or equal to the value specified. Example Usage:
(768) priority <=2
(769) priority <=MEDIUM
(770) confidence <=0.942
(771) OR: The OR operator joins two rules together into a single rule. This requires that one of the rules is joined by the OR operator to evaluate to true. Example Usage:
(772) container_name==steve or priority >LOW
(773) AND: The AND operator joins two or more rules together into a single rule. This requires that all of the rules joined by the AND operator evaluate to true. Example Usage: container_name==load_balancer:3.8 and priority >LOW
VIII. QUERY API
(774) In various embodiments, platform 100 provides a query API. The query API can be used for a variety of purposes, such as providing more context around Alerts in the form of high-level Events (also referred to herein as MetaEvents), providing a mechanism that an operator can use to see high-level Events leading up to an Alert, providing a mechanism for an operator to query other monitored hosts for MetaEvents, and to allow Sensors (e.g., Sensor 112) to stay within their performance budgets.
(775)
(776)
(777)
(778)
(779) Although the foregoing embodiments have been described in some detail for purposes of clarity of understanding, the invention is not limited to the details provided. There are many alternative ways of implementing the invention. The disclosed embodiments are illustrative and not restrictive.