Skip to content

A parser for handling recognisable data such as IP, domain, MD5 and process them with custom actions.

License

Notifications You must be signed in to change notification settings

BongoKnight/cyberclip

Repository files navigation

Introduction

Cyberclip is designed to detect and extract recognizable data from text inputs, enabling data transformation and enrichment for cybersecurity professionals. Tailored for cyber threat analysts and SOC operators, Cyberclip helps investigate and pivot around technical indicators such as domains, URLs, IP addresses, and file hashes. It features a simple terminal interface (TUI) that integrates with tools like UrlScan, OpenCTI, and VirusTotal. It can also be used to extract data from JSON, defang IoCs, and encode or decode data in formats like Hex, Base64, and URL encode and much more... In short, Cyberclip empowers investigators to perform quick checks and make informed decisions during investigations!

User documentation: https://bongoknight.github.io/cyberclip/Features%20tour/

.env file and variables

Variables that allows Cyberclip to authenticate itself against third-party API should be written in /src/cyberclip/.env:

DATALAKE_EMAIL="<DATALAKE EMAIL>"
DATALAKE_PASSWORD="<DATALAKE PASSWORD>"
DEEPL_API-KEY="<DEEPL API-KEY>"
SHODAN_API-KEY="<SHODAN API KEY>"
URLSCAN_API-KEY="<URLSCAN API KEY>"
VIRUSTOTAL_API-KEY="<VIRUS TOTAL API KEY>"

Installation

Requirements

  • Git
  • Docker (for docker deployment)
  • Python 3.12

With uv

# For trying
uv tool run git+https://github.com/BongoKnight/cyberclip

# For installation
uv tool install git+https://github.com/BongoKnight/cyberclip
cyberclip

With pipx

python -m pip install pipx
python -m pipx install "cyberclip @ git+https://github.com/BongoKnight/cyberclip"

With Docker

git clone https://github.com/BongoKnight/cyberclip
cd cyberclip
docker build -t cyberclip .
docker run -d -p 8000:8000 cyberclip

Generate documentation

pip install mkdocs mkdocs-gen-files mkdocs-material mkdocs-autorefs mkdocstrings-python
mkdocs gh-deploy

Thanks to and similar project:

About

A parser for handling recognisable data such as IP, domain, MD5 and process them with custom actions.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages