Skip to content

Commit c4fb93f

Browse files
authored
feat: add compile_error! when no crypto backend is enabled (#569)
1 parent e2fd9be commit c4fb93f

4 files changed

Lines changed: 503 additions & 492 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
Low-level Tokio SSH2 client and server implementation.
88

9+
> **Crypto backends:** enable at least one of the `aws-lc-rs` or `ring` features. `russh` fails to compile when both are disabled because a crypto backend is required.
10+
911
Examples: [simple client](russh/examples/client_exec_simple.rs), [interactive PTY client](russh/examples/client_exec_interactive.rs), [server](russh/examples/echoserver.rs), [SFTP client](russh/examples/sftp_client.rs), [SFTP server](russh/examples/sftp_server.rs).
1012

1113
This is a fork of [Thrussh](https://nest.pijul.com/pijul/thrussh) by Pierre-Étienne Meunier.

russh/Cargo.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,15 @@ rust-version = "1.75"
1414

1515
[features]
1616
default = ["flate2", "aws-lc-rs", "rsa"]
17-
aws-lc-rs = ["dep:aws-lc-rs"]
17+
# Crypto backends: enable at least one of `aws-lc-rs` or `ring`.
18+
aws-lc-rs = ["dep:aws-lc-rs"] # Default crypto backend.
1819
async-trait = ["dep:async-trait"]
1920
legacy-ed25519-pkcs8-parser = ["yasna"]
2021
# Danger: 3DES cipher is insecure.
2122
des = ["dep:des"]
2223
# Danger: DSA algorithm is insecure.
2324
dsa = ["ssh-key/dsa"]
24-
ring = ["dep:ring"]
25+
ring = ["dep:ring"] # Alternative crypto backend.
2526
rsa = ["dep:rsa", "dep:pkcs1", "ssh-key/rsa", "ssh-key/rsa-sha1"]
2627
_bench = ["dep:criterion"]
2728

0 commit comments

Comments
 (0)