The static RTCPeerConnection.generateCertificate()
function creates an X.509 certificate and corresponding private key, returning a promise that resolves with the new RTCCertificate
once it's generated.
The static RTCPeerConnection.generateCertificate()
function creates an X.509 certificate and corresponding private key, returning a promise that resolves with the new RTCCertificate
once it's generated.
js
RTCPeerConnection.generateCertificate(keygenAlgorithm)
keygenAlgorithm
A Web Crypto API AlgorithmIdentifier
string or an Algorithm
-subclassed object specifying an algorithm to use when creating the certificate's key.
Note: RTCPeerConnection.generateCertificate()
is a static method, so it is always called on the RTCPeerConnection
interface itself, not an instance thereof.
A promise which resolves to a new RTCCertificate
object containing a new key based on the specified options.
NotSupportedError
DOMException
Thrown if the normalized form of keygenAlgorithm
specifies an algorithm or algorithm settings that the browser doesn't support, or which it does not allow for use with an RTCPeerConnection
.
Other errors may occur; for example, if the specified keygenAlgorithm
can't be successfully converted into an RTCCertificateExpiration
dictionary, the error that occurs during that conversion will be thrown.
If a string is specified, it must be a Web Crypto API-compatible algorithm name string. Alternatively, you can provide specific details for the algorithm's configuration by providing an object based on one of the Web Crypto API's Algorithm
class's subclasses.
All browsers are required to support the following two configurations. It's entirely possible that a browser's default settings may be different, but these are always supported.
js
let stdRSACertificate = { name: "RSASSA-PKCS1-v1_5", modulusLength: 2048, publicExponent: new Uint8Array([1, 0, 1]), hash: "SHA-256", };
js
let stdECDSACertificate = { name: "ECDSA", namedCurve: "P-256", };
By default the new certificate is configured with expires
set to a value of 2592000000 milliseconds, or 30 days. The expiration time cannot exceed 31536000000 milliseconds, or 365 days. It's also useful to note that browsers may further restrict the expiration time of certificates if they choose.
This example requests a new RSASSA-PKCS1-v1_5 certificate using a SHA-256 hash and a modulus length of 2048.
js
RTCPeerConnection.generateCertificate({ name: "RSASSA-PKCS1-v1_5", hash: "SHA-256", modulusLength: 2048, publicExponent: new Uint8Array([1, 0, 1]), }).then((cert) => { const pc = new RTCPeerConnection({ certificates: [cert] }); });
The example below specifies a string requesting an ECDSA certificate.
js
RTCPeerConnection.generateCertificate("ECDSA");
Specification |
---|
WebRTC: Real-Time Communication in Browsers # dom-rtcpeerconnection-generatecertificate |
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
generateCertificate_static |
48 | 79 | 22 | No | 35 | 12.1 | 48 | 48 | 24 | 35 | 12.2 | 6.0 |
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/generateCertificate_static