Skip to content

Commit eed0e25

Browse files
committed
Promote 'experimental_certs' -> 'certs'
Change-Id: I996160b9eccd0dd46b30d5d4827f80af5dcd41ae
1 parent 34280c6 commit eed0e25

File tree

4 files changed

+9
-13
lines changed

4 files changed

+9
-13
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ The following changes are included in the v1.3 (November 2023) release:
1818
config if used.
1919
* Add configuration flag to skip fork handlers registration, for applications
2020
that don't need the library to work in the child process.
21+
* Add configuration item to provide X.509 certificates that will be exposed
22+
by the library when matched with a KMS key.
2123
* Several internal dependencies were updated.
2224

2325
### PKCS#11 v1.2

kmsp11/config/config.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ message LibraryConfig {
4141

4242
// Optional. True means that X.509 certificates will be generated at runtime
4343
// for asymmetric KMS keys that are exposed in the library if no matching
44-
// certificate is found in a token's `experimental_certs`. Certificates are
44+
// certificate is found in a token's `certs`. Certificates are
4545
// not stable between runs of this library. This functionality is intended for
4646
// compatibility with the SunPKCS11 JCA provider; other use is discouraged.
4747
bool generate_certs = 5;
@@ -87,5 +87,5 @@ message TokenConfig {
8787

8888
// Optional. PEM-formatted X.509 certificates that should be exposed by this
8989
// token if a matching KMS key is found.
90-
repeated string experimental_certs = 3;
90+
repeated string certs = 3;
9191
}

kmsp11/docs/user_guide.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -141,16 +141,10 @@ experimental_create_multiple_versions | bool | No | false | Enables an
141141
142142
### Per token configuration
143143
144-
Item Name | Type | Required | Default | Description
145-
--------- | ------ | -------- | ------- | -----------
146-
key_ring | string | Yes | None | The full name of the KMS key ring whose keys will be made accessible.
147-
label | string | No | Empty | The label to use for this token's `CK_TOKEN_INFO` structure. Setting a value here may help an application disambiguate tokens at runtime.
148-
149-
#### Experimental token configuration options
150-
151-
Item Name | Type | Required | Default | Description
152-
-------------------------------------- | --------------- | -------- | ------- | -----------
153-
experimental_certs | list of strings | No | Empty | Enables an experiment that exposes the provided PEM X.509 certificate(s) alongside any KMS keys they match.
144+
--------- | --------------- | -------- | ------- | -----------
145+
key_ring | string | Yes | None | The full name of the KMS key ring whose keys will be made accessible.
146+
label | string | No | Empty | The label to use for this token's `CK_TOKEN_INFO` structure. Setting a value here may help an application disambiguate tokens at runtime.
147+
certs | list of strings | No | Empty | Exposes the provided PEM X.509 certificate(s) alongside any KMS keys they match.
154148

155149
## Functions
156150

kmsp11/token.cc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ absl::StatusOr<std::unique_ptr<Token>> Token::New(CK_SLOT_ID slot_id,
8686
ASSIGN_OR_RETURN(
8787
std::unique_ptr<ObjectLoader> loader,
8888
ObjectLoader::New(token_config.key_ring(),
89-
token_config.experimental_certs(), generate_certs));
89+
token_config.certs(), generate_certs));
9090
ASSIGN_OR_RETURN(ObjectStoreState state, loader->BuildState(*kms_client));
9191
ASSIGN_OR_RETURN(std::unique_ptr<ObjectStore> store, ObjectStore::New(state));
9292

0 commit comments

Comments
 (0)