Skip to content

Commit

Permalink
Add crypto faq
Browse files Browse the repository at this point in the history
  • Loading branch information
xnorpx committed Nov 26, 2024
1 parent 423361b commit db81288
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -524,6 +524,35 @@ don't let that stop you from building amazing applications!
Yes! str0m excels as a server component with support for both RTP API and Sample API. You can
easily build that recording server or SFU you dreamt of in Rust!

#### Crypto in str0m

##### What cryptographic provider does str0m use?
- On non-Windows platforms, str0m uses OpenSSL as the primary cryptographic provider.
- On Windows, you can choose between:
- wincrypto: Uses Windows Crypto API (CNG).
- openssl: Uses OpenSSL as the cryptographic backend.

##### What are the build options for OpenSSL?
When using OpenSSL, there are two alternatives:
- Vendored: Downloads and builds OpenSSL from source. This ensures compatibility and avoids
dependency on system-provided OpenSSL.
- Non-vendored: Relies on the OpenSSL library provided by the system.

##### What's the recommended build configuration?
For the easiest build experience:
- On Windows: Use wincrypto.
- On Non-Windows Platforms: Use openssl and vendored.

##### Does str0m support a pure Rust DTLS implementation?
Currently, str0m does not include a pure Rust implementation of DTLS. It relies on external
cryptographic libraries like OpenSSL for DTLS functionality.

##### Can I contribute a DTLS implementation?
Yes! Contributions for a DTLS 1.2 implementation are welcome, but note:
- It should be synchronous.
- It should be implemented entirely in pure Rust.
If you're interested in contributing, feel free to discuss with the str0m maintainers before starting.

#### Can I deploy the chat example into production?

While the chat example showcases how to use str0m's API, it's not intended for production use or
Expand Down
29 changes: 29 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -535,6 +535,35 @@
//! Yes! str0m excels as a server component with support for both RTP API and Sample API. You can
//! easily build that recording server or SFU you dreamt of in Rust!
//!
//! ### Crypto in str0m
//!
//! #### What cryptographic provider does str0m use?
//! - On non-Windows platforms, str0m uses OpenSSL as the primary cryptographic provider.
//! - On Windows, you can choose between:
//! - wincrypto: Uses Windows Crypto API (CNG).
//! - openssl: Uses OpenSSL as the cryptographic backend.
//!
//! #### What are the build options for OpenSSL?
//! When using OpenSSL, there are two alternatives:
//! - Vendored: Downloads and builds OpenSSL from source. This ensures compatibility and avoids
//! dependency on system-provided OpenSSL.

Check failure on line 549 in src/lib.rs

View workflow job for this annotation

GitHub Actions / lint

doc list item without indentation
//! - Non-vendored: Relies on the OpenSSL library provided by the system.
//!
//! #### What's the recommended build configuration?
//! For the easiest build experience:
//! - On Windows: Use wincrypto.
//! - On Non-Windows Platforms: Use openssl, vendored.
//!
//! #### Does str0m support a pure Rust DTLS implementation?
//! Currently, str0m does not include a pure Rust implementation of DTLS. It relies on external
//! cryptographic libraries like OpenSSL for DTLS functionality.
//!
//! #### Can I contribute a DTLS implementation?
//! Yes! Contributions for a DTLS 1.2 implementation are welcome, but note:
//! - It should be synchronous.
//! - It should be implemented entirely in pure Rust.
//! If you're interested in contributing, feel free to discuss with the str0m maintainers before starting.

Check failure on line 565 in src/lib.rs

View workflow job for this annotation

GitHub Actions / lint

doc list item without indentation
//!
//! ### Can I deploy the chat example into production?
//!
//! While the chat example showcases how to use str0m's API, it's not intended for production use or
Expand Down

0 comments on commit db81288

Please sign in to comment.