Introduce the aws_s3 BundlePublisher plugin
#4355
There are no files selected for viewing
This file contains 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
This file contains 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,50 @@ | ||
| # Server plugin: BundlePublisher "aws_s3" | ||
|
|
||
| The `aws_s3` plugin puts the current trust bundle of the server in a designated | ||
| Amazon S3 bucket, keeping it updated. | ||
|
|
||
| The plugin accepts the following configuration options: | ||
|
|
||
| | Configuration | Description | Default | | ||
| |-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------| | ||
| | access_key_id | AWS access key id. | Value of AWS_ACCESS_KEY_ID environment variable. | | ||
| | secret_access_key | AWS secret access key. | Value of AWS_SECRET_ACCESSKEY environment variable. | | ||
| | region | AWS region to store the trust bundle. | | | ||
| | bucket | The Amazon S3 bucket name to which the trust bundle is uploaded. | | | ||
| | object_key | The object key inside the bucket. | | | ||
| | format | Format in which the trust bundle is stored, <spiffe | jwks | pem>. See [Supported bundle formats](#supported-bundle-formats) for more details. | | | ||
|
There was a problem hiding this comment. may we add a (required) here? |
||
|
|
||
| ## Supported bundle formats | ||
|
|
||
| The following bundle formats are supported: | ||
|
|
||
| ### SPIFFE format | ||
|
|
||
| The trust bundle is represented as an RFC 7517 compliant JWK Set, with the specific parameters defined in the [SPIFFE Trust Domain and Bundle specification](https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE_Trust_Domain_and_Bundle.md#4-spiffe-bundle-format). Both the JWT authorities and the X.509 authorities are included. | ||
|
|
||
| ### JWKS format | ||
|
|
||
| The trust bundle is encoded as an RFC 7517 compliant JWK Set, omitting SPIFFE-specific parameters. Both the JWT authorities and the X.509 authorities are included. | ||
|
|
||
| ### PEM format | ||
|
|
||
| The trust bundle is formatted using PEM encoding. Only the X.509 authorities are included. | ||
|
|
||
| ## AWS IAM Permissions | ||
|
|
||
| The user or role identified by the configured credentials must have the `s3:PutObject` IAM permissions. | ||
|
|
||
| ## Sample configuration | ||
|
|
||
| The following configuration uploads the local trust bundle contents to the `example.org` object in the `spire-trust-bundle` bucket. The AWS access key id and secret access key are obtained from the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESSKEY environment variables. | ||
|
|
||
| ```hcl | ||
| BundlePublisher "aws_s3" { | ||
| plugin_data { | ||
| region = "us-east-1" | ||
| bucket = "spire-trust-bundle" | ||
| object_key = "example.org" | ||
| format = "spiffe" | ||
| } | ||
| } | ||
| ``` | ||
This file contains 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
This file contains 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
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in another examples we have region empty