Some small fixups (#31)

* Fix up documentation whitespace.

Remove trailing whitespace and apply a final line-ending character
to SECURTY.md and LICENSE. Some editors lint about or silently fix
these nits, so it makes for less-noisy patches if they're uniformly
applied to files in the repo.

* ppoprf: Fix comment typo

* sharks: Prefer rebinding to mutable variable.

In the documentation example, we try to recover a key from
both sufficient and insufficient number of shares. The example
used a `let mut secret` to store the result of both operations,
however in Rust it's generally better to use a new immutable
variable whenever possible.

Rebinding the previous variable name is considered acceptable
when it's a refinement of the same concept.

* ppoprf: don't request zeroize alloc feature

This feature is on by default, so it's not necessary to activate
it explicitly.

Author: rillian

LICENSE

@@ -370,4 +370,4 @@ Exhibit B - "Incompatible With Secondary Licenses" Notice
 ---------------------------------------------------------
 
   This Source Code Form is "Incompatible With Secondary Licenses", as
-  defined by the Mozilla Public License, v. 2.0.
+  defined by the Mozilla Public License, v. 2.0.

SECURITY.md

@@ -6,4 +6,4 @@ The code in this repository is still being actively developed, and is thus regar
 
 ## Reporting a Vulnerability
 
-Please report any observed issues to the [GitHub repository](https://github.com/brave-experiments/sta-rs/). 
+Please report any observed issues to the [GitHub repository](https://github.com/brave-experiments/sta-rs/).

adss-rs/LICENSE

@@ -370,4 +370,4 @@ Exhibit B - "Incompatible With Secondary Licenses" Notice
 ---------------------------------------------------------
 
   This Source Code Form is "Incompatible With Secondary Licenses", as
-  defined by the Mozilla Public License, v. 2.0.
+  defined by the Mozilla Public License, v. 2.0.

adss-rs/SECURITY.md

@@ -6,4 +6,4 @@ The code in this repository is still being actively developed, and is thus regar
 
 ## Reporting a Vulnerability
 
-Please report any observed issues to the [GitHub repository](https://github.com/brave-experiments/sta-rs/). 
+Please report any observed issues to the [GitHub repository](https://github.com/brave-experiments/sta-rs/).

ppoprf/Cargo.toml

@@ -18,7 +18,7 @@ strobe-rs = "0.7.1"
 strobe-rng = { path = "../strobe-rng" }
 base64 = "0.13"
 derive_more = "0.99"
-zeroize = { version = "1.5.4", features = [ "alloc", "derive" ]}
+zeroize = { version = "1.5.4", features = [ "derive" ] }
 
 [dev-dependencies]
 actix-web = "4.0.1"

ppoprf/src/ggm.rs

@@ -189,7 +189,7 @@ impl PPRF for GGM {
     let pfx = self.key.find_prefix(&bv)?;
     let pfx_len = pfx.0.len();
 
-    // If the prfix is smaller than the current input, then we
+    // If the prefix is smaller than the current input, then we
     // need to recompute some parts of the tree. Otherwise we
     // just remove the prefix entirely.
     let mut new_pfxs: Vec<(Prefix, Vec<u8>)> = Vec::new();

sharks/src/lib.rs

@@ -92,12 +92,12 @@ impl Sharks {
   /// # let mut rng = rand_chacha::ChaCha8Rng::from_seed([0x90; 32]);
   /// # let mut shares: Vec<Share> = sharks.dealer_rng(&[1], &mut rng).take(3).collect();
   /// // Recover original secret from shares
-  /// let mut secret = sharks.recover(&shares);
+  /// let secret = sharks.recover(&shares);
   /// // Secret correctly recovered
   /// assert!(secret.is_ok());
   /// // Remove shares for demonstration purposes
   /// shares.clear();
-  /// secret = sharks.recover(&shares);
+  /// let secret = sharks.recover(&shares);
   /// // Not enough shares to recover secret
   /// assert!(secret.is_err());
   pub fn recover<'a, T>(&self, shares: T) -> Result<Vec<u8>, &str>

sta-rs/LICENSE

@@ -370,4 +370,4 @@ Exhibit B - "Incompatible With Secondary Licenses" Notice
 ---------------------------------------------------------
 
   This Source Code Form is "Incompatible With Secondary Licenses", as
-  defined by the Mozilla Public License, v. 2.0.
+  defined by the Mozilla Public License, v. 2.0.

sta-rs/SECURITY.md

@@ -6,4 +6,4 @@ The code in this repository is still being actively developed, and is thus regar
 
 ## Reporting a Vulnerability
 
-Please report any observed issues to the [GitHub repository](https://github.com/brave-experiments/sta-rs/). 
+Please report any observed issues to the [GitHub repository](https://github.com/brave-experiments/sta-rs/).

strobe-rng/LICENSE

@@ -370,4 +370,4 @@ Exhibit B - "Incompatible With Secondary Licenses" Notice
 ---------------------------------------------------------
 
   This Source Code Form is "Incompatible With Secondary Licenses", as
-  defined by the Mozilla Public License, v. 2.0.
+  defined by the Mozilla Public License, v. 2.0.

strobe-rng/SECURITY.md

@@ -6,4 +6,4 @@ The code in this repository is still being actively developed, and is thus regar
 
 ## Reporting a Vulnerability
 
-Please report any observed issues to the [GitHub repository](https://github.com/brave-experiments/sta-rs/). 
+Please report any observed issues to the [GitHub repository](https://github.com/brave-experiments/sta-rs/).