You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: astro/src/content/docs/apis/_key-generate-post-request-body.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,15 +22,15 @@ import JSON from 'src/components/JSON.astro';
22
22
*`HS512` - HMAC using SHA-512 hash algorithm
23
23
</APIField>
24
24
<APIFieldname="key.issuer"type="String"optional>
25
-
The issuer of the RSA or EC certificate.
25
+
The issuer of the certificate.
26
26
27
27
If omitted, this value will default to the value of <InlineField>tenant.issuer</InlineField> on the default tenant. For HMAC keys, this field does not apply and will be ignored if specified, and no default value will be set.
28
28
</APIField>
29
29
<APIFieldname="key.name"type="String"required>
30
30
The name of the Key.
31
31
</APIField>
32
32
<APIFieldname="key.length"type="String"optional>
33
-
The length of the RSA or EC certificate. This field is required when generating RSA key types.
33
+
The length of the RSA or EC certificate. This field is required when generating RSA key types.
34
34
35
35
For RSA, possible values are: `2048`, `3072` or `4096`.
The Key public key. Required if importing an RSA or EC key and a `certificate`is not provided.
33
+
The Key public key. If the key is only to be used for signing, only a private key is necessary and this field may be omitted. This field should be omitted when importing an HMAC key type.
The Key private key. Optional if importing an RSA or EC key. If the key is only to be used for token validation, only a public key is necessary and this field may be omitted.
36
+
The Key private key. If the key is only to be used for signature validation, only a public key is necessary and this field may be omitted. This field should be omitted when importing an HMAC key type.
37
37
</APIField>
38
38
<APIFieldname="key.secret"type="String"optional>
39
39
The Key secret. This field is required if importing an HMAC key type.
40
40
</APIField>
41
41
<APIFieldname="key.type"type="String"optional>
42
-
The Key type. This field is required if importing an HMAC key type, or if importing a public key / private key pair. The possible values are:
42
+
The Key type. This field is required if importing an HMAC key type, or if importing a public key / private key pair. The possible values are:
Because the private key will never be returned in the API response, this value will indicate if the private key is stored in FusionAuth. This field is omitted for HMAC key types.
@@ -60,7 +60,7 @@ import JSON from 'src/components/JSON.astro';
60
60
The [instant](/docs/reference/data-types#instants) that the key was added to the FusionAuth database.
Copy file name to clipboardExpand all lines: astro/src/content/docs/apis/jwt.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -142,7 +142,7 @@ _Response Codes_
142
142
143
143
## Retrieve Public Keys
144
144
145
-
This API is used to retrieve Public Keys generated by FusionAuth. These can be used to cryptographically verify JWTs signed with the corresponding RSA or ECDSA private key.
145
+
This API is used to retrieve Public Keys generated by FusionAuth. These can be used to cryptographically verify JWTs signed with the corresponding private key.
Copy file name to clipboardExpand all lines: astro/src/content/docs/extend/events-and-webhooks/events/index.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ These are the events that FusionAuth generates that can be optionally consumed b
20
20
21
21
*[Audit Log Create](/docs/extend/events-and-webhooks/events/audit-log-create) - when an audit log is created
22
22
*[Event Log Create](/docs/extend/events-and-webhooks/events/event-log-create) - when an event log is created
23
-
*[JWT Public Key Update](/docs/extend/events-and-webhooks/events/jwt-public-key-update) - when a JWT RSA Public / Private keypair used for signing may have been updated
23
+
*[JWT Public Key Update](/docs/extend/events-and-webhooks/events/jwt-public-key-update) - when a JWT signing Public / Private keypair used for signing may have been updated
24
24
*[JWT Refresh](/docs/extend/events-and-webhooks/events/jwt-refresh) - when an access token is refreshed using a refresh token
25
25
*[JWT Refresh Token Revoke](/docs/extend/events-and-webhooks/events/jwt-refresh-token-revoke) - when a refresh token (or multiple tokens) are revoked
26
26
*[Kickstart Success](/docs/extend/events-and-webhooks/events/kickstart-success) - when kickstart has successfully completed
Copy file name to clipboardExpand all lines: astro/src/content/docs/extend/events-and-webhooks/signing.mdx
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,11 +28,12 @@ Configuring webhook signatures in FusionAuth consists of generating a key and co
28
28
29
29
Keys are generated or imported from <Breadcrumb>Settings -> Key Master</Breadcrumb>. Webhooks can be signed with three types of keys
30
30
31
-
* EC key - strongest cryptography, public key can be available
31
+
* OKP (EdDSA) key - strongest cryptography, public key can be available
32
+
* EC key - stronger cryptography, public key can be available
32
33
* RSA key - strong cryptography, public key can be available
33
34
* HMAC key - fast cryptography, requires manual key distribution
34
35
35
-
EC and RSA keys allow you to make public keys available through the `/.well-known/jwks.json` endpoint, which facilitates key rotation. If your webhook listener cannot make outbound network connections or you prefer to manually configure your key in your webhook listener, HMAC keys are a good option.
36
+
Asymmetric key types allow you to make public keys available through the `/.well-known/jwks.json` endpoint, which facilitates key rotation. If your webhook listener cannot make outbound network connections or you prefer to manually configure your key in your webhook listener, HMAC keys are a good option.
36
37
37
38
For this example, we'll use an RSA key pair. More information on keys is available in the [Key Master Guide](/docs/operate/secure/key-master).
38
39
@@ -87,7 +88,7 @@ The [Webhook Testing](/docs/extend/events-and-webhooks#test-a-webhook) page prov
87
88
88
89
[Rotating keys](/docs/operate/secure/key-rotation) regularly is an important part of a defense-in-depth strategy. The type of key used for signing webhook events and the method used for fetching that key determines the process for rotating keys.
89
90
90
-
* Signatures validated using a public key (RSA or EC) where signature verification dynamically fetches public key from `.well-known/jwks.json` endpoint
91
+
* Signatures validated using a public key where signature verification dynamically fetches public key from `.well-known/jwks.json` endpoint
0 commit comments