Skip to content

ssh-key: add crypto feature#83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tarcieri merged 1 commit into from
Mar 8, 2023
Merged

ssh-key: add crypto feature #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions .github/workflows/ssh-key.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@ jobs:
toolchain: ${{ matrix.rust }}
target: ${{ matrix.target }}
- uses: RustCrypto/actions/cargo-hack-install@master
- run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features default,getrandom,std
- run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features crypto,default,getrandom,std --release

test:
runs-on: ubuntu-latest
Expand All@@ -84,9 +84,12 @@ jobs:
with:
toolchain: ${{ matrix.rust }}
- uses: RustCrypto/actions/cargo-hack-install@master
- run: cargo hack test --feature-powerset --exclude-features aes-gcm,default,encryption,getrandom,std
- run: cargo test --features aes-gcm
- run: cargo test --features encryption
- run: cargo test --features getrandom
- run: cargo test --features std
- run: cargo test --all-features
- run: cargo hack test --feature-powerset --exclude-features aes-gcm,crypto,default,encryption,getrandom,std --release
- run: cargo test --release
- run: cargo test --release --features aes-gcm
- run: cargo test --release --features crypto
- run: cargo test --release --features encryption
- run: cargo test --release --features getrandom
- run: cargo test --release --features std
- run: cargo test --all-features # debug build
- run: cargo test --release --all-features
1 change: 1 addition & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions ssh-key/Cargo.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ ed25519-dalek = { version = "=2.0.0-pre.0", optional = true, default-features =
p256 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
p384 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
rand_core = { version = "0.6.4", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false, features = ["sha2"] }
sec1 = { version = "0.7", optional = true, default-features = false, features = ["point"] }
serde = { version = "1", optional = true }
sha1 = { version = "0.10", optional = true, default-features = false }
Expand DownExpand Up@@ -62,12 +62,15 @@ std = [
]

aes-gcm = ["dep:aes-gcm", "encryption"]
crypto = ["aes-gcm", "ed25519", "p256", "p384", "rsa"] # NOTE: `dsa` is obsolete/weak
dsa = ["dep:bigint", "dep:dsa", "dep:sha1", "alloc", "signature/rand_core"]
ecdsa = ["dep:sec1"]
ed25519 = ["dep:ed25519-dalek", "rand_core"]
encryption = [ "alloc", "dep:aes", "dep:bcrypt-pbkdf", "dep:ctr", "rand_core"]
getrandom = ["rand_core/getrandom"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core", "sha2/oid"]
p256 = ["dep:p256", "ecdsa"]
p384 = ["dep:p384", "ecdsa"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core"]

[package.metadata.docs.rs]
all-features = true
Expand Down
10 changes: 8 additions & 2 deletions ssh-key/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ respective SSH key algorithm.
- [ ] [RFC4716] public keys
- [ ] SEC1

## Supported algorithms
### Supported Signature Algorithms

| Name | Decode | Encode | Cert | Keygen | Sign | Verify | Feature | `no_std` |
|--------------------------------------|--------|--------|------|--------|------|--------|-----------|----------|
Expand All@@ -74,7 +74,13 @@ respective SSH key algorithm.
| `sk‑ecdsa‑sha2‑nistp256@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |
| `sk‑ssh‑ed25519@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |

Note: the "Feature" section lists the name of `ssh-key` crate features which can
By default *no algorithms are enabled* and you will get an
`Error::AlgorithmUnsupported` error if you try to use them.

Enable the `crypto` feature or the "Feature" for specific algorithms in the
chart above (e.g. `p256`, `rsa`) in order to use cryptographic functionality.

The "Feature" column lists the name of `ssh-key` crate features which can
be enabled to provide full support for the "Keygen", "Sign", and "Verify"
functionality for a particular SSH key algorithm.

Expand Down
50 changes: 18 additions & 32 deletions ssh-key/tests/certificate_builder.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
//! Certificate builder tests.

#![cfg(all(feature = "alloc", any(feature = "ed25519", feature = "p256")))]
#![cfg(all(
feature = "alloc",
feature = "rand_core",
any(feature = "ed25519", feature = "p256")
))]

use hex_literal::hex;
use rand_chacha::{rand_core::SeedableRng, ChaCha8Rng};
use ssh_key::{
certificate::{self, CertType},
Algorithm, PrivateKey,
};
use ssh_key::{certificate, Algorithm, PrivateKey};

#[cfg(feature = "p256")]
use ssh_key::EcdsaCurve;

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
use std::str::FromStr;

/// Example Unix timestamp when a certificate was issued (2020-09-13 12:26:40 UTC).
Expand All@@ -24,36 +25,21 @@ const VALID_AT: u64 = 1650000000;
/// Example Unix timestamp when a certificate expires (2023-11-14 22:13:20 UTC).
const EXPIRES_AT: u64 = 1700000000;

/// Example serial number.
const SERIAL: u64 = 42;

/// Example key ID.
const KEY_ID: &str = "example";

/// Example principal name.
const PRINCIPAL: &str = "nobody";

/// Critical extension 1.
const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");

/// Critical extension 1.
const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");

/// Non critical extension 1.
const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");

/// Non critical extension 2.
const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");

/// Example comment.
const COMMENT: &str = "user@example.com";

/// Seed to use for PRNG.
const PRNG_SEED: [u8; 32] = [42; 32];

#[cfg(feature = "ed25519")]
#[test]
fn ed25519_sign_and_verify() {
const SERIAL: u64 = 42;
const KEY_ID: &str = "example";
const PRINCIPAL: &str = "nobody";
const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");
const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");
const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");
const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");
const COMMENT: &str = "user@example.com";

let mut rng = ChaCha8Rng::from_seed(PRNG_SEED);

let ca_key = PrivateKey::random(&mut rng, Algorithm::Ed25519).unwrap();
Expand DownExpand Up@@ -89,7 +75,7 @@ fn ed25519_sign_and_verify() {
assert_eq!(cert.nonce(), &hex!("321fdf7e0a2afe803308f394f54c6abe"));
assert_eq!(cert.public_key(), subject_key.public_key().key_data());
assert_eq!(cert.serial(), SERIAL);
assert_eq!(cert.cert_type(), CertType::User);
assert_eq!(cert.cert_type(), certificate::CertType::User);
assert_eq!(cert.key_id(), KEY_ID);
assert_eq!(cert.valid_principals().len(), 1);
assert_eq!(cert.valid_principals()[0], PRINCIPAL);
Expand DownExpand Up@@ -140,7 +126,7 @@ fn ecdsa_nistp256_sign_and_verify() {
assert!(cert.validate_at(VALID_AT, &[ca_fingerprint]).is_ok());
}

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
#[test]
fn rsa_sign_and_verify() {
let ca_key = PrivateKey::from_str(
Expand Down
7 changes: 6 additions & 1 deletion ssh-key/tests/sshsig.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@
use hex_literal::hex;
use ssh_key::{Algorithm, HashAlg, LineEnding, PublicKey, SshSig};

#[cfg(any(feature = "dsa", feature = "ed25519", feature = "rsa"))]
#[cfg(any(
feature = "dsa",
feature = "ed25519",
feature = "p256",
feature = "rsa"
))]
use ssh_key::PrivateKey;

#[cfg(feature = "ed25519")]
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
ssh-key: add `crypto` feature by tarcieri · Pull Request #83 · RustCrypto/SSH · GitHub
Skip to content
ssh-key: add crypto feature#83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 1 commit into

from

Mar 8, 2023
 Merged


ssh-key: add crypto feature
#83
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


17 changes: 10 additions & 7 deletions
.github/workflows/ssh-key.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@ jobs:
 toolchain: ${{ matrix.rust }}
 target: ${{ matrix.target }}
 - uses: RustCrypto/actions/cargo-hack-install@master
 - run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features default,getrandom,std
 - run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features crypto,default,getrandom,std --release

 test:
 runs-on: ubuntu-latest
Expand All@@ -84,9 +84,12 @@ jobs:
 with:
 toolchain: ${{ matrix.rust }}
 - uses: RustCrypto/actions/cargo-hack-install@master
 - run: cargo hack test --feature-powerset --exclude-features aes-gcm,default,encryption,getrandom,std
 - run: cargo test --features aes-gcm
 - run: cargo test --features encryption
 - run: cargo test --features getrandom
 - run: cargo test --features std
 - run: cargo test --all-features
 - run: cargo hack test --feature-powerset --exclude-features aes-gcm,crypto,default,encryption,getrandom,std --release
 - run: cargo test --release
 - run: cargo test --release --features aes-gcm
 - run: cargo test --release --features crypto
 - run: cargo test --release --features encryption
 - run: cargo test --release --features getrandom
 - run: cargo test --release --features std
 - run: cargo test --all-features # debug build
 - run: cargo test --release --all-features

1 change: 1 addition & 0 deletions
Cargo.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


7 changes: 5 additions & 2 deletions
ssh-key/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ ed25519-dalek = { version = "=2.0.0-pre.0", optional = true, default-features =
p256 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
p384 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
rand_core = { version = "0.6.4", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false, features = ["sha2"] }
sec1 = { version = "0.7", optional = true, default-features = false, features = ["point"] }
serde = { version = "1", optional = true }
sha1 = { version = "0.10", optional = true, default-features = false }
Expand DownExpand Up@@ -62,12 +62,15 @@ std = [
]

aes-gcm = ["dep:aes-gcm", "encryption"]
crypto = ["aes-gcm", "ed25519", "p256", "p384", "rsa"] # NOTE: `dsa` is obsolete/weak
dsa = ["dep:bigint", "dep:dsa", "dep:sha1", "alloc", "signature/rand_core"]
ecdsa = ["dep:sec1"]
ed25519 = ["dep:ed25519-dalek", "rand_core"]
encryption = [ "alloc", "dep:aes", "dep:bcrypt-pbkdf", "dep:ctr", "rand_core"]
getrandom = ["rand_core/getrandom"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core", "sha2/oid"]
p256 = ["dep:p256", "ecdsa"]
p384 = ["dep:p384", "ecdsa"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core"]

[package.metadata.docs.rs]
all-features = true
Expand Down

10 changes: 8 additions & 2 deletions
ssh-key/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ respective SSH key algorithm.
 - [ ] [RFC4716] public keys
 - [ ] SEC1

## Supported algorithms
### Supported Signature Algorithms

| Name | Decode | Encode | Cert | Keygen | Sign | Verify | Feature | `no_std` |
|--------------------------------------|--------|--------|------|--------|------|--------|-----------|----------|
Expand All@@ -74,7 +74,13 @@ respective SSH key algorithm.
| `sk‑ecdsa‑sha2‑nistp256@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |
| `sk‑ssh‑ed25519@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |

Note: the "Feature" section lists the name of `ssh-key` crate features which can
By default *no algorithms are enabled* and you will get an
`Error::AlgorithmUnsupported` error if you try to use them.

Enable the `crypto` feature or the "Feature" for specific algorithms in the
chart above (e.g. `p256`, `rsa`) in order to use cryptographic functionality.

The "Feature" column lists the name of `ssh-key` crate features which can
be enabled to provide full support for the "Keygen", "Sign", and "Verify"
functionality for a particular SSH key algorithm.

Expand Down

50 changes: 18 additions & 32 deletions
ssh-key/tests/certificate_builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
//! Certificate builder tests.

#![cfg(all(feature = "alloc", any(feature = "ed25519", feature = "p256")))]
#![cfg(all(
 feature = "alloc",
 feature = "rand_core",
 any(feature = "ed25519", feature = "p256")
))]

use hex_literal::hex;
use rand_chacha::{rand_core::SeedableRng, ChaCha8Rng};
use ssh_key::{
 certificate::{self, CertType},
 Algorithm, PrivateKey,
};
use ssh_key::{certificate, Algorithm, PrivateKey};

#[cfg(feature = "p256")]
use ssh_key::EcdsaCurve;

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
use std::str::FromStr;

/// Example Unix timestamp when a certificate was issued (2020-09-13 12:26:40 UTC).
Expand All@@ -24,36 +25,21 @@ const VALID_AT: u64 = 1650000000;
/// Example Unix timestamp when a certificate expires (2023-11-14 22:13:20 UTC).
const EXPIRES_AT: u64 = 1700000000;

/// Example serial number.
const SERIAL: u64 = 42;

/// Example key ID.
const KEY_ID: &str = "example";

/// Example principal name.
const PRINCIPAL: &str = "nobody";

/// Critical extension 1.
const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");

/// Critical extension 1.
const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");

/// Non critical extension 1.
const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");

/// Non critical extension 2.
const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");

/// Example comment.
const COMMENT: &str = "user@example.com";

/// Seed to use for PRNG.
const PRNG_SEED: [u8; 32] = [42; 32];

#[cfg(feature = "ed25519")]
#[test]
fn ed25519_sign_and_verify() {
 const SERIAL: u64 = 42;
 const KEY_ID: &str = "example";
 const PRINCIPAL: &str = "nobody";
 const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");
 const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");
 const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");
 const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");
 const COMMENT: &str = "user@example.com";

 let mut rng = ChaCha8Rng::from_seed(PRNG_SEED);

 let ca_key = PrivateKey::random(&mut rng, Algorithm::Ed25519).unwrap();
Expand DownExpand Up@@ -89,7 +75,7 @@ fn ed25519_sign_and_verify() {
 assert_eq!(cert.nonce(), &hex!("321fdf7e0a2afe803308f394f54c6abe"));
 assert_eq!(cert.public_key(), subject_key.public_key().key_data());
 assert_eq!(cert.serial(), SERIAL);
 assert_eq!(cert.cert_type(), CertType::User);
 assert_eq!(cert.cert_type(), certificate::CertType::User);
 assert_eq!(cert.key_id(), KEY_ID);
 assert_eq!(cert.valid_principals().len(), 1);
 assert_eq!(cert.valid_principals()[0], PRINCIPAL);
Expand DownExpand Up@@ -140,7 +126,7 @@ fn ecdsa_nistp256_sign_and_verify() {
 assert!(cert.validate_at(VALID_AT, &[ca_fingerprint]).is_ok());
}

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
#[test]
fn rsa_sign_and_verify() {
 let ca_key = PrivateKey::from_str(
Expand Down

7 changes: 6 additions & 1 deletion
ssh-key/tests/sshsig.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@
use hex_literal::hex;
use ssh_key::{Algorithm, HashAlg, LineEnding, PublicKey, SshSig};

#[cfg(any(feature = "dsa", feature = "ed25519", feature = "rsa"))]
#[cfg(any(
 feature = "dsa",
 feature = "ed25519",
 feature = "p256",
 feature = "rsa"
))]
use ssh_key::PrivateKey;

#[cfg(feature = "ed25519")]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ssh-key: add `crypto` feature by tarcieri · Pull Request #83 · RustCrypto/SSH · GitHub
Skip to content
ssh-key: add crypto feature#83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 1 commit into

from

Mar 8, 2023
 Merged


ssh-key: add crypto feature
#83
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


17 changes: 10 additions & 7 deletions
.github/workflows/ssh-key.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@ jobs:
 toolchain: ${{ matrix.rust }}
 target: ${{ matrix.target }}
 - uses: RustCrypto/actions/cargo-hack-install@master
 - run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features default,getrandom,std
 - run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features crypto,default,getrandom,std --release

 test:
 runs-on: ubuntu-latest
Expand All@@ -84,9 +84,12 @@ jobs:
 with:
 toolchain: ${{ matrix.rust }}
 - uses: RustCrypto/actions/cargo-hack-install@master
 - run: cargo hack test --feature-powerset --exclude-features aes-gcm,default,encryption,getrandom,std
 - run: cargo test --features aes-gcm
 - run: cargo test --features encryption
 - run: cargo test --features getrandom
 - run: cargo test --features std
 - run: cargo test --all-features
 - run: cargo hack test --feature-powerset --exclude-features aes-gcm,crypto,default,encryption,getrandom,std --release
 - run: cargo test --release
 - run: cargo test --release --features aes-gcm
 - run: cargo test --release --features crypto
 - run: cargo test --release --features encryption
 - run: cargo test --release --features getrandom
 - run: cargo test --release --features std
 - run: cargo test --all-features # debug build
 - run: cargo test --release --all-features

1 change: 1 addition & 0 deletions
Cargo.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


7 changes: 5 additions & 2 deletions
ssh-key/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ ed25519-dalek = { version = "=2.0.0-pre.0", optional = true, default-features =
p256 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
p384 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
rand_core = { version = "0.6.4", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false, features = ["sha2"] }
sec1 = { version = "0.7", optional = true, default-features = false, features = ["point"] }
serde = { version = "1", optional = true }
sha1 = { version = "0.10", optional = true, default-features = false }
Expand DownExpand Up@@ -62,12 +62,15 @@ std = [
]

aes-gcm = ["dep:aes-gcm", "encryption"]
crypto = ["aes-gcm", "ed25519", "p256", "p384", "rsa"] # NOTE: `dsa` is obsolete/weak
dsa = ["dep:bigint", "dep:dsa", "dep:sha1", "alloc", "signature/rand_core"]
ecdsa = ["dep:sec1"]
ed25519 = ["dep:ed25519-dalek", "rand_core"]
encryption = [ "alloc", "dep:aes", "dep:bcrypt-pbkdf", "dep:ctr", "rand_core"]
getrandom = ["rand_core/getrandom"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core", "sha2/oid"]
p256 = ["dep:p256", "ecdsa"]
p384 = ["dep:p384", "ecdsa"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core"]

[package.metadata.docs.rs]
all-features = true
Expand Down

10 changes: 8 additions & 2 deletions
ssh-key/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ respective SSH key algorithm.
 - [ ] [RFC4716] public keys
 - [ ] SEC1

## Supported algorithms
### Supported Signature Algorithms

| Name | Decode | Encode | Cert | Keygen | Sign | Verify | Feature | `no_std` |
|--------------------------------------|--------|--------|------|--------|------|--------|-----------|----------|
Expand All@@ -74,7 +74,13 @@ respective SSH key algorithm.
| `sk‑ecdsa‑sha2‑nistp256@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |
| `sk‑ssh‑ed25519@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |

Note: the "Feature" section lists the name of `ssh-key` crate features which can
By default *no algorithms are enabled* and you will get an
`Error::AlgorithmUnsupported` error if you try to use them.

Enable the `crypto` feature or the "Feature" for specific algorithms in the
chart above (e.g. `p256`, `rsa`) in order to use cryptographic functionality.

The "Feature" column lists the name of `ssh-key` crate features which can
be enabled to provide full support for the "Keygen", "Sign", and "Verify"
functionality for a particular SSH key algorithm.

Expand Down

50 changes: 18 additions & 32 deletions
ssh-key/tests/certificate_builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
//! Certificate builder tests.

#![cfg(all(feature = "alloc", any(feature = "ed25519", feature = "p256")))]
#![cfg(all(
 feature = "alloc",
 feature = "rand_core",
 any(feature = "ed25519", feature = "p256")
))]

use hex_literal::hex;
use rand_chacha::{rand_core::SeedableRng, ChaCha8Rng};
use ssh_key::{
 certificate::{self, CertType},
 Algorithm, PrivateKey,
};
use ssh_key::{certificate, Algorithm, PrivateKey};

#[cfg(feature = "p256")]
use ssh_key::EcdsaCurve;

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
use std::str::FromStr;

/// Example Unix timestamp when a certificate was issued (2020-09-13 12:26:40 UTC).
Expand All@@ -24,36 +25,21 @@ const VALID_AT: u64 = 1650000000;
/// Example Unix timestamp when a certificate expires (2023-11-14 22:13:20 UTC).
const EXPIRES_AT: u64 = 1700000000;

/// Example serial number.
const SERIAL: u64 = 42;

/// Example key ID.
const KEY_ID: &str = "example";

/// Example principal name.
const PRINCIPAL: &str = "nobody";

/// Critical extension 1.
const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");

/// Critical extension 1.
const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");

/// Non critical extension 1.
const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");

/// Non critical extension 2.
const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");

/// Example comment.
const COMMENT: &str = "user@example.com";

/// Seed to use for PRNG.
const PRNG_SEED: [u8; 32] = [42; 32];

#[cfg(feature = "ed25519")]
#[test]
fn ed25519_sign_and_verify() {
 const SERIAL: u64 = 42;
 const KEY_ID: &str = "example";
 const PRINCIPAL: &str = "nobody";
 const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");
 const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");
 const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");
 const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");
 const COMMENT: &str = "user@example.com";

 let mut rng = ChaCha8Rng::from_seed(PRNG_SEED);

 let ca_key = PrivateKey::random(&mut rng, Algorithm::Ed25519).unwrap();
Expand DownExpand Up@@ -89,7 +75,7 @@ fn ed25519_sign_and_verify() {
 assert_eq!(cert.nonce(), &hex!("321fdf7e0a2afe803308f394f54c6abe"));
 assert_eq!(cert.public_key(), subject_key.public_key().key_data());
 assert_eq!(cert.serial(), SERIAL);
 assert_eq!(cert.cert_type(), CertType::User);
 assert_eq!(cert.cert_type(), certificate::CertType::User);
 assert_eq!(cert.key_id(), KEY_ID);
 assert_eq!(cert.valid_principals().len(), 1);
 assert_eq!(cert.valid_principals()[0], PRINCIPAL);
Expand DownExpand Up@@ -140,7 +126,7 @@ fn ecdsa_nistp256_sign_and_verify() {
 assert!(cert.validate_at(VALID_AT, &[ca_fingerprint]).is_ok());
}

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
#[test]
fn rsa_sign_and_verify() {
 let ca_key = PrivateKey::from_str(
Expand Down

7 changes: 6 additions & 1 deletion
ssh-key/tests/sshsig.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@
use hex_literal::hex;
use ssh_key::{Algorithm, HashAlg, LineEnding, PublicKey, SshSig};

#[cfg(any(feature = "dsa", feature = "ed25519", feature = "rsa"))]
#[cfg(any(
 feature = "dsa",
 feature = "ed25519",
 feature = "p256",
 feature = "rsa"
))]
use ssh_key::PrivateKey;

#[cfg(feature = "ed25519")]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ssh-key: add `crypto` feature by tarcieri · Pull Request #83 · RustCrypto/SSH · GitHub
Skip to content
ssh-key: add crypto feature#83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 1 commit into

from

Mar 8, 2023
 Merged


ssh-key: add crypto feature
#83
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


17 changes: 10 additions & 7 deletions
.github/workflows/ssh-key.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@ jobs:
 toolchain: ${{ matrix.rust }}
 target: ${{ matrix.target }}
 - uses: RustCrypto/actions/cargo-hack-install@master
 - run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features default,getrandom,std
 - run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features crypto,default,getrandom,std --release

 test:
 runs-on: ubuntu-latest
Expand All@@ -84,9 +84,12 @@ jobs:
 with:
 toolchain: ${{ matrix.rust }}
 - uses: RustCrypto/actions/cargo-hack-install@master
 - run: cargo hack test --feature-powerset --exclude-features aes-gcm,default,encryption,getrandom,std
 - run: cargo test --features aes-gcm
 - run: cargo test --features encryption
 - run: cargo test --features getrandom
 - run: cargo test --features std
 - run: cargo test --all-features
 - run: cargo hack test --feature-powerset --exclude-features aes-gcm,crypto,default,encryption,getrandom,std --release
 - run: cargo test --release
 - run: cargo test --release --features aes-gcm
 - run: cargo test --release --features crypto
 - run: cargo test --release --features encryption
 - run: cargo test --release --features getrandom
 - run: cargo test --release --features std
 - run: cargo test --all-features # debug build
 - run: cargo test --release --all-features

1 change: 1 addition & 0 deletions
Cargo.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


7 changes: 5 additions & 2 deletions
ssh-key/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ ed25519-dalek = { version = "=2.0.0-pre.0", optional = true, default-features =
p256 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
p384 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
rand_core = { version = "0.6.4", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false, features = ["sha2"] }
sec1 = { version = "0.7", optional = true, default-features = false, features = ["point"] }
serde = { version = "1", optional = true }
sha1 = { version = "0.10", optional = true, default-features = false }
Expand DownExpand Up@@ -62,12 +62,15 @@ std = [
]

aes-gcm = ["dep:aes-gcm", "encryption"]
crypto = ["aes-gcm", "ed25519", "p256", "p384", "rsa"] # NOTE: `dsa` is obsolete/weak
dsa = ["dep:bigint", "dep:dsa", "dep:sha1", "alloc", "signature/rand_core"]
ecdsa = ["dep:sec1"]
ed25519 = ["dep:ed25519-dalek", "rand_core"]
encryption = [ "alloc", "dep:aes", "dep:bcrypt-pbkdf", "dep:ctr", "rand_core"]
getrandom = ["rand_core/getrandom"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core", "sha2/oid"]
p256 = ["dep:p256", "ecdsa"]
p384 = ["dep:p384", "ecdsa"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core"]

[package.metadata.docs.rs]
all-features = true
Expand Down

10 changes: 8 additions & 2 deletions
ssh-key/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ respective SSH key algorithm.
 - [ ] [RFC4716] public keys
 - [ ] SEC1

## Supported algorithms
### Supported Signature Algorithms

| Name | Decode | Encode | Cert | Keygen | Sign | Verify | Feature | `no_std` |
|--------------------------------------|--------|--------|------|--------|------|--------|-----------|----------|
Expand All@@ -74,7 +74,13 @@ respective SSH key algorithm.
| `sk‑ecdsa‑sha2‑nistp256@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |
| `sk‑ssh‑ed25519@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |

Note: the "Feature" section lists the name of `ssh-key` crate features which can
By default *no algorithms are enabled* and you will get an
`Error::AlgorithmUnsupported` error if you try to use them.

Enable the `crypto` feature or the "Feature" for specific algorithms in the
chart above (e.g. `p256`, `rsa`) in order to use cryptographic functionality.

The "Feature" column lists the name of `ssh-key` crate features which can
be enabled to provide full support for the "Keygen", "Sign", and "Verify"
functionality for a particular SSH key algorithm.

Expand Down

50 changes: 18 additions & 32 deletions
ssh-key/tests/certificate_builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
//! Certificate builder tests.

#![cfg(all(feature = "alloc", any(feature = "ed25519", feature = "p256")))]
#![cfg(all(
 feature = "alloc",
 feature = "rand_core",
 any(feature = "ed25519", feature = "p256")
))]

use hex_literal::hex;
use rand_chacha::{rand_core::SeedableRng, ChaCha8Rng};
use ssh_key::{
 certificate::{self, CertType},
 Algorithm, PrivateKey,
};
use ssh_key::{certificate, Algorithm, PrivateKey};

#[cfg(feature = "p256")]
use ssh_key::EcdsaCurve;

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
use std::str::FromStr;

/// Example Unix timestamp when a certificate was issued (2020-09-13 12:26:40 UTC).
Expand All@@ -24,36 +25,21 @@ const VALID_AT: u64 = 1650000000;
/// Example Unix timestamp when a certificate expires (2023-11-14 22:13:20 UTC).
const EXPIRES_AT: u64 = 1700000000;

/// Example serial number.
const SERIAL: u64 = 42;

/// Example key ID.
const KEY_ID: &str = "example";

/// Example principal name.
const PRINCIPAL: &str = "nobody";

/// Critical extension 1.
const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");

/// Critical extension 1.
const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");

/// Non critical extension 1.
const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");

/// Non critical extension 2.
const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");

/// Example comment.
const COMMENT: &str = "user@example.com";

/// Seed to use for PRNG.
const PRNG_SEED: [u8; 32] = [42; 32];

#[cfg(feature = "ed25519")]
#[test]
fn ed25519_sign_and_verify() {
 const SERIAL: u64 = 42;
 const KEY_ID: &str = "example";
 const PRINCIPAL: &str = "nobody";
 const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");
 const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");
 const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");
 const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");
 const COMMENT: &str = "user@example.com";

 let mut rng = ChaCha8Rng::from_seed(PRNG_SEED);

 let ca_key = PrivateKey::random(&mut rng, Algorithm::Ed25519).unwrap();
Expand DownExpand Up@@ -89,7 +75,7 @@ fn ed25519_sign_and_verify() {
 assert_eq!(cert.nonce(), &hex!("321fdf7e0a2afe803308f394f54c6abe"));
 assert_eq!(cert.public_key(), subject_key.public_key().key_data());
 assert_eq!(cert.serial(), SERIAL);
 assert_eq!(cert.cert_type(), CertType::User);
 assert_eq!(cert.cert_type(), certificate::CertType::User);
 assert_eq!(cert.key_id(), KEY_ID);
 assert_eq!(cert.valid_principals().len(), 1);
 assert_eq!(cert.valid_principals()[0], PRINCIPAL);
Expand DownExpand Up@@ -140,7 +126,7 @@ fn ecdsa_nistp256_sign_and_verify() {
 assert!(cert.validate_at(VALID_AT, &[ca_fingerprint]).is_ok());
}

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
#[test]
fn rsa_sign_and_verify() {
 let ca_key = PrivateKey::from_str(
Expand Down

7 changes: 6 additions & 1 deletion
ssh-key/tests/sshsig.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@
use hex_literal::hex;
use ssh_key::{Algorithm, HashAlg, LineEnding, PublicKey, SshSig};

#[cfg(any(feature = "dsa", feature = "ed25519", feature = "rsa"))]
#[cfg(any(
 feature = "dsa",
 feature = "ed25519",
 feature = "p256",
 feature = "rsa"
))]
use ssh_key::PrivateKey;

#[cfg(feature = "ed25519")]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
ssh-key: add `crypto` feature by tarcieri · Pull Request #83 · RustCrypto/SSH · GitHub
Skip to content
ssh-key: add crypto feature#83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 1 commit into

from

Mar 8, 2023
 Merged


ssh-key: add crypto feature
#83
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


17 changes: 10 additions & 7 deletions
.github/workflows/ssh-key.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@ jobs:
 toolchain: ${{ matrix.rust }}
 target: ${{ matrix.target }}
 - uses: RustCrypto/actions/cargo-hack-install@master
 - run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features default,getrandom,std
 - run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features crypto,default,getrandom,std --release

 test:
 runs-on: ubuntu-latest
Expand All@@ -84,9 +84,12 @@ jobs:
 with:
 toolchain: ${{ matrix.rust }}
 - uses: RustCrypto/actions/cargo-hack-install@master
 - run: cargo hack test --feature-powerset --exclude-features aes-gcm,default,encryption,getrandom,std
 - run: cargo test --features aes-gcm
 - run: cargo test --features encryption
 - run: cargo test --features getrandom
 - run: cargo test --features std
 - run: cargo test --all-features
 - run: cargo hack test --feature-powerset --exclude-features aes-gcm,crypto,default,encryption,getrandom,std --release
 - run: cargo test --release
 - run: cargo test --release --features aes-gcm
 - run: cargo test --release --features crypto
 - run: cargo test --release --features encryption
 - run: cargo test --release --features getrandom
 - run: cargo test --release --features std
 - run: cargo test --all-features # debug build
 - run: cargo test --release --all-features

1 change: 1 addition & 0 deletions
Cargo.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


7 changes: 5 additions & 2 deletions
ssh-key/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ ed25519-dalek = { version = "=2.0.0-pre.0", optional = true, default-features =
p256 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
p384 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
rand_core = { version = "0.6.4", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false, features = ["sha2"] }
sec1 = { version = "0.7", optional = true, default-features = false, features = ["point"] }
serde = { version = "1", optional = true }
sha1 = { version = "0.10", optional = true, default-features = false }
Expand DownExpand Up@@ -62,12 +62,15 @@ std = [
]

aes-gcm = ["dep:aes-gcm", "encryption"]
crypto = ["aes-gcm", "ed25519", "p256", "p384", "rsa"] # NOTE: `dsa` is obsolete/weak
dsa = ["dep:bigint", "dep:dsa", "dep:sha1", "alloc", "signature/rand_core"]
ecdsa = ["dep:sec1"]
ed25519 = ["dep:ed25519-dalek", "rand_core"]
encryption = [ "alloc", "dep:aes", "dep:bcrypt-pbkdf", "dep:ctr", "rand_core"]
getrandom = ["rand_core/getrandom"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core", "sha2/oid"]
p256 = ["dep:p256", "ecdsa"]
p384 = ["dep:p384", "ecdsa"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core"]

[package.metadata.docs.rs]
all-features = true
Expand Down

10 changes: 8 additions & 2 deletions
ssh-key/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ respective SSH key algorithm.
 - [ ] [RFC4716] public keys
 - [ ] SEC1

## Supported algorithms
### Supported Signature Algorithms

| Name | Decode | Encode | Cert | Keygen | Sign | Verify | Feature | `no_std` |
|--------------------------------------|--------|--------|------|--------|------|--------|-----------|----------|
Expand All@@ -74,7 +74,13 @@ respective SSH key algorithm.
| `sk‑ecdsa‑sha2‑nistp256@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |
| `sk‑ssh‑ed25519@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |

Note: the "Feature" section lists the name of `ssh-key` crate features which can
By default *no algorithms are enabled* and you will get an
`Error::AlgorithmUnsupported` error if you try to use them.

Enable the `crypto` feature or the "Feature" for specific algorithms in the
chart above (e.g. `p256`, `rsa`) in order to use cryptographic functionality.

The "Feature" column lists the name of `ssh-key` crate features which can
be enabled to provide full support for the "Keygen", "Sign", and "Verify"
functionality for a particular SSH key algorithm.

Expand Down

50 changes: 18 additions & 32 deletions
ssh-key/tests/certificate_builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
//! Certificate builder tests.

#![cfg(all(feature = "alloc", any(feature = "ed25519", feature = "p256")))]
#![cfg(all(
 feature = "alloc",
 feature = "rand_core",
 any(feature = "ed25519", feature = "p256")
))]

use hex_literal::hex;
use rand_chacha::{rand_core::SeedableRng, ChaCha8Rng};
use ssh_key::{
 certificate::{self, CertType},
 Algorithm, PrivateKey,
};
use ssh_key::{certificate, Algorithm, PrivateKey};

#[cfg(feature = "p256")]
use ssh_key::EcdsaCurve;

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
use std::str::FromStr;

/// Example Unix timestamp when a certificate was issued (2020-09-13 12:26:40 UTC).
Expand All@@ -24,36 +25,21 @@ const VALID_AT: u64 = 1650000000;
/// Example Unix timestamp when a certificate expires (2023-11-14 22:13:20 UTC).
const EXPIRES_AT: u64 = 1700000000;

/// Example serial number.
const SERIAL: u64 = 42;

/// Example key ID.
const KEY_ID: &str = "example";

/// Example principal name.
const PRINCIPAL: &str = "nobody";

/// Critical extension 1.
const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");

/// Critical extension 1.
const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");

/// Non critical extension 1.
const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");

/// Non critical extension 2.
const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");

/// Example comment.
const COMMENT: &str = "user@example.com";

/// Seed to use for PRNG.
const PRNG_SEED: [u8; 32] = [42; 32];

#[cfg(feature = "ed25519")]
#[test]
fn ed25519_sign_and_verify() {
 const SERIAL: u64 = 42;
 const KEY_ID: &str = "example";
 const PRINCIPAL: &str = "nobody";
 const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");
 const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");
 const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");
 const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");
 const COMMENT: &str = "user@example.com";

 let mut rng = ChaCha8Rng::from_seed(PRNG_SEED);

 let ca_key = PrivateKey::random(&mut rng, Algorithm::Ed25519).unwrap();
Expand DownExpand Up@@ -89,7 +75,7 @@ fn ed25519_sign_and_verify() {
 assert_eq!(cert.nonce(), &hex!("321fdf7e0a2afe803308f394f54c6abe"));
 assert_eq!(cert.public_key(), subject_key.public_key().key_data());
 assert_eq!(cert.serial(), SERIAL);
 assert_eq!(cert.cert_type(), CertType::User);
 assert_eq!(cert.cert_type(), certificate::CertType::User);
 assert_eq!(cert.key_id(), KEY_ID);
 assert_eq!(cert.valid_principals().len(), 1);
 assert_eq!(cert.valid_principals()[0], PRINCIPAL);
Expand DownExpand Up@@ -140,7 +126,7 @@ fn ecdsa_nistp256_sign_and_verify() {
 assert!(cert.validate_at(VALID_AT, &[ca_fingerprint]).is_ok());
}

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
#[test]
fn rsa_sign_and_verify() {
 let ca_key = PrivateKey::from_str(
Expand Down

7 changes: 6 additions & 1 deletion
ssh-key/tests/sshsig.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@
use hex_literal::hex;
use ssh_key::{Algorithm, HashAlg, LineEnding, PublicKey, SshSig};

#[cfg(any(feature = "dsa", feature = "ed25519", feature = "rsa"))]
#[cfg(any(
 feature = "dsa",
 feature = "ed25519",
 feature = "p256",
 feature = "rsa"
))]
use ssh_key::PrivateKey;

#[cfg(feature = "ed25519")]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ssh-key: add `crypto` feature by tarcieri · Pull Request #83 · RustCrypto/SSH · GitHub
Skip to content
ssh-key: add crypto feature#83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 1 commit into

from

Mar 8, 2023
 Merged


ssh-key: add crypto feature
#83
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


17 changes: 10 additions & 7 deletions
.github/workflows/ssh-key.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@ jobs:
 toolchain: ${{ matrix.rust }}
 target: ${{ matrix.target }}
 - uses: RustCrypto/actions/cargo-hack-install@master
 - run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features default,getrandom,std
 - run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features crypto,default,getrandom,std --release

 test:
 runs-on: ubuntu-latest
Expand All@@ -84,9 +84,12 @@ jobs:
 with:
 toolchain: ${{ matrix.rust }}
 - uses: RustCrypto/actions/cargo-hack-install@master
 - run: cargo hack test --feature-powerset --exclude-features aes-gcm,default,encryption,getrandom,std
 - run: cargo test --features aes-gcm
 - run: cargo test --features encryption
 - run: cargo test --features getrandom
 - run: cargo test --features std
 - run: cargo test --all-features
 - run: cargo hack test --feature-powerset --exclude-features aes-gcm,crypto,default,encryption,getrandom,std --release
 - run: cargo test --release
 - run: cargo test --release --features aes-gcm
 - run: cargo test --release --features crypto
 - run: cargo test --release --features encryption
 - run: cargo test --release --features getrandom
 - run: cargo test --release --features std
 - run: cargo test --all-features # debug build
 - run: cargo test --release --all-features

1 change: 1 addition & 0 deletions
Cargo.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


7 changes: 5 additions & 2 deletions
ssh-key/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ ed25519-dalek = { version = "=2.0.0-pre.0", optional = true, default-features =
p256 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
p384 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
rand_core = { version = "0.6.4", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false, features = ["sha2"] }
sec1 = { version = "0.7", optional = true, default-features = false, features = ["point"] }
serde = { version = "1", optional = true }
sha1 = { version = "0.10", optional = true, default-features = false }
Expand DownExpand Up@@ -62,12 +62,15 @@ std = [
]

aes-gcm = ["dep:aes-gcm", "encryption"]
crypto = ["aes-gcm", "ed25519", "p256", "p384", "rsa"] # NOTE: `dsa` is obsolete/weak
dsa = ["dep:bigint", "dep:dsa", "dep:sha1", "alloc", "signature/rand_core"]
ecdsa = ["dep:sec1"]
ed25519 = ["dep:ed25519-dalek", "rand_core"]
encryption = [ "alloc", "dep:aes", "dep:bcrypt-pbkdf", "dep:ctr", "rand_core"]
getrandom = ["rand_core/getrandom"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core", "sha2/oid"]
p256 = ["dep:p256", "ecdsa"]
p384 = ["dep:p384", "ecdsa"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core"]

[package.metadata.docs.rs]
all-features = true
Expand Down

10 changes: 8 additions & 2 deletions
ssh-key/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ respective SSH key algorithm.
 - [ ] [RFC4716] public keys
 - [ ] SEC1

## Supported algorithms
### Supported Signature Algorithms

| Name | Decode | Encode | Cert | Keygen | Sign | Verify | Feature | `no_std` |
|--------------------------------------|--------|--------|------|--------|------|--------|-----------|----------|
Expand All@@ -74,7 +74,13 @@ respective SSH key algorithm.
| `sk‑ecdsa‑sha2‑nistp256@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |
| `sk‑ssh‑ed25519@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |

Note: the "Feature" section lists the name of `ssh-key` crate features which can
By default *no algorithms are enabled* and you will get an
`Error::AlgorithmUnsupported` error if you try to use them.

Enable the `crypto` feature or the "Feature" for specific algorithms in the
chart above (e.g. `p256`, `rsa`) in order to use cryptographic functionality.

The "Feature" column lists the name of `ssh-key` crate features which can
be enabled to provide full support for the "Keygen", "Sign", and "Verify"
functionality for a particular SSH key algorithm.

Expand Down

50 changes: 18 additions & 32 deletions
ssh-key/tests/certificate_builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
//! Certificate builder tests.

#![cfg(all(feature = "alloc", any(feature = "ed25519", feature = "p256")))]
#![cfg(all(
 feature = "alloc",
 feature = "rand_core",
 any(feature = "ed25519", feature = "p256")
))]

use hex_literal::hex;
use rand_chacha::{rand_core::SeedableRng, ChaCha8Rng};
use ssh_key::{
 certificate::{self, CertType},
 Algorithm, PrivateKey,
};
use ssh_key::{certificate, Algorithm, PrivateKey};

#[cfg(feature = "p256")]
use ssh_key::EcdsaCurve;

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
use std::str::FromStr;

/// Example Unix timestamp when a certificate was issued (2020-09-13 12:26:40 UTC).
Expand All@@ -24,36 +25,21 @@ const VALID_AT: u64 = 1650000000;
/// Example Unix timestamp when a certificate expires (2023-11-14 22:13:20 UTC).
const EXPIRES_AT: u64 = 1700000000;

/// Example serial number.
const SERIAL: u64 = 42;

/// Example key ID.
const KEY_ID: &str = "example";

/// Example principal name.
const PRINCIPAL: &str = "nobody";

/// Critical extension 1.
const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");

/// Critical extension 1.
const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");

/// Non critical extension 1.
const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");

/// Non critical extension 2.
const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");

/// Example comment.
const COMMENT: &str = "user@example.com";

/// Seed to use for PRNG.
const PRNG_SEED: [u8; 32] = [42; 32];

#[cfg(feature = "ed25519")]
#[test]
fn ed25519_sign_and_verify() {
 const SERIAL: u64 = 42;
 const KEY_ID: &str = "example";
 const PRINCIPAL: &str = "nobody";
 const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");
 const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");
 const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");
 const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");
 const COMMENT: &str = "user@example.com";

 let mut rng = ChaCha8Rng::from_seed(PRNG_SEED);

 let ca_key = PrivateKey::random(&mut rng, Algorithm::Ed25519).unwrap();
Expand DownExpand Up@@ -89,7 +75,7 @@ fn ed25519_sign_and_verify() {
 assert_eq!(cert.nonce(), &hex!("321fdf7e0a2afe803308f394f54c6abe"));
 assert_eq!(cert.public_key(), subject_key.public_key().key_data());
 assert_eq!(cert.serial(), SERIAL);
 assert_eq!(cert.cert_type(), CertType::User);
 assert_eq!(cert.cert_type(), certificate::CertType::User);
 assert_eq!(cert.key_id(), KEY_ID);
 assert_eq!(cert.valid_principals().len(), 1);
 assert_eq!(cert.valid_principals()[0], PRINCIPAL);
Expand DownExpand Up@@ -140,7 +126,7 @@ fn ecdsa_nistp256_sign_and_verify() {
 assert!(cert.validate_at(VALID_AT, &[ca_fingerprint]).is_ok());
}

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
#[test]
fn rsa_sign_and_verify() {
 let ca_key = PrivateKey::from_str(
Expand Down

7 changes: 6 additions & 1 deletion
ssh-key/tests/sshsig.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@
use hex_literal::hex;
use ssh_key::{Algorithm, HashAlg, LineEnding, PublicKey, SshSig};

#[cfg(any(feature = "dsa", feature = "ed25519", feature = "rsa"))]
#[cfg(any(
 feature = "dsa",
 feature = "ed25519",
 feature = "p256",
 feature = "rsa"
))]
use ssh_key::PrivateKey;

#[cfg(feature = "ed25519")]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ssh-key: add `crypto` feature by tarcieri · Pull Request #83 · RustCrypto/SSH · GitHub
Skip to content
ssh-key: add crypto feature#83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 1 commit into

from

Mar 8, 2023
 Merged


ssh-key: add crypto feature
#83
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


17 changes: 10 additions & 7 deletions
.github/workflows/ssh-key.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@ jobs:
 toolchain: ${{ matrix.rust }}
 target: ${{ matrix.target }}
 - uses: RustCrypto/actions/cargo-hack-install@master
 - run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features default,getrandom,std
 - run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features crypto,default,getrandom,std --release

 test:
 runs-on: ubuntu-latest
Expand All@@ -84,9 +84,12 @@ jobs:
 with:
 toolchain: ${{ matrix.rust }}
 - uses: RustCrypto/actions/cargo-hack-install@master
 - run: cargo hack test --feature-powerset --exclude-features aes-gcm,default,encryption,getrandom,std
 - run: cargo test --features aes-gcm
 - run: cargo test --features encryption
 - run: cargo test --features getrandom
 - run: cargo test --features std
 - run: cargo test --all-features
 - run: cargo hack test --feature-powerset --exclude-features aes-gcm,crypto,default,encryption,getrandom,std --release
 - run: cargo test --release
 - run: cargo test --release --features aes-gcm
 - run: cargo test --release --features crypto
 - run: cargo test --release --features encryption
 - run: cargo test --release --features getrandom
 - run: cargo test --release --features std
 - run: cargo test --all-features # debug build
 - run: cargo test --release --all-features

1 change: 1 addition & 0 deletions
Cargo.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


7 changes: 5 additions & 2 deletions
ssh-key/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ ed25519-dalek = { version = "=2.0.0-pre.0", optional = true, default-features =
p256 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
p384 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
rand_core = { version = "0.6.4", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false, features = ["sha2"] }
sec1 = { version = "0.7", optional = true, default-features = false, features = ["point"] }
serde = { version = "1", optional = true }
sha1 = { version = "0.10", optional = true, default-features = false }
Expand DownExpand Up@@ -62,12 +62,15 @@ std = [
]

aes-gcm = ["dep:aes-gcm", "encryption"]
crypto = ["aes-gcm", "ed25519", "p256", "p384", "rsa"] # NOTE: `dsa` is obsolete/weak
dsa = ["dep:bigint", "dep:dsa", "dep:sha1", "alloc", "signature/rand_core"]
ecdsa = ["dep:sec1"]
ed25519 = ["dep:ed25519-dalek", "rand_core"]
encryption = [ "alloc", "dep:aes", "dep:bcrypt-pbkdf", "dep:ctr", "rand_core"]
getrandom = ["rand_core/getrandom"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core", "sha2/oid"]
p256 = ["dep:p256", "ecdsa"]
p384 = ["dep:p384", "ecdsa"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core"]

[package.metadata.docs.rs]
all-features = true
Expand Down

10 changes: 8 additions & 2 deletions
ssh-key/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ respective SSH key algorithm.
 - [ ] [RFC4716] public keys
 - [ ] SEC1

## Supported algorithms
### Supported Signature Algorithms

| Name | Decode | Encode | Cert | Keygen | Sign | Verify | Feature | `no_std` |
|--------------------------------------|--------|--------|------|--------|------|--------|-----------|----------|
Expand All@@ -74,7 +74,13 @@ respective SSH key algorithm.
| `sk‑ecdsa‑sha2‑nistp256@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |
| `sk‑ssh‑ed25519@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |

Note: the "Feature" section lists the name of `ssh-key` crate features which can
By default *no algorithms are enabled* and you will get an
`Error::AlgorithmUnsupported` error if you try to use them.

Enable the `crypto` feature or the "Feature" for specific algorithms in the
chart above (e.g. `p256`, `rsa`) in order to use cryptographic functionality.

The "Feature" column lists the name of `ssh-key` crate features which can
be enabled to provide full support for the "Keygen", "Sign", and "Verify"
functionality for a particular SSH key algorithm.

Expand Down

50 changes: 18 additions & 32 deletions
ssh-key/tests/certificate_builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
//! Certificate builder tests.

#![cfg(all(feature = "alloc", any(feature = "ed25519", feature = "p256")))]
#![cfg(all(
 feature = "alloc",
 feature = "rand_core",
 any(feature = "ed25519", feature = "p256")
))]

use hex_literal::hex;
use rand_chacha::{rand_core::SeedableRng, ChaCha8Rng};
use ssh_key::{
 certificate::{self, CertType},
 Algorithm, PrivateKey,
};
use ssh_key::{certificate, Algorithm, PrivateKey};

#[cfg(feature = "p256")]
use ssh_key::EcdsaCurve;

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
use std::str::FromStr;

/// Example Unix timestamp when a certificate was issued (2020-09-13 12:26:40 UTC).
Expand All@@ -24,36 +25,21 @@ const VALID_AT: u64 = 1650000000;
/// Example Unix timestamp when a certificate expires (2023-11-14 22:13:20 UTC).
const EXPIRES_AT: u64 = 1700000000;

/// Example serial number.
const SERIAL: u64 = 42;

/// Example key ID.
const KEY_ID: &str = "example";

/// Example principal name.
const PRINCIPAL: &str = "nobody";

/// Critical extension 1.
const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");

/// Critical extension 1.
const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");

/// Non critical extension 1.
const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");

/// Non critical extension 2.
const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");

/// Example comment.
const COMMENT: &str = "user@example.com";

/// Seed to use for PRNG.
const PRNG_SEED: [u8; 32] = [42; 32];

#[cfg(feature = "ed25519")]
#[test]
fn ed25519_sign_and_verify() {
 const SERIAL: u64 = 42;
 const KEY_ID: &str = "example";
 const PRINCIPAL: &str = "nobody";
 const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");
 const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");
 const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");
 const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");
 const COMMENT: &str = "user@example.com";

 let mut rng = ChaCha8Rng::from_seed(PRNG_SEED);

 let ca_key = PrivateKey::random(&mut rng, Algorithm::Ed25519).unwrap();
Expand DownExpand Up@@ -89,7 +75,7 @@ fn ed25519_sign_and_verify() {
 assert_eq!(cert.nonce(), &hex!("321fdf7e0a2afe803308f394f54c6abe"));
 assert_eq!(cert.public_key(), subject_key.public_key().key_data());
 assert_eq!(cert.serial(), SERIAL);
 assert_eq!(cert.cert_type(), CertType::User);
 assert_eq!(cert.cert_type(), certificate::CertType::User);
 assert_eq!(cert.key_id(), KEY_ID);
 assert_eq!(cert.valid_principals().len(), 1);
 assert_eq!(cert.valid_principals()[0], PRINCIPAL);
Expand DownExpand Up@@ -140,7 +126,7 @@ fn ecdsa_nistp256_sign_and_verify() {
 assert!(cert.validate_at(VALID_AT, &[ca_fingerprint]).is_ok());
}

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
#[test]
fn rsa_sign_and_verify() {
 let ca_key = PrivateKey::from_str(
Expand Down

7 changes: 6 additions & 1 deletion
ssh-key/tests/sshsig.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@
use hex_literal::hex;
use ssh_key::{Algorithm, HashAlg, LineEnding, PublicKey, SshSig};

#[cfg(any(feature = "dsa", feature = "ed25519", feature = "rsa"))]
#[cfg(any(
 feature = "dsa",
 feature = "ed25519",
 feature = "p256",
 feature = "rsa"
))]
use ssh_key::PrivateKey;

#[cfg(feature = "ed25519")]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
ssh-key: add `crypto` feature by tarcieri · Pull Request #83 · RustCrypto/SSH · GitHub
Skip to content
ssh-key: add crypto feature#83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 1 commit into

from

Mar 8, 2023
 Merged


ssh-key: add crypto feature
#83
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


17 changes: 10 additions & 7 deletions
.github/workflows/ssh-key.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -69,7 +69,7 @@ jobs:
 toolchain: ${{ matrix.rust }}
 target: ${{ matrix.target }}
 - uses: RustCrypto/actions/cargo-hack-install@master
 - run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features default,getrandom,std
 - run: cargo hack build --target ${{ matrix.target }} --feature-powerset --exclude-features crypto,default,getrandom,std --release

 test:
 runs-on: ubuntu-latest
Expand All@@ -84,9 +84,12 @@ jobs:
 with:
 toolchain: ${{ matrix.rust }}
 - uses: RustCrypto/actions/cargo-hack-install@master
 - run: cargo hack test --feature-powerset --exclude-features aes-gcm,default,encryption,getrandom,std
 - run: cargo test --features aes-gcm
 - run: cargo test --features encryption
 - run: cargo test --features getrandom
 - run: cargo test --features std
 - run: cargo test --all-features
 - run: cargo hack test --feature-powerset --exclude-features aes-gcm,crypto,default,encryption,getrandom,std --release
 - run: cargo test --release
 - run: cargo test --release --features aes-gcm
 - run: cargo test --release --features crypto
 - run: cargo test --release --features encryption
 - run: cargo test --release --features getrandom
 - run: cargo test --release --features std
 - run: cargo test --all-features # debug build
 - run: cargo test --release --all-features

1 change: 1 addition & 0 deletions
Cargo.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


7 changes: 5 additions & 2 deletions
ssh-key/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@ ed25519-dalek = { version = "=2.0.0-pre.0", optional = true, default-features =
p256 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
p384 = { version = "0.13", optional = true, default-features = false, features = ["ecdsa"] }
rand_core = { version = "0.6.4", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false }
rsa = { version = "=0.9.0-pre.0", optional = true, default-features = false, features = ["sha2"] }
sec1 = { version = "0.7", optional = true, default-features = false, features = ["point"] }
serde = { version = "1", optional = true }
sha1 = { version = "0.10", optional = true, default-features = false }
Expand DownExpand Up@@ -62,12 +62,15 @@ std = [
]

aes-gcm = ["dep:aes-gcm", "encryption"]
crypto = ["aes-gcm", "ed25519", "p256", "p384", "rsa"] # NOTE: `dsa` is obsolete/weak
dsa = ["dep:bigint", "dep:dsa", "dep:sha1", "alloc", "signature/rand_core"]
ecdsa = ["dep:sec1"]
ed25519 = ["dep:ed25519-dalek", "rand_core"]
encryption = [ "alloc", "dep:aes", "dep:bcrypt-pbkdf", "dep:ctr", "rand_core"]
getrandom = ["rand_core/getrandom"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core", "sha2/oid"]
p256 = ["dep:p256", "ecdsa"]
p384 = ["dep:p384", "ecdsa"]
rsa = ["dep:bigint", "dep:rsa", "alloc", "rand_core"]

[package.metadata.docs.rs]
all-features = true
Expand Down

10 changes: 8 additions & 2 deletions
ssh-key/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,7 +61,7 @@ respective SSH key algorithm.
 - [ ] [RFC4716] public keys
 - [ ] SEC1

## Supported algorithms
### Supported Signature Algorithms

| Name | Decode | Encode | Cert | Keygen | Sign | Verify | Feature | `no_std` |
|--------------------------------------|--------|--------|------|--------|------|--------|-----------|----------|
Expand All@@ -74,7 +74,13 @@ respective SSH key algorithm.
| `sk‑ecdsa‑sha2‑nistp256@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |
| `sk‑ssh‑ed25519@openssh.com` | ✅ | ✅ | ✅ | ⛔ | ⛔️ | ⛔️ | ⛔ | `alloc` |

Note: the "Feature" section lists the name of `ssh-key` crate features which can
By default *no algorithms are enabled* and you will get an
`Error::AlgorithmUnsupported` error if you try to use them.

Enable the `crypto` feature or the "Feature" for specific algorithms in the
chart above (e.g. `p256`, `rsa`) in order to use cryptographic functionality.

The "Feature" column lists the name of `ssh-key` crate features which can
be enabled to provide full support for the "Keygen", "Sign", and "Verify"
functionality for a particular SSH key algorithm.

Expand Down

50 changes: 18 additions & 32 deletions
ssh-key/tests/certificate_builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
//! Certificate builder tests.

#![cfg(all(feature = "alloc", any(feature = "ed25519", feature = "p256")))]
#![cfg(all(
 feature = "alloc",
 feature = "rand_core",
 any(feature = "ed25519", feature = "p256")
))]

use hex_literal::hex;
use rand_chacha::{rand_core::SeedableRng, ChaCha8Rng};
use ssh_key::{
 certificate::{self, CertType},
 Algorithm, PrivateKey,
};
use ssh_key::{certificate, Algorithm, PrivateKey};

#[cfg(feature = "p256")]
use ssh_key::EcdsaCurve;

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
use std::str::FromStr;

/// Example Unix timestamp when a certificate was issued (2020-09-13 12:26:40 UTC).
Expand All@@ -24,36 +25,21 @@ const VALID_AT: u64 = 1650000000;
/// Example Unix timestamp when a certificate expires (2023-11-14 22:13:20 UTC).
const EXPIRES_AT: u64 = 1700000000;

/// Example serial number.
const SERIAL: u64 = 42;

/// Example key ID.
const KEY_ID: &str = "example";

/// Example principal name.
const PRINCIPAL: &str = "nobody";

/// Critical extension 1.
const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");

/// Critical extension 1.
const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");

/// Non critical extension 1.
const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");

/// Non critical extension 2.
const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");

/// Example comment.
const COMMENT: &str = "user@example.com";

/// Seed to use for PRNG.
const PRNG_SEED: [u8; 32] = [42; 32];

#[cfg(feature = "ed25519")]
#[test]
fn ed25519_sign_and_verify() {
 const SERIAL: u64 = 42;
 const KEY_ID: &str = "example";
 const PRINCIPAL: &str = "nobody";
 const CRITICAL_EXTENSION_1: (&str, &str) = ("critical name 1", "critical data 2");
 const CRITICAL_EXTENSION_2: (&str, &str) = ("critical name 2", "critical data 2");
 const EXTENSION_1: (&str, &str) = ("extension name 1", "extension data 1");
 const EXTENSION_2: (&str, &str) = ("extension name 2", "extension data 2");
 const COMMENT: &str = "user@example.com";

 let mut rng = ChaCha8Rng::from_seed(PRNG_SEED);

 let ca_key = PrivateKey::random(&mut rng, Algorithm::Ed25519).unwrap();
Expand DownExpand Up@@ -89,7 +75,7 @@ fn ed25519_sign_and_verify() {
 assert_eq!(cert.nonce(), &hex!("321fdf7e0a2afe803308f394f54c6abe"));
 assert_eq!(cert.public_key(), subject_key.public_key().key_data());
 assert_eq!(cert.serial(), SERIAL);
 assert_eq!(cert.cert_type(), CertType::User);
 assert_eq!(cert.cert_type(), certificate::CertType::User);
 assert_eq!(cert.key_id(), KEY_ID);
 assert_eq!(cert.valid_principals().len(), 1);
 assert_eq!(cert.valid_principals()[0], PRINCIPAL);
Expand DownExpand Up@@ -140,7 +126,7 @@ fn ecdsa_nistp256_sign_and_verify() {
 assert!(cert.validate_at(VALID_AT, &[ca_fingerprint]).is_ok());
}

#[cfg(feature = "rsa")]
#[cfg(all(feature = "ed25519", feature = "rsa"))]
#[test]
fn rsa_sign_and_verify() {
 let ca_key = PrivateKey::from_str(
Expand Down

7 changes: 6 additions & 1 deletion
ssh-key/tests/sshsig.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,12 @@
use hex_literal::hex;
use ssh_key::{Algorithm, HashAlg, LineEnding, PublicKey, SshSig};

#[cfg(any(feature = "dsa", feature = "ed25519", feature = "rsa"))]
#[cfg(any(
 feature = "dsa",
 feature = "ed25519",
 feature = "p256",
 feature = "rsa"
))]
use ssh_key::PrivateKey;

#[cfg(feature = "ed25519")]
Expand Down