csle_rest_api.constants package

Submodules

csle_rest_api.constants.constants module

Constants for csle-rest-api

class csle_rest_api.constants.constants.CREATE_EMULATION_PAGE

Bases: object

Constants related to crete_emulation_page resource

BITMASK = 'bitmask'

CELL_OVERHEAD_BYTES = 'cellOverheadBytes'

CLIENT = 'client'

CPU = 'cpu'

DEFAULT_FORWARD = 'defaultForward'

DEFAULT_GATEWAY = 'defaultGateway'

DEFAULT_INPUT = 'defaultInput'

DEFAULT_OUTPUT = 'defaultOutput'

EMULATION_CONTAINER = 'emulationContainer'

EMULATION_DESCRIPTION = 'emulationDescription'

EMULATION_IDS_ENABLED = 'emulationIdsEnabled'

EMULATION_LEVEL = 'emulationLevel'

EMULATION_NAME = 'emulationName'

EMULATION_NETWORK_ID = 'emulationNetworkId'

EMULATION_TIME_STEP_LENGTH = 'emulationTimeStepLength'

EMULATION_VERSION = 'emulationVersion'

FLAG_ID = 'flagId'

FLAG_PERMISSION = 'flagPermission'

FLAG_SCORE = 'flagScore'

HACKER = 'hacker'

INTERFACES = 'interfaces'

IP = 'ip'

LEVEL = 'level'

LIMIT_PACKETS_QUEUE = 'limitPacketsQueue'

LOSS_GE_MODEL_H = 'lossGemodelh'

LOSS_GE_MODEL_K = 'lossGemodelk'

LOSS_GE_MODEL_P = 'lossGemodelp'

LOSS_GE_MODEL_R = 'lossGemodelr'

MEM = 'mem'

NAME = 'name'

OS = 'os'

PACKET_CORRUPT_CORRELATION_PERCENTAGE = 'packetCorruptCorrelationPercentage'

PACKET_CORRUPT_PERCENTAGE = 'packetCorruptPercentage'

PACKET_DELAY_CORRELATION_PERCENTAGE = 'packetDelayCorrelationPercentage'

PACKET_DELAY_DISTRIBUTION = 'packetDelayDistribution'

PACKET_DELAY_JITTER_MS = 'packetDelayJitterMs'

PACKET_DELAY_MS = 'packetDelayMs'

PACKET_DUPLICATE_CORRELATION_PERCENTAGE = 'packetDuplicateCorrelationPercentage'

PACKET_DUPLICATE_PERCENTAGE = 'packetDuplicatePercentage'

PACKET_LOSS_TYPE = 'packetLossType'

PACKET_OVERHEAD_BYTES = 'packetOverheadBytes'

PACKET_REORDER_CORRELATION_PERCENTAGE = 'packetReorderCorrelationPercentage'

PACKET_REORDER_GAP = 'packetReorderGap'

PACKET_REORDER_PERCENTAGE = 'packetReorderPercentage'

PHYSICAL_INTERFACE = 'physicalInterface'

PORT = 'port'

PROTOCOL = 'protocol'

PW = 'pw'

RATE_LIMIT_MBIT = 'rateLimitMbit'

RESTART_POLICY = 'restartPolicy'

ROOT = 'root'

ROUTER = 'router'

SERVICES = 'services'

SERVICE_IP = 'serviceIp'

SUBNET_MASK = 'subnetMask'

SUBNET_PREFIX = 'subnetPrefix'

USERS = 'users'

USER_NAME = 'userName'

VERSION = 'version'

VULNS = 'vulns'

VULN_CREDENTIALS = 'vulnCredentials'

VULN_CRED_PW = 'vulnCredPw'

VULN_CRED_ROOT = 'vulnCredRoot'

VULN_CRED_USERNAME = 'vulnCredUsername'

VULN_NAME = 'vulnName'

VULN_ROOT = 'vulnRoot'

VULN_SERVICE = 'vulnService'

VULN_TYPE = 'vulnType'

class csle_rest_api.constants.constants.MGMT_WEBAPP

Bases: object

Constants related to the management webapp

ABOUT_PAGE_RESOURCE = 'about-page'

ACCEPT_HEADER = 'Accept'

ACCESS_CONTROL_ALLOW_ORIGIN_HEADER = 'Access-Control-Allow-Origin'

ACTIVE_COUNT_PROPERTY = 'active_count'

ADMIN_PROPERTY = 'admin'

AGG_FLOWS_PROPERTY = 'aggflows'

ALPHA_VEC_POLICIES_RESOURCE = 'alpha-vec-policies'

APPLICATION_JSON_DATA_TYPE = 'application/json'

CADVISOR_PORT_PROPERTY = 'cAdvisorPort'

CADVISOR_RESOURCE = 'cadvisor'

CADVISOR_RUNNING_PROPERTY = 'cAdvisorRunning'

CADVISOR_URL_PROPERTY = 'cAdvisorUrl'

CLIENT_MANAGER_SUBRESOURCE = 'client-manager'

CLIENT_POPULATION_SUBRESOURCE = 'client-population'

CLIENT_PRODUCER_SUBRESOURCE = 'client-producer'

CLUSTERMANAGER_RESOURCE = 'clustermanager'

CLUSTER_CONFIG_PROPERTY = 'cluster_config'

CLUSTER_STATUS_RESOURCE = 'clusterstatus'

COLS_PROPERTY = 'cols'

CONFIG_PROPERTY = 'config'

CONFIG_RESOURCE = 'config'

CONTAINER_NAME_PROPERTY = 'container_name'

CONTAINER_SUBRESOURCE = 'container'

CONTAINER_TERMINAL_PAGE_RESOURCE = 'container-terminal-page'

CONTAINER_TERMINAL_SSH_CONNECTION = 'container-terminal-ssh-connection'

CONTAINER_TERMINAL_SSH_SHELL = 'container-terminal-ssh-shell'

CONTENT_TYPE_HEADER = 'Content-type'

CONTROL_PLANE_PAGE_RESOURCE = 'control-plane-page'

CPUS_PROPERTY = 'cpus'

CREATE_EMULATION_PAGE_RESOURCE = 'create-emulation-page'

CREATE_EMULATION_RESOURCE = 'create-emulation'

CREATE_SUBRESOURCE = 'create'

DATA_COLLECTION_JOBS_RESOURCE = 'data-collection-jobs'

DESC_PROPERTY = 'desc'

DOCKER_ENGINE_RUNNING_PROPERTY = 'dockerEngineRunning'

DOCKER_RESOURCE = 'docker'

DOCKER_STATS_MANAGER_SUBRESOURCE = 'docker-stats-manager'

DOCKER_STATS_MONITOR_SUBRESOURCE = 'docker-stats-monitor'

DOWNLOADS_PAGE_RESOURCE = 'downloads-page'

DOWNLOAD_QUERY_PARAM = 'download'

DPID_PROPERTY = 'dpid'

DQN_POLICIES_RESOURCE = 'dqn-policies'

ELASTIC_SUBRESOURCE = 'elastic'

ELEMENT_PROPERTY = 'element'

ELK_MANAGER_SUBRESOURCE = 'elk-manager'

ELK_STACK_SUBRESOURCE = 'elk-stack'

EMAIL_PROPERTY = 'email'

EMPIRICAL_SYSTEM_MODELS_RESOURCE = 'empirical-system-models'

EMPIRICAL_SYSTEM_MODEL_TYPE = 'empirical'

EMULATIONS_PAGE_RESOURCE = 'emulations-page'

EMULATIONS_RESOURCE = 'emulations'

EMULATION_EXECUTIONS_RESOURCE = 'emulation-executions'

EMULATION_PROPERTY = 'emulation'

EMULATION_QUERY_PARAM = 'emulation'

EMULATION_SIMULATION_TRACES_RESOURCE = 'emulation-simulation-traces'

EMULATION_STATISTICS_PAGE_RESOURCE = 'emulation-statistics-page'

EMULATION_STATISTICS_RESOURCE = 'emulation-statistics'

EMULATION_TRACES_RESOURCE = 'emulation-traces'

EXECUTIONS_SUBRESOURCE = 'executions'

EXECUTION_ID_QUERY_PARAM = 'executionid'

EXEC_ID_PROPERTY = 'exec_id'

EXPERIMENTS_RESOURCE = 'experiments'

FILEBEAT_SUBRESOURCE = 'filebeat'

FILE_RESOURCE = 'file'

FIRST_NAME_PROPERTY = 'first_name'

FLASK_PORT_PROPERTY = 'flaskPort'

FLASK_RESOURCE = 'flask'

FLASK_RUNNING_PROPERTY = 'flaskRunning'

FLASK_URL_PROPERTY = 'flaskUrl'

FLOWS_PROPERTY = 'flows'

FNN_W_SOFTMAX_POLICIES_RESOURCE = 'fnn-w-softmax-policies'

GAUSSIAN_MIXTURE_SYSTEM_MODELS_RESOURCE = 'gaussian-mixture-system-models'

GAUSSIAN_MIXTURE_SYSTEM_MODEL_TYPE = 'gaussian_mixture'

GPUS_PROPERTY = 'gpus'

GP_SYSTEM_MODELS_RESOURCE = 'gp-system-models'

GP_SYSTEM_MODEL_TYPE = 'gp'

GRAFANA_PORT_PROPERTY = 'grafanaPort'

GRAFANA_RESOURCE = 'grafana'

GRAFANA_RUNNING_PROPERTY = 'grafanaRunning'

GRAFANA_URL_PROPERTY = 'grafanaUrl'

GROUPS_PROPERTY = 'groups'

GROUP_DESCS_PROPERTY = 'groupdescs'

GROUP_FEATURES_PROPERTY = 'groupfeatures'

HEARTBEAT_SUBRESOURCE = 'heartbeat'

HOST_MANAGER_SUBRESOURCE = 'host-manager'

HOST_MONITOR_SUBRESOURCE = 'host-monitor'

HTTP_REST_DELETE = 'DELETE'

HTTP_REST_GET = 'GET'

HTTP_REST_POST = 'POST'

HTTP_REST_PUT = 'PUT'

IDS_QUERY_PARAM = 'ids'

ID_PROPERTY = 'id'

IMAGES_PAGE_RESOURCE = 'images-page'

IMAGES_RESOURCE = 'images'

INFO_SUBRESOURCE = 'info'

INPUT_PROPERTY = 'input'

IP_PROPERTY = 'ip'

IP_QUERY_PARAM = 'ip'

JOBS_PAGE_RESOURCE = 'jobs-page'

JOBS_RESOURCE = 'jobs'

KAFKA_MANAGER_SUBRESOURCE = 'kafka-manager'

KAFKA_SUBRESOURCE = 'kafka'

KIBANA_SUBRESOURCE = 'kibana'

LAST_NAME_PROPERTY = 'last_name'

LEADER_PROPERTY = 'leader'

LINEAR_THRESHOLD_POLICIES_RESOURCE = 'linear-threshold-policies'

LOGIN_PAGE_RESOURCE = 'login-page'

LOGIN_RESOURCE = 'login'

LOGSTASH_SUBRESOURCE = 'logstash'

LOGS_ADMIN_PAGE_RESOURCE = 'logs-admin-page'

LOGS_PROPERTY = 'logs'

LOGS_RESOURCE = 'logs'

MCMC_SYSTEM_MODELS_RESOURCE = 'mcmc-system-models'

MCMC_SYSTEM_MODEL_TYPE = 'mcmc'

METERS_PROPERTY = 'meters'

METER_CONFIGS_PROPERTY = 'meter_configs'

METER_FEATURES_PROPERTY = 'meter_features'

METRICBEAT_SUBRESOURCE = 'metricbeat'

MONITORING_PAGE_RESOURCE = 'monitoring-page'

MONITORING_RESOURCE = 'monitoring'

MONITOR_SUBRESOURCE = 'monitor'

MULTI_THRESHOLD_POLICIES_RESOURCE = 'multi-threshold-policies'

NAME_PROPERTY = 'name'

NGINX_RESOURCE = 'nginx'

NGINX_RUNNING_PROPERTY = 'nginxRunning'

NODE_EXPORTER_PORT_PROPERTY = 'nodeExporterPort'

NODE_EXPORTER_RESOURCE = 'node-exporter'

NODE_EXPORTER_RUNNING_PROPERTY = 'nodeExporterRunning'

NODE_EXPORTER_URL_PROPERTY = 'nodeExporterUrl'

ORGANIZATION_PROPERTY = 'organization'

OSSEC_IDS_MANAGER_SUBRESOURCE = 'ossec-ids-manager'

OSSEC_IDS_MONITOR_SUBRESOURCE = 'ossec-ids-monitor'

OSSEC_IDS_SUBRESOURCE = 'ossec-ids'

OUTPUT_PROPERTY = 'output'

PACKETBEAT_SUBRESOURCE = 'packetbeat'

PARAMETERS_PROPERTY = 'parameters'

PARAM_RESOURCE = 'param'

PASSWORD_PROPERTY = 'password'

PATH_PROPERTY = 'path'

PGADMIN_PORT_PROPERTY = 'pgAdminPort'

PGADMIN_RESOURCE = 'pgadmin'

PGADMIN_RUNNING_PROPERTY = 'pgAdminRunning'

PGADMIN_URL_PROPERTY = 'pgAdminUrl'

POLICIES_PAGE_RESOURCE = 'policies-page'

POLICIES_RESOURCE = 'policies'

POLICY_EXAMINATION_PAGE_RESOURCE = 'policy-examination-page'

PORT_DESCS_PROPERTY = 'portdescs'

PORT_PROPERTY = 'port'

PORT_STATS_PROPERTY = 'portstats'

POSTGRESQL_RESOURCE = 'postgresql'

POSTGRESQL_RUNNING_PROPERTY = 'postgresqlRunning'

PPO_POLICIES_RESOURCE = 'ppo-policies'

PROMETHEUS_PORT_PROPERTY = 'prometheusPort'

PROMETHEUS_RESOURCE = 'prometheus'

PROMETHEUS_RUNNING_PROPERTY = 'prometheusRunning'

PROMETHEUS_URL_PROPERTY = 'prometheusUrl'

QUEUES_PROPERTY = 'queues'

QUEUE_CONFIGS_PROPERTY = 'queueconfigs'

RAM_PROPERTY = 'RAM'

REASON_PROPERTY = 'reason'

REGISTER_PAGE_RESOURCE = 'register-page'

REGISTRATION_ALLOWED_PROPERTY = 'registration_allowed'

REGISTRATION_ALLOWED_SUBRESOURCE = 'registration-allowed'

ROLES_PROPERTY = 'roles'

ROWS_PROPERTY = 'rows'

RUNNING_PROPERTY = 'running'

RYU_CONTROLLER_SUBRESOURCE = 'ryu-controller'

RYU_MANAGER_SUBRESOURCE = 'ryu-manager'

RYU_MONITOR_SUBRESOURCE = 'ryu-monitor'

SALT_PROPOERTY = 'salt'

SDN_CONTROLLERS_PAGE_RESOURCE = 'sdn-controllers-page'

SDN_CONTROLLERS_RESOURCE = 'sdn-controllers'

SDN_CONTROLLER_LOCAL_PORT = 'sdn-controller-local-port'

SERVER_CLUSTER_PAGE_RESOURCE = 'server-cluster-page'

SERVER_CLUSTER_RESOURCE = 'server-cluster'

SIMULATIONS_PAGE_RESOURCE = 'simulations-page'

SIMULATIONS_RESOURCE = 'simulations'

SIMULATION_PROPERTY = 'simulation'

SIMULATION_TRACES_RESOURCE = 'simulation-traces'

SIZE_PROPERTY = 'size'

SNORT_IDS_MANAGER_SUBRESOURCE = 'snort-ids-manager'

SNORT_IDS_MONITOR_SUBRESOURCE = 'snort-ids-monitor'

SNORT_IDS_SUBRESOURCE = 'snort-ids'

START_ALL_PROPERTY = 'start-all'

START_PROPERTY = 'start'

STATIC = 'static'

STATIC_RESOURCE_INDEX = 'index.html'

STATISTICS_DATASETS_RESOURCE = 'statistics-datasets'

STATISTICS_DATASET_PROPERTY = 'statistics_dataset'

STATISTIC_ID_PROPERTY = 'statistic_id'

STOP_ALL_PROPERTY = 'stop-all'

STOP_PROPERTY = 'stop'

STOP_QUERY_PARAM = 'stop'

SWITCHES_SUBRESOURCE = 'switches'

SYSTEM_ADMIN_PAGE_RESOURCE = 'system-admin-page'

SYSTEM_IDENTIFICATION_JOBS_RESOUCE = 'system-identification-jobs'

SYSTEM_MODELS_PAGE_RESOURCE = 'system-models-page'

SYSTEM_MODELS_RESOURCE = 'system-models'

SYSTEM_MODEL_TYPE = 'system_model_type'

TABLES_PROPERTY = 'tables'

TABLE_FEATURES_PROPERTY = 'tablefeatures'

TABLE_ID_PROPERTY = 'table_id'

TABULAR_POLICIES_RESOURCE = 'tabular-policies'

THREAD_PROPERTY = 'thread'

TOKEN_PROPERTY = 'token'

TOKEN_QUERY_PARAM = 'token'

TRACES_DATASETS_RESOURCE = 'traces-datasets'

TRACES_DATASET_PROPERTY = 'traces_dataset'

TRACES_PAGE_RESOURCE = 'traces-page'

TRACES_RESOURCE = 'traces'

TRAFFIC_GENERATOR_SUBRESOURCE = 'traffic-generator'

TRAFFIC_MANAGER_SUBRESOURCE = 'traffic-manager'

TRAINING_JOBS_RESOURCE = 'training-jobs'

TRAINING_PAGE_RESOURCE = 'training-page'

TRAINING_RESOURCE = 'training'

TRAJECTORIES_PROPERTY = 'trajectories'

URL_PROPERTY = 'url'

USERNAME_PROPERTY = 'username'

USERS_RESOURCE = 'users'

USER_ADMIN_PAGE_RESOURCE = 'user-admin-page'

USER_PROPERTY = 'user'

VALUE_RESOURCE = 'value'

VECTOR_POLICIES_RESOURCE = 'vector-policies'

VERSION_PROPERTY = 'version'

VERSION_RESOURCE = 'version'

WS_CONNECT_MSG = 'connect'

WS_CONTAINER_TERMINAL_INPUT_MSG = 'container-terminal-input'

WS_CONTAINER_TERMINAL_NAMESPACE = 'container-terminal'

WS_CONTAINER_TERMINAL_OUTPUT_MSG = 'container-terminal-output'

WS_RESIZE_MSG = 'resize'

class csle_rest_api.constants.constants.SESSION_TOKENS

Bases: object

Constants related to session tokens

EXPIRE_TIME_HOURS = 48

Module contents