Skip to main content

A Jupyter server extension to proxy requests with AWS SigV4 authentication

Project description

AWS Jupyter Proxy

CodeBuild Version Code style: black

A Jupyter server extension to proxy requests with AWS SigV4 authentication.

Overview

This server extension enables the usage of the AWS JavaScript/TypeScript SDK without having to export AWS credentials to the browser.

A single /awsproxy endpoint is added on the Jupyter server which receives incoming requests from the browser, uses the credentials on the server to add SigV4 authentication to the request, and then proxies the request to the actual AWS service endpoint.

All requests are proxied back-and-forth as-is, e.g., a 4xx status code from the AWS service will be relayed back as-is to the browser.

NOTE: This project is still under active development

Install

Installing the package from PyPI will install and enable the server extension on the Jupyter server.

pip install aws-jupyter-proxy

Usage

Using this requries no additional dependencies in the client-side code. Just use the regular AWS JavaScript/TypeScript SDK methods and add any dummy credentials and change the endpoint to the /awsproxy endpoint.

    import * as AWS from 'aws-sdk';
    import SageMaker from 'aws-sdk/clients/sagemaker';


    // These credentials are *not* used for the actual AWS service call but you have
    // to provide any dummy credentials (Not real ones!)
    AWS.config.secretAccessKey = 'IGNOREDIGNORE/IGNOREDIGNOREDIGNOREDIGNOR';
    AWS.config.accessKeyId = 'IGNOREDIGNO';

    // Change the endpoint in the client to the "awsproxy" endpoint on the Jupyter server.
    const proxyEndpoint = 'http://localhost:8888/awsproxy';

    const sageMakerClient = new SageMaker({
        region: 'us-west-2',
        endpoint: proxyEndpoint,
    });

    // Make the API call!
    await proxySageMaker
        .listNotebookInstances({
            NameContains: 'jaipreet'
        })
        .promise();

Usage with S3

For S3, use the s3ForcePathStyle parameter during the client initialization

    import S3 from 'aws-sdk/clients/s3';

    const s3Client = new S3({
        region: 'us-west-2',
        endpoint: proxyEndpoint,
        s3ForcePathStyle: true
    });

    await s3Client.getObject({
        Bucket: 'my-bucket',
        Key: 'my-object'
    }).promise();

Development

Install all dev dependencies

pip install -e ".[dev]"
jupyter serverextension enable --py aws_jupyter_proxy

Run unit tests using pytest

pytest tests/unit

License

This library is licensed under the Apache 2.0 License.

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for aws-jupyter-proxy, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size aws_jupyter_proxy-0.1.0-py2.py3-none-any.whl (16.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size aws_jupyter_proxy-0.1.0.tar.gz (10.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page