<img src="https://cloud.bitfl0wer.de/apps/files_sharing/publicpreview/2qCxoXJ27yW7QNR?file=/&fileId=1143147&x=256&y=256&a=true" align="left" alt="a purple cog, split in the middle along the horizontal axis with a gap inbetween the two halves. three overlayed, offset sinus-like waves travel through that gap. each wave has a different shade of purple" width="128px" height="auto"></img>
### `polyproto`
![dev-status]
[![Zulip-shield]][Zulip]
[![Build][build-shield]][build-url]
[![Coverage][coverage-shield]][coverage-url]
[![FAQ-shield]][FAQ]
Crate supplying (generic) Rust types and traits to quickly get a
[polyproto][spec] implementation up and
running, as well as an HTTP client for the polyproto API.
**[Overview/TL;DR][overview]** • **[crates.io][crates-link]** • **[Protocol Specification][spec]**
## Crate overview
Building upon types offered by the [der](https://crates.io/crates/der),
[x509_cert](https://crates.io/crates/x509_cert) and [spki](https://crates.io/crates/spki) crates,
this crate provides a set of types and traits to quickly implement the polyproto specification.
Simply add cryptography and signature algorithm crates of your choice to the mix, and you are ready
to go.
All polyproto certificate types can be converted to and from the types offered by the `x509_cert`
crate.
## Implementing polyproto
Start by implementing the trait `[crate::signature::Signature]` for a signature algorithm of your
choice. Popular crates for cryptography and signature algorithms supply their own `PublicKey` and
`PrivateKey` types. You should extend upon these types with your own structs and implement the
`[crate::key]` traits for these new structs.
You can then use the `[crate::certs]` types to build certificates using your implementations of the
aforementioned traits.
**View the [examples](./examples/)** directory for a simple example on how to implement and use this
crate with the ED25519 signature algorithm.
## Cryptography
This crate provides no cryptographic functionality whatsoever; its sole purpose is to aid in
implementing polyproto by transforming the
[polyproto specification][spec] into
well-defined yet adaptable Rust types.
## Safety
Please refer to the documentation of individual functions for information on which safety guarantees
they provide. Methods returning certificates, certificate requests and other types where the
validity and correctness of the data has a chance of impacting the security of a system always
mention the safety guarantees they provide in their respective documentation.
This crate has not undergone any security audits.
## WebAssembly
This crate is designed to work with the `wasm32-unknown-unknown` target. To compile for `wasm`, you
will have to use the `wasm` feature:
```toml
[dependencies]
polyproto = { version = "0", features = ["wasm"] }
```
Additionally, you will have to compile the project using the `--no-default-features` flag, to ensure
that `tokio/net` is not pulled in as a feature dependency. The `types`, `serde`, `reqwest` and `gateway`
features all work with WASM.
## HTTP API client through `reqwest`
If the `reqwest` feature is activated, this crate offers a polyproto HTTP API client, using the
`reqwest` crate.
### Alternatives to `reqwest`
If you would like to implement an HTTP client using something other than `reqwest`, simply enable
the `types` and `serde` features. Using these features, you can implement your own HTTP client, with
the polyproto crate acting as a single source of truth for request and response types, as well as
request routes and methods through the exported `static` `Route`s.
## WebSocket Gateway client
Since `v0.10`, this crate ships polyproto WebSocket Gateway client functionality, gated behind the `gateway` feature.
The implementation of this feature is super backend-agnostic—though, for now, we have sealed the needed traits, and are only shipping a `tokio-tungstenite` backend for testing.
The gateway handles establishing a connection to the server, sending regular heartbeats at the specified interval and responding to Opcode 11—the manual heartbeat request.
Apart from the Hello payload, library consumers can easily get access to all messages received from the gateway by calling `subscribe()` on the internal `tokio::sync::watch::Sender<GatewayMessage>`. This means that this crate handles only the bare necessities of connecting to the gateway, and that you are free to handle incoming messages however you would like to. Our `GatewayMessage` type is `.into()` and `From::<>`-compatible with `tokio_tungstenite::tungstenite::Message`, so that you are not locked into using our message types, should you not want that.
## Versioning and MSRV
Semver v2.0 is used for the versioning scheme for this crate.
The default feature set of this crate is used to determine, verify and update the MSRV and semver version
of this crate.
## Logo
The polyproto logo was designed by the wonderful [antidoxi](https://antidoxi.carrd.co/).
The polyproto logos provided in this document are not covered by the MPL-2.0 license covering the rest
of this project.
[dev-status]: https://img.shields.io/static/v1?label=Status&message=Alpha&color=blue&style=for-the-badge
[build-shield]: https://codeberg.org/polyphony/polyproto-rs/badges/workflows/build_and_test.yml/badge.svg?style=for-the-badge
[build-url]: https://codeberg.org/polyphony/polyproto-rs/actions?workflow=build_and_test.yml
[coverage-shield]: https://img.shields.io/coverallsCoverage/github/polyphony-chat/polyproto-rs?style=for-the-badge
[coverage-url]: https://coveralls.io/github/polyphony-chat/polyproto-rs?branch=main
[Zulip-shield]: https://img.shields.io/badge/Zulip-Join_Chat-6492FE?style=for-the-badge&logo=zulip&logoColor=%23ffffff
[Zulip]: https://polyphony.zulipchat.com
[crates-link]: https://crates.io/crates/polyproto
[spec]: https://polyproto.org/docs/protocols/core
[overview]: https://polyproto.org/docs/intro
[FAQ-shield]: https://img.shields.io/badge/Frequently_Asked_Questions_(FAQ)-ff62bd?style=for-the-badge
[FAQ]: https://codeberg.org/polyphony/.profile/src/branch/main/FAQ.md