1.9 KiB
| type | title | linkTitle | description |
|---|---|---|---|
| docs | JSON Web Key Sets (JWKS) | JSON Web Key Sets (JWKS) | Detailed information on the JWKS cryptography component |
Component format
The purpose of this component is to load keys from a JSON Web Key Set (RFC 7517). These are JSON documents that contain 1 or more keys as JWK (JSON Web Key); they can be public, private, or shared keys.
This component supports loading a JWKS:
- From a local file (if the file is changed on disk, it's reloaded automatically),
- From a HTTP(S) URL (periodically refreshed if needed), or
- By passing an actual JWKS in the Component YAML (as a string, which can be base64-encoded).
{{% alert title="Note" color="primary" %}} This component uses the cryptographic engine in Dapr to perform operations. Although keys are never exposed to your application, Dapr has access to the raw key material.
{{% /alert %}}
A Dapr crypto.yaml component file has the following structure:
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: jwks
spec:
type: crypto.jwks
version: v1
metadata:
- name: jwks
value: fixtures/crypto/jwks/jwks.json
{{% alert title="Warning" color="warning" %}} The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets, as described [here]({{< ref component-secrets.md >}}). {{% /alert %}}
Spec metadata fields
| Field | Required | Details | Example |
|---|---|---|---|
| jwks | Y | Connection-string for the JWKS host | fixtures/crypto/jwks/jwks.json |
| requestTimeout | N | Amount of time before request timeout; Default: 30 seconds | 30 |
| minRefreshInterval | N | Minimum interval for request refresh; Default: 10 minutes | 10 |
Related links
[Cryptography building block]({{< ref cryptography >}})