Changed base32 to base58; removed step to shorten the encoded hash du…

…ring the scid generation; added changelog; added author

 Signed-off-by: Michel Sahli <michel.sahli@bj.admin.ch>

Signed-off-by: Michel Sahli <michel.sahli@bj.admin.ch>

spec/definitions.md

@@ -78,12 +78,12 @@ when forced to change (such as when an organization is acquired by another,
 resulting in a change of domain names) and when changing DID hosting service
 providers.
 
-[[def: base32_lower]]
+[[def: base58]]
 
-~ Applies [[spec:rfc4648]] to convert
-data to a `base32` encoding, and then lower cases the result. Data encoded as
-base32 consists of a string of characters containing only the letters A-Z and
-digits 2-7.
+~ Applies [[spec:draft-msporny-base58-03]] to convert
+data to a `base58` encoding. Data encoded as
+base58 consists of a string of characters containing only the letters A-Z, a-z and
+digits 1-9.
 
 [[def: Linked-VP, Linked Verifiable Presentation]]
 

spec/header.md

@@ -3,7 +3,7 @@ Trust DID Web - `did:tdw`
 
 **Specification Status:** DRAFT
 
-**Specification Version:** 0.2 (see [Changelog](#did-tdw-version-changelog))
+**Specification Version:** 0.3 (see [Changelog](#did-tdw-version-changelog))
 
 **Latest Draft:**
   [https://github.com/bcgov/trustdidweb](https://github.com/bcgov/trustdidweb)
@@ -13,6 +13,7 @@ Trust DID Web - `did:tdw`
 ~ [John Jordan, BC Gov](https://github.com/jljordan42)
 ~ [Andrew Whitehead](https://github.com/andrewwhitehead)
 ~ [Brian Richter](https://github.com/brianorwhatever)
+~ [Michel Sahli](https://github.com/bj-ms)
 
 **Participate:**
 ~ [GitHub repo](https://github.com/bcgov/trustdidweb)

spec/specification.md

@@ -47,8 +47,8 @@ here the full ABNF of those elements from that RFC would inevitably be wrong.
 tdw-did = "did:tdw:" scid ":" domain-segment 1+( "." domain-segment ) *( ":" path-segment )
 domain-segment = ; A part of a domain name as defined in RFC3986, such as "example" and "com" in "example.com"
 path-segment= ; A part of a URL path as defined in RFC3986, such as "path", "to", "folder" in "path/to/folder"
-scid = 28+( lower-base32 )
-lower-base32 = [2-7a-z]
+scid = ( base58 )
+base58 = [1-9A-Za-z]
 ```
 
 The ABNF for a `did:tdw` is almost identical to that of [[ref: did:web]], with changes only to
@@ -620,7 +620,7 @@ first [[ref: DID log entry]] and is a portion of the hash of the DID's inception
 To generate the required [[ref: SCID]] for a `did:tdw` DID, the DID Controller
 **MUST** execute the following function:
 
- `left(base32_lower(hash(JCS(preliminary log entry with placeholders))), <length>)`
+ `base58(hash(JCS(preliminary log entry with placeholders)))`
 
 Where:
 
@@ -643,10 +643,8 @@ Where:
 3. `hash` is the hash algorithm enumerated in the `hash` item in the [[ref:
    parameters]], or if none is specified, the default hash algorithm defined in
    this specification. Its output is the hash of its input.
-4. `base32_lower` is an implementation of the [[ref: base32_lower]] function.
-   Its output is the lower case of the Base32 encoded string of its input.
-5. `left` extracts the `<length>` number of characters from the string input.
-   1. `<length>` **MUST** be at least 28 characters.
+4. `base58` is an implementation of the [[ref: base58]] function.
+   Its output is the Base58 encoded string of its input.
 
 ##### Verify SCID
 
@@ -680,7 +678,7 @@ previous log entry.
 ##### Generate Entry Hash
 
 To generate the required hash for a `did:tdw` DID entry, the DID Controller
-**MUST** execute the process `base32_lower(hash(JCS(entry)))` given a
+**MUST** execute the process `base58(hash(JCS(entry)))` given a
 preliminary log entry as the string `entry`, where:
 
 1. `JCS` is an implementation of the [[ref: JSON Canonicalization Scheme]]
@@ -689,8 +687,8 @@ preliminary log entry as the string `entry`, where:
 2. `hash` is the hash algorithm enumerated in the `hash` item in the [[ref:
    parameters]], or if none is specified, the default hash algorithm defined in
    this specification. Its output is the hash of its input.
-3. `base32_lower` is an implementation of the [[ref: base32_lower]] function.
-   Its output is the lower case of the Base32 encoded string of its input.
+3. `base58` is an implementation of the [[ref: base58]] function.
+   Its output is the Base58 encoded string of its input.
 
 The following is an example of a preliminary log entry that is processed to
 produce an entry hash. As this is a first entry in a DID Log, the input
@@ -720,16 +718,16 @@ Resolver **MUST** execute the following process:
 3. Set the first item of the entry to the `versionId` (first item) of the
    previous log entry. If this is the first entry in the log, set the value to
    the `1-<scid>` where `<scid>` if the SCID of the DID.
-4. Calculate the hash string as `base32_lower(hash(JCS(entry)))`, where:
+4. Calculate the hash string as `base58(hash(JCS(entry)))`, where:
    1. `entry` is the data from the previous step.
    2. `JCS` is an implementation of the [[ref: JSON Canonicalization Scheme]]
       ([[spec:rfc8785]]). Its output is a canonicalized representation of its
       input.
    3. `hash` is the hash algorithm enumerated in the `hash` item in the [[ref:
       parameters]], or if none is specified, the default hash algorithm defined in
       this specification. Its output is the hash of its input.
-   4. `base32_lower` as defined by the [[ref: base32_lower]] function. Its
-      output is the lower case of the Base32 encoded string of the input hash.
+   4. `base58` as defined by the [[ref: base58]] function. Its
+      output is the Base58 encoded string of the input hash.
 5. Verify that the calculated value matches the extracted value from Step 1. If
    not, terminate the resolution process with an error.
 
@@ -832,14 +830,14 @@ authorization key.
 1. Generate a new key pair.
 2. Generate a [[ref: multikeys]] representation of the public key of the new key
    pair.
-3. Calculate the hash string as `base32_lower(hash(multikey))`, where:
+3. Calculate the hash string as `base58(hash(multikey))`, where:
    1. `multikey` is the [[ref: multikey]] representation of the public key.
    2. ``hash` is the most recent hash algorithm enumerated in the `hash` item in
       the [[ref: parameters]], or if none is specified, the default hash
       algorithm defined in this specification. Its output is the hash of its
       input.
-   3. `base32_lower` as defined by the [[ref: base32_lower]] function. Its
-      output is the lower case of the Base32 encoded string of the input hash.
+   3. `base58` as defined by the [[ref: base58]] function. Its
+      output is the Base58 encoded string of the input hash.
 4. Insert the calculated hash into the `nextKeyHashes` array being built up within
    the [[ref: parameters]] item.
 5. The generated key pair **SHOULD** be safely stored so that it can be used in

spec/version.md

@@ -2,6 +2,9 @@
 
 The following lists the substantive changes in each version of the specification.
 
+- Version 0.3
+  - Change base32 encoding with base58, as it offers a better expansion rate.
+  - Remove the step to extract part of the base58 result during the generation of the [[ref: SCID]].
 - Version 0.2
   - Changes the location of the [[ref: SCID]] in the DID to always be the first
     component after the DID Method prefix -- `did:tdw:<scid>:...`.