Web/API/PublicKeyCredentialCreationOptions/pubKeyCredParams
Secure contextThis feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The pubKeyCredParams
property of the PublicKeyCredentialCreationOptions
dictionary is an Array
whose elements are objects describing the desired features of the credential to be created. These objects define the type of public-key and the algorithm used for cryptographic signature operations.
If this array contains multiple elements, they are sorted by descending order of preference.
Syntax
pubKeyCredParams = publicKeyCredentialCreationOptions.pubKeyCredParams
Value
An Array
whose elements are objects with the following properties:
type
- A string describing type of public-key credential to be created. As of this writing (March 2019), only
"public-key"
may be used. alg
- A numeric identifier for the algorithm to be used to generate the key pair. The links between identifier and algorithms are defined in this IANA registry (e.g.
-7
indicates the elliptic curve algorithm ECDSA with SHA-256).
Though those elements are sorted by preference (the first element being the most prefered), it is up to the client to choose among those elements for building the credential.
Examples
var publicKey = {
pubKeyCredParams: [
// We would like an elliptic curve to be used if possible
{
type: "public-key",
alg: -7
},
// If not, then we will fallback on an RSA algorithm
{
type: "public-key",
alg: -37
}
],
challenge: new Uint8Array(26) /* this actually is given from the server */,
rp: {
name: "Example CORP",
id : "login.example.com"
},
user: {
id: new Uint8Array(26), /* To be changed for each user */
name: "[email protected]",
displayName: "John Doe",
}
};
navigator.credentials.create({ publicKey })
.then(function (newCredentialInfo) {
// send attestation response and client extensions
// to the server to proceed with the registration
// of the credential
}).catch(function (err) {
console.error(err);
});
Specifications
Specification | Status | Comment |
---|---|---|
Web Authentication: An API for accessing Public Key Credentials Level 1The definition of 'pubKeyCredParams' in that specification. | Recommendation | Initial definition. |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Chrome
Full support 67 |
Edge
Full support ≤79 |
Firefox
Full support 60 |
IE
No support No |
Opera
Full support 54 |
Safari
Full support 13 |
WebView Android
No support No |
Chrome Android
Full support 67 |
Firefox Android
? |
Opera Android
Full support 48 |
Safari iOS
Full support 13.3 |
Samsung Internet Android
No support No |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.'
- Experimental. Expect behavior to change in the future.
See also
- The IANA COSE Algorithms registry which describes the cryptographic algorithms and their corresponding identifier (used as the
"alg"
key here)
PublicKeyCredentialCreationOptions.pubKeyCredParams by Mozilla Contributors is licensed under CC-BY-SA 2.5.