Back to Jose

Function: importSPKI()

docs/key/import/functions/importSPKI.md

6.2.21.8 KB
Original Source

Function: importSPKI()

šŸ’— Help the project

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.

ā–ø importSPKI(spki, alg, options?): Promise<CryptoKey>

Imports a PEM-encoded SPKI string as a CryptoKey.

[!NOTE]
The OID id-RSASSA-PSS (1.2.840.113549.1.1.10) is not supported in Web Cryptography API, use the OID rsaEncryption (1.2.840.113549.1.1.1) instead for all RSA algorithms.

This function is exported (as a named export) from the main 'jose' module entry point as well as from its subpath export 'jose/key/import'.

Parameters

ParameterTypeDescription
spkistringPEM-encoded SPKI string
algstringJSON Web Algorithm identifier to be used with the imported key. See Algorithm Key Requirements.
options?KeyImportOptions-

Returns

Promise<CryptoKey>

Example

js
const algorithm = 'ES256'
const spki = `-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEFlHHWfLk0gLBbsLTcuCrbCqoHqmM
YJepMC+Q+Dd6RBmBiA41evUsNMwLeN+PNFqib+xwi9JkJ8qhZkq8Y/IzGg==
-----END PUBLIC KEY-----`
const ecPublicKey = await jose.importSPKI(spki, algorithm)