Error: Unsupported verification method

[danilobassi8]

Hi, I'm getting an error when trying to verify a user via QR. I've tried using the SAS method, and it worked, but for some reason when I try to use any of the QR method it does not work. (Also, on the documentation is not very clear on how should I use this methods).

When the VerificationRequest instance is on phase Ready , if I try to call this functions, I always get the same error:

import { VerificationMethod } from 'matrix-js-sdk/lib/types';


request.startVerification(VerificationMethod.Reciprocate);
request.startVerification(VerificationMethod.ScanQrCode);
request.startVerification(VerificationMethod.ShowQrCode);

Error: Unsupported verification method: m.reciprocate.v1
Error: Unsupported verification method: m.qr_code.show.v1
Error: Unsupported verification method: m.qr_code.scan.v1

I also tried explicitly adding all those methods to the verificationMethods property on the initialization params, but it doesn't work.

If I try to do something like

const data = await request.generateQRCode()

I always get undefined. Even if the current phase is Ready. The method Docstring says:

Generate the data for a QR code allowing the other device to verify this one, if it supports it.
Only returns data once phase is VerificationPhase.Ready and the other party can scan a QR code; otherwise returns undefined.

Honestly, I don't know what I'm doing wrong. Is it a bug?

The error seems to come from a web assembly file, so its impossible for me to debug this.

If I click on matrix_sdk_crypto_wasm_bg.wasm I see this:

[danilobassi8]

I found this in the source code.

    /**
     * Send an `m.key.verification.start` event to start verification via a particular method.
     *
     * Implementation of {@link Crypto.VerificationRequest#startVerification}.
     *
     * @param method - the name of the verification method to use.
     */
    public async startVerification(method: string): Promise<Verifier> {
        if (method !== VerificationMethod.Sas) {
            throw new Error(`Unsupported verification method ${method}`);
        }

so it seems that the error is expected (and not being thrown in a wasm file).
I do not understand why it accept a method as a parameter if it will throw an error if the value is different to Sas.
So, is the QR validation not supported by the sdk?

[richvdh]

QR code is supported (there are even tests for it in spec/integ/crypto/verification.spec.ts), but indeed it's not obvious how to use it.

You should not call startVerification if you want to do a QR code verification. Rather, once you have a VerificationRequest which is in Phase.Ready, you have three options:

1. If you can display a QR code, call request.generateQRCode, and display it. You can do this at the same time as offering the user options 2 and/or 3. If the remote user does scan the QR code, there is nothing else for you to do.
2. If you can scan a QR code, offer the user the option to do so. If they accept, and you successfully read a QR code, call request.scanQRCode. If it is successful, you are done. (This path is not well tested, since Element-Web does not support scanning QR codes, but to the best of my knowledge, it should work.)
3. You can also offer the user the option to fall back to emoji verification. If they accept it, call request.startVerification(VerificationMethod.Sas).

If you get this working, contributions to the documentation to make it clearer would be much appreciated.

[danilobassi8]

1. If you can display a QR code, call request.generateQRCode, and display it. You can do this at the same time as offering the user options 2 and/or 3. If the remote user does scan the QR code, there is nothing else for you to do.

The main issue with this is that when I call request.generateQRCode() I always get undefined. Even if the current phase is Ready. So I can not test the scanQRCode method because there is nothing to scan.

Sure, I have no issues in contributing to the docs, but I'm not able to make it work. I'm using matrix-js-sdk": "37.6.0"

[richvdh]

The main issue with this is that when I call request.generateQRCode() I always get undefined. Even if the current phase is Ready

Does the other side report support for m.qr_code.scan.v1 and m.reciprocate.v1 in its m.key.verification.request / m.key.verification.ready request?

If you are setting explicit ICreateClientOpts.verificationMethods in your call to createClient, make sure you are including m.qr_code.show.v1 and m.reciprocate.v1.

Otherwise, I don't know why this would happen. As I said in your previous issue, make sure you are getting the logs from the client. Maybe compare with the tests in spec/integ/crypto/verification.spec.ts (which call generateQRCode()), to see what you're doing differently.

[danilobassi8]

Does the other side report support for m.qr_code.scan.v1 and m.reciprocate.v1 in its m.key.verification.request / m.key.verification.ready request?

Yes, I am not setting ICreateClientOpts.verificationMethods directly. I've tried before, but it didn't work.

Maybe compare with the tests in spec/integ/crypto/verification.spec.ts (which call generateQRCode()), to see what you're doing differently.

I read the test but I don't see what I'm doing differently.
I have a page that basically show two buttons when the phase is Ready, these are the handlers for those buttons:

export class Component {
  // ... other code


  async showQR(request: VerificationRequest) {
    console.log('--- CLICKED ON GENERATE QR ---');
    this.logRequestInfo(request);
    const qrData = await request.generateQRCode();
    console.log('QR GENERATED: ', qrData);
  }

  scanQR(request: VerificationRequest) {
    console.log('--- CLICKED ON SCAN QR ---');
    this.logRequestInfo(request);
  }

  logRequestInfo(request: VerificationRequest) {
    console.log({
      phase: request.phase,
      isPhaseReady: request.phase === VerificationPhase.Ready,
      initiatedByMe: request.initiatedByMe,
      isSelf: request.isSelfVerification,
      otherPartySupportsMethod: {
        [VerificationMethod.ScanQrCode]: request.otherPartySupportsMethod(VerificationMethod.ScanQrCode),
        [VerificationMethod.ShowQrCode]: request.otherPartySupportsMethod(VerificationMethod.ShowQrCode),
        [VerificationMethod.Reciprocate]: request.otherPartySupportsMethod(VerificationMethod.Reciprocate),
        [VerificationMethod.Sas]: request.otherPartySupportsMethod(VerificationMethod.Sas),
      },
      transactionId: request.transactionId,
    });
  }
}

And this is what I'm seeing on the logs:

User that triggered the request

[ASSOCIATIONS_SERVICE] Creating new D2D verification

Sending batch of to-device messages. type=m.key.verification.request txnid=743a87c0dec044c3ac36ba3848bc341a ['@bob:localhost/JQSHVUWDRZ (msgid undefined)']

[ASSOCIATIONS_SERVICE] new Device to Device event: {
    "content": {
        "from_device": "JQSHVUWDRZ",
        "methods": [
            "m.sas.v1",
            "m.qr_code.scan.v1",
            "m.qr_code.show.v1",
            "m.reciprocate.v1"
        ],
        "transaction_id": "44628d9b537b455d962200250c7aff45"
    },
    "type": "m.key.verification.ready",
    "sender": "@bob:localhost"
}

--- CLICKED ON GENERATE QR ---

{
    "phase": 3,
    "isPhaseReady": true,
    "initiatedByMe": true,
    "isSelf": false,
    "otherPartySupportsMethod": {
        "m.qr_code.scan.v1": true,
        "m.qr_code.show.v1": true,
        "m.reciprocate.v1": true,
        "m.sas.v1": true
    },
    "transactionId": "44628d9b537b455d962200250c7aff45"
}
QR GENERATED:  undefined


--- CLICKED ON SCAN QR ---
{
    "phase": 3,
    "isPhaseReady": true,
    "initiatedByMe": true,
    "isSelf": false,
    "otherPartySupportsMethod": {
        "m.qr_code.scan.v1": true,
        "m.qr_code.show.v1": true,
        "m.reciprocate.v1": true,
        "m.sas.v1": true
    },
    "transactionId": "44628d9b537b455d962200250c7aff45"
}

User that is receiving the request

INFO matrix_sdk_crypto::verification::machine: Received a new verification request
    sender="@alice:localhost" from_device="ZGCXIJVKOG"
    at /home/runner/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/matrix-sdk-crypto-0.14.0/src/verification/machine.rs:336
    in matrix_sdk_crypto::verification::machine::receive_any_event with flow_id="44628d9b537b455d962200250c7aff45"
    in matrix_sdk_crypto::machine::receive_to_device_event with sender="@alice:localhost" event_type="m.key.verification.request" 
    in matrix_sdk_crypto::machine::receive_sync_changes

Sending batch of to-device messages. type=m.key.verification.ready txnid=d2c6f82663964f25a0ba54811e9fe8bc ['@alice:localhost/ZGCXIJVKOG (msgid undefined)']


--- CLICKED ON SCAN QR ---
{
    "phase": 3,
    "isPhaseReady": true,
    "initiatedByMe": false,
    "isSelf": false,
    "otherPartySupportsMethod": {
        "m.qr_code.scan.v1": true,
        "m.qr_code.show.v1": true,
        "m.reciprocate.v1": true,
        "m.sas.v1": true
    },
    "transactionId": "44628d9b537b455d962200250c7aff45"
}


--- CLICKED ON GENERATE QR ---

{
    "phase": 3,
    "isPhaseReady": true,
    "initiatedByMe": false,
    "isSelf": false,
    "otherPartySupportsMethod": {
        "m.qr_code.scan.v1": true,
        "m.qr_code.show.v1": true,
        "m.reciprocate.v1": true,
        "m.sas.v1": true
    },
    "transactionId": "44628d9b537b455d962200250c7aff45"
}