Use ProtocolVersionValue instead of ProtocolVersionName

Author: LukaJCB

README.md

@@ -84,6 +84,7 @@ import {
   generateKeyPackage,
   encodeMlsMessage,
   decodeMlsMessage,
+  protocolVersions,
   Proposal,
   zeroOutUint8Array,
 } from "ts-mls"
@@ -107,7 +108,7 @@ const bob = await generateKeyPackage(bobCredential, defaultCapabilities(), defau
 const keyPackageMessage = encodeMlsMessage({
   keyPackage: bob.publicPackage,
   wireformat: "mls_key_package",
-  version: "mls10",
+  version: protocolVersions.mls10,
 })
 
 // alice decodes bob's keyPackage
@@ -135,7 +136,7 @@ commitResult.consumed.forEach(zeroOutUint8Array)
 const encodedWelcome = encodeMlsMessage({
   welcome: commitResult.welcome!,
   wireformat: "mls_welcome",
-  version: "mls10",
+  version: protocolVersions.mls10,
 })
 
 // bob decodes the welcome message
@@ -167,7 +168,7 @@ aliceCreateMessageResult.consumed.forEach(zeroOutUint8Array)
 const encodedPrivateMessageAlice = encodeMlsMessage({
   privateMessage: aliceCreateMessageResult.privateMessage,
   wireformat: "mls_private_message",
-  version: "mls10",
+  version: protocolVersions.mls10,
 })
 
 // bob decodes the message

src/capabilities.ts

@@ -1,14 +1,14 @@
 import { CredentialTypeName, decodeCredentialType, credentialTypeEncoder } from "./credentialType.js"
-import { CiphersuiteId } from "./crypto/ciphersuite.js"
-import { decodeProtocolVersion, protocolVersionEncoder, ProtocolVersionName } from "./protocolVersion.js"
+import { ciphersuiteEncoder, CiphersuiteId, decodeCiphersuite } from "./crypto/ciphersuite.js"
+import { decodeProtocolVersion, protocolVersionEncoder, ProtocolVersionValue } from "./protocolVersion.js"
 import { BufferEncoder, contramapBufferEncoders, encode, Encoder } from "./codec/tlsEncoder.js"
 import { Decoder, mapDecoders } from "./codec/tlsDecoder.js"
 import { decodeVarLenType, varLenTypeEncoder } from "./codec/variableLength.js"
 import { decodeUint16, uint16Encoder } from "./codec/number.js"
 
 /** @public */
 export interface Capabilities {
-  versions: ProtocolVersionName[]
+  versions: ProtocolVersionValue[]
   ciphersuites: CiphersuiteId[]
   extensions: number[]
   proposals: number[]
@@ -18,7 +18,7 @@ export interface Capabilities {
 export const capabilitiesEncoder: BufferEncoder<Capabilities> = contramapBufferEncoders(
   [
     varLenTypeEncoder(protocolVersionEncoder),
-    varLenTypeEncoder(uint16Encoder),
+    varLenTypeEncoder(ciphersuiteEncoder),
     varLenTypeEncoder(uint16Encoder),
     varLenTypeEncoder(uint16Encoder),
     varLenTypeEncoder(credentialTypeEncoder),
@@ -31,14 +31,14 @@ export const encodeCapabilities: Encoder<Capabilities> = encode(capabilitiesEnco
 export const decodeCapabilities: Decoder<Capabilities> = mapDecoders(
   [
     decodeVarLenType(decodeProtocolVersion),
-    decodeVarLenType(decodeUint16),
+    decodeVarLenType(decodeCiphersuite),
     decodeVarLenType(decodeUint16),
     decodeVarLenType(decodeUint16),
     decodeVarLenType(decodeCredentialType),
   ],
   (versions, ciphersuites, extensions, proposals, credentials) => ({
     versions,
-    ciphersuites: ciphersuites as CiphersuiteId[],
+    ciphersuites,
     extensions,
     proposals,
     credentials,

src/clientState.ts

@@ -689,7 +689,7 @@ function validateReinit(
 ): ValidationError | undefined {
   if (allProposals.length !== 1) return new ValidationError("Reinit proposal needs to be commited by itself")
 
-  if (protocolVersions[reinit.version] < protocolVersions[gc.version])
+  if (reinit.version < gc.version)
     return new ValidationError("A ReInit proposal cannot use a version less than the version for the current group")
 }
 
@@ -1102,7 +1102,7 @@ export async function createGroup(
   const confirmedTranscriptHash = new Uint8Array()
 
   const groupContext: GroupContext = {
-    version: "mls10",
+    version: protocolVersions.mls10,
     cipherSuite: cs.name,
     epoch: 0n,
     treeHash: await treeHashRoot(ratchetTree, cs.hash),

src/createCommit.ts

@@ -10,6 +10,7 @@ import {
 } from "./clientState.js"
 import { GroupActiveState } from "./groupActiveState.js"
 import { CiphersuiteImpl } from "./crypto/ciphersuite.js"
+import { protocolVersions } from "./protocolVersion.js"
 import { decryptWithLabel } from "./crypto/hpke.js"
 import { deriveSecret } from "./crypto/kdf.js"
 import {
@@ -427,7 +428,11 @@ async function protectCommit(
       cs,
     )
 
-    return [{ version: "mls10", wireformat: "mls_public_message", publicMessage: msg }, state.secretTree, []]
+    return [
+      { version: protocolVersions.mls10, wireformat: "mls_public_message", publicMessage: msg },
+      state.secretTree,
+      [],
+    ]
   } else {
     const res = await protect(
       state.keySchedule.senderDataSecret,
@@ -441,7 +446,7 @@ async function protectCommit(
     )
 
     return [
-      { version: "mls10", wireformat: "mls_private_message", privateMessage: res.privateMessage },
+      { version: protocolVersions.mls10, wireformat: "mls_private_message", privateMessage: res.privateMessage },
       res.tree,
       res.consumed,
     ]

src/createMessage.ts

@@ -6,6 +6,7 @@ import { protectProposal, protectApplicationData } from "./messageProtection.js"
 import { protectProposalPublic } from "./messageProtectionPublic.js"
 import { Proposal } from "./proposal.js"
 import { addUnappliedProposal } from "./unappliedProposals.js"
+import { protocolVersions } from "./protocolVersion.js"
 
 /** @public */
 export async function createProposal(
@@ -33,7 +34,11 @@ export async function createProposal(
     )
     return {
       newState,
-      message: { wireformat: "mls_public_message", version: "mls10", publicMessage: result.publicMessage },
+      message: {
+        wireformat: "mls_public_message",
+        version: protocolVersions.mls10,
+        publicMessage: result.publicMessage,
+      },
       consumed: [],
     }
   } else {
@@ -62,7 +67,11 @@ export async function createProposal(
 
     return {
       newState,
-      message: { wireformat: "mls_private_message", version: "mls10", privateMessage: result.privateMessage },
+      message: {
+        wireformat: "mls_private_message",
+        version: protocolVersions.mls10,
+        privateMessage: result.privateMessage,
+      },
       consumed: result.consumed,
     }
   }

src/defaultCapabilities.ts

@@ -1,11 +1,12 @@
 import { Capabilities } from "./capabilities.js"
 import { ciphersuites, CiphersuiteId } from "./crypto/ciphersuite.js"
 import { greaseCapabilities, defaultGreaseConfig } from "./grease.js"
+import { protocolVersions } from "./protocolVersion.js"
 
 /** @public */
 export function defaultCapabilities(): Capabilities {
   return greaseCapabilities(defaultGreaseConfig, {
-    versions: ["mls10"],
+    versions: [protocolVersions.mls10],
     ciphersuites: Object.values(ciphersuites) as CiphersuiteId[],
     extensions: [],
     proposals: [],

src/framedContent.ts

@@ -17,7 +17,7 @@ import { Signature, signWithLabel, verifyWithLabel } from "./crypto/signature.js
 import { groupContextEncoder, GroupContext } from "./groupContext.js"
 import { wireformatEncoder, WireformatName } from "./wireformat.js"
 import { decodeProposal, proposalEncoder, Proposal } from "./proposal.js"
-import { protocolVersionEncoder, ProtocolVersionName } from "./protocolVersion.js"
+import { protocolVersionEncoder, ProtocolVersionValue } from "./protocolVersion.js"
 import {
   decodeSender,
   senderEncoder,
@@ -176,7 +176,7 @@ export const senderInfoEncoder: BufferEncoder<SenderInfo> = (info) => {
 export const encodeSenderInfo: Encoder<SenderInfo> = encode(senderInfoEncoder)
 
 export type FramedContentTBS = {
-  protocolVersion: ProtocolVersionName
+  protocolVersion: ProtocolVersionValue
   wireformat: WireformatName
   content: FramedContent
 } & SenderInfo

src/groupContext.ts

@@ -7,11 +7,11 @@ import { CiphersuiteId, ciphersuiteEncoder, decodeCiphersuite } from "./crypto/c
 import { expandWithLabel, Kdf } from "./crypto/kdf.js"
 import { decodeExtension, extensionEncoder, Extension } from "./extension.js"
 
-import { decodeProtocolVersion, protocolVersionEncoder, ProtocolVersionName } from "./protocolVersion.js"
+import { decodeProtocolVersion, protocolVersionEncoder, ProtocolVersionValue } from "./protocolVersion.js"
 
 /** @public */
 export interface GroupContext {
-  version: ProtocolVersionName
+  version: ProtocolVersionValue
   cipherSuite: CiphersuiteId
   groupId: Uint8Array
   epoch: bigint

src/index.ts

@@ -137,7 +137,7 @@ export { type Encoder } from "./codec/tlsEncoder.js"
 export { type Brand } from "./util/brand.js"
 
 export { type ContentTypeName } from "./contentType.js"
-export { type ProtocolVersionName } from "./protocolVersion.js"
+export { type ProtocolVersionName, type ProtocolVersionValue } from "./protocolVersion.js"
 
 export { type CredentialTypeName } from "./credentialType.js"
 export { type CredentialBasic, type CredentialX509 } from "./credential.js"

src/keyPackage.ts

@@ -5,7 +5,12 @@ import { CiphersuiteId, CiphersuiteImpl, ciphersuiteEncoder, decodeCiphersuite }
 import { Hash, refhash } from "./crypto/hash.js"
 import { Signature, signWithLabel, verifyWithLabel } from "./crypto/signature.js"
 import { decodeExtension, extensionEncoder, Extension } from "./extension.js"
-import { decodeProtocolVersion, protocolVersionEncoder, ProtocolVersionName } from "./protocolVersion.js"
+import {
+  decodeProtocolVersion,
+  protocolVersionEncoder,
+  protocolVersions,
+  ProtocolVersionValue,
+} from "./protocolVersion.js"
 import {
   decodeLeafNodeKeyPackage,
   leafNodeEncoder,
@@ -19,7 +24,7 @@ import { Credential } from "./credential.js"
 
 /** @public */
 export type KeyPackageTBS = {
-  version: ProtocolVersionName
+  version: ProtocolVersionValue
   cipherSuite: CiphersuiteId
   initKey: Uint8Array
   leafNode: LeafNodeKeyPackage
@@ -130,7 +135,7 @@ export async function generateKeyPackageWithKey(
   }
 
   const tbs: KeyPackageTBS = {
-    version: "mls10",
+    version: protocolVersions.mls10,
     cipherSuite: cs.name,
     initKey: await cs.hpke.exportPublicKey(initKeys.publicKey),
     leafNode: await signLeafNodeKeyPackage(leafNodeTbs, signatureKeyPair.signKey, cs.signature),