Lacework Python SDK
laceworksdk is a community developed Python library for interacting with the Lacework APIs.
The purpose of this library is to simplify the common tasks required for interacting with the Lacework API, and allow users write simple code to automate tasks related to their Lacework instance(s). From data retrieval to configuration, this library aims to expose all publicly available APIs. For example, the following code would authenticate, fetch events, fetch host vulnerabilities, and fetch container vulnerabilities. The latest version of the SDK supports expressive searches as enabled by v2 of the Lacework APIs.
For more information read the documentation
from laceworksdk import LaceworkClient
lw = LaceworkClient() # This would leverage your default Lacework CLI profile.
lw = LaceworkClient(account="ACCOUNT",
subaccount="SUBACCOUNT",
api_key="API KEY",
api_secret="API SECRET")
events = lw.events.search(json={
"timeFilter": {
"startTime": start_time,
"endTime": end_time
}
})
host_vulns = lw.vulnerabilities.hosts.search(json={
"timeFilter": {
"startTime": start_time,
"endTime": end_time
}
})
container_vulns = lw.vulnerabilities.containers.search(json={
"timeFilter": {
"startTime": start_time,
"endTime": end_time
},
"filters": [
{
"field": "imageId",
"expression": "eq",
"value": "sha256:657922eb2d64b0a34fe7339f8b48afb9f2f44635d7d6eaa92af69591d29b3330"
}
]
})
Requirements
- Python 3.8 or higher
- Lacework API Credentials
- Account Name
- API Key
- API Secret
How-To
The following information is required to instantiate a LaceworkClient instance:
account: The Lacework account/organization domain. (xxxxx.lacework.net)api_key: The API Key that was generated from the Lacework UI/API.api_secret: The API Secret that was generated from the Lacework UI/API.
Optionally, you can also set a Lacework Sub-Account using the subaccount parameter.
To generate API credentials, you'll need to do the following in Lacework:
- In the Lacework web interface, go to Settings -> API Keys
- Create a new API Key and download information the credentials.
Environment Variables
If you wish to configure the LaceworkClient instance using environment variables, this module honors the same
variables used by the Lacework CLI. The account, subaccount, api_key, api_secret, api_token, and profile parameters
can all be configured as specified below.
| Environment Variable | Description | Required |
|---|---|---|
LW_PROFILE |
Lacework CLI profile to use (configured at ~/.lacework.toml) | N |
LW_ACCOUNT |
Lacework account/organization domain (i.e. <account>.lacework.net) |
Y |
LW_SUBACCOUNT |
Lacework sub-account | N |
LW_API_KEY |
Lacework API Access Key | N |
LW_API_SECRET |
Lacework API Access Secret | N |
LW_API_TOKEN |
Lacework API Token (alternative to key and secret) | N |
NOTE: To authenticate with the Lacework API you must specify either a key and secret OR a token. If you specify both the token will be used.
Installation
Installing and upgrading laceworksdk is easy:
Install via PIP
$ pip install laceworksdk
Upgrading to the latest Version
$ pip install laceworksdk --upgrade
Examples
Are you looking for some sample scripts? Check out the examples folder!
Contributing
Metadata
Release files for laceworksdk 4.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| laceworksdk-4.1.0.tar.gz | 33.5 kB | Without provenance | Details for laceworksdk-4.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| laceworksdk-4.1.0-py3-none-any.whl | Python 3 | none | any | Details for laceworksdk-4.1.0-py3-none-any.whl |
Total release size: 90.5 kB
Release files / laceworksdk-4.1.0.tar.gz
| Download URL | laceworksdk-4.1.0.tar.gz |
|---|---|
| Size | 33.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
83a5b996704eb7854705fa69d7306705871134bd0342f55f6baae50526a2ca76
|
|
BLAKE2b-256 checksum How to use checksums |
21192dcba78a801f557e8d7a8ad8605ccf6718ce141c08643b8ede80b84a6655
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1021-azure
|
Release files / laceworksdk-4.1.0-py3-none-any.whl
| Download URL | laceworksdk-4.1.0-py3-none-any.whl |
|---|---|
| Size | 57.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
55a67355f135fc1a7173796d904a4ee9f3173953ca3c2afa0ec9c84ceddd1cef
|
|
BLAKE2b-256 checksum How to use checksums |
5108d9d2e02e61f54b22932e16dff798d292812ddb11893c64baddd459ee5c9e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1021-azure
|
Security for laceworksdk 4.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.