Encode and decode your Temporal data

• Purpose
  • Key file format
• Languages
  • Codec Server
  • Library
• Deployment
• Contributing
  • Open in a container
  • Commit style

This repository is designed to act as a practical guide for implementing data encryption for every language officially supported by Temporal.

For every language, these implement an AES encryption algorithm and add an encryption-key-id to the metadata. Multiple keys can be added to allow for key rotation.

The Codec servers and libraries are mutually compatible meaning you are not required to install multiple versions of the Codec server for each SDK you us.

Both YAML and JSON are supported for the key file. It's a simple structure where the active key is the key in position 0.

The id is stored in the metadata and will be publicly visible so should not be considered sensitive data. The key is used by the algorithm and should be treated as a secret.

- id: key0
  key: passphrasewhichneedstobe32bytes!
- id: key1
  key: anoldpassphraseinourhistory!!!!!

Other languages coming soon

• Go

• Go
• Python
• TypeScript

See the Helm chart.

• Open in a container

All commits must be done in the Conventional Commit format.

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]