README.md

web-authn-completed-app

English | 简体中文

web-authn-completed-app is a complete application based on SimpleWebAuthn. It allows websites to authenticate users using built-in authenticators such as Apple TouchID and Windows Hello or mobile device biometric sensor; it can replace conventional verification methods such as passwords or SMS verification codes, and provide users with a more secure and easy login experience.

About

This monorepo project contains code of client and server

• client
• server

For more information about client and server, please check the README of the module

Overview

💻 overview online demo: web-authn.starjump.space

What you'll need

• One of the following devices:
  • An Android device, preferably with a biometric sensor
  • An iPhone or iPad with Touch ID or Face ID on iOS 14 or higher
  • A MacBook Pro or Air with Touch ID on macOS Big Sur or higher
  • Windows 10 19H1 or higher with Windows Hello set up
• One of the following browsers:
  • Google Chrome 67 or higher
  • Microsoft Edge 85 or higher
  • Safari 14 or higher
  • visit Can I use to get more information

 

All user data registered through web-authn.starjump.space will not be used and is only for demo user statistics. If you are still concerned, you can email itgumx@163.com to delete the data.

Install

Install dependencies after cloning the code

git clone git@github.com:guMcrey/web-authn-completed-app.git
npm install pnpm -g
pnpm install

Development

⚠ In order to ensure that the full functionality can be used normally, it is recommended to use ngrok proxy to experience under HTTPS

1. Client, Server, and MySQL all use Docker images

Local environment preparation:

• Docker

docker-compose up --build -d
docker container ls
docker exec -ti <mysql-container-id> /bin/bash
mysql -h127.0.0.1 -uroot -pPassword123#@!

show databases;
use web_authn_demo;

Create a database table:

# Paste the content of packages/server/sql/init.sql into the command line of the mysql container
show tables;

Browser access：http://localhost:5173

---

2：Client and Server run locally, MySQL uses Docker image

Local environment preparation:

• Node 16+
• NPM 8+
• Docker

docker-compose -f docker-compose-dev.yml up --build -d
docker container ls
docker exec -ti <mysql-container-id> /bin/bash
mysql -h127.0.0.1 -uroot -pPassword123#@!

show databases;
use web_authn_demo;

Create a database table:

# Paste the content of packages/server/sql/init.sql into the command line of the mysql container
show tables;

Start the server and client

cd packages/server
pnpm run start:dev

cd ..
cd client
pnpm run dev

Browser access：http://localhost:5173

---

3：Client, Server, and MySQL all run locally

Local environment preparation:

• Node 16+
• NPM 8+
• MySQL 8+

Start the server and client

cd packages/server
pnpm run start:dev

cd ..
cd client
pnpm run dev

Connect to mysql

# Please modify the username and password as needed
mysql -h127.0.0.1 -uroot -pPassword123#@!

Create database tables

# Paste the contents of packages/server/sql/init.sql into the mysql command line
show tables;

Browser access：http://localhost:5173

FAQ

• MySQL 8.0 - Client does not support authentication protocol requested by server; consider upgrading MySQL client

  ALTER USER 'root' IDENTIFIED WITH mysql_native_password BY 'Password123#@!';
  flush privileges;
  

• Create authentication error under http

  • Create certificate, verify certificate functions are only available in the security context (HTTPS) of supported browsers

• When accessing http://localhost:5173, how to use the function of creating authentication or verifying authentication?

  • You can use ngrok as a proxy

  ngrok http 5173
  

License

is an open source project, licensed at MIT