-
Notifications
You must be signed in to change notification settings - Fork 381
Add key management documentation for MSI v2 #5513
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
gladjohn
wants to merge
4
commits into
main
Choose a base branch
from
gladjohn-keys
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+71
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| # MSI v2 — Key Management | ||
|
|
||
| ## Overview | ||
|
|
||
| In MSI v2, before MSAL can call the managed identity endpoints (for example the Instance Metadata Service (IMDS) or the ESTS token service), it needs an asymmetric key pair. The private key is the local root of trust used for all subsequent operations (CSR generation, certificate issuance, Proof-of-Possession (PoP) binding, and mutual TLS (mTLS) handshakes). | ||
|
|
||
| ## Key responsibilities | ||
|
|
||
| The key management layer is responsible for: | ||
|
|
||
| - Generating the RSA key pair. | ||
| - Storing and managing the private key. | ||
| - On Windows, using the most secure available platform keystore (KeyGuard or TPM/KSP). | ||
| - On Linux, keeping the key in process memory only. | ||
| - Protecting the key to the maximum capability of the platform, preferring hardware-backed and isolated storage when available. | ||
| - Providing the key for signing (CSR, PoP requests, mTLS handshakes). | ||
| - Preventing export of hardware- or KeyGuard-backed keys (no API returns or serializes the private key material). | ||
|
|
||
| ## Key selection priority | ||
|
|
||
| MSAL implements a hierarchical key-provider strategy. | ||
|
|
||
| On **Windows**: | ||
|
|
||
| 1. KeyGuard (preferred, especially for PoP). | ||
| 2. Hardware / TPM / KSP (fallback). | ||
| 3. In-memory RSA (last resort). | ||
|
|
||
| On **Linux**, the only available option is in-memory RSA. | ||
|
|
||
| ### KeyGuard (preferred for PoP) | ||
|
|
||
| - Requires Virtualization-Based Security (VBS). | ||
| - Keys are isolated in a secure enclave. | ||
| - Provides the strongest guarantee that the private key cannot be exfiltrated. | ||
| - Preferred provider for PoP tokens on supported hosts. | ||
|
|
||
| ### Hardware / TPM / KSP (fallback) | ||
|
|
||
| - Keys are backed by the Trusted Platform Module (TPM) or the Platform Crypto Provider. | ||
| - Non-exportable and tied to the device. | ||
| - Provides strong hardware-based protection, but without the additional VBS isolation offered by KeyGuard. | ||
|
|
||
| ### In-memory RSA (last resort on Windows and only option on Linux) | ||
|
|
||
| - Keys are created and held in process memory. | ||
| - Software-only protection; weakest in terms of resistance to host compromise. | ||
| - Used only when stronger platform protections (KeyGuard or TPM/KSP) are unavailable. | ||
|
|
||
| ## Key selection flow | ||
|
|
||
| ```mermaid | ||
| sequenceDiagram | ||
| autonumber | ||
| participant MSAL | ||
| participant KeyProvider as Key Provider | ||
|
|
||
| MSAL->>KeyProvider: GetOrCreateKey() | ||
| alt Cached key exists | ||
| KeyProvider-->>MSAL: Return cached key | ||
| else No cached key | ||
| KeyProvider-->>KeyProvider: Acquire semaphore | ||
| alt KeyGuard available | ||
| KeyProvider-->>MSAL: KeyGuard key (preferred) | ||
| else KeyGuard not available, Hardware/TPM available | ||
| KeyProvider-->>MSAL: Hardware key | ||
| else KeyGuard and Hardware/TPM not available | ||
| KeyProvider-->>MSAL: In-memory RSA key | ||
gladjohn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| end | ||
| KeyProvider-->>KeyProvider: Cache key & release semaphore | ||
| end | ||
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.
Uh oh!
There was an error while loading. Please reload this page.