app.api.v2.handlers namespace

Submodules

app.api.v2.handlers.ability_api module

class app.api.v2.handlers.ability_api.AbilityApi(services)

Bases: BaseObjectApi

add_routes(app: Application)
async create_ability(request: Request)
async create_or_update_ability(request: Request)
async delete_ability(request: Request)
async get_abilities(request: Request)
async get_ability_by_id(request: Request)
async update_ability(request: Request)

app.api.v2.handlers.adversary_api module

class app.api.v2.handlers.adversary_api.AdversaryApi(services)

Bases: BaseObjectApi

add_routes(app: Application)
async create_adversary(request: Request)
async create_on_disk_object(request: Request)
async create_or_update_adversary(request: Request)
async delete_adversary(request: Request)
async get_adversaries(request: Request)
async get_adversary_by_id(request: Request)
async update_adversary(request: Request)

app.api.v2.handlers.agent_api module

class app.api.v2.handlers.agent_api.AgentApi(services)

Bases: BaseObjectApi

add_routes(app: Application)
async create_agent(request: Request)
async create_or_update_agent(request: Request)
async delete_agent(request: Request)
async get_agent_by_id(request: Request)
async get_agents(request: Request)
async get_deploy_commands(request: Request)
async get_deploy_commands_for_ability(request: Request)
async kill_agent(request: Request)
async update_agent(request: Request)

app.api.v2.handlers.base_api module

class app.api.v2.handlers.base_api.BaseApi(auth_svc, logger=None)

Bases: ABC

abstract add_routes(app: Application)
async get_request_permissions(request: Request)
property log
async static parse_json_body(request: Request, schema: Schema)

app.api.v2.handlers.base_object_api module

class app.api.v2.handlers.base_object_api.BaseObjectApi(description, obj_class, schema, ram_key, id_property, auth_svc, logger=None)

Bases: BaseApi

abstract add_routes(app: Application)
async create_object(request: Request)
async create_on_disk_object(request: Request)
async create_or_update_object(request: Request)
async create_or_update_on_disk_object(request: Request)
async delete_object(request: Request)
async delete_on_disk_object(request: Request)
async get_all_objects(request: Request)
async get_object(request: Request)
async update_object(request: Request)
async update_on_disk_object(request: Request)

app.api.v2.handlers.config_api module

class app.api.v2.handlers.config_api.ConfigApi(services)

Bases: BaseApi

add_routes(app: Application)
async get_config_with_name(request)
async update_agents_config(request)
async update_main_config(request)

app.api.v2.handlers.contact_api module

class app.api.v2.handlers.contact_api.ContactApi(services)

Bases: BaseApi

add_routes(app: Application)
async get_available_contact_reports(request: Request)
async get_contact_list(request: Request)
async get_contact_report(request: Request)

app.api.v2.handlers.fact_api module

class app.api.v2.handlers.fact_api.FactApi(services)

Bases: BaseObjectApi

async add_facts(request: Request)
async add_relationships(request: Request)
add_routes(app: Application)
async delete_facts(request: Request)
async delete_relationships(request: Request)
async get_facts(request: Request)
async get_facts_by_operation_id(request: Request)
async get_relationships(request: Request)
async get_relationships_by_operation_id(request: Request)
async update_facts(request: Request)
async update_relationships(request: Request)

app.api.v2.handlers.fact_source_api module

class app.api.v2.handlers.fact_source_api.FactSourceApi(services)

Bases: BaseObjectApi

add_routes(app: Application)
async create_fact_source(request: Request)
async create_or_update_source(request: Request)
async delete_source(request: Request)
async get_fact_source_by_id(request: Request)
async get_fact_sources(request: Request)
async update_fact_source(request: Request)

app.api.v2.handlers.health_api module

class app.api.v2.handlers.health_api.HealthApi(services)

Bases: BaseApi

add_routes(app: Application)
async get_health_info(request)

app.api.v2.handlers.obfuscator_api module

class app.api.v2.handlers.obfuscator_api.ObfuscatorApi(services)

Bases: BaseObjectApi

add_routes(app: Application)
async get_obfuscator_by_name(request: Request)
async get_obfuscators(request: Request)

app.api.v2.handlers.objective_api module

class app.api.v2.handlers.objective_api.ObjectiveApi(services)

Bases: BaseObjectApi

add_routes(app: Application)
async create_objective(request: Request)
async create_or_update_objective(request: Request)
async get_objective_by_id(request: Request)
async get_objectives(request: Request)
async update_objective(request: Request)

app.api.v2.handlers.operation_api module

class app.api.v2.handlers.operation_api.OperationApi(services)

Bases: BaseObjectApi

add_routes(app: Application)
async create_object(request: Request)
async create_operation(request: Request)
async delete_operation(request: Request)
async get_operation_by_id(request: Request)
async get_operation_event_logs(request: Request)
async get_operation_report(request: Request)
async get_operations(request: Request)
async get_operations_summary(request: Request)
async update_object(request: Request)
async update_operation(request: Request)

app.api.v2.handlers.payload_api module

class app.api.v2.handlers.payload_api.PayloadApi(services)

Bases: BaseApi

add_routes(app: Application)
async delete_payloads(request: Request)
async get_payloads(request: Request)
async post_payloads(request: Request)
static sanitize_filename(filename: str) → str

Sanitizes a file name to remove potentially dangerous characters.

Parameters:

filename – The original file name.

Returns:

A sanitized file name.

static validate_and_canonicalize_path(input_path: str, base_directory: str = 'data/payloads/') → str

Validates and canonicalizes a file path to ensure it is within the designated directory.

Parameters:

  • input_path – The input file path to validate.

  • base_directory – The base directory to constrain paths to.

Returns:

The canonicalized absolute path if valid.

Raises:

ValueError – If the path resolves outside the base directory.

app.api.v2.handlers.planner_api module

class app.api.v2.handlers.planner_api.PlannerApi(services)

Bases: BaseObjectApi

add_routes(app: Application)
async get_planner_by_id(request: Request)
async get_planners(request: Request)
async update_planner(request: Request)

app.api.v2.handlers.plugins_api module

class app.api.v2.handlers.plugins_api.PluginApi(services)

Bases: BaseObjectApi

add_routes(app: Application)
async get_plugin_by_name(request: Request)
async get_plugins(request: Request)

app.api.v2.handlers.schedule_api module

class app.api.v2.handlers.schedule_api.ScheduleApi(services)

Bases: BaseObjectApi

add_routes(app: Application)
async create_object(request: Request)
async create_or_update_object(request: Request)
async create_or_update_schedule(request: Request)
async create_schedule(request: Request)
async delete_schedule(request: Request)
async get_schedule_by_id(request: Request)
async get_schedules(request: Request)
async update_schedule(request: Request)