MSC4183: Additional Error Codes for submitToken endpoint #4183

dbkr · 2024-08-28T16:12:55Z

Rendered

Impls:

Sydent: matrix-org/sydent#592
Synapse: element-hq/synapse#17625
Element Web/Desktop: matrix-org/matrix-react-sdk#12936

FCP tickyboxes

turt2live · 2024-08-28T17:47:51Z

I don't feel as though implementation is required for this MSC.

@mscbot fcp merge

mscbot · 2024-08-28T17:47:54Z

proposals/4180-submitToken-error-codes.md

Co-authored-by: Johannes Marbach <[email protected]>

proposals/4183-submitToken-error-codes.md

Spelling / grammar fixes Co-authored-by: Andrew Morgan <[email protected]>

proposals/4183-submitToken-error-codes.md

richvdh · 2024-11-05T17:01:11Z

@mscbot concern lack of clarity about changes to requestToken

richvdh · 2024-11-26T17:23:47Z

proposals/4183-submitToken-error-codes.md

+Also change the corresponding submitYoken-like API given in the C/S API's definition of [`POST
+/_matrix/client/v3/account/3pid/email/requestToken`](https://spec.matrix.org/v1.11/client-server-api/#post_matrixclientv3account3pidemailrequesttoken)
+to specify that both request and response parameters / error codes are the same as the I/S API version, rather than just parameters, apart from needing an I/S API token.


Suggested change

Also change the corresponding submitYoken-like API given in the C/S API's definition of [`POST

/_matrix/client/v3/account/3pid/email/requestToken`](https://spec.matrix.org/v1.11/client-server-api/#post_matrixclientv3account3pidemailrequesttoken)

to specify that both request and response parameters / error codes are the same as the I/S API version, rather than just parameters, apart from needing an I/S API token.

Also change the `submit_url` field in the response to [`POST

/_matrix/client/v3/account/3pid/email/requestToken`](https://spec.matrix.org/v1.11/client-server-api/#post_matrixclientv3account3pidemailrequesttoken),

to specify that response parameters and error codes are the same as the I/S API version, as well as request parameters.

Are you sure about this, by the way? AFAICT synapse currently returns a bit of HTML here.

I don't think the sample impl (element-hq/synapse#17625) actually changes the email submit-token endpoint.

So the deal here is that the POST endpoint isn't proxied by Synapse: it doesn't need to be as Sydent's email can just link straight to its own version of the GET endpoint. I've tried to clarify this in 63dcbe0 (it's different for phone numbers because Sydent sends a code for the user to enter rather than a link).

Co-authored-by: Richard van der Hoff <[email protected]>

and how it isn't really a thing in practice

richvdh · 2024-11-27T15:02:56Z

proposals/4183-submitToken-error-codes.md

+endpoint in the C/S API also specifies a `submit_url` response parameter, defining its parameters to be the same as the
+Identity API's `submitToken` endpoints. Everything this MSC specifies applies to this endpoint in the same way.
+
+Note that the email `submitToken` endpoint ([`POST


it's a bit confusing that we jump from talking about an endpoint in the C-S API to one in the IS API without mentioning that.

Also, if you're talking specifically about the POST variant, you better say that, rather than saying that the entire endpoint is unused.

Yes - sort of, I don't think there is a POST variant for email on the C/S API. Hopefully clearer in af1dc86.

This is still confusing: we still jump from talking about an endpoint in the C-S API to one in the IS API without mentioning that.

richvdh · 2024-11-27T15:05:31Z

proposals/4183-submitToken-error-codes.md

+Also change the `submit_url` field in the response to [`POST
+/_matrix/client/v3/account/3pid/email/requestToken`](https://spec.matrix.org/v1.11/client-server-api/#post_matrixclientv3account3pidemailrequesttoken),
+to specify that response parameters and error codes are the same as the I/S API version, as well as request parameters.


why does this only apply to POST /_matrix/client/v3/account/3pid/email/requestToken, and not also:

POST /_matrix/client/v3/account/password/email/requestToken

POST /_matrix/client/v3/account/password/msisdn/requestToken

POST /_matrix/client/v3/register/email/requestToken

POST /_matrix/client/v3/register/msisdn/requestToken

POST /_matrix/client/v3/account/3pid/msisdn/requestToken

?

Mmm, yeah - I'd done it as only editing what I needed to, but you're right, they should be consistent. Changed in 0f43a51.

...from the other requestToken enpoints Also try to further clarify the note about the largely unused POST email submitToken

proposals/4183-submitToken-error-codes.md

richvdh · 2024-11-29T11:40:14Z

proposals/4183-submitToken-error-codes.md

+
+## Proposal
+
+Add the following specific error code as a code that can be returned by the two endpoints given above:


not least because there are now at least three different endpoints given above, I think you should restate which endpoints are changing here.

richvdh · 2024-11-29T11:42:12Z

proposals/4183-submitToken-error-codes.md

+ * [`POST /_matrix/client/v3/register/email/requestToken`](https://spec.matrix.org/v1.11/client-server-api/#post_matrixclientv3registeremailrequesttoken)
+ * [`POST /_matrix/client/v3/register/msisdn/requestToken`](https://spec.matrix.org/v1.11/client-server-api/#post_matrixclientv3registerrequesttoken)
+ * [`POST /_matrix/client/v3/account/3pid/email/requestToken`](https://spec.matrix.org/v1.11/client-server-api/#post_matrixclientv3account3pidemailrequesttoken)
+ * [`POST /_matrix/client/v3/account/3pid/msisdn/requestToken`](https://spec.matrix.org/v1.11/client-server-api/#post_matrixclientv3account3pidmsisdnrequesttoken)
+ * [`POST /_matrix/client/v3/account/password/email/requestToken`](https://spec.matrix.org/v1.11/client-server-api/#post_matrixclientv3accountpasswordemailrequesttoken)
+ * [`POST /_matrix/client/v3/account/password/msisdn/requestToken`](https://spec.matrix.org/v1.11/client-server-api/#post_matrixclientv3accountpasswordmsisdnrequesttoken)


haven't checked this morning, but I'm pretty sure your synapse implementation PR doesn't change all of these.

(I don't think synapse returns a submit_url from the email/requestToken endpoints, but it does from the msisdn/requestToken endpoints, and you haven't updated all the implementations of those submit_url endpoints.)

It actually does (so it's just as well we included the other endpoints): the various different rest classes use that function in the handler to do the request to the ID server and then the error code is in the exception that it throws.

proposals/4183-submitToken-error-codes.md

Co-authored-by: Richard van der Hoff <[email protected]>

turt2live

re-asserting approval as a read marker

MSC4180: Additional Error Codes for submitToken endpoint

e2cc52f

dbkr added the proposal A matrix spec change proposal label Aug 28, 2024

dbkr added 3 commits August 28, 2024 17:16

Bah, markdown

daa2132

Line wrapping

f4fdd0f

Typos

0cdf8c6

turt2live removed the needs-implementation This MSC does not have a qualifying implementation for the SCT to review. The MSC cannot enter FCP. label Aug 28, 2024

Johennes reviewed Aug 28, 2024

View reviewed changes

proposals/4180-submitToken-error-codes.md Outdated Show resolved Hide resolved

dbkr and others added 3 commits August 29, 2024 11:08

Right MSC number

7fb14aa

Co-authored-by: Johannes Marbach <[email protected]>

Rename

725f2ec

Add http status code

d383285

dbkr changed the title ~~MSC4180: Additional Error Codes for submitToken endpoint~~ MSC4183: Additional Error Codes for submitToken endpoint Aug 29, 2024

anoadragon453 reviewed Oct 1, 2024

View reviewed changes

dbkr and others added 5 commits October 2, 2024 11:29

Apply suggestions from code review

7809ced

Spelling / grammar fixes Co-authored-by: Andrew Morgan <[email protected]>

Word wrap

be435a8

Clearer wording

007d364

clarify

43638f1

Clarify

5b8b163

richvdh requested changes Nov 5, 2024

View reviewed changes

proposals/4183-submitToken-error-codes.md Outdated Show resolved Hide resolved

mscbot added the unresolved-concerns This proposal has at least one outstanding concern label Nov 5, 2024

dbkr added 3 commits November 18, 2024 14:52

Add note about not reusing error code

c026da7

Clarify that we're taking about the submittoken api in requestToken

70d3e07

spelling

28d1128

turt2live requested a review from richvdh November 26, 2024 01:15

richvdh requested changes Nov 26, 2024

View reviewed changes

dbkr and others added 2 commits November 26, 2024 17:59

Clearer wording

7c53dc9

Co-authored-by: Richard van der Hoff <[email protected]>

Add note on POST email submitToken api

63dcbe0

and how it isn't really a thing in practice

richvdh reviewed Nov 27, 2024

View reviewed changes

dbkr added 2 commits November 29, 2024 09:34

Hopefully make more clearer

af1dc86

Apply same change to other submitToken endpoints

0f43a51

...from the other requestToken enpoints Also try to further clarify the note about the largely unused POST email submitToken

richvdh requested changes Nov 29, 2024

View reviewed changes

dbkr and others added 2 commits November 29, 2024 11:54

Remove stray lines, more clarifications & consistency fix

9c12f64

clarify only c/s api

c630214

Co-authored-by: Richard van der Hoff <[email protected]>

turt2live approved these changes Nov 29, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MSC4183: Additional Error Codes for submitToken endpoint #4183

MSC4183: Additional Error Codes for submitToken endpoint #4183

dbkr commented Aug 28, 2024 •

edited by turt2live

Loading

turt2live commented Aug 28, 2024

mscbot commented Aug 28, 2024 •

edited

Loading

richvdh commented Nov 5, 2024

richvdh Nov 26, 2024

richvdh Nov 26, 2024

richvdh Nov 26, 2024

dbkr Nov 27, 2024 •

edited

Loading

richvdh Nov 27, 2024

dbkr Nov 29, 2024

richvdh Nov 29, 2024

richvdh Nov 27, 2024

dbkr Nov 29, 2024

richvdh Nov 29, 2024

dbkr Nov 29, 2024

richvdh Nov 29, 2024

dbkr Nov 29, 2024

turt2live left a comment


		## Proposal

		Add the following specific error code as a code that can be returned by the two endpoints given above:

MSC4183: Additional Error Codes for submitToken endpoint #4183

Are you sure you want to change the base?

MSC4183: Additional Error Codes for submitToken endpoint #4183

Conversation

dbkr commented Aug 28, 2024 • edited by turt2live Loading

Impls:

turt2live commented Aug 28, 2024

mscbot commented Aug 28, 2024 • edited Loading

richvdh commented Nov 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dbkr Nov 27, 2024 • 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

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

turt2live left a comment

Choose a reason for hiding this comment

dbkr commented Aug 28, 2024 •

edited by turt2live

Loading

mscbot commented Aug 28, 2024 •

edited

Loading

dbkr Nov 27, 2024 •

edited

Loading