1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
// Copyright 2015-2021 Swim Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! A library for writing extensions for [Ratchet](../ratchet).
//!
//! # Implementations:
//! [ratchet_deflate](../ratchet_deflate)
//!
//! # Usage
//! Implementing an extension requires two traits to be implemented: [ExtensionProvider] for
//! negotiating the extension during the WebSocket handshake, and [Extension] (along with its
//! bounds) for using the extension during the session.
//!
//! # Splitting an extension
//! If a WebSocket is to be split into its sending and receiving halves then the extension must
//! implement the `SplittableExtension` trait and if it is to be reunited then it must implement the
//! `ReunitableExtension`. This allows more fine-grained control over the BiLock within the
//! receiver.
#![deny(
missing_docs,
missing_debug_implementations,
unused_imports,
unused_import_braces
)]
pub use http::{HeaderMap, HeaderValue};
pub use httparse::Header;
use bytes::BytesMut;
use std::error::Error;
use std::fmt::Debug;
/// A trait for negotiating an extension during a WebSocket handshake.
///
/// Extension providers allow for a single configuration to be used to negotiate multiple peers.
pub trait ExtensionProvider {
/// The extension produced by this provider if the negotiation was successful.
type Extension: Extension;
/// The error produced by this extension if the handshake failed.
type Error: Error + Sync + Send + 'static;
/// Apply this extension's headers to a request.
fn apply_headers(&self, headers: &mut HeaderMap);
/// Negotiate the headers that the server responded with.
///
/// If it is possible to negotiate this extension, then this should return an initialised
/// extension.
///
/// If it is not possible to negotiate an extension then this should return `None`, not `Err`.
/// An error should only be returned if the server responded with a malformatted header or a
/// value that was not expected.
///
/// Returning `Err` from this will *fail* the connection with the reason being the error's
/// `to_string()` value.
fn negotiate_client(&self, headers: &[Header]) -> Result<Option<Self::Extension>, Self::Error>;
/// Negotiate the headers that a client has sent.
///
/// If it is possible to negotiate this extension, then this should return a pair containing an
/// initialised extension and a `HeaderValue` to return to the client.
///
/// If it is not possible to negotiate an extension then this should return `None`, not `Err`.
/// An error should only be returned if the server responded with a malformatted header or a
/// value that was not expected.
///
/// Returning `Err` from this will *fail* the connection with the reason being the error's
/// `to_string()` value.
fn negotiate_server(
&self,
headers: &[Header],
) -> Result<Option<(Self::Extension, HeaderValue)>, Self::Error>;
}
impl<'r, E> ExtensionProvider for &'r mut E
where
E: ExtensionProvider,
{
type Extension = E::Extension;
type Error = E::Error;
fn apply_headers(&self, headers: &mut HeaderMap) {
E::apply_headers(self, headers)
}
fn negotiate_client(&self, headers: &[Header]) -> Result<Option<Self::Extension>, Self::Error> {
E::negotiate_client(self, headers)
}
fn negotiate_server(
&self,
headers: &[Header],
) -> Result<Option<(Self::Extension, HeaderValue)>, Self::Error> {
E::negotiate_server(self, headers)
}
}
impl<'r, E> ExtensionProvider for &'r E
where
E: ExtensionProvider,
{
type Extension = E::Extension;
type Error = E::Error;
fn apply_headers(&self, headers: &mut HeaderMap) {
E::apply_headers(self, headers)
}
fn negotiate_client(&self, headers: &[Header]) -> Result<Option<Self::Extension>, Self::Error> {
E::negotiate_client(self, headers)
}
fn negotiate_server(
&self,
headers: &[Header],
) -> Result<Option<(Self::Extension, HeaderValue)>, Self::Error> {
E::negotiate_server(self, headers)
}
}
/// A data code for a frame.
#[derive(Debug, Copy, Clone, PartialEq)]
pub enum OpCode {
/// The message is a continuation.
Continuation,
/// The message is text.
Text,
/// The message is binary.
Binary,
}
impl OpCode {
/// Returns whether this `OpCode` is a continuation.
pub fn is_continuation(&self) -> bool {
matches!(self, OpCode::Continuation)
}
/// Returns whether this `OpCode` is text.
pub fn is_text(&self) -> bool {
matches!(self, OpCode::Text)
}
/// Returns whether this `OpCode` is binary.
pub fn is_binary(&self) -> bool {
matches!(self, OpCode::Binary)
}
}
/// A frame's header.
///
/// This is passed to both `ExtensionEncoder::encode` and `ExtensionDecoder::decode` when a frame
/// has been received. Changes to the reserved bits on a decode call will be sent to the peer.
/// Any other changes or changes made when decoding will have no effect.
#[derive(Debug, PartialEq)]
pub struct FrameHeader {
/// Whether this is the final frame.
///
/// Changing this field has no effect.
pub fin: bool,
/// Whether `rsv1` was high.
pub rsv1: bool,
/// Whether `rsv2` was high.
pub rsv2: bool,
/// Whether `rsv3` was high.
pub rsv3: bool,
/// The frame's data code.
///
/// Changing this field has no effect.
pub opcode: OpCode,
}
/// A structure containing the bits that an extension *may* set high during a session.
///
/// If any bits are received by a peer during a session that are different to what this structure
/// returns then the session is failed.
#[derive(Debug)]
pub struct RsvBits {
/// Whether `rsv1` is allowed to be high.
pub rsv1: bool,
/// Whether `rsv2` is allowed to be high.
pub rsv2: bool,
/// Whether `rsv3` is allowed to be high.
pub rsv3: bool,
}
impl From<RsvBits> for u8 {
fn from(bits: RsvBits) -> Self {
let RsvBits { rsv1, rsv2, rsv3 } = bits;
(rsv1 as u8) << 6 | (rsv2 as u8) << 5 | (rsv3 as u8) << 4
}
}
/// A negotiated WebSocket extension.
pub trait Extension: ExtensionEncoder + ExtensionDecoder + Debug {
/// Returns the reserved bits that this extension *may* set high during a session.
fn bits(&self) -> RsvBits;
}
/// A per-message frame encoder.
pub trait ExtensionEncoder {
/// The error type produced by this extension if encoding fails.
type Error: Error + Send + Sync + 'static;
/// Invoked when a frame has been received.
///
/// # Continuation frames
/// If this frame is not final or a continuation frame then `payload` will contain all of the
/// data received up to and including this frame.
///
/// # Note
/// If a condition is not met an implementation may opt to not encode this frame; such as the
/// payload length not being large enough to require encoding.
fn encode(
&mut self,
payload: &mut BytesMut,
header: &mut FrameHeader,
) -> Result<(), Self::Error>;
}
/// A per-message frame decoder.
pub trait ExtensionDecoder {
/// The error type produced by this extension if decoding fails.
type Error: Error + Send + Sync + 'static;
/// Invoked when a frame has been received.
///
/// # Continuation frames
/// If this frame is not final or a continuation frame then `payload` will contain all of the
/// data received up to and including this frame.
///
/// # Note
/// If a condition is not met an implementation may opt to not decode this frame; such as the
/// payload length not being large enough to require decoding.
fn decode(
&mut self,
payload: &mut BytesMut,
header: &mut FrameHeader,
) -> Result<(), Self::Error>;
}
/// A trait for permitting an extension to be split into its encoder and decoder halves. Allowing
/// for a WebSocket to be split into its sender and receiver halves.
pub trait SplittableExtension: Extension {
/// The type of the encoder.
type SplitEncoder: ExtensionEncoder + Send + Sync + 'static;
/// The type of the decoder.
type SplitDecoder: ExtensionDecoder + Send + Sync + 'static;
/// Split this extension into its encoder and decoder halves.
fn split(self) -> (Self::SplitEncoder, Self::SplitDecoder);
}
/// A trait for permitting a matched encoder and decoder to be reunited into an extension.
pub trait ReunitableExtension: SplittableExtension {
/// Reunite this encoder and decoder back into a single extension.
fn reunite(encoder: Self::SplitEncoder, decoder: Self::SplitDecoder) -> Self;
}