Metadata-Version: 2.4
Name: settled-sdk
Version: 0.1.0
Summary: Python SDK for the Settled tamper-evident audit log
Project-URL: Homepage, https://github.com/richardadalton/settled
Project-URL: Repository, https://github.com/richardadalton/settled
Author-email: Richard Dalton <richard.a.dalton@gmail.com>
License: Elastic License 2.0
        
        URL: https://www.elastic.co/licensing/elastic-license
        
        ## Acceptance
        
        By using the software, you agree to all of the terms and conditions below.
        
        ## Copyright License
        
        The licensor grants you a non-exclusive, royalty-free, worldwide,
        non-sublicensable, non-transferable license to use, copy, distribute, make
        available, and prepare derivative works of the software, in each case subject to
        the limitations and conditions below.
        
        ## Limitations
        
        **You may not** provide the software to third parties as a hosted or managed
        service, where the service provides users with access to any substantial set of
        the features or functionality of the software.
        
        **You may not** move, change, disable, or circumvent the license key
        functionality in the software, and you may not remove or obscure any
        functionality in the software that is protected by the license key.
        
        **You may not** alter, remove, or obscure any licensing, copyright, or other
        notices of the licensor in the software. Any use of the licensor's trademarks is
        subject to applicable law.
        
        ## Patents
        
        The licensor grants you a license, under any patent claims the licensor can
        license, or becomes able to license, to make, have made, use, sell, offer for
        sale, import and have imported the software, in each case subject to the
        limitations and conditions in this license. This license does not cover any
        patent claims that you cause to be infringed by modifications or additions to the
        software. If you or your company make any written claim that the software
        infringes or contributes to infringement of any patent, your patent license for
        the software granted under these terms ends immediately.
        
        ## Notices
        
        You must ensure that anyone who gets a copy of any part of the software from you
        also gets a copy of these terms.
        
        If you modify the software, you must include in any modified copies of the
        software prominent notices stating that you have modified the software.
        
        ## No Other Rights
        
        These terms do not imply any licenses other than those expressly granted in these
        terms.
        
        ## Termination
        
        If you use the software in violation of these terms, such use is not licensed,
        and your licenses will automatically terminate. If the licensor provides you with
        a notice of your violation, and you cease all violation of this license no later
        than 30 days after you receive that notice, your licenses will be reinstated
        retroactively. However, if you violate these terms after such reinstatement, any
        additional violation of these terms will cause your licenses to terminate
        automatically and permanently.
        
        ## No Liability
        
        *As far as the law allows, the software comes as is, without any warranty or
        condition, and the licensor will not be liable to you for any damages arising out
        of these terms or the use or nature of the software, under any kind of legal
        claim.*
        
        ## Definitions
        
        The **licensor** is the entity offering these terms, and the **software** is the
        software the licensor makes available under these terms, including any portion of
        it.
        
        **you** refers to the individual or entity agreeing to these terms.
        
        **your company** is any legal entity, sole proprietorship, or other kind of
        organization that you work for, plus all organizations that have control over,
        are under the control of, or are under common control with that organization.
        **Control** means ownership of substantially all the assets of an entity, or the
        power to direct its management and legal affairs.
        
        **your licenses** are all the licenses granted to you for the software under
        these terms.
        
        **use** means anything you do with the software requiring one of your licenses.
        
        **trademark** means trademarks, service marks, and similar rights.
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Requires-Dist: cryptography>=42.0.0
Requires-Dist: grpcio-tools>=1.62.0
Requires-Dist: grpcio>=1.62.0
Requires-Dist: protobuf>=4.25.0
Provides-Extra: dev
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Description-Content-Type: text/markdown

# settled-sdk

Python SDK for [Settled](https://github.com/richardadalton/settled), a tamper-evident audit log built on RFC 6962 Merkle trees.

## Installation

```bash
pip install settled-sdk
```

## Usage

### Connecting to a Settled server

```python
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

```python
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](LICENSE)
