Add SecureToken to enforce good token hygiene #3320

pietroalbini · 2021-02-22T14:35:51Z

This PR adds the SecureToken struct, which relies on the type system to enforce good practices for generating and verifying tokens:

SecureToken forces adding an unique prefix in front of every kind of generated token. This allows token scanning services to properly identify tokens generated by crates.io, and allows crates.io to detect which kind of token it's about to revoke.
SecureToken only stores and exposes the SHA256 of already generated tokens, to prevent accidental plaintext leakages. The plaintext token value is only exposes for newly generated tokens.

r? @Turbo87

src/util.rs

Turbo87 · 2021-02-22T14:48:26Z

src/util/token.rs

+        .collect()
+}
+
+macro_rules! secure_token_kind {


I find this a bit hard to read. Did you consider using something like strum instead of this custom macro? If we'll still go with the custom macro I think it'd be good to add a few more doc comments on it at least :)

I don't think it's worth bringing another dependency in just for this. I'll try to add some comments to the macro.

I guess this is also fine to retrofit. I'm approving the PR in the meantime :)

src/models/token.rs

src/util/token.rs

src/models/token.rs

This commit adds the `SecureToken` struct, which relies on the type system to enforce good practices for generating and verifying tokens: * `SecureToken` forces adding an unique prefix in front of every kind of generated token. This allows token scanning services to properly identify tokens generated by crates.io, and allows crates.io to detect which kind of token it's about to revoke. * `SecureToken` only stores and exposes the SHA256 of already generated tokens, to prevent accidental plaintext leakages. The plaintext token value is only exposes for newly generated tokens.

Turbo87 · 2021-02-25T11:02:01Z

@bors r+

bors · 2021-02-25T11:02:03Z

📌 Commit 46840ca has been approved by Turbo87

Add SecureToken to enforce good token hygiene This PR adds the `SecureToken` struct, which relies on the type system to enforce good practices for generating and verifying tokens: * `SecureToken` forces adding an unique prefix in front of every kind of generated token. This allows token scanning services to properly identify tokens generated by crates.io, and allows crates.io to detect which kind of token it's about to revoke. * `SecureToken` only stores and exposes the SHA256 of already generated tokens, to prevent accidental plaintext leakages. The plaintext token value is only exposes for newly generated tokens. r? `@Turbo87`

bors · 2021-02-25T11:30:23Z

⌛ Testing commit 46840ca with merge febf9f8...

bors · 2021-02-25T11:35:32Z

💔 Test failed - checks-actions

Turbo87 · 2021-02-25T13:27:56Z

@bors retry

bors · 2021-02-25T13:41:52Z

⌛ Testing commit 46840ca with merge eb093ee...

bors · 2021-02-25T13:59:12Z

☀️ Test successful - checks-actions
Approved by: Turbo87
Pushing eb093ee to master...

rust-highfive assigned Turbo87 Feb 22, 2021

rust-highfive added the S-waiting-on-review label Feb 22, 2021