This specification describes a JavaScript API for performing basic cryptographic operations in web applications, such as hashing, signature generation and verification, and encryption and decryption. Additionally, it describes an API for applications to generate and/or manage the keying material necessary to perform these operations. Uses for this API range from user or service authentication, document or code signing, and the confidentiality and integrity of communications.
Status of This DocumentThis section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C standards and drafts index at https://www.w3.org/TR/.
This document was published by the Web Application Security Working Group as a First Public Working Draft using the Recommendation track.
Publication as a First Public Working Draft does not imply endorsement by W3C and its Members.
This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.
This document was produced by a group operating under the W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.
This document is governed by the 03 November 2023 W3C Process Document.
Table of ContentsThis section is non-normative.
The Web Cryptography API defines a low-level interface to interacting with cryptographic key material that is managed or exposed by user agents. The API itself is agnostic of the underlying implementation of key storage, but provides a common set of interfaces that allow rich web applications to perform operations such as signature generation and verification, hashing and verification, encryption and decryption, without requiring access to the raw keying material.
Cryptographic transformations are exposed via the SubtleCrypto interface, which defines a set of methods for performing common cryptographic operations. In addition to operations such as signature generation and verification, hashing and verification, and encryption and decryption, the API provides interfaces for key generation, key derivation and key import and export.
This section is non-normative.
A web application may wish to extend or replace existing username/password based authentication schemes with authentication methods based on proving that the user has access to some secret keying material. Rather than using transport-layer authentication, such as TLS client certificates, the web application may prefer the richer user experience provided by authenticating within the application itself.
Using the Web Cryptography API, the application could locate suitable client keys, which may have been previously generated via the user agent or pre-provisioned out-of-band by the web application. It could then perform cryptographic operations such as decrypting an authentication challenge followed by signing an authentication response.
This exchange could be further strengthened by binding the authentication to the TLS session over which the client is authenticating, by deriving a key based on properties of the underlying transport.
If a user does not already have a key associated with their account, the web application could direct the user agent to either generate a new key or to re-use an existing key of the user's choice.
A web application may wish to limit the viewership of documents that contain sensitive or personal information, even when these documents have been securely received, such as over TLS.
Using the Web Cryptography API, the application could do so by encrypting the documents with a secret key, and then wrapping that key with the public keys associated with the authorized viewers. When a user agent navigates to such a web application, the application would send the encrypted form of the document. The user agent is then instructed to unwrap the encryption key, using the user's private key, and from there, decrypt and display the document.
A web application may wish to permit users to protect the confidentiality of data and documents stored with remote service providers prior to uploading.
Using the Web Cryptography API, the application may have a user select a private or secret key, optionally derive an encryption key from the selected key, encrypt the document, and then upload the encrypted data to the service provider using existing APIs.
This use case is similar to the Protected Document Exchange use case, with viewership of the document limited to the user themself.
A web application may wish to accept electronic signatures on documents, in lieu of requiring physical signatures.
Using the Web Cryptography API, the application may direct the user to select a key, which may have been pre-provisioned out-of-band, or generated specifically for the web application. Using this key, the application may perform a signing operation over some data, as proof that the user accepts the document.
A web application may wish to cache data locally, while ensuring that this data cannot be modified in an offline attack.
Using the Web Cryptography API, the application may use a public key contained within the application to verify the contents of the data cache. Previously, when data was added to the cache, it would have been signed by the server with the corresponding private key. By validating the signature when restoring data from the cache, the client ensures that the cached data has not been tampered with.
A web application may wish to employ message layer security using schemes such as off-the-record (OTR) messaging, even when these messages have been securely received, such as over TLS.
The Web Cryptography API enables OTR and similar message signing schemes, by allowing key agreement to be performed. The two parties can negotiate shared encryption keys and message authentication code (MAC) keys, to allow encryption and decryption of messages, and to prevent tampering.
A web application may wish to interact with the structures and message formats defined by the IETF JavaScript Object Signing and Encryption (JOSE) Working Group.
Using the Web Cryptography API, the application may read and import keys encoded in the JSON key format (JWK), validate messages that have been integrity protected using digital signatures or MACs (JWS), or decrypt messages that have been encrypted (JWE).
As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.
The key words MUST, REQUIRED, and SHALL in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
The following conformance classes are defined by this specification:
A user agent is considered to be a conforming user agent if it satisfies all of the MUST-, REQUIRED- and SHALL-level criteria in this specification that apply to implementations. This specification uses both the terms "conforming user agent" and "user agent" to refer to this product class.
Conformance requirements phrased as algorithms or specific steps may be implemented in any manner, so long as the end result is equivalent. (In particular, the algorithms defined in this specification are intended to be easy to follow, and not intended to be performant.)
User agents that use ECMAScript to implement the APIs defined in this specification MUST implement them in a manner consistent with the ECMAScript Bindings defined in the Web IDL specification [WebIDL] as this specification uses that specification and terminology.
Unless otherwise stated, string comparisons are done in a case-sensitive manner. String literals in this specification written in monospace font like "this" do not include the enclosing quotes.
Vendor-specific proprietary extensions to this specification are strongly discouraged. Authors must not use such extensions, as doing so reduces interoperability and fragments the user base, allowing only users of specific user agents to access the content in question.
If vendor-specific extensions are needed, the members should be prefixed by vendor-specific strings to prevent clashes with future versions of this specification. Extensions must be defined so that the use of extensions neither contradicts nor causes the non-conformance of functionality defined in the specification.
When vendor-neutral extensions to this specification are needed, either this specification can be updated accordingly, or an extension specification can be written that overrides the requirements in this specification. When someone applying this specification to their activities decides that they will recognize the requirements of such an extension specification, it becomes an applicable specification for the purposes of conformance requirements in this specification. Applicable specifications defined by the W3C Web Cryptography Working Group are listed in the table below.
Note
Readers are advised to consult the errata to this specification for updates to the table above.
This section is non-normative.
The specification attempts to focus on the common functionality and features between various platform-specific or standardized cryptographic APIs, and avoid features and functionality that are specific to one or two implementations. As such this API allows key generation, management, and exchange with a level of abstraction that avoids developers needing to care about the implementation of the underlying key storage. The API is focused specifically around CryptoKey objects, as an abstraction for the underlying raw cryptographic keying material. The intent behind this is to allow an API that is generic enough to allow conforming user agents to expose keys that are stored and managed directly by the user agent, that may be stored or managed using isolated storage APIs such as per-user key stores provided by some operating systems, or within key storage devices such as secure elements, while allowing rich web applications to manipulate the keys and without requiring the web application be aware of the nature of the underlying key storage.
Because the underlying cryptographic implementations will vary between conforming user agents, and may be subject to local policy, including but not limited to concerns such as government or industry regulation, security best practices, intellectual property concerns, and constrained operational environments, this specification does not dictate a mandatory set of algorithms that MUST be implemented. Instead, it defines a common set of bindings that can be used in an algorithm-independent manner, a common framework for discovering if a user agent or key handle supports the underlying algorithm, and a set of conformance requirements for the behaviors of individual algorithms, if implemented.
This API, while allowing applications to generate, retrieve, and manipulate keying material, does not specifically address the provisioning of keys in particular types of key storage, such as secure elements or smart cards. This is due to such provisioning operations often being burdened with vendor-specific details that make defining a vendor-agnostic interface an unsuitably unbounded task. Additionally, this API does not deal with or address the discovery of cryptographic modules, as such concepts are dependent upon the underlying user agent and are not concepts that are portable between common operating systems, cryptographic libraries, and implementations.
This section is non-normative.
This specification assumes, but does not require, that conforming user agents do not and will not be directly implementing cryptographic operations within the user agent itself. Historically, many user agents have deferred cryptographic operations, such as those used within TLS, to existing APIs that are available as part of the underlying operating system or to third-party modules that are managed independently of the user agent.
The CryptoKey object represents the bridge between the JavaScript execution environment and these underlying libraries, through the use of the internal slot named [[handle]]. The handle represents an opaque type that is implementation specific, which may not be represented within a JavaScript type, nor is it ever exposed to script authors. In this way, the CryptoKey object is the conceptual equivalent to the JavaScript executing environment as the [[handle]] is to the underlying cryptographic implementation.
These APIs are traditionally built around a notion of cryptographic providers, an abstraction for a specific implementation of a set of algorithms. The operating system or library may come with a default provider, and users are frequently allowed to add additional providers, reconfigure the set of enabled algorithms, or otherwise customize how cryptographic services are provided.
While it is assumed that most user agents will be interacting with a cryptographic provider that is implemented purely in software, it is not required by this specification. As a result, the capabilities of some implementations may be limited by the capabilities of the underlying hardware, and, depending on how the user has configured the underlying cryptographic library, this may be entirely opaque to the User Agent.
This specification does not explicitly provide any new storage mechanisms for CryptoKey objects. Instead, by defining serialization and deserialization steps for CryptoKey objects, any existing or future web storage mechanisms that support storing serializable objects can be used to store CryptoKey objects.
In practice, it is expected that most authors will make use of the Indexed Database API [INDEXEDDB], which allows associative storage of key/value pairs, where the key is some string identifier meaningful to the application, and the value is a CryptoKey object. This allows the storage and retrieval of key material, without ever exposing that key material to the application or the JavaScript environment. Additionally, this allows authors the full flexibility to store any additional metadata with the CryptoKey itself.
This section is non-normative.
By not providing an explicit storage mechanism, this specification assumes that CryptoKey objects are scoped to the current execution environment and any storage mechanisms available to that environment (e.g. Indexed Database API). Application authors rely upon this for the security of their applications; two origins with the same CryptoKey object have full access to the underlying key, and as such, messages from these applications cannot be distinguished, and messages sent to these applications can be fully recovered. Implementors should ensure that no CryptoKey objects are shared between two origins unless the author has explicitly chosen to share (e.g., such as through the use of postMessage)
A number of algorithms specified within this specification perform computationally intensive work, such as the generation of significantly large prime numbers, or through repeated iterations of a particular operation. As such, hostile applications may attempt to misuse this API and attempt to cause significant amount of work to be performed by an implementation, denying access or services to other applications that are executing. Implementations should take steps to mitigate these risks, such as limiting the amount of operations an implementation performs concurrently, requiring user consent for operations that may be known to be disruptive for the executing environment, or defining device-specific limits on attributes such as key sizes or iteration counts.
This specification includes descriptions for a variety of cryptographic operations, some of which have known weaknesses when used inappropriately. Application developers must take care and review appropriate and current cryptographic literature, to understand and mitigate such issues. In general, application developers are strongly discouraged from inventing new cryptographic protocols; as with all applications, users of this specification will be best served through the use of existing protocols, of which this specification provides the necessary building blocks to implement.
In order to use the APIs defined in this specification to provide any meaningful cryptographic assurances, authors must be familiar with existing threats to web applications, as well as the underlying security model employed. Conceptually, issues such as script injection are the equivalent to remote code execution in other operating environments, and allowing hostile script to be injected may allow for the exfiltration of keys or data. Script injection may come from other applications, for which the judicious use of Content Security Policy may mitigate, or it may come from hostile network intermediaries, for which the use of Transport Layer Security may mitigate.
This specification does not define any specific mechanisms for the storage of cryptographic keys. By default, unless specific effort is taken by the author to persist keys, such as through the use of the Indexed Database API, keys created with this API will only be valid for the duration of the current page (e.g. until a navigation event). Authors that wish to use the same key across different pages or multiple browsing sessions must employ existing web storage technologies. Authors should be aware of the security assumptions of these technologies, such as the same-origin security model; that is, any application that shares the same scheme, host, and port have access to the same storage partition, even if other information, such as the path, may differ. Authors may explicitly choose to relax this security through the use of inter-origin sharing, such as postMessage.
Authors should be aware that this specification places no normative requirements on implementations as to how the underlying cryptographic key material is stored. The only requirement is that key material is not exposed to script, except through the use of the exportKey and wrapKey operations. In particular, it does not guarantee that the underlying cryptographic key material will not be persisted to disk, possibly unencrypted, nor that it will be inaccessible to users or other applications running with the same privileges as the User Agent. Any application or user that has access to the device storage may be able to recover the key material, even through scripts may be prohibited.
This specification places no normative requirements on how implementations handle key material once all references to it go away. That is, conforming user agents are not required to zeroize key material, and it may still be accessible on device storage or device memory, even after all references to the CryptoKey have gone away.
Applications may share a CryptoKey object across security boundaries, such as origins, through the use of the structured clone algorithm and APIs such as postMessage. While access to the underlying cryptographic key material may be restricted, based upon the extractable attribute, once a key is shared with a destination origin, the source origin can not later restrict or revoke access to the key. As such, authors must be careful to ensure they trust the destination origin to take the same mitigations against hostile script that the source origin employs. Further, in the event of script injection on the source origin, attackers may post the key to an origin under attacker control. Any time that the user agent visits the attacker's origin, the user agent may be directed to perform cryptographic operations using that key, such as the decryption of existing messages or the creation of new, fraudulent messages.
Authors should be aware that users may, at any time, choose to clear the storage associated with an origin, potentially destroying keys. Applications that are meant to provide long-term storage, such as on the server, should consider techniques such as key escrow to prevent such data from being inaccessible. Authors should not presume that keys will be available indefinitely.
Users of applications that employ the APIs defined in this specification should be aware that these applications will have full access to all messages exchanged, regardless of the cryptography employed. That is, for messages that are encrypted, applications that use these APIs will have full access to the decrypted message as well.
This section is non-normative.
randomUUID as user ID
randomUUID is useful for generating user IDs, but does not directly give any ability to generate global identifiers.
This specification relies on underlying specifications.
A conforming user agent MUST support at least the subset of the functionality defined in DOM that this specification relies upon; in particular, it MUST support Promises and DOMException. [DOM]
A conforming user agent MUST support at least the subset of the functionality defined in HTML that this specification relies upon; in particular, it MUST support the ArrayBufferView typedef and serializable objects. [HTML]
A conforming user agent MUST be a conforming implementation of the IDL fragments in this specification, as described in the Web IDL specification. [WebIDL]
The terms ArrayBuffer, ArrayBufferView, and serializable objects, are defined by the HTML specification [HTML].
The terms DOMString and BufferSource are defined in [WEBIDL].
The term byte sequence is defined in [Infra].
The length in bits of a byte sequence is its length multiplied by 8.
A byte sequence containing a bit sequence b is the byte sequence obtained by first appending zero or more bits of value zero to b such that the length of the resulting bit sequence is minimal and an integer multiple of 8 and then considering each consecutive sequence of 8 bits in that string as a byte.
When this specification says to convert a non-negative integer i to a byte sequence of length n, where n * 8 is greater than the logarithm to base 2 of i, the user agent must first calculate the binary representation of i, most significant bit first, prefix this with sufficient zero bits to form a bit sequence of length n * 8, and then return the byte sequence formed by considering each consecutive sequence of 8 bits in that bit sequence as a byte.
Comparing two strings in a case-sensitive manner means comparing them exactly, code point for code point.
Comparing two strings in a ASCII case-insensitive manner means comparing them exactly, code point for code point, except that the codepoints in the range U+0041 .. U+005A (i.e. LATIN CAPITAL LETTER A to LATIN CAPITAL LETTER Z) and the corresponding codepoints in the range U+0061 .. U+007A (i.e. LATIN SMALL LETTER A to LATIN SMALL LETTER Z) are also considered to match.
When this specification says to terminate the algorithm, the user agent must terminate the algorithm after finishing the step it is on. The algorithm referred to is the set of specification-defined processing steps, rather than the underlying cryptographic algorithm that may be in the midst of processing.
When this specification says to parse an ASN.1 structure, the user agent must perform the following steps:
Let data be a sequence of bytes to be parsed.
Let structure be the ASN.1 structure to be parsed.
Let exactData be an optional boolean value. If it is not supplied, let it be initialized to true.
Parse data according to the Distinguished Encoding Rules of [X690], using structure as the ASN.1 structure to be decoded.
If exactData was specified, and all of the bytes of data were not consumed during the parsing phase, then throw a DataError.
Return the parsed ASN.1 structure.
When this specification says to parse a subjectPublicKeyInfo, the user agent must parse an ASN.1 structure, with data set to the sequence of bytes to be parsed, structure as the ASN.1 structure of subjectPublicKeyInfo, as specified in [RFC5280], and exactData set to true.
When this specification says to parse a PrivateKeyInfo, the user agent must parse an ASN.1 structure with data set to the sequence of bytes to be parsed, structure as the ASN.1 structure of PrivateKeyInfo, as specified in [RFC5208], and exactData set to true.
When this specification says to parse a JWK, the user agent must run the following steps:
Let data be the sequence of bytes to be parsed.
Let json be the Unicode string that results from interpreting data according to UTF-8.
Convert json to UTF-16.
Let result be the object literal that results from executing the JSON.parse internal function in the context of a new global object, with text argument set to a JavaScript String containing json.
Let key be the result of converting result to the IDL dictionary type of JsonWebKey.
If the kty field of key is not defined, then throw a DataError.
Return key.
When this specification says to calculate the usage intersection of two sequences, a and b the result shall be a sequence containing each recognized key usage value that appears in both a and b, in the order listed in the list of recognized key usage values, where a value is said to appear in a sequence if an element of the sequence exists that is a case-sensitive string match for that value.
When this specification says to calculate the normalized value of a usages list, usages the result shall be the usage intersection of usages and a sequence containing all recognized key usage values.
When this specification refers to the cached ECMAScript object associated with an internal slot [[slot]] of object, the user agent must run the following steps:
The Crypto interface represents an interface to general purpose cryptographic functionality including a cryptographically strong pseudo-random number generator seeded with truly random values.
partial interface mixin WindowOrWorkerGlobalScope {
[SameObject] readonly attribute Crypto crypto;
};
[Exposed=(Window,Worker)]
interface Crypto {
[SecureContext] readonly attribute SubtleCrypto subtle;
ArrayBufferView getRandomValues(ArrayBufferView array);
[SecureContext] DOMString randomUUID();
};Note
Implementations should generate cryptographically strong random values using well-established cryptographic pseudo-random number generators seeded with high-quality entropy, such as from an operating-system entropy source (e.g., "/dev/urandom"). This specification provides no lower-bound on the information theoretic entropy present in cryptographically strong random values, but implementations should make a best effort to provide as much entropy as practicable.
Note
This interface defines a synchronous method for obtaining cryptographically strong random values. While some devices and implementations may support truly random cryptographic number generators or provide interfaces that block when there is insufficient entropy, implementations are discouraged from using these sources when implementing getRandomValues, both for performance and to avoid depleting the system of entropy. Instead, these sources should be used to seed a cryptographic pseudo-random number generator that can then return suitable values efficiently.
The getRandomValues method generates cryptographically strong random values. It must act as follows:
If array is not an Int8Array, Uint8Array, Uint8ClampedArray, Int16Array, Uint16Array, Int32Array, Uint32Array, BigInt64Array, or BigUint64Array, then throw a TypeMismatchError and terminate the algorithm.
Let byteLength be the byte length of array.
If byteLength is greater than 65536, throw a QuotaExceededError and terminate the algorithm.
Let bytes be a byte sequence of length byteLength.
Fill bytes with cryptographically secure random bytes.
Write bytes into array.
Return array.
Note
Do not generate keys using the getRandomValues method. Use the generateKey method instead.
The randomUUID method generates a new version 4 UUID and returns its namespace specific string representation as described in section 3 of [RFC4122]. To generate a random UUID:
0100.10.Return the string concatenation of «
-",-",-",-",».
For the steps described in the algorithm to generate a random UUID, the hexadecimal representation of a byte value is the two-character string created by expressing value in hexadecimal using ASCII lower hex digits, left-padded with "0" to reach two ASCII lower hex digits.
The subtle attribute provides an instance of the SubtleCrypto interface which provides low-level cryptographic primitives and algorithms.
The Algorithm object is a dictionary object [WEBIDL] which is used to specify an algorithm and any additional parameters required to fully specify the desired operation.
typedef (object or DOMString) AlgorithmIdentifier;
typedef AlgorithmIdentifier HashAlgorithmIdentifier;
dictionary Algorithm {
required DOMString name;
};name
The KeyAlgorithm dictionary represents information about the contents of a given CryptoKey object.
dictionary KeyAlgorithm {
required DOMString name;
};This section is non-normative.
The KeyAlgorithm dictionary is provided to aid in documenting how fixed, public properties of a CryptoKey are reflected back to an application. The actual dictionary type is never exposed to applications.
name
CryptoKey
The CryptoKey object represents an opaque reference to keying material that is managed by the user agent.
enum KeyType { "public", "private", "secret" };
enum KeyUsage { "encrypt", "decrypt", "sign", "verify", "deriveKey", "deriveBits", "wrapKey", "unwrapKey" };
[SecureContext,Exposed=(Window,Worker),Serializable]
interface CryptoKey {
readonly attribute KeyType type;
readonly attribute object algorithm;
readonly attribute object usages;
};This section is non-normative.
This specification provides a uniform interface for many different kinds of keying material managed by the user agent. This may include keys that have been generated by the user agent, derived from other keys by the user agent, imported to the user agent through user actions or using this API, pre-provisioned within software or hardware to which the user agent has access or made available to the user agent in other ways. The term key refers broadly to any keying material including actual keys for cryptographic operations and secret values obtained within key derivation or exchange operations.
The CryptoKey object is not required to directly interface with the underlying key storage mechanism, and may instead simply be a reference for the user agent to understand how to obtain the keying material when needed, e.g. when performing a cryptographic operation.
KeyType
public", "private" and "secret". Opaque keying material, including that used for symmetric algorithms, is represented by secret, while keys used as part of asymmetric algorithms composed of public/private keypairs will be either public or private.
KeyUsage
encrypt, decrypt, sign, verify, deriveKey, deriveBits, wrapKey and unwrapKey.
Every CryptoKey object has a set of internal slots that store information about the key. These slots are not exposed as part of this specification; they represent internal state that an implementation uses to implement this specification. The notational convention used in [ECMA-262] is re-used here; internal slots are identified by names enclosed in double square brackets [[ ]].
All CryptoKey objects have internal slots named [[type]], , [[algorithm]], [[algorithm_cached]], [[usages]], [[usages_cached]], and [[handle]].
The contents of the [[algorithm]] internal slot shall be, or be derived from, a KeyAlgorithm. The contents of the [[usages]] internal slot shall be of type Sequence<KeyUsage>.
Note
The [[handle]] slot is an opaque type that contains whatever data the underlying cryptographic implementation uses to represent a logical key. Different cryptographic implementations may use different types, ranging from opaque identifiers represented as integers, pointer types, or structures that provide identifying information. These handles are never exposed to applications.
type
[[type]] internal slot, which contains the type of the underlying key.
[[extractable]] internal slot, which indicates whether or not the raw keying material may be exported by the application.
algorithm
[[algorithm]] internal slot.
usages
[[usages]] internal slot, which indicates which cryptographic operations are permissible to be used with this key.
CryptoKey objects are serializable objects. Their serialization steps, given value and serialized, are:
[[type]] internal slot of value.[[extractable]] internal slot of value.[[algorithm]] internal slot of value.[[usages]] internal slot of value.[[handle]] internal slot of value.Their deserialization steps, given serialized and value, are:
[[type]] internal slot of value to serialized.[[Type]].[[extractable]] internal slot of value to serialized.[[Extractable]].[[algorithm]] internal slot of value to the sub-deserialization of serialized.[[Algorithm]].[[usages]] internal slot of value to the sub-deserialization of serialized.[[Usages]].[[handle]] internal slot of value to serialized.[[Handle]].Note
When deserializing a serialized
CryptoKey
object, it is important that the object is not deserialized as a different type. This is normatively required by the definition of the
deserialization steps, but it merits specific attention, as such deserialization may expose the contents of the key material, which in some cases (such as when the
[[extractable]]
internal slot is false) should not be exposed to applications.
The SubtleCrypto interface provides a set of methods for dealing with low-level cryptographic primitives and algorithms.
enum KeyFormat { "raw", "spki", "pkcs8", "jwk" };
[SecureContext,Exposed=(Window,Worker)]
interface SubtleCrypto {
Promise<ArrayBuffer> encrypt(
AlgorithmIdentifier algorithm,
CryptoKey key,
BufferSource data
);
Promise<ArrayBuffer> decrypt(
AlgorithmIdentifier algorithm,
CryptoKey key,
BufferSource data
);
Promise<ArrayBuffer> sign(
AlgorithmIdentifier algorithm,
CryptoKey key,
BufferSource data
);
Promise<boolean> verify(
AlgorithmIdentifier algorithm,
CryptoKey key,
BufferSource signature,
BufferSource data
);
Promise<ArrayBuffer> digest(
AlgorithmIdentifier algorithm,
BufferSource data
);
Promise<ArrayBuffer> deriveBits(
AlgorithmIdentifier algorithm,
CryptoKey baseKey,
optional unsigned long? length = null
);
Promise<(ArrayBuffer or JsonWebKey)> exportKey(
KeyFormat format,
CryptoKey key
);
Promise<ArrayBuffer> wrapKey(
KeyFormat format,
CryptoKey key,
CryptoKey wrappingKey,
AlgorithmIdentifier wrapAlgorithm
);
};Note
The SubtleCrypto interface is named "SubtleCrypto" to reflect the fact that many of these algorithms have subtle usage requirements in order to provide the required algorithmic security guarantees.
For example, the direct use of an unauthenticated encryption scheme, such as AES in counter mode, gives potential attackers the ability to manipulate bits in the output by manipulating bits in the input, compromising the integrity of the message. However, AES-CTR can be used securely in combination with other cryptographic primitives, such as message authentication codes, to ensure the integrity of the protected message, but only when the message authentication code is constructed over the encrypted message and IV.
Developers making use of the SubtleCrypto interface are expected to be aware of the security concerns associated with both the design and implementation of the various algorithms provided. The raw algorithms are provided in order to allow developers maximum flexibility in implementing a variety of protocols and applications, each of which may represent the composition and security parameters in a unique manner that necessitate the use of the raw algorithms.
KeyFormat
raw
pkcs8
spki
jwk
JsonWebKey dictionary encoded as a JavaScript object
SubtleCrypto.
Note
This specification makes no specific requirements on the ordering of responses to calls to methods of
SubtleCrypto
, neither between multiple calls, nor between calls and tasks from other
task sources. This task source is merely used to
queue a taskto resolve or reject the relevant promise whenever the cryptographic operation is completed, in order to
prevent race conditions.
Note
All errors are reported asynchronously by rejecting the returned Promise. This includes Web IDL type mapping errors.
The encrypt method returns a new Promise object that will encrypt data using the specified AlgorithmIdentifier with the supplied CryptoKey. It must act as follows:
Let algorithm and key be the algorithm and key parameters passed to the encrypt() method, respectively.
Let data be the result of getting a copy of the bytes held by the data parameter passed to the encrypt() method.
Let normalizedAlgorithm be the result of normalizing an algorithm, with alg set to algorithm and op set to "encrypt".
If an error occurred, return a Promise rejected with normalizedAlgorithm.
Let realm be the relevant realm of this.
Let promise be a new Promise.
Return promise and perform the remaining steps in parallel.
If the following steps or referenced procedures say to throw an error, queue a global task on the crypto task source, given realm's global object, to reject promise with the returned error; and then terminate the algorithm.
If the name member of normalizedAlgorithm is not equal to the name attribute of the [[algorithm]] internal slot of key then throw an InvalidAccessError.
If the [[usages]] internal slot of key does not contain an entry that is "encrypt", then throw an InvalidAccessError.
Let ciphertext be the result of performing the encrypt operation specified by normalizedAlgorithm using algorithm and key and with data as plaintext.
Queue a global task on the crypto task source, given realm's global object, to perform the remaining steps.
Let result be the result of creating an ArrayBuffer in realm, containing ciphertext.
Resolve promise with result.
The decrypt method returns a new Promise object that will decrypt data using the specified AlgorithmIdentifier with the supplied CryptoKey. It must act as follows:
Let algorithm and key be the algorithm and key parameters passed to the decrypt() method, respectively.
Let data be the result of getting a copy of the bytes held by the data parameter passed to the decrypt() method.
Let normalizedAlgorithm be the result of normalizing an algorithm, with alg set to algorithm and op set to "decrypt".
If an error occurred, return a Promise rejected with normalizedAlgorithm.
Let realm be the relevant realm of this.
Let promise be a new Promise.
Return promise and perform the remaining steps in parallel.
If the following steps or referenced procedures say to throw an error, queue a global task on the crypto task source, given realm's global object, to reject promise with the returned error; and then terminate the algorithm.
If the name member of normalizedAlgorithm is not equal to the name attribute of the [[algorithm]] internal slot of key then throw an InvalidAccessError.
If the [[usages]] internal slot of key does not contain an entry that is "decrypt", then throw an InvalidAccessError.
Let plaintext be the result of performing the decrypt operation specified by normalizedAlgorithm using key and algorithm and with data as ciphertext.
Queue a global task on the crypto task source, given realm's global object, to perform the remaining steps.
Let result be the result of creating an ArrayBuffer in realm, containing plaintext.
Resolve promise with result.
The sign method returns a new Promise object that will sign data using the specified AlgorithmIdentifier with the supplied CryptoKey. It must act as follows:
Let algorithm and key be the algorithm and key parameters passed to the sign() method, respectively.
Let data be the result of getting a copy of the bytes held by the data parameter passed to the sign() method.
Let normalizedAlgorithm be the result of normalizing an algorithm, with alg set to algorithm and op set to "sign".
If an error occurred, return a Promise rejected with normalizedAlgorithm.
Let realm be the relevant realm of this.
Let promise be a new Promise.
Return promise and perform the remaining steps in parallel.
If the following steps or referenced procedures say to throw an error, queue a global task on the crypto task source, given realm's global object, to reject promise with the returned error; and then terminate the algorithm.
If the name member of normalizedAlgorithm is not equal to the name attribute of the [[algorithm]] internal slot of key then throw an InvalidAccessError.
If the [[usages]] internal slot of key does not contain an entry that is "sign", then throw an InvalidAccessError.
Let signature be the result of performing the sign operation specified by normalizedAlgorithm using key and algorithm and with data as message.
Queue a global task on the crypto task source, given realm's global object, to perform the remaining steps.
Let result be the result of creating an ArrayBuffer in realm, containing signature.
Resolve promise with result.
The verify method returns a new Promise object that will verify data using the specified AlgorithmIdentifier with the supplied CryptoKey. It must act as follows:
Let algorithm and key be the algorithm and key parameters passed to the verify() method, respectively.
Let signature be the result of getting a copy of the bytes held by the signature parameter passed to the verify() method.
Let data be the result of getting a copy of the bytes held by the data parameter passed to the verify() method.
Let normalizedAlgorithm be the result of normalizing an algorithm, with alg set to algorithm and op set to "verify".
If an error occurred, return a Promise rejected with normalizedAlgorithm.
Let realm be the relevant realm of this.
Let promise be a new Promise.
Return promise and perform the remaining steps in parallel.
If the following steps or referenced procedures say to throw an error, queue a global task on the crypto task source, given realm's global object, to reject promise with the returned error; and then terminate the algorithm.
If the name member of normalizedAlgorithm is not equal to the name attribute of the [[algorithm]] internal slot of key then throw an InvalidAccessError.
If the [[usages]] internal slot of key does not contain an entry that is "verify", then throw an InvalidAccessError.
Let result be the result of performing the verify operation specified by normalizedAlgorithm using key, algorithm and signature and with data as message.
Queue a global task on the crypto task source, given realm's global object, to perform the remaining steps.
Resolve promise with result.
The digest method returns a new Promise object that will digest data using the specified AlgorithmIdentifier. It must act as follows:
Let algorithm be the algorithm parameter passed to the digest() method.
Let data be the result of getting a copy of the bytes held by the data parameter passed to the digest() method.
Let normalizedAlgorithm be the result of normalizing an algorithm, with alg set to algorithm and op set to "digest".
If an error occurred, return a Promise rejected with normalizedAlgorithm.
Let realm be the relevant realm of this.
Let promise be a new Promise.
Return promise and perform the remaining steps in parallel.
If the following steps or referenced procedures say to throw an error, queue a global task on the crypto task source, given realm's global object, to reject promise with the returned error; and then terminate the algorithm.
Let digest be the result of performing the digest operation specified by normalizedAlgorithm using algorithm, with data as message.
Queue a global task on the crypto task source, given realm's global object, to perform the remaining steps.
Let result be the result of creating an ArrayBuffer in realm, containing digest.
Resolve promise with result.
When invoked, generateKey MUST perform the following steps:
Let algorithm, extractable and usages be the algorithm, extractable and keyUsages parameters passed to the generateKey() method, respectively.
Let normalizedAlgorithm be the result of normalizing an algorithm, with alg set to algorithm and op set to "generateKey".
If an error occurred, return a Promise rejected with normalizedAlgorithm.
Let realm be the relevant realm of this.
Let promise be a new Promise.
Return promise and perform the remaining steps in parallel.
If the following steps or referenced procedures say to throw an error, queue a global task on the crypto task source, given realm's global object, to reject promise with the returned error; and then terminate the algorithm.
Let result be the result of performing the generate key operation specified by normalizedAlgorithm using algorithm, extractable and usages.
CryptoKey object:
If the [[type]] internal slot of result is "secret" or "private" and usages is empty, then throw a SyntaxError.
CryptoKeyPair object:
If the [[usages]] internal slot of the privateKey attribute of result is the empty sequence, then throw a SyntaxError.
Queue a global task on the crypto task source, given realm's global object, to perform the remaining steps.
Let result be the result of converting result to an ECMAScript Object in realm, as defined by [WebIDL].
Resolve promise with result.
When invoked, deriveKey MUST perform the following steps:
Let algorithm, baseKey, derivedKeyType, extractable and usages be the algorithm, baseKey, derivedKeyType, extractable and keyUsages parameters passed to the deriveKey() method, respectively.
Let normalizedAlgorithm be the result of normalizing an algorithm, with alg set to algorithm and op set to "deriveBits".
If an error occurred, return a Promise rejected with normalizedAlgorithm.
Let normalizedDerivedKeyAlgorithmImport be the result of normalizing an algorithm, with alg set to derivedKeyType and op set to "importKey".
If an error occurred, return a Promise rejected with normalizedDerivedKeyAlgorithmImport.
Let normalizedDerivedKeyAlgorithmLength be the result of normalizing an algorithm, with alg set to derivedKeyType and op set to "get key length".
If an error occurred, return a Promise rejected with normalizedDerivedKeyAlgorithmLength.
Let realm be the relevant realm of this.
Let promise be a new Promise.
Return promise and perform the remaining steps in parallel.
If the following steps or referenced procedures say to throw an error, queue a global task on the crypto task source, given realm's global object, to reject promise with the returned error; and then terminate the algorithm.
If the name member of normalizedAlgorithm is not equal to the name attribute of the [[algorithm]] internal slot of baseKey then throw an InvalidAccessError.
If the [[usages]] internal slot of baseKey does not contain an entry that is "deriveKey", then throw an InvalidAccessError.
Let length be the result of performing the get key length algorithm specified by normalizedDerivedKeyAlgorithmLength using derivedKeyType.
Let secret be the result of performing the derive bits operation specified by normalizedAlgorithm using key, algorithm and length.
Let result be the result of performing the import key operation specified by normalizedDerivedKeyAlgorithmImport using "raw" as format, secret as keyData, derivedKeyType as algorithm and using extractable and usages.
If the [[type]] internal slot of result is "secret" or "private" and usages is empty, then throw a SyntaxError.
Set the [[extractable]] internal slot of result to extractable.
Set the [[usages]] internal slot of result to the normalized value of usages.
Queue a global task on the crypto task source, given realm's global object, to perform the remaining steps.
Let result be the result of converting result to an ECMAScript Object in realm, as defined by [WebIDL].
Resolve promise with result.
When invoked, deriveBits MUST perform the following steps:
Let algorithm, baseKey and length, be the algorithm, baseKey and length parameters passed to the deriveBits() method, respectively.
Let normalizedAlgorithm be the result of normalizing an algorithm, with alg set to algorithm and op set to "deriveBits".
If an error occurred, return a Promise rejected with normalizedAlgorithm.
Let realm be the relevant realm of this.
Let promise be a new Promise.
Return promise and perform the remaining steps in parallel.
If the following steps or referenced procedures say to throw an error, queue a global task on the crypto task source, given realm's global object, to reject promise with the returned error; and then terminate the algorithm.
If the name member of normalizedAlgorithm is not equal to the name attribute of the [[algorithm]] internal slot of baseKey then throw an InvalidAccessError.
If the [[usages]] internal slot of baseKey does not contain an entry that is "deriveBits", then throw an InvalidAccessError.
Let bits be the result of performing the derive bits operation specified by normalizedAlgorithm using baseKey, algorithm and length.
Queue a global task on the crypto task source, given realm's global object, to perform the remaining steps.
Let result be the result of creating an ArrayBuffer in realm, containing bits.
Resolve promise with result.
When invoked, the importKey method MUST perform the following steps:
Let format, algorithm, extractable and usages, be the format, algorithm, extractable and keyUsages parameters passed to the importKey() method, respectively.
raw", "pkcs8", or "spki":
If the keyData parameter passed to the importKey() method is a JsonWebKey dictionary, throw a TypeError.
Let keyData be the result of getting a copy of the bytes held by the keyData parameter passed to the importKey() method.
jwk":
If the keyData parameter passed to the importKey() method is not a JsonWebKey dictionary, throw a TypeError.
Let keyData be the keyData parameter passed to the importKey() method.
Let normalizedAlgorithm be the result of normalizing an algorithm, with alg set to algorithm and op set to "importKey".
If an error occurred, return a Promise rejected with normalizedAlgorithm.
Let realm be the relevant realm of this.
Let promise be a new Promise.
Return promise and perform the remaining steps in parallel.
If the following steps or referenced procedures say to throw an error, queue a global task on the crypto task source, given realm's global object, to reject promise with the returned error; and then terminate the algorithm.
Let result be the CryptoKey object that results from performing the import key operation specified by normalizedAlgorithm using keyData, algorithm, format, extractable and usages.
If the [[type]] internal slot of result is "secret" or "private" and usages is empty, then throw a SyntaxError.
Set the [[extractable]] internal slot of result to extractable.
Set the [[usages]] internal slot of result to the normalized value of usages.
Queue a global task on the crypto task source, given realm's global object, to perform the remaining steps.
Let result be the result of converting result to an ECMAScript Object in realm, as defined by [WebIDL].
Resolve promise with result.
Note
Support of "raw" key formats is encouraged for interoperability. Web developers should consult the test-suite for detailed information on implementations support of other key formats.
Note
For structured key formats, "spki", "pkcs8" and "jwk", fields that are not explicitly referred to in the key import procedures for an algorithm are ignored.
When invoked, the exportKey method MUST perform the following steps:
Let format and key be the format and key parameters passed to the exportKey() method, respectively.
Let realm be the relevant realm of this.
Let promise be a new Promise.
Return promise and perform the remaining steps in parallel.
If the following steps or referenced procedures say to throw an error, queue a global task on the crypto task source, given realm's global object, to reject promise with the returned error; and then terminate the algorithm.
If the name member of the [[algorithm]] internal slot of key does not identify a registered algorithm that supports the export key operation, then throw a NotSupportedError.
If the [[extractable]] internal slot of key is false, then throw an InvalidAccessError.
Let result be the result of performing the export key operation specified by the [[algorithm]] internal slot of key using key and format.
Queue a global task on the crypto task source, given realm's global object, to perform the remaining steps.
Resolve promise with result.
Note
Support of "raw" key formats is encouraged for interoperability. Web developers should consult the test-suite for detailed information on implementations support of other key formats.
When invoked, the wrapKey method MUST perform the following steps:
Let format, key, wrappingKey and algorithm be the format, key, wrappingKey and wrapAlgorithm parameters passed to the wrapKey() method, respectively.
Let normalizedAlgorithm be the result of normalizing an algorithm, with alg set to algorithm and op set to "wrapKey".
If an error occurred, let normalizedAlgorithm be the result of normalizing an algorithm, with alg set to algorithm and op set to "encrypt".
If an error occurred, return a Promise rejected with normalizedAlgorithm.
Let realm be the relevant realm of this.
Let promise be a new Promise.
Return promise and perform the remaining steps in parallel.
If the following steps or referenced procedures say to throw an error, queue a global task on the crypto task source, given realm's global object, to reject promise with the returned error; and then terminate the algorithm.
If the name member of normalizedAlgorithm is not equal to the name attribute of the [[algorithm]] internal slot of wrappingKey then throw an InvalidAccessError.
If the [[usages]] internal slot of wrappingKey does not contain an entry that is "wrapKey", then throw an InvalidAccessError.
If the algorithm identified by the [[algorithm]] internal slot of key does not support the export key operation, then throw a NotSupportedError.
If the [[extractable]] internal slot of key is false, then throw an InvalidAccessError.
Note
Because the wrapKey method effectively exports the key, only keys marked as extractable may be wrapped. In particular, this means that this API cannot create a wrapped JWK key that is marked as non-extractable using the ext JWK member.
However, the unwrapKey method does support the ext JWK member, so that wrapped non-extractable keys created elsewhere, for example by a server, can be unwrapped using this API.
Let exportedKey be the result of performing the export key operation specified by the [[algorithm]] internal slot of key using key and format.
raw", "pkcs8", or "spki":
jwk":
Let json be the result of representing exportedKey as a UTF-16 string conforming to the JSON grammar; for example, by executing the JSON.stringify algorithm specified in [ECMA-262] in the context of a new global object.
Let bytes be the result of UTF-8 encoding json.
Note
The key wrapping operations for some algorithms place constraints on the payload size. For example AES-KW requires the payload to be a multiple of 8 bytes in length and RSA-OAEP places a restriction on the length. For key formats that offer flexibility in serialization of a given key (for example JWK), implementations may choose to adapt the serialization to the constraints of the wrapping algorithm. This is why JSON.stringify is not normatively required, as otherwise it would prohibit implementations from introducing added padding.
Let result be the result of performing the wrap key operation specified by normalizedAlgorithm using algorithm, wrappingKey as key and bytes as plaintext.
Let result be the result of performing the encrypt operation specified by normalizedAlgorithm using algorithm, wrappingKey as key and bytes as plaintext.
NotSupportedError.
Queue a global task on the crypto task source, given realm's global object, to perform the remaining steps.
Let result be the result of creating an ArrayBuffer in realm, containing result.
Resolve promise with result.
Note
Support of "raw" key formats is encouraged for interoperability. Web developers should consult the test-suite for detailed information on implementations support of other key formats.
When invoked, the unwrapKey method MUST perform the following steps:
Let format, unwrappingKey, algorithm, unwrappedKeyAlgorithm, extractable and usages, be the format, unwrappingKey, unwrapAlgorithm, unwrappedKeyAlgorithm, extractable and keyUsages parameters passed to the unwrapKey() method, respectively.
Let wrappedKey be the result of getting a copy of the bytes held by the wrappedKey parameter passed to the unwrapKey() method.
Let normalizedAlgorithm be the result of normalizing an algorithm, with alg set to algorithm and op set to "unwrapKey".
If an error occurred, let normalizedAlgorithm be the result of normalizing an algorithm, with alg set to algorithm and op set to "decrypt".
If an error occurred, return a Promise rejected with normalizedAlgorithm.
Let normalizedKeyAlgorithm be the result of normalizing an algorithm, with alg set to unwrappedKeyAlgorithm and op set to "importKey".
If an error occurred, return a Promise rejected with normalizedKeyAlgorithm.
Let realm be the relevant realm of this.
Let promise be a new Promise.
Return promise and perform the remaining steps in parallel.
If the following steps or referenced procedures say to throw an error, queue a global task on the crypto task source, given realm's global object, to reject promise with the returned error; and then terminate the algorithm.
If the name member of normalizedAlgorithm is not equal to the name attribute of the [[algorithm]] internal slot of unwrappingKey then throw an InvalidAccessError.
If the [[usages]] internal slot of unwrappingKey does not contain an entry that is "unwrapKey", then throw an InvalidAccessError.
NotSupportedError.
raw", "pkcs8", or "spki":
jwk":
data to be parsed.
Let result be the result of performing the import key operation specified by normalizedKeyAlgorithm using unwrappedKeyAlgorithm as algorithm, format, usages and extractable and with key as keyData.
If the [[type]] internal slot of result is "secret" or "private" and usages is empty, then throw a SyntaxError.
Set the [[extractable]] internal slot of result to extractable.
Set the [[usages]] internal slot of result to the normalized value of usages.
Queue a global task on the crypto task source, given realm's global object, to perform the remaining steps.
Let result be the result of converting result to an ECMAScript Object in realm, as defined by [WebIDL].
Resolve promise with result.
Note
Support of "raw" key formats is encouraged for interoperability. Web developers should consult the test-suite for detailed information on implementations support of other key formats.
The methods of the SubtleCrypto interface return errors by rejecting the returned promise with a predefined exception defined in ECMAScript [ECMA-262] or DOMException. The following predefined exceptions are used: TypeError. The following DOMException types from [DOM] are used:
When this specification says to throw an error, the user agent must throw an error as described in [WebIDL]. When this occurs in a sub-algorithm, this results in termination of execution of the sub-algorithm and all ancestor algorithms until one is reached that explicitly describes procedures for catching exceptions. The error object thrown shall be associated with the relevant realm of this.
dictionary RsaOtherPrimesInfo {DOMString r;
DOMString d;
DOMString t;
};
dictionary JsonWebKey {DOMString kty;
DOMString use;
sequence<DOMString> key_ops;
DOMString alg;boolean ext;DOMString crv;
DOMString x;
DOMString y;
DOMString d;
DOMString n;
DOMString e;
DOMString p;
DOMString q;
DOMString dp;
DOMString dq;
DOMString qi;
sequence<RsaOtherPrimesInfo> oth;
DOMString k;
};The JsonWebKey dictionary provides a way to represent and exchange cryptographic keys represented by the JSON Web Key [JWK] structure, while allowing native and efficient use within Web Cryptography API applications.
The members of the RsaOtherPrimesInfo are defined in Section 6.3.2.7 of JSON Web Algorithms.
typedef Uint8Array BigInteger;The BigInteger typedef is a Uint8Array that holds an arbitrary magnitude unsigned integer in big-endian order. Values read from the API SHALL have minimal typed array length (that is, at most 7 leading zero bits, except the value 0 which shall have length 8 bits). The API SHALL accept values with any number of leading zero bits, including the empty array, which represents zero.
Note
Since the integer is unsigned, the highest order bit is NOT a sign bit. Implementors should take care when mapping to big integer implementations that expected signed integers.
dictionary CryptoKeyPair {
CryptoKey publicKey;
CryptoKey privateKey;
};The CryptoKeyPair dictionary represents an asymmetric key pair that is comprised of both public (publicKey) and private (privateKey) keys.
This section is non-normative.
In addition to providing a common interface to perform cryptographic operations, by way of the SubtleCrypto interface, this specification also provides descriptions for a variety of algorithms that authors may wish to use and that User Agents may choose to implement. This includes a selection of commonly-deployed symmetric and asymmetric algorithms, key derivation mechanisms, and methods for wrapping and unwrapping keys. Further, this specification defines a process to allow additional specifications to introduce additional cryptographic algorithms.
Every cryptographic algorithm defined for use with the Web Cryptography API MUST have a unique name, referred to as its recognized algorithm name, such that no other specification defines the same case-insensitive string for use with the Web Cryptography API.
Every cryptographic algorithm defined for use with the Web Cryptography API has a list of supported operations, which are a set of sub-algorithms to be invoked by the SubtleCrypto interface in order to perform the desired cryptographic operation. This specification makes use of the following operations:
If a given algorithm specification does not list a particular operation as supported, or explicitly lists an operation as not-supported, then the User Agent MUST behave as if the invocation of the sub-algorithm threw a NotSupportedError.
Every cryptographic algorithm defined for use with the Web Cryptography API MUST define, for every supported operation, the IDL type to use for algorithm normalization, as well as the IDL type or types of the return values of the sub-algorithms.
Every cryptographic algorithm definition within this specification employs the following specification conventions. A section, titled "Registration", will include the recognized algorithm name. Additionally, it includes a table, which will list each of the supported operations as rows, identified by the Operation column. The contents of the Parameters column for a given row will contain the IDL type to use for algorithm normalization for that operation, and the contents of the Result column for that row indicate the IDL type that results from performing the supported operation.
If a conforming User Agent implements an algorithm, it MUST implement all of the supported operations and MUST return the IDL type specified.
Additionally, upon initialization, conforming User Agents must perform the define an algorithm steps for each of the supported operations, registering their IDL parameter type as indicated.
Unless otherwise stated, objects created by the operations defined in this specification shall be associated with the relevant realm of this.
This section is non-normative.
The AlgorithmIdentifier typedef permits algorithms to either be specified as a DOMString or an object. The usage of DOMString is to permit authors a short-hand for noting algorithms that have no parameters (e.g. SHA-1). The usage of object is to allow an Algorithm (or appropriate subclass) to be specified, which contains all of the associated parameters for an object.
Because of this, it's necessary to define the algorithm for converting an AlgorithmIdentifier into an appropriate dictionary that is usable with this API. This algorithm must be extensible, so as to allow new cryptographic algorithms to be added, and consistent, so that Web IDL type mapping can occur before any control is returned to the calling script, which would potentially allow the mutation of parameters or the script environment.
This specification makes use of an internal object, supportedAlgorithms. This internal object is not exposed to applications.
Because this value is not exposed to applications, the exact type is not specified. It is only required to behave as an associative container of key/value pairs, where comparisons of keys are performed in a case-sensitive manner.
The initial contents of this internal object are as follows:
For each value, v in the List of supported operations, set the v key of the internal object supportedAlgorithms to a new associative container.
The define an algorithm algorithm is used by specification authors to indicate how a user agent should normalize arguments for a particular algorithm. Its input is an algorithm name alg, represented as a DOMString, operation name op, represented as a DOMString, and desired IDL dictionary type type. The algorithm behaves as follows:
supportedAlgorithms.The normalize an algorithm algorithm defines a process for coercing inputs to a targeted IDL dictionary type, after Web IDL conversion has occurred. It is designed to be extensible, to allow future specifications to define additional algorithms, as well as safe for use with Promises. Its input is an operation name op and an AlgorithmIdentifier alg. Its output is either an IDL dictionary type or an error. It behaves as follows:
Return the result of running the normalize an algorithm algorithm, with the alg set to a new Algorithm dictionary whose name attribute is alg, and with the op set to op.
op key of supportedAlgorithms.Algorithm, as defined by [WebIDL].name attribute of initialAlg.Set algName to the value of the matching key.
Let desiredType be the IDL dictionary type stored at algName in registeredAlgorithms.
NotSupportedError and terminate this algorithm.
name attribute of normalizedAlgorithm to algName.For each dictionary dictionary in dictionaries:
For each dictionary member member declared on dictionary, in order:
BufferSource and is present:
HashAlgorithmIdentifier:
alg set to idlValue and the op set to "digest".
AlgorithmIdentifier:
alg set to idlValue and the op set to the operation defined by the specification that defines the algorithm identified by algName.
This section is non-normative.
As this API is meant to be extensible, in order to keep up with future developments within cryptography, there are no algorithms that conforming user agents are required to implement. As such, authors should check to see what algorithms are currently recommended and supported by implementations.
As highlighted in the Security Considerations, even cryptographic algorithms that might be considered strong for one purpose may be insufficient when used with another purpose. Authors should therefore proceed with extreme caution before inventing new cryptographic protocols.
Additionally, this specification includes several algorithms which, in their default usage, can result in cryptographic vulnerabilities. While these concerns may be mitigated, such as through the combination and composition with additional algorithms provided by this specification, authors should proceed with caution and review the relevant cryptographic literature before using a given algorithm. The inclusion of algorithms within this specification is not an indicator of their suitability for any or all purpose, and instead merely serve to provide as a specification for how a conforming User Agent must implement the given algorithm, if it choses to implement the algorithm.
In order to promote interoperability for developers, this specification includes a list of suggested algorithms. These are considered to be the most widely used algorithms in practice at the time of writing, and therefore provide a good starting point for initial implementations of this specification. The suggested algorithms are:
This section is non-normative.
The table below contains an overview of the algorithms described within this specification, as well as the set of SubtleCrypto methods the algorithm may be used with. In order for an algorithm to be used with a method the corresponding operation or operations, as defined in the procedures for the method, must be defined in the algorithm specification. Note that this mapping of methods to underlying operations is not one-to-one:
The encrypt method requires the encrypt operation.
The decrypt method requires the decrypt operation.
The sign method requires the sign operation.
The verify method requires the verify operation.
The generateKey method requires the generateKey operation.
The importKey method requires the importKey operation.
The exportKey method requires the exportKey operation.
The deriveKey method requires the deriveBits operation for the key derivation algorithm and the get key length and importKey operations for the derived key algorithm.
The deriveBits method requires the deriveBits operation for the key derivation algorithm.
The digest method requires the digest operation.
The wrapKey method requires either the encrypt or wrapKey operation for the wrapping algorithm and the exportKey operation for the wrapped key algorithm.
The unwrapKey method requires either the decrypt or unwrapKey operation for the unwrapping algorithm and the importKey operation for the unwrapped key algorithm.
Note
Application developers and script authors should not interpret this table as a recommendation for the use of particular algorithms. Instead, it simply documents what methods are supported. Authors should refer to the Security considerations for authors section of this document to better understand the risks and concerns that may arise when using certain algorithms.
This section is non-normative.
The "RSASSA-PKCS1-v1_5" algorithm identifier is used to perform signing and verification using the RSASSA-PKCS1-v1_5 algorithm specified in [RFC3447] and using the SHA hash functions defined in this specification.
Other specifications may specify the use of additional hash algorithms with RSASSA-PKCS1-v1_5. Such specifications must define the digest operations for the additional hash algorithms and key import steps and key export steps for RSASSA-PKCS1-v1_5.
The recognized algorithm name for this algorithm is "RSASSA-PKCS1-v1_5".
dictionary RsaKeyGenParams : Algorithm {
required [EnforceRange] unsigned long modulusLength;
required BigInteger publicExponent;
};The modulusLength member contains the length, in bits, of the RSA modulus.
The publicExponent member contains the RSA public exponent.
dictionary RsaHashedKeyGenParams : RsaKeyGenParams {
required HashAlgorithmIdentifier hash;
};The hash member represents the hash algorithm to use.
dictionary RsaKeyAlgorithm : KeyAlgorithm {
required unsigned long modulusLength;
required BigInteger publicExponent;
};The modulusLength member contains the length, in bits, of the RSA modulus.
The publicExponent member contains the RSA public exponent.
dictionary RsaHashedKeyAlgorithm : RsaKeyAlgorithm {
required KeyAlgorithm hash;
};The hash member describes the hash algorithm that is used with this key.
dictionary RsaHashedImportParams : Algorithm {
required HashAlgorithmIdentifier hash;
};The hash member describes the hash algorithm to use.
If the [[type]] internal slot of key is not "private", then throw an InvalidAccessError.
Perform the signature generation operation defined in Section 8.2 of [RFC3447] with the key represented by the [[handle]] internal slot of key as the signer's private key and message as M and using the hash function specified in the hash attribute of the [[algorithm]] internal slot of key as the Hash option for the EMSA-PKCS1-v1_5 encoding method.
If performing the operation results in an error, then throw an OperationError.
Let signature be the value S that results from performing the operation.
Return signature.
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
Perform the signature verification operation defined in Section 8.2 of [RFC3447] with the key represented by the [[handle]] internal slot of key as the signer's RSA public key and message as M and signature as S and using the hash function specified in the hash attribute of the [[algorithm]] internal slot of key as the Hash option for the EMSA-PKCS1-v1_5 encoding method.
Let result be a boolean with value true if the result of the operation was "valid signature" and the value false otherwise.
Return result.
If usages contains an entry which is not "sign" or "verify", then throw a SyntaxError.
Generate an RSA key pair, as defined in [RFC3447], with RSA modulus length equal to the modulusLength attribute of normalizedAlgorithm and RSA public exponent equal to the publicExponent attribute of normalizedAlgorithm.
If generation of the key pair fails, then throw an OperationError.
Let algorithm be a new RsaHashedKeyAlgorithm dictionary.
Set the name attribute of algorithm to "RSASSA-PKCS1-v1_5".
Set the modulusLength attribute of algorithm to equal the modulusLength attribute of normalizedAlgorithm.
Set the publicExponent attribute of algorithm to equal the publicExponent attribute of normalizedAlgorithm.
Set the hash attribute of algorithm to equal the hash member of normalizedAlgorithm.
Let publicKey be a new CryptoKey representing the public key of the generated key pair.
Set the [[type]] internal slot of publicKey to "public"
Set the [[algorithm]] internal slot of publicKey to algorithm.
Set the [[extractable]] internal slot of publicKey to true.
Set the [[usages]] internal slot of publicKey to be the usage intersection of usages and [ "verify" ].
Let privateKey be a new CryptoKey representing the private key of the generated key pair.
Set the [[algorithm]] internal slot of privateKey to algorithm.
Set the [[extractable]] internal slot of privateKey to extractable.
Set the [[usages]] internal slot of privateKey to be the usage intersection of usages and [ "sign" ].
Let result be a new CryptoKeyPair dictionary.
Set the publicKey attribute of result to be publicKey.
Set the privateKey attribute of result to be privateKey.
Return result.
Let keyData be the key data to be imported.
spki":
If usages contains an entry which is not "verify", then throw a SyntaxError.
Let spki be the result of running the parse a subjectPublicKeyInfo algorithm over keyData.
If the algorithm object identifier field of the algorithm AlgorithmIdentifier field of spki is not equal to the rsaEncryption object identifier defined in [RFC3447], then throw a DataError.
Let publicKey be the result of performing the parse an ASN.1 structure algorithm, with data as the subjectPublicKeyInfo field of spki, structure as the RSAPublicKey structure specified in Section A.1.1 of [RFC3447], and exactData set to true.
If an error occurred while parsing, or it can be determined that publicKey is not a valid public key according to [RFC3447], then throw a DataError.
Let key be a new CryptoKey that represents the RSA public key identified by publicKey.
Set the [[type]] internal slot of key to "public"
pkcs8":
If usages contains an entry which is not "sign" then throw a SyntaxError.
Let privateKeyInfo be the result of running the parse a privateKeyInfo algorithm over keyData.
If the algorithm object identifier field of the privateKeyAlgorithm PrivateKeyAlgorithm field of privateKeyInfo is not equal to the rsaEncryption object identifier defined in [RFC3447], then throw a DataError.
Let rsaPrivateKey be the result of performing the parse an ASN.1 structure algorithm, with data as the privateKey field of privateKeyInfo, structure as the RSAPrivateKey structure specified in Section A.1.2 of [RFC3447], and exactData set to true.
If an error occurred while parsing, or if rsaPrivateKey is not a valid RSA private key according to [RFC3447], then throw a DataError.
Let key be a new CryptoKey that represents the RSA private key identified by rsaPrivateKey.
jwk":
JsonWebKey dictionary:
Let jwk equal keyData.
If the d field of jwk is present and usages contains an entry which is not "sign", or, if the d field of jwk is not present and usages contains an entry which is not "verify" then throw a SyntaxError.
If the kty field of jwk is not a case-sensitive string match to "RSA", then throw a DataError.
If usages is non-empty and the use field of jwk is present and is not a case-sensitive string match to "sig", then throw a DataError.
If the key_ops field of jwk is present, and is invalid according to the requirements of JSON Web Key [JWK] or does not contain all of the specified usages values, then throw a DataError.
If the ext field of jwk is present and has the value false and extractable is true, then throw a DataError.
Let hash be a be a string whose initial value is undefined.
alg field of jwk is not present:
Let hash be undefined.
alg field is equal to the string "RS1":
Let hash be the string "SHA-1".
alg field is equal to the string "RS256":
Let hash be the string "SHA-256".
alg field is equal to the string "RS384":
Let hash be the string "SHA-384".
alg field is equal to the string "RS512":
Let hash be the string "SHA-512".
Perform any key import steps defined by other applicable specifications, passing format, jwk and obtaining hash.
If an error occurred or there are no applicable specifications, throw a DataError.
Let normalizedHash be the result of normalize an algorithm with alg set to hash and op set to digest.
If normalizedHash is not equal to the hash member of normalizedAlgorithm, throw a DataError.
d field of jwk is present:
If jwk does not meet the requirements of Section 6.3.2 of JSON Web Algorithms [JWA], then throw a DataError.
Let privateKey represents the RSA private key identified by interpreting jwk according to Section 6.3.2 of JSON Web Algorithms [JWA].
If privateKey is not a valid RSA private key according to [RFC3447], then throw a DataError.
Let key be a new CryptoKey object that represents privateKey.
If jwk does not meet the requirements of Section 6.3.1 of JSON Web Algorithms [JWA], then throw a DataError.
Let publicKey represent the RSA public key identified by interpreting jwk according to Section 6.3.1 of JSON Web Algorithms [JWA].
If publicKey can be determined to not be a valid RSA public key according to [RFC3447], then throw a DataError.
Let key be a new CryptoKey representing publicKey.
Set the [[type]] internal slot of key to "public"
NotSupportedError.
Let algorithm be a new RsaHashedKeyAlgorithm dictionary.
Set the name attribute of algorithm to "RSASSA-PKCS1-v1_5"
Set the modulusLength attribute of algorithm to the length, in bits, of the RSA public modulus.
Set the publicExponent attribute of algorithm to the BigInteger representation of the RSA public exponent.
Set the hash attribute of algorithm to the hash member of normalizedAlgorithm.
Set the [[algorithm]] internal slot of key to algorithm.
Return key.
Let key be the key to be exported.
If the underlying cryptographic key material represented by the [[handle]] internal slot of key cannot be accessed, then throw an OperationError.
spki"
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
Let data be an instance of the SubjectPublicKeyInfo ASN.1 structure defined in [RFC5280] with the following properties:
Set the algorithm field to an AlgorithmIdentifier ASN.1 type with the following properties:
Set the algorithm field to the OID rsaEncryption defined in [RFC3447].
Set the params field to the ASN.1 type NULL.
Set the subjectPublicKey field to the result of DER-encoding an RSAPublicKey ASN.1 type, as defined in [RFC3447], Appendix A.1.1, that represents the RSA public key represented by the [[handle]] internal slot of key
Let result be the result of DER-encoding data.
pkcs8":
If the [[type]] internal slot of key is not "private", then throw an InvalidAccessError.
Let data be an instance of the PrivateKeyInfo ASN.1 structure defined in [RFC5208] with the following properties:
Set the version field to 0.
Set the privateKeyAlgorithm field to a PrivateKeyAlgorithmIdentifier ASN.1 type with the following properties:
Set the algorithm field to the OID rsaEncryption defined in [RFC3447].
Set the params field to the ASN.1 type NULL.
Set the privateKey field to the result of DER-encoding an RSAPrivateKey ASN.1 type, as defined in [RFC3447], Appendix A.1.2, that represents the RSA private key represented by the [[handle]] internal slot of key
Note
[
RFC5208] specifies that the encoding of this field should be
BERencoded in Section 5 (as a "for example"). However, to avoid requiring WebCrypto implementations support BER-encoding and BER-decoding, only
DERencodings are produced or accepted.
Let result be the result of DER-encoding data.
jwk":
Let jwk be a new JsonWebKey dictionary.
Set the kty attribute of jwk to the string "RSA".
Let hash be the name attribute of the hash attribute of the [[algorithm]] internal slot of key.
SHA-1":
Set the alg attribute of jwk to the string "RS1".
SHA-256":
Set the alg attribute of jwk to the string "RS256".
SHA-384":
Set the alg attribute of jwk to the string "RS384".
SHA-512":
Set the alg attribute of jwk to the string "RS512".
Perform any key export steps defined by other applicable specifications, passing format, key and obtaining alg.
If an error occurred or there are no applicable specifications, throw a NotSupportedError.
Set the alg attribute of jwk to alg.
Set the attributes n and e of jwk according to the corresponding definitions in JSON Web Algorithms [JWA], Section 6.3.1.
[[type]] internal slot of key is "private":
Set the attributes named d, p, q, dp, dq, and qi of jwk according to the corresponding definitions in JSON Web Algorithms [JWA], Section 6.3.2.
If the underlying RSA private key represented by the [[handle]] internal slot of key is represented by more than two primes, set the attribute named oth of jwk according to the corresponding definition in JSON Web Algorithms [JWA], Section 6.3.2.7
Set the key_ops attribute of jwk to the usages attribute of key.
Set the ext attribute of jwk to the [[extractable]] internal slot of key.
Let result be jwk.
Return result.
This section is non-normative.
The "RSA-PSS" algorithm identifier is used to perform signing and verification using the RSASSA-PSS algorithm specified in [RFC3447], using the SHA hash functions defined in this specification and the mask generation formula MGF1.
Other specifications may specify the use of additional hash algorithms with RSASSA-PSS. Such specifications must define the digest operation for the additional hash algorithms and key import steps and key export steps for RSASSA-PSS.
The recognized algorithm name for this algorithm is "RSA-PSS".
dictionary RsaPssParams : Algorithm {
required [EnforceRange] unsigned long saltLength;
};The saltLength member represents the desired length of the random salt in bytes.
If the [[type]] internal slot of key is not "private", then throw an InvalidAccessError.
Perform the signature generation operation defined in Section 8.1 of [RFC3447] with the key represented by the [[handle]] internal slot of key as the signer's private key, K, and message as the message to be signed, M, and using the hash function specified by the hash attribute of the [[algorithm]] internal slot of key as the Hash option, MGF1 (defined in Section B.2.1 of [RFC3447]) as the MGF option and the saltLength member of normalizedAlgorithm as the salt length option for the EMSA-PSS-ENCODE operation.
If performing the operation results in an error, then throw an OperationError.
Let signature be the signature, S, that results from performing the operation.
Return signature.
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
Perform the signature verification operation defined in Section 8.1 of [RFC3447] with the key represented by the [[handle]] internal slot of key as the signer's RSA public key and message as M and signature as S and using the hash function specified by the hash attribute of the [[algorithm]] internal slot of key as the Hash option, MGF1 (defined in Section B.2.1 of [RFC3447]) as the MGF option and the saltLength member of normalizedAlgorithm as the salt length option for the EMSA-PSS-VERIFY operation.
Let result be a boolean with the value true if the result of the operation was "valid signature" and the value false otherwise.
If usages contains an entry which is not "sign" or "verify", then throw a SyntaxError.
Generate an RSA key pair, as defined in [RFC3447], with RSA modulus length equal to the modulusLength member of normalizedAlgorithm and RSA public exponent equal to the publicExponent member of normalizedAlgorithm.
If performing the operation results in an error, then throw an OperationError.
Let algorithm be a new RsaHashedKeyAlgorithm dictionary.
Set the name attribute of algorithm to "RSA-PSS".
Set the modulusLength attribute of algorithm to equal the modulusLength member of normalizedAlgorithm.
Set the publicExponent attribute of algorithm to equal the publicExponent member of normalizedAlgorithm.
Set the hash attribute of algorithm to equal the hash member of normalizedAlgorithm.
Let publicKey be a new CryptoKey representing the public key of the generated key pair.
Set the [[type]] internal slot of publicKey to "public"
Set the [[algorithm]] internal slot of publicKey to algorithm.
Set the [[extractable]] internal slot of publicKey to true.
Set the [[usages]] internal slot of publicKey to be the usage intersection of usages and [ "verify" ].
Let privateKey be a new CryptoKey representing the private key of the generated key pair.
Set the [[algorithm]] internal slot of privateKey to algorithm.
Set the [[extractable]] internal slot of privateKey to extractable.
Set the [[usages]] internal slot of privateKey to be the usage intersection of usages and [ "sign" ].
Let result be a new CryptoKeyPair dictionary.
Set the publicKey attribute of result to publicKey.
Set the privateKey attribute of result to privateKey.
Return result.
Let keyData be the key data to be imported.
spki":
If usages contains an entry which is not "verify" then throw a SyntaxError.
Let spki be the result of running the parse a subjectPublicKeyInfo algorithm over keyData.
If the algorithm object identifier field of the algorithm AlgorithmIdentifier field of spki is not equal to the rsaEncryption object identifier defined in [RFC3447], then throw a DataError.
Let publicKey be the result of performing the parse an ASN.1 structure algorithm, with data as the subjectPublicKeyInfo field of spki, structure as the RSAPublicKey structure specified in Section A.1.1 of [RFC3447], and exactData set to true.
If an error occurred while parsing, or it can be determined that publicKey is not a valid public key according to [RFC3447], then throw a DataError.
Let key be a new CryptoKey that represents the RSA public key identified by publicKey.
Set the [[type]] internal slot of key to "public"
pkcs8":
If usages contains an entry which is not "sign" then throw a SyntaxError.
Let privateKeyInfo be the result of running the parse a privateKeyInfo algorithm over keyData.
If the algorithm object identifier field of the privateKeyAlgorithm PrivateKeyAlgorithm field of privateKeyInfo is not equal to the rsaEncryption object identifier defined in [RFC3447], then throw a DataError.
Let rsaPrivateKey be the result of performing the parse an ASN.1 structure algorithm, with data as the privateKey field of privateKeyInfo, structure as the RSAPrivateKey structure specified in Section A.1.2 of [RFC3447], and exactData set to true.
If an error occurred while parsing, or if rsaPrivateKey is not a valid RSA private key according to [RFC3447], then throw a DataError.
Let key be a new CryptoKey that represents the RSA private key identified by rsaPrivateKey.
jwk":
JsonWebKey dictionary:
Let jwk equal keyData.
If the d field of jwk is present and usages contains an entry which is not "sign", or, if the d field of jwk is not present and usages contains an entry which is not "verify" then throw a SyntaxError.
If the kty field of jwk is not a case-sensitive string match to "RSA", then throw a DataError.
If usages is non-empty and the use field of jwk is present and is not a case-sensitive string match to "sig", then throw a DataError.
If the key_ops field of jwk is present, and is invalid according to the requirements of JSON Web Key [JWK] or does not contain all of the specified usages values, then throw a DataError.
If the ext field of jwk is present and has the value false and extractable is true, then throw a DataError.
alg field of jwk is not present:
Let hash be undefined.
alg field is equal to the string "PS1":
Let hash be the string "SHA-1".
alg field is equal to the string "PS256":
Let hash be the string "SHA-256".
alg field is equal to the string "PS384":
Let hash be the string "SHA-384".
alg field is equal to the string "PS512":
Let hash be the string "SHA-512".
Perform any key import steps defined by other applicable specifications, passing format, jwk and obtaining hash.
If an error occurred or there are no applicable specifications, throw a DataError.
Let normalizedHash be the result of normalize an algorithm with alg set to hash and op set to digest.
If normalizedHash is not equal to the hash member of normalizedAlgorithm, throw a DataError.
d field of jwk is present:
If jwk does not meet the requirements of Section 6.3.2 of JSON Web Algorithms [JWA], then throw a DataError.
Let privateKey represent the RSA private key identified by interpreting jwk according to Section 6.3.2 of JSON Web Algorithms [JWA].
If privateKey can be determined to not be a valid RSA private key according to [RFC3447], then throw a DataError.
Let key be a new CryptoKey representing privateKey.
If jwk does not meet the requirements of Section 6.3.1 of JSON Web Algorithms [JWA], then throw a DataError.
Let publicKey represent the RSA public key identified by interpreting jwk according to Section 6.3.1 of JSON Web Algorithms [JWA].
If publicKey can be determined to not be a valid RSA public key according to [RFC3447], then throw a DataError.
Let key be a new CryptoKey representing publicKey.
Set the [[type]] internal slot of key to "public"
NotSupportedError.
Let algorithm be a new RsaHashedKeyAlgorithm dictionary.
Set the name attribute of algorithm to "RSA-PSS"
Set the modulusLength attribute of algorithm to the length, in bits, of the RSA public modulus.
Set the publicExponent attribute of algorithm to the BigInteger representation of the RSA public exponent.
Set the hash attribute of algorithm to the hash member of normalizedAlgorithm.
Set the [[algorithm]] internal slot of key to algorithm
Return key.
Let key be the key to be exported.
If the underlying cryptographic key material represented by the [[handle]] internal slot of key cannot be accessed, then throw an OperationError.
spki"
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
Let data be an instance of the SubjectPublicKeyInfo ASN.1 structure defined in [RFC5280] with the following properties:
Set the algorithm field to an AlgorithmIdentifier ASN.1 type with the following properties:
Set the algorithm field to the OID rsaEncryption defined in [RFC3447].
Set the params field to the ASN.1 type NULL.
Set the subjectPublicKey field to the result of DER-encoding an RSAPublicKey ASN.1 type, as defined in [RFC3447], Appendix A.1.1, that represents the RSA public key represented by the [[handle]] internal slot of key
Let result be the result of DER-encoding data.
pkcs8":
If the [[type]] internal slot of key is not "private", then throw an InvalidAccessError.
Let data be an instance of the PrivateKeyInfo ASN.1 structure defined in [RFC5208] with the following properties:
Set the version field to 0.
Set the privateKeyAlgorithm field to a PrivateKeyAlgorithmIdentifier ASN.1 type with the following properties:
Set the algorithm field to the OID rsaEncryption defined in [RFC3447].
Set the params field to the ASN.1 type NULL.
Set the privateKey field to the result of DER-encoding an RSAPrivateKey ASN.1 type, as defined in [RFC3447], Appendix A.1.2, that represents the RSA private key represented by the [[handle]] internal slot of key
Note
[
RFC5208] specifies that the encoding of this field should be
BERencoded in Section 5 (as a "for example"). However, to avoid requiring WebCrypto implementations support BER-encoding and BER-decoding, only
DERencodings are produced or accepted.
Let result be the result of DER-encoding data.
jwk":
Let jwk be a new JsonWebKey dictionary.
Set the kty attribute of jwk to the string "RSA".
Let hash be the name attribute of the hash attribute of the [[algorithm]] internal slot of key.
SHA-1":
Set the alg attribute of jwk to the string "PS1".
SHA-256":
Set the alg attribute of jwk to the string "PS256".
SHA-384":
Set the alg attribute of jwk to the string "PS384".
SHA-512":
Set the alg attribute of jwk to the string "PS512".
Perform any key export steps defined by other applicable specifications, passing format and the hash attribute of the [[algorithm]] internal slot of key and obtaining alg.
Set the alg attribute of jwk to alg.
Set the attributes n and e of jwk according to the corresponding definitions in JSON Web Algorithms [JWA], Section 6.3.1.
[[type]] internal slot of key is "private":
Set the attributes named d, p, q, dp, dq, and qi of jwk according to the corresponding definitions in JSON Web Algorithms [JWA], Section 6.3.2.
If the underlying RSA private key represented by the [[handle]] internal slot of key is represented by more than two primes, set the attribute named oth of jwk according to the corresponding definition in JSON Web Algorithms [JWA], Section 6.3.2.7
Set the key_ops attribute of jwk to the usages attribute of key.
Set the ext attribute of jwk to the [[extractable]] internal slot of key.
Let result be jwk.
Return result.
This section is non-normative.
The "RSA-OAEP" algorithm identifier is used to perform encryption and decryption ordering to the RSAES-OAEP algorithm specified in [RFC3447], using the SHA hash functions defined in this specification and using the mask generation function MGF1.
Other specifications may specify the use of additional hash algorithms with RSAES-OAEP. Such specifications must define the digest operation for the additional hash algorithm and key import steps and key export steps for RSAES-OAEP.
The recognized algorithm name for this algorithm is "RSA-OAEP".
dictionary RsaOaepParams : Algorithm {
BufferSource label;
};The label member represents the optional label/application data to associate with the message.
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
Let label be the label member of normalizedAlgorithm or the empty byte sequence if the label member of normalizedAlgorithm is not present.
Perform the encryption operation defined in Section 7.1 of [RFC3447] with the key represented by key as the recipient's RSA public key, plaintext as the message to be encrypted, M and label as the label, L, and with the hash function specified by the hash attribute of the [[algorithm]] internal slot of key as the Hash option and MGF1 (defined in Section B.2.1 of [RFC3447]) as the MGF option.
If performing the operation results in an error, then throw an OperationError.
Let ciphertext be the value C that results from performing the operation.
Return ciphertext.
If the [[type]] internal slot of key is not "private", then throw an InvalidAccessError.
Let label be the label member of normalizedAlgorithm or the empty byte sequence if the label member of normalizedAlgorithm is not present.
Perform the decryption operation defined in Section 7.1 of [RFC3447] with the key represented by key as the recipient's RSA private key, ciphertext as the ciphertext to be decrypted, C, and label as the label, L, and with the hash function specified by the hash attribute of the [[algorithm]] internal slot of key as the Hash option and MGF1 (defined in Section B.2.1 of [RFC3447]) as the MGF option.
If performing the operation results in an error, then throw an OperationError.
Let plaintext the value M that results from performing the operation.
Return plaintext.
If usages contains an entry which is not "encrypt", "decrypt", "wrapKey" or "unwrapKey", then throw a SyntaxError.
Generate an RSA key pair, as defined in [RFC3447], with RSA modulus length equal to the modulusLength member of normalizedAlgorithm and RSA public exponent equal to the publicExponent member of normalizedAlgorithm.
If performing the operation results in an error, then throw an OperationError.
Let algorithm be a new RsaHashedKeyAlgorithm object.
Set the name attribute of algorithm to "RSA-OAEP".
Set the modulusLength attribute of algorithm to equal the modulusLength member of normalizedAlgorithm.
Set the publicExponent attribute of algorithm to equal the publicExponent member of normalizedAlgorithm.
Set the hash attribute of algorithm to equal the hash member of normalizedAlgorithm.
Let publicKey be a new CryptoKey representing the public key of the generated key pair.
Set the [[type]] internal slot of publicKey to "public"
Set the [[algorithm]] internal slot of publicKey to algorithm.
Set the [[extractable]] internal slot of publicKey to true.
Set the [[usages]] internal slot of publicKey to be the usage intersection of usages and [ "encrypt", "wrapKey" ].
Let privateKey be a new CryptoKey representing the private key of the generated key pair.
Set the [[algorithm]] internal slot of privateKey to algorithm.
Set the [[extractable]] internal slot of privateKey to extractable.
Set the [[usages]] internal slot of privateKey to be the usage intersection of usages and [ "decrypt", "unwrapKey" ].
Let result be a new CryptoKeyPair dictionary.
Set the publicKey attribute of result to be publicKey.
Set the privateKey attribute of result to be privateKey.
Return result.
Let keyData be the key data to be imported.
spki":
If usages contains an entry which is not "encrypt" or "wrapKey", then throw a SyntaxError.
Let spki be the result of running the parse a subjectPublicKeyInfo algorithm over keyData.
If the algorithm object identifier field of the algorithm AlgorithmIdentifier field of spki is not equal to the rsaEncryption object identifier defined in [RFC3447], then throw a DataError.
Let publicKey be the result of performing the parse an ASN.1 structure algorithm, with data as the subjectPublicKeyInfo field of spki, structure as the RSAPublicKey structure specified in Section A.1.1 of [RFC3447], and exactData set to true.
If an error occurred while parsing, or it can be determined that publicKey is not a valid public key according to [RFC3447], then throw a DataError.
Let key be a new CryptoKey that represents the RSA public key identified by publicKey.
Set the [[type]] internal slot of key to "public"
pkcs8":
If usages contains an entry which is not "decrypt" or "unwrapKey", then throw a SyntaxError.
Let privateKeyInfo be the result of running the parse a privateKeyInfo algorithm over keyData.
If the algorithm object identifier field of the privateKeyAlgorithm PrivateKeyAlgorithm field of privateKeyInfo is not equal to the rsaEncryption object identifier defined in [RFC3447], then throw a DataError.
Let rsaPrivateKey be the result of performing the parse an ASN.1 structure algorithm, with data as the privateKey field of privateKeyInfo, structure as the RSAPrivateKey structure specified in Section A.1.2 of [RFC3447], and exactData set to true.
If an error occurred while parsing, or if rsaPrivateKey is not a valid RSA private key according to [RFC3447], then throw a DataError.
Let key be a new CryptoKey that represents the RSA private key identified by rsaPrivateKey.
jwk":
JsonWebKey dictionary:
Let jwk equal keyData.
If the d field of jwk is present and usages contains an entry which is not "decrypt" or "unwrapKey", then throw a SyntaxError.
If the d field of jwk is not present and usages contains an entry which is not "encrypt" or "wrapKey", then throw a SyntaxError.
If the kty field of jwk is not a case-sensitive string match to "RSA", then throw a DataError.
If usages is non-empty and the use field of jwk is present and is not a case-sensitive string match to "enc", then throw a DataError.
If the key_ops field of jwk is present, and is invalid according to the requirements of JSON Web Key [JWK] or does not contain all of the specified usages values, then throw a DataError.
If the ext field of jwk is present and has the value false and extractable is true, then throw a DataError.
alg field of jwk is not present:
alg field of jwk is equal to "RSA-OAEP":
SHA-1".
alg field of jwk is equal to "RSA-OAEP-256":
SHA-256".
alg field of jwk is equal to "RSA-OAEP-384":
SHA-384".
alg field of jwk is equal to "RSA-OAEP-512":
SHA-512".
Perform any key import steps defined by other applicable specifications, passing format, jwk and obtaining hash.
If an error occurred or there are no applicable specifications, throw a DataError.
Let normalizedHash be the result of normalize an algorithm with alg set to hash and op set to digest.
If normalizedHash is not equal to the hash member of normalizedAlgorithm, throw a DataError.
d field of jwk is present:
If jwk does not meet the requirements of Section 6.3.2 of JSON Web Algorithms [JWA], then throw a DataError.
Let privateKey represent the RSA private key identified by interpreting jwk according to Section 6.3.2 of JSON Web Algorithms [JWA].
If privateKey can be determined to not be a valid RSA private key according to [RFC3447], then throw a DataError.
Let key be a new CryptoKey representing privateKey.
If jwk does not meet the requirements of Section 6.3.1 of JSON Web Algorithms [JWA], then throw a DataError.
Let publicKey represent the RSA public key identified by interpreting jwk according to Section 6.3.1 of JSON Web Algorithms [JWA].
If publicKey can be determined to not be a valid RSA public key according to [RFC3447], then throw a DataError.
Let key be a new CryptoKey representing publicKey.
Set the [[type]] internal slot of key to "public"
NotSupportedError.
Let algorithm be a new RsaHashedKeyAlgorithm.
Set the name attribute of algorithm to "RSA-OAEP"
Set the modulusLength attribute of algorithm to the length, in bits, of the RSA public modulus.
Set the publicExponent attribute of algorithm to the BigInteger representation of the RSA public exponent.
Set the hash attribute of algorithm to the hash member of normalizedAlgorithm.
Set the [[algorithm]] internal slot of key to algorithm
Return key.
Let key be the key to be exported.
If the underlying cryptographic key material represented by the [[handle]] internal slot of key cannot be accessed, then throw an OperationError.
spki"
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
Let data be an instance of the SubjectPublicKeyInfo ASN.1 structure defined in [RFC5280] with the following properties:
Set the algorithm field to an AlgorithmIdentifier ASN.1 type with the following properties:
Set the algorithm field to the OID rsaEncryption defined in [RFC3447].
Set the params field to the ASN.1 type NULL.
Set the subjectPublicKey field to the result of DER-encoding an RSAPublicKey ASN.1 type, as defined in [RFC3447], Appendix A.1.1, that represents the RSA public key represented by the [[handle]] internal slot of key
Let result be the result of DER-encoding data.
pkcs8":
If the [[type]] internal slot of key is not "private", then throw an InvalidAccessError.
Let data be an instance of the PrivateKeyInfo ASN.1 structure defined in [RFC5208] with the following properties:
Set the version field to 0.
Set the privateKeyAlgorithm field to a PrivateKeyAlgorithmIdentifier ASN.1 type with the following properties:
Set the algorithm field to the OID rsaEncryption defined in [RFC3447].
Set the params field to the ASN.1 type NULL.
Set the privateKey field to the result of DER-encoding an RSAPrivateKey ASN.1 type, as defined in [RFC3447], Appendix A.1.2, that represents the RSA private key represented by the [[handle]] internal slot of key
Note
[
RFC5208] specifies that the encoding of this field should be
BERencoded in Section 5 (as a "for example"). However, to avoid requiring WebCrypto implementations support BER-encoding and BER-decoding, only
DERencodings are produced or accepted.
Let result be the result of DER-encoding data.
jwk":
Let jwk be a new JsonWebKey dictionary.
Set the kty attribute of jwk to the string "RSA".
Let hash be the name attribute of the hash attribute of the [[algorithm]] internal slot of key.
SHA-1":
Set the alg attribute of jwk to the string "RSA-OAEP".
SHA-256":
Set the alg attribute of jwk to the string "RSA-OAEP-256".
SHA-384":
Set the alg attribute of jwk to the string "RSA-OAEP-384".
SHA-512":
Set the alg attribute of jwk to the string "RSA-OAEP-512".
Perform any key export steps defined by other applicable specifications, passing format and the hash attribute of the [[algorithm]] internal slot of key and obtaining alg.
Set the alg attribute of jwk to alg.
Set the attributes n and e of jwk according to the corresponding definitions in JSON Web Algorithms [JWA], Section 6.3.1.
[[type]] internal slot of key is "private":
Set the attributes named d, p, q, dp, dq, and qi of jwk according to the corresponding definitions in JSON Web Algorithms [JWA], Section 6.3.2.
If the underlying RSA private key represented by the [[handle]] internal slot of key is represented by more than two primes, set the attribute named oth of jwk according to the corresponding definition in JSON Web Algorithms [JWA], Section 6.3.2.7
Set the key_ops attribute of jwk to the usages attribute of key.
Set the ext attribute of jwk to the [[extractable]] internal slot of key.
Let result be jwk.
Return result.
This section is non-normative.
The "ECDSA" algorithm identifier is used to perform signing and verification using the ECDSA algorithm specified in [RFC6090] and using the SHA hash functions and elliptic curves defined in this specification.
Other specifications may specify the use of additional elliptic curves and hash algorithms with ECDSA. To specify additional hash algorithms to be used with ECDSA, a specification must define a registered algorithm that supports the digest operation. To specify an additional elliptic curve a specification must define the curve name, ECDSA signature steps, ECDSA verification steps, ECDSA generation steps, ECDSA key import steps and ECDSA key export steps.
The recognized algorithm name for this algorithm is "ECDSA".
dictionary EcdsaParams : Algorithm {
required HashAlgorithmIdentifier hash;
};The hash member represents the hash algorithm to use.
typedef DOMString NamedCurve;
dictionary EcKeyGenParams : Algorithm {
required NamedCurve namedCurve;
};The NamedCurve type represents named elliptic curves, which are a convenient way to specify the domain parameters of well-known elliptic curves. The following values defined by this specification:
P-256"
secp256r1.
P-384"
secp384r1.
P-521"
secp521r1.
Other specifications may define additional values.
The namedCurve member of the EcKeyGenParams dictionary represents a named curve.
dictionary EcKeyAlgorithm : KeyAlgorithm {
required NamedCurve namedCurve;
};The namedCurve member represents the named curve that the key uses.
dictionary EcKeyImportParams : Algorithm {
required NamedCurve namedCurve;
};The namedCurve member represents a named curve.
If the [[type]] internal slot of key is not "private", then throw an InvalidAccessError.
Let hashAlgorithm be the hash member of normalizedAlgorithm.
Let M be the result of performing the digest operation specified by hashAlgorithm using message.
Let d be the ECDSA private key associated with key.
Let params be the EC domain parameters associated with key.
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256", "P-384" or "P-521":
Perform the ECDSA signing process, as specified in [RFC6090], Section 5.4, with M as the message, using params as the EC domain parameters, and with d as the private key.
Let r and s be the pair of integers resulting from performing the ECDSA signing process.
Let result be an empty byte sequence.
Let n be the smallest integer such that n * 8 is greater than the logarithm to base 2 of the order of the base point of the elliptic curve identified by params.
Convert r to a byte sequence of length n and append it to result.
Convert s to a byte sequence of length n and append it to result.
namedCurve attribute of the [[algorithm]] internal slot of key is a value specified in an applicable specification:
Perform the ECDSA signature steps specified in that specification, passing in M, params and d and resulting in result.
Return result.
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
Let hashAlgorithm be the hash member of normalizedAlgorithm.
Let M be the result of performing the digest operation specified by hashAlgorithm using message.
Let Q be the ECDSA public key associated with key.
Let params be the EC domain parameters associated with key.
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256", "P-384" or "P-521":
Perform the ECDSA verifying process, as specified in [RFC6090], Section 5.3, with M as the received message, signature as the received signature and using params as the EC domain parameters, and Q as the public key.
namedCurve attribute of the [[algorithm]] internal slot of key is a value specified in an applicable specification:
Perform the ECDSA verification steps specified in that specification passing in M, signature, params and Q and resulting in an indication of whether or not the purported signature is valid.
Let result be a boolean with the value true if the signature is valid and the value false otherwise.
Return result.
If usages contains a value which is not one of "sign" or "verify", then throw a SyntaxError.
namedCurve member of normalizedAlgorithm is "P-256", "P-384" or "P-521":
Generate an Elliptic Curve key pair, as defined in [RFC6090] with domain parameters for the curve identified by the namedCurve member of normalizedAlgorithm.
namedCurve member of normalizedAlgorithm is a value specified in an applicable specification:
Perform the ECDSA generation steps specified in that specification, passing in normalizedAlgorithm and resulting in an elliptic curve key pair.
If performing the key generation operation results in an error, then throw an OperationError.
Let algorithm be a new EcKeyAlgorithm object.
Set the name attribute of algorithm to "ECDSA".
Set the namedCurve attribute of algorithm to equal the namedCurve member of normalizedAlgorithm.
Let publicKey be a new CryptoKey representing the public key of the generated key pair.
Set the [[type]] internal slot of publicKey to "public"
Set the [[algorithm]] internal slot of publicKey to algorithm.
Set the [[extractable]] internal slot of publicKey to true.
Set the [[usages]] internal slot of publicKey to be the usage intersection of usages and [ "verify" ].
Let privateKey be a new CryptoKey representing the private key of the generated key pair.
Set the [[algorithm]] internal slot of privateKey to algorithm.
Set the [[extractable]] internal slot of privateKey to extractable.
Set the [[usages]] internal slot of privateKey to be the usage intersection of usages and [ "sign" ].
Let result be a new CryptoKeyPair dictionary.
Set the publicKey attribute of result to be publicKey.
Set the privateKey attribute of result to be privateKey.
Return result.
Let keyData be the key data to be imported.
spki":
If usages contains a value which is not "verify" then throw a SyntaxError.
Let spki be the result of running the parse a subjectPublicKeyInfo algorithm over keyData
If the algorithm object identifier field of the algorithm AlgorithmIdentifier field of spki is not equal to the id-ecPublicKey object identifier defined in [RFC5480], then throw a DataError.
If the parameters field of the algorithm AlgorithmIdentifier field of spki is absent, then throw a DataError.
Let params be the parameters field of the algorithm AlgorithmIdentifier field of spki.
If params is not an instance of the ECParameters ASN.1 type defined in [RFC5480] that specifies a namedCurve, then throw a DataError.
Let namedCurve be a string whose initial value is undefined.
secp256r1 object identifier defined in [RFC5480]:
Set namedCurve "P-256".
secp384r1 object identifier defined in [RFC5480]:
Set namedCurve "P-384".
secp521r1 object identifier defined in [RFC5480]:
Set namedCurve "P-521".
Let publicKey be the Elliptic Curve public key identified by performing the conversion steps defined in Section 2.3.4 of [SEC1] using the subjectPublicKey field of spki.
The uncompressed point format MUST be supported.
If the implementation does not support the compressed point format and a compressed point is provided, throw a DataError.
If a decode error occurs or an identity point is found, throw a DataError.
Let key be a new CryptoKey that represents publicKey.
Perform any key import steps defined by other applicable specifications, passing format, spki and obtaining namedCurve and key.
If an error occurred or there are no applicable specifications, throw a DataError.
If namedCurve is defined, and not equal to the namedCurve member of normalizedAlgorithm, throw a DataError.
If the public key value is not a valid point on the Elliptic Curve identified by the namedCurve member of normalizedAlgorithm throw a DataError.
Set the [[type]] internal slot of key to "public"
Let algorithm be a new EcKeyAlgorithm.
Set the name attribute of algorithm to "ECDSA".
Set the namedCurve attribute of algorithm to namedCurve.
Set the [[algorithm]] internal slot of key to algorithm.
pkcs8":
If usages contains a value which is not "sign" then throw a SyntaxError.
Let privateKeyInfo be the result of running the parse a privateKeyInfo algorithm over keyData.
If the algorithm object identifier field of the privateKeyAlgorithm PrivateKeyAlgorithm field of privateKeyInfo is not equal to the id-ecPublicKey object identifier defined in [RFC5480], then throw a DataError.
If the parameters field of the privateKeyAlgorithm PrivateKeyAlgorithmIdentifier field of privateKeyInfo is not present, then throw a DataError.
Let params be the parameters field of the privateKeyAlgorithm PrivateKeyAlgorithmIdentifier field of privateKeyInfo.
If params is not an instance of the ECParameters ASN.1 type defined in [RFC5480] that specifies a namedCurve, then throw a DataError.
Let namedCurve be a string whose initial value is undefined.
secp256r1 object identifier defined in [RFC5480]:
Set namedCurve "P-256".
secp384r1 object identifier defined in [RFC5480]:
Set namedCurve "P-384".
secp521r1 object identifier defined in [RFC5480]:
Set namedCurve "P-521".
Let ecPrivateKey be the result of performing the parse an ASN.1 structure algorithm, with data as the privateKey field of privateKeyInfo, structure as the ASN.1 ECPrivateKey structure specified in Section 3 of [RFC5915], and exactData set to true.
If the parameters field of ecPrivateKey is present, and is not an instance of the namedCurve ASN.1 type defined in [RFC5480], or does not contain the same object identifier as the parameters field of the privateKeyAlgorithm PrivateKeyAlgorithmIdentifier field of privateKeyInfo, then throw a DataError.
Let key be a new CryptoKey that represents the Elliptic Curve private key identified by performing the conversion steps defined in Section 3 of [RFC5915] using ecPrivateKey.
Perform any key import steps defined by other applicable specifications, passing format, privateKeyInfo and obtaining namedCurve and key.
If an error occurred or there are no applicable specifications, throw a DataError.
If namedCurve is defined, and not equal to the namedCurve member of normalizedAlgorithm, throw a DataError.
If the private key value is not a valid point on the Elliptic Curve identified by the namedCurve member of normalizedAlgorithm throw a DataError.
Let algorithm be a new EcKeyAlgorithm.
Set the name attribute of algorithm to "ECDSA".
Set the namedCurve attribute of algorithm to namedCurve.
Set the [[algorithm]] internal slot of key to algorithm.
jwk":
JsonWebKey dictionary:
Let jwk equal keyData.
If the d field is present and usages contains a value which is not "sign", or, if the d field is not present and usages contains a value which is not "verify" then throw a SyntaxError.
If the kty field of jwk is not "EC", then throw a DataError.
If usages is non-empty and the use field of jwk is present and is not "sig", then throw a DataError.
If the key_ops field of jwk is present, and is invalid according to the requirements of JSON Web Key [JWK], or it does not contain all of the specified usages values, then throw a DataError.
If the ext field of jwk is present and has the value false and extractable is true, then throw a DataError.
Let namedCurve be a string whose value is equal to the crv field of jwk.
If namedCurve is not equal to the namedCurve member of normalizedAlgorithm, throw a DataError.
P-256", "P-384" or "P-521":
Let algNamedCurve be a string whose initial value is undefined.
alg field is not present:
alg field is equal to the string "ES256":
P-256".
alg field is equal to the string "ES384":
P-384".
alg field is equal to the string "ES512":
P-521".
DataError.
If algNamedCurve is defined, and is not equal to namedCurve, throw a DataError.
d field is present:
If jwk does not meet the requirements of Section 6.2.1 of JSON Web Algorithms [JWA], then throw a DataError.
Let key be a new CryptoKey object that represents the Elliptic Curve public key identified by interpreting jwk according to Section 6.2.1 of JSON Web Algorithms [JWA].
Set the [[type]] internal slot of Key to "public".
Perform any key import steps defined by other applicable specifications, passing format, jwk and obtaining key.
If an error occurred or there are no applicable specifications, throw a DataError.
If the key value is not a valid point on the Elliptic Curve identified by the namedCurve member of normalizedAlgorithm throw a DataError.
Let algorithm be a new instance of an EcKeyAlgorithm object.
Set the name attribute of algorithm to "ECDSA".
Set the namedCurve attribute of algorithm to namedCurve.
Set the [[algorithm]] internal slot of key to algorithm.
raw":
If the namedCurve member of normalizedAlgorithm is not a named curve, then throw a DataError.
If usages contains a value which is not "verify" then throw a SyntaxError.
P-256", "P-384" or "P-521":
Let Q be the elliptic curve point on the curve identified by the namedCurve member of normalizedAlgorithm identified by performing the conversion steps defined in Section 2.3.4 of [SEC1] on keyData.
The uncompressed point format MUST be supported.
If the implementation does not support the compressed point format and a compressed point is provided, throw a DataError.
If a decode error occurs or an identity point is found, throw a DataError.
Let key be a new CryptoKey that represents Q.
Perform any key import steps defined by other applicable specifications, passing format, keyData and obtaining key.
If an error occurred or there are no applicable specifications, throw a DataError.
Let algorithm be a new EcKeyAlgorithm object.
Set the name attribute of algorithm to "ECDSA".
Set the namedCurve attribute of algorithm to equal the namedCurve member of normalizedAlgorithm.
Set the [[type]] internal slot of key to "public"
Set the [[algorithm]] internal slot of key to algorithm.
Return key
Let key be the CryptoKey to be exported.
If the underlying cryptographic key material represented by the [[handle]] internal slot of key cannot be accessed, then throw an OperationError.
spki":
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
Let data be an instance of the SubjectPublicKeyInfo ASN.1 structure defined in [RFC5280] with the following properties:
Set the algorithm field to an AlgorithmIdentifier ASN.1 type with the following properties:
Set the algorithm field to the OID id-ecPublicKey defined in [RFC5480].
Set the parameters field to an instance of the ECParameters ASN.1 type defined in [RFC5480] as follows:
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256", "P-384" or "P-521":
Let keyData be the byte sequence that represents the Elliptic Curve public key represented by the [[handle]] internal slot of key according to the encoding rules specified in Section 2.2 of [RFC5480] and using the uncompressed form. and keyData.
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256":
Set parameters to the namedCurve choice with value equal to the object identifier secp256r1 defined in [RFC5480]
namedCurve attribute of the [[algorithm]] internal slot of key is "P-384":
Set parameters to the namedCurve choice with value equal to the object identifier secp384r1 defined in [RFC5480]
namedCurve attribute of the [[algorithm]] internal slot of key is "P-521":
Set parameters to the namedCurve choice with value equal to the object identifier secp521r1 defined in [RFC5480]
Perform any key export steps defined by other applicable specifications, passing format and the namedCurve attribute of the [[algorithm]] internal slot of key and obtaining namedCurveOid and keyData.
Set parameters to the namedCurve choice with value equal to the object identifier namedCurveOid.
Set the subjectPublicKey field to keyData.
Let result be the result of DER-encoding data.
pkcs8":
If the [[type]] internal slot of key is not "private", then throw an InvalidAccessError.
Let data be an instance of the PrivateKeyInfo ASN.1 structure defined in [RFC5208] with the following properties:
Set the version field to 0.
Set the privateKeyAlgorithm field to a PrivateKeyAlgorithmIdentifier ASN.1 type with the following properties:
Set the algorithm field to the OID id-ecPublicKey defined in [RFC5480].
Set the parameters field to an instance of the ECParameters ASN.1 type defined in [RFC5480] as follows:
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256", "P-384" or "P-521":
Let keyData be the result of DER-encoding an instance of the ECPrivateKey structure defined in Section 3 of [RFC5915] for the Elliptic Curve private key represented by the [[handle]] internal slot of key and that conforms to the following:
The parameters field is present, and is equivalent to the parameters field of the privateKeyAlgorithm field of this PrivateKeyInfo ASN.1 structure.
The publicKey field is present and represents the Elliptic Curve public key associated with the Elliptic Curve private key represented by the [[handle]] internal slot of key.
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256":
Set parameters to the namedCurve choice with value equal to the object identifier secp256r1 defined in [RFC5480]
namedCurve attribute of the [[algorithm]] internal slot of key is "P-384":
Set parameters to the namedCurve choice with value equal to the object identifier secp384r1 defined in [RFC5480]
namedCurve attribute of the [[algorithm]] internal slot of key is "P-521":
Set parameters to the namedCurve choice with value equal to the object identifier secp521r1 defined in [RFC5480]
Perform any key export steps defined by other applicable specifications, passing format and the namedCurve attribute of the [[algorithm]] internal slot of key and obtaining namedCurveOid and keyData.
Set parameters to the namedCurve choice with value equal to the object identifier namedCurveOid.
Set the privateKey field to keyData.
Let result be the result of DER-encoding data.
jwk":
Let jwk be a new JsonWebKey dictionary.
Set the kty attribute of jwk to "EC".
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256", "P-384" or "P-521":
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256":
crv attribute of jwk to "P-256"
namedCurve attribute of the [[algorithm]] internal slot of key is "P-384":
crv attribute of jwk to "P-384"
namedCurve attribute of the [[algorithm]] internal slot of key is "P-521":
crv attribute of jwk to "P-521"
Set the x attribute of jwk according to the definition in Section 6.2.1.2 of JSON Web Algorithms [JWA].
Set the y attribute of jwk according to the definition in Section 6.2.1.3 of JSON Web Algorithms [JWA].
Perform any key export steps defined by other applicable specifications, passing format and the namedCurve attribute of the [[algorithm]] internal slot of key and obtaining namedCurve and a new value of jwk.
Set the crv attribute of jwk to namedCurve.
Set the key_ops attribute of jwk to the usages attribute of key.
Set the ext attribute of jwk to the [[extractable]] internal slot of key.
Let result be jwk.
raw":
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256", "P-384" or "P-521":
Let data be a byte sequence representing the Elliptic Curve point Q represented by the [[handle]] internal slot of key according to [SEC1] 2.3.3 using the uncompressed format.
Perform any key export steps defined by other applicable specifications, passing format and the namedCurve attribute of the [[algorithm]] internal slot of key and obtaining namedCurve and data.
Let result be data.
Return result.
This section is non-normative.
This describes using Elliptic Curve Diffie-Hellman (ECDH) for key generation and key agreement, as specified by [RFC6090].
Other specifications may specify the use of additional elliptic curves with ECDH. To specify an additional elliptic curve a specification must define the curve name, ECDH generation steps, ECDH derivation steps, ECDH key import steps and ECDH key export steps.
The recognized algorithm name for this algorithm is "ECDH".
dictionary EcdhKeyDeriveParams : Algorithm {
required CryptoKey public;
};The public member represents the peer's EC public key.
If usages contains an entry which is not "deriveKey" or "deriveBits" then throw a SyntaxError.
namedCurve member of normalizedAlgorithm is "P-256", "P-384" or "P-521":
Generate an Elliptic Curve key pair, as defined in [RFC6090] with domain parameters for the curve identified by the namedCurve member of normalizedAlgorithm.
namedCurve member of normalizedAlgorithm is a value specified in an applicable specification that specifies the use of that value with ECDH:
Perform the ECDH generation steps specified in that specification, passing in normalizedAlgorithm and resulting in an elliptic curve key pair.
If performing the operation results in an error, then throw a OperationError.
Let algorithm be a new EcKeyAlgorithm object.
Set the name member of algorithm to "ECDH".
Set the namedCurve attribute of algorithm to equal the namedCurve member of normalizedAlgorithm.
Let publicKey be a new CryptoKey representing the public key of the generated key pair.
Set the [[type]] internal slot of publicKey to "public"
Set the [[algorithm]] internal slot of publicKey to algorithm.
Set the [[extractable]] internal slot of publicKey to true.
Set the [[usages]] internal slot of publicKey to be the empty list.
Let privateKey be a new CryptoKey representing the private key of the generated key pair.
Set the [[algorithm]] internal slot of privateKey to algorithm.
Set the [[extractable]] internal slot of privateKey to extractable.
Set the [[usages]] internal slot of privateKey to be the usage intersection of usages and [ "deriveKey", "deriveBits" ].
Let result be a new CryptoKeyPair dictionary.
Set the publicKey attribute of result to be publicKey.
Set the privateKey attribute of result to be privateKey.
Return result.
If the [[type]] internal slot of key is not "private", then throw an InvalidAccessError.
Let publicKey be the public member of normalizedAlgorithm.
If the [[type]] internal slot of publicKey is not "public", then throw an InvalidAccessError.
If the name attribute of the [[algorithm]] internal slot of publicKey is not equal to the name property of the [[algorithm]] internal slot of key, then throw an InvalidAccessError.
If the namedCurve attribute of the [[algorithm]] internal slot of publicKey is not equal to the namedCurve property of the [[algorithm]] internal slot of key, then throw an InvalidAccessError.
namedCurve property of the [[algorithm]] internal slot of key is "P-256", "P-384" or "P-521":
Perform the ECDH primitive specified in [RFC6090] Section 4 with key as the EC private key d and the EC public key represented by the [[handle]] internal slot of publicKey as the EC public key.
Let secret be a byte sequence containing the result of applying the field element to octet string conversion defined in Section 6.2 of [RFC6090] to the output of the ECDH primitive.
namedCurve property of the [[algorithm]] internal slot of key is a value specified in an applicable specification that specifies the use of that value with ECDH:
Perform the ECDH derivation steps specified in that specification, passing in key and publicKey and resulting in secret.
If performing the operation results in an error, then throw a OperationError.
OperationError.
Let keyData be the key data to be imported.
spki":
If usages is not empty then throw a SyntaxError.
Let spki be the result of running the parse a subjectPublicKeyInfo algorithm over keyData
If the algorithm object identifier field of the algorithm AlgorithmIdentifier field of spki is not equal to the id-ecPublicKey object identifier defined in [RFC5480], then throw a DataError.
If the parameters field of the algorithm AlgorithmIdentifier field of spki is absent, then throw a DataError.
Let params be the parameters field of the algorithm AlgorithmIdentifier field of spki.
If params is not an instance of the ECParameters ASN.1 type defined in [RFC5480] that specifies a namedCurve, then throw a DataError.
Let namedCurve be a string whose initial value is undefined.
secp256r1 object identifier defined in [RFC5480]:
Set namedCurve "P-256".
secp384r1 object identifier defined in [RFC5480]:
Set namedCurve "P-384".
secp521r1 object identifier defined in [RFC5480]:
Set namedCurve "P-521".
Let publicKey be the Elliptic Curve public key identified by performing the conversion steps defined in Section 2.3.4 of [SEC1] to the subjectPublicKey field of spki.
The uncompressed point format MUST be supported.
If the implementation does not support the compressed point format and a compressed point is provided, throw a DataError.
If a decode error occurs or an identity point is found, throw a DataError.
Let key be a new CryptoKey that represents publicKey.
Perform any key import steps defined by other applicable specifications, passing format, spki and obtaining namedCurve and key.
If an error occurred or there are no applicable specifications, throw a DataError.
If namedCurve is defined, and not equal to the namedCurve member of normalizedAlgorithm, throw a DataError.
If the key value is not a valid point on the Elliptic Curve identified by the namedCurve member of normalizedAlgorithm throw a DataError.
Set the [[type]] internal slot of key to "public"
Let algorithm be a new EcKeyAlgorithm.
Set the name attribute of algorithm to "ECDH".
Set the namedCurve attribute of algorithm to namedCurve.
Set the [[algorithm]] internal slot of key to algorithm.
pkcs8":
If usages contains an entry which is not "deriveKey" or "deriveBits" then throw a SyntaxError.
Let privateKeyInfo be the result of running the parse a privateKeyInfo algorithm over keyData.
If the algorithm object identifier field of the privateKeyAlgorithm PrivateKeyAlgorithm field of privateKeyInfo is not equal to the id-ecPublicKey object identifier defined in [RFC5480], throw a DataError.
If the parameters field of the privateKeyAlgorithm PrivateKeyAlgorithmIdentifier field of privateKeyInfo is not present, throw a DataError.
Let params be the parameters field of the privateKeyAlgorithm PrivateKeyAlgorithmIdentifier field of privateKeyInfo.
If params is not an instance of the ECParameters ASN.1 type defined in [RFC5480] that specifies a namedCurve, then throw a DataError.
Let namedCurve be a string whose initial value is undefined.
secp256r1 object identifier defined in [RFC5480]:
Set namedCurve to "P-256".
secp384r1 object identifier defined in [RFC5480]:
Set namedCurve to "P-384".
secp521r1 object identifier defined in [RFC5480]:
Set namedCurve to "P-521".
Let ecPrivateKey be the result of performing the parse an ASN.1 structure algorithm, with data as the privateKey field of privateKeyInfo, structure as the ASN.1 ECPrivateKey structure specified in Section 3 of [RFC5915], and exactData set to true.
If the parameters field of ecPrivateKey is present, and is not an instance of the namedCurve ASN.1 type defined in [RFC5480], or does not contain the same object identifier as the parameters field of the privateKeyAlgorithm PrivateKeyAlgorithmIdentifier field of privateKeyInfo, throw a DataError.
Let key be a new CryptoKey that represents the Elliptic Curve private key identified by performing the conversion steps defined in Section 3 of [RFC5915] using ecPrivateKey.
Perform any key import steps defined by other applicable specifications, passing format, privateKeyInfo and obtaining namedCurve and key.
If an error occurred or there are no applicable specifications, throw a DataError.
If namedCurve is defined, and not equal to the namedCurve member of normalizedAlgorithm, throw a DataError.
If the key value is not a valid point on the Elliptic Curve identified by the namedCurve member of normalizedAlgorithm throw a DataError.
Let algorithm be a new EcKeyAlgorithm.
Set the name attribute of algorithm to "ECDH".
Set the namedCurve attribute of algorithm to namedCurve.
Set the [[algorithm]] internal slot of key to algorithm.
jwk":
JsonWebKey dictionary:
Let jwk equal keyData.
If the d field is present and if usages contains an entry which is not "deriveKey" or "deriveBits" then throw a SyntaxError.
If the d field is not present and if usages is not empty then throw a SyntaxError.
If the kty field of jwk is not "EC", then throw a DataError.
If usages is non-empty and the use field of jwk is present and is not equal to "enc" then throw a DataError.
If the key_ops field of jwk is present, and is invalid according to the requirements of JSON Web Key [JWK], or it does not contain all of the specified usages values, then throw a DataError.
If the ext field of jwk is present and has the value false and extractable is true, then throw a DataError.
Let namedCurve be a string whose value is equal to the crv field of jwk.
If namedCurve is not equal to the namedCurve member of normalizedAlgorithm, throw a DataError.
P-256", "P-384" or "P-521":
d field is present:
If jwk does not meet the requirements of Section 6.2.1 of JSON Web Algorithms [JWA], then throw a DataError.
Let key be a new CryptoKey object that represents the Elliptic Curve public key identified by interpreting jwk according to Section 6.2.1 of JSON Web Algorithms [JWA].
Set the [[type]] internal slot of Key to "public".
Perform any key import steps defined by other applicable specifications, passing format, jwk and obtaining key.
If an error occurred or there are no applicable specifications, throw a DataError.
If the key value is not a valid point on the Elliptic Curve identified by the namedCurve member of normalizedAlgorithm throw a DataError.
Let algorithm be a new instance of an EcKeyAlgorithm object.
Set the name attribute of algorithm to "ECDH".
Set the namedCurve attribute of algorithm to namedCurve.
Set the [[algorithm]] internal slot of key to algorithm.
raw":
If the namedCurve member of normalizedAlgorithm is not a named curve, then throw a DataError.
If usages is not the empty list, then throw a SyntaxError.
P-256", "P-384" or "P-521":
Let Q be the Elliptic Curve public key on the curve identified by the namedCurve member of normalizedAlgorithm identified by performing the conversion steps defined in Section 2.3.4 of [SEC1] to keyData.
The uncompressed point format MUST be supported.
If the implementation does not support the compressed point format and a compressed point is provided, throw a DataError.
If a decode error occurs or an identity point is found, throw a DataError.
Let key be a new CryptoKey that represents Q.
Perform any key import steps defined by other applicable specifications, passing format, keyData and obtaining key.
If an error occured or there are no applicable specifications, throw a DataError.
Let algorithm be a new EcKeyAlgorithm object.
Set the name attribute of algorithm to "ECDH".
Set the namedCurve attribute of algorithm to equal the namedCurve member of normalizedAlgorithm.
Set the [[type]] internal slot of key to "public"
Set the [[algorithm]] internal slot of key to algorithm.
Return key
Let key be the CryptoKey to be exported.
If the underlying cryptographic key material represented by the [[handle]] internal slot of key cannot be accessed, then throw an OperationError.
spki":
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
Let data be an instance of the SubjectPublicKeyInfo ASN.1 structure defined in [RFC5280] with the following properties:
Set the algorithm field to an AlgorithmIdentifier ASN.1 type with the following properties:
Set the algorithm field to the OID id-ecPublicKey defined in [RFC5480].
Set the parameters field to an instance of the ECParameters ASN.1 type defined in [RFC5480] as follows:
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256", "P-384" or "P-521":
Let keyData be the byte sequence that represents the Elliptic Curve public key represented by the [[handle]] internal slot of key according to the encoding rules specified in Section 2.3.3 of [SEC1] and using the uncompressed form.
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256":
Set parameters to the namedCurve choice with value equal to the object identifier secp256r1 defined in [RFC5480]
namedCurve attribute of the [[algorithm]] internal slot of key is "P-384":
Set parameters to the namedCurve choice with value equal to the object identifier secp384r1 defined in [RFC5480]
namedCurve attribute of the [[algorithm]] internal slot of key is "P-521":
Set parameters to the namedCurve choice with value equal to the object identifier secp521r1 defined in [RFC5480]
Perform any key export steps defined by other applicable specifications, passing format and the namedCurve attribute of the [[algorithm]] internal slot of key and obtaining namedCurveOid and keyData.
Set parameters to the namedCurve choice with value equal to the object identifier namedCurveOid.
Set the subjectPublicKey field to keyData
pkcs8":
If the [[type]] internal slot of key is not "private", then throw an InvalidAccessError.
Let data be an instance of the PrivateKeyInfo ASN.1 structure defined in [RFC5208] with the following properties:
Set the version field to 0.
Set the privateKeyAlgorithm field to a PrivateKeyAlgorithmIdentifier ASN.1 type with the following properties:
Set the algorithm field to the OID id-ecPublicKey defined in [RFC5480].
Set the parameters field to an instance of the ECParameters ASN.1 type defined in [RFC5480] as follows:
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256", "P-384" or "P-521":
Let keyData be the result of DER-encoding an instance of the ECPrivateKey structure defined in Section 3 of [RFC5915] for the Elliptic Curve private key represented by the [[handle]] internal slot of key and that conforms to the following:
The parameters field is present, and is equivalent to the parameters field of the privateKeyAlgorithm field of this PrivateKeyInfo ASN.1 structure.
The publicKey field is present and represents the Elliptic Curve public key associated with the Elliptic Curve private key represented by the [[handle]] internal slot of key.
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256":
Set parameters to the namedCurve choice with value equal to the object identifier secp256r1 defined in [RFC5480]
namedCurve attribute of the [[algorithm]] internal slot of key is "P-384":
Set parameters to the namedCurve choice with value equal to the object identifier secp384r1 defined in [RFC5480]
namedCurve attribute of the [[algorithm]] internal slot of key is "P-521":
Set parameters to the namedCurve choice with value equal to the object identifier secp521r1 defined in [RFC5480]
Perform any key export steps defined by other applicable specifications, passing format and the namedCurve attribute of the [[algorithm]] internal slot of key and obtaining namedCurveOid and keyData.
Set parameters to the namedCurve choice with value equal to the object identifier namedCurveOid.
Set the privateKey field to keyData.
jwk":
Let jwk be a new JsonWebKey dictionary.
Set the kty attribute of jwk to "EC".
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256", "P-384" or "P-521":
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256":
crv attribute of jwk to "P-256"
namedCurve attribute of the [[algorithm]] internal slot of key is "P-384":
crv attribute of jwk to "P-384"
namedCurve attribute of the [[algorithm]] internal slot of key is "P-521":
crv attribute of jwk to "P-521"
Set the x attribute of jwk according to the definition in Section 6.2.1.2 of JSON Web Algorithms [JWA].
Set the y attribute of jwk according to the definition in Section 6.2.1.3 of JSON Web Algorithms [JWA].
Perform any key export steps defined by other applicable specifications, passing format and the namedCurve attribute of the [[algorithm]] internal slot of key and obtaining namedCurve and a new value of jwk.
Set the crv attribute of jwk to namedCurve.
Set the key_ops attribute of jwk to the usages attribute of key.
Set the ext attribute of jwk to the [[extractable]] internal slot of key.
Let result be jwk.
raw":
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
namedCurve attribute of the [[algorithm]] internal slot of key is "P-256", "P-384" or "P-521":
Let data be the byte sequence that represents the Elliptic Curve public key represented by the [[handle]] internal slot of key according to the encoding rules specified in Section 2.3.3 of [SEC1] and using the uncompressed form.
Perform any key export steps defined by other applicable specifications, passing format and the namedCurve attribute of the [[algorithm]] internal slot of key and obtaining namedCurve and data.
Let result be data.
Return result.
This section is non-normative.
The "Ed25519" algorithm identifier is used to perform signing and verification using the Ed25519 algorithm specified in [RFC8032].
The recognized algorithm name for this algorithm is "Ed25519".
If the [[type]] internal slot of key is not "private", then throw an InvalidAccessError.
Let result be the result of performing the Ed25519 signing process, as specified in [RFC8032], Section 5.1.6, with message as M, using the Ed25519 private key associated with key.
Return result.
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
If the key data of key represents an invalid point or a small-order element on the Elliptic Curve of Ed25519, return false.
If the point R, encoded in the first half of signature, represents an invalid point or a small-order element on the Elliptic Curve of Ed25519, return false.
Perform the Ed25519 verification steps, as specified in [RFC8032], Section 5.1.7, using the cofactorless (unbatched) equation, [S]B = R + [k]A', on the signature, with message as M, using the Ed25519 public key associated with key.
Let result be a boolean with the value true if the signature is valid and the value false otherwise.
Return result.
If usages contains a value which is not one of "sign" or "verify", then throw a SyntaxError.
Generate an Ed25519 key pair, as defined in [RFC8032], section 5.1.5.
Let algorithm be a new KeyAlgorithm object.
Set the name attribute of algorithm to "Ed25519".
Let publicKey be a new CryptoKey representing the public key of the generated key pair.
Set the [[type]] internal slot of publicKey to "public"
Set the [[algorithm]] internal slot of publicKey to algorithm.
Set the [[extractable]] internal slot of publicKey to true.
Set the [[usages]] internal slot of publicKey to be the usage intersection of usages and [ "verify" ].
Let privateKey be a new CryptoKey representing the private key of the generated key pair.
Set the [[algorithm]] internal slot of privateKey to algorithm.
Set the [[extractable]] internal slot of privateKey to extractable.
Set the [[usages]] internal slot of privateKey to be the usage intersection of usages and [ "sign" ].
Let result be a new CryptoKeyPair dictionary.
Set the publicKey attribute of result to be publicKey.
Set the privateKey attribute of result to be privateKey.
Return result.
Let keyData be the key data to be imported.
spki":
If usages contains a value which is not "verify" then throw a SyntaxError.
Let spki be the result of running the parse a subjectPublicKeyInfo algorithm over keyData.
If the algorithm object identifier field of the algorithm AlgorithmIdentifier field of spki is not equal to the id-Ed25519 object identifier defined in [RFC8410], then throw a DataError.
If the parameters field of the algorithm AlgorithmIdentifier field of spki is present, then throw a DataError.
Let publicKey be the Ed25519 public key identified by the subjectPublicKey field of spki.
Let key be a new CryptoKey that represents publicKey.
Set the [[type]] internal slot of key to "public"
Let algorithm be a new KeyAlgorithm.
Set the name attribute of algorithm to "Ed25519".
Set the [[algorithm]] internal slot of key to algorithm.
pkcs8":
If usages contains a value which is not "sign" then throw a SyntaxError.
Let privateKeyInfo be the result of running the parse a privateKeyInfo algorithm over keyData.
If the algorithm object identifier field of the privateKeyAlgorithm PrivateKeyAlgorithm field of privateKeyInfo is not equal to the id-Ed25519 object identifier defined in [RFC8410], then throw a DataError.
If the parameters field of the privateKeyAlgorithm PrivateKeyAlgorithmIdentifier field of privateKeyInfo is present, then throw a DataError.
Let curvePrivateKey be the result of performing the parse an ASN.1 structure algorithm, with data as the privateKey field of privateKeyInfo, structure as the ASN.1 CurvePrivateKey structure specified in Section 7 of [RFC8410], and exactData set to true.
Let key be a new CryptoKey that represents the Ed25519 private key identified by curvePrivateKey.
Let algorithm be a new KeyAlgorithm.
Set the name attribute of algorithm to "Ed25519".
Set the [[algorithm]] internal slot of key to algorithm.
jwk":
JsonWebKey dictionary:
Let jwk equal keyData.
If the d field is present and usages contains a value which is not "sign", or, if the d field is not present and usages contains a value which is not "verify" then throw a SyntaxError.
If the kty field of jwk is not "OKP", then throw a DataError.
If the crv field of jwk is not "Ed25519", then throw a DataError.
If the alg field of jwk is present and is not "Ed25519" or "EdDSA", then throw a DataError.
If usages is non-empty and the use field of jwk is present and is not "sig", then throw a DataError.
If the key_ops field of jwk is present, and is invalid according to the requirements of JSON Web Key [JWK], or it does not contain all of the specified usages values, then throw a DataError.
If the ext field of jwk is present and has the value false and extractable is true, then throw a DataError.
d field is present:
Let algorithm be a new instance of a KeyAlgorithm object.
Set the name attribute of algorithm to "Ed25519".
Set the [[algorithm]] internal slot of key to algorithm.
raw":
If usages contains a value which is not "verify" then throw a SyntaxError.
Let algorithm be a new KeyAlgorithm object.
Set the name attribute of algorithm to "Ed25519".
Let key be a new CryptoKey representing the key data provided in keyData.
Set the [[type]] internal slot of key to "public"
Set the [[algorithm]] internal slot of key to algorithm.
Return key
Let key be the CryptoKey to be exported.
If the underlying cryptographic key material represented by the [[handle]] internal slot of key cannot be accessed, then throw an OperationError.
spki":
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
Let data be an instance of the SubjectPublicKeyInfo ASN.1 structure defined in [RFC5280] with the following properties:
Set the algorithm field to an AlgorithmIdentifier ASN.1 type with the following properties:
Set the algorithm object identifier to the id-Ed25519 OID defined in [RFC8410].
Set the subjectPublicKey field to keyData.
Let result be the result of DER-encoding data.
pkcs8":
If the [[type]] internal slot of key is not "private", then throw an InvalidAccessError.
Let data be an instance of the PrivateKeyInfo ASN.1 structure defined in [RFC5208] with the following properties:
Set the version field to 0.
Set the privateKeyAlgorithm field to a PrivateKeyAlgorithmIdentifier ASN.1 type with the following properties:
Set the algorithm object identifier to the id-Ed25519 OID defined in [RFC8410].
Set the privateKey field to the result of DER-encoding a CurvePrivateKey ASN.1 type, as defined in Section 7 of [RFC8410], that represents the Ed25519 private key represented by the [[handle]] internal slot of key
Let result be the result of DER-encoding data.
jwk":
Let jwk be a new JsonWebKey dictionary.
Set the kty attribute of jwk to "OKP".
Set the alg attribute of jwk to "Ed25519".
Set the crv attribute of jwk to "Ed25519".
Set the x attribute of jwk according to the definition in Section 2 of [RFC8037].
Set the key_ops attribute of jwk to the usages attribute of key.
Set the ext attribute of jwk to the [[extractable]] internal slot of key.
Let result be jwk.
raw":
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
Let data be a byte sequence representing the Ed25519 public key represented by the [[handle]] internal slot of key.
Let result be data.
Return result.
This section is non-normative.
The "X25519" algorithm identifier is used to perform key agreement using the X25519 algorithm specified in [RFC7748].
The recognized algorithm name for this algorithm is "X25519".
If the [[type]] internal slot of key is not "private", then throw an InvalidAccessError.
Let publicKey be the public member of normalizedAlgorithm.
If the [[type]] internal slot of publicKey is not "public", then throw an InvalidAccessError.
If the name attribute of the [[algorithm]] internal slot of publicKey is not equal to the name property of the [[algorithm]] internal slot of key, then throw an InvalidAccessError.
Let secret be the result of performing the X25519 function specified in [RFC7748] Section 5 with key as the X25519 private key k and the X25519 public key represented by the [[handle]] internal slot of publicKey as the X25519 public key u.
If secret is the all-zero value, then throw a OperationError. This check must be performed in constant-time, as per [RFC7748] Section 6.1.
OperationError.
If usages contains an entry which is not "deriveKey" or "deriveBits" then throw a SyntaxError.
Generate an X25519 key pair, with the private key being 32 random bytes, and the public key being X25519(a, 9), as defined in [RFC7748], section 6.1.
Let algorithm be a new KeyAlgorithm object.
Set the name attribute of algorithm to "X25519".
Let publicKey be a new CryptoKey representing the public key of the generated key pair.
Set the [[type]] internal slot of publicKey to "public"
Set the [[algorithm]] internal slot of publicKey to algorithm.
Set the [[extractable]] internal slot of publicKey to true.
Set the [[usages]] internal slot of publicKey to be the empty list.
Let privateKey be a new CryptoKey representing the private key of the generated key pair.
Set the [[algorithm]] internal slot of privateKey to algorithm.
Set the [[extractable]] internal slot of privateKey to extractable.
Set the [[usages]] internal slot of privateKey to be the usage intersection of usages and [ "deriveKey", "deriveBits" ].
Let result be a new CryptoKeyPair dictionary.
Set the publicKey attribute of result to be publicKey.
Set the privateKey attribute of result to be privateKey.
Return result.
Let keyData be the key data to be imported.
spki":
If usages is not empty then throw a SyntaxError.
Let spki be the result of running the parse a subjectPublicKeyInfo algorithm over keyData.
If the algorithm object identifier field of the algorithm AlgorithmIdentifier field of spki is not equal to the id-X25519 object identifier defined in [RFC8410], then throw a DataError.
If the parameters field of the algorithm AlgorithmIdentifier field of spki is present, then throw a DataError.
Let publicKey be the X25519 public key identified by the subjectPublicKey field of spki.
Let key be a new CryptoKey that represents publicKey.
Set the [[type]] internal slot of key to "public"
Let algorithm be a new KeyAlgorithm.
Set the name attribute of algorithm to "X25519".
Set the [[algorithm]] internal slot of key to algorithm.
pkcs8":
If usages contains an entry which is not "deriveKey" or "deriveBits" then throw a SyntaxError.
Let privateKeyInfo be the result of running the parse a privateKeyInfo algorithm over keyData.
If the algorithm object identifier field of the privateKeyAlgorithm PrivateKeyAlgorithm field of privateKeyInfo is not equal to the id-X25519 object identifier defined in [RFC8410], then throw a DataError.
If the parameters field of the privateKeyAlgorithm PrivateKeyAlgorithmIdentifier field of privateKeyInfo is present, then throw a DataError.
Let curvePrivateKey be the result of performing the parse an ASN.1 structure algorithm, with data as the privateKey field of privateKeyInfo, structure as the ASN.1 CurvePrivateKey structure specified in Section 7 of [RFC8410], and exactData set to true.
Let key be a new CryptoKey that represents the X25519 private key identified by curvePrivateKey.
Let algorithm be a new KeyAlgorithm.
Set the name attribute of algorithm to "X25519".
Set the [[algorithm]] internal slot of key to algorithm.
jwk":
JsonWebKey dictionary:
Let jwk equal keyData.
If the d field is present and if usages contains an entry which is not "deriveKey" or "deriveBits" then throw a SyntaxError.
If the d field is not present and if usages is not empty then throw a SyntaxError.
If the kty field of jwk is not "OKP", then throw a DataError.
If the crv field of jwk is not "X25519", then throw a DataError.
If usages is non-empty and the use field of jwk is present and is not equal to "enc" then throw a DataError.
If the key_ops field of jwk is present, and is invalid according to the requirements of JSON Web Key [JWK], or it does not contain all of the specified usages values, then throw a DataError.
If the ext field of jwk is present and has the value false and extractable is true, then throw a DataError.
d field is present:
Let algorithm be a new instance of a KeyAlgorithm object.
Set the name attribute of algorithm to "X25519".
Set the [[algorithm]] internal slot of key to algorithm.
raw":
If usages is not empty then throw a SyntaxError.
Let algorithm be a new KeyAlgorithm object.
Set the name attribute of algorithm to "X25519".
Let key be a new CryptoKey representing the key data provided in keyData.
Set the [[type]] internal slot of key to "public"
Set the [[algorithm]] internal slot of key to algorithm.
Return key
Let key be the CryptoKey to be exported.
If the underlying cryptographic key material represented by the [[handle]] internal slot of key cannot be accessed, then throw an OperationError.
spki":
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
Let data be an instance of the SubjectPublicKeyInfo ASN.1 structure defined in [RFC5280] with the following properties:
Set the algorithm field to an AlgorithmIdentifier ASN.1 type with the following properties:
Set the algorithm object identifier to the id-X25519 OID defined in [RFC8410].
Set the subjectPublicKey field to keyData.
Let result be the result of DER-encoding data.
pkcs8":
If the [[type]] internal slot of key is not "private", then throw an InvalidAccessError.
Let data be an instance of the PrivateKeyInfo ASN.1 structure defined in [RFC5208] with the following properties:
Set the version field to 0.
Set the privateKeyAlgorithm field to a PrivateKeyAlgorithmIdentifier ASN.1 type with the following properties:
Set the algorithm object identifier to the id-X25519 OID defined in [RFC8410].
Set the privateKey field to the result of DER-encoding a CurvePrivateKey ASN.1 type, as defined in Section 7 of [RFC8410], that represents the X25519 private key represented by the [[handle]] internal slot of key
Let result be the result of DER-encoding data.
jwk":
Let jwk be a new JsonWebKey dictionary.
Set the kty attribute of jwk to "OKP".
Set the crv attribute of jwk to "X25519".
Set the x attribute of jwk according to the definition in Section 2 of [RFC8037].
Set the key_ops attribute of jwk to the usages attribute of key.
Set the ext attribute of jwk to the [[extractable]] internal slot of key.
Let result be jwk.
raw":
If the [[type]] internal slot of key is not "public", then throw an InvalidAccessError.
Let data be a byte sequence representing the X25519 public key represented by the [[handle]] internal slot of key.
Let result be data.
Return result.
This section is non-normative.
The "AES-CTR" algorithm identifier is used to perform encryption and decryption using AES in Counter mode, as described in [NIST-SP800-38A].
The recognized algorithm name for this algorithm is "AES-CTR".
dictionary AesCtrParams : Algorithm {
required BufferSource counter;
required [EnforceRange] octet length;
};The counter member contains the initial value of the counter block. counter MUST be 16 bytes (the AES block size). The counter bits are the rightmost length bits of the counter block. The rest of the counter block is for the nonce. The counter bits are incremented using the standard incrementing function specified in NIST SP 800-38A Appendix B.1: the counter bits are interpreted as a big-endian integer and incremented by one.
The length member contains the length, in bits, of the rightmost part of the counter block that is incremented.
dictionary AesKeyAlgorithm : KeyAlgorithm {
required unsigned short length;
};The length member represents the length, in bits, of the key.
dictionary AesKeyGenParams : Algorithm {
required [EnforceRange] unsigned short length;
};The length member represents the length, in bits, of the key.
dictionary AesDerivedKeyParams : Algorithm {
required [EnforceRange] unsigned short length;
};The length member represents the length, in bits, of the key.
If the counter member of normalizedAlgorithm does not have a length of 16 bytes, then throw an OperationError.
If the length member of normalizedAlgorithm is zero or is greater than 128, then throw an OperationError.
Let ciphertext be the result of performing the CTR Encryption operation described in Section 6.5 of [NIST-SP800-38A] using AES as the block cipher, the counter member of normalizedAlgorithm as the initial value of the counter block, the length member of normalizedAlgorithm as the input parameter m to the standard counter block incrementing function defined in Appendix B.1 of [NIST-SP800-38A] and plaintext as the input plaintext.
Return ciphertext.
If the counter member of normalizedAlgorithm does not have a length of 16 bytes, then throw an OperationError.
If the length member of normalizedAlgorithm is zero or is greater than 128, then throw an OperationError.
Let plaintext be the result of performing the CTR Decryption operation described in Section 6.5 of [NIST-SP800-38A] using AES as the block cipher, the counter member of normalizedAlgorithm as the initial value of the counter block, the length member of normalizedAlgorithm as the input parameter m to the standard counter block incrementing function defined in Appendix B.1 of [NIST-SP800-38A] and ciphertext as the input ciphertext.
Return plaintext.
If usages contains any entry which is not one of "encrypt", "decrypt", "wrapKey" or "unwrapKey", then throw a SyntaxError.
If the length member of normalizedAlgorithm is not equal to one of 128, 192 or 256, then throw an OperationError.
Generate an AES key of length equal to the length member of normalizedAlgorithm.
If the key generation step fails, then throw an OperationError.
Let key be a new CryptoKey object representing the generated AES key.
Let algorithm be a new AesKeyAlgorithm.
Set the name attribute of algorithm to "AES-CTR".
Set the length attribute of algorithm to equal the length member of normalizedAlgorithm.
Set the [[algorithm]] internal slot of key to algorithm.
Set the [[extractable]] internal slot of key to be extractable.
Set the [[usages]] internal slot of key to be usages.
Return key.
If usages contains an entry which is not one of "encrypt", "decrypt", "wrapKey" or "unwrapKey", then throw a SyntaxError.
raw":
Let data be keyData.
If the length in bits of data is not 128, 192 or 256 then throw a DataError.
jwk":
JsonWebKey dictionary:
Let jwk equal keyData.
If the kty field of jwk is not "oct", then throw a DataError.
If jwk does not meet the requirements of Section 6.4 of JSON Web Algorithms [JWA], then throw a DataError.
Let data be the byte sequence obtained by decoding the k field of jwk.
alg field of jwk is present, and is not "A128CTR", then throw a DataError.
alg field of jwk is present, and is not "A192CTR", then throw a DataError.
alg field of jwk is present, and is not "A256CTR", then throw a DataError.
DataError.
If usages is non-empty and the use field of jwk is present and is not "enc", then throw a DataError.
If the key_ops field of jwk is present, and is invalid according to the requirements of JSON Web Key [JWK] or does not contain all of the specified usages values, then throw a DataError.
If the ext field of jwk is present and has the value false and extractable is true, then throw a DataError.
NotSupportedError.
Let key be a new CryptoKey object representing an AES key with value data.
Let algorithm be a new AesKeyAlgorithm.
Set the name attribute of algorithm to "AES-CTR".
Set the length attribute of algorithm to the length, in bits, of data.
Set the [[algorithm]] internal slot of key to algorithm.
Return key.
If the underlying cryptographic key material represented by the [[handle]] internal slot of key cannot be accessed, then throw an OperationError.
raw":
Let data be a byte sequence containing the raw octets of the key represented by the [[handle]] internal slot of key.
Let result be data.
jwk":
Let jwk be a new JsonWebKey dictionary.
Set the kty attribute of jwk to the string "oct".
Set the k attribute of jwk to be a string containing the raw octets of the key represented by the [[handle]] internal slot of key, encoded according to Section 6.4 of JSON Web Algorithms [JWA].
Set the key_ops attribute of jwk to equal the [[usages]] internal slot of key.
Set the ext attribute of jwk to equal the [[extractable]] internal slot of key.
Let result be jwk.
Return result.
If the length member of normalizedDerivedKeyAlgorithm is not 128, 192 or 256, then throw a OperationError.
Return the length member of normalizedDerivedKeyAlgorithm.
This section is non-normative.
The "AES-CBC" algorithm identifier is used to perform encryption and decryption using AES in Cipher Block Chaining mode, as described in [NIST-SP800-38A].
When operating in CBC mode, messages that are not exact multiples of the AES block size (16 bytes) can be padded under a variety of padding schemes. In the Web Crypto API, the only padding mode that is supported is that of PKCS#7, as described by Section 10.3, step 2, of [RFC2315].
The recognized algorithm name for this algorithm is "AES-CBC".
dictionary AesCbcParams : Algorithm {
required BufferSource iv;
};The iv member represents the initialization vector. It MUST be 16 bytes.
If the iv member of normalizedAlgorithm does not have a length of 16 bytes, then throw an OperationError.
Let paddedPlaintext be the result of adding padding octets to plaintext according to the procedure defined in Section 10.3 of [RFC2315], step 2, with a value of k of 16.
Let ciphertext be the result of performing the CBC Encryption operation described in Section 6.2 of [NIST-SP800-38A] using AES as the block cipher, the iv member of normalizedAlgorithm as the IV input parameter and paddedPlaintext as the input plaintext.
Return ciphertext.
If the iv member of normalizedAlgorithm does not have a length of 16 bytes, then throw an OperationError.
If the length of ciphertext is zero or is not a multiple of 16 bytes, then throw an OperationError.
Let paddedPlaintext be the result of performing the CBC Decryption operation described in Section 6.2 of [NIST-SP800-38A] using AES as the block cipher, the iv member of normalizedAlgorithm as the IV input parameter and ciphertext as the input ciphertext.
Let p be the value of the last octet of paddedPlaintext.
If p is zero or greater than 16, or if any of the last p octets of paddedPlaintext have a value which is not p, then throw an OperationError.
Let plaintext be the result of removing p octets from the end of paddedPlaintext.
Return plaintext.
If usages contains any entry which is not one of "encrypt", "decrypt", "wrapKey" or "unwrapKey", then throw a SyntaxError.
If the length member of normalizedAlgorithm is not equal to one of 128, 192 or 256, then throw an OperationError.
Generate an AES key of length equal to the length member of normalizedAlgorithm.
If the key generation step fails, then throw an OperationError.
Let key be a new CryptoKey object representing the generated AES key.
Let algorithm be a new AesKeyAlgorithm.
Set the name attribute of algorithm to "AES-CBC".
Set the length attribute of algorithm to equal the length member of normalizedAlgorithm.
Set the [[algorithm]] internal slot of key to algorithm.
Set the [[extractable]] internal slot of key to be extractable.
Set the [[usages]] internal slot of key to be usages.
Return key.
If usages contains an entry which is not one of "encrypt", "decrypt", "wrapKey" or "unwrapKey", then throw a SyntaxError.
raw":
Let data be keyData.
If the length in bits of data is not 128, 192 or 256 then throw a DataError.
jwk":
JsonWebKey dictionary:
Let jwk equal keyData.
If the kty field of jwk is not "oct", then throw a DataError.
If jwk does not meet the requirements of Section 6.4 of JSON Web Algorithms [JWA], then throw a DataError.
Let data be the byte sequence obtained by decoding the k field of jwk.
alg field of jwk is present, and is not "A128CBC", then throw a DataError.
alg field of jwk is present, and is not "A192CBC", then throw a DataError.
alg field of jwk is present, and is not "A256CBC", then throw a DataError.
DataError.
If usages is non-empty and the use field of jwk is present and is not "enc", then throw a DataError.
If the key_ops field of jwk is present, and is invalid according to the requirements of JSON Web Key [JWK] or does not contain all of the specified usages values, then throw a DataError.
If the ext field of jwk is present and has the value false and extractable is true, then throw a DataError.
NotSupportedError
Let key be a new CryptoKey object representing an AES key with value data.
Let algorithm be a new AesKeyAlgorithm.
Set the name attribute of algorithm to "AES-CBC".
Set the length attribute of algorithm to the length, in bits, of data.
Set the [[algorithm]] internal slot of key to algorithm.
Return key.
If the underlying cryptographic key material represented by the [[handle]] internal slot of key cannot be accessed, then throw an OperationError.
raw":
Let data be a byte sequence containing the raw octets of the key represented by the [[handle]] internal slot of key.
Let result be data.
jwk":
Let jwk be a new JsonWebKey dictionary.
Set the kty attribute of jwk to the string "oct".
Set the k attribute of jwk to be a string containing the raw octets of the key represented by the [[handle]] internal slot of key, encoded according to Section 6.4 of JSON Web Algorithms [JWA].
Set the key_ops attribute of jwk to equal the usages attribute of key.
Set the ext attribute of jwk to equal the [[extractable]] internal slot of key.
Let result be jwk.
Return result.
If the length member of normalizedDerivedKeyAlgorithm is not 128, 192 or 256, then throw an OperationError.
Return the length member of normalizedDerivedKeyAlgorithm.
This section is non-normative.
The "AES-GCM" algorithm identifier is used to perform authenticated encryption and decryption using AES in Galois/Counter Mode mode, as described in [NIST-SP800-38D].
The recognized algorithm name for this algorithm is "AES-GCM".
dictionary AesGcmParams : Algorithm {
required BufferSource iv;
BufferSource additionalData;
[EnforceRange] octet tagLength;
};The iv member represents the initialization vector to use. May be up to 2^64-1 bytes long.
The additionalData member represents the additional authentication data to include.
The tagLength member represents the desired length of the authentication tag. May be 0 - 128.
If plaintext has a length greater than 2^39 - 256 bytes, then throw an OperationError.
If the iv member of normalizedAlgorithm has a length greater than 2^64 - 1 bytes, then throw an OperationError.
If the additionalData member of normalizedAlgorithm is present and has a length greater than 2^64 - 1 bytes, then throw an OperationError.
tagLength member of normalizedAlgorithm is not present:
tagLength member of normalizedAlgorithm is one of 32, 64, 96, 104, 112, 120 or 128:
tagLength member of normalizedAlgorithm
OperationError.
Let additionalData be the additionalData member of normalizedAlgorithm if present or an empty byte sequence otherwise.
Let C and T be the outputs that result from performing the Authenticated Encryption Function described in Section 7.1 of [NIST-SP800-38D] using AES as the block cipher, the iv member of normalizedAlgorithm as the IV input parameter, additionalData as the A input parameter, tagLength as the t pre-requisite and plaintext as the input plaintext.
Let ciphertext be equal to C | T, where '|' denotes concatenation.
Return ciphertext.
tagLength member of normalizedAlgorithm is not present:
tagLength member of normalizedAlgorithm is one of 32, 64, 96, 104, 112, 120 or 128:
tagLength member of normalizedAlgorithm
OperationError.
If ciphertext has a length in bits less than tagLength, then throw an OperationError.
If the iv member of normalizedAlgorithm has a length greater than 2^64 - 1 bytes, then throw an OperationError.
If the additionalData member of normalizedAlgorithm is present and has a length greater than 2^64 - 1 bytes, then throw an OperationError.
Let tag be the last tagLength bits of ciphertext.
Let actualCiphertext be the result of removing the last tagLength bits from ciphertext.
Let additionalData be the additionalData member of normalizedAlgorithm if present or an empty byte sequence otherwise.
Perform the Authenticated Decryption Function described in Section 7.2 of [NIST-SP800-38D] using AES as the block cipher, the iv member of normalizedAlgorithm as the IV input parameter, additionalData as the A input parameter, tagLength as the t pre-requisite, actualCiphertext as the input ciphertext, C and tag as the authentication tag, T.
OperationError
Return plaintext.
If usages contains any entry which is not one of "encrypt", "decrypt", "wrapKey" or "unwrapKey", then throw a SyntaxError.
If the length member of normalizedAlgorithm is not equal to one of 128, 192 or 256, then throw an OperationError.
Generate an AES key of length equal to the length member of normalizedAlgorithm.
If the key generation step fails, then throw an OperationError.
Let key be a new CryptoKey object representing the generated AES key.
Let algorithm be a new AesKeyAlgorithm.
Set the name attribute of algorithm to "AES-GCM".
Set the length attribute of algorithm to equal the length member of normalizedAlgorithm.
Set the [[algorithm]] internal slot of key to algorithm.
Set the [[extractable]] internal slot of key to be extractable.
Set the [[usages]] internal slot of key to be usages.
Return key.
If usages contains an entry which is not one of "encrypt", "decrypt", "wrapKey" or "unwrapKey", then throw a SyntaxError.
raw":
Let data be keyData.
If the length in bits of data is not 128, 192 or 256 then throw a DataError.
jwk":
JsonWebKey dictionary:
Let jwk equal keyData.
If the kty field of jwk is not "oct", then throw a DataError.
If jwk does not meet the requirements of Section 6.4 of JSON Web Algorithms [JWA], then throw a DataError.
Let data be the byte sequence obtained by decoding the k field of jwk.
alg field of jwk is present, and is not "A128GCM", then throw a DataError.
alg field of jwk is present, and is not "A192GCM", then throw a DataError.
alg field of jwk is present, and is not "A256GCM", then throw a DataError.
DataError.
If usages is non-empty and the use field of jwk is present and is not "enc", then throw a DataError.
If the key_ops field of jwk is present, and is invalid according to the requirements of JSON Web Key [JWK] or does not contain all of the specified usages values, then throw a DataError.
If the ext field of jwk is present and has the value false and extractable is true, then throw a DataError.
NotSupportedError.
Let key be a new CryptoKey object representing an AES key with value data.
Let algorithm be a new AesKeyAlgorithm.
Set the name attribute of algorithm to "AES-GCM".
Set the length attribute of algorithm to the length, in bits, of data.
Set the [[algorithm]] internal slot of key to algorithm.
Return key.
If the underlying cryptographic key material represented by the [[handle]] internal slot of key cannot be accessed, then throw an OperationError.
raw":
Let data be a byte sequence containing the raw octets of the key represented by the [[handle]] internal slot of key.
Let result be data.
jwk":
Let jwk be a new JsonWebKey dictionary.
Set the kty attribute of jwk to the string "oct".
Set the k attribute of jwk to be a string containing the raw octets of the key represented by the [[handle]] internal slot of key, encoded according to Section 6.4 of JSON Web Algorithms [JWA].
Set the key_ops attribute of jwk to equal the usages attribute of key.
Set the ext attribute of jwk to equal the [[extractable]] internal slot of key.
Let result be jwk.
Return result.
If the length member of normalizedDerivedKeyAlgorithm is not 128, 192 or 256, then throw an OperationError.
Return the length member of normalizedDerivedKeyAlgorithm.
This section is non-normative.
The "AES-KW" algorithm identifier is used to perform key wrapping using AES, as described in [RFC3394].
The recognized algorithm name for this algorithm is "AES-KW".
If plaintext is not a multiple of 64 bits in length, then throw an OperationError.
Let ciphertext be the result of performing the Key Wrap operation described in Section 2.2.1 of [RFC3394] with plaintext as the plaintext to be wrapped and using the default Initial Value defined in Section 2.2.3.1 of the same document.
Return ciphertext.
Let plaintext be the result of performing the Key Unwrap operation described in Section 2.2.2 of [RFC3394] with ciphertext as the input ciphertext and using the default Initial Value defined in Section 2.2.3.1 of the same document.
If the Key Unwrap operation returns an error, then throw an OperationError.
Return plaintext.
If usages contains any entry which is not one of "wrapKey" or "unwrapKey", then throw a SyntaxError.
If the length property of normalizedAlgorithm is not equal to one of 128, 192 or 256, then throw an OperationError.
Generate an AES key of length equal to the length member of normalizedAlgorithm.
If the key generation step fails, then throw an OperationError.
Let key be a new CryptoKey object representing the generated AES key.
Let algorithm be a new AesKeyAlgorithm.
Set the name attribute of algorithm to "AES-KW".
Set the length attribute of algorithm to equal the length property of normalizedAlgorithm.
Set the [[algorithm]] internal slot of key to algorithm.
Set the [[extractable]] internal slot of key to be extractable.
Set the [[usages]] internal slot of key to be usages.
Return key.
If usages contains an entry which is not one of "wrapKey" or "unwrapKey", then throw a SyntaxError.
raw":
Let data be keyData.
If the length in bits of data is not 128, 192 or 256 then throw a DataError.
jwk":
JsonWebKey dictionary:
Let jwk equal keyData.
If the kty field of jwk is not "oct", then throw a DataError.
If jwk does not meet the requirements of Section 6.4 of JSON Web Algorithms [JWA], then throw a DataError.
Let data be the byte sequence obtained by decoding the k field of jwk.
alg field of jwk is present, and is not "A128KW", then throw a DataError.
alg field of jwk is present, and is not "A192KW", then throw a DataError.
alg field of jwk is present, and is not "A256KW", then throw a DataError.
DataError.
If usages is non-empty and the use field of jwk is present and is not "enc", then throw a DataError.
If the key_ops field of jwk is present, and is invalid according to the requirements of JSON Web Key [JWK] or does not contain all of the specified usages values, then throw a DataError.
If the ext field of jwk is present and has the value false and extractable is true, then throw a DataError.
NotSupportedError.
Let key be a new CryptoKey representing an AES key with value data.
Let algorithm be a new AesKeyAlgorithm.
Set the name attribute of algorithm to "AES-KW".
Set the length attribute of algorithm to the length, in bits, of data.
Set the [[algorithm]] internal slot of key to algorithm.
Return key.
If the underlying cryptographic key material represented by the [[handle]] internal slot of key cannot be accessed, then throw an OperationError.
raw":
Let data be a byte sequence containing the raw octets of the key represented by the [[handle]] internal slot of key.
Let result be data.
jwk":
Let jwk be a new JsonWebKey dictionary.
Set the kty attribute of jwk to the string "oct".
Set the k attribute of jwk to be a string containing the raw octets of the key represented by the [[handle]] internal slot of key, encoded according to Section 6.4 of JSON Web Algorithms [JWA].
Set the key_ops attribute of jwk to equal the usages attribute of key.
Set the ext attribute of jwk to equal the [[extractable]] internal slot of key.
Let result be jwk.
Return result.
If the length member of normalizedDerivedKeyAlgorithm is not 128, 192 or 256, then throw an OperationError.
Return the length member of normalizedDerivedKeyAlgorithm.
This section is non-normative.
The HMAC algorithm calculates and verifies hash-based message authentication codes according to [FIPS-198-1] using the SHA hash functions defined in this specification.
Other specifications may specify the use of additional hash algorithms with HMAC. Such specifications must define the digest operation for the additional hash algorithms and key import steps and key export steps for HMAC.
The recognized algorithm name for this algorithm is "HMAC".
dictionary HmacImportParams : Algorithm {
required HashAlgorithmIdentifier hash;
[EnforceRange] unsigned long length;
};The hash member represents the inner hash function to use.
The length member represent the length (in bits) of the key.
dictionary HmacKeyAlgorithm : KeyAlgorithm {
required KeyAlgorithm hash;
required unsigned long length;
};The hash member represents the inner hash function to use.
The length member represent the length (in bits) of the key.
dictionary HmacKeyGenParams : Algorithm {
required HashAlgorithmIdentifier hash;
[EnforceRange] unsigned long length;
};The hash member represents the inner hash function to use.
The length member represent the length (in bits) of the key to generate. If unspecified, the recommended length will be used, which is the size of the associated hash function's block size.
Let mac be the result of performing the MAC Generation operation described in Section 4 of [FIPS-198-1] using the key represented by the [[handle]] internal slot of key, the hash function identified by the hash attribute of the [[algorithm]] internal slot of key and message as the input data text.
Return mac.
Let mac be the result of performing the MAC Generation operation described in Section 4 of [FIPS-198-1] using the key represented by the [[handle]] internal slot of key, the hash function identified by the hash attribute of the [[algorithm]] internal slot of key and message as the input data text.
Return true if mac is equal to signature and false otherwise.
If usages contains any entry which is not "sign" or "verify", then throw a SyntaxError.
length member of normalizedAlgorithm is not present:
hash member of normalizedAlgorithm.
length member of normalizedAlgorithm is non-zero:
length member of normalizedAlgorithm.
OperationError.
Generate a key of length length bits.
If the key generation step fails, then throw an OperationError.
Let key be a new CryptoKey object representing the generated key.
Let algorithm be a new HmacKeyAlgorithm.
Set the name attribute of algorithm to "HMAC".
Set the length attribute of algorithm to length.
Let hash be a new KeyAlgorithm.
Set the name attribute of hash to equal the name member of the hash member of normalizedAlgorithm.
Set the hash attribute of algorithm to hash.
Set the [[algorithm]] internal slot of key to algorithm.
Set the [[extractable]] internal slot of key to be extractable.
Set the [[usages]] internal slot of key to be usages.
Return key.
Let keyData be the key data to be imported.
If usages contains an entry which is not "sign" or "verify", then throw a SyntaxError.
Let hash be a new KeyAlgorithm.
raw":
Let data be keyData.
Set hash to equal the hash member of normalizedAlgorithm.
jwk":
JsonWebKey dictionary:
Let jwk equal keyData.
If the kty field of jwk is not "oct", then throw a DataError.
If jwk does not meet the requirements of Section 6.4 of JSON Web Algorithms [JWA], then throw a DataError.
Let data be the byte sequence obtained by decoding the k field of jwk.
Set the hash to equal the hash member of normalizedAlgorithm.
name attribute of hash is "SHA-1":
alg field of jwk is present and is not "HS1", then throw a DataError.
name attribute of hash is "SHA-256":
alg field of jwk is present and is not "HS256", then throw a DataError.
name attribute of hash is "SHA-384":
alg field of jwk is present and is not "HS384", then throw a DataError.
name attribute of hash is "SHA-512":
alg field of jwk is present and is not "HS512", then throw a DataError.
name attribute of hash is defined in another applicable specification:
If usages is non-empty and the use field of jwk is present and is not "sign", then throw a DataError.
If the key_ops field of jwk is present, and is invalid according to the requirements of JSON Web Key [JWK] or does not contain all of the specified usages values, then throw a DataError.
If the ext field of jwk is present and has the value false and extractable is true, then throw a DataError.
NotSupportedError.
Let length be the length in bits of data.
length member of normalizedAlgorithm is present:
Let key be a new CryptoKey object representing an HMAC key with the first length bits of data.
Let algorithm be a new HmacKeyAlgorithm.
Set the name attribute of algorithm to "HMAC".
Set the length attribute of algorithm to length.
Set the hash attribute of algorithm to hash.
Set the [[algorithm]] internal slot of key to algorithm.
Return key.
If the underlying cryptographic key material represented by the [[handle]] internal slot of key cannot be accessed, then throw an OperationError.
Let bits be the raw bits of the key represented by the [[handle]] internal slot of key.
Let data be a byte sequence containing bits.
raw":
Let result be data.
jwk":
Let jwk be a new JsonWebKey dictionary.
Set the kty attribute of jwk to the string "oct".
Set the k attribute of jwk to be a string containing data, encoded according to Section 6.4 of JSON Web Algorithms [JWA].
Let algorithm be the [[algorithm]] internal slot of key.
Let hash be the hash attribute of algorithm.
name attribute of hash is "SHA-1":
alg attribute of jwk to the string "HS1".
name attribute of hash is "SHA-256":
alg attribute of jwk to the string "HS256".
name attribute of hash is "SHA-384":
alg attribute of jwk to the string "HS384".
name attribute of hash is "SHA-512":
alg attribute of jwk to the string "HS512".
name attribute of hash is defined in another applicable specification:
Perform any key export steps defined by other applicable specifications, passing format and key and obtaining alg.
Set the alg attribute of jwk to alg.
Set the key_ops attribute of jwk to equal the usages attribute of key.
Set the ext attribute of jwk to equal the [[extractable]] internal slot of key.
Let result be jwk.
Return result.
length member of normalizedDerivedKeyAlgorithm is not present:
Let length be the block size in bits of the hash function identified by the hash member of normalizedDerivedKeyAlgorithm.
length member of normalizedDerivedKeyAlgorithm is non-zero:
length member of normalizedDerivedKeyAlgorithm.
TypeError.
Return length.
This section is non-normative.
This describes the SHA-1 and SHA-2 families, as specified by [FIPS-180-4].
The recognized algorithm names are "SHA-1", "SHA-256", "SHA-384", and "SHA-512" for the respective SHA algorithms.
name member of normalizedAlgorithm is a cases-sensitive string match for "SHA-1":
name member of normalizedAlgorithm is a cases-sensitive string match for "SHA-256":
name member of normalizedAlgorithm is a cases-sensitive string match for "SHA-384":
name member of normalizedAlgorithm is a cases-sensitive string match for "SHA-512":
If performing the operation results in an error, then throw an OperationError.
Return result.
This section is non-normative.
The "HKDF" algorithm identifier is used to perform key derivation using the extraction-then-expansion approach described in [RFC5869] and using the SHA hash functions defined in this specification.
Other specifications may specify the use of additional hash algorithms with HKDF. Such specifications must define the digest operation for the additional hash algorithms.
The recognized algorithm name for this algorithm is "HKDF".
dictionary HkdfParams : Algorithm {
required HashAlgorithmIdentifier hash;
required BufferSource salt;
required BufferSource info;
};The hash member represents the algorithm to use with HMAC (e.g.: SHA-256).
The salt member represents the salt used in the extract step.
The info member represents application specific context for the derived keying material.
If length is null or is not a multiple of 8, then throw an OperationError.
Let keyDerivationKey be the secret represented by the [[handle]] internal slot of key.
Let result be the result of performing the HKDF extract and then the HKDF expand step described in Section 2 of [RFC5869] using:
If the key derivation operation fails, then throw an OperationError.
Return result.
Let keyData be the key data to be imported.
raw":
If usages contains a value that is not "deriveKey" or "deriveBits", then throw a SyntaxError.
If extractable is not false, then throw a SyntaxError.
Let key be a new CryptoKey representing the key data provided in keyData.
Let algorithm be a new KeyAlgorithm object.
Set the name attribute of algorithm to "HKDF".
Set the [[algorithm]] internal slot of key to algorithm.
Return key.
NotSupportedError.
Return null.
This section is non-normative.
The "PBKDF2" algorithm identifier is used to perform key derivation using the PKCS#5 password-based key derivation function version 2, as defined in [RFC8018] using HMAC as the pseudo-random function, using the SHA hash functions defined in this specification.
Other specifications may specify the use of additional hash algorithms with PBKDF2. Such specifications must define the digest operation for the additional hash algorithms.
The recognized algorithm name for this algorithm is "PBKDF2".
dictionary Pbkdf2Params : Algorithm {
required BufferSource salt;
required [EnforceRange] unsigned long iterations;
required HashAlgorithmIdentifier hash;
};The Pbkdf2Params dictionary has a salt member, a iterations member, and a hash member.
If length is null or is not a multiple of 8, then throw an OperationError.
If the iterations member of normalizedAlgorithm is zero, then throw an OperationError.
If length is zero, return an empty byte sequence.
Let prf be the MAC Generation function described in Section 4 of [FIPS-198-1] using the hash function described by the hash member of normalizedAlgorithm.
Let result be the result of performing the PBKDF2 operation defined in Section 5.2 of [RFC8018] using prf as the pseudo-random function, PRF, the password represented by the [[handle]] internal slot of key as the password, P, the salt attribute of normalizedAlgorithm as the salt, S, the value of the iterations attribute of normalizedAlgorithm as the iteration count, c, and length divided by 8 as the intended key length, dkLen.
If the key derivation operation fails, then throw an OperationError.
Return result.
If format is not "raw", throw a NotSupportedError
If usages contains a value that is not "deriveKey" or "deriveBits", then throw a SyntaxError.
If extractable is not false, then throw a SyntaxError.
Let key be a new CryptoKey representing keyData.
Let algorithm be a new KeyAlgorithm object.
Set the name attribute of algorithm to "PBKDF2".
Set the [[algorithm]] internal slot of key to algorithm.
Return key.
Return null.
This example generates two X25519 key pairs, one for Alice and one for Bob, performs a key agreement between them, derives a 256-bit AES-GCM key from the result using HKDF with SHA-256, and encrypts and decrypts some data with it.
const alice_x25519_key = await crypto.subtle.generateKey('X25519', false , ['deriveKey']);
const alice_private_key = alice_x25519_key.privateKey;
const bob_x25519_key = await crypto.subtle.generateKey('X25519', false , ['deriveKey']);
const bob_public_key = bob_x25519_key.publicKey;
const alice_x25519_params = { name: 'X25519', public: bob_public_key };
const alice_shared_key = await crypto.subtle.deriveKey(alice_x25519_params, alice_private_key, 'HKDF', false , ['deriveKey']);
const salt = crypto.getRandomValues(new Uint8Array(32));
const info = new TextEncoder().encode('X25519 key agreement for an AES-GCM-256 key');
const hkdf_params = { name: 'HKDF', hash: 'SHA-256', salt, info };
const gcm_params = { name: 'AES-GCM', length: 256 };
const alice_symmetric_key = await crypto.subtle.deriveKey(hkdf_params, alice_shared_key, gcm_params, false , ['encrypt', 'decrypt']);
const iv = crypto.getRandomValues(new Uint8Array(12));
const message = new TextEncoder().encode('Hi Bob!');
const encrypted = await crypto.subtle.encrypt({ ...gcm_params, iv }, alice_symmetric_key, message);
const alice_public_key = alice_x25519_key.publicKey;
const bob_private_key = bob_x25519_key.privateKey;
const bob_x25519_params = { name: 'X25519', public: alice_public_key };
const bob_shared_key = await crypto.subtle.deriveKey(bob_x25519_params, bob_private_key, 'HKDF', false , ['deriveKey']);
const bob_symmetric_key = await crypto.subtle.deriveKey(hkdf_params, bob_shared_key, gcm_params, false , ['encrypt', 'decrypt']);
const decrypted = await crypto.subtle.decrypt({ ...gcm_params, iv }, bob_symmetric_key, encrypted);
const decrypted_message = new TextDecoder().decode(decrypted);const data = new TextEncoder().encode('Hello, world!');
const key = await crypto.subtle.generateKey('Ed25519', false, ['sign']);
const signature = await crypto.subtle.sign('Ed25519', key.privateKey, data);const data = new TextEncoder().encode('Hello, world!');
const aesAlgorithmKeyGen = {
name: 'AES-GCM',
length: 256
};
const aesAlgorithmEncrypt = {
name: 'AES-GCM',
iv: crypto.getRandomValues(new Uint8Array(16))
};
const key = await crypto.subtle.generateKey(aesAlgorithmKeyGen, false, ['encrypt']);
const encrypted = await crypto.subtle.encrypt(aesAlgorithmEncrypt, key, data);const filename = `${crypto.randomUUID()}.txt`;This section registers the following algorithm identifiers in the IANA JSON Web Signature and Encryption Algorithms Registry for use with JSON Web Key. Note that the 'Implementation Requirements' field in the template refers to use with JSON Web Signature and JSON Web Encryption specifically, in which case use of unauthenticated encryption is prohibited.
Thanks are due especially to Ryan Sleevi, the original author and editor, and Mark Watson, the former editor of this document.
Thanks to Adam Barth, Alex Russell, Ali Asad, Arun Ranganathan, Brian Smith, Brian Warner, Channy Yun, Charles Engelke, Eric Roman, Glenn Adams, Jim Schaad, Kai Engert, Michael Hutchinson, Michael B. Jones, Nick Van den Bleeken, Richard Barnes, Ryan Hurst, Tim Taubert, Vijay Bharadwaj, Virginie Galindo, and Wan-Teh Chang for their technical feedback and assistance.
Thanks to the W3C Web Cryptography WG, and to participants on the public-webcrypto@w3.org mailing list.
The W3C would like to thank the Northrop Grumman Cybersecurity Research Consortium for supporting W3C/MIT.
The getRandomValues method in the Crypto interface was originally proposed by Adam Barth to the WHATWG.
This section is non-normative.
Refer to algorithm-specific sections for the normative requirements of importing and exporting JWK.
JSON Web Key AlgorithmIdentifier{ kty: "RSA",
alg: "RS1" }{ name: "RSASSA-PKCS1-v1_5",
hash: { name: "SHA-1" }
}{ kty: "RSA",
alg: "RS256" }{ name: "RSASSA-PKCS1-v1_5",
hash: { name: "SHA-256" }
}{ kty: "RSA",
alg: "RS384" }{ name: "RSASSA-PKCS1-v1_5",
hash: { name: "SHA-384" }
}{ kty: "RSA",
alg: "RS512" }{ name: "RSASSA-PKCS1-v1_5",
hash: { name: "SHA-512" }
}{ kty: "RSA",
alg: "PS256" }{ name: "RSA-PSS",
hash: { name: "SHA-256" }
}{ kty: "RSA",
alg: "PS384" }{ name: "RSA-PSS",
hash: { name: "SHA-384" }
}{ kty: "RSA",
alg: "PS512" }{ name: "RSA-PSS",
hash: { name: "SHA-512" }
}{ kty: "RSA",
alg: "RSA-OAEP" }{ name: "RSA-OAEP",
hash: { name: "SHA-1" }
}{ kty: "RSA",
alg: "RSA-OAEP-256" }{ name: "RSA-OAEP",
hash: { name: "SHA-256" }
}{ kty: "RSA",
alg: "RSA-OAEP-384" }{ name: "RSA-OAEP",
hash: { name: "SHA-384" }
}{ kty: "RSA",
alg: "RSA-OAEP-512" }{ name: "RSA-OAEP",
hash: { name: "SHA-512" }
}{ kty: "EC",
alg: "ES256" }{ name: "ECDSA",
namedCurve: "P-256",
hash: { name: "SHA-256" }
}{ kty: "EC",
alg: "ES384" }{ name: "ECDSA",
namedCurve: "P-384",
hash: { name: "SHA-384" }
}{ kty: "EC",
alg: "ES512" }{ name: "ECDSA",
namedCurve: "P-521",
hash: { name: "SHA-512" }
}{ kty: "OKP",
crv: "Ed25519",
alg: "Ed25519" }{ name: "Ed25519" }{ kty: "OKP",
crv: "X25519" }{ name: "X25519" }{ kty: "oct",
alg: "A128CTR" }{ name: "AES-CTR",
length: 128 }{ kty: "oct",
alg: "A192CTR" }{ name: "AES-CTR",
length: 192 }{ kty: "oct",
alg: "A256CTR" }{ name: "AES-CTR",
length: 256 }{ kty: "oct",
alg: "A128CBC" }{ name: "AES-CBC",
length: 128 }{ kty: "oct",
alg: "A192CBC" }{ name: "AES-CBC",
length: 192 }{ kty: "oct",
alg: "A256CBC" }{ name: "AES-CBC",
length: 256 }{ kty: "oct",
alg: "A128KW" }{ name: "AES-KW",
length: 128 }{ kty: "oct",
alg: "A192KW" }{ name: "AES-KW",
length: 192 }{ kty: "oct",
alg: "A256KW" }{ name: "AES-KW",
length: 256 }{ kty: "oct",
alg: "A128GCM" }{ name: "AES-GCM",
length: 128 }{ kty: "oct",
alg: "A192GCM" }{ name: "AES-GCM",
length: 192 }{ kty: "oct",
alg: "A256GCM" }{ name: "AES-GCM",
length: 256 }{ kty: "oct",
alg: "A128GCMKW" }{ name: "AES-GCM",
length: 128 }{ kty: "oct",
alg: "A192GCMKW" }{ name: "AES-GCM",
length: 192 }{ kty: "oct",
alg: "A256GCMKW" }{ name: "AES-GCM",
length: 256 }{ kty: "oct",
alg: "HS1" }{ name: "HMAC",
hash: { name: "SHA-1" }
}{ kty: "oct",
alg: "HS256" }{ name: "HMAC",
hash: { name: "SHA-256" }
}{ kty: "oct",
alg: "HS384" }{ name: "HMAC",
hash: { name: "SHA-384" }
}{ kty: "oct",
alg: "HS512" }{ name: "HMAC",
hash: "SHA-512" }This section is non-normative.
Refer to algorithm-specific sections for the normative requirements of importing and exporting SPKI.
Algorithm OID subjectPublicKey ASN.1 structure AlgorithmIdentifier Reference rsaEncryption (1.2.840.113549.1.1.1) RSAPublicKey "RSASSA-PKCS1-v1_5", "RSA-PSS", or "RSA-OAEP" [RFC3447] id-ecPublicKey (1.2.840.10045.2.1) ECPoint "ECDH" or "ECDSA" [RFC5480] id-Ed25519 (1.3.101.112) BIT STRING "Ed25519" [RFC8410] id-X25519 (1.3.101.110) BIT STRING "X25519" [RFC8410]
Note
The object identifiers used by this specification do not include information about the specific algorithm and hash that the key is intended to be used with. If this is required, it's recommended that the "jwk" key format is used instead.
This section is non-normative.
Refer to algorithm-specific sections for the normative requirements of importing and exporting PKCS#8 PrivateKeyInfo.
privateKeyAlgorithm privateKey format AlgorithmIdentifier Reference rsaEncryption (1.2.840.113549.1.1.1) RSAPrivateKey "RSASSA-PKCS1-v1_5", "RSA-PSS", or "RSA-OAEP" [RFC3447] id-ecPublicKey (1.2.840.10045.2.1) ECPrivateKey "ECDH" or "ECDSA" [RFC5480] id-Ed25519 (1.3.101.112) CurvePrivateKey "Ed25519" [RFC8410] id-X25519 (1.3.101.110) CurvePrivateKey "X25519" [RFC8410]
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
Referenced in:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4