Google Secret Manager
Since Camel 3.16
Only producer is supported
The Google Secret Manager component provides access to Google Cloud Secret Manager
Maven users will need to add the following dependency to their pom.xml for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-google-secret-manager</artifactId>
<!-- use the same version as your Camel core version -->
<version>x.x.x</version>
</dependency>
Authentication Configuration
Google Secret Manager component authentication is targeted for use with the GCP Service Accounts. For more information please refer to Google Cloud Authentication.
When you have the service account key you can provide authentication credentials to your application code. Google security credentials can be set through the component endpoint:
String endpoint = "google-secret-manager://myCamelFunction?serviceAccountKey=/home/user/Downloads/my-key.json";
Or by setting the environment variable GOOGLE_APPLICATION_CREDENTIALS
:
export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/my-key.json"
URI Format
google-secret-manager://functionName[?options]
You can append query options to the URI in the following format,
?options=value&option2=value&…
For example in order to call the function myCamelFunction
from the project myProject
and location us-central1
, use the following snippet:
from("google-secret-manager://myProject?serviceAccountKey=/home/user/Downloads/my-key.json&operation=createSecret")
.to("direct:test");
Configuring Options
Camel components are configured on two separate levels:
-
component level
-
endpoint level
Configuring Component Options
The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.
Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.
Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.
Configuring Endpoint Options
Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.
Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL as a type safe way of configuring endpoints.
A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.
The following two sections lists all the options, firstly for the component followed by the endpoint.
Component Options
The Google Secret Manager component supports 2 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
boolean |
|
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. |
true |
boolean |
Endpoint Options
The Google Secret Manager endpoint is configured using URI syntax:
google-secret-manager:project
with the following path and query parameters:
Query Parameters (5 parameters)
Name | Description | Default | Type |
---|---|---|---|
Service account key to authenticate an application as a service account. |
String |
||
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
boolean |
|
The operation to perform on the producer. Enum values:
|
GoogleSecretManagerOperations |
||
Specifies if the request is a pojo request. |
false |
boolean |
|
Autowired The client to use during service invocation. |
SecretManagerServiceClient |
Message Headers
The Google Secret Manager component supports 3 message header(s), which is/are listed below:
Name | Description | Default | Type |
---|---|---|---|
GoogleSecretManagerOperation (producer) Constant: |
The operation to perform. Enum values:
|
GoogleSecretManagerOperations |
|
CamelGoogleSecretManagerSecretId (producer) Constant: |
The id of the secret. |
String |
|
CamelGoogleSecretManagerVersionId (producer) Constant: |
The version of the secret. |
latest |
String |
Using GCP Secret Manager Properties Source
To use GCP Secret Manager you need to provide serviceAccountKey file and GCP projectId. This can be done using environmental variables before starting the application:
export $CAMEL_VAULT_GCP_SERVICE_ACCOUNT_KEY=file:////path/to/service.accountkey
export $CAMEL_VAULT_GCP_PROJECT_ID=projectId
You can also configure the credentials in the application.properties
file such as:
camel.vault.gcp.serviceAccountKey = accessKey
camel.vault.gcp.projectId = secretKey
If you want instead to use the GCP default client instance, you’ll need to provide the following env variables:
export $CAMEL_VAULT_GCP_USE_DEFAULT_INSTANCE=true
export $CAMEL_VAULT_GCP_PROJECT_ID=projectId
You can also configure the credentials in the application.properties
file such as:
camel.vault.gcp.useDefaultInstance = true
camel.vault.aws.projectId = region
At this point you’ll be able to reference a property in the following way by using gcp:
as prefix in the {{ }}
syntax:
<camelContext>
<route>
<from uri="direct:start"/>
<to uri="{{gcp:route}}"/>
</route>
</camelContext>
Where route
will be the name of the secret stored in the GCP Secret Manager Service.
You could specify a default value in case the secret is not present on GCP Secret Manager:
<camelContext>
<route>
<from uri="direct:start"/>
<to uri="{{gcp:route:default}}"/>
</route>
</camelContext>
In this case if the secret doesn’t exist, the property will fallback to "default" as value.
Also, you are able to get particular field of the secret, if you have for example a secret named database of this form:
{
"username": "admin",
"password": "password123",
"engine": "postgres",
"host": "127.0.0.1",
"port": "3128",
"dbname": "db"
}
You’re able to do get single secret value in your route, like for example:
<camelContext>
<route>
<from uri="direct:start"/>
<log message="Username is {{gcp:database/username}}"/>
</route>
</camelContext>
Or re-use the property as part of an endpoint.
You could specify a default value in case the particular field of secret is not present on GCP Secret Manager:
<camelContext>
<route>
<from uri="direct:start"/>
<log message="Username is {{gcp:database/username:admin}}"/>
</route>
</camelContext>
In this case if the secret doesn’t exist or the secret exists, but the username field is not part of the secret, the property will fallback to "admin" as value.
For the moment we are not considering the rotation function, if any will be applied, but it is in the work to be done. |
There are only two requirements:
- Adding camel-google-secret-manager
JAR to your Camel application.
- Give the service account used permissions to do operation at secret management level (for example accessing the secret payload, or being admin of secret manager service)
Google Secret Manager Producer operations
Google Functions component provides the following operation on the producer side:
-
createSecret
-
getSecretVersion
-
deleteSecret
-
listSecrets
If you don’t specify an operation by default the producer will use the createSecret
operation.
Google Secret Manager Producer Operation examples
-
createSecret: This operation will create a secret in the Secret Manager service
from("direct:start")
.setHeader("GoogleSecretManagerConstants.SECRET_ID, constant("test"))
.setBody(constant("hello"))
.to("google-functions://myProject?serviceAccountKey=/home/user/Downloads/my-key.json&operation=createSecret")
.log("body:${body}")
-
getSecretVersion: This operation will retrieve a secret value with latest version in the Secret Manager service
from("direct:start")
.setHeader("GoogleSecretManagerConstants.SECRET_ID, constant("test"))
.to("google-functions://myProject?serviceAccountKey=/home/user/Downloads/my-key.json&operation=getSecretVersion")
.log("body:${body}")
This will log the value of the secret "test".
-
deleteSecret: This operation will delete a secret
from("direct:start")
.setHeader("GoogleSecretManagerConstants.SECRET_ID, constant("test"))
.to("google-functions://myProject?serviceAccountKey=/home/user/Downloads/my-key.json&operation=deleteSecret")
-
listSecrets: This operation will return the secrets list for the project myProject
from("direct:start")
.setHeader("GoogleSecretManagerConstants.SECRET_ID, constant("test"))
.to("google-functions://myProject?serviceAccountKey=/home/user/Downloads/my-key.json&operation=listSecrets")
Spring Boot Auto-Configuration
When using google-secret-manager with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-google-secret-manager-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
The component supports 3 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. |
true |
Boolean |
|
Whether to enable auto configuration of the google-secret-manager component. This is enabled by default. |
Boolean |
||
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
Boolean |