SubtleCrypto: phương thức exportKey()
Baseline
Widely available
*
This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.
* Some parts of this feature may have varying levels of support.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Note: This feature is available in Web Workers.
Phương thức exportKey() của giao diện SubtleCrypto xuất một khóa: nghĩa là, nó nhận làm đầu vào một đối tượng CryptoKey và cung cấp cho bạn khóa ở định dạng bên ngoài, có thể di chuyển.
Để xuất một khóa, khóa phải có CryptoKey.extractable được đặt thành true.
Khóa có thể được xuất ở nhiều định dạng: xem Các định dạng được hỗ trợ trong trang SubtleCrypto.importKey() để biết chi tiết.
Khóa không được xuất ở định dạng mã hóa: để mã hóa khóa khi xuất chúng, sử dụng API SubtleCrypto.wrapKey() thay thế.
Cú pháp
exportKey(format, key)
Tham số
format-
Một chuỗi mô tả định dạng dữ liệu mà khóa sẽ được xuất. Nó có thể là một trong các giá trị sau:
raw: Định dạng Raw.pkcs8: Định dạng PKCS #8.spki: Định dạng SubjectPublicKeyInfo.jwk: Định dạng JSON Web Key.
key-
CryptoKeycần xuất.
Giá trị trả về
Một Promise.
- Nếu
formatlàjwk, thì promise được fulfill với một đối tượng JSON chứa khóa. - Nếu không, promise được fulfill với một
ArrayBufferchứa khóa.
Ngoại lệ
Promise bị reject khi gặp một trong các ngoại lệ sau:
InvalidAccessErrorDOMException-
Ném lên khi cố xuất một khóa không thể trích xuất.
NotSupportedDOMException-
Ném lên khi cố xuất ở định dạng không xác định.
TypeError-
Ném lên khi cố sử dụng một định dạng không hợp lệ.
Ví dụ
Note: Bạn có thể thử các ví dụ hoạt động trên GitHub.
Xuất Raw
Ví dụ này xuất một khóa AES dưới dạng ArrayBuffer chứa các byte cho khóa. Xem mã đầy đủ trên GitHub.
/*
Xuất khóa đã cho và ghi vào không gian "exported-key".
*/
async function exportCryptoKey(key) {
const exported = await window.crypto.subtle.exportKey("raw", key);
const exportedKeyBuffer = new Uint8Array(exported);
const exportKeyOutput = document.querySelector(".exported-key");
exportKeyOutput.textContent = `[${exportedKeyBuffer}]`;
}
/*
Tạo một khóa bí mật mã hóa/giải mã,
sau đó thiết lập trình lắng nghe sự kiện trên nút "Export".
*/
window.crypto.subtle
.generateKey(
{
name: "AES-GCM",
length: 256,
},
true,
["encrypt", "decrypt"],
)
.then((key) => {
const exportButton = document.querySelector(".raw");
exportButton.addEventListener("click", () => {
exportCryptoKey(key);
});
});
Xuất PKCS #8
Ví dụ này xuất một khóa riêng tư ký RSA dưới dạng đối tượng PKCS #8. Khóa đã xuất sau đó được mã hóa PEM. Xem mã đầy đủ trên GitHub.
/*
Chuyển đổi một ArrayBuffer thành một chuỗi
từ https://developer.chrome.com/blog/how-to-convert-arraybuffer-to-and-from-string/
*/
function ab2str(buf) {
return String.fromCharCode.apply(null, new Uint8Array(buf));
}
/*
Xuất khóa đã cho và ghi vào không gian "exported-key".
*/
async function exportCryptoKey(key) {
const exported = await window.crypto.subtle.exportKey("pkcs8", key);
const exportedAsString = ab2str(exported);
const exportedAsBase64 = window.btoa(exportedAsString);
const pemExported = `-----BEGIN PRIVATE KEY-----\n${exportedAsBase64}\n-----END PRIVATE KEY-----`;
const exportKeyOutput = document.querySelector(".exported-key");
exportKeyOutput.textContent = pemExported;
}
/*
Tạo một cặp khóa ký/xác minh,
sau đó thiết lập trình lắng nghe sự kiện trên nút "Export".
*/
window.crypto.subtle
.generateKey(
{
name: "RSA-PSS",
// Cân nhắc sử dụng khóa 4096-bit cho các hệ thống yêu cầu bảo mật dài hạn
modulusLength: 2048,
publicExponent: new Uint8Array([1, 0, 1]),
hash: "SHA-256",
},
true,
["sign", "verify"],
)
.then((keyPair) => {
const exportButton = document.querySelector(".pkcs8");
exportButton.addEventListener("click", () => {
exportCryptoKey(keyPair.privateKey);
});
});
Xuất SubjectPublicKeyInfo
Ví dụ này xuất một khóa công khai mã hóa RSA dưới dạng đối tượng SubjectPublicKeyInfo được mã hóa PEM. Xem mã đầy đủ trên GitHub.
/*
Chuyển đổi một ArrayBuffer thành một chuỗi
từ https://developer.chrome.com/blog/how-to-convert-arraybuffer-to-and-from-string/
*/
function ab2str(buf) {
return String.fromCharCode.apply(null, new Uint8Array(buf));
}
/*
Xuất khóa đã cho và ghi vào không gian "exported-key".
*/
async function exportCryptoKey(key) {
const exported = await window.crypto.subtle.exportKey("spki", key);
const exportedAsString = ab2str(exported);
const exportedAsBase64 = window.btoa(exportedAsString);
const pemExported = `-----BEGIN PUBLIC KEY-----\n${exportedAsBase64}\n-----END PUBLIC KEY-----`;
const exportKeyOutput = document.querySelector(".exported-key");
exportKeyOutput.textContent = pemExported;
}
/*
Tạo một cặp khóa mã hóa/giải mã,
sau đó thiết lập trình lắng nghe sự kiện trên nút "Export".
*/
window.crypto.subtle
.generateKey(
{
name: "RSA-OAEP",
// Cân nhắc sử dụng khóa 4096-bit cho các hệ thống yêu cầu bảo mật dài hạn
modulusLength: 2048,
publicExponent: new Uint8Array([1, 0, 1]),
hash: "SHA-256",
},
true,
["encrypt", "decrypt"],
)
.then((keyPair) => {
const exportButton = document.querySelector(".spki");
exportButton.addEventListener("click", () => {
exportCryptoKey(keyPair.publicKey);
});
});
Xuất JSON Web Key
Ví dụ này xuất một khóa riêng tư ký ECDSA dưới dạng đối tượng JSON Web Key. Xem mã đầy đủ trên GitHub.
/*
Xuất khóa đã cho và ghi vào không gian "exported-key".
*/
async function exportCryptoKey(key) {
const exported = await window.crypto.subtle.exportKey("jwk", key);
const exportKeyOutput = document.querySelector(".exported-key");
exportKeyOutput.textContent = JSON.stringify(exported, null, " ");
}
/*
Tạo một cặp khóa ký/xác minh,
sau đó thiết lập trình lắng nghe sự kiện trên nút "Export".
*/
window.crypto.subtle
.generateKey(
{
name: "ECDSA",
namedCurve: "P-384",
},
true,
["sign", "verify"],
)
.then((keyPair) => {
const exportButton = document.querySelector(".jwk");
exportButton.addEventListener("click", () => {
exportCryptoKey(keyPair.privateKey);
});
});
Đặc tả kỹ thuật
| Specification |
|---|
| Web Cryptography Level 2 # SubtleCrypto-method-exportKey |