feat: add cookbook recipe how to generate keys #223

trusch · 2023-03-03T10:16:04Z

This adds a cookbook recipe how to generate all keys necessary for the following recipes, so a user can start at zero.

fixes KILTProtocol/ticket#2373

How to test:

Build the docs and go to the DID section of the cookbook. The very first item is new and explains how to generate keys.

Checklist:

I have verified that the code works
I have verified that the code is easy to understand
- If not, I have left a well-balanced amount of inline comments
I have left the code in a better state
I have documented the changes (where applicable)

weichweich

Nice. Some small things... Could you explain what happens in the the code?

how are the keys generated?
- why are some using derivation paths?
- why use the base mnemonic for the authentication key?

Could you also add links to the places where this might be interesting? e.g. DID creation?

code_examples/sdk_examples/src/core_features/did/00_generate_did_keys.ts

docs/develop/01_sdk/02_cookbook/01_dids/00_generate_keys.md

trusch · 2023-03-23T09:25:56Z

@weichweich I addressed all of your comments, PTAL :)

…op section)

aws-amplify-eu-central-1 · 2023-03-23T09:59:03Z

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-223.d3oeht7cvddn19.amplifyapp.com

weichweich

I still would like to see something that explains the derivation paths.

ntn-x2

If you add a mention to Sporran, explaining that the derivation path shown is the same Sporran uses, it's good to go!

ntn-x2 · 2023-07-14T15:23:18Z

code_examples/sdk_examples/src/core_features/did/00_generate_did_keys.ts

+  // This allows us to restore all keys related to this DID from a single mnemonic seed phrase.
+  // The chosen derivation pathes can be anything, but here we use the purpuse of the keys to be generated.
+  const authenticationKey = baseSignerKey.derive(
+    '//authentication'


Should we follow the way Sporran does it?

Yes, I was about to update this. This would mean that our current accounts and DIDs used in the testing would break but hopefully fix itself.

Though we already have this in the utils folder in the core_features. Therefore, I would take over this PR and sort it out.

Maybe it is good to make it consistent with the workshop, that is already using the derivation paths from sporran.

Agreed. I was going to basically copy pasta it in.

weichweich · 2023-07-28T13:10:32Z

docs/develop/01_sdk/02_cookbook/01_dids/00_generate_keys.md

+Creating a DID (like in [Light DID Creation](./01_light_did_creation.md) or [Full DID Creation](./02_full_did_creation.md)) requires the generation of some keying material for keys that are to be used for authentication and encryption.
+
+The following is an example of how to create a a set of keypairs suitable for generating a KILT DID from it.


Maybe something like this:

Suggested change

Creating a DID (like in [Light DID Creation](./01_light_did_creation.md) or [Full DID Creation](./02_full_did_creation.md)) requires the generation of some keying material for keys that are to be used for authentication and encryption.

The following is an example of how to create a a set of keypairs suitable for generating a KILT DID from it.

Creating a Decentralized Identifier (DID) in the KILT network involves generating keying material for authentication and encryption. In this guide, we'll demonstrate how to create a set of key pairs suitable for generating a KILT DID.

Before we proceed, it's important to note that this example assumes the usage of the @kiltprotocol/sdk-js library along with the @polkadot/util-crypto library for cryptographic operations. Additionally, we want to emphasize the significance of securely storing keys and the mnemonic seed phrase. For production use, ensure that private keys are encrypted and stored safely, while also creating a backup of the mnemonic seed phrase.

Below is an example code snippet illustrating the key pair generation for a KILT DID:

Also please explain the reason for the derivation paths

Maybe like that:

In the example provided, we derive different types of keys from a single account using derivation paths. This approach allows us to generate various key pairs for authentication, key agreement, assertion methods, and capability delegation from one mnemonic seed phrase. Using derivation paths simplifies key management, ensuring that a single mnemonic seed serves as the basis for multiple keys associated with a DID. This method improves efficiency while maintaining security. However, it's essential to handle and store private keys securely to prevent unauthorized access and ensure the overall integrity and privacy of the decentralized identity system.

soooo much 🤖

weichweich

LGTM

docs/develop/01_sdk/02_cookbook/01_dids/00_generate_keys.md

Co-authored-by: Albrecht <[email protected]>

* feat: add cookbook recipe how to generate keys (taken from the workshop section) * fix broken test * run prettier * try to fix test * prettier * try to fix test * prettier * add more explanations about derivation pathes * feat: updating to match sporran and updating naming throughout to match * lint: updating the linting * feat: removal of the mention of light did * feat: adding remarks and suggestions for better text * Update docs/develop/01_sdk/02_cookbook/01_dids/00_generate_keys.md Co-authored-by: Albrecht <[email protected]> --------- Co-authored-by: dudleyneedham <[email protected]> Co-authored-by: Skedley <[email protected]> Co-authored-by: Albrecht <[email protected]>

trusch requested a review from weichweich March 3, 2023 10:16

weichweich suggested changes Mar 10, 2023

View reviewed changes

code_examples/sdk_examples/src/core_features/did/00_generate_did_keys.ts Outdated Show resolved Hide resolved

docs/develop/01_sdk/02_cookbook/01_dids/00_generate_keys.md Outdated Show resolved Hide resolved

trusch requested a review from weichweich March 23, 2023 09:25

trusch added 2 commits March 23, 2023 10:49

feat: add cookbook recipe how to generate keys (taken from the worksh…

890c5bd

…op section)

fix broken test

89dba2e

trusch force-pushed the feat/key-generation-recipe branch from 10553b9 to 89dba2e Compare March 23, 2023 09:53

trusch added 5 commits March 23, 2023 10:59

run prettier

042a8d7

try to fix test

491529a

prettier

6f19170

try to fix test

73a4fbb

prettier

56eaa58

weichweich suggested changes Mar 24, 2023

View reviewed changes

trusch and others added 2 commits July 14, 2023 13:17

Merge branch 'master' into feat/key-generation-recipe

18f3b1d

add more explanations about derivation pathes

1f3e5d9

ntn-x2 reviewed Jul 14, 2023

View reviewed changes

Dudleyneedham added 3 commits July 28, 2023 14:46

feat: updating to match sporran and updating naming throughout to match

ba5e741

lint: updating the linting

a3f88a9

feat: removal of the mention of light did

45dd6d0

weichweich suggested changes Jul 28, 2023

View reviewed changes

feat: adding remarks and suggestions for better text

a9895e8

Dudleyneedham force-pushed the feat/key-generation-recipe branch 2 times, most recently from e02e592 to a9895e8 Compare August 1, 2023 09:10

weichweich approved these changes Aug 1, 2023

View reviewed changes

docs/develop/01_sdk/02_cookbook/01_dids/00_generate_keys.md Outdated Show resolved Hide resolved

Update docs/develop/01_sdk/02_cookbook/01_dids/00_generate_keys.md

a17686a

Co-authored-by: Albrecht <[email protected]>

Dudleyneedham merged commit 827222a into master Aug 1, 2023
6 checks passed

Dudleyneedham deleted the feat/key-generation-recipe branch August 1, 2023 10:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add cookbook recipe how to generate keys #223

feat: add cookbook recipe how to generate keys #223

trusch commented Mar 3, 2023

weichweich left a comment

trusch commented Mar 23, 2023

aws-amplify-eu-central-1 bot commented Mar 23, 2023

weichweich left a comment

ntn-x2 left a comment

ntn-x2 Jul 14, 2023

Dudleyneedham Jul 28, 2023

Dudleyneedham Jul 28, 2023

kilted-andres Jul 28, 2023

Dudleyneedham Jul 28, 2023

weichweich Jul 28, 2023

Dudleyneedham Jul 28, 2023

weichweich Jul 28, 2023

weichweich left a comment

		Creating a DID (like in [Light DID Creation](./01_light_did_creation.md) or [Full DID Creation](./02_full_did_creation.md)) requires the generation of some keying material for keys that are to be used for authentication and encryption.

		The following is an example of how to create a a set of keypairs suitable for generating a KILT DID from it.

-Creating a DID (like in [Light DID Creation](./01_light_did_creation.md) or [Full DID Creation](./02_full_did_creation.md)) requires the generation of some keying material for keys that are to be used for authentication and encryption.
-The following is an example of how to create a a set of keypairs suitable for generating a KILT DID from it.
+Creating a Decentralized Identifier (DID) in the KILT network involves generating keying material for authentication and encryption. In this guide, we'll demonstrate how to create a set of key pairs suitable for generating a KILT DID.
+Before we proceed, it's important to note that this example assumes the usage of the @kiltprotocol/sdk-js library along with the @polkadot/util-crypto library for cryptographic operations. Additionally, we want to emphasize the significance of securely storing keys and the mnemonic seed phrase. For production use, ensure that private keys are encrypted and stored safely, while also creating a backup of the mnemonic seed phrase.
+Below is an example code snippet illustrating the key pair generation for a KILT DID:

feat: add cookbook recipe how to generate keys #223

feat: add cookbook recipe how to generate keys #223

Conversation

trusch commented Mar 3, 2023

fixes KILTProtocol/ticket#2373

How to test:

Checklist:

weichweich left a comment

Choose a reason for hiding this comment

trusch commented Mar 23, 2023

aws-amplify-eu-central-1 bot commented Mar 23, 2023

weichweich left a comment

Choose a reason for hiding this comment

ntn-x2 left a comment

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

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

Choose a reason for hiding this comment

weichweich left a comment

Choose a reason for hiding this comment