PyLOOBins
PyLOOBins is a Python SDK and command-line utility for programmatically interacting with LOOBins.
You can download PyLOOBins from PyPI by running the following command:
pip install pyloobins
PyLOOBins requires Python 3.8 or later.
Usage
Command-line
You can run pyloobins --help to see the available commands and options.
>>> pyloobins --help
Usage: pyloobins [OPTIONS] COMMAND [ARGS]...
Create, validate, and view LOOBin objects.
Options:
--help Show this message and exit.
Commands:
create Create a YAML template file for a new LOOBin.
get Get a LOOBin object.
validate Validate a LOOBin YAML file.
You can run pyloobins <command> --help to see the available options for a specific command.
>>> pyloobins validate --help
Usage: pyloobins validate [OPTIONS]
Validate a LOOBin YAML file.
Options:
--path TEXT The path of the LOOBin YAML file to validate. [required]
--help Show this message and exit.
SDK
You can use pyloobins as a Python SDK to programmatically interact with LOOBins.
pyloobins.util
The util module can be used to get LOOBin objects from the LOOBins API, validate LOOBin YAML files, and create LOOBin YAML templates.
Example: get all LOOBins and print a list of the use case code.
from pyloobins import util
loobins = util.get_loobins()
for loobin in loobins:
for uc in loobin.example_use_cases:
print(f"{loobin.name}: {uc.code}")
pyloobins.models
The models module contains the classes that represent a LOOBin and its various components.
Example: programmitcally create a LOOBin object.
from pyloobins.models import Detection, ExampleUseCase, LOOBin, Resource
l = LOOBin(
name="",
short_description="A short description of the binary goes here.",
full_description="A full length description of the binary goes here.",
author="Enter your name or alias here.",
created=date.today(),
example_use_cases=[
ExampleUseCase(
name="An Example Use Case",
description="A description of the use case goes here.",
code="A code snippet goes here.",
tactics=["Discovery"],
tags=["example_tag", "another_tag"],
)
],
paths=["/enter/binary/path/here"],
detections=[
Detection(
name="A detection source (e.g. Sigma)",
url="https://urltodetection.here",
)
],
resources=[
Resource(
name="Name of resources.",
url="https://urlofexternalreference.here",
)
],
acknowledgements=["Enter any acknowledgements here."],
)
with open ("loobin.yaml", "w") as f:
f.write(l.to_yaml())
1 maintainer
Metadata
1 maintainer
Release files for PyLOOBins 1.3.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 | |
|---|---|---|---|
| pyloobins-1.3.0.tar.gz | 40.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyloobins-1.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 98.2 kB
Release files / pyloobins-1.3.0.tar.gz
| Download URL | pyloobins-1.3.0.tar.gz |
|---|---|
| Size | 40.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7decc79dff907e131ab2063ae5da3a6980beb0c80c09f416250cace7bba6b164
|
|
BLAKE2b-256 checksum How to use checksums |
e21608c337d694269aff76d134edc8e63d8d18c6cda025e05396c57f3f94352d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.6.1 CPython/3.11.6 Darwin/23.0.0
|
Release files / pyloobins-1.3.0-py3-none-any.whl
| Download URL | pyloobins-1.3.0-py3-none-any.whl |
|---|---|
| Size | 58.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bb95eeb89f8c2bb5566209c2f290ef32b99ee0bc36dc7d418aac82b3afa9ac90
|
|
BLAKE2b-256 checksum How to use checksums |
23ec43da2878a1ba567e0c78ff280da5d447cdd13233a26a634b22cb807f4005
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.6.1 CPython/3.11.6 Darwin/23.0.0
|
