node-eauth-server - GitLite

KO | EN

gitlite — search

#javascript #python #react #llm #android #rust #docker #nodejs #macos #windows #kubernetes #security #pytorch #ios

node-eauth-server

(★ 91)

An OAuth-compatiable service based on Ethereum credentials to authenticate users on a website. See live version at https://eauth.pelith.com/ https://forum.hakka.finance

File Explorer

Download Latest Version (.zip)

- - contract.js
  - index.js
- - eauth.js
  - index.js
- - index.js
- - authenticate.js
  - express.js
  - index.js
  - oauth.js
  - oauth_models.js
- - index.js
  - qrcode.js
- index.js
- Session.js
- User.js
- - eauth_bg.png
  - ethereum@2x.png
  - fortmatic@2x.png
  - logo.png
  - logo.svg
  - refresh.svg
  - sign@2x.png
  - WalletConnect@2x.png
- - contractinput.js
  - contractlogin.js
  - customizedsign.js
  - index.js
  - login.js
  - mobile-socket.js
  - pageControl.js
  - qrcode.min.js
  - showAddress.js
  - toast.js
  - web3.js
- - bootstrap.min.css
  - main.css
  - normalize.css
  - toastr.min.css
- favicon.ico
- authorise.pug
- contractInput.pug
- contractLogin.pug
- customizedSign.pug
- error.pug
- index.pug
- layout.pug
- login.pug
- logout.pug
.dockerignore
.env.example
.eslintrc
.gitignore
.sequelizerc
Dockerfile
index.js
LICENSE
package.json
pm2.config.js.example
README.md
yarn.lock

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Eauth Server &middot;  [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/pelith/node-eauth-server/blob/master/LICENSE)

## Introduction
An OAuth2-compatible service based on Ethereum credentials to authenticate users on website.

And also has these features:
* Contact Login [ERC-1271](https://eips.ethereum.org/EIPS/eip-1271)
* [ENS](https://ens.domains/)
* QRcode for mobile devices remote login
* Support [Fortmatic](https://fortmatic.com/), [Wallet Connect](https://walletconnect.org/)

## Demo

Eauth - An Oauth2 compatible authentication service: https://www.youtube.com/watch?v=fE5B7DaRHnA

Hakka Forum with Eauth: https://forum.hakka.finance

Usages: [eauth-examples](https://github.com/pelith/eauth-examples)

## Requirements

* **Node.js** 10 or higher

## Installation

### 1. Clone this repo, and install dependencies.

Using [yarn](https://yarnpkg.com/):
   ```bash
   $ yarn install
   ```
   
   **Notice**: For those who are not using **SQLite**:
   ```bash
   $ yarn install --ignore-optional
   ```

### 2. Configure Eauth config.

2.1. Copy an example configuration:
   ```bash
   $ cp .env.example .env
   ```
   
   2.2. Configure your `.env` following `.env.example`:
   
   See more information : [Sequelize configuration](https://sequelize.org/master/manual/migrations.html#configuration)
   
### 3. Setup OAuth Clients.
  
  ### Manual
  
  3.1.1 Connect to your database, and fulfill the table below with Oauth data 
  
  Table: oauth_clients

| client_id | client_secret |  redirect_uri |
  |    ---    |      ---      |      ---      |
  |    ...    |      ...      |      ...      |

### Insert a client config when the server starts

3.2.1 Setup your client configs `name, client_id, client_secret, redirect_uri` in `.env`

## Usage
### Quickstart

Start the server: `node -r dotenv/config index.js`. \
Test it on `http://localhost:8080/`.

### Using PM2

```bash
$ npm i -g pm2

$ cp pm2.config.js.example pm2.config.js

$ pm2 start pm2.config.js --env development // development mode on port 8080

// or

$ pm2 start pm2.config.js --env production // production mode on port 80
```

### Docker

#### Get it from [DockerHub](https://hub.docker.com/r/pelith/node-eauth-server)

For normal version

```bash
$ docker pull pelith/node-eauth-server:latest
$ docker run --net=host --env-file ./.env -d pelith/node-eauth-server
```

For ENS version

```bash
$ docker pull pelith/node-eauth-server:latest-ENS
$ docker run --net=host --env-file ./.env -d pelith/node-eauth-server
```

**Optionally**: Build docker image manually

```bash
$ docker build -t pelith/node-eauth-server .
```

## Tutorial

This service requires a wallet which supports `eth_signTypedData`, `personal_sign` or customized method for your contract wallet. For first-time visitors, the simplest setup is to include a MetaMask download badge before proceeding to the authentication page.

Browser Extensions (MetaMask) | Mobile Wallets (imToken / Trustwallet) | Other SDK (Fortmatic)
:-------------------------:|:-------------------------:|:-------------------------:
[<img alt="MetaMask badge" src="https://raw.githubusercontent.com/MetaMask/metamask-extension/develop/app/images/icon-128.png" height="100">](https://metamask.io)  |  [<img alt="imToken badge" src="https://token.im/img/appLogo.svg" height="100">](https://token.im/download?locale=en-us) [<img alt="Trustwallet badge" src="https://avatars0.githubusercontent.com/u/32179889?s=100&v=4" height="100">](https://trustwallet.com/) | [<img alt="Fortmatic badge" src="https://avatars1.githubusercontent.com/u/38988377?s=90&v=4" height="100">](https://fortmatic.com/)

1. In the page `/`, you can decide to login with your Ethereum wallet or contract wallet which implements [ERC-1271](https://github.com/ethereum/EIPs/issues/1271).

![Main Page](https://user-images.githubusercontent.com/16600750/64110015-7dac8400-cd70-11e9-83ab-412ad8b17a59.png)

2. For Ethereum wallet, there is no email/id/password input fields. Instead, **you gotta sign in with your Ethereum credentials**. If your MetaMask is locked or in [the privacy mode](https://medium.com/metamask/introducing-privacy-mode-42549d4870fa), it would prompt you to unlock. You can also scan the QR Code to open the URL with your mobile wallet (imToken or Trustwallet), then sign the message for authentication through socket.

![Login with Ethereum](https://user-images.githubusercontent.com/16600750/64110510-e8aa8a80-cd71-11e9-9f5a-8bd3195b95e8.png)

3. In your wallet, you should check the banner and the prefix of message, usually the brand name of a site. The challenge message should contain a token string. If it's the correct info from the site you are about to login, click "Sign" or "Confirm" to proceed.

![Signing Process](https://user-images.githubusercontent.com/16600750/64104830-90b95700-cd64-11e9-8f0f-6d642692b72b.jpeg)

4. Next, your wallet address is shown and you are asked for authorization. **This step is to bind that wallet address to your account.** Click "Authorize" to proceed, or click "Use another account" if this is not the account you intend to use.

![Authorise](https://user-images.githubusercontent.com/16600750/64116418-d3d5f300-cd81-11e9-9de6-fb81bfb437df.png)

5. If everything is fine, you will be redirected back to the original site. Clicking "Logout" will log you out and reset the session.

6. For contract wallet, you'll have to input your contract address (ENS is also acceptable if the feature is enabled), Click "Use Contract" and choose your way to verify.

![Contract Input](https://user-images.githubusercontent.com/16600750/64110524-f19b5c00-cd71-11e9-9705-39fe7ee70084.png)

7. The `eth_signTypedData` and `personal_sign` will both works if you implement the [ERC-1271](https://github.com/ethereum/EIPs/issues/1271) like [this](https://github.com/artistic709/solidity_contracts/blob/master/personalwalletfactory.sol#L106). The signing process will be the same as Ethereum login. However, if you're using customized signature for verification, click "Customized Sign".

![Contract](https://user-images.githubusercontent.com/16600750/64110536-f7913d00-cd71-11e9-9107-5d5ce93ca57b.png)

8. For Customized Sign, server will return the full message for signing and the hexed message after web3.sha3(message). Sign the message with your customized way and fill the signature below. Click "Verify Signature" to login with your contract wallet.

![Customized](https://user-images.githubusercontent.com/16600750/64110579-17286580-cd72-11e9-89d4-42bf5cfd4123.png)

## Discourse Integration

1. Install [discourse-eauth](https://github.com/pelith/discourse-eauth) plugin by following this [guide](https://meta.discourse.org/t/install-plugins-in-discourse/19157).

2. Enable the plugin at `/admin/site_settings/category/plugins`.
![Setup Plugin](https://user-images.githubusercontent.com/16600750/64149783-63c57c80-ce16-11e9-92f1-693eb0a70680.png)
![Configs](https://user-images.githubusercontent.com/16600750/64155221-e7d13180-ce21-11e9-9ae8-0644a81d85a0.png)

3. Set max username length up to 42. Remember to setup username change period if you're allowing users to edit their username instead of using the address they registered.
![username length](https://user-images.githubusercontent.com/16600750/64155052-9a54c480-ce21-11e9-92a7-fbe6e08befff.png)
![edit username](https://user-images.githubusercontent.com/16600750/64159073-26b6b580-ce29-11e9-80a8-abc1235ae46a.png)

4. [Setup OAuth client](https://github.com/pelith/node-eauth-server/tree/componentize#setup-oauth-clients) and use `http://your.domain/auth/eauthoauth2/callback` as your OAuth `redirect_uri`

5. Finally, enjoy!

## Fortmatic

Let users access blockchain apps from anywhere 💻📱 - without forcing them to wrestle with browser extensions, wallets, or seed phrases, see more at [fortmatic.com](fortmatic.com)

## License

Node Eauth Server is [MIT licensed](./LICENSE).