Alibaba Key Management Service (KMS)

Since Camel 4.23

Only producer is supported

The Alibaba Cloud KMS component allows you to encrypt, decrypt and generate data keys using Alibaba Cloud KMS.

Maven users will need to add the following dependency to their pom.xml for this component:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-alibaba-kms</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

URI format

alibaba-kms:operation[?options]

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

At the component level, you set general and shared configurations that are, then, inherited by the endpoints. It is the highest configuration level.

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.

You can configure components using:

  • the Component DSL.

  • in a configuration file (application.properties, *.yaml files, etc).

  • directly in the Java code.

Configuring Endpoint Options

You usually spend more time setting up endpoints because they have many options. These options help you customize what you want the endpoint to do. The options are also categorized into whether the endpoint is used as a consumer (from), as a producer (to), or both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders.

Property placeholders provide a few benefits:

  • They help prevent using hardcoded urls, port numbers, sensitive information, and other settings.

  • They allow externalizing the configuration from the code.

  • They help the code to become more flexible and reusable.

The following two sections list all the options, firstly for the component followed by the endpoint.

Component Options

The Alibaba Key Management Service (KMS) component supports the following options which are listed below.

Name Description Default Type

lazyStartProducer (producer)

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

autowiredEnabled (advanced)

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

healthCheckConsumerEnabled (health)

Used for enabling or disabling all consumer based health checks from this component.

true

boolean

healthCheckProducerEnabled (health)

Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.

true

boolean

Endpoint Options

The Alibaba Key Management Service (KMS) endpoint is configured using URI syntax:

alibaba-kms:operation

With the following path and query parameters:

Path Parameters

Name Description Default Type

operation (producer)

Required Operation to perform.

Enum values:

  • encrypt

  • decrypt

  • generateDataKey

String

Query Parameters

Name Description Default Type

endpoint (producer)

KMS endpoint URL. Carries higher precedence than region based client initialization.

String

keyId (producer)

KMS key id.

String

keySpec (producer)

Key spec for generateDataKey.

String

numberOfBytes (producer)

Number of bytes for generateDataKey.

Integer

region (producer)

Required Alibaba Cloud region.

String

lazyStartProducer (producer (advanced))

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

kmsClient (advanced)

Autowired Autowire an existing KMS client instance.

Client

accessKey (security)

Access key for the cloud user.

String

ciphertextBlob (security)

Ciphertext blob to decrypt.

String

plaintext (security)

Plaintext to encrypt.

String

secretKey (security)

Secret key for the cloud user.

String

serviceKeys (security)

Configuration object for cloud service authentication.

ServiceKeys

Message Headers

The Alibaba Key Management Service (KMS) component supports the following message header(s), which is/are listed below:

Name Description Default Type

CamelAlibabaKmsKeyId (producer)

Constant: KEY_ID

KMS key id override.

String

CamelAlibabaKmsPlaintext (producer)

Constant: PLAINTEXT

Plaintext to encrypt.

String

CamelAlibabaKmsCiphertextBlob (producer)

Constant: CIPHERTEXT_BLOB

Ciphertext blob to decrypt.

String

CamelAlibabaKmsKeySpec (producer)

Constant: KEY_SPEC

Key spec for generateDataKey.

String

CamelAlibabaKmsNumberOfBytes (producer)

Constant: NUMBER_OF_BYTES

Number of bytes for generateDataKey.

Integer

CamelAlibabaKmsRequestId (producer)

Constant: REQUEST_ID

Alibaba Cloud request id.

String

Usage

Operations

The component supports the following operations:

  • encrypt - encrypt plaintext using a KMS key (producer)

  • decrypt - decrypt a ciphertext blob (producer)

  • generateDataKey - generate a data key (producer)

Producer example

from("direct:start")
    .setBody(constant("secret-value"))
    .to("alibaba-kms:encrypt?keyId=alias/my-key&region=cn-hangzhou&accessKey=RAW(accessKey)&secretKey=RAW(secretKey)");

Examples

For more examples, see the unit tests in the camel-alibaba-kms module.

Back to top