Skip to content

Commit 3c37052

Browse files
committed
Update README to reflect CNG availability.
Bug: b/273095357 Change-Id: I97c0f08f2b2bb9b34b4a579c9b5b5c7940a89d69
1 parent 19b9996 commit 3c37052

File tree

1 file changed

+25
-7
lines changed

1 file changed

+25
-7
lines changed

README.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Cloud KMS Integrations
22

33
This repository contains clients that integrate Cloud KMS with standard
4-
cryptographic APIs. Presently, this includes the library for PKCS #11.
4+
cryptographic APIs. Presently, this includes the library for PKCS #11, and the
5+
CNG provider.
56

67
For | Go To
78
---------------------------- | -----
@@ -34,16 +35,33 @@ this if you are writing a new application.
3435
You can learn more about the PKCS #11 library in the
3536
[user guide](kmsp11/docs/user_guide.md).
3637

37-
Binary distributions of this library are available as Github releases. These
38+
## Cloud KMS CNG Provider
39+
40+
NOTE: the CNG provider is currently in public preview.
41+
42+
The CNG provider exposes cryptographic and key management capabilities
43+
from Google Cloud KMS using the
44+
[CNG](https://learn.microsoft.com/en-us/windows/win32/seccng/cng-portal) API.
45+
Sources for this library are contained in the `kmscng/` directory in this
46+
repository.
47+
48+
Popular uses for the CNG provider include:
49+
50+
* Signing Windows artifacts using Windows SignTool.
51+
[Learn more](https://cloud.google.com/kms/docs/reference/cng-signtool).
52+
* Migrating an existing application that uses the CNG API to the cloud.
53+
54+
You can learn more about the CNG provider in the
55+
[user guide](kmscng/docs/user_guide.md).
56+
57+
## General Information
58+
59+
Binary distributions of the libraries are available as Github releases. These
3860
binaries built and distributed by Google are covered by the
3961
[GCP Terms of Service](https://cloud.google.com/terms), and support is available
4062
from [Google Cloud support](https://cloud.google.com/support-hub).
4163

42-
We recommend that you use a binary distribution of this library rather than
64+
We recommend that you use a binary distribution of these libraries rather than
4365
building from source. Support for a library that you build yourself from source
4466
is on a best-effort basis, via GitHub issues. Further information about
4567
build configurations is available in [BUILDING](BUILDING.md).
46-
47-
## Cloud KMS CNG Provider
48-
49-
The CNG provider is currently under development and is not yet ready for use.

0 commit comments

Comments
 (0)