Skip to content
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

Jump to bottom

Fix encoding and syntax highlighting of example code #2175

Merged
merged 2 commits into from
Oct 9, 2024
Merged

Fix encoding and syntax highlighting of example code #2175

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41c514f
Consistently use <xmp> instead of <pre> for code examples
emlun Oct 2, 2024
ef54852
Fix syntax highlighting tags
emlun Oct 2, 2024
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
44 changes: 22 additions & 22 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -536,7 +536,7 @@ In this flow, the [=[WRP]=] does not have a preference for [=platform authentica

The sample code for generating and registering a new key follows:

<pre class="example" highlight="js">
<xmp class="example" highlight="js">
if (!window.PublicKeyCredential) { /* Client not capable. Handle error. */ }

var publicKey = {
Expand Down Expand Up @@ -591,7 +591,7 @@ The sample code for generating and registering a new key follows:
}).catch(function (err) {
// No acceptable authenticator or user refused consent. Handle appropriately.
});
</pre>
</xmp>

### Registration Specifically with User-Verifying Platform Authenticator ### {#sctn-sample-registration-with-platform-authenticator}

Expand All @@ -613,7 +613,7 @@ a [=user-verifying platform authenticator=].

1. Upon successful credential creation, the [=[RP]=] script conveys the new credential to the server.

<pre class="example" highlight="js">
<xmp class="example" highlight="js">
if (!window.PublicKeyCredential) { /* Client not capable of the API. Handle error. */ }

PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable()
Expand All @@ -637,7 +637,7 @@ a [=user-verifying platform authenticator=].
}).catch(function (err) {
// Something went wrong. Handle appropriately.
});
</pre>
</xmp>

### Authentication ### {#sctn-sample-authentication}

Expand Down Expand Up @@ -679,7 +679,7 @@ credential.
If the [=[RP]=] script does not have any hints available (e.g., from locally stored data) to help it narrow the list of
credentials, then the sample code for performing such an authentication might look like this:

<pre class="example" highlight="js">
<xmp class="example" highlight="js">
if (!window.PublicKeyCredential) { /* Client not capable. Handle error. */ }

// credentialId is generated by the authenticator and is an opaque random byte array
Expand All @@ -697,12 +697,12 @@ credentials, then the sample code for performing such an authentication might lo
}).catch(function (err) {
// No acceptable credential or user refused consent. Handle appropriately.
});
</pre>
</xmp>

On the other hand, if the [=[RP]=] script has some hints to help it narrow the list of credentials, then the sample code for
performing such an authentication might look like the following. Note that this sample also demonstrates how to use the [=credProps|Credential Properties Extension=].

<pre class="example" highlight="js">
<xmp class="example" highlight="js">
if (!window.PublicKeyCredential) { /* Client not capable. Handle error. */ }

var encoder = new TextEncoder();
Expand All @@ -729,14 +729,14 @@ performing such an authentication might look like the following. Note that this
}).catch(function (err) {
// No acceptable credential or user refused consent. Handle appropriately.
});
</pre>
</xmp>

### Aborting Authentication Operations ### {#sctn-sample-aborting}

The below example shows how a developer may use the AbortSignal parameter to abort a
credential registration operation. A similar procedure applies to an authentication operation.

<pre class="example" highlight="js">
<xmp class="example" highlight="js">
const authAbortController = new AbortController();
const authAbortSignal = authAbortController.signal;

Expand Down Expand Up @@ -764,7 +764,7 @@ credential registration operation. A similar procedure applies to an authenticat
if (widget == "disappear") {
authAbortController.abort();
}
</pre>
</xmp>


### Decommissioning ### {#sctn-sample-decommissioning}
Expand Down Expand Up @@ -5669,7 +5669,7 @@ Below is an example of a COSE_Key-encoded Elliptic Curve public key in EC2 forma
on the P-256 curve, to be used with the ES256 signature
algorithm (ECDSA w/ SHA-256, see [=Section 2.1=] of [[!RFC9053]]):

<pre class="example" highlight="json">
<xmp class="example" highlight="cddl">
{
1: 2, ; kty: EC2 key type
3: -7, ; alg: ES256 signature algorithm
Expand All @@ -5679,12 +5679,12 @@ algorithm (ECDSA w/ SHA-256, see [=Section 2.1=] of [[!RFC9053]]):
-3: y ; y-coordinate as byte string 32 bytes in length
; e.g., in hex: 1e52ed75701163f7f9e40ddf9f341b3dc9ba860af7e0ca7ca7e9eecd0084d19c
}
</pre>
</xmp>

Below is the above Elliptic Curve public key encoded in the [=CTAP2 canonical CBOR encoding form=], whitespace and line breaks
are included here for clarity and to match the CDDL [[!RFC8610]] presentation above:

<pre class="example" highlight="json">
<xmp class="example">
A5
01 02

Expand All @@ -5695,14 +5695,14 @@ are included here for clarity and to match the CDDL [[!RFC8610]] presentation ab
21 58 20 65eda5a12577c2bae829437fe338701a10aaa375e1bb5b5de108de439c08551d

22 58 20 1e52ed75701163f7f9e40ddf9f341b3dc9ba860af7e0ca7ca7e9eecd0084d19c
</pre>
</xmp>


Below is an example of a COSE_Key-encoded 2048-bit RSA public key (see [[RFC8230]] [=Section 4=],
to be used with the PS256 signature algorithm
(RSASSA-PSS with SHA-256, see [=RFC8230/Section 2=] of [[RFC8230]]:

<pre class="example" highlight="json">
<xmp class="example" highlight="cddl">
{
1: 3, ; kty: RSA key type
3: -37, ; alg: PS256
Expand All @@ -5711,12 +5711,12 @@ to be used with the PS256 signature algorithm
-2: e ; e: RSA public exponent e byte string 3 bytes in length
; e.g., in hex: 010001
}
</pre>
</xmp>

Below is an example of the same COSE_Key-encoded RSA public key as above,
to be used with the RS256 signature algorithm (RSASSA-PKCS1-v1_5 with SHA-256):

<pre class="example" highlight="json">
<xmp class="example" highlight="cddl">
{
1: 3, ; kty: RSA key type
3:-257, ; alg: RS256
Expand All @@ -5725,7 +5725,7 @@ to be used with the RS256 signature algorithm (RSASSA-PKCS1-v1_5 with SHA-256):
-2: e ; e: RSA public exponent e byte string 3 bytes in length
; e.g., in hex: 010001
}
</pre>
</xmp>


### Attestation Statement Formats ### {#sctn-attestation-formats}
Expand Down Expand Up @@ -7040,7 +7040,7 @@ Note: Other documents have specified extensions where the extension input does n
as the entry key.
New extensions SHOULD follow the above convention.

<pre class="example" highlight="js">
<xmp class="example" highlight="js">
var assertionPromise = navigator.credentials.get({
publicKey: {
// Other members omitted for brevity
Expand All @@ -7054,7 +7054,7 @@ New extensions SHOULD follow the above convention.
}
}
});
</pre>
</xmp>

Extension definitions MUST specify the valid values for their [=client extension input=]. Clients SHOULD ignore extensions with
an invalid [=client extension input=]. If an extension does not require any parameters from the [=[RP]=], it SHOULD be defined
Expand All @@ -7077,14 +7077,14 @@ The following example defines that an extension with [=extension identifier|iden
takes an unsigned integer as [=authenticator extension input=],
and returns an array of at least one byte string as [=authenticator extension output=]:

<pre class="example">
<xmp class="example" highlight="cddl">
$$extensionInput //= (
webauthnExample_foobar: uint
)
$$extensionOutput //= (
webauthnExample_foobar: [+ bytes]
)
</pre>
</xmp>

Note: Extensions should aim to define authenticator arguments that are as small as possible. Some authenticators communicate
over low-bandwidth links such as Bluetooth Low-Energy or NFC.
Expand Down