Expand description
- Documentation: stable | master branch
- Changelog: Link
A library to work with Javascript Object Signing and Encryption(JOSE), including JSON Web Tokens (JWT), JSON Web Signature (JWS) and JSON Web Encryption (JWE)
This was based off Keats/rust-jwt.
Installation
Add the following to Cargo.toml:
biscuit = "0.0.8"To use the latest master branch, for example:
biscuit = { git = "https://github.com/lawliet89/biscuit", branch = "master" }See JWT for common usage examples.
Supported Features
The crate does not support all, and probably will never support all of the features described in the various RFCs, including some algorithms and verification.
See the documentation for more information.
References
- JWT Handbook — great introduction to JWT
- IANA JOSE Registry
RFCs
Modules
Errors returned will be converted to one of the structs in this module.
JSON Web Algorithms
JSON Web Key
JSON Web Signatures, including JWT signing and headers
Structs
A newtype wrapper around a string to indicate it’s base64 URL encoded
Options for claims presence validation
A collection of claims, both registered and your custom
private claims.
A collection of
CompactParts that have been converted to Base64UrlAn empty struct that derives Serialize and Deserialize. Can be used, for example, in places where a type
for custom values (such as private claims in a
ClaimsSet) is required but you have nothing to implement.Registered claims defined by RFC7519#4.1
Options for validating temporal claims
Wrapper around
DateTime<Utc> to allow us to do custom de(serialization)A parsed URL record.
Options for claims validation
Enums
Errors that can occur during parsing.
Defines whether a claim is required or not
Represents a choice between a single value or multiple values.
This value is serialized by serde untagged.
Represents a choice between a URI or an arbitrary string. Both variants will serialize to a string.
According to RFC 7519, any string containing the “:” character
will be deserialized as a URL. Any invalid URLs will be treated as a deserialization failure.
The URL is parsed according to the URL Standard which supersedes
RFC 3986 as required in
the JWT RFC.
Defines whether a claim is validated or not
Traits
A marker trait that indicates that the object is to be serialized to JSON and deserialized from JSON.
This is primarily used in conjunction with the
CompactPart trait which will serialize structs to JSON before
base64 encoding, and vice-versa.A “part” of the compact representation of JWT/JWS/JWE. Parts are first serialized to some form and then
base64 encoded and separated by periods.