Skip to content

Commit 7561b47

Browse files
committed
docs(mbe): modified aws interface docs
added better security recommendations as sugguested by audit Ticket: WP-6413
1 parent 8b0817e commit 7561b47

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

demo-kms-script/aws-interface.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ This document provides a reference implementation for integrating the 4 KMS API'
44

55
## ⚠️ Security Recommendation
66

7-
**For production KMS implementations, consider implementing the KMS-API in a C++ like language, or use typed arrays like Uint8Array for all sensitive data because JavaScript does not support secure memory management.**
7+
For production KMS implementations, consider implementing the KMS-API in a C++ like language, because JavaScript does not support low-level memory management. Depending on your solution, direct memory management with explicit memory allocation/deallocation might be desirable.
88

9-
**Recommended Alternatives:**
10-
- **C++/Rust**: Languages with explicit memory management and secure allocation
11-
- **Node.js Typed Arrays**: Use `Uint8Array` for sensitive data with explicit zeroing
12-
- **Native Addons**: Implement cryptographic operations in native C++ modules
13-
- **Hardware Security**: Use HSM-backed secure memory when available
9+
Also consider implementing low level cryptographic operations using low-level languages like C++ or Rust. They typically provide easier and more efficient data manipulation and transaformation.
10+
11+
If Javascript/Typescript is used, use low level data types such as Uint8Array to store keys. Avoid using datatype such as strings to store keys unless necessary.
12+
13+
When working with AWS HSM, adhere to their guidances and best practices for the [KMS](https://docs.aws.amazon.com/prescriptive-guidance/latest/encryption-best-practices/kms.html) and their [IAM policies](https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies-best-practices.html). You are encouraged to look into how keys are generated stored in AWS, and if certain features AWS offers (e.g. KMS key rotation, key policies) applies to your solution.
1414

1515
## API Overview
1616

package-lock.json

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)