Skip to content
forked from tlsnotary/tlsn

Rust implementation of the TLSNotary protocol

Notifications You must be signed in to change notification settings

chcharcharlie/tlsn

 
 

Repository files navigation

MIT licensed Apache licensed Build Status

Website | Documentation | API Docs | Discord

TLSNotary

⚠️ Notice

This project is currently under active development and should not be used in production. Expect bugs and regular major breaking changes.

License

All crates in this repository are licensed under either of

at your option.

Overview

  • tls: Home of the TLS logic of our protocol like handshake en-/decryption, ghash, currently outdated
  • utils: Utility functions which are frequently used everywhere
  • actors: Provides actors, which implement protocol-specific functionality using the actor pattern. They usually wrap an aio module
  • universal-hash: Implements ghash, which is used AES-GCM. Poly-1305 coming soon.
  • point-addition: Used in key-exchange and allows to compute a two party sharing of an EC curve point

General remarks

  • the TLSNotary codebase makes heavy use of async Rust. Usually an aio crate/module implements the network IO and wraps a core crate/module which provides the protocol implementation. This is a frequent pattern you will encounter in the codebase.
  • some protocols are implemented using the actor pattern to facilitate asynchronous message processing with shared state.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

See CONTRIBUTING.md.

About

Rust implementation of the TLSNotary protocol

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 99.3%
  • Other 0.7%