How to: Encrypt and decrypt data with the Dapr JavaScript SDK

Mon, 01 Jan 0001 00:00:00 +0000

Use DaprClient.crypto to encrypt and decrypt data without passing cryptographic keys to your application. This guide uses a local key for development, then shows how to work with buffers and files.

Prerequisites

Dapr CLI
An initialized Dapr environment with a runtime that supports the alpha Cryptography API
Node.js 18 or later; a supported LTS release is recommended
The @dapr/dapr package, version 3.19.0 or later
A configured cryptography component and a key compatible with the selected key-wrapping algorithm

In your application directory, initialize an npm project if you do not already have one, then install the SDK:

Cryptography client usage

Mon, 01 Jan 0001 00:00:00 +0000

Cryptography is available through DaprClient.crypto. This page describes @dapr/dapr version 3.19.0 or later, which supports both HTTP and gRPC. Both transports use the alpha Cryptography API.

Client lifetime and configuration

Reuse a long-lived DaprClient rather than creating one for each operation. Await outstanding operations and stream pipelines before calling await client.stop() during application shutdown.

HTTP is the default protocol and uses sidecar port "3500" by default. For gRPC, configure the protocol and its port explicitly:

Dapr Cryptography JavaScript SDK on Dapr Docs

How to: Encrypt and decrypt data with the Dapr JavaScript SDK

Prerequisites

Cryptography client usage

Client lifetime and configuration