Files
teleport/lib/auth/webauthncli/doc.go
T
2023-12-01 17:48:14 +00:00

45 lines
1.9 KiB
Go

/*
* Teleport
* Copyright (C) 2023 Gravitational, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
// Package webauthncli provides the client-side implementation for WebAuthn.
//
// There are two separate implementations contained within the package:
//
// * A U2F (aka CTAP1), pure Go implementation, backed by flynn/u2f
// * A FIDO2 (aka CTAP1/CTAP2) implementation, backed by Yubico's libfido2
//
// High-level API methods prefer the FIDO2 implementation, falling back to U2F
// if the binary isn't compiled with libfido2 support. Note that passwordless
// requires CTAP2.
//
// The FIDO2 implementation is protected by the `libfido2` build tag. In order
// to build FIDO2-enabled code, in addition to setting the build tag (eg, `go
// build -tags=libfido2 ./tool/tsh` or `go test -tags=libfido2
// ./lib/auth/webauthncli`), you must first have libfido2 installed in your
// system.
//
// To install libfido2 [follow its installation instructions](
// https://github.com/Yubico/libfido2#installation). See
// [gravitational/go-libfido2](https://github.com/gravitational/go-libfido2#why-fork)
// for additional build options.
//
// Refer to
// [buildbox](https://github.com/gravitational/teleport/blob/master/build.assets/Dockerfile#L10)
// for the library versions used by release binaries.
package webauthncli