https://github.com/rnag/aws-secrets
Retrieve AWS secrets and interact with Secrets Manager and SSM Parameter Store
https://github.com/rnag/aws-secrets
Last synced: 9 days ago
JSON representation
Retrieve AWS secrets and interact with Secrets Manager and SSM Parameter Store
- Host: GitHub
- URL: https://github.com/rnag/aws-secrets
- Owner: rnag
- License: mit
- Created: 2022-08-26T22:02:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-27T02:14:02.000Z (over 3 years ago)
- Last Synced: 2025-02-28T09:05:31.594Z (11 months ago)
- Language: Rust
- Size: 28.3 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# aws-secrets
[
](https://github.com/rnag/aws-secrets)
[
](https://crates.io/crates/aws-secrets)
[
](https://docs.rs/aws-secrets)
[
](https://github.com/rnag/aws-secrets/actions?query=branch%3Amain)
Retrieve AWS secrets and interact with [Secrets Manager] and [SSM Parameter Store].
[Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
[SSM Parameter Store]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html
---
This crate works with Cargo with a `Cargo.toml` like:
```toml
[dependencies]
aws-secrets = { version = "0.1.1", features = ["all"] }
serde_json = "1" # optional
tokio = { version = "1", features = ["full"] }
```
## Getting started
Add some usage to your application. Here's an example of using `aws-secrets` in code.
> Note: this sample requires the `all` feature to be enabled.
```rust
use aws_secrets::{config_from_env, SSMParamExt, SecretsExt};
use serde_json::{to_string, Value};
#[tokio::main]
async fn main() -> Result<(), Box> {
let shared_config = config_from_env().await;
// Retrieve a secret from AWS Secrets Manager
let secret_name = "my-secret";
let value: Value = secret_name.get_secret(&shared_config).await?;
let secret_string = to_string(&value)?;
println!("[{secret_name}] Retrieved secret. value={secret_string}");
// Retrieve a parameter from AWS SSM Parameter Store
let param_name = "/my/secure/param";
let value = param_name.get_secure_string(&shared_config).await?;
println!("[{param_name}] Retrieved parameter. value={value:?}");
Ok(())
}
```
## Examples
You can check out sample usage of this crate in the [examples/](https://github.com/rnag/aws-secrets/tree/main/examples)
folder in the project repo on GitHub.
## Dependencies and Features
This library uses only the minimum required dependencies, in order
to keep the overall size small. It leverages the [AWS SDK for Rust]
for making calls to AWS APIs.
> **Note:** Any desired features must be enabled individually, as no features are enabled by default.
#### Available features
* `all` - Enables support for AWS Secrets Manager and SSM Parameter Store.
* `params` - Enables support for AWS SSM Parameter Store.
* `sm` - Enables support for AWS Secrets Manager.
#### Enabling Features
Update the project's `Cargo.toml` to include any optional features to enable:
```toml
[dependencies]
aws-secrets = { version = "*", features = ["all"] }
```
[AWS SDK for Rust]: https://docs.aws.amazon.com/sdk-for-rust/latest/dg/using.html
## Contributing
Contributions are welcome! Open a pull request to fix a bug, or [open an issue][]
to discuss a new feature or change.
Check out the [Contributing][] section in the docs for more info.
[Contributing]: CONTRIBUTING.md
[open an issue]: https://github.com/rnag/aws-secrets/issues
## License
This project is proudly licensed under the MIT license ([LICENSE](LICENSE)
or http://opensource.org/licenses/MIT).
`aws-secrets` can be distributed according to the MIT license. Contributions
will be accepted under the same license.
## Authors
* [Ritvik Nag](https://github.com/rnag)