Remove legacy crypto #4653

florianduros · 2025-01-23T17:13:54Z

Closes element-hq/element-web#26922
EW e2e tests

Remove the legacy crypto. All included PRs have been reviewed.
Sonarcloud is raising an issue because the code coverage on new code is at 71.4% due to the lack of code coverage on the legacy call. I'll ask an exception to merge this PR (EW e2e tests are OK).

…crypto/call Remove deprecated calls in `webrtc/call.ts`

* Remove `MatrixClient.initLegacyCrypto` * Remove `MatrixClient.initLegacyCrypto` in README.md * Remove tests using `MatrixClient.initLegacyCrypto`

* chore(legacy call): Remove `DeviceInfo` usage * refactor(legacy call): throw `GroupCallUnknownDeviceError` at the end of `initOpponentCrypto`

…-legacy-crypto

* feat(legacy crypto)!: remove deprecated methods of `MatrixClient` * test(legacy crypto): update existing tests to not use legacy crypto - `Embedded.spec.ts`: casting since `encryptAndSendToDevices` is removed from `MatrixClient`. - `room.spec.ts`: remove deprecated usage of `MatrixClient.crypto` - `matrix-client.spec.ts` & `matrix-client-methods.spec.ts`: remove calls of deprecated methods of `MatrixClient` * test(legacy crypto): remove test files using `MatrixClient` deprecated methods * test(legacy crypto): update existing integ tests to run successfully * feat(legacy crypto!): remove `ICreateClientOpts.deviceToImport`. `ICreateClientOpts.deviceToImport` was used in the legacy cryto. The rust crypto doesn't support to import devices in this way. * feat(legacy crypto!): remove `{get,set}GlobalErrorOnUnknownDevices` `globalErrorOnUnknownDevices` is not used in the rust-crypto. The API is marked as unstable, we can remove it.

* feat(legacy crypto!): remove legacy crypto usage in `event.ts` * test(legacy crypto): update event.spec.ts to not use legacy crypto types

* feat(legacy crypto!): remove legacy crypto export in `matrix.ts` * test(legacy crypto): update `megolm-backup.spec.ts` to import directly `CryptoApi`

* feat(legacy crypto!): keep legacy methods used in lib olm migration The rust cryto needs these legacy stores in order to do the migration from the legacy crypto to the rust crypto. We keep the following methods of the stores: - Used in `libolm_migration.ts`. - Needed in the legacy store tests. - Needed in the rust crypto test migration. * feat(legacy crypto): extract legacy crypto types in legacy stores In order to be able to delete the legacy crypto, these stores shouldn't rely on the legacy crypto. We need to extract the used types. * feat(crypto store): remove `CryptoStore` functions used only by tests * test(crypto store): use legacy `MemoryStore` type

* feat(CryptoBackend)!: remove deprecated methods * feat(rust-crypto)!: remove deprecated methods of `CryptoBackend` * test(rust-crypto): remove tests of deprecated methods of `CryptoBackend`

The interface of `encryptAndSendToDevices` changes because `DeviceInfo` is from the legacy crypto. In fact `encryptAndSendToDevices` only need pairs of userId and deviceId.

* fix(legacy store): fix legacy store typing In #4663, the storeXXX methods were removed of the CryptoStore interface but they are used internally by IndexedDBCryptoStore. * feat(legacy crypto)!: remove content of `crypto/*` except legacy stores * test(legacy crypto): remove `spec/unit/crypto/*` except legacy store tests * refactor: remove unused types * doc: fix broken link * doc: remove link tag when typedoc is unable to find the CryptoApi

…-legacy-crypto # Conflicts: # src/crypto/index.ts

* test(crypto): remove `newBackendOnly` test closure * test(crypto): fix duplicate test name * test(crypto): remove `oldBackendOnly` test closure * test(crypto): remove `rust-sdk` comparison * test(crypto): remove iteration on `CRYPTO_BACKEND` * test(crypto): remove old legacy comments and tests * test(crypto): fix documentations and removed unused expect

…-legacy-crypto # Conflicts: # src/client.ts # src/crypto/EncryptionSetup.ts # src/crypto/OutgoingRoomKeyRequestManager.ts

t3chguy · 2025-02-04T15:34:27Z

src/@types/crypto.ts

@@ -30,7 +30,7 @@ interface Extensible {

 /* eslint-disable camelcase */

-/** The result of a call to {@link MatrixClient.exportRoomKeys} */
+/** The result of a call to CryptoApi.exportRoomKeys */


This looks like it breaks docs

It works as per the docs I linked you to when you asked

Oh perfect, I didn't understood first the documentation. I tried multiple times different without success. I'll make a PR for that

Also just noticed in the screenshot I included that it looks like OlmGroupSessionExtraData is now unused that /crypto/ has been deleted so seems like the checks for dead code were not exhaustive

I relied on knip to catch the unused type, this one wasn't raised unfortunately.

src/crypto-api/index.ts

src/models/event.ts

t3chguy · 2025-02-04T15:36:10Z

src/models/event.ts

-     *
-     * @returns a promise that resolves when the request is queued
-     */
-    public cancelAndResendKeyRequest(crypto: Crypto, userId: string): Promise<void> {


This wasn't deprecated?

Event.cancelAndResendKeyRequest is only used by

matrix-js-sdk/src/client.ts

Lines 3211 to 3225 in 7d68753

/**

* Cancel a room key request for this event if one is ongoing and resend the

* request.

* @param event - event of which to cancel and resend the room

* key request.

* @returns A promise that will resolve when the key request is queued

*

* @deprecated Not supported for Rust Cryptography.

*/

public cancelAndResendEventRoomKeyRequest(event: MatrixEvent): Promise<void> {

if (!this.crypto) {

throw new Error("End-to-End encryption disabled");

}

return event.cancelAndResendKeyRequest(this.crypto, this.getUserId()!);

}

Which was deprecated and deleted in this PR. Cryptois also deprecated, this function can't live with Crypto.

Right, but it should be deprecated before removal, just because another method with a similar name was deprecated does not mean this was deprecated.

t3chguy · 2025-02-04T15:36:13Z

src/models/event.ts

@@ -1721,10 +1691,6 @@ export class MatrixEvent extends TypedEventEmitter<MatrixEventEmittedEvents, Mat
        };
    }

-    public setVerificationRequest(request: VerificationRequest): void {


This wasn't deprecated?

src/rust-crypto/rust-crypto.ts

src/common-crypto/CryptoBackend.ts

richvdh · 2025-02-04T17:43:30Z

@t3chguy the strategy we agreed was that we'd review PRs on the way into the florianduros/rip-out-legacy-crypto/remove-legacy-crypto branch rather than attempt to give meaningful review to the branch as a whole. I don't think we should put another set of roadblocks on merging this branch now.

t3chguy · 2025-02-05T11:08:57Z

@t3chguy the strategy we agreed was that we'd review PRs on the way into the florianduros/rip-out-legacy-crypto/remove-legacy-crypto branch rather than attempt to give meaningful review to the branch as a whole. I don't think we should put another set of roadblocks on merging this branch now.

Where was the list of component parts which are to be PR'd individually reviewed? What's to say all the PRs have been made now and there doesn't need to be further PRs made onto this feature branch? If we don't review this then what's to stop the component sum of all the PRs not being acceptable?

florianduros and others added 4 commits November 28, 2024 14:14

Remove deprecated calls in webrtc/call.ts

a45de2f

Throw error when legacy call was used

9c4f21b

Merge branch 'develop' into florianduros/rip-out-legacy-crypto/call

020770b

Merge pull request #4562 from matrix-org/florianduros/rip-out-legacy-…

d12fcc4

…crypto/call Remove deprecated calls in `webrtc/call.ts`

florianduros added the X-Breaking-Change label Jan 23, 2025

github-actions bot deployed to PR Documentation Preview January 23, 2025 17:15 View deployment

This was referenced Jan 23, 2025

Remove deprecated DeviceInfo in webrtc/call.ts #4654

Merged

Remove MatrixClient.initLegacyCrypto #4620

Merged

Remove MatrixClient.initLegacyCrypto (#4620)

1129c45

* Remove `MatrixClient.initLegacyCrypto` * Remove `MatrixClient.initLegacyCrypto` in README.md * Remove tests using `MatrixClient.initLegacyCrypto`

github-actions bot deployed to PR Documentation Preview January 27, 2025 09:35 View deployment

Remove legacy crypto support in sync api (#4622)

8537aee

github-actions bot deployed to PR Documentation Preview January 27, 2025 09:51 View deployment

This was referenced Jan 27, 2025

Remove deprecated methods and attributes of MatrixClient #4659

Merged

Rip out legacy crypto code element-hq/element-web#26922

Open

Remove deprecated DeviceInfo in webrtc/call.ts (#4654)

f763192

* chore(legacy call): Remove `DeviceInfo` usage * refactor(legacy call): throw `GroupCallUnknownDeviceError` at the end of `initOpponentCrypto`

github-actions bot deployed to PR Documentation Preview January 27, 2025 14:17 View deployment

Merge branch 'develop' into florianduros/rip-out-legacy-crypto/remove…

ce6f971

…-legacy-crypto

github-actions bot deployed to PR Documentation Preview January 27, 2025 15:03 View deployment

This was referenced Jan 28, 2025

Clean up legacy stores #4663

Merged

Remove usage of legacy crypto in event.ts #4666

Merged

Remove legacy crypto export in matrix.ts #4667

Merged

florianduros added 2 commits January 29, 2025 12:32

Remove usage of legacy crypto in event.ts (#4666)

b156707

* feat(legacy crypto!): remove legacy crypto usage in `event.ts` * test(legacy crypto): update event.spec.ts to not use legacy crypto types

Remove legacy crypto export in matrix.ts (#4667)

2558903

* feat(legacy crypto!): remove legacy crypto export in `matrix.ts` * test(legacy crypto): update `megolm-backup.spec.ts` to import directly `CryptoApi`

This was referenced Jan 29, 2025

Remove usage of legacy crypto in embedded.ts #4668

Merged

Remove usage of legacy crypto in integ tests #4669

Merged

Remove usage of legacy crypto in integ tests (#4669)

69db213

This was referenced Jan 29, 2025

Remove deprecated parameters and types in CryptoApi #4670

Draft

Remove deprecated methods of CryptoBackend #4671

Merged

Remove call to MatrixClient.setGlobalErrorOnUnknownDevices element-hq/element-web#29134

Merged

florianduros added 3 commits January 30, 2025 14:45

Remove deprecated methods of CryptoBackend (#4671)

bca2582

* feat(CryptoBackend)!: remove deprecated methods * feat(rust-crypto)!: remove deprecated methods of `CryptoBackend` * test(rust-crypto): remove tests of deprecated methods of `CryptoBackend`

Remove usage of legacy crypto in embedded.ts (#4668)

0185f30

The interface of `encryptAndSendToDevices` changes because `DeviceInfo` is from the legacy crypto. In fact `encryptAndSendToDevices` only need pairs of userId and deviceId.

florianduros mentioned this pull request Jan 31, 2025

Remove legacy crypto files #4672

Merged

florianduros mentioned this pull request Feb 3, 2025

Clean up integ test after legacy crypto removal #4682

Merged

Merge branch 'develop' into florianduros/rip-out-legacy-crypto/remove…

07016bb

…-legacy-crypto # Conflicts: # src/crypto/index.ts

github-actions bot deployed to PR Documentation Preview February 3, 2025 15:19 View deployment

florianduros and others added 2 commits February 4, 2025 15:56

Merge branch 'develop' into florianduros/rip-out-legacy-crypto/remove…

e287ff6

…-legacy-crypto # Conflicts: # src/client.ts # src/crypto/EncryptionSetup.ts # src/crypto/OutgoingRoomKeyRequestManager.ts

github-actions bot deployed to PR Documentation Preview February 4, 2025 15:03 View deployment

florianduros marked this pull request as ready for review February 4, 2025 15:29

florianduros requested review from a team as code owners February 4, 2025 15:29

florianduros requested review from andybalaam, BillCarsonFr, hughns and t3chguy February 4, 2025 15:29

andybalaam approved these changes Feb 4, 2025

View reviewed changes

t3chguy requested changes Feb 4, 2025

View reviewed changes

florianduros mentioned this pull request Feb 5, 2025

Restore broken link to CryptoApi #4692

Merged

Restore broken link to CryptoApi (#4692)

b3ec086

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove legacy crypto #4653

Remove legacy crypto #4653

florianduros commented Jan 23, 2025 •

edited

Loading

t3chguy Feb 4, 2025

florianduros Feb 4, 2025

t3chguy Feb 5, 2025

florianduros Feb 5, 2025

t3chguy Feb 5, 2025 •

edited

Loading

florianduros Feb 5, 2025

t3chguy Feb 4, 2025

florianduros Feb 4, 2025

t3chguy Feb 5, 2025

t3chguy Feb 4, 2025

richvdh commented Feb 4, 2025

t3chguy commented Feb 5, 2025

	/**
	* Cancel a room key request for this event if one is ongoing and resend the
	* request.
	* @param event - event of which to cancel and resend the room
	* key request.
	* @returns A promise that will resolve when the key request is queued
	*
	* @deprecated Not supported for Rust Cryptography.
	*/
	public cancelAndResendEventRoomKeyRequest(event: MatrixEvent): Promise<void> {
	if (!this.crypto) {
	throw new Error("End-to-End encryption disabled");
	}
	return event.cancelAndResendKeyRequest(this.crypto, this.getUserId()!);
	}

Remove legacy crypto #4653

Are you sure you want to change the base?

Remove legacy crypto #4653

Conversation

florianduros commented Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

t3chguy Feb 5, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richvdh commented Feb 4, 2025

t3chguy commented Feb 5, 2025

florianduros commented Jan 23, 2025 •

edited

Loading

t3chguy Feb 5, 2025 •

edited

Loading