What is this?

This is a procedural macro for easy use of AWS Secrets Manager. This code allows you to create a global constant of the same type as the name of Secrets Manager by simply creating a structure that matches the key pair set in Secrets Manager. This way, you can access the secret values stored in Secrets Manager without writing any code to fetch them from AWS.

Pros:

• Key pairs can be retrieved by simply defining a struct with the same structure as the key pair set in Secrets Manager
• Key pairs are defined as global constants, so they can be used from anywhere
• Lazy evaluation by once_cell::sync::Lazy

Example code

use global_secrets_manager::GlobalSecretsManager;

/// Please use the same name as Secrets Manager for the name of the structure
/// Please set the keys of Secrets Manager without any omission or excess
#[derive(GlobalSecretsManager)]
#[derive(Debug, serde::Deserialize)]
pub struct SampleSecrets{ 
	key1: String,
	key2: String,
}
fn main(){
	dbg!(&SampleSecrets.key1); //-> value1
	dbg!(&SampleSecrets.key2); //-> value2
}

Advance Preparation

Dependencies

The following dependencies are required.

aws-config = "0.54.1"
aws-sdk-secretsmanager = "0.24.0"
once_cell = "1.17.0"
dotenvy = "0.15.6"
serde_json = "1.0.93"
tokio = { version = "1.21.2", features = ["full"] }
global-secrets-manager = "0.1.1"

However, it is better to use the latest versions of them.

AWS Secrets Manager settings

Please set up your secrets in AWS Secrets Manager according to the relevant page. For the sake of explanation, let's assume that the name of Secrets Manager is SampleSecrets and the secret values are set as follows.

AWS credential acquisition

Please obtain your credential information. If you are using AWS CLI, you can get it with the following command.

cat ~/.aws/credentials

.env settings

Create a .env file in your repository and enter your credential information as follows.

AWS_ACCESS_KEY_ID=AAAAA
AWS_SECRET_ACCESS_KEY = BBBBB
AWS_REGION = CCCCC

Explanation of internal specifications

For the structure

struct SampleSecrets{
	key1:String,
	key2:String
}

the same name global constant

pub static SampleSecrets: once_cell::sync::Lazy<SampleSecrets> = once_cell::sync::Lazy::new(||SampleSecrets::get());

is defined. This constant is initialized only once when it is first accessed, and it calls the get() method of the structure to fetch the secret values from AWS Secrets Manager.

LICENSE

AGPL-3.0-or-later.

The code generated by this proc-macro is exception of AGPL. You can choose its license as you like.