MIGRATION.md

Migration Guide

This is a guide on migration from github.com/duo-labs/webauthn. As discussed in this issue this library is tentatively the natural successor to the amazing github.com/duo-labs/webauthn.

Differences

There are several differences between the upstream library and this one (items marked with a strike-through indicate they are also solved/merged in the upstream fork now). We will aim to keep this list updated:

• There are minimal breaking changes between this library and the upstream one. Identified breaking changes exist in the following commits:
  • Change of protocol.ResidentKeyUnrequired() to protocol.ResidentKeyNotRequired() 5ad54f8. This method has been restored as a deprecated function making the migration path clearer.
• This library is versioned with branches per minor version for back-porting fixes.
• This library releases tagged versions.
• This library has a smaller dependency tree because of c561447.
• The following upstream issues have been resolved:
  • Issue #76 was fixed related to the google.golang.org/grpc/naming dependency was fixed by merging c561447 which migrates from the github.com/cloudflare/cfssl module to a fork of the features used by this module implemented in 1edcf14.
• The following pull requests in the upstream repository are merged in one form or another:
  • Pull Request #132 was merged in 401a3f6.
  • Pull Request #131 was merged in 509e08f (cherry-pick squashed).
  • Pull Request #130 was merged in 729227d (v0.2.x) and 93a942a (v0.1.x).
  • Pull Request #122 was merged in 2bbb113.
  • Pull Request #116 was (effectively) merged in d64d2ba.
• The following additional features have been added:
  • Support for the MDS3 in 697bc4c.
  • Migration to the Google TPM library in cdfc867.
  • Migration away from github.com/cloudflare/cfssl in c561447.
• The following misc fixes have been merged:
  • Ensuring the credential ID length is not too long in b3b93ac (v0.2.x) and 35287ea (v0.1.x).
  • Ensuring errors are effectively checked, ineffectual checks are not done, and general linting fixes in 90be0fe.
  • A potential nil pointer error in ParseFIDOPublicKey in 3551cfa.

Guide

At the present time the only adjustment that should need to be made is as follows:

• Follow the Quickstart.
• Replace all instances of github.com/duo-labs/webauthn with github.com/go-webauthn/webauthn.

If you believe this is an inaccurate guide please create a bug report or start a discussion.