ts-mls 1.1.0 → 1.2.0

package/README.md

@@ -98,7 +98,7 @@ 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
+// bob generates his key package
 const bobCredential: Credential = { credentialType: "basic", identity: new TextEncoder().encode("bob") }
 const bob = await generateKeyPackage(bobCredential, defaultCapabilities(), defaultLifetime, [], impl)
 
@@ -123,7 +123,7 @@ const addBobProposal: Proposal = {
 }
 
 // alice commits
-const commitResult = await createCommit(aliceGroup, emptyPskIndex, false, [addBobProposal], impl)
+const commitResult = await createCommit({ state: aliceGroup, cipherSuite: impl }, { extraProposals: [addBobProposal] })
 
 aliceGroup = commitResult.newState
 

package/dist/authenticatedContent.d.ts

@@ -0,0 +1,32 @@
+import { Decoder } from "./codec/tlsDecoder.js";
+import { Encoder } from "./codec/tlsEncoder.js";
+import { Hash } from "./crypto/hash.js";
+import { FramedContent, FramedContentApplicationData, FramedContentAuthData, FramedContentCommitData, FramedContentData, FramedContentProposalData, FramedContentTBS } from "./framedContent.js";
+import { WireformatName } from "./wireformat.js";
+export interface 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 interface 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/authenticatedContent.js

@@ -0,0 +1,26 @@
+import { flatMapDecoder, mapDecoder, mapDecoders } from "./codec/tlsDecoder.js";
+import { contramapEncoders } from "./codec/tlsEncoder.js";
+import { refhash } from "./crypto/hash.js";
+import { decodeFramedContent, decodeFramedContentAuthData, encodeFramedContent, encodeFramedContentAuthData, encodeFramedContentTBS, } from "./framedContent.js";
+import { decodeWireformat, encodeWireformat } from "./wireformat.js";
+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/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,uBAAuB,CAAA;AACxF,OAAO,EAAE,iBAAiB,EAAW,MAAM,uBAAuB,CAAA;AAClE,OAAO,EAAQ,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAChD,OAAO,EACL,mBAAmB,EACnB,2BAA2B,EAC3B,mBAAmB,EACnB,2BAA2B,EAC3B,sBAAsB,GAQvB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAkB,MAAM,iBAAiB,CAAA;AAuBpF,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/authenticationService.d.ts

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

package/dist/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/capabilities.d.ts

@@ -0,0 +1,14 @@
+import { CredentialTypeName } from "./credentialType.js";
+import { CiphersuiteName } from "./crypto/ciphersuite.js";
+import { ProtocolVersionName } from "./protocolVersion.js";
+import { Encoder } from "./codec/tlsEncoder.js";
+import { Decoder } from "./codec/tlsDecoder.js";
+export interface 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/capabilities.js

@@ -0,0 +1,28 @@
+import { decodeCredentialType, encodeCredentialType } from "./credentialType.js";
+import { decodeCiphersuite, encodeCiphersuite } from "./crypto/ciphersuite.js";
+import { decodeProtocolVersion, encodeProtocolVersion } from "./protocolVersion.js";
+import { contramapEncoders } from "./codec/tlsEncoder.js";
+import { mapDecoders } from "./codec/tlsDecoder.js";
+import { decodeVarLenType, encodeVarLenType } from "./codec/variableLength.js";
+import { decodeUint16, encodeUint16 } from "./codec/number.js";
+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/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,qBAAqB,CAAA;AACpG,OAAO,EAAmB,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC/F,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAuB,MAAM,sBAAsB,CAAA;AACxG,OAAO,EAAW,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AAClE,OAAO,EAAW,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAC9E,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAU9D,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/clientConfig.d.ts

@@ -0,0 +1,21 @@
+import { AuthenticationService } from "./authenticationService.js";
+import { KeyPackageEqualityConfig } from "./keyPackageEqualityConfig.js";
+import { KeyRetentionConfig } from "./keyRetentionConfig.js";
+import { LifetimeConfig } from "./lifetimeConfig.js";
+import { PaddingConfig } from "./paddingConfig.js";
+export interface 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.js").Credential, _signaturePublicKey: Uint8Array): Promise<boolean>;
+    };
+};

package/dist/clientConfig.js

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

package/dist/clientConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientConfig.js","sourceRoot":"","sources":["../src/clientConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,4BAA4B,EAAE,MAAM,4BAA4B,CAAA;AAChG,OAAO,EAAE,+BAA+B,EAA4B,MAAM,+BAA+B,CAAA;AACzG,OAAO,EAAE,yBAAyB,EAAsB,MAAM,yBAAyB,CAAA;AACvF,OAAO,EAAE,qBAAqB,EAAkB,MAAM,qBAAqB,CAAA;AAC3E,OAAO,EAAE,oBAAoB,EAAiB,MAAM,oBAAoB,CAAA;AAUxE,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/clientState.d.ts

@@ -0,0 +1,123 @@
+import { AuthenticatedContent } from "./authenticatedContent.js";
+import { CiphersuiteImpl } from "./crypto/ciphersuite.js";
+import { Hash } from "./crypto/hash.js";
+import { Extension } from "./extension.js";
+import { FramedContentCommit } from "./framedContent.js";
+import { GroupContext } from "./groupContext.js";
+import { KeyPackage, PrivateKeyPackage } from "./keyPackage.js";
+import { KeySchedule } from "./keySchedule.js";
+import { PreSharedKeyID } from "./presharedkey.js";
+import { RatchetTree } from "./ratchetTree.js";
+import { SecretTree } from "./secretTree.js";
+import { LeafIndex } from "./treemath.js";
+import { Welcome } from "./welcome.js";
+import { WireformatName } from "./wireformat.js";
+import { ProposalOrRef } from "./proposalOrRefType.js";
+import { Proposal, ProposalAdd, ProposalExternalInit, ProposalGroupContextExtensions, ProposalPSK, ProposalReinit, ProposalRemove, ProposalUpdate, Reinit } from "./proposal.js";
+import { PrivateKeyPath } from "./privateKeyPath.js";
+import { UnappliedProposals, ProposalWithSender } from "./unappliedProposals.js";
+import { PskIndex } from "./pskIndex.js";
+import { MlsError } from "./mlsError.js";
+import { Signature } from "./crypto/signature.js";
+import { LeafNodeCommit, LeafNodeUpdate } from "./leafNode.js";
+import { AuthenticationService } from "./authenticationService.js";
+import { LifetimeConfig } from "./lifetimeConfig.js";
+import { ClientConfig } from "./clientConfig.js";
+export interface 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 interface 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 interface 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 interface ApplyProposalsResult {
+    tree: RatchetTree;
+    pskSecret: Uint8Array;
+    pskIds: PreSharedKeyID[];
+    needsUpdatePath: boolean;
+    additionalResult: ApplyProposalsData;
+    selfRemoved: boolean;
+    allProposals: ProposalWithSender[];
+}
+export type ApplyProposalsData = {
+    kind: "memberCommit";
+    addedLeafNodes: [LeafIndex, KeyPackage][];
+    extensions: Extension[];
+} | {
+    kind: "externalCommit";
+    externalInitSecret: Uint8Array;
+    newMemberLeafIndex: LeafIndex;
+} | {
+    kind: "reinit";
+    reinit: Reinit;
+};
+export declare function applyProposals(state: ClientState, proposals: ProposalOrRef[], committerLeafIndex: LeafIndex | 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>;