mirror of
https://github.com/actix/actix-extras.git
synced 2024-11-28 17:52:40 +01:00
306 lines
10 KiB
Rust
306 lines
10 KiB
Rust
use std::fmt;
|
|
use std::convert::{Into, From};
|
|
use sha1;
|
|
use base64;
|
|
|
|
use self::OpCode::*;
|
|
/// Operation codes as part of rfc6455.
|
|
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
|
|
pub(crate) enum OpCode {
|
|
/// Indicates a continuation frame of a fragmented message.
|
|
Continue,
|
|
/// Indicates a text data frame.
|
|
Text,
|
|
/// Indicates a binary data frame.
|
|
Binary,
|
|
/// Indicates a close control frame.
|
|
Close,
|
|
/// Indicates a ping control frame.
|
|
Ping,
|
|
/// Indicates a pong control frame.
|
|
Pong,
|
|
/// Indicates an invalid opcode was received.
|
|
Bad,
|
|
}
|
|
|
|
impl fmt::Display for OpCode {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
match *self {
|
|
Continue => write!(f, "CONTINUE"),
|
|
Text => write!(f, "TEXT"),
|
|
Binary => write!(f, "BINARY"),
|
|
Close => write!(f, "CLOSE"),
|
|
Ping => write!(f, "PING"),
|
|
Pong => write!(f, "PONG"),
|
|
Bad => write!(f, "BAD"),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Into<u8> for OpCode {
|
|
|
|
fn into(self) -> u8 {
|
|
match self {
|
|
Continue => 0,
|
|
Text => 1,
|
|
Binary => 2,
|
|
Close => 8,
|
|
Ping => 9,
|
|
Pong => 10,
|
|
Bad => {
|
|
debug_assert!(false, "Attempted to convert invalid opcode to u8. This is a bug.");
|
|
8 // if this somehow happens, a close frame will help us tear down quickly
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
impl From<u8> for OpCode {
|
|
|
|
fn from(byte: u8) -> OpCode {
|
|
match byte {
|
|
0 => Continue,
|
|
1 => Text,
|
|
2 => Binary,
|
|
8 => Close,
|
|
9 => Ping,
|
|
10 => Pong,
|
|
_ => Bad
|
|
}
|
|
}
|
|
}
|
|
|
|
use self::CloseCode::*;
|
|
/// Status code used to indicate why an endpoint is closing the `WebSocket` connection.
|
|
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
|
|
pub enum CloseCode {
|
|
/// Indicates a normal closure, meaning that the purpose for
|
|
/// which the connection was established has been fulfilled.
|
|
Normal,
|
|
/// Indicates that an endpoint is "going away", such as a server
|
|
/// going down or a browser having navigated away from a page.
|
|
Away,
|
|
/// Indicates that an endpoint is terminating the connection due
|
|
/// to a protocol error.
|
|
Protocol,
|
|
/// Indicates that an endpoint is terminating the connection
|
|
/// because it has received a type of data it cannot accept (e.g., an
|
|
/// endpoint that understands only text data MAY send this if it
|
|
/// receives a binary message).
|
|
Unsupported,
|
|
/// Indicates that no status code was included in a closing frame. This
|
|
/// close code makes it possible to use a single method, `on_close` to
|
|
/// handle even cases where no close code was provided.
|
|
Status,
|
|
/// Indicates an abnormal closure. If the abnormal closure was due to an
|
|
/// error, this close code will not be used. Instead, the `on_error` method
|
|
/// of the handler will be called with the error. However, if the connection
|
|
/// is simply dropped, without an error, this close code will be sent to the
|
|
/// handler.
|
|
Abnormal,
|
|
/// Indicates that an endpoint is terminating the connection
|
|
/// because it has received data within a message that was not
|
|
/// consistent with the type of the message (e.g., non-UTF-8 [RFC3629]
|
|
/// data within a text message).
|
|
Invalid,
|
|
/// Indicates that an endpoint is terminating the connection
|
|
/// because it has received a message that violates its policy. This
|
|
/// is a generic status code that can be returned when there is no
|
|
/// other more suitable status code (e.g., Unsupported or Size) or if there
|
|
/// is a need to hide specific details about the policy.
|
|
Policy,
|
|
/// Indicates that an endpoint is terminating the connection
|
|
/// because it has received a message that is too big for it to
|
|
/// process.
|
|
Size,
|
|
/// Indicates that an endpoint (client) is terminating the
|
|
/// connection because it has expected the server to negotiate one or
|
|
/// more extension, but the server didn't return them in the response
|
|
/// message of the WebSocket handshake. The list of extensions that
|
|
/// are needed should be given as the reason for closing.
|
|
/// Note that this status code is not used by the server, because it
|
|
/// can fail the WebSocket handshake instead.
|
|
Extension,
|
|
/// Indicates that a server is terminating the connection because
|
|
/// it encountered an unexpected condition that prevented it from
|
|
/// fulfilling the request.
|
|
Error,
|
|
/// Indicates that the server is restarting. A client may choose to reconnect,
|
|
/// and if it does, it should use a randomized delay of 5-30 seconds between attempts.
|
|
Restart,
|
|
/// Indicates that the server is overloaded and the client should either connect
|
|
/// to a different IP (when multiple targets exist), or reconnect to the same IP
|
|
/// when a user has performed an action.
|
|
Again,
|
|
#[doc(hidden)]
|
|
Tls,
|
|
#[doc(hidden)]
|
|
Empty,
|
|
#[doc(hidden)]
|
|
Other(u16),
|
|
}
|
|
|
|
impl Into<u16> for CloseCode {
|
|
|
|
fn into(self) -> u16 {
|
|
match self {
|
|
Normal => 1000,
|
|
Away => 1001,
|
|
Protocol => 1002,
|
|
Unsupported => 1003,
|
|
Status => 1005,
|
|
Abnormal => 1006,
|
|
Invalid => 1007,
|
|
Policy => 1008,
|
|
Size => 1009,
|
|
Extension => 1010,
|
|
Error => 1011,
|
|
Restart => 1012,
|
|
Again => 1013,
|
|
Tls => 1015,
|
|
Empty => 0,
|
|
Other(code) => code,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl From<u16> for CloseCode {
|
|
|
|
fn from(code: u16) -> CloseCode {
|
|
match code {
|
|
1000 => Normal,
|
|
1001 => Away,
|
|
1002 => Protocol,
|
|
1003 => Unsupported,
|
|
1005 => Status,
|
|
1006 => Abnormal,
|
|
1007 => Invalid,
|
|
1008 => Policy,
|
|
1009 => Size,
|
|
1010 => Extension,
|
|
1011 => Error,
|
|
1012 => Restart,
|
|
1013 => Again,
|
|
1015 => Tls,
|
|
0 => Empty,
|
|
_ => Other(code),
|
|
}
|
|
}
|
|
}
|
|
|
|
static WS_GUID: &'static str = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
|
|
|
|
// TODO: hash is always same size, we dont need String
|
|
pub(crate) fn hash_key(key: &[u8]) -> String {
|
|
let mut hasher = sha1::Sha1::new();
|
|
|
|
hasher.update(key);
|
|
hasher.update(WS_GUID.as_bytes());
|
|
|
|
base64::encode(&hasher.digest().bytes())
|
|
}
|
|
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
#![allow(unused_imports, unused_variables, dead_code)]
|
|
use super::*;
|
|
|
|
macro_rules! opcode_into {
|
|
($from:expr => $opcode:pat) => {
|
|
match OpCode::from($from) {
|
|
e @ $opcode => (),
|
|
e => panic!("{:?}", e)
|
|
}
|
|
}
|
|
}
|
|
|
|
macro_rules! opcode_from {
|
|
($from:expr => $opcode:pat) => {
|
|
let res: u8 = $from.into();
|
|
match res {
|
|
e @ $opcode => (),
|
|
e => panic!("{:?}", e)
|
|
}
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_to_opcode() {
|
|
opcode_into!(0 => OpCode::Continue);
|
|
opcode_into!(1 => OpCode::Text);
|
|
opcode_into!(2 => OpCode::Binary);
|
|
opcode_into!(8 => OpCode::Close);
|
|
opcode_into!(9 => OpCode::Ping);
|
|
opcode_into!(10 => OpCode::Pong);
|
|
opcode_into!(99 => OpCode::Bad);
|
|
}
|
|
|
|
#[test]
|
|
fn test_from_opcode() {
|
|
opcode_from!(OpCode::Continue => 0);
|
|
opcode_from!(OpCode::Text => 1);
|
|
opcode_from!(OpCode::Binary => 2);
|
|
opcode_from!(OpCode::Close => 8);
|
|
opcode_from!(OpCode::Ping => 9);
|
|
opcode_from!(OpCode::Pong => 10);
|
|
}
|
|
|
|
#[test]
|
|
#[should_panic]
|
|
fn test_from_opcode_debug() {
|
|
opcode_from!(OpCode::Bad => 99);
|
|
}
|
|
|
|
#[test]
|
|
fn test_from_opcode_display() {
|
|
assert_eq!(format!("{}", OpCode::Continue), "CONTINUE");
|
|
assert_eq!(format!("{}", OpCode::Text), "TEXT");
|
|
assert_eq!(format!("{}", OpCode::Binary), "BINARY");
|
|
assert_eq!(format!("{}", OpCode::Close), "CLOSE");
|
|
assert_eq!(format!("{}", OpCode::Ping), "PING");
|
|
assert_eq!(format!("{}", OpCode::Pong), "PONG");
|
|
assert_eq!(format!("{}", OpCode::Bad), "BAD");
|
|
}
|
|
|
|
#[test]
|
|
fn closecode_from_u16() {
|
|
assert_eq!(CloseCode::from(1000u16), CloseCode::Normal);
|
|
assert_eq!(CloseCode::from(1001u16), CloseCode::Away);
|
|
assert_eq!(CloseCode::from(1002u16), CloseCode::Protocol);
|
|
assert_eq!(CloseCode::from(1003u16), CloseCode::Unsupported);
|
|
assert_eq!(CloseCode::from(1005u16), CloseCode::Status);
|
|
assert_eq!(CloseCode::from(1006u16), CloseCode::Abnormal);
|
|
assert_eq!(CloseCode::from(1007u16), CloseCode::Invalid);
|
|
assert_eq!(CloseCode::from(1008u16), CloseCode::Policy);
|
|
assert_eq!(CloseCode::from(1009u16), CloseCode::Size);
|
|
assert_eq!(CloseCode::from(1010u16), CloseCode::Extension);
|
|
assert_eq!(CloseCode::from(1011u16), CloseCode::Error);
|
|
assert_eq!(CloseCode::from(1012u16), CloseCode::Restart);
|
|
assert_eq!(CloseCode::from(1013u16), CloseCode::Again);
|
|
assert_eq!(CloseCode::from(1015u16), CloseCode::Tls);
|
|
assert_eq!(CloseCode::from(0u16), CloseCode::Empty);
|
|
assert_eq!(CloseCode::from(2000u16), CloseCode::Other(2000));
|
|
}
|
|
|
|
#[test]
|
|
fn closecode_into_u16() {
|
|
assert_eq!(1000u16, Into::<u16>::into(CloseCode::Normal));
|
|
assert_eq!(1001u16, Into::<u16>::into(CloseCode::Away));
|
|
assert_eq!(1002u16, Into::<u16>::into(CloseCode::Protocol));
|
|
assert_eq!(1003u16, Into::<u16>::into(CloseCode::Unsupported));
|
|
assert_eq!(1005u16, Into::<u16>::into(CloseCode::Status));
|
|
assert_eq!(1006u16, Into::<u16>::into(CloseCode::Abnormal));
|
|
assert_eq!(1007u16, Into::<u16>::into(CloseCode::Invalid));
|
|
assert_eq!(1008u16, Into::<u16>::into(CloseCode::Policy));
|
|
assert_eq!(1009u16, Into::<u16>::into(CloseCode::Size));
|
|
assert_eq!(1010u16, Into::<u16>::into(CloseCode::Extension));
|
|
assert_eq!(1011u16, Into::<u16>::into(CloseCode::Error));
|
|
assert_eq!(1012u16, Into::<u16>::into(CloseCode::Restart));
|
|
assert_eq!(1013u16, Into::<u16>::into(CloseCode::Again));
|
|
assert_eq!(1015u16, Into::<u16>::into(CloseCode::Tls));
|
|
assert_eq!(0u16, Into::<u16>::into(CloseCode::Empty));
|
|
assert_eq!(2000u16, Into::<u16>::into(CloseCode::Other(2000)));
|
|
}
|
|
}
|