Add documentation for the version (v) parameter #4

simonepri · 2018-04-02T19:35:10Z

Changes

Add the version (v) parameter to the PHC string format standard

Closes

#1
P-H-C/phc-winner-argon2#248
P-H-C/phc-winner-argon2#199
P-H-C/phc-winner-argon2#157

cc: @philtay @ranisalt @tarcieri @sneves @YetAnotherMinion @tniswong @veorq @josephlr @khovratovich @pornin

Close P-H-C/phc-winner-argon2#248 Close P-H-C/phc-winner-argon2#199 Close P-H-C#1

ranisalt · 2018-04-02T20:26:06Z

phc-sf-spec.md

@@ -279,6 +286,8 @@ For Argon2, the following is specified:

  - The identifier for Argon2ds is `argon2ds`.

+  - The versions are: [16, 19].


It would be clearer to use 0x10, 0x13 or 16 (for Argon2 1.0), 19 (for Argon2 1.3).

Yes it makes sense.
Actually I think we should completely remove the Argon2 Encoding section.
It does not make a lot of sense to have it here.

simonepri · 2018-04-02T20:39:29Z

More changes to discuss about:

Remove Argon2 Encoding section.
Replace the current readme with the specs. The readme is pointless.
Add references to implemented parsers like phc-format.
Add explaination on why salt and secret can be optional. (Why hash and salt are both optional? #3)

What do you think about them?

christianpv · 2018-04-09T00:10:38Z

phc-sf-spec.md

@@ -35,6 +36,7 @@ The string is then the concatenation, in that order, of:

 - a `$` sign;
 - the function symbolic name;
+ - optionally, a `$` sign followed by the algortihm version with a `v=version` format;


Found a typo: algortihm -> algorithm

Nice catch thank you!

ranisalt · 2018-04-10T03:23:04Z

phc-sf-spec.md

@@ -48,6 +50,8 @@ case of a function family); identifiers should be explicit (human
 readable, not a single digit), with a length of about 5 to 10
 characters. An identifier name MUST NOT exceed 32 characters in length.

+The value for the version shall be a sequence of characters in: `[0-9]`.
+


Considering Argon2 currently uses hex numbers, technically it's [0-9A-Fa-f] or [[:xdigit:]] class.

All the values are decimal encoded as per specs.
Eg:
0x13->19
0x10->16
So the version is digits only.

simonepri · 2018-06-07T10:46:52Z

Should we just create a new "official" repository for that instead of relying on this one?
The team definitely doesn't care about it anymore.

dimaqq · 2019-08-23T02:02:21Z

Ugh, the whole version business is ugly.
IMO, if the algorithm implementation changed, just s/argon2/argon3 so that the older version can be one day deprecated.

tarcieri · 2021-01-05T16:59:55Z

phc-sf-spec.md

@@ -21,11 +21,12 @@ string that differs from the format herein described.

 We define the following format:

-       $<id>[$<param>=<value>(,<param>=<value>)*][$<salt>[$<hash>]]
+       $<id>[$v=<version>][$<param>=<value>(,<param>=<value>)*][$<salt>[$<hash>]]


There's a somewhat ambiguous case:

$<id>[$v=<version>](,<param>=<value>)+][$<salt>[$<hash>]]

It'd be good to clarify what behavior parsers have for this case:

MUST NOT interpret the v parameter as a version

MUST interpret the v parameter as a version

Since a separated [$v=<version>]$... parameter is already in the wild, I would suggest MUST NOT here.

I don't know if it helps, but you can refer to this implementation:
https://github.com/simonepri/phc-format/blob/master/index.js#L136-L224

If I remember correctly, in the case you mentioned my parser does not interpret v as the version but as a parameter.

Since a separated [$v=]$... parameter is already in the wild

What are you referring to exactly?

I'm referring to Argon2 having deployed $v=...$<params>, versus $v=...,<params>

Support for PHC string variant with an additional version field: P-H-C/phc-string-format#4 This is used by Argon2.

tarcieri · 2021-04-17T04:33:36Z

So I notice that as a panel member I can merge this.

I'll give it a more thorough review, but perhaps I should. Getting it merged seems very much overdue.

khovratovich · 2021-04-17T05:27:43Z

Feel free to merge

…

On Sat, Apr 17, 2021, 07:33 Tony Arcieri ***@***.***> wrote: So I notice that as a panel member I can merge this. I'll give it a more thorough review, but perhaps I should. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#4 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA767MRRRB3C7OXGXATD4NTTJEFSVANCNFSM4EYP4P6A> .

tarcieri · 2021-04-17T18:53:23Z

Sorry that took so long.

FYI I'm maintaining an argon2 Rust crate which is using this repo for documentation. I'm happy to help review such PRs in the future and hopefully as such they'll get merged sooner than 3 years. 😉

The upstream PR to add this to the spec was merged: P-H-C/phc-string-format#4

Add documentation for the version (v) parameter

ffc60ce

Close P-H-C/phc-winner-argon2#248 Close P-H-C/phc-winner-argon2#199 Close P-H-C#1

simonepri mentioned this pull request Apr 2, 2018

Add Hash class to handle results ranisalt/node-argon2#119

Closed

ranisalt reviewed Apr 2, 2018

View reviewed changes

christianpv reviewed Apr 9, 2018

View reviewed changes

ranisalt reviewed Apr 10, 2018

View reviewed changes

Fix typo

af7dd44

tarcieri reviewed Jan 5, 2021

View reviewed changes

tarcieri mentioned this pull request Jan 5, 2021

password-hash: MCF support RustCrypto/traits#450

Closed

tarcieri added a commit to RustCrypto/traits that referenced this pull request Jan 6, 2021

password-hash: add version field

423f2c9

Support for PHC string variant with an additional version field: P-H-C/phc-string-format#4 This is used by Argon2.

tarcieri added a commit to RustCrypto/traits that referenced this pull request Jan 6, 2021

password-hash: add version field

fab383d

Support for PHC string variant with an additional version field: P-H-C/phc-string-format#4 This is used by Argon2.

tarcieri mentioned this pull request Jan 6, 2021

password-hash: add version field RustCrypto/traits#456

Merged

tarcieri added a commit to RustCrypto/traits that referenced this pull request Jan 6, 2021

password-hash: add version field (#456)

80b4bcb

Support for PHC string variant with an additional version field: P-H-C/phc-string-format#4 This is used by Argon2.

tarcieri merged commit cf415da into P-H-C:master Apr 17, 2021

tarcieri added a commit to RustCrypto/traits that referenced this pull request Apr 17, 2021

password-hash: update docs for PHC string <version> field

7a3111d

The upstream PR to add this to the spec was merged: P-H-C/phc-string-format#4

tarcieri mentioned this pull request Apr 17, 2021

password-hash: update docs for PHC string <version> field RustCrypto/traits#593

Merged

tarcieri added a commit to RustCrypto/traits that referenced this pull request Apr 17, 2021

password-hash: update docs for PHC string <version> field (#593)

d93daef

The upstream PR to add this to the spec was merged: P-H-C/phc-string-format#4

tarcieri mentioned this pull request Apr 10, 2024

Wrong text about where = may occur #7

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation for the version (v) parameter #4

Add documentation for the version (v) parameter #4

simonepri commented Apr 2, 2018 •

edited

Loading

ranisalt Apr 2, 2018

simonepri Apr 2, 2018 •

edited

Loading

simonepri commented Apr 2, 2018 •

edited

Loading

christianpv Apr 9, 2018

simonepri Apr 10, 2018

ranisalt Apr 10, 2018

simonepri Apr 10, 2018

simonepri commented Jun 7, 2018 •

edited

Loading

dimaqq commented Aug 23, 2019

tarcieri Jan 5, 2021

simonepri Jan 6, 2021

tarcieri Jan 6, 2021

tarcieri commented Apr 17, 2021 •

edited

Loading

khovratovich commented Apr 17, 2021 via email

tarcieri commented Apr 17, 2021

		@@ -279,6 +286,8 @@ For Argon2, the following is specified:

		- The identifier for Argon2ds is `argon2ds`.

		- The versions are: [16, 19].

Add documentation for the version (v) parameter #4

Add documentation for the version (v) parameter #4

Conversation

simonepri commented Apr 2, 2018 • edited Loading

Changes

Closes

Choose a reason for hiding this comment

simonepri Apr 2, 2018 • edited Loading

Choose a reason for hiding this comment

simonepri commented Apr 2, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

simonepri commented Jun 7, 2018 • edited Loading

dimaqq commented Aug 23, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tarcieri commented Apr 17, 2021 • edited Loading

khovratovich commented Apr 17, 2021 via email

tarcieri commented Apr 17, 2021

simonepri commented Apr 2, 2018 •

edited

Loading

simonepri Apr 2, 2018 •

edited

Loading

simonepri commented Apr 2, 2018 •

edited

Loading

simonepri commented Jun 7, 2018 •

edited

Loading

tarcieri commented Apr 17, 2021 •

edited

Loading