init

node_modules/matrix-js-sdk/lib/rendezvous/index.js

@@ -0,0 +1,113 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { OAuthGrantType } from "../matrix.js";
+import { MSC4108FailureReason } from "./RendezvousFailureReason.js";
+import { MSC4108SignInWithQR } from "./MSC4108SignInWithQR.js";
+import { MSC4108RendezvousSession } from "./transports/MSC4108RendezvousSession.js";
+import { MSC4108SecureChannel } from "./channels/MSC4108SecureChannel.js";
+import { RendezvousIntent } from "./RendezvousIntent.js";
+import { logger } from "../logger.js";
+export * from "./MSC4108SignInWithQR.js";
+export * from "./RendezvousError.js";
+export * from "./RendezvousFailureReason.js";
+export * from "./RendezvousIntent.js";
+export * from "./transports/index.js";
+export * from "./channels/index.js";
+
+/**
+ * Check if the homeserver that the client is connected to supports a variant of sign-in with QR that we can use.
+ *
+ * @param client the client to check for sign-in with QR support
+ * @returns true if the homeserver that the client is connected to supports a variant of sign-in with QR that we can use, false otherwise.
+ */
+export async function isSignInWithQRAvailable(client) {
+  let metadata;
+  try {
+    metadata = await client.getAuthMetadata();
+  } catch (e) {
+    logger.warn("Failed to fetch auth metadata, assuming sign-in with QR is unavailable", e);
+    return false;
+  }
+
+  // check for support of device authorization grant
+  if (!metadata.grant_types_supported.includes(OAuthGrantType.DeviceAuthorization)) {
+    return false;
+  }
+
+  // check for unstable support for MSC4108 2024 version
+  return client.doesServerSupportUnstableFeature("org.matrix.msc4108");
+}
+
+/**
+ * Start a linking flow from an existing authenticated client by generating a QR code that can be scanned by the new device.
+ * The new device will then authenticate with the server and link itself to the same account as the existing client and
+ * share the end-to-end encryption keys.
+ *
+ * @param client the existing client
+ * @param onFailure callback for when the linking process fails
+ * @param abortSignal an AbortSignal that can be used to cancel the linking process,
+ *   for example when the user cancels out of the flow.
+ *   This will unbind the {@link onFailure} callback and prevent any further steps in the flow from being executed.
+ * @returns a promise that resolves to an instance of the linking flow
+ */
+export async function linkNewDeviceByGeneratingQR(client, onFailure, abortSignal) {
+  // we assume rust crypto is already initialised
+  return initGenerateQrFlow(RendezvousIntent.RECIPROCATE_LOGIN_ON_EXISTING_DEVICE, client, onFailure, abortSignal);
+}
+
+/**
+ * Start a sign-in flow by generating a QR code that can be scanned by an existing authenticated client.
+ * The existing client will then help complete the authentication of the new device and link it to the same account,
+ * sharing the end-to-end encryption keys.
+ *
+ * @param tempClient temporary client used during the flow for the rendezvous channel
+ * @param onFailure callback for when the sign-in process fails
+ * @param abortSignal an AbortSignal that can be used to cancel the linking process,
+ *   for example when the user cancels out of the flow.
+ *   This will unbind the {@link onFailure} callback and prevent any further steps in the flow from being executed.
+ * @returns a promise that resolves to an instance of the sign-in flow
+ */
+export async function signInByGeneratingQR(tempClient, onFailure, abortSignal) {
+  // ensure rust crypto is initialized as needed for the secure channel
+  const RustSdkCryptoJs = await import("@matrix-org/matrix-sdk-crypto-wasm");
+  await RustSdkCryptoJs.initAsync();
+  return initGenerateQrFlow(RendezvousIntent.LOGIN_ON_NEW_DEVICE, tempClient, onFailure, abortSignal);
+}
+async function initGenerateQrFlow(intent, client, onFailure, abortSignal) {
+  const session = new MSC4108RendezvousSession({
+    onFailure,
+    client
+  });
+  const channel = new MSC4108SecureChannel(session, undefined, onFailure);
+  const flow = new MSC4108SignInWithQR(channel, false, intent === RendezvousIntent.LOGIN_ON_NEW_DEVICE ? undefined : client, onFailure);
+  if (abortSignal.aborted) return flow;
+  abortSignal.onabort = () => {
+    // Detach failure handlers
+    session.onFailure = undefined;
+    channel.onFailure = undefined;
+    flow.onFailure = undefined;
+    // Cancel the session
+    void flow.cancel(MSC4108FailureReason.UserCancelled);
+  };
+  await session.send(""); // open channel
+
+  if (!abortSignal.aborted) {
+    await flow.generateCode();
+  }
+  return flow;
+}
+//# sourceMappingURL=index.js.map