<!---
Copyright (C) 2021 Robin Krahl <robin.krahl@ireas.org>
SPDX-License-Identifier: CC0-1.0
-->

# cptahid-types

Data types for the CTAPHID protocol.

The `ctaphid-types` crate provides data types that are used by the [CTAPHID
protocol][spec].  It is intended to be usable both by client and device
implementations as well as packet parsers.

[spec]: https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-20210615.html#usb

Please see the [API documentation][docs] for more information.

[docs]: https://docs.rs/ctaphid-types

## Features

This crate has the following features:

- `std` (enabled by default): Implements `std::error::Error` for error types.
  Disable this feature to make the crate `no_std`.

## Contributing

This crate is developed as a part of the [`ctaphid-rs`][] repository.  Please
refer to [the `ctaphid-rs` readme][ctaphid-rs-readme] for more information.

[`ctaphid-rs`]: https://git.sr.ht/~ireas/ctaphid-rs
[ctaphid-rs-readme]: https://git.sr.ht/~ireas/ctaphid-rs/tree/master/item/README.md

## Contact

For bug reports, feature requests and other messages, please send a mail to
[~ireas/public-inbox@lists.sr.ht][] ([archive][]) using the `[ctaphid-rs]`
prefix in the subject.

[~ireas/public-inbox@lists.sr.ht]: mailto:~ireas/public-inbox@lists.sr.ht
[archive]: https://lists.sr.ht/~ireas/public-inbox

## License

This project is dual-licensed under the [Apache-2.0][] and [MIT][] licenses.
The documentation and examples contained in this repository are licensed under
the [Creative Commons Zero][CC0] license.  You can find a copy of the license
texts in the `../LICENSES` directory.

`ctaphid-types` complies with [version 3.0 of the REUSE specification][reuse].

[Apache-2.0]: https://opensource.org/licenses/Apache-2.0
[MIT]: https://opensource.org/licenses/MIT
[CC0]: https://creativecommons.org/publicdomain/zero/1.0/
[reuse]: https://reuse.software/practices/3.0/

