Skip to content

Commit 1027d7e

Browse files
committed
Add another breaking change to v13.0.0 CHANGELOG
1 parent 5dc6bfc commit 1027d7e

File tree

1 file changed

+43
-2
lines changed

1 file changed

+43
-2
lines changed

CHANGELOG.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,10 @@ on for more information, including refactor advice for dealing with the retireme
2626

2727
### Breaking Changes
2828

29-
**@typescript/types is being retired.** Its types will now be included directly in
30-
**@simplewebauthn/browser** and **@simplewebauthn/server**.
29+
#### @typescript/types is being retired
30+
31+
Its types will now be included directly in **@simplewebauthn/browser** and
32+
**@simplewebauthn/server**.
3133

3234
To refactor existing imports from **/types**, simply import them from **/browser** or **/server**
3335
instead:
@@ -52,6 +54,45 @@ import type {
5254
} from '@simplewebauthn/server'; // <--
5355
```
5456

57+
---
58+
59+
#### [server] `attestationType` no longer accepts `'indirect'`
60+
61+
The benefits of indirect attestation are too minimal to be useful for Relying Parties. In practice
62+
it is almost never used over ignoring the concept completely with `'none'` or needing to be
63+
intentional and setting `'direct'`.
64+
65+
RP's that have been specifying `attestationType: 'indirect'` when calling
66+
`generateRegistrationOptions()` will need to refactor their code to either **omit**
67+
`attestationType` (`generateRegistrationOptions()` will default to `attestationType: 'none'`) or set
68+
`attestationType: 'direct'` instead:
69+
70+
**Before:**
71+
72+
```ts
73+
const options = await generateRegistrationOptions({
74+
// ...
75+
attestationType: 'indirect',
76+
});
77+
```
78+
79+
**After:**
80+
81+
```ts
82+
const options = await generateRegistrationOptions({
83+
// ...
84+
});
85+
```
86+
87+
-or-
88+
89+
```ts
90+
const options = await generateRegistrationOptions({
91+
// ...
92+
attestationType: 'direct',
93+
});
94+
```
95+
5596
## v12.0.0 - The one that claims a JSR scope
5697

5798
All SimpleWebAuthn packages are now available for installation from the

0 commit comments

Comments
 (0)