Skip to content

Update fork documentation #16

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

Merged
codingllama merged 1 commit into from
Jan 23, 2024
Merged

Update fork documentation #16

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
20 changes: 12 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,9 @@ needs of [Teleport](https://github.com/gravitational/teleport).

The fork exists because:

1. It allows us to experiment and land required changes to go-libfido2 faster;
and
2. It allows us to tweak CGO build directives for the Teleport binaries.

We do intend to contribute widely valuable changes to the original repo, meaning
that over time (1) should become a non-issue. If the CGO build changes turn out
to be widely applicable (and accepted by the upstream repo), then the fork
becomes obsolete.
1. It allows us to experiment and land required changes to go-libfido2 faster,
2. It allows us to make necessary breaking changes; and
3. It allows us to tweak CGO build directives for the Teleport binaries.

The `master` branch reflects the upstream master.

Expand All @@ -29,6 +24,15 @@ write their own definition for the libfido2-static.pc file in this case.

You are looking at the `teleport` branch now.

## Breaking changes

Breaking changes in relation to upstream.

* Revamped build process (`libfido2` and `libfido2static` build tags, everything
based on `pkg-config`)
* Assertion func returns multiple assertions (#7)
* Devices have to be explicitly closed (#15)

# go-libfido2

Go wrapper for libfido2.
Expand Down