Skip to main content

Python Yubikey AWS signature library

Project description

Exile stores your AWS access key on your YubiKey device and uses it to sign your AWS API requests, protecting you against credential theft.

Installation

pip install exile

Synopsis

import base64, logging
import boto3, botocore.auth
from exile import YKOATH, SCardManager

logging.basicConfig(level=logging.INFO)

ykoath = YKOATH(SCardManager())

def write_active_aws_key_to_yubikey():
    credentials = boto3.Session().get_credentials()
    secret_name = "exile-" + credentials.access_key[len("AKIA"):]
    # This is for SigV4 only. Other formats will require a separate secret
    secret = b"AWS4" + credentials.secret_key.encode()
    print("Writing YubiKey OATH credential", secret_name, "for", credentials.access_key)
    ykoath.put(secret_name, secret, algorithm=YKOATH.Algorithm.SHA256)

write_active_aws_key_to_yubikey()

class YKSigV4Auth(botocore.auth.SigV4Auth):
    def signature(self, string_to_sign, request):
        key_name = "exile-" + self.credentials.access_key[len("AKIA"):]
        k_date = ykoath.calculate(key_name, request.context['timestamp'][0:8].encode(), want_truncated_response=False)
        k_region = self._sign(k_date, self._region_name)
        k_service = self._sign(k_region, self._service_name)
        k_signing = self._sign(k_service, "aws4_request")
        return self._sign(k_signing, string_to_sign, hex=True)

botocore.auth.SigV4Auth.signature = YKSigV4Auth.signature

print("Using YubiKey credential to perform AWS call")
print(boto3.client("sts").get_caller_identity())

Authors

  • Andrey Kislyuk

Bugs

Please report bugs, issues, feature requests, etc. on GitHub.

License

Licensed under the terms of the Apache License, Version 2.0.

https://img.shields.io/travis/com/pyauth/exile.svg https://codecov.io/github/pyauth/exile/coverage.svg?branch=master https://img.shields.io/pypi/v/exile.svg https://img.shields.io/pypi/l/exile.svg https://readthedocs.org/projects/exile/badge/?version=latest

Project details


Download files

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

Source Distribution

exile-0.0.3.tar.gz (10.9 kB view hashes)

Uploaded Source

Built Distribution

exile-0.0.3-py3-none-any.whl (14.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page