Skip to content

Commit

Permalink
Merge pull request #36 from near/serhii/setup
Browse files Browse the repository at this point in the history
build instractions
  • Loading branch information
volovyks authored Apr 13, 2023
2 parents c73dc94 + 4c70ade commit 59e6042
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,21 @@ Check OIDC standard docs [here](https://openid.net/specs/openid-connect-core-1_0
There are several ways to get and use the ID token. The flow that we are using is called the "server" flow, you can find more info [here](https://developers.google.com/identity/openid-connect/openid-connect#authenticatingtheuser). The system will be able to process any token that is following the core OpenID Connect standard. In order to recieve the ID token from OpenID provider you will need to include the `openid` scope value to the Authorization Request.

### Server integration
Internally, we are identifiying users by their issuer id (iss) and their unique ID (sub) retrieved form the ID token and separated by a colon: `<issuer_iss>:<user_sub>`. It means that each recovery method (like GitHub abd Google) is separated from one another even if they have the same email.
Internally, we are identifiying users by their issuer id (iss) and their unique ID (sub) retrieved form the ID token and separated by a colon: `<issuer_iss>:<user_sub>`. It means that each recovery method (like GitHub abd Google) is separated from one another even if they have the same email.

### Contribute

In order to build the project, you will need to have `protoc` installed and execute next commands:

```BASH
# init submodules
git submodule update --init --recursive
# build the Docker image
docker build . -t near/mpc-recovery
```

Run tests with:
```
cargo test -p mpc-recovery-integration-tests
```
You will need to re-build the Docker image each time you made a code change and want to run the integration tests.

0 comments on commit 59e6042

Please sign in to comment.