CYST:

• User’s documentation
  • First steps
    • Setting it all up
    • Running the first do-nothing code
    • Creating the first simulated machine
    • Creating a vulnerable service
    • Networking
    • Creating and controlling an adversary
    • Simulating the first interaction
    • Coming up next
• Developer’s documentation
  • Hacking on existing packages
    • Getting the AIF package and setting it all up
    • Using the package
    • Shit! My change requires hacking on the core as well
  • Creating a new package
    • Package structure
    • Package setup
    • Internal logic - models
    • Internal logic - services
• API reference
  • cyst.api.configuration
    • ConfigItem
    • cyst.api.configuration.host
      • ActiveServiceConfig
      • PassiveServiceConfig
    • cyst.api.configuration.logic
    • cyst.api.configuration.logic.access
      • AuthorizationConfig
      • FederatedAuthorizationConfig
      • AuthorizationDomainType
      • AuthorizationDomainConfig
      • AuthenticationProviderConfig
      • AccessSchemeConfig
    • cyst.api.configuration.logic.data
      • DataConfig
    • cyst.api.configuration.logic.exploit
      • VulnerableServiceConfig
      • ExploitParameterConfig
      • ExploitConfig
    • cyst.api.configuration.network
    • cyst.api.configuration.network.elements
      • PortConfig
      • InterfaceConfig
      • ConnectionConfig
      • RouteConfig
    • cyst.api.configuration.network.node
      • NodeConfig
    • cyst.api.configuration.network.firewall
      • FirewallChainConfig
      • FirewallConfig
    • cyst.api.configuration.network.router
      • RouterConfig
    • cyst.api.configuration.network.network
      • NetworkConfig
  • cyst.api.environment
    • cyst.api.environment.environment
      • EnvironmentMode
      • Environment
        • Environment.configuration
        • Environment.control
        • Environment.messaging
        • Environment.policy
        • Environment.resources
        • Environment.configure()
        • Environment.create()
    • cyst.api.environment.configuration
      • EnvironmentConfiguration
        • EnvironmentConfiguration.general
        • EnvironmentConfiguration.node
        • EnvironmentConfiguration.service
        • EnvironmentConfiguration.network
        • EnvironmentConfiguration.exploit
        • EnvironmentConfiguration.action
        • EnvironmentConfiguration.access
      • GeneralConfiguration
        • GeneralConfiguration.get_configuration()
        • GeneralConfiguration.save_configuration()
        • GeneralConfiguration.load_configuration()
        • GeneralConfiguration.get_configuration_by_id()
        • GeneralConfiguration.get_object_by_id()
      • NodeConfiguration
        • NodeConfiguration.create_node()
        • NodeConfiguration.create_router()
        • NodeConfiguration.create_port()
        • NodeConfiguration.create_interface()
        • NodeConfiguration.create_route()
        • NodeConfiguration.add_interface()
        • NodeConfiguration.set_interface()
        • NodeConfiguration.add_service()
        • NodeConfiguration.remove_service()
        • NodeConfiguration.set_shell()
        • NodeConfiguration.add_traffic_processor()
        • NodeConfiguration.add_route()
        • NodeConfiguration.add_routing_rule()
        • NodeConfiguration.set_routing_policy()
        • NodeConfiguration.list_routes()
      • ServiceParameter
      • ServiceConfiguration
        • ServiceConfiguration.create_active_service()
        • ServiceConfiguration.get_service_interface()
        • ServiceConfiguration.create_passive_service()
        • ServiceConfiguration.update_service_version()
        • ServiceConfiguration.set_service_parameter()
        • ServiceConfiguration.create_data()
        • ServiceConfiguration.public_data()
        • ServiceConfiguration.private_data()
        • ServiceConfiguration.public_authorizations()
        • ServiceConfiguration.private_authorizations()
        • ServiceConfiguration.sessions()
        • ServiceConfiguration.provides_auth()
        • ServiceConfiguration.set_scheme()
      • NetworkConfiguration
        • NetworkConfiguration.add_node()
        • NetworkConfiguration.add_connection()
        • NetworkConfiguration.get_connections()
        • NetworkConfiguration.create_session()
        • NetworkConfiguration.append_session()
        • NetworkConfiguration.create_session_from_message()
      • ExploitConfiguration
        • ExploitConfiguration.create_vulnerable_service()
        • ExploitConfiguration.create_exploit_parameter()
        • ExploitConfiguration.create_exploit()
        • ExploitConfiguration.add_exploit()
        • ExploitConfiguration.clear_exploits()
      • ActionConfiguration
        • ActionConfiguration.create_action_parameter_domain_any()
        • ActionConfiguration.create_action_parameter_domain_range()
        • ActionConfiguration.create_action_parameter_domain_options()
      • AccessConfiguration
        • AccessConfiguration.create_authentication_provider()
        • AccessConfiguration.create_authentication_token()
        • AccessConfiguration.register_authentication_token()
        • AccessConfiguration.unregister_authentication_token()
        • AccessConfiguration.create_and_register_authentication_token()
        • AccessConfiguration.create_authorization()
        • AccessConfiguration.create_access_scheme()
        • AccessConfiguration.add_provider_to_scheme()
        • AccessConfiguration.add_authorization_to_scheme()
        • AccessConfiguration.remove_authorization_from_scheme()
        • AccessConfiguration.evaluate_token_for_service()
        • AccessConfiguration.disable_authentication_token()
        • AccessConfiguration.enable_authentication_token()
        • AccessConfiguration.create_service_access()
        • AccessConfiguration.modify_existing_access()
    • cyst.api.environment.control
      • EnvironmentState
      • EnvironmentControl
        • EnvironmentControl.state
        • EnvironmentControl.init()
        • EnvironmentControl.commit()
        • EnvironmentControl.reset()
        • EnvironmentControl.run()
        • EnvironmentControl.pause()
        • EnvironmentControl.terminate()
        • EnvironmentControl.add_pause_on_request()
        • EnvironmentControl.remove_pause_on_request()
        • EnvironmentControl.add_pause_on_response()
        • EnvironmentControl.remove_pause_on_response()
        • EnvironmentControl.snapshot_save()
        • EnvironmentControl.snapshot_load()
        • EnvironmentControl.transaction_start()
        • EnvironmentControl.transaction_commit()
        • EnvironmentControl.transaction_rollback()
    • cyst.api.environment.messaging
      • EnvironmentMessaging
        • EnvironmentMessaging.send_message()
        • EnvironmentMessaging.create_request()
        • EnvironmentMessaging.create_response()
        • EnvironmentMessaging.open_session()
    • cyst.api.environment.policy
      • EnvironmentPolicy
        • EnvironmentPolicy.create_authorization()
        • EnvironmentPolicy.get_authorizations()
        • EnvironmentPolicy.decide()
        • EnvironmentPolicy.get_schemas()
        • EnvironmentPolicy.get_nodes()
        • EnvironmentPolicy.get_services()
        • EnvironmentPolicy.get_access_level()
    • cyst.api.environment.resources
      • EnvironmentResources
        • EnvironmentResources.action_store
        • EnvironmentResources.exploit_store
        • EnvironmentResources.clock
        • EnvironmentResources.statistics
    • cyst.api.environment.stores
      • ActionStore
        • ActionStore.get()
        • ActionStore.get_ref()
        • ActionStore.get_prefixed()
        • ActionStore.add()
      • ExploitStore
        • ExploitStore.get_exploit()
        • ExploitStore.evaluate_exploit()
    • cyst.api.environment.clock
      • Clock
        • Clock.simulation_time()
        • Clock.hybrid_time()
        • Clock.timeout()
    • cyst.api.environment.interpreter
      • ActionInterpreter
        • ActionInterpreter.evaluate()
      • ActionInterpreterDescription
    • cyst.api.environment.message
      • MessageType
      • StatusOrigin
      • StatusValue
      • StatusDetail
      • Status
      • Message
        • Message.id
        • Message.type
        • Message.src_ip
        • Message.dst_ip
        • Message.src_service
        • Message.dst_service
        • Message.session
        • Message.auth
        • Message.ttl
        • Message.metadata
        • Message.set_metadata()
        • Message.cast_to()
      • Request
        • Request.action
      • Response
        • Response.status
        • Response.content
      • Timeout
        • Timeout.start_time
        • Timeout.duration
        • Timeout.parameter
    • cyst.api.environment.metadata_provider
      • MetadataProvider
        • MetadataProvider.register_action_parameters()
        • MetadataProvider.get_metadata()
      • MetadataProviderDescription
    • cyst.api.environment.stats
      • Statistics
        • Statistics.run_id
        • Statistics.configuration_id
        • Statistics.start_time_real
        • Statistics.end_time_real
        • Statistics.end_time_virtual
  • cyst.api.host
    • cyst.api.host.service
      • Service
        • Service.name
        • Service.owner
        • Service.service_access_level
        • Service.passive_service
        • Service.active_service
      • ActiveService
        • ActiveService.run()
        • ActiveService.process_message()
      • ActiveServiceDescription
      • ServiceState
      • PassiveService
        • PassiveService.version
        • PassiveService.state
        • PassiveService.tags
        • PassiveService.enable_session
        • PassiveService.session_access_level
        • PassiveService.local
  • cyst.api.logic
    • cyst.api.logic.access
      • AccessLevel
      • AuthenticationTokenType
      • AuthenticationTokenSecurity
      • AuthenticationProviderType
      • AuthenticationToken
        • AuthenticationToken.type
        • AuthenticationToken.security
        • AuthenticationToken.identity
        • AuthenticationToken.copy()
        • AuthenticationToken.content
      • AuthenticationTarget
        • AuthenticationTarget.address
        • AuthenticationTarget.service
        • AuthenticationTarget.tokens
      • Authorization
        • Authorization.identity
        • Authorization.access_level
        • Authorization.expiration
        • Authorization.token
      • AuthenticationProvider
        • AuthenticationProvider.type
        • AuthenticationProvider.target
        • AuthenticationProvider.token_is_registered()
      • AccessScheme
        • AccessScheme.factors
        • AccessScheme.identities
        • AccessScheme.authorizations
    • cyst.api.logic.action
      • ActionParameterDomainType
      • ActionParameterDomain
        • ActionParameterDomain.type
        • ActionParameterDomain.range_min
        • ActionParameterDomain.range_max
        • ActionParameterDomain.range_step
        • ActionParameterDomain.options
        • ActionParameterDomain.validate()
        • ActionParameterDomain.default
      • ActionParameterType
      • ActionParameter
      • ActionToken
      • ActionDescription
      • Action
        • Action.id
        • Action.description
        • Action.fragments
        • Action.namespace
        • Action.exploit
        • Action.set_exploit()
        • Action.parameters
        • Action.add_parameters()
        • Action.tokens
        • Action.copy()
    • cyst.api.logic.data
      • Data
        • Data.id
        • Data.owner
        • Data.description
    • cyst.api.logic.exploit
      • ExploitCategory
      • ExploitLocality
      • ExploitParameterType
      • ExploitParameter
        • ExploitParameter.type
        • ExploitParameter.value
        • ExploitParameter.set_value()
      • VulnerableService
        • VulnerableService.id
        • VulnerableService.min_version
        • VulnerableService.max_version
      • Exploit
        • Exploit.id
        • Exploit.services
        • Exploit.locality
        • Exploit.category
        • Exploit.parameters
    • cyst.api.logic.metadata
      • Event
      • TCPFlags
      • Protocol
      • FlowDirection
      • Flow
      • Metadata
  • cyst.api.network
    • cyst.api.network.elements
      • Route
      • Port
        • Port.ip
        • Port.mask
        • Port.net
        • Port.connection
      • Interface
        • Interface.gateway
      • Connection
        • Connection.delay
        • Connection.blocked
        • Connection.set_params()
        • Connection.evaluate()
    • cyst.api.network.firewall
      • FirewallPolicy
      • FirewallRule
      • FirewallChainType
      • Firewall
        • Firewall.list_rules()
        • Firewall.add_local_ip()
        • Firewall.remove_local_ip()
        • Firewall.add_rule()
        • Firewall.remove_rule()
        • Firewall.set_default_policy()
        • Firewall.get_default_policy()
        • Firewall.evaluate()
    • cyst.api.network.node
      • Node
        • Node.type
        • Node.services
        • Node.shell
        • Node.interfaces
        • Node.ips
        • Node.gateway()
    • cyst.api.network.session
      • Session
        • Session.owner
        • Session.id
        • Session.parent
        • Session.path
        • Session.end
        • Session.start
        • Session.enabled
  • cyst.api.utils

Indices and tables

• Index

• Module Index

• Search Page