Skip to main content

psengine is a simple, yet elegant, library for rapid development of integrations with Recorded Future.

Project description

Documentation: https://recordedfuture-professionalservices.github.io/psengine/

Github: https://github.com/RecordedFuture-ProfessionalServices/psengine

PyPi: https://pypi.org/project/psengine/


PSEngine is a simple, yet elegant, library for rapid development of integrations with Recorded Future.

PSEngine allows you to interact with the Recorded Future API extremely easily. There’s no need to manually build the URLs and query parameters, just use the modules dedicated to individual API endpoints.

PSEngine is a Python package solely built and maintained by the Recorded Future Cyber Security Engineering team powering a number of high profile integrations, such as: PS Banshee; Recorded Future Alerts for QRadar; Anomali ThreatStream: Alerts and Analyst Notes integrations; Google SecOps and many more.

Installation

PSEngine is a Python package that can be installed using pip. To install PSengine, run the following command:

pip install psengine

PSEngine officially supports Python >= 3.10, < 3.15.

Supported Features & Best Practices

PSEngine is ready for the demands of building robust and reliable integrations.

It can easily interact with the following Recorded Future datasets:

  • Analyst Notes
  • Attack Surface Intelligence
  • Collective Insights
  • Classic & Playbook Alerts
  • Detection Rules
  • Fusion File management
  • Identity Exposures management
  • List management
  • Malware Intelligence (including Auto Yara and Auto Sigma)
  • Malware Sandbox reports download
  • On demand IOC enrichment
  • Risklists
  • Risk History
  • STIX conversion

And facilitate the development with features like:

  • Built-in logging
  • Easy configuration management
  • Markdown creation from certain data types
  • Proxy support

Previous versions and version documentation

PSEngine has been made public from our internal version 2.0.4. Previous versions, including version 1, are not publicly available.

The documentation arrived at version 2.1.1. Older versions are not explicitly documented and changes can be found in the Release History section.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

psengine-2.8.2.tar.gz (144.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

psengine-2.8.2-py3-none-any.whl (267.3 kB view details)

Uploaded Python 3

File details

Details for the file psengine-2.8.2.tar.gz.

File metadata

  • Download URL: psengine-2.8.2.tar.gz
  • Upload date:
  • Size: 144.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for psengine-2.8.2.tar.gz
Algorithm Hash digest
SHA256 b3089ec79842de6f0593a00a5411bb73d2a51be023873f0cff07b82beeb544d3
MD5 49800d38b60a301c2fd92f7fbb86504d
BLAKE2b-256 dbafd0f649ebbcb5992800c58daa07e6a68bc67c920fb9c94a357813d6a6081e

See more details on using hashes here.

Provenance

The following attestation bundles were made for psengine-2.8.2.tar.gz:

Publisher: workflow.yml on RecordedFuture-ProfessionalServices/psengine

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file psengine-2.8.2-py3-none-any.whl.

File metadata

  • Download URL: psengine-2.8.2-py3-none-any.whl
  • Upload date:
  • Size: 267.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for psengine-2.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cce7d33a396b10aef0d7a7e39d91a7b905af4563917391b23b4550f46060d20b
MD5 8f6dd5bec0ce78c5345d7815581b95e7
BLAKE2b-256 2454a57c7590a37ba7c659240ec6db3a7ceda890c393b16accc1b4c235c9ce77

See more details on using hashes here.

Provenance

The following attestation bundles were made for psengine-2.8.2-py3-none-any.whl:

Publisher: workflow.yml on RecordedFuture-ProfessionalServices/psengine

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page