Skip to content
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.

Sign up for GitHub

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

Add documentation for VBS in CngKeyCreationOptions #107301

Merged
merged 3 commits into from
Sep 3, 2024
Merged

Add documentation for VBS in CngKeyCreationOptions #107301

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2af6c89
Add documentation for VBS in CngKeyCreationOptions
vcsjones Sep 3, 2024
315b2c0
Reorder description.
vcsjones Sep 3, 2024
680b981
Update src/libraries/System.Security.Cryptography/src/System/Security…
bartonjs Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions ...es/System.Security.Cryptography/src/System/Security/Cryptography/CngKeyCreationOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,21 @@ public enum CngKeyCreationOptions : int
None = 0x00000000,
MachineKey = 0x00000020, // NCRYPT_MACHINE_KEY_FLAG
OverwriteExistingKey = 0x00000080, // NCRYPT_OVERWRITE_KEY_FLAG

/// <summary>
/// Indicates a key should be protected with Virtualization-based security (VBS).
/// </summary>
PreferVbs = 0x00010000, // NCRYPT_PREFER_VBS_FLAG

/// <summary>
/// Indicates a key must be protected with Virtualization-based security (VBS).
vcsjones marked this conversation as resolved.
Show resolved Hide resolved
/// </summary>
RequireVbs = 0x00020000, // NCRYPT_REQUIRE_VBS_FLAG

/// <summary>
/// Instructs Virtualization-based security (VBS) to protect the client key with a per-boot key
/// when combined with <see cref="RequireVbs"/> or <see cref="PreferVbs"/> .
Comment on lines +30 to +31
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Instructs Virtualization-based security (VBS) to protect the client key with a per-boot key
/// when combined with <see cref="RequireVbs"/> or <see cref="PreferVbs"/> .
/// Instructs Virtualization-based security (VBS) to protect the client key with a key that can't
/// be reused across boot cycles when combined with <see cref="RequireVbs"/> or
/// <see cref="PreferVbs"/>.

/// </summary>
UsePerBootKey = 0x00040000, // NCRYPT_USE_PER_BOOT_KEY_FLAG
}
}
Loading