search

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

hashtag
Run

hashtag
Flask & FastAPI

pyrasp instance creation requires 2 specific arguments:

  • cloud_url: URL to retrieve agent configuration from

  • key: unique key to identify the agent

<rasp_class>(<framework_instance>, cloud_url = <configuration_url>, key = <agent_key>)

Those 2 parameters can be set as environment vaiables - see Environment Variables

from pyrasp.pyrasp import FastApiRASP
app = FastAPI()
rasp = FastApiRASP(app, cloud_url = 'https://pyrasp.my.org/config', key = '000000-1111-2222-3333-44444444' )

hashtag
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.

hashtag
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

@<rasp_class>(cloud_url = <configuration_url>, key = <agent_key>)

Those 2 parameters can be set as environment variables - see Environment Variables

hashtag
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

hashtag
Connection

Upon connection the pyrasp agent sends a POST request to the specified PYRASP_CLOUD_URL. Format of the JSON content is provided below.

hashtag
Configuration download

hashtag
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.

hashtag
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.

hashtag
Configuration example

Previous4. Event Logs FormatNext6. Status, Telemetry, Configuration & Blacklist updates

Last updated