# 5. Cloud Operations `pyrasp` is capable to operate in a 'cloud' environment: * Retrieve initial configuration and updates from remote server * Retrieve Blacklist from remote server at startup * Provide regular agent status to remote server * Provide basic telemetry (cpu & memory usage, number of requests) * Share new blacklisted entries * Update blacklist with new entries provided by remote server ## Run ### Flask & FastAPI `pyrasp` instance creation requires 2 specific arguments: * `cloud_url`: URL to retrieve agent configuration from * `key`: unique key to identify the agent `(, cloud_url = , key = )` > Those 2 parameters can be set as environment vaiables - see [Environment Variables](#environment-variables) ```python from pyrasp.pyrasp import FastApiRASP app = FastAPI() rasp = FastApiRASP(app, cloud_url = 'https://pyrasp.my.org/config', key = '000000-1111-2222-3333-44444444' ) ``` ### Django For cloud agents, `PYRASP_CLOUD_URL` and `PYRASP_KEY` variables must be added to the `settings.py` file of the Django application: * `PYRASP_CLOUD_URL` contains the URL to retrieve agent configuration from * `PYRASP_KEY` is used by the server to uniquely identify the agent. ```python PYRASP_CLOUD_URL = 'https://pyrasp.my.org/config' PYRASP_KEY = '000000-1111-2222-3333-44444444' MIDDLEWARE = [ 'pyrasp.pyrasp.DjangoRASP', ... ] ``` ### AWS Lambda, Google Cloud Functions and Azure Function `pyrasp` instance creation requires 2 specific arguments: * `cloud_url`: URL to retrieve agent configuration from * `key`: unique key to identify the agent `@(cloud_url = , key = )` > Those 2 parameters can be set as environment variables - see [Environment Variables](#environment-variables) ```python @LambdaRASP(cloud_url = 'https://pyrasp.my.org/config', key = '000000-1111-2222-3333-44444444').register def lambda_handler(event, context): ... ``` ```python @GcpRASP(cloud_url = 'https://pyrasp.my.org/config', key = '000000-1111-2222-3333-44444444').register def lambda_handler(event, context): ... ``` ### Environment Variables `cloud_url` and `key` values can be set as environment variables: * `PYRASP_CLOUD_URL`: URL to retrieve agent configuration from * `PYRASP_KEY`: unique key to identify the agent ## Connection Upon connection the `pyrasp` agent sends a POST request to the specified `PYRASP_CLOUD_URL`. Format of the JSON content is provided below. ```json { "key": "", "version": "", "platform": "", "routes": { "": { "methods": [ "", ... ], "path": "" } } } ``` ## Configuration download ### Overview Configuration file and blacklist are retrieved by the agent through a `GET` request to the URL specified. At agent startup the remote configuration URL is displayed. ``` ### PyRASP v0.9.2 ########## [+] Starting PyRASP [+] Loading template configuration: default [+] Loading configuration from http://pyrasp.my.org/config [+] XSS model loaded [+] SQLI model loaded [+] Prompt Injection model loaded [+] Starting logging process [+] PyRASP succesfully started ############################ ``` ### Format The response to the request **MUST** be an `application/json` body containing the configuration.\ The data structure **MUST** be a dictionary (`{}`) The JSON configuration **MUST** be provided in the `config` key.\ Optionaly an initial blacklist can be provided as a dictionary structure in the `blacklist` key of the response.\ The blacklist structure **MUST** comply with the format detailed in the example below. ### Configuration example ```json { "config": { "HOSTS" : ["mysite.mydomain.com"], "APP_NAME" : "Web Server", "GTFO_MSG" : "

You have been blocked

", "DENY_STATUS_CODE": 403, ... }, "blacklist": { "": , ... } } ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://paracyberbellum.gitbook.io/pyrasp/5.-cloud-operations.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.