Cybex-P API Module

The Cybex-P API Module is the gateway for all data that travels in and out of Cybex-P during collection and posting. Cybex-P API is combintation of two sub-modules; the Data Input sub-module and the Report Publishing sub-module. The Data Input sub-module deals with the parsing of posted raw data and transferring of it to the backend. The Report Publishing sub-module deals with the handling of report request and the returning of any available ports to the user. In addition to being the gateway to the Cybex-P services, The API module also works as another checkpoint of additional privacy preservation in which the data gets further encrypted.

graph LR A[Cybex-P Input] --> B B(Cybex-P API) --> C C(Cybex-P Cache Data Lake)

Cybex-P API Repositories

the Cybex-P API Module and it’s sub-modules is comprised of the following three modules.

  • API

    • URL calls

    • Frontend to backend services

  • views

    • Privacy preservation

    • Report querying and status updates

    • Data parsing and processing

  • Resource

    • Token validation

    • User authentication

    • Appending of new users and organiztion

    • Configurations

    • Access control Lists


the Cybex-P API (not to be confused with Cybex-P API Module, which is the entire backend API module) is where URL calls are made depending on the type of desired service. The API modules web backend runs off the Falcon framework.

The following calls can be made to Cybex-P API:






Utility call to ping the backend



When called, checks the status of the previously provided data set and returns it if available



Call the raw module and proceeds to parse and prepare the inputted data to be sent to the cache data lake



Register a new organization in Cybex-P



Register a new user



Register a new user under an organization



Pull Organization information



Delete a user from an organization



Get the information of the current admins of an organization



Get the information of all users under an organization



Get information on the current sessions user


The Views module is a respository of various functions and utility that encompass the funtionality behind Cybex-P API Module’s two sub-modules. The Data Input sub-module utilizes the raw module for the handling of raw data posted to the API while Report Publishing sub-module utilizes the query module for the handling of report request made by users. Both sub-modules also rely on the crypto repository to handle the encryption of posted data and querys made by users.

  • raw

    • Raw data that is supplied from the frontend arrives at the Raw module. When called, it pulls the database config information and issues a timestamp index for the call. Raw then takes the raw unfiltered data (which comes in the form of an Input Configuration Object that is passed to it) and begins to parise it. That raw data arrives in the form of a long list of strings that is scanned for the following mandatory keys:

    • typetag

    • name

    • orgid

    • timezone

    • config_hash

    • Once the The above tags have been identified. The data to be processed along with the identifying tags get encrypted with the public key of the archive server and gets stored in the cache data lake.

  • query

    • The query module is responsible for the handling and retrieval of report queries made to the backend. When called, all forms of input data are encoded into a canonical formatting and then encrypted via the crpyto module. A report query is then made via the Cybex-P language TDQL.

    query = TDQL(qtype, enc_qdata, qhash, userid, time.time())

    • qtype -> data itype

    • enc_qdata -> JSON of the data query

    • qhash -> sha256 hexdigest of the data

    • userid -> hash of the user who requested the report

    • time.time() -> timestamp of the report query

    • If a TDQL call returns with a status “ready”. the entire report is handed off to the responds media and returned to the client. Otherwise, the status will be indicated as “processing” and will prompt with an additional message “check back later”.

  • crypto

    • The crypto module is a utility-based module used by both the query and raw module and is largely responsible for providing and handling the privacy preservation aspect of the Cybex-P API Module. The modules sole function is take the the provided API POST data (when called by the other 2 modules) and encrypt it with the public key of the archive modules’ server.

    • def encrypt_filfe( fbytes, fpub_name=”pub.pem”)

    • Before the data itself gets encrypted, a 32-byte long session key is generated and encrypted with the provided public RSA key (by default the public key is stored in “pub.pem”). Once the session key is encrypted, the data gets encrypted with the AES session key.

    • enc_session_key = cipher_rsa.encrypt(session_key)

    • A string made out of the concatenation of the encrypted session key, nonce, tag, and ciphertext is then returned as hash that works as an identity hash of the encrypted data.

    • dout = enc_session_key + cipher_aes.nonce + tag + ciphertext

    • return dout


The resource module contains a variety of decorator functions and utility functions meant to handle and support the more miscellaneous task of the Cybex-P API Module. Some of these task include:

  • Token authentication

  • Login authentication

  • Hash supplying

  • User preferences and configuration

  • New user and organization registration

And more internal responsibilities such as:

  • System exception handling

  • Backend configurations

  • Required input fields

Common is the code in resources that contains common resources and decorators widely used throughout the Cybex-P API Module.

  • configureIDBackend() :

    • use by to setup the identity backend. The information on the backend identity gets stored in the two variables below. If the following variables aren’t properly set, the rest of the code will not work.

    • ResourceBase._backend = _backend

    • Identity._backend = _backend

  • early_return()

    • Utility dectorator used by other decorators as a way to early return from any function call if a decorator calls for an early return. It is meant to be placed between any decorators before the action calling of the function. That is because if any of the previous decorators delcare an error on their part, early_return() can return a true as a way of allowing the previous decorater to return that error message; It also signals the current process to return earlier.

  • exception_handler() :

    • This decorator function is in tandem with almost all other functions and API endpoint calls in the API module. the exception handler signals on any errors such as a bad HTTP request, Invalid input, and if the backend is currently down and/or not working properly.

  • require_fields() :

    • Another decorator function that is responsible for establishing the fields mandated in order to process a request. If any fields are missing from a request, a response of "Missing the following fields: {}" is returned with a HTTP 400.

  • validate_org() :

    • This function takes the provided JSON Web Token (JWT) of an organization request and ensures the validity of it and authentication. If the token is valid, it will return the request organization object

  • validate_user() :

    • Works equivalently to validate_org() , Just with returning a user object is the token is valid

config deals with initializing the an organization object and it’s required keys within the Cybex-P API.


  • AddConfig()

    • Main Class of the config source code

    • Takes in a python dictionary that contains a set of values corresponding to the Identity of backends and Input configurations

    • Those values then get pulled and are formed into a TAHOE Input configuration that belongs to that organization/user

Identity contains functionality to handle various responsibilities of user and organization management, authentication, and access control list modification. Every class in the Identity source code is decorated with the validate_user() and exception_handler() functions from Common to assist with authentication and exception handling capabilities.


  • CreateOrg() :

    • Takes a request to register and create an organization in Cybex-P.

  • CreateUser() :

    • Takes a request to register and create an user in Cybex-P.

  • OrgAddUser() :

    • Appends a new user to an organization. Users can be appended in one of three different privilege categories to an organization object:

      • admin : add the user as a new admin to the org

      • user : add the user as a new general user under the org

      • acl : add the user as a general user under the organizations access control list (acl)

  • OrgInfo() :

    • Returns information of an organization based on the request. This function can return information on the list of admins, users, and users under the organizations access control list. The user making the request must have admin privileges of their organization.

  • OrgDelUser() :

    • Takes a request to remove a user from the acl or admin privileges of an organization. If the user is delete from the general user category of an orgnization, that user is removed from the organization as a whole and does not exist in the list of users. Must have admin privileges to request

  • OrgsAdminOf() :

    • Provides a list of organizations that a user is an admin to

  • OrgsUserOf() :

    • Provides a list of organizations that a user exist under

  • UserInfoSelf() :

    • Provides information on the current user

The following are deprecated or previous functions in the source code:

validate_token() - Decorator function that checks the validity of a token, failures will return a response code of 401. tokens are received from request_data[“token”] of a user request,

extract_request_data() - Decorator function that grabs the data from the falcon request objected and passes it to the decorated function as ‘request_data’. The required_fields parameter is often used with the decorator to properly extract certain pieces of data within a query; otherwise, the request_data will only contain the timestamp of the call.

exception_handler() - This decorator function is in tandem with almost all other functions and API endpoint calls in the API module. the exception handler signals on any errors such as a bad HTTP request, Invalid input, and if the backend is currently down and/or not working properly.

early_return() - Utility dectorator used by other decorators as a way to early return from any function call if a decorator calls for an early return.

get_org_object() - checks to see if the key org_hash is present within the argument request_data. If it fails, then a response code 400 is returned. This decorator will pull ‘org_hash’ from request_data[“org_hash”] and place the org tahoe object under org_object.





  • Public key

    • Public key of the Cybex-P API module, used with the privacy preservation system

  • Config repository

    • JSON format configurations of other module identities and the backend databases

      • api

      • cache

      • report

      • identity

      • tahoe

      • archive

      • analytics

  • load_config

    • handles the execution and updating of the API backend and module configurations

  • uwsgi

    • service file configuration for uwsgi instance