-
Notifications
You must be signed in to change notification settings - Fork 247
L127: C++: SPIFFE Bundle Map support in Providers #506
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
8510c4f
add file
gtcooke94 8f289b7
wording
gtcooke94 e7df383
address comments
gtcooke94 07a85a2
add correct file
gtcooke94 f3f99ff
add google groups discussion link
gtcooke94 1fbb197
add impl PRs
gtcooke94 deffb81
update header info
gtcooke94 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,48 @@ | ||
| L123: Spiffe Bundle Map support in Root Providers | ||
markdroth marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ---- | ||
| * Author(s): gtcooke94 | ||
| * Approver: markdroth | ||
| * Status: Draft | ||
| * Implemented in: core, cpp | ||
| * Last updated: 2025-07-15 | ||
| * Discussion at: TODO | ||
|
|
||
| ## Abstract | ||
|
|
||
| The purpose of this proposal is to add public API support for SPIFFE bundle maps in root certificate file watcher providers. [gRFC A87](https://github.com/grpc/proposal/blob/master/A87-mtls-spiffe-support.md) details the broader internals for this support. | ||
markdroth marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Background | ||
|
|
||
| gRPC supports SPIFFE bundle maps as root certificate material per [gRFC A87](https://github.com/grpc/proposal/blob/master/A87-mtls-spiffe-support.md). Public APIs to configure these roots is needed. | ||
markdroth marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Related Proposals: | ||
| * [gRFC A87](https://github.com/grpc/proposal/blob/master/A87-mtls-spiffe-support.md) | ||
|
|
||
| ## Proposal | ||
|
|
||
| This document proposes to extend the C-Core and C++ APIs as follows: | ||
|
|
||
|
|
||
| ### C-Core | ||
| C-Core APIs are always subject to change - we will simply add an argument to the existing constructor in https://github.com/grpc/grpc/blob/79769b35d04535259592ac1b0a98d65f63203f06/include/grpc/credentials.h#L663-L666. | ||
markdroth marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
markdroth marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
| GRPCAPI grpc_tls_certificate_provider* | ||
| grpc_tls_certificate_provider_file_watcher_create( | ||
| const char* private_key_path, const char* identity_certificate_path, | ||
| const char* root_cert_path, const char* spiffe_bundle_map_path, unsigned int refresh_interval_sec); | ||
| ``` | ||
|
|
||
| ### C++ | ||
| While the existing C++ API is marked experimental, we don't _want_ to break existing users. Thus, in https://github.com/grpc/grpc/blob/79769b35d04535259592ac1b0a98d65f63203f06/include/grpcpp/security/tls_certificate_provider.h#L109-L112, we will add a constructor with the `spiffe_bundle_map_path` argument. | ||
markdroth marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| In order to not break current users, we will make the existing constructors support this by supplying an empty SPIFFE bundle map path. | ||
| ``` | ||
|
|
||
| FileWatcherCertificateProvider(const std::string& private_key_path, | ||
| const std::string& identity_certificate_path, | ||
| const std::string& root_cert_path, | ||
| const std::string& spiffe_bundle_map_path, | ||
| unsigned int refresh_interval_sec); | ||
| ``` | ||
|
|
||
| ### Other Providers | ||
| This proposal _only_ aims to support file-based SPIFFE Bundle Maps via the file watcher providers. The `StaticDataCertificateProvider` structure is left as future work - we do not want to expose our internal SPIFFE utilities. | ||
markdroth marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
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.