resilient-circuits
This package is a framework for rapid development of Resilient Action Module event processors in Python.
Recent Changes
2021-08: version 42.0
-
Added support for HTTP_PROXY, HTTPS_PROXY and NO_PROXY environmental variables. See the App Host Deployment Guide for details.
-
Enhancement to selftest to also check connection back to SOAR platform.
-
Added 'selftest_timeout' to app.config file. It sets the value in seconds for selftest to wait for a response from the SOAR platform.
-
Bug fixes.
Installation
Instructions for building and installing this package can be found in the repository README.
Configuration
Configuration parameters for the server URLs, user credentials and so on should be provided using a configuration file. They can optionally also be provided on the command-line.
If the environment variable APP_CONFIG_FILE is set, it defines the path
to your configuration file. The default configuration file is named
app.config and is stored in ~/.resilient/app.config.
Generate a template app.config file with:
resilient-circuits config -c
Or on Windows:
resilient-circuits.exe config -c
Edit the app.config file with parameters appropriate to your environment.__
Any sample components you are running may have additional sections that
need to be added to the app.config file, which will be indicated in their README.
Running an example
After installing the resilient-circuits module, install a compatible integration
package or copy some sample component modules to your components directory.
The path to this components directory will need to be specified in your app.config
file in the [resilient] section in the componentsdir parameter.
Create a directory for resilient-circuits to write log files to and specify
its location in the logdir parameter in your app.config file.
Once everything is configured, start the integration:
resilient-circuits run
or on Windows,
resilient-circuits.exe run
Logging
Script output is logged to a file "app.log", which rotates if it grows large. On unix systems, the script output is also sent to syslog. You should periodically check the log for warnings and errors.
Usage:
resilient-circuits [-h] [-v]
{run,list,test,service,config,codegen,extract,customize,selftest,clone,ext:package,ext:convert}
optional arguments:
-h, --help show this help message and exit
-v, --verbose Print debug output
subcommands:
one of these options must be provided
run Run the Resilient Circuits application
list List the installed Resilient Circuits components
test An interactive client for testing Resilient Circuits
messages
service Manage Resilient Circuits as a service
config Create or update a basic configuration file
customize Apply customizations to the Resilient platform
selftest Calls selftest functions for every package and prints
out their return states
clone Clone Resilient objects
1 maintainer
Metadata
1 maintainer
Release files for resilient-circuits 42.0.2101
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| resilient_circuits-42.0.2101.tar.gz | 78.2 kB | Details |
Release files / resilient_circuits-42.0.2101.tar.gz
| Download URL | resilient_circuits-42.0.2101.tar.gz |
|---|---|
| Size | 78.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e5ba24f92075aeb2f6dcc45059a05d1b0ee7078fd4f58d77043281be9ae303a0
|
|
BLAKE2b-256 checksum How to use checksums |
4473dfb0e9eee39d9d79aa912fec8bb266815b92cfbeb5e2b11caa1665daedc8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.6.10
|
