pelith/node-eauth-server repository overview

⁠Eauth Server ·

⁠Introduction

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

And also has these features:

• Contact Login ERC-1271⁠
• ENS⁠
• QRcode for mobile devices remote login
• Support Fortmatic⁠, Wallet Connect⁠

⁠Demo

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

Gitlab OAuth with Eauth: https://gitlab-demo.pelith.com⁠

Usages: eauth-examples⁠

⁠Requirements

• Node.js 10 or higher

⁠Installation

⁠1. Clone this repo, and install dependencies.

Using npm⁠:

$ npm i

Notice: For those who are not using ENS or Contact Login, following command can speed up the step:

$ npm i --no-optional

⁠2. Configure Eauth config.

2.1. Copy an example configuration:

$ cp .env.example .env

2.2. Configure your .env accordingly. Edit the following entries:

# eauth configs
# your brand name
EAUTH_BANNER=YOUR_BANNER_HERE
# morgan logger
EAUTH_LOGGING=true
# prefix showing with token
EAUTH_MESSAGE_PREFIX=This is a prefix example%0A%0Atoken:%0A----------%0A
# rpc for ENS and contract wallets
EAUTH_RPC_URL=https://rinkeby.infura.io/
# session lifetime for OAuth
EAUTH_SESSION_TIMEOUT=60000
#  app secret
EAUTH_SECRET=YOUR_SECRET_HERE

# component configs
# isValidSignature feature for ERC-1271
EAUTH_COMPONENTS_CONTRACT=true 
# ENS feature for OAuth and contract wallet
EAUTH_COMPONENTS_ENS=true
# Fortmatic ui component
EAUTH_COMPONENTS_FORTMATIC=true
# OAuth component
EAUTH_COMPONENTS_OAUTH=true
# qrcode for remote login
EAUTH_COMPONENTS_QRCODE=true
# 
EAUTH_COMPONENTS_UI=true
# Wallet Connect component
EAUTH_COMPONENTS_WALLETCONNECT=true

# Eauth DB configs
EAUTH_DB_DIALECT=mysql
EAUTH_DB_HOST=127.0.0.1
EAUTH_DB_PORT=3306
EAUTH_DB_USER=YOUR_DB_USER_HERE
EAUTH_DB_PASSWORD=YOUR_DB_PASSWORD_HERE
EAUTH_DB_NAME=YOUR_DB_NAME_HERE

# Eauth OAuth db configs
EAUTH_OAUTH_DB_DIALECT=mysql
EAUTH_OAUTH_DB_HOST=127.0.0.1
EAUTH_OAUTH_DB_PORT=32769
EAUTH_OAUTH_DB_USER=YOUR_DB_USER_HERE
EAUTH_OAUTH_DB_PASSWORD=YOUR_DB_PASSWORD_HERE
EAUTH_OAUTH_DB_NAME=YOUR_DB_NAME_HERE

See more information : Sequelize configuration⁠

⁠3. Setup OAuth Clients.

⁠Manual

3.1.1 Connect to your database, and fulfill the table below with Oauth datas

Table: oauth_clients

⁠Command

3.2.1 Setup your client_id, client_secret, redirect_uri in components/seeders/20190725062038-oauth_clients.js⁠

3.2.2 Seeding them with follow command:

$ npx sequelize db:seed:all

⁠Usage

⁠Quickstart

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

⁠Using PM2

$ 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⁠

$ docker run --env-file ./.env -p 8080:8080 -d pelith/node-eauth-server

Optionally: Build docker image manually

$ 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)

1. In the page /, you can decide to login with your Ethereum wallet or contract wallet which implements ERC-1271⁠.

   

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⁠, 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.

   

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.

   

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.

   

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.

   

7. The eth_signTypedData and personal_sign will both works if you implement the ERC-1271⁠ like this⁠. The signing process will be the same as Ethereum login. However, if you're using customized signature for verification, click "Customized Sign".

   

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.

   

⁠Discourse Integration

1. Install discourse-eauth⁠ plugin by following this guide⁠.

2. Enable the plugin at /admin/site_settings/category/plugins.

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.

4. Setup OAuth client⁠ 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⁠

⁠License

React is MIT licensed⁠.