chore: rename Ciphersuite -> CipherSuite [WPB-25044]

CHANGELOG.md

@@ -200,6 +200,12 @@
 
   Affected platforms: all
 
+- We aligned cipher suite spelling to CipherSuite
+
+  - renamed `Ciphersuite` -> `CipherSuite`
+
+  Affected platforms: all
+
 - Removed `WelcomeBundle` type that was returned from `processWelcomeMessage()` and `joinByExternalCommit()`. They
   return a `ConversationId` now only.
 

cc-book/src/cc10/migration-guide.md

@@ -32,6 +32,10 @@ the sub-pages:
    - renamed `removeKeypackage` → `removeKeyPackage`
    - renamed `removeKeypackagesFor` → `removeKeyPackagesFor`
 
+1. We aligned cipher suite spelling to `CipherSuite`:
+
+   - renamed `Ciphersuite` -> `CipherSuite`
+
 ## Higher-Level Newtypes
 
 1. `GroupInfo.new()` and `Welcome.new()` are now **fallible** constructors. Previously, both accepted any byte sequence

crypto-ffi/bindings/js/packages/browser/benches/addUser.bench.ts

@@ -24,7 +24,7 @@ describe("benchmark", () => {
                 });
                 for (const { userCount, cipherSuite } of parameters) {
                     window.bench.add(
-                        `cipherSuite=${window.ccModule.Ciphersuite[cipherSuite]} userCount=${userCount}`,
+                        `cipherSuite=${window.ccModule.CipherSuite[cipherSuite]} userCount=${userCount}`,
                         async () => {
                             const aliceCc = await window.helpers.ccInit({
                                 withBasicCredential: true,

crypto-ffi/bindings/js/packages/browser/benches/createMessage.bench.ts

@@ -34,7 +34,7 @@ describe("benchmark", () => {
                         await window.helpers.createConversation(cc);
 
                     window.bench.add(
-                        `cipherSuite=${window.ccModule.Ciphersuite[cipherSuite]} size=${size}B count=${count}`,
+                        `cipherSuite=${window.ccModule.CipherSuite[cipherSuite]} size=${size}B count=${count}`,
                         async () => {
                             await cc.transaction(async (ctx) => {
                                 for (let i = 0; i < count; i++) {

crypto-ffi/bindings/js/packages/browser/benches/joinGroup.bench.ts

@@ -24,7 +24,7 @@ describe("benchmark", () => {
                 });
                 for (const { userCount, cipherSuite } of parameters) {
                     window.bench.add(
-                        `cipherSuite=${window.ccModule.Ciphersuite[cipherSuite]} userCount=${userCount}`,
+                        `cipherSuite=${window.ccModule.CipherSuite[cipherSuite]} userCount=${userCount}`,
                         async () => {
                             const aliceCc = await window.helpers.ccInit({
                                 withBasicCredential: true,

crypto-ffi/bindings/js/packages/browser/benches/processMessage.bench.ts

@@ -47,7 +47,7 @@ describe("benchmark", () => {
                     // This means that we can't encrypt the messages beforehand as this would lead to bob decrypting
                     // the same messages over and over again.
                     window.bench.add(
-                        `cipherSuite=${window.ccModule.Ciphersuite[cipherSuite]} size=${size}B count=${count}`,
+                        `cipherSuite=${window.ccModule.CipherSuite[cipherSuite]} size=${size}B count=${count}`,
                         async () => {
                             const encryptedMessages = await aliceCc.transaction(
                                 async (ctx) => {

crypto-ffi/bindings/js/packages/browser/benches/removeUser.bench.ts

@@ -24,7 +24,7 @@ describe("benchmark", () => {
                 });
                 for (const { userCount, cipherSuite } of parameters) {
                     window.bench.add(
-                        `cipherSuite=${window.ccModule.Ciphersuite[cipherSuite]} userCount=${userCount}`,
+                        `cipherSuite=${window.ccModule.CipherSuite[cipherSuite]} userCount=${userCount}`,
                         async () => {
                             const aliceCc = await window.helpers.ccInit({
                                 withBasicCredential: true,

crypto-ffi/bindings/js/packages/browser/shared/utils.ts

@@ -1,16 +1,16 @@
-import type {
-    Ciphersuite,
-    ClientId,
-    CommitBundle,
-    ConversationId,
-    CoreCrypto,
-    CoreCryptoLogLevel,
-    GroupInfoBundle,
-    HistorySecret,
-    KeyPackage,
-    MlsTransport,
-    MlsTransportData,
-    Database,
+import {
+    CipherSuite,
+    type ClientId,
+    type CommitBundle,
+    type ConversationId,
+    type CoreCrypto,
+    type CoreCryptoLogLevel,
+    type Database,
+    type GroupInfoBundle,
+    type HistorySecret,
+    type KeyPackage,
+    type MlsTransport,
+    type MlsTransportData,
 } from "@wireapp/core-crypto/browser";
 
 import { browser } from "@wdio/globals";
@@ -105,7 +105,7 @@ export async function sharedSetup() {
 
             static async generateKeyPackage(
                 cc: CoreCrypto,
-                cipherSuite?: Ciphersuite
+                cipherSuite?: CipherSuite
             ): Promise<KeyPackage> {
                 if (cipherSuite === undefined) {
                     cipherSuite = window.defaultCipherSuite;
@@ -237,7 +237,7 @@ export async function sharedSetup() {
                 cc1: CoreCrypto,
                 cc2: CoreCrypto,
                 conversationId: ConversationId,
-                cipherSuite?: Ciphersuite
+                cipherSuite?: CipherSuite
             ): Promise<GroupInfoBundle> {
                 const kp = await window.helpers.generateKeyPackage(
                     cc2,
@@ -506,7 +506,7 @@ type CcInitOptions =
       }
     | {
           withBasicCredential?: true;
-          cipherSuite?: Ciphersuite;
+          cipherSuite?: CipherSuite;
           clientId?: ClientId;
       };
 
@@ -516,7 +516,7 @@ export interface Helpers {
     newDatabase(): Promise<Database>;
     generateKeyPackage(
         cc: CoreCrypto,
-        cipherSuite?: Ciphersuite
+        cipherSuite?: CipherSuite
     ): Promise<KeyPackage>;
     ccInit: (options?: CcInitOptions) => Promise<CoreCrypto>;
     recordLogs(): Promise<void>;
@@ -526,7 +526,7 @@ export interface Helpers {
         cc1: CoreCrypto,
         cc2: CoreCrypto,
         conversationId: ConversationId,
-        cipherSuite?: Ciphersuite
+        cipherSuite?: CipherSuite
     ): Promise<GroupInfoBundle>;
     remove(
         cc: CoreCrypto,

crypto-ffi/bindings/js/packages/browser/test/keyPackage.test.ts

@@ -142,12 +142,12 @@ describe("key package", () => {
                     clientId,
                 });
                 const credential1 = window.ccModule.Credential.basic(
-                    window.ccModule.Ciphersuite
+                    window.ccModule.CipherSuite
                         .Mls128Dhkemx25519Aes128gcmSha256Ed25519,
                     clientId
                 );
                 const credential2 = window.ccModule.Credential.basic(
-                    window.ccModule.Ciphersuite
+                    window.ccModule.CipherSuite
                         .Mls128Dhkemp256Aes128gcmSha256P256,
                     clientId
                 );

crypto-ffi/bindings/js/packages/browser/test/utils.ts

@@ -1,9 +1,9 @@
 import { browser } from "@wdio/globals";
 
-import type {
-    Ciphersuite,
-    CommitBundle,
-    PkiEnvironmentHooks,
+import {
+    CipherSuite,
+    type CommitBundle,
+    type PkiEnvironmentHooks,
     HttpMethod,
     HttpHeader,
 } from "@wireapp/core-crypto/browser";
@@ -21,7 +21,7 @@ type ccModuleType = typeof import("@wireapp/core-crypto/browser");
 declare global {
     interface Window {
         ccModule: ccModuleType;
-        defaultCipherSuite: Ciphersuite;
+        defaultCipherSuite: CipherSuite;
         deliveryService: DeliveryService;
         pkiEnvironmentHooks: PkiEnvironmentHooks;
         _latestCommitBundle: CommitBundle;
@@ -34,7 +34,7 @@ export async function setup() {
     await sharedSetup();
     await browser.execute(async () => {
         window.defaultCipherSuite =
-            window.ccModule.Ciphersuite.Mls128Dhkemx25519Aes128gcmSha256Ed25519;
+            window.ccModule.CipherSuite.Mls128Dhkemx25519Aes128gcmSha256Ed25519;
 
         window.pkiEnvironmentHooks = {
             async httpRequest(

crypto-ffi/bindings/js/packages/native/benches/addUser.bench.ts

@@ -3,7 +3,7 @@ import {
     tinybenchSetup,
     userBenchmarkParameters,
 } from "../../shared/benches/utils";
-import { Ciphersuite, type KeyPackage } from "@wireapp/core-crypto/native";
+import { CipherSuite, type KeyPackage } from "@wireapp/core-crypto/native";
 import { Bench } from "tinybench";
 import {
     setup,
@@ -27,7 +27,7 @@ async function run() {
     });
     for (const { userCount, cipherSuite } of parameters) {
         bench.add(
-            `cipherSuite=${Ciphersuite[cipherSuite]} userCount=${userCount}`,
+            `cipherSuite=${CipherSuite[cipherSuite]} userCount=${userCount}`,
             async () => {
                 const aliceCc = await ccInit({
                     withBasicCredential: true,

crypto-ffi/bindings/js/packages/native/benches/createMessage.bench.ts

@@ -1,5 +1,5 @@
 import { Bench } from "tinybench";
-import { Ciphersuite } from "@wireapp/core-crypto/native";
+import { CipherSuite } from "@wireapp/core-crypto/native";
 import {
     logResults,
     messageBenchmarkParameters,
@@ -25,7 +25,7 @@ async function run() {
         const conversationId = await createConversation(cc);
 
         bench.add(
-            `cipherSuite=${Ciphersuite[cipherSuite]} size=${size}B count=${count}`,
+            `cipherSuite=${CipherSuite[cipherSuite]} size=${size}B count=${count}`,
             async () => {
                 await cc.transaction(async (ctx) => {
                     for (let i = 0; i < count; i++) {

crypto-ffi/bindings/js/packages/native/benches/joinGroup.bench.ts

@@ -3,7 +3,7 @@ import {
     tinybenchSetup,
     userBenchmarkParameters,
 } from "../../shared/benches/utils";
-import { Ciphersuite, type KeyPackage } from "@wireapp/core-crypto/native";
+import { CipherSuite, type KeyPackage } from "@wireapp/core-crypto/native";
 import { Bench } from "tinybench";
 import {
     setup,
@@ -28,7 +28,7 @@ async function run() {
     });
     for (const { userCount, cipherSuite } of parameters) {
         bench.add(
-            `cipherSuite=${Ciphersuite[cipherSuite]} userCount=${userCount}`,
+            `cipherSuite=${CipherSuite[cipherSuite]} userCount=${userCount}`,
             async () => {
                 const aliceCc = await ccInit({
                     withBasicCredential: true,

crypto-ffi/bindings/js/packages/native/benches/processMessage.bench.ts

@@ -1,5 +1,5 @@
 import { Bench } from "tinybench";
-import { Ciphersuite } from "@wireapp/core-crypto/native";
+import { CipherSuite } from "@wireapp/core-crypto/native";
 import {
     logResults,
     messageBenchmarkParameters,
@@ -42,7 +42,7 @@ async function run() {
         // This means that we can't encrypt the messages beforehand as this would lead to bob decrypting
         // the same messages over and over again.
         bench.add(
-            `cipherSuite=${Ciphersuite[cipherSuite]} size=${size}B count=${count}`,
+            `cipherSuite=${CipherSuite[cipherSuite]} size=${size}B count=${count}`,
             async () => {
                 const encryptedMessages = await aliceCc.transaction(
                     async (ctx) => {

crypto-ffi/bindings/js/packages/native/benches/removeUser.bench.ts

@@ -4,7 +4,7 @@ import {
     userBenchmarkParameters,
 } from "../../shared/benches/utils";
 import {
-    Ciphersuite,
+    CipherSuite,
     ClientId,
     type KeyPackage,
 } from "@wireapp/core-crypto/native";
@@ -31,7 +31,7 @@ async function run() {
     });
     for (const { userCount, cipherSuite } of parameters) {
         bench.add(
-            `cipherSuite=${Ciphersuite[cipherSuite]} userCount=${userCount}`,
+            `cipherSuite=${CipherSuite[cipherSuite]} userCount=${userCount}`,
             async () => {
                 const aliceCc = await ccInit({
                     withBasicCredential: true,

crypto-ffi/bindings/js/packages/native/test/credential.test.ts

@@ -1,7 +1,7 @@
 import { ccInit, setup, teardown } from "./utils";
 import { test, beforeEach, describe, expect, afterAll } from "bun:test";
 import {
-    Ciphersuite,
+    CipherSuite,
     ciphersuiteDefault,
     ClientId,
     Credential,
@@ -59,11 +59,11 @@ describe("credentials", () => {
 
     test("credentials can be searched", async () => {
         const clientId = new ClientId(Buffer.from("any random client id here"));
-        const ciphersuite1 = Ciphersuite.Mls128Dhkemp256Aes128gcmSha256P256;
+        const ciphersuite1 = CipherSuite.Mls128Dhkemp256Aes128gcmSha256P256;
         const credential1 = Credential.basic(ciphersuite1, clientId);
 
         const ciphersuite2 =
-            Ciphersuite.Mls128Dhkemx25519Chacha20poly1305Sha256Ed25519;
+            CipherSuite.Mls128Dhkemx25519Chacha20poly1305Sha256Ed25519;
         const credential2 = Credential.basic(ciphersuite2, clientId);
 
         const cc = await ccInit({ withBasicCredential: false, clientId });

crypto-ffi/bindings/js/packages/native/test/keyPackage.test.ts

@@ -2,7 +2,7 @@ import { ccInit, generateKeyPackage, setup, teardown } from "./utils";
 import { test, beforeEach, describe, expect, afterAll } from "bun:test";
 import { ClientId } from "@wireapp/core-crypto/native";
 import {
-    Ciphersuite,
+    CipherSuite,
     Credential,
     KeyPackage,
 } from "@wireapp/core-crypto/native";
@@ -78,11 +78,11 @@ describe("key package", () => {
     test("can be removed by credentialref", async () => {
         const clientId = new ClientId(Buffer.from("any random client id here"));
         const credential1 = Credential.basic(
-            Ciphersuite.Mls128Dhkemx25519Aes128gcmSha256Ed25519,
+            CipherSuite.Mls128Dhkemx25519Aes128gcmSha256Ed25519,
             clientId
         );
         const credential2 = Credential.basic(
-            Ciphersuite.Mls128Dhkemp256Aes128gcmSha256P256,
+            CipherSuite.Mls128Dhkemp256Aes128gcmSha256P256,
             clientId
         );
         const cc = await ccInit({ withBasicCredential: false, clientId });

crypto-ffi/bindings/js/packages/native/test/utils.ts

@@ -1,7 +1,7 @@
 import { rm } from "node:fs/promises";
 import assert from "node:assert";
 import {
-    Ciphersuite,
+    CipherSuite,
     type CommitBundle,
     ConversationId,
     CoreCrypto,
@@ -28,7 +28,7 @@ import { Database } from "@wireapp/core-crypto/native";
 const logLevel = Number(process.env["CC_TEST_LOG_LEVEL"] || "0");
 
 const DEFAULT_CIPHERSUITE =
-    Ciphersuite.Mls128Dhkemx25519Chacha20poly1305Sha256Ed25519;
+    CipherSuite.Mls128Dhkemx25519Chacha20poly1305Sha256Ed25519;
 const SQLITE_SIDE_CAR_SUFFIXES = ["", "-journal", "-shm", "-wal"] as const;
 const DATABASE_LOCATIONS = new Set<string>();
 
@@ -109,7 +109,7 @@ type CcInitOptions =
       }
     | {
           withBasicCredential?: true;
-          cipherSuite?: Ciphersuite;
+          cipherSuite?: CipherSuite;
           clientId?: ClientId;
       };
 
@@ -146,7 +146,7 @@ export async function ccInit(
 
 export async function generateKeyPackage(
     cc: CoreCrypto,
-    cipherSuite?: Ciphersuite
+    cipherSuite?: CipherSuite
 ): Promise<KeyPackage> {
     if (cipherSuite === undefined) {
         cipherSuite = DEFAULT_CIPHERSUITE;
@@ -207,7 +207,7 @@ export async function invite(
     cc1: CoreCrypto,
     cc2: CoreCrypto,
     conversationId: ConversationId,
-    cipherSuite?: Ciphersuite
+    cipherSuite?: CipherSuite
 ): Promise<GroupInfoBundle> {
     const kp = await generateKeyPackage(cc2, cipherSuite);
     await cc1.transaction((ctx) =>