https://github.com/verida/vault-auth-server
https://github.com/verida/vault-auth-server
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/verida/vault-auth-server
- Owner: verida
- License: isc
- Created: 2020-09-30T08:26:13.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-14T00:49:00.000Z (about 2 years ago)
- Last Synced: 2025-03-01T00:07:56.756Z (over 1 year ago)
- Language: JavaScript
- Size: 403 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: license.md
Awesome Lists containing this project
README
# Vault Auth Server
A web socket server that bridges connections between a mobile device and a web page to enable secure, single sign on using private blockchain keys stored on the mobile device.
## Usage
```
npm run start
```
### Configuration
There is an example configuration file located in `src/config/index.example.js`. Copy this file to `src/config/index.js`.
You must update `AUTH_URI` to match the domain name / IP address of the server. You will also need to configure the Auth Client library to use this value as the `serverUri`. See [Verida Connect SDK / Getting Started / Configuration](https://developers.verida.io/docs/single-sign-on-sdk/getting-started#configuration).
You must configure each application this server will support in the `CONTEXTS` section. You can specify a different private key per context. All data is encrypted and signed using the private key. This enables the data to be decrypted by the end user and in the future, will enable Application Contexts to be registered to specific keys, providing enhanced man-in-the-middle attack protection.
You must specify valid `DID_CLIENT_CONFIG` if you are registering a new Verida Account (DID) with the private key of a context. See [Client SDK / Authentication / Private Key](https://developers.verida.io/docs/client-sdk/authentication#2-private-key).
# Security
The configuration file allows you to provide the private key of a valid blockchain account that can sign messages relating to the login process.
There is a `loginOrigin` property that, if specified, will check the `origin` HTTP header from each socket request to ensure it's coming from the expected domain. This ensures third party websites can't easily request valid authentication tokens. This also ensures third party websites can be prevented from using the resources of any auth server that is running.
Malicious third parties could obtain a token by spoofing the `origin` HTTP header and then presenting that to the user. However, this `loginOrigin` property is passed inside the encrypted payload to the Verida Vault and is displayed to the user. This allows the user to visually verify the domain name they are currently on matches the domain name displayed on the Verida Vault login screen. In the future, the Verida Trust Framework will add an additional layer of security by matching on chain metadata against the public key and domain name used to sign the payload.
# Production
We recommend using [PM2](https://www.npmjs.com/package/pm2) package to manage running the server.
Starting the server:
```
$ cd
$ pm2 start ~/.nvm/versions/node/v12.14.1/bin/yarn --name vault-auth-server -- serve
```
Restarting the server:
```
$ pm2 restart vault-auth-server -- serve
```
Stopping the server:
```
$ pm2 stop vault-auth-server -- serve
```
Monitoring the server:
```
$ pm2 monit
```
It's also recommended to install `pm2-logrotate` which is useful to manage logs on the server.