Skip to content

goto-opensource/secure-frame-rs

Repository files navigation

Secure Frame (SFrame)

build version Crates.io license documentation maintenance

This library is now continued and maintainend under https://github.com/TobTheRock/sframe-rs

This library is an implementation of draft-ietf-sframe-enc-03 and provides and end-to-end encryption mechanism for media frames that is suited for WebRTC conferences. It is in it's current form a subset of the specification. There is an alternative implementation under goto-opensource/secure-frame-ts

Differences from the sframe draft

  • ratcheting is not implemented
  • keyIds are used as senderIds
  • no metadata authentication

Supported crypto libraries

Currently two crypto libraries are supported:

  • ring
    • is enabled per default with the feature ring
    • supports compilation to Wasm32
    • Aes-CTR mode ciphers are not supported
  • openssl
    • is enabled with the feature openssl
      • To build e.g. use cargo build --features openssl --no-default-features
    • uses rust bindings to OpenSSL.
    • Per default the OpenSSL library is locally compiled and then statically linked. The build process requires a C compiler, perl (and perl-core), and make. For further options see the openssl crate documentation.
    • Compilation to Wasm32 is not yet supported

Both cannot be enabled at the same time, thus on conflict sframe issues a compiler error.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

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

Contribution

Any help in form of descriptive and friendly issues or comprehensive pull requests are welcome!

The Changelog of this library is generated from its commit log, there any commit message must conform with https://www.conventionalcommits.org/en/v1.0.0/. For simplicity you could make your commits with convco.