/php-metamask-user-login

Web3 passwordless user login with MetaMask and PHP

Primary LanguagePHPMIT LicenseMIT

Web3 Passwordless Sign-In System with Ethereum, MetaMask, and PHP

Demo: https://setinblock.com/php-metamask-user-login

About

Sign-in with Ethereum using MetaMask, PHP, JWT, and MySQL/PostgreSQL.

The concept of such user authentication system (initially based on this article) is as follows: The backend provides a random message for the user to sign it with his or her MetaMask wallet. The signed message is then returned to the backend, together with the user's public Ethereum address. Having the message, the same message signed by the user and user's public address, the backend can perform some cryptographic magic in order to know if the message was signed with the same private key to which the public address belongs. The public address also works as a username to identify the user's account. If the signed message and public address belong to the same private key, it means that the user who is trying to log in is also the owner of the account.

After the successful validation, the backend creates a JSON Web Token (JWT) and sends it to the frontend to authenticate the further user requests.

The "Public name" input field (visible after the successful login) is just an example showing how to update user's metadata using JWT. When entered by the user, this field is stored in the db and loaded the next time the user logs in.

The cryptographic magic mentioned above is done using Elliptic Curve Cryptography and Keccak (SHA-3) libraries. The necessary parts of these libraries are bundled into the source of this repository, but if you wish, you can install them separately using Composer. Keccak requires PHP version 7.1.0 or higher.

Quick launch

To launch the demo app provided in this repository, first download all files. Then put them in your remote or local PHP + MySQL/PostgreSQL server's public html directory. Create an empty database, edit credentials in backend/config.php and then open create_db_table.php in your browser. Then open index.html.

Integrate

To add this to your website or a web app:

  • Clone this repo into the root of your web application.
  • Update config.php file with your database credentials and then run create_db_table.php to create the required database table.
  • Update the backendPath JavaScript variable.
  • Open your-app.domain/php-metamask-user-login in your browser. There should be a fully working demo login screen.
  • Use the demo index.html file as a reference when building your own user login UI/UX.

Issues

Report issues in issue tracker.

Contribution

Feel free to make a pull request or suggest ideas.