element-web/cypress/plugins/oauth_server/README.md
Richard van der Hoff f65c6726c9
Add a cypress test for SSO login (#11401)
* Allow `startHomeserver` to take an options object

... so that we can add more options

* Add a Cypress test for SSO login
2023-08-14 11:08:12 +00:00

1 KiB

oauth_server

A very simple OAuth identity provider server.

The following endpoints are exposed:

  • /oauth/auth.html: An OAuth2 authorization endpoint. In a proper OAuth2 system, this would prompt the user to log in; we just give a big "Submit" button (and an auth code that can be changed if we want the next step to fail). It redirects back to the calling application with a "code".

  • /oauth/token: An OAuth2 token endpoint. Receives the code issued by "auth.html" and, if it is valid, exchanges it for an OAuth2 access token.

  • /oauth/userinfo: An OAuth2 userinfo endpoint. Returns details about the owner of the offered access token.

To start the server, do:

cy.task("startOAuthServer").then((port) => {
    // now we can configure Synapse or Element to talk to the OAuth2 server.
});