Skip to content

Commit 7077c80

Browse files
committed
tweak labels text, make origin examples actual origins
1 parent 143eab1 commit 7077c80

File tree

1 file changed

+56
-56
lines changed
  • content/docs/advanced/related-origins

1 file changed

+56
-56
lines changed

content/docs/advanced/related-origins/index.md

Lines changed: 56 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Related Origin Requests (RoR) works by allowing a Relying Party (RP) to provide
3636

3737
During a WebAuthn ceremony, if the RP ID and origin do not match, the WebAuthn client can query the RP for a list of valid origins. The client processes that origin list and then re-evaluates the binding based on this additional context. If an origin is matched, the client will continue with the request in the context of the RP ID.
3838

39-
Labels are the portion of a domain name to the left of the [effective top level domain](https://developer.mozilla.org/en-US/docs/Glossary/eTLD). For instance, `shopping` is the label for `shopping.com`, `shopping.co.uk`, `shopping.co.jp`, `shopping.net`, and `shopping.org`. Labels are used as a way to support the large number of entries required to support [ccTLDs](#cctld), while enabling clients to restrict the number of unique origins to prevent abuse.
39+
A label, in the context of this feature, is the name directly preceding the [effective top level domain](https://developer.mozilla.org/en-US/docs/Glossary/eTLD). For instance, `shopping` is the label for `https://shopping.com`, `https://shopping.co.uk`, `https://shopping.co.jp`, `https://shopping.net`, and `https://shopping.org`. Labels are used as a way to support the large number of entries required to support [ccTLDs](#cctld), while enabling clients to restrict the number of unique origins to prevent abuse.
4040

4141
If there are 30 origins in the list, all with the same label, these count as 1 unique label. WebAuthn requires client implementations to support at least 5 unique labels, however there are no known clients which support more than 5, so that should be treated as the maximum for deployments.
4242

@@ -50,14 +50,14 @@ Below are three examples of origin lists and their respective label counts.
5050
```json
5151
{
5252
"origins": [
53-
"shopping.com",
54-
"shopping.co.uk",
55-
"shopping.co.jp",
56-
"shopping.ie",
57-
"shopping.ca",
58-
"shopping.net",
59-
"shopping.org",
60-
"shopping.github.io"
53+
"https://shopping.com",
54+
"https://shopping.co.uk",
55+
"https://shopping.co.jp",
56+
"https://shopping.ie",
57+
"https://shopping.ca",
58+
"https://shopping.net",
59+
"https://shopping.org",
60+
"https://shopping.github.io"
6161
]
6262
}
6363
```
@@ -72,21 +72,21 @@ Below are three examples of origin lists and their respective label counts.
7272
```json
7373
{
7474
"origins": [
75-
"shopping.com",
76-
"shopping.co.uk",
77-
"shopping.co.jp",
78-
"shopping.ie",
79-
"shopping.ca",
80-
"myshoppingrewards.com",
81-
"myshoppingrewards.co.uk",
82-
"myshoppingrewards.co.jp",
83-
"myshoppingrewards.ie",
84-
"myshoppingrewards.ca",
85-
"myshoppingtravel.com",
86-
"myshoppingtravel.co.uk",
87-
"myshoppingtravel.co.jp",
88-
"myshoppingtravel.ie",
89-
"myshoppingtravel.ca"
75+
"https://shopping.com",
76+
"https://shopping.co.uk",
77+
"https://shopping.co.jp",
78+
"https://shopping.ie",
79+
"https://shopping.ca",
80+
"https://myshoppingrewards.com",
81+
"https://myshoppingrewards.co.uk",
82+
"https://myshoppingrewards.co.jp",
83+
"https://myshoppingrewards.ie",
84+
"https://myshoppingrewards.ca",
85+
"https://myshoppingtravel.com",
86+
"https://myshoppingtravel.co.uk",
87+
"https://myshoppingtravel.co.jp",
88+
"https://myshoppingtravel.ie",
89+
"https://myshoppingtravel.ca"
9090
]
9191
}
9292
```
@@ -103,26 +103,26 @@ Below are three examples of origin lists and their respective label counts.
103103
```json
104104
{
105105
"origins": [
106-
"shopping.com",
107-
"shopping.co.uk",
108-
"shopping.co.jp",
109-
"shopping.ie",
110-
"shopping.ca",
111-
"myshoppingcard.us",
112-
"myshoppingrewards.com",
113-
"myshoppingrewards.co.uk",
114-
"myshoppingrewards.co.jp",
115-
"myshoppingrewards.ie",
116-
"myshoppingrewards.ca",
117-
"myshoppingcreditcard.co.uk",
118-
"myshoppingcreditcard.co.jp",
119-
"myshoppingcreditcard.ie",
120-
"myshoppingcreditcard.ca",
121-
"myshoppingtravel.com",
122-
"myshoppingtravel.co.uk",
123-
"myshoppingtravel.co.jp",
124-
"myshoppingtravel.ie",
125-
"myshoppingtravel.ca"
106+
"https://shopping.com",
107+
"https://shopping.co.uk",
108+
"https://shopping.co.jp",
109+
"https://shopping.ie",
110+
"https://shopping.ca",
111+
"https://myshoppingcard.us",
112+
"https://myshoppingrewards.com",
113+
"https://myshoppingrewards.co.uk",
114+
"https://myshoppingrewards.co.jp",
115+
"https://myshoppingrewards.ie",
116+
"https://myshoppingrewards.ca",
117+
"https://myshoppingcreditcard.co.uk",
118+
"https://myshoppingcreditcard.co.jp",
119+
"https://myshoppingcreditcard.ie",
120+
"https://myshoppingcreditcard.ca",
121+
"https://myshoppingtravel.com",
122+
"https://myshoppingtravel.co.uk",
123+
"https://myshoppingtravel.co.jp",
124+
"https://myshoppingtravel.ie",
125+
"https://myshoppingtravel.ca"
126126
]
127127
}
128128
```
@@ -155,14 +155,14 @@ Below is an example for the RP ID `shopping.com`.
155155
```json {title="https://shopping.com/.well-known/webauthn"}
156156
{
157157
"origins": [
158-
"shopping.com",
159-
"myshoppingrewards.com",
160-
"myshoppingcreditcard.com",
161-
"myshoppingtravel.com",
162-
"shopping.co.uk",
163-
"shopping.co.jp",
164-
"shopping.ie",
165-
"shopping.ca"
158+
"https://shopping.com",
159+
"https://myshoppingrewards.com",
160+
"https://myshoppingcreditcard.com",
161+
"https://myshoppingtravel.com",
162+
"https://shopping.co.uk",
163+
"https://shopping.co.jp",
164+
"https://shopping.ie",
165+
"https://shopping.ca"
166166
]
167167
}
168168
```
@@ -206,12 +206,12 @@ This flow assumes the [autofill UI](/docs/reference/terms/#autofill-ui) for pass
206206

207207
In this example, passkeys have previously been rolled out to the following users:
208208

209-
- `shopping.com` users, with an RP ID of `shopping.com`
210-
- `shopping.co.uk` users, with an RP ID or `shopping.co.uk`
209+
- `https://shopping.com` users, with an RP ID of `shopping.com`
210+
- `https://shopping.co.uk` users, with an RP ID or `shopping.co.uk`
211211

212-
A user with a passkey for `shopping.com` navigates to `shopping.com`, clicks into the username field, selects their passkey, performs user verification, and is then signed in!
212+
A user with a passkey for `shopping.com` navigates to `https://shopping.com`, clicks into the username field, selects their passkey, performs user verification, and is then signed in!
213213

214-
A user with a passkey for `shopping.co.uk` has traveled to the US and navigates to `shopping.co.uk`. Based on location data, the user is redirected to `shopping.com`. They click into the username field and do not see any passkey available. They then type their username and click continue. A backend lookup occurs, and WebAuthn is now invoked with an RP ID of `shopping.co.uk` and the user selects their passkey, performs user verification, and is signed in!
214+
A user with a passkey for `shopping.co.uk` has traveled to the US and navigates to `https://shopping.co.uk`. Based on location data, the user is redirected to `https://shopping.com`. They click into the username field and do not see any passkey available. They then type their username and click continue. A backend lookup occurs, and WebAuthn is now invoked with an RP ID of `shopping.co.uk` and the user selects their passkey, performs user verification, and is signed in!
215215

216216
## Additional Information
217217

0 commit comments

Comments
 (0)