Skip to main content

Python 3 Library to access the NIST Randomness Beacon

Project description

Python NIST Randomness Beacon

WARNING: DO NOT USE BEACON GENERATED VALUES AS SECRET CRYPTOGRAPHIC KEYS.

Installation

Prerequisites

A required library pycryptodome is used with nistbeacon.

Ubuntu, and other Linux-based users should have python3-dev installed.

apt-get install python3-dev

Installing nistbeacon

To install the beacon library, simply use pip:

pip install nistbeacon

Beacon Usage

It is easy to use the beacon. Most queries are performed through NistBeacon which produces NistBeaconValue objects.

Beacon Sample Code

from nistbeacon import NistBeacon

# In the examples below I will be using 1447873020
# as my <timestamp> when required

# Current Record (or next closest)
# https://beacon.nist.gov/rest/record/<timestamp>
record = NistBeacon.get_record(1447873020)

# Previous Record
# https://beacon.nist.gov/rest/record/previous/<timestamp>
prev_record = NistBeacon.get_previous(1447873020)

# Next Record
# https://beacon.nist.gov/rest/record/next/<timestamp>
next_record = NistBeacon.get_next(1447873020)

# First Record
# https://beacon.nist.gov/rest/record/1378395540
first_record = NistBeacon.get_first_record(download=True)

# Last Record
# https://beacon.nist.gov/rest/record/last
last_record = NistBeacon.get_last_record()

# Verify the record and the record chain
record_chain_result = NistBeacon.chain_check(1447873020)

Further Documentation

Please refer to the official documentation to dive deeper into NistBeacon and NistBeaconValue objects.

Contributing

Please refer to the CONTRIBUTING document on GitHub

Project Health

Branch

Build Status

Coverage Status

Master

MasterBuild

MasterCoverage

Develop

DevelopBuild

DevelopCoverage

References

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

nistbeacon-0.9.4.tar.gz (18.4 kB view details)

Uploaded Source

File details

Details for the file nistbeacon-0.9.4.tar.gz.

File metadata

  • Download URL: nistbeacon-0.9.4.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for nistbeacon-0.9.4.tar.gz
Algorithm Hash digest
SHA256 e567810860861de7245d440d5a6e0b4b5d09bfee7aec0da6e36c8b5be1a99d96
MD5 b4629a1c87d875cebc67e7195c98277f
BLAKE2b-256 17eac00533b17d9aa1802382a3a75f95ee57df83bc0148bd14c7c472e1faeac5

See more details on using hashes here.

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