ts-mls 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Luka Jacobowitz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,196 @@
+# ts-mls: A TypeScript MLS (Messaging Layer Security - RFC 9420) implementation
+
+[![CI](https://github.com/LukaJCB/ts-mls/actions/workflows/ci.yml/badge.svg)](https://github.com/LukaJCB/ts-mls/actions/workflows/ci.yml) [![npm version](https://badge.fury.io/js/ts-mls.svg)](https://badge.fury.io/js/ts-mls) [![Coverage Status](https://coveralls.io/repos/github/LukaJCB/ts-mls/badge.svg?branch=main)](https://coveralls.io/github/LukaJCB/ts-mls?branch=main)
+
+Typescript implementation of Messaging Layer Security (RFC 9420, MLS).
+
+This project aims to be a full implementation of [RFC 9420](https://datatracker.ietf.org/doc/html/rfc9420) and focuses on immutability and type safety. It is suitable for browsers, Node.js, or serverless environments and supports the recently standardized Post Quantum public-key algorithms (FIPS-203, FIPS-204) as well as the X-Wing hybrid KEM combining X25519 and ML-KEM.
+
+## Installation
+
+> **Node.js Requirement**: Node.js 19+ is required when using this library in Node.js environments due to the Web Crypto API dependency.
+
+```bash
+# npm
+npm install ts-mls
+
+# yarn
+yarn add ts-mls
+
+# pnpm
+pnpm add ts-mls
+```
+
+This project currently only has a single dependency, `@hpke/core`. However, to support different Ciphersuites, you may need to install other libraries. As an example, to use the `MLS_128_DHKEMX25519_AES128GCM_SHA256_Ed25519` Ciphersuite, you would also have to install `@noble/curves`:
+
+```bash
+# npm
+npm install @noble/curves
+
+# yarn
+yarn add @noble/curves
+
+# pnpm
+pnpm add @noble/curves
+```
+
+Please refer to the subsequent table to understand which additional dependencies are required to install for each Ciphersuite.
+
+## Supported Ciphersuites
+
+The following cipher suites are supported:
+
+| KEM                      | AEAD             | KDF         | Hash    | Signature | Name                                                | ID  | Dependencies                                                        |
+| ------------------------ | ---------------- | ----------- | ------- | --------- | --------------------------------------------------- | --- | ------------------------------------------------------------------- |
+| DHKEM-X25519-HKDF-SHA256 | AES128GCM        | HKDF-SHA256 | SHA-256 | Ed25519   | MLS_128_DHKEMX25519_AES128GCM_SHA256_Ed25519        | 1   | @noble/curves                                                       |
+| DHKEM-P256-HKDF-SHA256   | AES128GCM        | HKDF-SHA256 | SHA-256 | P256      | MLS_128_DHKEMP256_AES128GCM_SHA256_P256             | 2   | @noble/curves                                                       |
+| DHKEM-X25519-HKDF-SHA256 | CHACHA20POLY1305 | HKDF-SHA256 | SHA-256 | Ed25519   | MLS_128_DHKEMX25519_CHACHA20POLY1305_SHA256_Ed25519 | 3   | @hpke/chacha20poly1305, @noble/curves                               |
+| DHKEM-X448-HKDF-SHA512   | AES256GCM        | HKDF-SHA512 | SHA-512 | Ed448     | MLS_256_DHKEMX448_AES256GCM_SHA512_Ed448            | 4   | @noble/curves                                                       |
+| DHKEM-P521-HKDF-SHA512   | AES256GCM        | HKDF-SHA512 | SHA-512 | P521      | MLS_256_DHKEMP521_AES256GCM_SHA512_P521             | 5   | @noble/curves                                                       |
+| DHKEM-X448-HKDF-SHA512   | CHACHA20POLY1305 | HKDF-SHA512 | SHA-512 | Ed448     | MLS_256_DHKEMX448_CHACHA20POLY1305_SHA512_Ed448     | 6   | @hpke/chacha20poly1305, @noble/curves                               |
+| DHKEM-P384-HKDF-SHA384   | AES256GCM        | HKDF-SHA384 | SHA-384 | P384      | MLS_256_DHKEMP384_AES256GCM_SHA384_P384             | 7   | @noble/curves                                                       |
+| ML-KEM-512               | AES256GCM        | HKDF-SHA256 | SHA-256 | Ed25519   | MLS_128_MLKEM512_AES128GCM_SHA256_Ed25519           | 77  | @hpke/ml-kem, @noble/curves                                         |
+| ML-KEM-512               | CHACHA20POLY1305 | HKDF-SHA256 | SHA-256 | Ed25519   | MLS_128_MLKEM512_CHACHA20POLY1305_SHA256_Ed25519    | 78  | @hpke/ml-kem, @hpke/chacha20poly1305, @noble/curves                 |
+| ML-KEM-768               | AES256GCM        | HKDF-SHA384 | SHA-384 | Ed25519   | MLS_256_MLKEM768_AES256GCM_SHA384_Ed25519           | 79  | @hpke/ml-kem, @noble/curves                                         |
+| ML-KEM-768               | CHACHA20POLY1305 | HKDF-SHA384 | SHA-384 | Ed25519   | MLS_256_MLKEM768_CHACHA20POLY1305_SHA384_Ed25519    | 80  | @hpke/ml-kem, @hpke/chacha20poly1305, @noble/curves                 |
+| ML-KEM-1024              | AES256GCM        | HKDF-SHA512 | SHA-512 | Ed25519   | MLS_256_MLKEM1024_AES256GCM_SHA512_Ed25519          | 81  | @hpke/ml-kem, @noble/curves                                         |
+| ML-KEM-1024              | CHACHA20POLY1305 | HKDF-SHA512 | SHA-512 | Ed25519   | MLS_256_MLKEM1024_CHACHA20POLY1305_SHA512_Ed25519   | 82  | @hpke/ml-kem, @hpke/chacha20poly1305, @noble/curves                 |
+| X-Wing                   | AES256GCM        | HKDF-SHA512 | SHA-512 | Ed25519   | MLS_256_XWING_AES256GCM_SHA512_Ed25519              | 83  | @hpke/hybridkem-x-wing, @noble/curves                               |
+| X-Wing                   | CHACHA20POLY1305 | HKDF-SHA512 | SHA-512 | Ed25519   | MLS_256_XWING_CHACHA20POLY1305_SHA512_Ed25519       | 84  | @hpke/hybridkem-x-wing, @hpke/chacha20poly1305, @noble/curves       |
+| ML-KEM-1024              | AES256GCM        | HKDF-SHA512 | SHA-512 | ML-DSA-87 | MLS_256_MLKEM1024_AES256GCM_SHA512_MLDSA78          | 85  | @hpke/ml-kem, @noble/post-quantum                                   |
+| ML-KEM-1024              | CHACHA20POLY1305 | HKDF-SHA512 | SHA-512 | ML-DSA-87 | MLS_256_MLKEM1024_CHACHA20POLY1305_SHA512_MLDSA78   | 86  | @hpke/ml-kem, @hpke/chacha20poly1305, @noble/post-quantum           |
+| X-Wing                   | AES256GCM        | HKDF-SHA512 | SHA-512 | ML-DSA-87 | MLS_256_XWING_AES256GCM_SHA512_MLDSA78              | 87  | @hpke/hybridkem-x-wing, @noble/post-quantum                         |
+| X-Wing                   | CHACHA20POLY1305 | HKDF-SHA512 | SHA-512 | ML-DSA-87 | MLS_256_XWING_CHACHA20POLY1305_SHA512_MLDSA78       | 88  | @hpke/hybridkem-x-wing, @hpke/chacha20poly1305, @noble/post-quantum |
+
+## Security Disclaimer
+
+This library has not undergone a formal security audit. While care has been taken to implement the MLS protocol correctly and securely, it may contain undiscovered vulnerabilities. If you plan to use this library in a production or security-critical context, proceed with caution and consider conducting an independent security review.
+
+## Basic Usage
+
+```typescript
+import {
+  createApplicationMessage,
+  createCommit,
+  createGroup,
+  joinGroup,
+  processPrivateMessage,
+  getCiphersuiteImpl,
+  getCiphersuiteFromName,
+  Credential,
+  defaultCapabilities,
+  defaultLifetime,
+  emptyPskIndex,
+  generateKeyPackage,
+  encodeMlsMessage,
+  decodeMlsMessage,
+  Proposal,
+} from "ts-mls"
+
+const impl = await getCiphersuiteImpl(getCiphersuiteFromName("MLS_256_XWING_AES256GCM_SHA512_Ed25519"))
+
+// alice generates her key package
+const aliceCredential: Credential = { credentialType: "basic", identity: new TextEncoder().encode("alice") }
+const alice = await generateKeyPackage(aliceCredential, defaultCapabilities(), defaultLifetime, [], impl)
+
+const groupId = new TextEncoder().encode("group1")
+
+// alice creates a new group
+let aliceGroup = await createGroup(groupId, alice.publicPackage, alice.privatePackage, [], impl)
+
+// bob generates her key package
+const bobCredential: Credential = { credentialType: "basic", identity: new TextEncoder().encode("bob") }
+const bob = await generateKeyPackage(bobCredential, defaultCapabilities(), defaultLifetime, [], impl)
+
+// bob sends keyPackage to alice
+const keyPackageMessage = encodeMlsMessage({
+  keyPackage: bob.publicPackage,
+  wireformat: "mls_key_package",
+  version: "mls10",
+})
+
+// alice decodes bob's keyPackage
+const decodedKeyPackage = decodeMlsMessage(keyPackageMessage, 0)![0]
+
+if (decodedKeyPackage.wireformat !== "mls_key_package") throw new Error("Expected key package")
+
+// alice creates proposal to add bob
+const addBobProposal: Proposal = {
+  proposalType: "add",
+  add: {
+    keyPackage: decodedKeyPackage.keyPackage,
+  },
+}
+
+// alice commits
+const commitResult = await createCommit(aliceGroup, emptyPskIndex, false, [addBobProposal], impl)
+
+aliceGroup = commitResult.newState
+
+// alice sends welcome message to bob
+const encodedWelcome = encodeMlsMessage({
+  welcome: commitResult.welcome!,
+  wireformat: "mls_welcome",
+  version: "mls10",
+})
+
+// bob decodes the welcome message
+const decodedWelcome = decodeMlsMessage(encodedWelcome, 0)![0]
+
+if (decodedWelcome.wireformat !== "mls_welcome") throw new Error("Expected welcome")
+
+// bob creates his own group state
+let bobGroup = await joinGroup(
+  decodedWelcome.welcome,
+  bob.publicPackage,
+  bob.privatePackage,
+  emptyPskIndex,
+  impl,
+  aliceGroup.ratchetTree,
+)
+
+const messageToBob = new TextEncoder().encode("Hello bob!")
+
+// alice creates a message to the group
+const aliceCreateMessageResult = await createApplicationMessage(aliceGroup, messageToBob, impl)
+
+aliceGroup = aliceCreateMessageResult.newState
+
+// alice sends the message to bob
+const encodedPrivateMessageAlice = encodeMlsMessage({
+  privateMessage: aliceCreateMessageResult.privateMessage,
+  wireformat: "mls_private_message",
+  version: "mls10",
+})
+
+// bob decodes the message
+const decodedPrivateMessageAlice = decodeMlsMessage(encodedPrivateMessageAlice, 0)![0]
+
+if (decodedPrivateMessageAlice.wireformat !== "mls_private_message") throw new Error("Expected private message")
+
+// bob receives the message
+const bobProcessMessageResult = await processPrivateMessage(
+  bobGroup,
+  decodedPrivateMessageAlice.privateMessage,
+  emptyPskIndex,
+  impl,
+)
+
+bobGroup = bobProcessMessageResult.newState
+
+if (bobProcessMessageResult.kind === "newState") throw new Error("Expected application message")
+
+console.log(bobProcessMessageResult.message)
+```
+
+## Documentation
+
+Please visit the [/docs directory](docs/) for further documentation on different scenarios.
+
+## Contributing
+
+We welcome contributions! Please read our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to set up your environment, run checks, and submit changes.
+
+# License
+
+[MIT](LICENSE)

package/dist/src/IncomingMessageAction.d.ts

@@ -0,0 +1,10 @@
+import { ProposalWithSender } from "./unappliedProposals";
+export type IncomingMessageAction = "accept" | "reject";
+export type IncomingMessageCallback = (incoming: {
+    kind: "commit";
+    proposals: ProposalWithSender[];
+} | {
+    kind: "proposal";
+    proposal: ProposalWithSender;
+}) => IncomingMessageAction;
+export declare const acceptAll: IncomingMessageCallback;

package/dist/src/IncomingMessageAction.js

@@ -0,0 +1,2 @@
+export const acceptAll = () => "accept";
+//# sourceMappingURL=IncomingMessageAction.js.map

package/dist/src/IncomingMessageAction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IncomingMessageAction.js","sourceRoot":"","sources":["../../src/IncomingMessageAction.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,MAAM,SAAS,GAA4B,GAAG,EAAE,CAAC,QAAQ,CAAA"}

package/dist/src/authenticatedContent.d.ts

@@ -0,0 +1,32 @@
+import { Decoder } from "./codec/tlsDecoder";
+import { Encoder } from "./codec/tlsEncoder";
+import { Hash } from "./crypto/hash";
+import { FramedContent, FramedContentApplicationData, FramedContentAuthData, FramedContentCommitData, FramedContentData, FramedContentProposalData, FramedContentTBS } from "./framedContent";
+import { WireformatName } from "./wireformat";
+export type AuthenticatedContent = {
+    wireformat: WireformatName;
+    content: FramedContent;
+    auth: FramedContentAuthData;
+};
+export type AuthenticatedContentApplication = AuthenticatedContent & {
+    content: FramedContentApplicationData & FramedContentData;
+};
+export type AuthenticatedContentCommit = AuthenticatedContent & {
+    content: FramedContentCommitData & FramedContentData;
+};
+export type AuthenticatedContentProposal = AuthenticatedContent & {
+    content: FramedContentProposalData & FramedContentData;
+};
+export type AuthenticatedContentProposalOrCommit = AuthenticatedContent & {
+    content: (FramedContentProposalData | FramedContentCommitData) & FramedContentData;
+};
+export declare const encodeAuthenticatedContent: Encoder<AuthenticatedContent>;
+export declare const decodeAuthenticatedContent: Decoder<AuthenticatedContent>;
+export type AuthenticatedContentTBM = {
+    contentTbs: FramedContentTBS;
+    auth: FramedContentAuthData;
+};
+export declare const encodeAuthenticatedContentTBM: Encoder<AuthenticatedContentTBM>;
+export declare function createMembershipTag(membershipKey: Uint8Array, tbm: AuthenticatedContentTBM, h: Hash): Promise<Uint8Array>;
+export declare function verifyMembershipTag(membershipKey: Uint8Array, tbm: AuthenticatedContentTBM, tag: Uint8Array, h: Hash): Promise<boolean>;
+export declare function makeProposalRef(proposal: AuthenticatedContent, h: Hash): Promise<Uint8Array>;

package/dist/src/authenticatedContent.js

@@ -0,0 +1,26 @@
+import { flatMapDecoder, mapDecoder, mapDecoders } from "./codec/tlsDecoder";
+import { contramapEncoders } from "./codec/tlsEncoder";
+import { refhash } from "./crypto/hash";
+import { decodeFramedContent, decodeFramedContentAuthData, encodeFramedContent, encodeFramedContentAuthData, encodeFramedContentTBS, } from "./framedContent";
+import { decodeWireformat, encodeWireformat } from "./wireformat";
+export const encodeAuthenticatedContent = contramapEncoders([encodeWireformat, encodeFramedContent, encodeFramedContentAuthData], (a) => [a.wireformat, a.content, a.auth]);
+export const decodeAuthenticatedContent = mapDecoders([
+    decodeWireformat,
+    flatMapDecoder(decodeFramedContent, (content) => {
+        return mapDecoder(decodeFramedContentAuthData(content.contentType), (auth) => ({ content, auth }));
+    }),
+], (wireformat, contentAuth) => ({
+    wireformat,
+    ...contentAuth,
+}));
+export const encodeAuthenticatedContentTBM = contramapEncoders([encodeFramedContentTBS, encodeFramedContentAuthData], (t) => [t.contentTbs, t.auth]);
+export function createMembershipTag(membershipKey, tbm, h) {
+    return h.mac(membershipKey, encodeAuthenticatedContentTBM(tbm));
+}
+export function verifyMembershipTag(membershipKey, tbm, tag, h) {
+    return h.verifyMac(membershipKey, tag, encodeAuthenticatedContentTBM(tbm));
+}
+export function makeProposalRef(proposal, h) {
+    return refhash("MLS 1.0 Proposal Reference", encodeAuthenticatedContent(proposal), h);
+}
+//# sourceMappingURL=authenticatedContent.js.map

package/dist/src/authenticatedContent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authenticatedContent.js","sourceRoot":"","sources":["../../src/authenticatedContent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACrF,OAAO,EAAE,iBAAiB,EAAW,MAAM,oBAAoB,CAAA;AAC/D,OAAO,EAAQ,OAAO,EAAE,MAAM,eAAe,CAAA;AAC7C,OAAO,EACL,mBAAmB,EACnB,2BAA2B,EAC3B,mBAAmB,EACnB,2BAA2B,EAC3B,sBAAsB,GAQvB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAkB,MAAM,cAAc,CAAA;AAuBjF,MAAM,CAAC,MAAM,0BAA0B,GAAkC,iBAAiB,CACxF,CAAC,gBAAgB,EAAE,mBAAmB,EAAE,2BAA2B,CAAC,EACpE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAU,CAClD,CAAA;AAED,MAAM,CAAC,MAAM,0BAA0B,GAAkC,WAAW,CAClF;IACE,gBAAgB;IAChB,cAAc,CAAC,mBAAmB,EAAE,CAAC,OAAO,EAAE,EAAE;QAC9C,OAAO,UAAU,CAAC,2BAA2B,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;IACpG,CAAC,CAAC;CACH,EACD,CAAC,UAAU,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;IAC5B,UAAU;IACV,GAAG,WAAW;CACf,CAAC,CACH,CAAA;AAOD,MAAM,CAAC,MAAM,6BAA6B,GAAqC,iBAAiB,CAC9F,CAAC,sBAAsB,EAAE,2BAA2B,CAAC,EACrD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAU,CACvC,CAAA;AAED,MAAM,UAAU,mBAAmB,CACjC,aAAyB,EACzB,GAA4B,EAC5B,CAAO;IAEP,OAAO,CAAC,CAAC,GAAG,CAAC,aAAa,EAAE,6BAA6B,CAAC,GAAG,CAAC,CAAC,CAAA;AACjE,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,aAAyB,EACzB,GAA4B,EAC5B,GAAe,EACf,CAAO;IAEP,OAAO,CAAC,CAAC,SAAS,CAAC,aAAa,EAAE,GAAG,EAAE,6BAA6B,CAAC,GAAG,CAAC,CAAC,CAAA;AAC5E,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,QAA8B,EAAE,CAAO;IACrE,OAAO,OAAO,CAAC,4BAA4B,EAAE,0BAA0B,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAA;AACvF,CAAC"}

package/dist/src/authenticationService.d.ts

@@ -0,0 +1,7 @@
+import { Credential } from "./credential";
+export interface AuthenticationService {
+    validateCredential(credential: Credential, signaturePublicKey: Uint8Array): Promise<boolean>;
+}
+export declare const defaultAuthenticationService: {
+    validateCredential(_credential: Credential, _signaturePublicKey: Uint8Array): Promise<boolean>;
+};

package/dist/src/authenticationService.js

@@ -0,0 +1,6 @@
+export const defaultAuthenticationService = {
+    async validateCredential(_credential, _signaturePublicKey) {
+        return true;
+    },
+};
+//# sourceMappingURL=authenticationService.js.map

package/dist/src/authenticationService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authenticationService.js","sourceRoot":"","sources":["../../src/authenticationService.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,KAAK,CAAC,kBAAkB,CAAC,WAAuB,EAAE,mBAA+B;QAC/E,OAAO,IAAI,CAAA;IACb,CAAC;CACF,CAAA"}

package/dist/src/capabilities.d.ts

@@ -0,0 +1,14 @@
+import { CredentialTypeName } from "./credentialType";
+import { CiphersuiteName } from "./crypto/ciphersuite";
+import { ProtocolVersionName } from "./protocolVersion";
+import { Encoder } from "./codec/tlsEncoder";
+import { Decoder } from "./codec/tlsDecoder";
+export type Capabilities = {
+    versions: ProtocolVersionName[];
+    ciphersuites: CiphersuiteName[];
+    extensions: number[];
+    proposals: number[];
+    credentials: CredentialTypeName[];
+};
+export declare const encodeCapabilities: Encoder<Capabilities>;
+export declare const decodeCapabilities: Decoder<Capabilities>;

package/dist/src/capabilities.js

@@ -0,0 +1,28 @@
+import { decodeCredentialType, encodeCredentialType } from "./credentialType";
+import { decodeCiphersuite, encodeCiphersuite } from "./crypto/ciphersuite";
+import { decodeProtocolVersion, encodeProtocolVersion } from "./protocolVersion";
+import { contramapEncoders } from "./codec/tlsEncoder";
+import { mapDecoders } from "./codec/tlsDecoder";
+import { decodeVarLenType, encodeVarLenType } from "./codec/variableLength";
+import { decodeUint16, encodeUint16 } from "./codec/number";
+export const encodeCapabilities = contramapEncoders([
+    encodeVarLenType(encodeProtocolVersion),
+    encodeVarLenType(encodeCiphersuite),
+    encodeVarLenType(encodeUint16),
+    encodeVarLenType(encodeUint16),
+    encodeVarLenType(encodeCredentialType),
+], (cap) => [cap.versions, cap.ciphersuites, cap.extensions, cap.proposals, cap.credentials]);
+export const decodeCapabilities = mapDecoders([
+    decodeVarLenType(decodeProtocolVersion),
+    decodeVarLenType(decodeCiphersuite),
+    decodeVarLenType(decodeUint16),
+    decodeVarLenType(decodeUint16),
+    decodeVarLenType(decodeCredentialType),
+], (versions, ciphersuites, extensions, proposals, credentials) => ({
+    versions,
+    ciphersuites,
+    extensions,
+    proposals,
+    credentials,
+}));
+//# sourceMappingURL=capabilities.js.map

package/dist/src/capabilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"capabilities.js","sourceRoot":"","sources":["../../src/capabilities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AACjG,OAAO,EAAmB,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC5F,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAuB,MAAM,mBAAmB,CAAA;AACrG,OAAO,EAAW,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAC/D,OAAO,EAAW,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACzD,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAC3E,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAU3D,MAAM,CAAC,MAAM,kBAAkB,GAA0B,iBAAiB,CACxE;IACE,gBAAgB,CAAC,qBAAqB,CAAC;IACvC,gBAAgB,CAAC,iBAAiB,CAAC;IACnC,gBAAgB,CAAC,YAAY,CAAC;IAC9B,gBAAgB,CAAC,YAAY,CAAC;IAC9B,gBAAgB,CAAC,oBAAoB,CAAC;CACvC,EACD,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,WAAW,CAAU,CACnG,CAAA;AAED,MAAM,CAAC,MAAM,kBAAkB,GAA0B,WAAW,CAClE;IACE,gBAAgB,CAAC,qBAAqB,CAAC;IACvC,gBAAgB,CAAC,iBAAiB,CAAC;IACnC,gBAAgB,CAAC,YAAY,CAAC;IAC9B,gBAAgB,CAAC,YAAY,CAAC;IAC9B,gBAAgB,CAAC,oBAAoB,CAAC;CACvC,EACD,CAAC,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;IAC/D,QAAQ;IACR,YAAY;IACZ,UAAU;IACV,SAAS;IACT,WAAW;CACZ,CAAC,CACH,CAAA"}

package/dist/src/clientConfig.d.ts

@@ -0,0 +1,21 @@
+import { AuthenticationService } from "./authenticationService";
+import { KeyPackageEqualityConfig } from "./keyPackageEqualityConfig";
+import { KeyRetentionConfig } from "./keyRetentionConfig";
+import { LifetimeConfig } from "./lifetimeConfig";
+import { PaddingConfig } from "./paddingConfig";
+export type ClientConfig = {
+    keyRetentionConfig: KeyRetentionConfig;
+    lifetimeConfig: LifetimeConfig;
+    keyPackageEqualityConfig: KeyPackageEqualityConfig;
+    paddingConfig: PaddingConfig;
+    authService: AuthenticationService;
+};
+export declare const defaultClientConfig: {
+    keyRetentionConfig: KeyRetentionConfig;
+    lifetimeConfig: LifetimeConfig;
+    keyPackageEqualityConfig: KeyPackageEqualityConfig;
+    paddingConfig: PaddingConfig;
+    authService: {
+        validateCredential(_credential: import("./credential").Credential, _signaturePublicKey: Uint8Array): Promise<boolean>;
+    };
+};

package/dist/src/clientConfig.js

@@ -0,0 +1,13 @@
+import { defaultAuthenticationService } from "./authenticationService";
+import { defaultKeyPackageEqualityConfig } from "./keyPackageEqualityConfig";
+import { defaultKeyRetentionConfig } from "./keyRetentionConfig";
+import { defaultLifetimeConfig } from "./lifetimeConfig";
+import { defaultPaddingConfig } from "./paddingConfig";
+export const defaultClientConfig = {
+    keyRetentionConfig: defaultKeyRetentionConfig,
+    lifetimeConfig: defaultLifetimeConfig,
+    keyPackageEqualityConfig: defaultKeyPackageEqualityConfig,
+    paddingConfig: defaultPaddingConfig,
+    authService: defaultAuthenticationService,
+};
+//# sourceMappingURL=clientConfig.js.map

package/dist/src/clientConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientConfig.js","sourceRoot":"","sources":["../../src/clientConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,4BAA4B,EAAE,MAAM,yBAAyB,CAAA;AAC7F,OAAO,EAAE,+BAA+B,EAA4B,MAAM,4BAA4B,CAAA;AACtG,OAAO,EAAE,yBAAyB,EAAsB,MAAM,sBAAsB,CAAA;AACpF,OAAO,EAAE,qBAAqB,EAAkB,MAAM,kBAAkB,CAAA;AACxE,OAAO,EAAE,oBAAoB,EAAiB,MAAM,iBAAiB,CAAA;AAUrE,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,kBAAkB,EAAE,yBAAyB;IAC7C,cAAc,EAAE,qBAAqB;IACrC,wBAAwB,EAAE,+BAA+B;IACzD,aAAa,EAAE,oBAAoB;IACnC,WAAW,EAAE,4BAA4B;CAC1C,CAAA"}

package/dist/src/clientState.d.ts

@@ -0,0 +1,122 @@
+import { AuthenticatedContent } from "./authenticatedContent";
+import { CiphersuiteImpl } from "./crypto/ciphersuite";
+import { Hash } from "./crypto/hash";
+import { Extension } from "./extension";
+import { FramedContentCommit } from "./framedContent";
+import { GroupContext } from "./groupContext";
+import { KeyPackage, PrivateKeyPackage } from "./keyPackage";
+import { KeySchedule } from "./keySchedule";
+import { PreSharedKeyID } from "./presharedkey";
+import { RatchetTree } from "./ratchetTree";
+import { SecretTree } from "./secretTree";
+import { Welcome } from "./welcome";
+import { WireformatName } from "./wireformat";
+import { ProposalOrRef } from "./proposalOrRefType";
+import { Proposal, ProposalAdd, ProposalExternalInit, ProposalGroupContextExtensions, ProposalPSK, ProposalReinit, ProposalRemove, ProposalUpdate, Reinit } from "./proposal";
+import { PrivateKeyPath } from "./privateKeyPath";
+import { UnappliedProposals, ProposalWithSender } from "./unappliedProposals";
+import { PskIndex } from "./pskIndex";
+import { MlsError } from "./mlsError";
+import { Signature } from "./crypto/signature";
+import { LeafNodeCommit, LeafNodeUpdate } from "./leafNode";
+import { AuthenticationService } from "./authenticationService";
+import { LifetimeConfig } from "./lifetimeConfig";
+import { ClientConfig } from "./clientConfig";
+export type ClientState = {
+    groupContext: GroupContext;
+    keySchedule: KeySchedule;
+    secretTree: SecretTree;
+    ratchetTree: RatchetTree;
+    privatePath: PrivateKeyPath;
+    signaturePrivateKey: Uint8Array;
+    unappliedProposals: UnappliedProposals;
+    confirmationTag: Uint8Array;
+    historicalReceiverData: Map<bigint, EpochReceiverData>;
+    groupActiveState: GroupActiveState;
+    clientConfig: ClientConfig;
+};
+export type GroupActiveState = {
+    kind: "active";
+} | {
+    kind: "suspendedPendingReinit";
+    reinit: Reinit;
+} | {
+    kind: "removedFromGroup";
+};
+/**
+ * This type contains everything necessary to receieve application messages for an earlier epoch
+ */
+export type EpochReceiverData = {
+    resumptionPsk: Uint8Array;
+    secretTree: SecretTree;
+    ratchetTree: RatchetTree;
+    senderDataSecret: Uint8Array;
+    groupContext: GroupContext;
+};
+export declare function checkCanSendApplicationMessages(state: ClientState): void;
+export declare function checkCanSendHandshakeMessages(state: ClientState): void;
+export type Proposals = {
+    add: {
+        senderLeafIndex: number | undefined;
+        proposal: ProposalAdd;
+    }[];
+    update: {
+        senderLeafIndex: number | undefined;
+        proposal: ProposalUpdate;
+    }[];
+    remove: {
+        senderLeafIndex: number | undefined;
+        proposal: ProposalRemove;
+    }[];
+    psk: {
+        senderLeafIndex: number | undefined;
+        proposal: ProposalPSK;
+    }[];
+    reinit: {
+        senderLeafIndex: number | undefined;
+        proposal: ProposalReinit;
+    }[];
+    external_init: {
+        senderLeafIndex: number | undefined;
+        proposal: ProposalExternalInit;
+    }[];
+    group_context_extensions: {
+        senderLeafIndex: number | undefined;
+        proposal: ProposalGroupContextExtensions;
+    }[];
+};
+export declare function validateRatchetTree(tree: RatchetTree, groupContext: GroupContext, config: LifetimeConfig, authService: AuthenticationService, treeHash: Uint8Array, cs: CiphersuiteImpl): Promise<MlsError | undefined>;
+export declare function validateLeafNodeUpdateOrCommit(leafNode: LeafNodeCommit | LeafNodeUpdate, leafIndex: number, groupContext: GroupContext, tree: RatchetTree, authService: AuthenticationService, s: Signature): Promise<MlsError | undefined>;
+export declare function throwIfDefined(err: MlsError | undefined): void;
+export type ApplyProposalsResult = {
+    tree: RatchetTree;
+    pskSecret: Uint8Array;
+    pskIds: PreSharedKeyID[];
+    needsUpdatePath: boolean;
+    additionalResult: ApplyProposalsData;
+    selfRemoved: boolean;
+    allProposals: ProposalWithSender[];
+};
+export type ApplyProposalsData = {
+    kind: "memberCommit";
+    addedLeafNodes: [number, KeyPackage][];
+    extensions: Extension[];
+} | {
+    kind: "externalCommit";
+    externalInitSecret: Uint8Array;
+    newMemberLeafIndex: number;
+} | {
+    kind: "reinit";
+    reinit: Reinit;
+};
+export declare function applyProposals(state: ClientState, proposals: ProposalOrRef[], committerLeafIndex: number | undefined, pskSearch: PskIndex, sentByClient: boolean, cs: CiphersuiteImpl): Promise<ApplyProposalsResult>;
+export declare function makePskIndex(state: ClientState | undefined, externalPsks: Record<string, Uint8Array>): PskIndex;
+export declare function nextEpochContext(groupContext: GroupContext, wireformat: WireformatName, content: FramedContentCommit, signature: Uint8Array, updatedTreeHash: Uint8Array, confirmationTag: Uint8Array, h: Hash): Promise<GroupContext>;
+export declare function joinGroup(welcome: Welcome, keyPackage: KeyPackage, privateKeys: PrivateKeyPackage, pskSearch: PskIndex, cs: CiphersuiteImpl, ratchetTree?: RatchetTree, resumingFromState?: ClientState, clientConfig?: ClientConfig): Promise<ClientState>;
+export declare function createGroup(groupId: Uint8Array, keyPackage: KeyPackage, privateKeyPackage: PrivateKeyPackage, extensions: Extension[], cs: CiphersuiteImpl, clientConfig?: ClientConfig): Promise<ClientState>;
+export declare function exportSecret(publicKey: Uint8Array, cs: CiphersuiteImpl): Promise<{
+    enc: Uint8Array;
+    secret: Uint8Array;
+}>;
+export declare function processProposal(state: ClientState, content: AuthenticatedContent, proposal: Proposal, h: Hash): Promise<ClientState>;
+export declare function addHistoricalReceiverData(state: ClientState): Map<bigint, EpochReceiverData>;