encodedKey indexing out of sync in docs/CaskSecret.md
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Domain
- documentation
Research direction
Open docs/CaskSecret.md around lines 84–91 and compare the encodedKey table with the corrected ending supplied in the issue. Update the indexes, closing bracket, and range notation so the final character is encodedKey[63] and the total is 64 characters. Done means the URL-safe Base64 example's table is internally consistent.
Written by the indexing model from the issue text.
Description
In https://github.com/microsoft/cask/blob/main/docs/CaskSecret.md#url-safe-base64-encoded-rendering-example-for-256-bit-key-no-optional-data, the indexing of encodedKey goes out of sync after <12-bits-reserved> "AA":
It shows the time-of-allocation second at encodedKey[64], but that should instead be at encodedKey[63] so that the size of the whole thing is 64 characters and it evenly translates to 64/4*3 = 48 bytes.
Also, there is a closing bracket missing, and the 'a'..'e' range should use ... rather than .. because it's meant to include 'e'.
The table should end like this:
| String Range | Text Value | Description |
|---|---|---|
| … | … | … |
| encodedKey[52..56] | 'TEST' | Provider fixed signature. |
| encodedKey[56..58] | 'AA' | Reserved encoded zero characters. |
| encodedKey[58] | 'A'...'_' | Time-of-allocation year, 'A' (2025) to '_' (2088) |
| encodedKey[59] | 'A'...'L' | Time-of-allocation month, 'A' (January) to 'L' (December) |
| encodedKey[60] | 'A'...'Z'|'a'...'e' | Time-of-allocation day, 'A' (0) to 'e' (31) |
| encodedKey[61] | 'A'...'X' | Time-of-allocation hour, 'A' (hour 0 or midnight) to 'X' (hour 23). |
| encodedKey[62] | 'A'...'7' | Time-of-allocation minute, 'A' (0) to '7' (59). |
| encodedKey[63] | 'A'...'7' | Time-of-allocation second, 'A' (0) to '7' (59). |
- Dominant language
- C#
- Stars
- 6
- Forks
- 6
- Avg merge
- 8h 21m
- Merged PRs (30d)
- 2
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/cask
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
Difficulty 1/5 Under an hour Newbie friendliness 55/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Avoid encode/decode round-trips in IsCaskMay be free again @nguerrera claimed this 542 days ago, and no pull request is open. Open
Similar issues
-
[Doc Gap] Document new --enable-public-network-access breaking change for azurebackup vault createOpencopilot documentation
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
area-dashboard
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
0 - Backlog Bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
BrighterCommand/Brighter#4539 ·
Maintainers usually reply within 1 day
-
area-networking
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
dotnet/aspnetcore#69671 · 1 comment ·
Maintainers usually reply within 1 day
-
test
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
NethermindEth/nethermind#14274 ·
Maintainers usually reply within 1 day