Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Usage section of README with links to Warden & Devise gems #391

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Usage section of README with links to Warden & Devise gems #391

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,33 @@ Or install it yourself as:

## Usage

You can find a working example on how to use this gem in a pasword-less login in a __Rails__ app in [webauthn-rails-demo-app](https://github.com/cedarcode/webauthn-rails-demo-app). If you want to see an example on how to use this gem as a second factor authenticator in a __Rails__ application instead, you can check it in [webauthn-2fa-rails-demo](https://github.com/cedarcode/webauthn-2fa-rails-demo).
### Cedarcode Demo Apps

If you are migrating an existing application from the legacy FIDO U2F JavaScript API to WebAuthn, also refer to
[`docs/u2f_migration.md`](docs/u2f_migration.md).
These demo apps are provided by Cedarcode

* **Passwordless login for a _Rails_ app**: [webauthn-rails-demo-app](https://github.com/cedarcode/webauthn-rails-demo-app)
* **Second-factor authentication method in a _Rails_ app**: [webauthn-2fa-rails-demo](https://github.com/cedarcode/webauthn-2fa-rails-demo)

### Devise Extension

The Ruby passkeys organization has a Devise extension that can be used to provide passkey authentication using `webauthn-ruby`.

_Note that this extension is currently in an Alpha, experimental state. [You can learn more about how to help out here!](https://github.com/ruby-passkeys/.github/issues/1)_

* [`devise-passkeys` gem](https://github.com/ruby-passkeys/devise-passkeys)
* [`devise-passkeys-template` template repo for a _Rails_ app](https://github.com/ruby-passkeys/devise-passkeys-template)

### Warden Strategy

The Ruby passkeys organization has a Warden strategy that can be used to streamline `webauthn-ruby` calls & setup.

_Note that this extension is currently in an Alpha, experimental state. [You can learn more about how to help out here!](https://github.com/ruby-passkeys/.github/issues/1)_

* [`warden-webauthn` gem](https://github.com/ruby-passkeys/warden-webauthn)

### Migrating legacy FIDO U2F Javascript API to WebAuthn

If you are migrating an existing application from the legacy FIDO U2F JavaScript API to WebAuthn, also refer to [`docs/u2f_migration.md`](docs/u2f_migration.md).

### Configuration

Expand Down