Configure WebAuthn for Biometric Authentication [wallet - service]

[salazarsebas]

🔑 Configure WebAuthn for Biometric Authentication 🛠️

📝 Description

Configure the WebAuthn library to enable biometric authentication (e.g., fingerprint or Face ID) for the Stellar wallet service. This setup will provide secure user authentication by leveraging WebAuthn’s public key cryptography, preparing the service for registering and verifying user credentials in subsequent issues. The configuration will establish the server as a Relying Party (RP) for WebAuthn.

🎯 Objective

Set up WebAuthn in services/stellar-wallet/src/auth/webauthn.js to initialize the server as a Relying Party and provide functions for generating registration and verification options.

🗂 Structure

• Directory: services/stellar-wallet
• Files:
  • src/auth/webauthn.js
  • package.json (updated)
• Expected structure:

  services/stellar-wallet
  ├── src
  │   ├── index.js
  │   ├── stellar
  │   │   ├── client.js
  │   │   ├── keys.js
  │   │   └── fund.js
  │   ├── db
  │   │   └── kyc.js
  │   ├── routes
  │   │   ├── kyc.js
  │   │   ├── kyc-verify.js
  │   │   └── kyc-status.js
  │   ├── kyc
  │   │   └── validate.js
  │   ├── soroban
  │   │   ├── client.js
  │   │   ├── kyc-contract.rs
  │   │   └── deploy.js
  │   └── auth
  │       └── webauthn.js
  ├── config
  │   └── db.sqlite
  ├── tests
  │   ├── stellar
  │   │   ├── client.test.js
  │   │   ├── keys.test.js
  │   │   └── fund.test.js
  │   ├── db
  │   │   └── kyc.test.js
  │   ├── routes
  │   │   ├── kyc.test.js
  │   │   ├── kyc-verify.test.js
  │   │   └── kyc-status.test.js
  │   ├── kyc
  │   │   └── validate.test.js
  │   └── soroban
  │       ├── client.test.js
  │       └── deploy.test.js
  ├── package.json
  ├── .env.example
  ├── .eslintrc.json
  ├── .eslintignore
  ├── .prettierrc.json
  ├── .prettierignore
  ├── .gitignore
  

✅ Requirements

• Create a branch named feat/webauthn-config for this task.
• Install the WebAuthn server library using npm install @simplewebauthn/server.
• Update package.json to include @simplewebauthn/server as a dependency.
• Create src/auth/webauthn.js with functions:
  • configureWebAuthn: Initializes the WebAuthn server as a Relying Party with configuration (e.g., RP name, ID, and origin from .env).
  • generateRegistrationOptions: Generates WebAuthn registration options for a user.
  • generateAuthenticationOptions: Generates WebAuthn authentication options for a user.
• Add environment variables to .env.example for WebAuthn configuration (e.g., RP_NAME, RP_ID, ORIGIN).
• Set RP_NAME to a descriptive name (e.g., Stellar Wallet), RP_ID to the server domain (e.g., localhost for development), and ORIGIN to the server URL (e.g., http://localhost:3000).
• Ensure the functions produce valid WebAuthn options compatible with browser-based authenticators (e.g., fingerprint or Face ID).
• Ensure the code adheres to ESLint and Prettier rules (from Issue 3).
• Commit changes to the feat/webauthn-config branch with a message like feat: configure webauthn.
• Verify that the CI pipeline (from Issue 1) passes, with linting succeeding (no tests required for this issue).

🏆 Expected Outcomes

• @simplewebauthn/server is installed and listed in package.json.
• src/auth/webauthn.js contains configureWebAuthn, generateRegistrationOptions, and generateAuthenticationOptions functions.
• WebAuthn is configured as a Relying Party with values from environment variables.
• .env.example includes RP_NAME, RP_ID, and ORIGIN for WebAuthn configuration.
• Code passes ESLint and Prettier checks.
• Changes are committed to the feat/webauthn-config branch with a descriptive lowercase commit message.
• CI pipeline runs successfully, with linting passing for src/auth/webauthn.js.

🔗 References

• SimpleWebAuthn Server
• WebAuthn Guide
• ESLint Node.js Rules

📋 Notes

• The RP_ID should be set to localhost for development but updated to the production domain later.
• The ORIGIN must match the server’s URL to ensure compatibility with WebAuthn clients.
• No unit tests are required in this issue, as testing will be covered in subsequent issues for registration and authentication.
• Ensure environment variables are documented in .env.example without sensitive values.
• Commit messages must be in lowercase and start with feat, change, fix, chore, or refactor.
• The CI pipeline should validate the new code, ensuring ESLint passes for src/auth/webauthn.js.

[Benjtalkshow]

Hello @salazarsebas
Can i work on this task? Kindly assign. Thanks