Skip to main content

Library for accessing Swagger-enabled API's with bitjws authentication.

Project description

Bravado-bitjws is an add on for Bravado that allows bitjws authentication.

Install

By default it’s expected that secp256k1 is available, so install it before proceeding; make sure to run ./configure --enable-module-recovery. If you’re using some other library that provides the functionality necessary for this, check the Using a custom library section of the bitjws README.

Bravado-bitjws can be installed by running:

pip install bravado-bitjws

Building secp256k1

In case you need to install the secp256k1 C library, the following sequence of commands is recommended. If you already have secp256k1, make sure it was compiled from the expected git commit or it might fail to work due to API incompatibilities.

git clone git://github.com/bitcoin/secp256k1.git libsecp256k1
cd libsecp256k1
git checkout d7eb1ae96dfe9d497a26b3e7ff8b6f58e61e400a
./autogen.sh
./configure --enable-module-recovery
make
sudo make install

Usage

Bravado-bitjws is used just like Bravado. The primary difference users need to be aware of is the management of bitjws keys.

Create a client with existing keys

# Your bitjws private key in WIF
privkey = "KweY4PozGhtkGPMvvD7vk7nLiN6211XZ2QGxLBMginAQW7MBbgp8"

# the URL of the swagger spec
url = "http://0.0.0.0:8002/static/swagger.json"

# initialize your client
client = BitJWSSwaggerClient.from_url(url, privkey=privkey)

If no key is provided to BitJWSSwaggerClient, one will be generated. However the private key originated, it is important to store private key somewhere secure.

Known Limitations

Currently there is no management of server keys. This means that Bravado-bitjws checks the signature of server responses, but trusts all keys. It is up to the Bravado-bitjws user to match the server’s key against a trusted list.

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

bravado-bitjws-0.1.2.tar.gz (6.6 kB view details)

Uploaded Source

File details

Details for the file bravado-bitjws-0.1.2.tar.gz.

File metadata

File hashes

Hashes for bravado-bitjws-0.1.2.tar.gz
Algorithm Hash digest
SHA256 ac43320a89145f5bb6190d6c2268260a7038fbac1b009bf69415e7916f11d6d2
MD5 eb679a43b31fe6e15a783e2d25d69833
BLAKE2b-256 00f6ba77d9c68f52eee201a782f7991fbcb624f1c57a728b4033df5468bee0c6

See more details on using hashes here.

Supported by

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