前端加密不求人!Web Crypto API 完整教學:雜湊、AES 加解密、HMAC 簽章

前言
在開發過程中,我們常常會需要對資料進行加密、解密、雜湊等操作,過去我們可能會依賴 Node.js 的 crypto 模組或第三方套件(例如:crypto-js),但其實現代瀏覽器已經內建了 Web Crypto API,讓你不需要安裝任何套件就可以直接在瀏覽器中進行加解密操作,那麼這一篇就來介紹一下 Web Crypto API 的使用方式吧!
Crypto 是什麼?
許多時候我們在進行開發時,並不會直接將資料明文儲存,而是會將資料額外加密後再儲存,這樣的好處在於,當資料庫被入侵時,駭客也會因為沒有 Key 而無法解密資料庫中的資料,雖然可以透過暴力破解方式推測出 Key,但這樣的方式會需要花費非常長的時間,但其實這樣有助於當資安事件發生時,企業可以爭取足夠時間來處理資安事件,並且通知使用者(如:更改密碼、鎖定帳號等等)。
因此 Crypto 就是專門做這件事情的套件,舉凡:
- 加密
- 解密
- 雜湊
- HMAC
- 簽章
- 驗章
等等,都可以透過 Crypto 來實現,而在 Node.js 環境中,Crypto 是內建的模組,因此我們不需要額外安裝套件就可以直接使用,但在瀏覽器環境中,我們則是需要透過第三方套件來實現加密功能,但其實在瀏覽器環境中,我們也有一個內建的 API 可以直接使用,那就是 Web Crypto API。
Web Crypto API
Web Crypto API 是瀏覽器後來新加入的功能,讓你可以直接透過瀏覽器進行加解密的操作行為,這樣的好處在於,你不需要額外安裝套件就可以直接使用,而且它的 API 也非常簡單易懂,接下來我們就來介紹一下 Web Crypto API 的使用方式吧!
Web Crypto API 主要是透過 window.crypto.subtle 這個物件來操作,它提供了以下幾種常見的方法:
crypto.subtle.digest():雜湊(Hash)crypto.subtle.encrypt()/crypto.subtle.decrypt():加密 / 解密crypto.subtle.sign()/crypto.subtle.verify():簽章 / 驗章crypto.subtle.generateKey():產生金鑰crypto.subtle.importKey()/crypto.subtle.exportKey():匯入 / 匯出金鑰crypto.subtle.deriveKey()/crypto.subtle.deriveBits():衍生金鑰 / 衍生位元
那麼接下來我們就來一一介紹這些方法的使用方式吧!
產生隨機 UUID
在介紹比較複雜的加解密之前,我們先來看一個最簡單也最實用的功能,那就是產生 UUID(Universally Unique Identifier),其實 crypto.randomUUID() 就是 Web Crypto API 所提供的方法之一,使用方式非常簡單:
1 | |
是不是超級簡單?你不需要額外安裝 uuid 套件,瀏覽器本身就已經內建了這個功能,而且它產生的是 UUID v4,幾乎不可能會有重複的情況發生。
Note
如果你想要更深入了解 UUID 的使用方式,可以參考我之前寫的「不安裝 npm 套件也可以直接在瀏覽器上生成 UUID!」這篇文章。
產生隨機值
除了 UUID 之外,Web Crypto API 還提供了 crypto.getRandomValues() 方法,讓你可以產生加密安全的隨機值,這個方法比 Math.random() 更加安全,因為 Math.random() 產生的隨機數是可預測的,但 crypto.getRandomValues() 產生的隨機數是不可預測的:
1 | |
這個方法在產生加密金鑰的初始化向量(IV)、鹽值(Salt)等場景中非常實用,後面的加解密範例中你也會看到它的身影。
雜湊(Hash)
雜湊是一種單向的加密方式,也就是說你只能將資料加密,但無法將加密後的資料解密回原本的資料,這種方式通常用於密碼的儲存,因為我們不需要知道密碼的原文,只需要知道密碼是否正確就好。
常見的雜湊演算法有以下幾種:
SHA-1(已不建議使用)SHA-256SHA-384SHA-512
那麼我們就來看看如何使用 Web Crypto API 來進行雜湊吧!
1 | |
你可能會好奇,為什麼要先將字串轉換成 Uint8Array 呢?因為 Web Crypto API 的 digest 方法接受的參數是 BufferSource,也就是 ArrayBuffer 或 TypedArray,因此我們需要先將字串轉換成 Uint8Array。
而 digest 方法回傳的也是一個 ArrayBuffer,因此我們需要再將它轉換成我們比較好閱讀的十六進位字串。
Note
如果你之前有使用過 Node.js 的crypto模組,你可能會發現它的 API 比較簡單,例如:crypto.createHash('sha256').update('Hello World').digest('hex'),但 Web Crypto API 的方式雖然稍微複雜一些,但它是瀏覽器原生支援的,不需要額外安裝套件。
加密與解密(AES-GCM)
接下來我們來介紹加密與解密的部分,這邊我們使用 AES-GCM 演算法來示範,AES-GCM 是一種對稱式加密演算法,也就是說加密與解密使用的是同一把金鑰。
產生金鑰
首先我們需要先產生一把金鑰:
1 | |
加密
接著我們就可以使用這把金鑰來進行加密:
1 | |
這邊有一個重要的概念,就是 iv(初始化向量),它的用途是讓同一段文字每次加密後的結果都不一樣,這樣可以增加安全性,而 iv 是不需要保密的,通常會跟加密後的資料一起儲存。
解密
最後我們就可以使用同一把金鑰來進行解密:
1 | |
完整範例 AES-GCM
那麼我們就來看看完整的加密與解密範例:
1 | |
是不是看起來非常簡單呢?透過 Web Crypto API,我們不需要安裝任何套件就可以直接在瀏覽器中進行加密與解密的操作。
簽章與驗章(HMAC)
HMAC(Hash-based Message Authentication Code)是一種用來驗證資料完整性與真實性的機制,它結合了雜湊函數與金鑰,讓你可以確認資料在傳輸過程中是否被篡改。
產生 HMAC 金鑰
1 | |
簽章
1 | |
驗章
1 | |
完整範例 HMAC
1 | |
透過 HMAC,我們可以確認資料在傳輸過程中是否被篡改,這在 API 通訊中是非常常見的安全機制。
非對稱式加密(RSA-OAEP)
除了對稱式加密之外,Web Crypto API 也支援非對稱式加密,也就是我們俗稱的公私鑰加密,這邊我們使用 RSA-OAEP 來示範。
非對稱式加密的概念是,你會有一對金鑰,分別是「公鑰」與「私鑰」,公鑰用來加密,私鑰用來解密,而且公鑰是可以公開的,私鑰則是要保密的。
1 | |
實用的輔助函式
在使用 Web Crypto API 時,你會發現經常需要做 ArrayBuffer 與字串之間的轉換,因此我們可以封裝一些常用的輔助函式,讓操作更加方便:
1 | |
這些輔助函式在實際開發中非常實用,因為我們在傳輸或儲存加密後的資料時,通常會將 ArrayBuffer 轉換成 Base64 或十六進位字串。
Web Crypto API 與 Node.js crypto 的差異
你可能會好奇,Web Crypto API 與 Node.js 的 crypto 模組有什麼差異呢?這邊我們簡單比較一下:
| 比較項目 | Web Crypto API | Node.js crypto |
|---|---|---|
| 環境 | 瀏覽器 | Node.js |
| API 風格 | Promise(非同步) | 同步 / Stream |
| 安裝方式 | 內建,不需安裝 | 內建,不需安裝 |
| 支援的演算法 | AES、RSA、ECDSA、HMAC 等 | 更多演算法支援 |
| 使用限制 | 需要 HTTPS(Secure Context) | 無限制 |
有一個很重要的點要注意,Web Crypto API 只能在 Secure Context(安全環境)下使用,也就是說你必須在 HTTPS 或 localhost 的環境下才能使用,如果你是在一般的 HTTP 環境下,是無法使用的哦!
Note
值得一提的是,Web Crypto API 的所有方法都是非同步的(回傳 Promise),這是因為加密操作通常比較耗時,使用非同步的方式可以避免阻塞主執行緒,讓使用者體驗更好。
瀏覽器支援度
那麼 Web Crypto API 的瀏覽器支援度如何呢?其實現在主流瀏覽器都已經支援了,包含 Chrome、Firefox、Safari、Edge 等等,基本上你可以放心的使用它。
而且不只瀏覽器,其實 Node.js(v15+)、Deno、Bun 等 Runtime 也都有支援 Web Crypto API,因此你的加密程式碼可以跨環境使用,這是一個非常大的優勢。
結語
Web Crypto API 是一個非常強大的瀏覽器內建 API,它讓我們不需要額外安裝套件就可以直接在瀏覽器中進行加解密的操作,雖然它的 API 相較於 Node.js 的 crypto 模組來說稍微複雜一些(主要是因為需要處理 ArrayBuffer 的轉換),但它的好處在於:
- 不需要安裝任何套件,減少專案的依賴
- 瀏覽器原生支援,效能更好
- 跨環境支援(瀏覽器、Node.js、Deno、Bun)
- 非同步設計,不會阻塞主執行緒
如果你的專案需要在前端進行加解密的操作,那麼 Web Crypto API 絕對是你的首選哩~