Add KMS driver guide to 3.x docs #835
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
carrielaben-da
approved these changes
Nov 13, 2024
Comment on lines
+17
to
+23
| The Canton protocol relies on a number of cryptographic operations such as | ||
| asymmetric encryption and digital signatures. To maximize the | ||
| operational security of a Canton node the corresponding private keys should not | ||
| be stored or processed in cleartext. A Key Management System (KMS) or Hardware | ||
| Security Module (HSM) allows us to perform such cryptographic operations where | ||
| the private key resides securely inside the KMS/HSM. All nodes in Canton can | ||
| make use of a KMS. |
There was a problem hiding this comment.
Suggested change
| The Canton protocol relies on a number of cryptographic operations such as | |
| asymmetric encryption and digital signatures. To maximize the | |
| operational security of a Canton node the corresponding private keys should not | |
| be stored or processed in cleartext. A Key Management System (KMS) or Hardware | |
| Security Module (HSM) allows us to perform such cryptographic operations where | |
| the private key resides securely inside the KMS/HSM. All nodes in Canton can | |
| make use of a KMS. | |
| The Canton protocol relies on cryptographic operations such as | |
| asymmetric encryption and digital signatures. To maximize the | |
| operational security of a Canton node the corresponding private keys should not | |
| be stored or processed in cleartext. A Key Management System (KMS) or Hardware | |
| Security Module (HSM) allows you to perform cryptographic operations where | |
| the private key resides securely inside the KMS/HSM. All nodes in Canton can | |
| make use of a KMS. |
| make use of a KMS. | ||
|
|
||
| AWS KMS and Google Cloud KMS are supported as of Canton v2.7. To broaden the | ||
| support of other KMSs and HSMs, Canton v2.9 introduces a plugin approach, called |
There was a problem hiding this comment.
Suggested change
| support of other KMSs and HSMs, Canton v2.9 introduces a plugin approach, called | |
| support of other KMSs and HSMs, Canton v2.9 introduces a plug-in approach, called |
Comment on lines
+30
to
+31
| run with a KMS driver. An implementation needs to be developed for the JVM, | ||
| currently only Scala is supported. |
There was a problem hiding this comment.
Suggested change
| run with a KMS driver. An implementation needs to be developed for the JVM, | |
| currently only Scala is supported. | |
| run with a KMS Driver. Currently, the KMS Driver is only available in a Scala implementation. |
Comment on lines
+38
to
+42
| 1. Driver Factory: Implements how a driver is instantiated and the main entry | ||
| point for Canton to load a driver. | ||
|
|
||
| 2. KMS Driver: The actual KMS driver API that offers cryptographic operations | ||
| based on the KMS. |
There was a problem hiding this comment.
Suggested change
| 1. Driver Factory: Implements how a driver is instantiated and the main entry | |
| point for Canton to load a driver. | |
| 2. KMS Driver: The actual KMS driver API that offers cryptographic operations | |
| based on the KMS. | |
| - Driver Factory: Implements how a driver is instantiated; the main entry | |
| point for Canton to load a driver. | |
| - KMS Driver: Offers cryptographic operations based on the KMS. |
Comment on lines
+45
to
+46
| change to either the factory or driver APIs will result in a new major version | ||
| of those APIs. The current and only version is **v1**, which is part of the |
There was a problem hiding this comment.
Suggested change
| change to either the factory or driver APIs will result in a new major version | |
| of those APIs. The current and only version is **v1**, which is part of the | |
| change to either the factory or driver APIs results in a new major version | |
| of those APIs. The current and only version is **v1**, which is part of the |
| failed with a ``KmsDriverException``. When the exception's flag retryable is | ||
| true the caller side, i.e., Canton, performs a retry with exponential | ||
| backoff. This behavior is suitable for transient errors, such as network issues, | ||
| resource exhaustion etc. |
There was a problem hiding this comment.
Suggested change
| resource exhaustion etc. | |
| resource exhaustion, etc. |
Comment on lines
+176
to
+177
| The major part of the implementation is the ``v1.KmsDriver`` that is specific to | ||
| the KMS/HSM to be integrated with. The supported key and algorithm |
There was a problem hiding this comment.
Suggested change
| The major part of the implementation is the ``v1.KmsDriver`` that is specific to | |
| the KMS/HSM to be integrated with. The supported key and algorithm | |
| The major part of the implementation is the ``v1.KmsDriver`` specific to | |
| the KMS/HSM to be integrated with. The supported key and algorithm |
| :end-before: user-manual-entry-end: AwsKmsDriverTest | ||
|
|
||
| Generating new keys can be expensive when running tests during | ||
| development, in particular when using cloud-based KMSs. To mitigate this, the test |
There was a problem hiding this comment.
Suggested change
| development, in particular when using cloud-based KMSs. To mitigate this, the test | |
| development, particularly with cloud-based KMSs. To mitigate this, the test |
| KmsDriverFactoryTest | ||
| ^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| The test suite for the KMS driver factory is structured similarly to the above: |
There was a problem hiding this comment.
Suggested change
| The test suite for the KMS driver factory is structured similarly to the above: | |
| The test suite for the KMS Driver factory is structured similarly to the above: |
| Run Canton with a KMS Driver | ||
| ---------------------------- | ||
|
|
||
| Configure Canton to run with a KMS driver, for example, for a |
There was a problem hiding this comment.
Suggested change
| Configure Canton to run with a KMS driver, for example, for a | |
| Configure Canton to run with a KMS Driver, for example, for a |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.