Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saga420/temporal-encryption-converter
Temporal Encryption Converter is a Go package enabling robust encryption, decryption, and context propagation within Temporal workflows. The package employs asymmetric cryptography, sophisticated encryption algorithms, and pre-encryption ZLib compression for optimal security and efficiency.
https://github.com/saga420/temporal-encryption-converter
encryption golang temporal
Last synced: 2 months ago
JSON representation
Temporal Encryption Converter is a Go package enabling robust encryption, decryption, and context propagation within Temporal workflows. The package employs asymmetric cryptography, sophisticated encryption algorithms, and pre-encryption ZLib compression for optimal security and efficiency.
- Host: GitHub
- URL: https://github.com/saga420/temporal-encryption-converter
- Owner: saga420
- License: mit
- Created: 2023-07-11T00:31:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-13T07:46:12.000Z (over 1 year ago)
- Last Synced: 2024-08-02T11:14:23.405Z (5 months ago)
- Topics: encryption, golang, temporal
- Language: Go
- Homepage:
- Size: 98.6 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-temporal - `saga420/temporal-encryption-converter` - The Temporal Encryption Converter is a Go package that provides secure communication and context propagation for the Temporal workflow engine, employing AES256_GCM_PBKDF2_Curve25519 and XChaCha20_Poly1305_PBKDF2_Curve25519 encryption algorithms and ZLib compression. (Go / Libraries)
README
[![Go Report Card][go-report-image]][go-report-url]
[](https://pkg.go.dev/github.com/saga420/temporal-encryption-converter)
[](https://opensource.org/licenses/MIT)
[](https://codecov.io/gh/saga420/temporal-encryption-converter)
[go-report-image]: https://goreportcard.com/badge/github.com/saga420/temporal-encryption-converter
[go-report-url]: https://goreportcard.com/report/github.com/saga420/temporal-encryption-converter
[go-report-image]: https://goreportcard.com/badge/github.com/saga420/temporal-encryption-converter
[go-report-url]: https://goreportcard.com/report/github.com/saga420/temporal-encryption-converter
# Temporal Encryption Converter
The Temporal Encryption Converter is a Go package designed to deliver encryption and decryption solutions for payloads
within the Temporal workflow engine. The package incorporates a unique context propagator, enabling the transmission of
context values across multiple workflows.
## Installation
Install the package with the go get command:
```bash
go get github.com/saga420/temporal-encryption-converter
```
## Usage
> SEE example/*.go for more examples
```go
// Generate a key pair for the client
client, _ := encryption.GenerateKeyPair()
fmt.Println("Client's Private Key: ", client.PrivateKey)
fmt.Println("Client's Public Key: ", client.PublicKey)
// Generate a key pair for the worker
worker, _ := encryption.GenerateKeyPair()
fmt.Println("Worker's Private Key: ", worker.PrivateKey)
fmt.Println("Worker's Public Key: ", worker.PublicKey)
```
The X25519 algorithm is used for key exchange. Before initiating a workflow, the client must possess knowledge of the
worker's public key, which is essential for encrypting data intended solely for that worker to decrypt and process.
Intriguingly, it's not required for the worker to preconfigure the client's public key. This key is conveyed within the
context metadata of the workflow, allowing any client (each potentially with different key pairs) to transmit encrypted
data to the worker using the worker's public key. The worker can subsequently receive and process workflow messages from
any client, promoting a flexible and secure communication system.
Note: Error handling is critical in production code. While errors are omitted for brevity in these examples, in a
production environment, it's crucial to always check and handle errors effectively.
## Features
- Empowers payload encryption and decryption in Temporal workflows.
- Implements AES256_GCM_PBKDF2_Curve25519 and XChaCha20_Poly1305_PBKDF2_Curve25519 encryption algorithms.
- Supports ZLib compression pre-encryption for payload size optimization.
- Facilitates passing of context values across diverse workflows.
## Contributing
We warmly welcome contributions. Kindly fork the repository and submit a pull request with your amendments.
## License
This package is distributed under the terms of the MIT License.