microsoft / microsoft/cask

GenerateKeyPseudoCode.md is inconsistent about parameter sizes

Open
#73 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
6
Forks
6
Avg merge
8d 10h
Merged PRs (30d)
4

Description

Provider data

CaskSecret.md says the provider data can be up to 40 characters:

https://github.com/microsoft/cask/blob/6f4c27277bdbe447929dba1a7f009bdddc0e9c0e/docs/CaskSecret.md?plain=1#L43-L48

GenerateKeyPseudoCode.md however says it cannot be more than 12 characters:

https://github.com/microsoft/cask/blob/6f4c27277bdbe447929dba1a7f009bdddc0e9c0e/docs/GenerateKeyPseudoCode.md?plain=1#L19

even though another part of GenerateKeyPseudoCode.md allows 10 segments of 4 characters each:

https://github.com/microsoft/cask/blob/6f4c27277bdbe447929dba1a7f009bdddc0e9c0e/docs/GenerateKeyPseudoCode.md?plain=1#L41

Sensitive data

CaskSecret.md allows only 256 or 512 bits of sensitive data:

https://github.com/microsoft/cask/blob/6f4c27277bdbe447929dba1a7f009bdddc0e9c0e/docs/CaskSecret.md?plain=1#L42

GenerateKeyPseudoCode.md however allows 128, 256, 384, or 512 bits during validation:

https://github.com/microsoft/cask/blob/6f4c27277bdbe447929dba1a7f009bdddc0e9c0e/docs/GenerateKeyPseudoCode.md?plain=1#L21

even though another part of GenerateKeyPseudoCode.md allows only 256 or 512 bits:

https://github.com/microsoft/cask/blob/6f4c27277bdbe447929dba1a7f009bdddc0e9c0e/docs/GenerateKeyPseudoCode.md?plain=1#L40

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read docs/CaskSecret.md and docs/GenerateKeyPseudoCode.md at the referenced sections, comparing the provider-data and sensitive-data limits. Determine the intended values from the surrounding specification, then make the two documents consistent; done means no contradictory parameter sizes remain.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.