iron-webcrypto

iron-webcrypto (beta)

This module is a replacement for @hapi/iron, written using the Web Crypto API that makes it compatible with browser and edge environments.

Check out vvo/iron-session to see this module in use!

---

Installation

To use this module, run:

npm add iron-webcrypto
npm remove @hapi/iron

and update imports.

Then modify function calls to pass a Web Crypto implementation as the first param. For example:

Iron.seal(obj, password, Iron.defaults)

becomes:

Iron.seal(_crypto, obj, password, Iron.defaults)

where _crypto is your Web Crypto implementation. Generally, this will available in your context (for example, globalThis.crypto in browsers, edge runtimes, Deno¹, Bun and Node.js v19+; require('crypto').webcrypto in Node.js v15+). However, you may also need to polyfill this for older Node.js versions. We recommend using @peculiar/webcrypto for that.

Footnotes

1. You can use esm.sh for importing this module in Deno (and browsers). Example:

   import * as Iron from 'https://esm.sh/iron-webcrypto@0.2.6'
   
   const obj = { a: 1, b: 2, c: [3, 4, 5], d: { e: 'f' } }
   const password = 'some_not_random_password_that_is_also_long_enough'
   
   const sealed = await Iron.seal(crypto, obj, password, Iron.defaults)
   const unsealed = await Iron.unseal(crypto, sealed, password, Iron.defaults)
   
   console.log(unsealed)
   

   ↩

Changelog

0.4.0 (2023-02-07)

Features

• drop dependency on buffer and use standard uint8array (#5) (285bfd9)