app package

Subpackages

• app.api namespace
  • Subpackages
    • app.api.packs namespace
      • Submodules
      • app.api.packs.advanced module
      • app.api.packs.campaign module
    • app.api.v2 package
      • Subpackages
      • Submodules
      • app.api.v2.errors module
      • app.api.v2.responses module
      • app.api.v2.security module
      • app.api.v2.validation module
      • Module contents
  • Submodules
  • app.api.rest_api module
    • RestApi
      • RestApi.download_exfil_file()
      • RestApi.download_file()
      • RestApi.enable()
      • RestApi.handle_catch()
      • RestApi.landing()
      • RestApi.logout()
      • RestApi.rest_core()
      • RestApi.rest_core_info()
      • RestApi.upload_file()
      • RestApi.validate_login()
• app.contacts namespace
  • Subpackages
    • app.contacts.handles namespace
      • Submodules
      • app.contacts.handles.h_beacon module
    • app.contacts.tunnels namespace
      • Submodules
      • app.contacts.tunnels.tunnel_ssh module
  • Submodules
  • app.contacts.contact_dns module
    • Contact
      • Contact.start()
      • Contact.stop()
    • DnsAnswerObj
      • DnsAnswerObj.get_bytes()
    • DnsPacket
      • DnsPacket.authoritative_resp_flag
      • DnsPacket.generate_packet_from_bytes()
      • DnsPacket.get_opcode()
      • DnsPacket.get_response_code()
      • DnsPacket.has_standard_query()
      • DnsPacket.is_query()
      • DnsPacket.is_response()
      • DnsPacket.opcode_mask
      • DnsPacket.opcode_offset
      • DnsPacket.query_response_flag
      • DnsPacket.recursion_available()
      • DnsPacket.recursion_available_flag
      • DnsPacket.recursion_desired()
      • DnsPacket.recursion_desired_flag
      • DnsPacket.response_code_mask
      • DnsPacket.truncated()
      • DnsPacket.truncated_flag
    • DnsRecordType
      • DnsRecordType.A
      • DnsRecordType.AAAA
      • DnsRecordType.CNAME
      • DnsRecordType.NS
      • DnsRecordType.TXT
    • DnsResponse
      • DnsResponse.default_ttl
      • DnsResponse.generate_response_for_query()
      • DnsResponse.get_bytes()
      • DnsResponse.max_ttl
      • DnsResponse.max_txt_size
      • DnsResponse.min_ttl
      • DnsResponse.standard_pointer
    • DnsResponseCodes
      • DnsResponseCodes.NXDOMAIN
      • DnsResponseCodes.SUCCESS
    • Handler
      • Handler.ClientRequestContext
      • Handler.FileUploadRequest
      • Handler.MessageType
      • Handler.StoredResponse
      • Handler.TunneledMessage
      • Handler.connection_made()
      • Handler.datagram_received()
      • Handler.generate_dns_tunneling_response_bytes()
  • app.contacts.contact_ftp module
    • Contact
      • Contact.check_config()
      • Contact.ftp_server_python_new()
      • Contact.ftp_server_python_old()
      • Contact.set_up_server()
      • Contact.setup_ftp_users()
      • Contact.start()
      • Contact.stop()
    • FtpHandler
      • FtpHandler.contact_caldera_server()
      • FtpHandler.create_beacon_response()
      • FtpHandler.get_payload_file()
      • FtpHandler.handle_agent_file()
      • FtpHandler.stor()
      • FtpHandler.submit_uploaded_file()
      • FtpHandler.write_file()
  • app.contacts.contact_gist module
    • Contact
      • Contact.GistUpload
      • Contact.VALID_TOKEN_FORMATS
      • Contact.get_beacons()
      • Contact.get_results()
      • Contact.get_uploads()
      • Contact.gist_operation_loop()
      • Contact.handle_beacons()
      • Contact.handle_uploads()
      • Contact.retrieve_config()
      • Contact.start()
      • Contact.valid_config()
    • api_access()
  • app.contacts.contact_html module
    • Contact
      • Contact.start()
  • app.contacts.contact_http module
    • Contact
      • Contact.start()
  • app.contacts.contact_slack module
    • Contact
      • Contact.SlackUpload
      • Contact.get_beacons()
      • Contact.get_results()
      • Contact.get_uploads()
      • Contact.handle_beacons()
      • Contact.handle_uploads()
      • Contact.retrieve_config()
      • Contact.slack_operation_loop()
      • Contact.start()
      • Contact.valid_config()
    • api_access()
  • app.contacts.contact_tcp module
    • Contact
      • Contact.operation_loop()
      • Contact.start()
    • TcpSessionHandler
      • TcpSessionHandler.accept()
      • TcpSessionHandler.refresh()
      • TcpSessionHandler.send()
  • app.contacts.contact_udp module
    • Contact
      • Contact.start()
      • Contact.stop()
    • Handler
      • Handler.datagram_received()
  • app.contacts.contact_websocket module
    • Contact
      • Contact.start()
      • Contact.stop()
    • Handler
      • Handler.handle()
• app.data_encoders namespace
  • Submodules
  • app.data_encoders.base64_basic module
    • Base64Encoder
      • Base64Encoder.decode()
      • Base64Encoder.encode()
    • load()
  • app.data_encoders.plain_text module
    • PlainTextEncoder
      • PlainTextEncoder.decode()
      • PlainTextEncoder.encode()
    • load()
• app.learning namespace
  • Submodules
  • app.learning.p_ip module
    • Parser
      • Parser.parse()
  • app.learning.p_path module
    • Parser
      • Parser.parse()
• app.objects namespace
  • Subpackages
    • app.objects.interfaces namespace
      • Submodules
      • app.objects.interfaces.i_object module
    • app.objects.secondclass namespace
      • Submodules
      • app.objects.secondclass.c_executor module
      • app.objects.secondclass.c_fact module
      • app.objects.secondclass.c_goal module
      • app.objects.secondclass.c_instruction module
      • app.objects.secondclass.c_link module
      • app.objects.secondclass.c_parser module
      • app.objects.secondclass.c_parserconfig module
      • app.objects.secondclass.c_relationship module
      • app.objects.secondclass.c_requirement module
      • app.objects.secondclass.c_result module
      • app.objects.secondclass.c_rule module
      • app.objects.secondclass.c_variation module
      • app.objects.secondclass.c_visibility module
  • Submodules
  • app.objects.c_ability module
    • Ability
      • Ability.HOOKS
      • Ability.add_bucket()
      • Ability.add_executor()
      • Ability.add_executors()
      • Ability.display_schema
      • Ability.executors
      • Ability.find_executor()
      • Ability.find_executors()
      • Ability.remove_all_executors()
      • Ability.schema
      • Ability.store()
      • Ability.unique
      • Ability.which_plugin()
    • AbilitySchema
      • AbilitySchema.Meta
      • AbilitySchema.build_ability()
      • AbilitySchema.fix_id()
      • AbilitySchema.opts
  • app.objects.c_adversary module
    • Adversary
      • Adversary.check_repeatable_abilities()
      • Adversary.has_ability()
      • Adversary.schema
      • Adversary.store()
      • Adversary.unique
      • Adversary.verify()
      • Adversary.which_plugin()
    • AdversarySchema
      • AdversarySchema.Meta
      • AdversarySchema.build_adversary()
      • AdversarySchema.fix_id()
      • AdversarySchema.opts
      • AdversarySchema.phase_to_atomic_ordering()
      • AdversarySchema.remove_properties()
  • app.objects.c_agent module
    • Agent
      • Agent.RESERVED
      • Agent.all_facts()
      • Agent.assign_pending_executor_change()
      • Agent.bootstrap()
      • Agent.calculate_sleep()
      • Agent.capabilities()
      • Agent.deadman()
      • Agent.display_name
      • Agent.executor_change_to_assign
      • Agent.get_preferred_executor()
      • Agent.gui_modification()
      • Agent.heartbeat_modification()
      • Agent.is_global_variable()
      • Agent.kill()
      • Agent.load_schema
      • Agent.privileged_to_run()
      • Agent.replace()
      • Agent.schema
      • Agent.set_pending_executor_path_update()
      • Agent.set_pending_executor_removal()
      • Agent.store()
      • Agent.task()
      • Agent.unique
    • AgentFieldsSchema
      • AgentFieldsSchema.opts
      • AgentFieldsSchema.remove_nulls()
      • AgentFieldsSchema.remove_properties()
    • AgentSchema
      • AgentSchema.build_agent()
      • AgentSchema.opts
  • app.objects.c_data_encoder module
    • DataEncoder
      • DataEncoder.decode()
      • DataEncoder.display_schema
      • DataEncoder.encode()
      • DataEncoder.schema
      • DataEncoder.store()
      • DataEncoder.unique
    • DataEncoderSchema
      • DataEncoderSchema.opts
  • app.objects.c_obfuscator module
    • Obfuscator
      • Obfuscator.display_schema
      • Obfuscator.load()
      • Obfuscator.schema
      • Obfuscator.store()
      • Obfuscator.unique
    • ObfuscatorSchema
      • ObfuscatorSchema.build_obfuscator()
      • ObfuscatorSchema.opts
  • app.objects.c_objective module
    • Objective
      • Objective.completed()
      • Objective.percentage
      • Objective.schema
      • Objective.store()
      • Objective.unique
    • ObjectiveSchema
      • ObjectiveSchema.Meta
      • ObjectiveSchema.build_objective()
      • ObjectiveSchema.opts
      • ObjectiveSchema.remove_properties()
  • app.objects.c_operation module
    • HostSchema
      • HostSchema.opts
    • InvalidOperationStateError
    • Operation
      • Operation.EVENT_EXCHANGE
      • Operation.EVENT_QUEUE_COMPLETED
      • Operation.EVENT_QUEUE_STATE_CHANGED
      • Operation.Reason
      • Operation.States
      • Operation.active_agents()
      • Operation.add_ignored_link()
      • Operation.add_link()
      • Operation.all_facts()
      • Operation.all_relationships()
      • Operation.apply()
      • Operation.cede_control_to_planner()
      • Operation.close()
      • Operation.event_logs()
      • Operation.get_active_agent_by_paw()
      • Operation.get_finished_states()
      • Operation.get_skipped_abilities_by_agent()
      • Operation.get_states()
      • Operation.has_fact()
      • Operation.has_link()
      • Operation.is_closeable()
      • Operation.is_finished()
      • Operation.link_status()
      • Operation.ran_ability_id()
      • Operation.report()
      • Operation.run()
      • Operation.schema
      • Operation.set_start_details()
      • Operation.state
      • Operation.states
      • Operation.store()
      • Operation.unique
      • Operation.update_operation_agents()
      • Operation.update_untrusted_agents()
      • Operation.wait_for_completion()
      • Operation.wait_for_links_completion()
      • Operation.write_event_logs_to_disk()
    • OperationOutputRequestSchema
      • OperationOutputRequestSchema.opts
    • OperationSchema
      • OperationSchema.Meta
      • OperationSchema.build_operation()
      • OperationSchema.opts
      • OperationSchema.remove_properties()
    • OperationSchemaAlt
      • OperationSchemaAlt.chain
      • OperationSchemaAlt.host_group
      • OperationSchemaAlt.opts
      • OperationSchemaAlt.source
      • OperationSchemaAlt.visibility
  • app.objects.c_planner module
    • Planner
      • Planner.display_schema
      • Planner.schema
      • Planner.store()
      • Planner.unique
      • Planner.which_plugin()
    • PlannerSchema
      • PlannerSchema.build_planner()
      • PlannerSchema.fix_id()
      • PlannerSchema.opts
  • app.objects.c_plugin module
    • Plugin
      • Plugin.destroy()
      • Plugin.display_schema
      • Plugin.enable()
      • Plugin.expand()
      • Plugin.load_plugin()
      • Plugin.schema
      • Plugin.store()
      • Plugin.unique
    • PluginSchema
      • PluginSchema.build_plugin()
      • PluginSchema.opts
  • app.objects.c_schedule module
    • Schedule
      • Schedule.schema
      • Schedule.store()
      • Schedule.unique
    • ScheduleSchema
      • ScheduleSchema.Meta
      • ScheduleSchema.build_schedule()
      • ScheduleSchema.opts
  • app.objects.c_source module
    • Adjustment
      • Adjustment.ability_id
      • Adjustment.offset
      • Adjustment.trait
      • Adjustment.value
    • AdjustmentSchema
      • AdjustmentSchema.build_adjustment()
      • AdjustmentSchema.opts
    • Source
      • Source.display_schema
      • Source.schema
      • Source.store()
      • Source.unique
    • SourceSchema
      • SourceSchema.build_source()
      • SourceSchema.fix_adjustments()
      • SourceSchema.opts
• app.planners namespace
  • Submodules
  • app.planners.atomic module
    • LogicalPlanner
      • LogicalPlanner.atomic()
      • LogicalPlanner.execute()
• app.service namespace
  • Subpackages
    • app.service.interfaces namespace
      • Submodules
      • app.service.interfaces.i_app_svc module
      • app.service.interfaces.i_auth_svc module
      • app.service.interfaces.i_contact_svc module
      • app.service.interfaces.i_data_svc module
      • app.service.interfaces.i_event_svc module
      • app.service.interfaces.i_file_svc module
      • app.service.interfaces.i_knowledge_svc module
      • app.service.interfaces.i_learning_svc module
      • app.service.interfaces.i_login_handler module
      • app.service.interfaces.i_object_svc module
      • app.service.interfaces.i_planning_svc module
      • app.service.interfaces.i_rest_svc module
    • app.service.login_handlers namespace
      • Submodules
      • app.service.login_handlers.default module
  • Submodules
  • app.service.app_svc module
    • AppService
      • AppService.errors
      • AppService.find_link()
      • AppService.find_op_with_link()
      • AppService.get_loaded_plugins()
      • AppService.load_plugin_expansions()
      • AppService.load_plugins()
      • AppService.register_contact_tunnels()
      • AppService.register_contacts()
      • AppService.register_subapp()
      • AppService.resume_operations()
      • AppService.retrieve_compiled_file()
      • AppService.run_scheduler()
      • AppService.start_sniffer_untrusted_agents()
      • AppService.teardown()
      • AppService.update_operations_with_untrusted_agent()
      • AppService.validate_requirement()
      • AppService.validate_requirements()
      • AppService.watch_ability_files()
    • Error
      • Error.msg
      • Error.name
      • Error.optional
  • app.service.auth_svc module
    • AuthService
      • AuthService.User
      • AuthService.apply()
      • AuthService.check_permissions()
      • AuthService.create_user()
      • AuthService.default_login_handler
      • AuthService.get_permissions()
      • AuthService.handle_successful_login()
      • AuthService.is_request_authenticated()
      • AuthService.login_redirect()
      • AuthService.login_user()
      • AuthService.logout_user()
      • AuthService.request_has_valid_api_key()
      • AuthService.request_has_valid_user_session()
      • AuthService.set_login_handlers()
    • DictionaryAuthorizationPolicy
      • DictionaryAuthorizationPolicy.authorized_userid()
      • DictionaryAuthorizationPolicy.permits()
    • check_authorization()
    • for_all_public_methods()
  • app.service.contact_svc module
    • ContactService
      • ContactService.build_filename()
      • ContactService.deregister_contacts()
      • ContactService.get_contact()
      • ContactService.get_tunnel()
      • ContactService.handle_heartbeat()
      • ContactService.register_contact()
      • ContactService.register_tunnel()
    • report()
  • app.service.data_svc module
    • DataService
      • DataService.apply()
      • DataService.convert_v0_ability_executor()
      • DataService.convert_v0_ability_requirements()
      • DataService.convert_v0_ability_technique_id()
      • DataService.convert_v0_ability_technique_name()
      • DataService.create_or_update_everything_adversary()
      • DataService.destroy()
      • DataService.get_facts_from_source()
      • DataService.load_ability_file()
      • DataService.load_adversary_file()
      • DataService.load_data()
      • DataService.load_executors_from_list()
      • DataService.load_executors_from_platform_dict()
      • DataService.load_objective_file()
      • DataService.load_requirements_from_list()
      • DataService.load_source_file()
      • DataService.load_yaml_file()
      • DataService.locate()
      • DataService.reload_data()
      • DataService.remove()
      • DataService.restore_state()
      • DataService.save_state()
      • DataService.search()
      • DataService.store()
  • app.service.event_svc module
    • EventService
      • EventService.fire_event()
      • EventService.handle_exceptions()
      • EventService.notify_global_event_listeners()
      • EventService.observe_event()
      • EventService.register_global_event_listener()
  • app.service.file_svc module
    • FileSvc
      • FileSvc.add_special_payload()
      • FileSvc.add_xored_extension()
      • FileSvc.compile_go()
      • FileSvc.create_exfil_operation_directory()
      • FileSvc.create_exfil_sub_directory()
      • FileSvc.find_file_path()
      • FileSvc.get_file()
      • FileSvc.get_payload_name_from_uuid()
      • FileSvc.get_payload_packer()
      • FileSvc.is_extension_xored()
      • FileSvc.list_exfilled_files()
      • FileSvc.read_file()
      • FileSvc.read_result_file()
      • FileSvc.remove_xored_extension()
      • FileSvc.save_file()
      • FileSvc.save_multipart_file_upload()
      • FileSvc.walk_file_path()
      • FileSvc.write_result_file()
  • app.service.knowledge_svc module
    • KnowledgeService
      • KnowledgeService.add_fact()
      • KnowledgeService.add_relationship()
      • KnowledgeService.add_rule()
      • KnowledgeService.check_fact_exists()
      • KnowledgeService.delete_fact()
      • KnowledgeService.delete_relationship()
      • KnowledgeService.delete_rule()
      • KnowledgeService.destroy()
      • KnowledgeService.get_fact_origin()
      • KnowledgeService.get_facts()
      • KnowledgeService.get_meta_facts()
      • KnowledgeService.get_relationships()
      • KnowledgeService.get_rules()
      • KnowledgeService.restore_state()
      • KnowledgeService.save_state()
      • KnowledgeService.update_fact()
      • KnowledgeService.update_relationship()
  • app.service.learning_svc module
    • LearningService
      • LearningService.add_parsers()
      • LearningService.build_model()
      • LearningService.learn()
  • app.service.planning_svc module
    • PlanningService
      • PlanningService.add_ability_to_bucket()
      • PlanningService.check_stopping_conditions()
      • PlanningService.default_next_bucket()
      • PlanningService.execute_planner()
      • PlanningService.exhaust_bucket()
      • PlanningService.generate_and_trim_links()
      • PlanningService.get_cleanup_links()
      • PlanningService.get_links()
      • PlanningService.sort_links()
      • PlanningService.update_stopping_condition_met()
      • PlanningService.wait_for_links_and_monitor()
  • app.service.rest_svc module
    • RestService
      • RestService.add_manual_command()
      • RestService.apply_potential_link()
      • RestService.build_potential_abilities()
      • RestService.build_potential_links()
      • RestService.construct_agents_for_group()
      • RestService.create_operation()
      • RestService.create_schedule()
      • RestService.delete_ability()
      • RestService.delete_adversary()
      • RestService.delete_agent()
      • RestService.delete_operation()
      • RestService.display_objects()
      • RestService.display_operation_report()
      • RestService.display_result()
      • RestService.download_contact_report()
      • RestService.find_abilities()
      • RestService.get_agent_configuration()
      • RestService.get_link_pin()
      • RestService.get_potential_links()
      • RestService.list_exfil_files()
      • RestService.list_payloads()
      • RestService.persist_ability()
      • RestService.persist_adversary()
      • RestService.persist_objective()
      • RestService.persist_source()
      • RestService.task_agent_with_ability()
      • RestService.update_agent_data()
      • RestService.update_chain_data()
      • RestService.update_config()
      • RestService.update_operation()
      • RestService.update_planner()
• app.utility namespace
  • Submodules
  • app.utility.base_knowledge_svc module
    • BaseKnowledgeService
  • app.utility.base_obfuscator module
    • BaseObfuscator
      • BaseObfuscator.run()
  • app.utility.base_object module
    • AppConfigGlobalVariableIdentifier
      • AppConfigGlobalVariableIdentifier.is_global_variable()
    • BaseObject
      • BaseObject.access
      • BaseObject.clean()
      • BaseObject.created
      • BaseObject.display
      • BaseObject.display_schema
      • BaseObject.hash()
      • BaseObject.load()
      • BaseObject.load_schema
      • BaseObject.match()
      • BaseObject.replace_app_props()
      • BaseObject.retrieve()
      • BaseObject.schema
      • BaseObject.search_tags()
      • BaseObject.update()
  • app.utility.base_parser module
    • BaseParser
      • BaseParser.broadcastip()
      • BaseParser.email()
      • BaseParser.filename()
      • BaseParser.ip()
      • BaseParser.line()
      • BaseParser.load_json()
      • BaseParser.set_value()
  • app.utility.base_planning_svc module
    • BasePlanningService
      • BasePlanningService.add_global_variable_owner()
      • BasePlanningService.add_test_variants()
      • BasePlanningService.is_global_variable()
      • BasePlanningService.obfuscate_commands()
      • BasePlanningService.re_index
      • BasePlanningService.re_limited
      • BasePlanningService.re_trait
      • BasePlanningService.re_variable
      • BasePlanningService.remove_completed_links()
      • BasePlanningService.remove_links_above_visibility()
      • BasePlanningService.remove_links_with_unset_variables()
      • BasePlanningService.trim_links()
  • app.utility.base_service module
    • BaseService
      • BaseService.add_service()
      • BaseService.get_service()
      • BaseService.get_services()
      • BaseService.remove_service()
  • app.utility.base_world module
    • AccessSchema
      • AccessSchema.opts
    • BaseWorld
      • BaseWorld.Access
      • BaseWorld.Privileges
      • BaseWorld.TIME_FORMAT
      • BaseWorld.apply_config()
      • BaseWorld.check_requirement()
      • BaseWorld.clear_config()
      • BaseWorld.create_logger()
      • BaseWorld.decode_bytes()
      • BaseWorld.encode_string()
      • BaseWorld.generate_name()
      • BaseWorld.generate_number()
      • BaseWorld.get_config()
      • BaseWorld.get_current_timestamp()
      • BaseWorld.get_timestamp_from_string()
      • BaseWorld.is_base64()
      • BaseWorld.is_uuid4()
      • BaseWorld.jitter()
      • BaseWorld.load_module()
      • BaseWorld.prepend_to_file()
      • BaseWorld.re_base64
      • BaseWorld.set_config()
      • BaseWorld.strip_yml()
    • PrivilegesSchema
      • PrivilegesSchema.opts
  • app.utility.config_generator module
    • ensure_local_config()
    • log_config_message()
    • make_secure_config()
  • app.utility.file_decryptor module
    • decrypt()
    • get_encryptor()
    • read()
  • app.utility.payload_encoder module
    • xor_bytes()
    • xor_file()
  • app.utility.rule_set module
    • RuleAction
      • RuleAction.ALLOW
      • RuleAction.DENY
    • RuleSet
      • RuleSet.apply_rules()
      • RuleSet.is_fact_allowed()

Submodules

app.ascii_banner module

app.ascii_banner.no_color()

app.ascii_banner.print_rich_banner()

Print banner using Python Rich library

app.version module

app.version.get_version()

Module contents