Web Platform APIs
One way Ende simplifies web and cloud development is by using standard Web
Platform APIs (like fetch, WebSockets and more) over proprietary APIs. This
means if you've ever built for the browser, you're likely already familiar with
Ende, and if you're learning Ende, you're also investing in your knowledge of
the web.
Below we'll highlight some of the standard Web APIs that Ende supports.
To check if a Web Platform API is available in Ende, you can click on the interface on MDN and refer to its Browser Compatibility table.
fetch
The fetch API can be used to make HTTP requests. It is
implemented as specified in the
WHATWG fetch spec.
Spec deviations
- The Ende user agent does not have a cookie jar. As such, the
set-cookieheader on a response is not processed, or filtered from the visible response headers. - Ende does not follow the same-origin policy, because the Ende user agent
currently does not have the concept of origins, and it does not have a cookie
jar. This means Ende does not need to protect against leaking authenticated
data cross origin. Because of this Ende does not implement the following
sections of the WHATWG
fetchspecification:- Section
3.1. 'Origin' header. - Section
3.2. CORS protocol. - Section
3.5. CORB. - Section
3.6. 'Cross-Origin-Resource-Policy' header. Atomic HTTP redirect handling.- The
opaqueredirectresponse type.
- Section
- A
fetchwith aredirectmode ofmanualwill return abasicresponse rather than anopaqueredirectresponse. - The specification is vague on how
file:URLs are to be handled. Firefox is the only mainstream browser that implements fetchingfile:URLs, and even then it doesn't work by default. Ende supports fetching local files. See the next section for details. - The
requestandresponseheader guards are implemented, but unlike browsers do not have any constraints on which header names are allowed. - The
referrer,referrerPolicy,mode,credentials,cache,integrity,keepalive, andwindowproperties and their relevant behaviours inRequestInitare not implemented. The relevant fields are not present on theRequestobject. - The
prioritymember ofRequestInit("auto","high", or"low") is accepted and validated. Following the Fetch standard it is write-only, so it is not exposed back as a property on theRequestobject. - Request body upload streaming is supported (on HTTP/1.1 and HTTP/2). Unlike the current fetch proposal, the implementation supports duplex streaming.
- The
set-cookieheader is not concatenated when iterated over in theheadersiterator. This behaviour is in the process of being specified.
Fetching local files
Ende supports fetching file: URLs. This makes it easier to write code that
uses the same code path on a server as local, as well as easier to author code
that runs in several places.
Ende only supports absolute file URLs, this means that fetch("./some.json")
will not work. It should be noted though that if --location is
specified, relative URLs use the --location as the base, but a file: URL
cannot be passed as the --location.
To be able to fetch a resource, relative to the current module, which would work
if the module is local or remote, you should to use import.meta.url as the
base. For example:
const response = await fetch(new URL("./config.json", import.meta.url));
const config = await response.json();
Notes on fetching local files:
- Permissions are applied to reading resources, so an appropriate
--allow-readpermission is needed to be able to read a local file. - Fetching locally only supports the
GETmethod, and will reject the promise with any other method. - A file that does not exist simply rejects the promise with a vague
TypeError. This is to avoid the potential of fingerprinting attacks. - No headers are set on the response. Therefore it is up to the consumer to determine things like the content type or content length.
- Response bodies are streamed from the Rust side, so large files are available in chunks, and can be cancelled.
Structured Clone & Transferable Objects
Ende supports structuredClone() and
postMessage() for cloning and transferring objects
across contexts (e.g. between the main thread and Web Workers).
Serializable types
These types can be cloned with structuredClone() and sent via postMessage():
| Type | Notes |
|---|---|
| Primitives | string, number, boolean, null, undefined, bigint |
Array, Object, Map, Set |
Including nested structures and circular references |
Date, RegExp |
|
ArrayBuffer, TypedArray, DataView |
Copied by default, or transferred (see below) |
Error types |
Error, EvalError, RangeError, ReferenceError, SyntaxError, TypeError, URIError |
Blob |
Supported |
File |
Supported |
DOMException |
|
CryptoKey |
Transferable types
These types can be transferred (not copied) via the transfer option in
structuredClone() or the transfer list in postMessage(). After transfer,
the original object becomes unusable:
| Type | Notes |
|---|---|
ArrayBuffer |
Moves the backing memory to the receiver |
MessagePort |
Transfers the port to another context |
ReadableStream |
Transfers the stream to another context |
WritableStream |
Transfers the stream to another context |
TransformStream |
Transfers the stream to another context |
// Clone a Blob
const blob = new Blob(["hello"], { type: "text/plain" });
const cloned = structuredClone(blob);
console.log(await cloned.text()); // "hello"
// Transfer an ArrayBuffer through a MessageChannel
const buffer = new ArrayBuffer(1024);
const ch = new MessageChannel();
ch.port1.postMessage(buffer, [buffer]);
// buffer.byteLength is now 0 (transferred)
CustomEvent and EventTarget
The DOM Event API can be used to dispatch and listen to events happening in an application. It is implemented as specified in the WHATWG DOM spec.
Spec deviations
- Events do not bubble, because Ende does not have a DOM hierarchy, so there is no tree for Events to bubble/capture through.
timeStampproperty is always set to0.
Typings
The TypeScript definitions for the implemented web APIs can be found in the
lib.ende.shared_globals.d.ts
and
lib.ende.window.d.ts
files.
Definitions that are specific to workers can be found in the
lib.ende.worker.d.ts
file.
Location
Ende supports the location global from the web.
Location flag
There is no "web page" whose URL we can use for a location in an Ende process.
We instead allow users to emulate a document location by specifying one on the
CLI using the --location flag. It can be a http or https URL.
// ende run --location https://example.com/path main.ts
console.log(location.href);
// "https://example.com/path"
You must pass --location <href> for this to work. If you don't, any access to
the location global will throw an error.
// ende run main.ts
console.log(location.href);
// error: Uncaught ReferenceError: Access to "location", run again with --location <href>.
Setting location or any of its fields will normally cause navigation in
browsers. This is not applicable in Ende, so it will throw in this situation.
// ende run --location https://example.com/path main.ts
location.pathname = "./foo";
// error: Uncaught NotSupportedError: Cannot set "location.pathname".
Extended usage
On the web, resource resolution (excluding modules) typically uses the value of
location.href as the root on which to base any relative URLs. This affects
some web APIs adopted by Ende.
Fetch API
// ende run --location https://api.github.com/ --allow-net main.ts
const response = await fetch("./orgs/denoland");
// Fetches "https://api.github.com/orgs/denoland".
The fetch() call above would throw if the --location flag was not passed,
since there is no web-analogous location to base it onto.
Worker modules
// ende run --location https://example.com/index.html --allow-net main.ts
const worker = new Worker("./workers/hello.ts", { type: "module" });
// Fetches worker module at "https://example.com/workers/hello.ts".
Note
For the above use cases, it is preferable to pass URLs in full rather than
relying on --location. You can manually base a relative URL using the
URL constructor if needed.
The --location flag is intended for those who have a specific purpose in mind
for emulating a document location and are aware that this will only work at
application-level. However, you may also use it to silence errors from a
dependency which is frivolously accessing the location global.
Web Storage
The Web Storage API provides an API for storing string keys
and values. Persisting data works similar to a browser, and has a 10MB storage
limit. The global sessionStorage object only persists data for the current
execution context, while localStorage persists data from execution to
execution.
In a browser, localStorage persists data uniquely per origin (effectively the
protocol plus hostname plus port). Ende has a set of rules to determine what is
a unique storage location:
- When using the
--locationflag, the origin for the location is used to uniquely store the data. That means a location ofhttp://example.com/a.tsandhttp://example.com/b.tsandhttp://example.com:80/would all share the same storage, buthttps://example.com/would be different. - If there is no location specifier, but there is a
--configconfiguration file specified, the absolute path to that configuration file is used. That meansende run --config ende.jsonc a.tsandende run --config ende.jsonc b.tswould share the same storage, butende run --config tsconfig.json a.tswould be different. - If there is no configuration or location specifier, Ende uses the absolute
path to the main module to determine what storage is shared. The Ende REPL
generates a "synthetic" main module that is based off the current working
directory where
endeis started from. This means that multiple invocations of the REPL from the same path will share the persistedlocalStoragedata.
To set, get and remove items from localStorage, you can use the following:
// Set an item in localStorage
localStorage.setItem("myDemo", "Ende App");
// Read an item from localStorage
const cat = localStorage.getItem("myDemo");
// Remove an item from localStorage
localStorage.removeItem("myDemo");
// Remove all items from localStorage
localStorage.clear();
Web Workers
Ende supports the Web Worker API.
Workers can be used to run code on multiple threads. Each instance of Worker
is run on a separate thread, dedicated only to that worker.
Currently Ende supports only module type workers; thus it's essential to pass
the type: "module" option when creating a new worker.
Use of relative module specifiers in the main worker are only supported with
--location <href> passed on the CLI. This is not recommended for portability.
You can instead use the URL constructor and
import.meta.url to easily create a specifier for some nearby script. Dedicated
workers, however, have a location and this capability by default.
// Good
new Worker(import.meta.resolve("./worker.js"), { type: "module" });
// Bad
new Worker(import.meta.resolve("./worker.js"));
new Worker(import.meta.resolve("./worker.js"), { type: "classic" });
new Worker("./worker.js", { type: "module" });
As with regular modules, you can use top-level await in worker modules.
However, you should be careful to always register the message handler before the
first await, since messages can be lost otherwise. This is not a bug in Ende,
it's just an unfortunate interaction of features, and it also happens in all
browsers that support module workers.
import { delay } from "jsr:@ende/async@^2026.10.15/delay";
// First await: waits for a second, then continues running the module.
await delay(1000);
// The message handler is only set after that 1s delay, so some of the messages
// that reached the worker during that second might have been fired when no
// handler was registered.
self.onmessage = (evt) => {
console.log(evt.data);
};
Sending messages back to the main thread
Communication goes both ways. The main thread sends data to the worker with
worker.postMessage() and listens for replies with worker.onmessage. Inside
the worker, self.onmessage receives messages and self.postMessage() sends
results back:
const worker = new Worker(import.meta.resolve("./worker.ts"), {
type: "module"
});
// Receive results from the worker
worker.onmessage = (evt) => {
console.log("result from worker:", evt.data);
};
// Send work to the worker
worker.postMessage(41);self.onmessage = (evt) => {
const result = evt.data + 1;
// Send the result back to the main thread
self.postMessage(result);
};Running ende run --allow-read main.ts prints result from worker: 42.
Instantiation permissions
Creating a new Worker instance is similar to a dynamic import; therefore Ende
requires appropriate permission for this action.
For workers using local modules; --allow-read permission is required:
new Worker(import.meta.resolve("./worker.ts"), { type: "module" });console.log("hello world");
self.close();$ ende run main.ts
error: Uncaught PermissionDenied: read access to "./worker.ts", run again with the --allow-read flag
$ ende run --allow-read main.ts
hello world
For workers using remote modules; --allow-net permission is required:
new Worker("https://example.com/worker.ts", { type: "module" });// This file is hosted at https://example.com/worker.ts
console.log("hello world");
self.close();$ ende run main.ts
error: Uncaught PermissionDenied: net access to "https://example.com/worker.ts", run again with the --allow-net flag
$ ende run --allow-net main.ts
hello world
Using Ende in a worker
const worker = new Worker(import.meta.resolve("./worker.js"), {
type: "module"
});
worker.postMessage({ filename: "./log.txt" });self.onmessage = async (e) => {
const { filename } = e.data;
const text = await Ende.readTextFile(filename);
console.log(text);
self.close();
};hello world$ ende run --allow-read main.js
hello world
Specifying worker permissions
Caution
This is an unstable Ende feature. Learn more about unstable features.
The permissions available for the worker are analogous to the CLI permission flags, meaning every permission enabled there can be disabled at the level of the Worker API. You can find a more detailed description of each of the permission options here.
By default a worker will inherit permissions from the thread it was created in,
however in order to allow users to limit the access of this worker we provide
the ende.permissions option in the worker API.
For permissions that support granular access you can pass in a list of the desired resources the worker will have access to, and for those who only have the on/off option you can pass true/false respectively:
const worker = new Worker(import.meta.resolve("./worker.js"), {
type: "module",
ende: {
permissions: {
net: [
"deno.land"
],
read: [
new URL("./file_1.txt", import.meta.url),
new URL("./file_2.txt", import.meta.url)
],
write: false
}
}
});
Granular access permissions receive both absolute and relative routes as arguments, however take into account that relative routes will be resolved relative to the file the worker is instantiated in, not the path the worker file is currently in:
const worker = new Worker(
new URL("./worker/worker.js", import.meta.url).href,
{
type: "module",
ende: {
permissions: {
read: [
"/home/user/Documents/ende/worker/file_1.txt",
"./worker/file_2.txt"
]
}
}
}
);
Both ende.permissions and its children support the option "inherit", which
implies it will borrow its parent permissions:
// This worker will inherit its parent permissions
const worker = new Worker(import.meta.resolve("./worker.js"), {
type: "module",
ende: {
permissions: "inherit"
}
});
// This worker will inherit only the net permissions of its parent
const worker = new Worker(import.meta.resolve("./worker.js"), {
type: "module",
ende: {
permissions: {
env: false,
hrtime: false,
net: "inherit",
ffi: false,
read: false,
run: false,
write: false
}
}
});
Not specifying the ende.permissions option or one of its children will cause
the worker to inherit by default:
// This worker will inherit its parent permissions
const worker = new Worker(import.meta.resolve("./worker.js"), {
type: "module"
});
// This worker will inherit all the permissions of its parent BUT net
const worker = new Worker(import.meta.resolve("./worker.js"), {
type: "module",
ende: {
permissions: {
net: false
}
}
});
You can disable the permissions of the worker all together by passing "none"
to the ende.permissions option:
// This worker will not have any permissions enabled
const worker = new Worker(import.meta.resolve("./worker.js"), {
type: "module",
ende: {
permissions: "none"
}
});
OffscreenCanvas
The
OffscreenCanvas
API is available. OffscreenCanvas is a canvas that lives outside any DOM and
can be used anywhere (including Web Workers) for off-thread rendering and image
generation.
Supported rendering contexts
OffscreenCanvas#getContext accepts two of the spec-defined context ids:
"bitmaprenderer": returns anImageBitmapRenderingContextfor displaying anImageBitmapproduced viacreateImageBitmap."webgpu": returns aGPUCanvasContextfor rendering with WebGPU.
Calling getContext with "2d", "webgl", or "webgl2" returns null; these
contexts are not implemented in Ende.
Example: encoding an image to PNG
Decode an image into an ImageBitmap, place it on an OffscreenCanvas via the
bitmaprenderer context, and write the result to disk:
const data = await Ende.readFile("./input.jpg");
const bitmap = await createImageBitmap(new Blob([data]));
const canvas = new OffscreenCanvas(bitmap.width, bitmap.height);
const ctx = canvas.getContext("bitmaprenderer")!;
ctx.transferFromImageBitmap(bitmap);
const blob = await canvas.convertToBlob({ type: "image/png" });
await Ende.writeFile(
"./output.png",
new Uint8Array(await blob.arrayBuffer())
);
Typical uses:
- producing thumbnails, format conversions, or social-card images at request time without spinning up a headless browser,
- running off-thread image work inside a Web Worker,
- driving WebGPU rendering targets that don't need a window.
Geometry Interfaces
The Geometry Interfaces Module Level 1 types are available as globals. These are the same types you'd find in a browser:
DOMMatrix/DOMMatrixReadOnly: 4×4 transform matrices for 2D and 3D operations.DOMPoint/DOMPointReadOnly: points in 2D / 3D space.DOMRect/DOMRectReadOnly: axis-aligned rectangles.DOMQuad: a quadrilateral defined by four points.
const m = new DOMMatrix().translateSelf(10, 20).scaleSelf(2);
const p = new DOMPoint(1, 1).matrixTransform(m);
console.log(p.x, p.y); // 12 22
These types are useful for graphics work; applying transforms to canvas drawings, computing layout math, or porting browser code that depends on geometry types.
navigator
Ende implements a subset of the
navigator
global. The following properties are available:
navigator.userAgent— always"Ende/<version>"navigator.platform— the underlying OS platform (e.g."Linux x86_64","MacIntel","Win32").navigator.hardwareConcurrency— number of logical CPU coresnavigator.userAgentData— aNavigatorUADataobject implementing the User-Agent Client Hints API. The low-entropy propertiesbrands,mobile, andplatformare read synchronously, whilegetHighEntropyValues(hints)resolves with additional details such asarchitecture,model, andplatformVersion.navigator.locks— aLockManagerimplementing the Web Locks API, for coordinating access to a named resource withnavigator.locks.request()andnavigator.locks.query().
console.log(navigator.userAgent); // "Ende/2.7.0"
console.log(navigator.platform); // e.g. "Linux x86_64", "MacIntel", "Win32"
console.log(navigator.hardwareConcurrency); // e.g. 8
console.log(navigator.userAgentData.brands); // e.g. [{ brand: "Ende", version: "2" }]
Temporal
The Temporal API is a modern
date/time library that replaces Date for most use cases. It is available as a
global without any flags.
// Current date/time in local timezone
const now = Temporal.Now.plainDateTimeISO();
console.log(now.toString()); // e.g. "2025-03-12T10:30:00"
// Parse a date
const date = Temporal.PlainDate.from("2025-03-12");
console.log(date.month); // 3
// Timezone-aware
const zonedNow = Temporal.Now.zonedDateTimeISO("America/New_York");
console.log(zonedNow.timeZoneId); // "America/New_York"
CompressionStream and DecompressionStream
Ende supports
CompressionStream
and
DecompressionStream
for streaming compression and decompression.
Supported formats
| Format | String | Notes |
|---|---|---|
| gzip | "gzip" |
RFC 1952 |
| deflate | "deflate" |
zlib (RFC 1950) |
| deflate-raw | "deflate-raw" |
raw DEFLATE (1951) |
| Brotli | "brotli" |
7 |
// Compress with Brotli
const input = new TextEncoder().encode("Hello, Ende!");
const cs = new CompressionStream("brotli");
const writer = cs.writable.getWriter();
writer.write(input);
writer.close();
const compressed = await new Response(cs.readable).arrayBuffer();
// Decompress
const ds = new DecompressionStream("brotli");
const writer2 = ds.writable.getWriter();
writer2.write(new Uint8Array(compressed));
writer2.close();
const result = await new Response(ds.readable).text();
console.log(result); // "Hello, Ende!"
Web Crypto
Ende supports the
Web Crypto API
via crypto.subtle.
Feature detection
SubtleCrypto.supports() is a static method for synchronously checking whether
a given algorithm and operation combination is available, without running the
operation or catching an error. It takes the operation name, the algorithm, and
an optional third argument, and returns a boolean.
SubtleCrypto.supports("digest", "SHA3-256"); // true
SubtleCrypto.supports("generateKey", "ChaCha20-Poly1305"); // true
SubtleCrypto.supports("sign", "ML-DSA-65"); // true
The operation is one of "encrypt", "decrypt", "sign", "verify",
"digest", "generateKey", "deriveKey", "deriveBits", "importKey",
"exportKey", "wrapKey", "unwrapKey", "encapsulateKey",
"encapsulateBits", "decapsulateKey", "decapsulateBits", or
"getPublicKey".
The optional third argument is interpreted by operation: a length in bits for
"deriveBits", and a related algorithm otherwise, such as the derived-key
algorithm for "deriveKey" or the shared-key algorithm for "encapsulateKey"
and "decapsulateKey".
// Will deriveKey produce an AES-GCM key from HKDF?
SubtleCrypto.supports("deriveKey", "HKDF", { name: "AES-GCM", length: 256 });
SubtleCrypto.supports() is part of the WICG
Modern Algorithms in the Web Cryptography API
draft.
SHA-3 hash algorithms
The SHA-3 family of hash algorithms is supported by crypto.subtle.digest:
SHA3-256SHA3-384SHA3-512
const data = new TextEncoder().encode("Hello, Ende!");
const hash = await crypto.subtle.digest("SHA3-256", data);
console.log(new Uint8Array(hash));
An HMAC key can also use a SHA-3 hash. Pass the algorithm name as the hash
when you generate or import the key:
const key = await crypto.subtle.generateKey(
{ name: "HMAC", hash: "SHA3-256" },
true,
["sign", "verify"]
);
const signature = await crypto.subtle.sign("HMAC", key, data);
Extendable-output functions
Ende supports the SHAKE, cSHAKE, TurboSHAKE, and KangarooTwelve
extendable-output functions (XOFs). Unlike a fixed-size hash, an XOF can produce
a digest of any length, so crypto.subtle.digest requires an outputLength
option giving the output size in bits. outputLength must be a positive
multiple of 8. The supported names are:
SHAKE128,SHAKE256cSHAKE128,cSHAKE256TurboSHAKE128,TurboSHAKE256KT128(also accepted asKangarooTwelve) andKT256
const data = new TextEncoder().encode("Hello, Ende!");
// 256-bit (32-byte) SHAKE256 digest.
const digest = await crypto.subtle.digest(
{ name: "SHAKE256", outputLength: 256 },
data
);
console.log(new Uint8Array(digest).length); // 32
cSHAKE128 and cSHAKE256 accept two optional BufferSource parameters that
customize the function: functionName, a NIST-defined function name, and
customization, a caller-defined domain separation string.
const digest = await crypto.subtle.digest(
{
name: "cSHAKE128",
outputLength: 256,
customization: new TextEncoder().encode("my-app")
},
data
);
TurboSHAKE128 and TurboSHAKE256 accept an optional domainSeparation byte,
which must be in the range 0x01 to 0x7F:
const digest = await crypto.subtle.digest(
{ name: "TurboSHAKE256", outputLength: 512, domainSeparation: 0x1f },
data
);
KT128 and KT256 are KangarooTwelve XOFs. They accept an optional
customization BufferSource:
const digest = await crypto.subtle.digest(
{ name: "KT128", outputLength: 256 },
data
);
KMAC
KMAC128 and KMAC256 are keyed message authentication codes built on cSHAKE.
Generate a key with a length in bits, then sign and verify with an
outputLength in bits and an optional customization BufferSource:
const key = await crypto.subtle.generateKey(
{ name: "KMAC128", length: 128 },
true,
["sign", "verify"]
);
const data = new TextEncoder().encode("Hello, Ende!");
const params = {
name: "KMAC128",
outputLength: 256,
customization: new TextEncoder().encode("Ende")
};
const mac = await crypto.subtle.sign(params, key, data);
const valid = await crypto.subtle.verify(params, key, mac, data);
KMAC keys can be imported and exported in the "raw", "raw-secret", and
"jwk" formats.
Argon2
Argon2d, Argon2i, and Argon2id are password-hashing key-derivation
functions. Import the password as a key in the "raw-secret" format with the
deriveBits usage, then call deriveBits. The parameters are memory (memory
cost in kibibytes), passes (iterations), parallelism (degree of
parallelism), and a nonce BufferSource (the salt). secretValue and
associatedData are optional BufferSource values:
const password = new TextEncoder().encode("correct horse battery staple");
const key = await crypto.subtle.importKey(
"raw-secret",
password,
"Argon2id",
false,
["deriveBits"]
);
const derived = await crypto.subtle.deriveBits(
{
name: "Argon2id",
memory: 65536,
passes: 3,
parallelism: 4,
nonce: crypto.getRandomValues(new Uint8Array(16))
},
key,
256 // output length in bits
);
ChaCha20-Poly1305
Ende supports the ChaCha20-Poly1305 authenticated encryption algorithm through
generateKey, encrypt, and decrypt. Keys are always 256 bits:
const key = await crypto.subtle.generateKey(
{ name: "ChaCha20-Poly1305" },
true,
["encrypt", "decrypt"]
);
Each encrypt and decrypt call takes a 12-byte nonce and optional
additionalData that is authenticated but not encrypted. Use a fresh nonce for
every message encrypted under the same key:
const nonce = crypto.getRandomValues(new Uint8Array(12));
const data = new TextEncoder().encode("Hello, Ende!");
const ciphertext = await crypto.subtle.encrypt(
{ name: "ChaCha20-Poly1305", nonce },
key,
data
);
const plaintext = await crypto.subtle.decrypt(
{ name: "ChaCha20-Poly1305", nonce },
key,
ciphertext
);
console.log(new TextDecoder().decode(plaintext)); // "Hello, Ende!"
The returned ciphertext includes the 16-byte Poly1305 authentication tag.
Post-quantum cryptography
Ende implements the NIST post-quantum algorithms from the WICG Modern Algorithms in the Web Cryptography API draft: ML-DSA and SLH-DSA signatures, and ML-KEM key encapsulation.
ML-DSA signatures
ML-DSA (FIPS 204) is a lattice-based digital signature scheme. Three parameter
sets are available, in increasing security level: ML-DSA-44, ML-DSA-65, and
ML-DSA-87. Generate a key pair, then sign with the private key and verify with
the public key:
const { publicKey, privateKey } = await crypto.subtle.generateKey(
{ name: "ML-DSA-65" },
true,
["sign", "verify"]
);
const data = new TextEncoder().encode("Hello, Ende!");
const signature = await crypto.subtle.sign(
{ name: "ML-DSA-65" },
privateKey,
data
);
const valid = await crypto.subtle.verify(
{ name: "ML-DSA-65" },
publicKey,
signature,
data
);
console.log(valid); // true
sign and verify accept an optional context, a BufferSource that binds
the signature to an application-specific value. The same context must be
supplied to both calls:
const context = new TextEncoder().encode("v1");
const signature = await crypto.subtle.sign(
{ name: "ML-DSA-65", context },
privateKey,
data
);
ML-DSA keys can be imported and exported in the "pkcs8", "spki", "jwk",
"raw-public", "raw-private", and "raw-seed" formats.
SLH-DSA signatures
SLH-DSA (FIPS 205) is a stateless hash-based signature scheme. All twelve
parameter sets are available, combining a hash family (SHA2 or SHAKE), a
security level (128, 192, or 256), and a s (small signature) or f
(fast) tradeoff:
SLH-DSA-SHA2-128s,SLH-DSA-SHA2-128f,SLH-DSA-SHA2-192s,SLH-DSA-SHA2-192f,SLH-DSA-SHA2-256s,SLH-DSA-SHA2-256fSLH-DSA-SHAKE-128s,SLH-DSA-SHAKE-128f,SLH-DSA-SHAKE-192s,SLH-DSA-SHAKE-192f,SLH-DSA-SHAKE-256s,SLH-DSA-SHAKE-256f
SLH-DSA uses the same generateKey, sign, and verify flow as ML-DSA,
including the optional context:
const { publicKey, privateKey } = await crypto.subtle.generateKey(
{ name: "SLH-DSA-SHAKE-128f" },
true,
["sign", "verify"]
);
const data = new TextEncoder().encode("Hello, Ende!");
const signature = await crypto.subtle.sign(
{ name: "SLH-DSA-SHAKE-128f" },
privateKey,
data
);
SLH-DSA keys can be imported and exported in the "pkcs8", "spki", "jwk",
"raw-public", and "raw-private" formats.
ML-KEM key encapsulation
ML-KEM (FIPS 203) is a key-encapsulation mechanism: one party encapsulates a
fresh shared secret to a recipient's public key, and the recipient decapsulates
the resulting ciphertext to recover the same secret. The parameter sets are
ML-KEM-512, ML-KEM-768, and ML-KEM-1024.
The recipient generates a key pair and publishes the public (encapsulation) key.
The sender calls encapsulateKey, which returns both the ciphertext to send
back and a sharedKey CryptoKey for the algorithm named by its third
argument. The recipient passes the ciphertext to decapsulateKey to derive the
same key:
const { publicKey, privateKey } = await crypto.subtle.generateKey(
{ name: "ML-KEM-768" },
true,
["encapsulateKey", "decapsulateKey"]
);
// Sender: encapsulate a shared AES-GCM key to the recipient's public key.
const { ciphertext, sharedKey } = await crypto.subtle.encapsulateKey(
{ name: "ML-KEM-768" },
publicKey,
{ name: "AES-GCM", length: 256 },
false,
["encrypt", "decrypt"]
);
// Recipient: decapsulate the ciphertext to recover the same key.
const recovered = await crypto.subtle.decapsulateKey(
{ name: "ML-KEM-768" },
privateKey,
ciphertext,
{ name: "AES-GCM", length: 256 },
false,
["encrypt", "decrypt"]
);
encapsulateBits and decapsulateBits are the lower-level variants: they
return the raw shared secret as an ArrayBuffer instead of importing it as a
CryptoKey. A decapsulation (private) key also exposes getPublicKey(), which
returns its matching encapsulation (public) key.
createImageBitmap
Ende supports
createImageBitmap()
for decoding images into ImageBitmap objects that can be used with
OffscreenCanvas.
Supported input formats
| Format | Notes |
|---|---|
| PNG | |
| JPEG | |
| BMP | |
| GIF | 7 |
| WebP | 7 |
const data = await Ende.readFile("./image.gif");
const bitmap = await createImageBitmap(new Blob([data]));
console.log(bitmap.width, bitmap.height);
File locking
Ende.FsFile supports advisory file locking to
coordinate access between processes:
lock(exclusive?)— acquires a lock. Shared (read) by default; passtruefor exclusive (write). Blocks if an incompatible lock is held.lockSync(exclusive?)— synchronous variant oflock().tryLock(exclusive?)— non-blocking. Returnstrueif the lock was acquired,falseotherwise.tryLockSync(exclusive?)— synchronous variant oftryLock().
const file = await Ende.open("./data.txt", { read: true, write: true });
const locked = await file.tryLock(true); // exclusive
if (locked) {
await file.write(new TextEncoder().encode("hello"));
await file.unlock();
} else {
console.log("File is locked by another process, skipping.");
}
file.close();
Deviations of other APIs from spec
Cache API
Only the following APIs are implemented:
A few things that are different compared to browsers:
- You cannot pass relative paths to the APIs. The request can be an instance of Request or URL or a url string.
match()&delete()don't support query options yet.