MAuth Client Python is an authentication library to manage the information needed to both sign and authenticate requests and responses for Medidata's MAuth authentication system.
To use MAuth Authenticator you will need:
- An MAuth app ID
- An MAuth private key (with the public key registered with Medidata's MAuth server)
To resolve packages using pip, add the following to ~/.pip/pip.conf:
[global]
index-url = https://<username>:<password>@mdsol.jfrog.io/mdsol/api/pypi/pypi-packages/simple/
Install using pip:
$ pip install mauth-client
Or directly from GitHub:
$ pip install git+https://github.com/mdsol/mauth-client-python.git
This will also install the dependencies.
To resolve using a requirements file, the index URL can be specified in the first line of the file:
--index-url https://<username>:<password>@mdsol.jfrog.io/mdsol/api/pypi/pypi-packages/simple/
mauth-client==<latest version>
With Requests library
import requests from mauth_client.requests_mauth import MAuth # MAuth configuration APP_UUID = "<MAUTH_APP_UUID>" private_key = open("private.key", "r").read() mauth = MAuth(APP_UUID, private_key) # Call an MAuth protected resource, in this case an iMedidata API # listing the studies for a particular user user_uuid = "10ac3b0e-9fe2-11df-a531-12313900d531" url = "https://innovate.imedidata.com/api/v2/users/{}/studies.json".format(user_uuid) # Make the requests call, passing the auth client result = requests.get(url, auth=mauth) # Print results if result.status_code == 200: print([r["uuid"] for r in result.json()["studies"]]) print(result.text)
With HTTPX library
import httpx from mauth_client.httpx_mauth import MAuthHttpx # MAuth configuration APP_UUID = "<MAUTH_APP_UUID>" private_key = open("private.key", "r").read() auth = MAuthHttpx(app_uuid=APP_UUID, private_key_data=private_key) client = httpx.Client(auth=auth) response = client.get("https://api.example.com/endpoint")
The following variables can be configured in the environment variables:
| Key | Value |
|---|---|
APP_UUID or MAUTH_APP_UUID |
APP_UUID for signing requests |
PRIVATE_KEY or MAUTH_PRIVATE_KEY |
MAuth private key for the APP_UUID |
The mauth_sign_versions option can be set as an environment variable to specify protocol versions to sign outgoing requests:
| Key | Value |
|---|---|
MAUTH_SIGN_VERSIONS |
(optional) Comma-separated protocol versions to sign requests. Defaults to v1. |
This option can also be passed to the constructor:
mauth_sign_versions = "v1,v2" mauth = MAuth(APP_UUID, private_key, mauth_sign_versions) auth = MAuthHttpx(app_uuid=APP_UUID, private_key_data=private_key, sign_versions=mauth_sign_versions)
MAuth Client Python supports AWS Lambda functions and Flask applications to authenticate MAuth signed requests.
The following variables are required to be configured in the environment variables:
| Key | Value |
|---|---|
APP_UUID or MAUTH_APP_UUID |
APP_UUID for the AWS Lambda function |
PRIVATE_KEY or MAUTH_PRIVATE_KEY |
Encrypted private key for the APP_UUID |
MAUTH_URL |
MAuth service URL (e.g. https://mauth-innovate.imedidata.com) |
The following variables can optionally be set in the environment variables:
| Key | Value |
|---|---|
MAUTH_API_VERSION |
(optional) MAuth API version. Only v1 exists as of this writing. Defaults to v1. |
MAUTH_MODE |
(optional) Method to authenticate requests. local or remote. Defaults to local. |
V2_ONLY_AUTHENTICATE |
(optional) Authenticate requests with only V2. Defaults to False. |
from mauth_client.lambda_authenticator import LambdaAuthenticator authenticator = LambdaAuthenticator(method, url, headers, body) authentic, status_code, message = authenticator.is_authentic() app_uuid = authenticator.get_app_uuid()
To apply to a WSGI application you should use the MAuthWSGIMiddleware. You
can make certain paths exempt from authentication by passing the exempt
option with a set of paths to exempt.
Here is an example for Flask. Note that requesting app's UUID and the protocol version will be added to the request environment for successfully authenticated requests.
from flask import Flask, request, jsonify from mauth_client.consts import ENV_APP_UUID, ENV_PROTOCOL_VERSION from mauth_client.middlewares import MAuthWSGIMiddleware app = Flask("MyApp") app.wsgi_app = MAuthWSGIMiddleware(app.wsgi_app, exempt={"/app_status"}) @app.get("/") def root(): return jsonify({ "msg": "authenticated", "app_uuid": request.environ[ENV_APP_UUID], "protocol_version": request.environ[ENV_PROTOCOL_VERSION], }) @app.get("/app_status") return "this route is exempt from authentication"
To apply to an ASGI application you should use the MAuthASGIMiddleware. You
can make certain paths exempt from authentication by passing the exempt
option with a set of paths to exempt.
Here is an example for FastAPI. Note that requesting app's UUID and the
protocol version will be added to the ASGI scope for successfully
authenticated requests.
from fastapi import FastAPI, Request from mauth_client.consts import ENV_APP_UUID, ENV_PROTOCOL_VERSION from mauth_client.middlewares import MAuthASGIMiddleware app = FastAPI() app.add_middleware(MAuthASGIMiddleware, exempt={"/app_status"}) @app.get("/") async def root(request: Request): return { "msg": "authenticated", "app_uuid": request.scope[ENV_APP_UUID], "protocol_version": request.scope[ENV_PROTOCOL_VERSION], } @app.get("/app_status") async def app_status(): return { "msg": "this route is exempt from authentication", }
See CONTRIBUTING