Skip to content

feat: Document the support of HMAC SHA-256 JWT signing algorithm #526

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcelomendoncasoares merged 2 commits into from
Jun 3, 2026
+12 −4
Merged

feat: Document the support of HMAC SHA-256 JWT signing algorithm #526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3951155
feat: Document the support of HMAC SHA-256 JWT signing algorithm
marcelomendoncasoares May 19, 2026
2ba2cee
fix: Fix missing references for the HMAC SHA-256
marcelomendoncasoares Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/06-concepts/11-authentication/01-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ void run(List<String> args) async {
JwtConfig(
// Pepper used to hash the refresh token secret.
refreshTokenHashPepper: pod.getPassword('jwtRefreshTokenHashPepper')!,
// Algorithm used to sign the tokens (`hmacSha512` or `ecdsaSha512`).
// Algorithm used to sign the tokens (`hmacSha512`, `hmacSha256` or `ecdsaSha512`).
algorithm: JwtAlgorithm.hmacSha512(
// Private key to sign the tokens. Must be a valid HMAC SHA-512 key.
SecretKey(pod.getPassword('jwtHmacSha512PrivateKey')!),
Expand Down
14 changes: 11 additions & 3 deletions docs/06-concepts/11-authentication/05-token-managers/02-jwt-token-manager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,12 @@ Finally, run `serverpod generate` to generate the client code and expose the end

### Basic configuration options

- `algorithm`: Required. The algorithm to use for signing tokens (HMAC SHA-512 or ECDSA SHA-512).
- `algorithm`: Required. The algorithm to use for signing tokens (HMAC SHA-512, HMAC SHA-256 or ECDSA SHA-512).
- `refreshTokenHashPepper`: Required. A secret pepper for hashing refresh tokens. Must be at least 10 characters long, but [the recommended length is 32 bytes](https://www.ietf.org/archive/id/draft-ietf-kitten-password-storage-04.html#name-storage-2).

#### Token Algorithms

There are two supported token algorithms:
There are three supported token algorithms:

- **HMAC SHA-512**: Use HMAC SHA-512 for symmetric key signing.

Expand All @@ -67,6 +67,14 @@ There are two supported token algorithms:
),
```

- **HMAC SHA-256**: Use HMAC SHA-256 for symmetric key signing.

```dart
algorithm: JwtAlgorithm.hmacSha256(
SecretKey(pod.getPassword('authenticationTokenPrivateKey')!),
),
```

- **ECDSA SHA-512**: Use ECDSA SHA-512 for asymmetric key signing.

```dart
Expand All @@ -76,7 +84,7 @@ There are two supported token algorithms:
),
```

As of now, the `JwtConfigFromPasswords` only supports HMAC SHA-512. To use ECDSA SHA-512, you need to pass the private and public keys manually.
As of now, the `JwtConfigFromPasswords` only supports HMAC SHA-512 and HMAC SHA-256. To use ECDSA SHA-512, you need to pass the private and public keys manually.

### Extra configuration options

Expand Down
Loading