Skip to content

pss: make *_with_salt methods the default #291

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

Closed
tarcieri wants to merge 1 commit into from
Closed

pss: make *_with_salt methods the default #291

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
102 changes: 69 additions & 33 deletions src/pss.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,26 +51,42 @@ pub struct Pss {
}

impl Pss {
/// New PSS padding for the given digest with a salt value of the given length.
pub fn new<T: 'static + Digest + DynDigest + Send + Sync>(salt_len: usize) -> Self {
Self {
blinded: false,
digest: Box::new(T::new()),
salt_len: Some(salt_len),
}
}

/// New PSS padding for the given digest.
pub fn new<T: 'static + Digest + DynDigest + Send + Sync>() -> Self {
pub fn new_unsalted<T: 'static + Digest + DynDigest + Send + Sync>() -> Self {
Self {
blinded: false,
digest: Box::new(T::new()),
salt_len: None,
}
}

/// New PSS padding for the given digest with a salt value of the given length.
pub fn new_with_salt<T: 'static + Digest + DynDigest + Send + Sync>(len: usize) -> Self {
/// Create a new signing key with a prefix for the digest `D`.
#[deprecated(since = "0.9.0", note = "use Pss::new instead")]
pub fn new_with_salt<T: 'static + Digest + DynDigest + Send + Sync>(salt_len: usize) -> Self {
Self::new::<T>(salt_len)
}

/// New PSS padding for blinded signatures (RSA-BSSA) for the given digest
/// with a salt value of the given length.
pub fn new_blinded<T: 'static + Digest + DynDigest + Send + Sync>(salt_len: usize) -> Self {
Self {
blinded: false,
blinded: true,
digest: Box::new(T::new()),
salt_len: Some(len),
salt_len: Some(salt_len),
}
}

/// New PSS padding for blinded signatures (RSA-BSSA) for the given digest.
pub fn new_blinded<T: 'static + Digest + DynDigest + Send + Sync>() -> Self {
pub fn new_blinded_unsalted<T: 'static + Digest + DynDigest + Send + Sync>() -> Self {
Self {
blinded: true,
digest: Box::new(T::new()),
Expand All @@ -80,14 +96,11 @@ impl Pss {

/// New PSS padding for blinded signatures (RSA-BSSA) for the given digest
/// with a salt value of the given length.
#[deprecated(since = "0.9.0", note = "use Pss::new_blinded instead")]
pub fn new_blinded_with_salt<T: 'static + Digest + DynDigest + Send + Sync>(
len: usize,
salt_len: usize,
) -> Self {
Self {
blinded: true,
digest: Box::new(T::new()),
salt_len: Some(len),
}
Self::new_blinded::<T>(salt_len)
}
}

Expand Down Expand Up @@ -652,8 +665,17 @@ impl<D> SigningKey<D>
where
D: Digest,
{
/// Create a new RSASSA-PSS signing key with a salt of the given length.
pub fn new(key: RsaPrivateKey, salt_len: usize) -> Self {
Self {
inner: key,
salt_len: Some(salt_len),
phantom: Default::default(),
}
}

/// Create a new RSASSA-PSS signing key.
pub fn new(key: RsaPrivateKey) -> Self {
pub fn new_unsalted(key: RsaPrivateKey) -> Self {
Self {
inner: key,
salt_len: None,
Expand All @@ -662,16 +684,29 @@ where
}

/// Create a new RSASSA-PSS signing key with a salt of the given length.
#[deprecated(since = "0.9.0", note = "use SigningKey::new instead")]
pub fn new_with_salt_len(key: RsaPrivateKey, salt_len: usize) -> Self {
Self {
inner: key,
Self::new(key, salt_len)
}

/// Generate a new random RSASSA-PSS signing key with a salt of the given length.
pub fn random<R: CryptoRngCore + ?Sized>(
rng: &mut R,
bit_size: usize,
salt_len: usize,
) -> Result<Self> {
Ok(Self {
inner: RsaPrivateKey::new(rng, bit_size)?,
salt_len: Some(salt_len),
phantom: Default::default(),
}
})
}

/// Generate a new random RSASSA-PSS signing key.
pub fn random<R: CryptoRngCore + ?Sized>(rng: &mut R, bit_size: usize) -> Result<Self> {
pub fn random_unsalted<R: CryptoRngCore + ?Sized>(
rng: &mut R,
bit_size: usize,
) -> Result<Self> {
Ok(Self {
inner: RsaPrivateKey::new(rng, bit_size)?,
salt_len: None,
Expand All @@ -680,16 +715,13 @@ where
}

/// Generate a new random RSASSA-PSS signing key with a salt of the given length.
#[deprecated(since = "0.9.0", note = "use SigningKey::random instead")]
pub fn random_with_salt_len<R: CryptoRngCore + ?Sized>(
rng: &mut R,
bit_size: usize,
salt_len: usize,
) -> Result<Self> {
Ok(Self {
inner: RsaPrivateKey::new(rng, bit_size)?,
salt_len: Some(salt_len),
phantom: Default::default(),
})
Self::random(rng, bit_size, salt_len)
}

/// Return specified salt length for this key
Expand Down Expand Up @@ -754,7 +786,7 @@ where
D: Digest,
{
fn from(key: RsaPrivateKey) -> Self {
Self::new(key)
Self::new_unsalted(key)
}
}

Expand Down Expand Up @@ -1172,7 +1204,7 @@ mod test {

for (text, sig, expected) in &tests {
let digest = Sha1::digest(text.as_bytes()).to_vec();
let result = pub_key.verify(Pss::new::<Sha1>(), &digest, sig);
let result = pub_key.verify(Pss::new_unsalted::<Sha1>(), &digest, sig);
match expected {
true => result.expect("failed to verify"),
false => {
Expand Down Expand Up @@ -1270,11 +1302,11 @@ mod test {
for test in &tests {
let digest = Sha1::digest(test.as_bytes()).to_vec();
let sig = priv_key
.sign_with_rng(&mut rng.clone(), Pss::new::<Sha1>(), &digest)
.sign_with_rng(&mut rng.clone(), Pss::new_unsalted::<Sha1>(), &digest)
.expect("failed to sign");

priv_key
.verify(Pss::new::<Sha1>(), &digest, &sig)
.verify(Pss::new_unsalted::<Sha1>(), &digest, &sig)
.expect("failed to verify");
}
}
Expand All @@ -1289,11 +1321,15 @@ mod test {
for test in &tests {
let digest = Sha1::digest(test.as_bytes()).to_vec();
let sig = priv_key
.sign_with_rng(&mut rng.clone(), Pss::new_blinded::<Sha1>(), &digest)
.sign_with_rng(
&mut rng.clone(),
Pss::new_blinded_unsalted::<Sha1>(),
&digest,
)
.expect("failed to sign");

priv_key
.verify(Pss::new::<Sha1>(), &digest, &sig)
.verify(Pss::new_unsalted::<Sha1>(), &digest, &sig)
.expect("failed to verify");
}
}
Expand All @@ -1304,7 +1340,7 @@ mod test {

let tests = ["test\n"];
let mut rng = ChaCha8Rng::from_seed([42; 32]);
let signing_key = SigningKey::<Sha1>::new(priv_key);
let signing_key = SigningKey::<Sha1>::new_unsalted(priv_key);
let verifying_key = signing_key.verifying_key();

for test in &tests {
Expand Down Expand Up @@ -1338,7 +1374,7 @@ mod test {

let tests = ["test\n"];
let mut rng = ChaCha8Rng::from_seed([42; 32]);
let signing_key = SigningKey::new(priv_key);
let signing_key = SigningKey::new_unsalted(priv_key);
let verifying_key = signing_key.verifying_key();

for test in &tests {
Expand Down Expand Up @@ -1419,7 +1455,7 @@ mod test {

let tests = [Sha1::digest("test\n")];
let mut rng = ChaCha8Rng::from_seed([42; 32]);
let signing_key = SigningKey::<Sha1>::new(priv_key);
let signing_key = SigningKey::<Sha1>::new_unsalted(priv_key);
let verifying_key = signing_key.verifying_key();

for test in &tests {
Expand Down Expand Up @@ -1460,11 +1496,11 @@ mod test {

let digest = Sha1::digest(plaintext.as_bytes()).to_vec();
let sig = priv_key
.sign_with_rng(&mut rng.clone(), Pss::new::<Sha1>(), &digest)
.sign_with_rng(&mut rng.clone(), Pss::new_unsalted::<Sha1>(), &digest)
.expect("failed to sign");

priv_key
.verify(Pss::new::<Sha1>(), &digest, &sig)
.verify(Pss::new_unsalted::<Sha1>(), &digest, &sig)
.expect("failed to verify");
}
}