Skip to main content

Python SDK for the Settled tamper-evident audit log

Project description

settled-sdk

Python SDK for Settled, a tamper-evident audit log built on RFC 6962 Merkle trees.

Installation

pip install settled-sdk

Usage

Connecting to a Settled server

from settled import SettledClient

client = SettledClient("localhost:50051")

# Append an entry
result = client.append(b"my audit event")

# Get the current Signed Tree Head
sth = client.get_sth()

# Verify inclusion
proof = client.inclusion_proof(result.leaf_index, sth.tree_size)

Verifying proofs independently

from settled import verify_inclusion, verify_consistency, verify_tree_head

# Verify that an entry is included in a tree
verify_inclusion(leaf_hash, leaf_index, tree_size, proof_hashes, root_hash)

# Verify consistency between two tree heads
verify_consistency(old_size, new_size, proof_hashes, old_root, new_root)

# Verify the signature on a Signed Tree Head
verify_tree_head(sth, public_key_bytes)

License

Elastic License 2.0

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

settled_sdk-0.1.0.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

settled_sdk-0.1.0-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file settled_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: settled_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for settled_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7ef915d12d54b7a921bde8b035caebacd5b4d1c1c6dd81886bea2be730081c60
MD5 55177a4e3aca8e2c31cc2b0bc1872ffd
BLAKE2b-256 fd977f672337197eba0f2ace90d2b16810e92dcf3006fe9516f339e27326dc47

See more details on using hashes here.

File details

Details for the file settled_sdk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: settled_sdk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for settled_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8a764cb3d00a7bf038724c4364a5b478fbc1bb7d128f667f9bb2e748dd609a78
MD5 927ba099bfaf11d7947f10d5571cec66
BLAKE2b-256 11a5ab96363a75e4c1fa1372f87508f6370c439ca83846d3a0e82d0817528ecb

See more details on using hashes here.

Supported by

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