mse-cli 0.10.1

Python CLI for MicroService Encryption

Microservice Encryption Command-Line (MSE)

Overview

Python CLI for Microservice Encryption. See Github repository.

Read the MSE documentation.

Install

$ pip install -r requirements.txt
$ pip install -U .

Usage

Pre-requisites

First of all sign up or sign in using:

$ mse login

Download the mse-app-examples repository. And go to the helloworld directory.

You can find an example of flask application and a mse.toml configuration file.

Deployment

You can deploy this application as follow:

$ cd helloworld
$ mse deploy --path mse.toml

mse creates <uuid>.toml in $MSE_CONF_PATH/context for each new deployment which contains some context data.

If --path is not provided, mse is expecting a mse.toml in the current directory when using deploy subcommand.

More subcommands

$ mse --help

More parameters

You can use these following env variables:

• MSE_CONF_PATH to use another directory than ~/.config/mse/
• MSE_BASE_URL to use another backend url than https://backend.mse.cosmian.com
• MSE_AUTH0_DOMAIN_NAME to specify another auth0 login url
• MSE_AUTH0_CLIENT_ID to specify another auth0 tenant client id
• MSE_AUTH0_AUDIENCE to specify another tenant audience
• MSE_CONSOLE_URL to specify another console URL
• MSE_PCCS_URL to specify another PCCS URL

Development & Test

To work with the development/test environment, you shall edit the following variables with their proper values:

• MSE_CONF_PATH
• MSE_AUTH0_CLIENT_ID
• MSE_AUTH0_DOMAIN_NAME
• MSE_BASE_URL
• MSE_AUTH0_AUDIENCE
• MSE_CONSOLE_URL
• MSE_PCCS_URL

Do the same, if you need to use de staging environment.

Then you first need to login in in order to generate a session. Then run the test.

$ mse login
$ export MSE_TEST_DOMAIN_NAME="EDIT"
$ export MSE_TEST_PRIVATE_KEY="EDIT"
$ export MSE_TEST_PUBLIC_KEY="EDIT"
$ pytest

Documentation

$ cd documentation
$ mkdocs serve

then open your browser on: http://127.0.0.1:8003/