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 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
//! Compression and encryption protocol.
//!
//! Recommended to use this protocol.
//!
//! # Example
//! ```rust
//! use anyhow::Result;
//! use bytes::{Buf, BufMut, BytesMut};
//! use tcp_handler::protocols::compress_encrypt::*;
//! use tokio::net::{TcpListener, TcpStream};
//! use variable_len_reader::{VariableReader, VariableWriter};
//!
//! #[tokio::main]
//! async fn main() -> Result<()> {
//! let server = TcpListener::bind("localhost:0").await?;
//! let mut client = TcpStream::connect(server.local_addr()?).await?;
//! let (mut server, _) = server.accept().await?;
//!
//! let c_init = client_init(&mut client, "test", "0").await;
//! let s_init = server_init(&mut server, "test", |v| v == "0").await;
//! let (s_cipher, protocol_version, client_version) = server_start(&mut server, "test", "0", s_init).await?;
//! let c_cipher = client_start(&mut client, c_init).await?;
//! # let _ = protocol_version;
//! # let _ = client_version;
//!
//! let mut writer = BytesMut::new().writer();
//! writer.write_string("hello server.")?;
//! let mut bytes = writer.into_inner();
//! send(&mut client, &mut bytes, &c_cipher).await?;
//!
//! let mut reader = recv(&mut server, &s_cipher).await?.reader();
//! let message = reader.read_string()?;
//! assert_eq!("hello server.", message);
//!
//! let mut writer = BytesMut::new().writer();
//! writer.write_string("hello client.")?;
//! let mut bytes = writer.into_inner();
//! send(&mut server, &mut bytes, &s_cipher).await?;
//!
//! let mut reader = recv(&mut client, &c_cipher).await?.reader();
//! let message = reader.read_string()?;
//! assert_eq!("hello client.", message);
//!
//! Ok(())
//! }
//! ```
//!
//! The send protocol:
//! ```text
//! ┌────┬────────┬────────────┐ (It may not be in contiguous memory.)
//! in --> │ ** │ ****** │ ********** │
//! └────┴────────┴────────────┘
//! └─────┐
//! +Nonce │
//! │ │─ Chain
//! v v
//! ┌─────┬────┬────────┬────────────┐ (Zero copy. Not in contiguous memory.)
//! │ *** │ ** │ ****** │ ********** │
//! └─────┴────┴────────┴────────────┘
//! │
//! │─ DeflateEncoder
//! v
//! ┌─────────────────────┐ (Compressed bytes. In contiguous memory.)
//! │ ******************* │
//! └─────────────────────┘
//! │
//! │─ Encrypt in-place
//! v
//! ┌─────────────────────┐ (Compressed and encrypted bytes.)
//! out <-- │ ******************* │
//! └─────────────────────┘
//! ```
//! The recv process:
//! ```text
//! ┌─────────────────────┐ (Packet data.)
//! in --> │ ******************* │
//! └─────────────────────┘
//! │
//! │─ Decrypt in-place
//! v
//! ┌─────────────────────┐ (Decrypted bytes.)
//! │ ******************* │
//! └─────────────────────┘
//! │
//! │─ DeflateEncoder
//! v
//! ┌─────┬──────────────────┐ (Decrypted and decompressed bytes.)
//! │ *** │ **************** │
//! └─────┴──────────────────┘
//! │ │
//! -Nonce │
//! out <-- ───────┘
//! ```
use bytes::{Buf, BufMut, BytesMut};
use flate2::write::{DeflateDecoder, DeflateEncoder};
use tokio::io::{AsyncRead, AsyncWrite};
use tokio::task::block_in_place;
use variable_len_reader::{AsyncVariableReader, AsyncVariableWriter};
use variable_len_reader::helper::{AsyncReaderHelper, AsyncWriterHelper};
use crate::config::get_compression;
use crate::protocols::common::*;
/// Init the client side in tcp-handler compress_encrypt protocol.
///
/// Must be used in conjunction with [`client_start`].
///
/// # Runtime
/// Due to call [`block_in_place`] internally,
/// this function cannot be called in a `current_thread` runtime.
///
/// # Arguments
/// * `stream` - The tcp stream or `WriteHalf`.
/// * `identifier` - The identifier of your application.
/// * `version` - Current version of your application.
///
/// # Example
/// ```rust,no_run
/// use anyhow::Result;
/// use tcp_handler::protocols::compress_encrypt::{client_init, client_start};
/// use tokio::net::TcpStream;
///
/// #[tokio::main]
/// async fn main() -> Result<()> {
/// let mut client = TcpStream::connect("localhost:25564").await?;
/// let c_init = client_init(&mut client, "test", "0").await;
/// let cipher = client_start(&mut client, c_init).await?;
/// // Now the client is ready to use.
/// # let _ = cipher;
/// Ok(())
/// }
/// ```
pub async fn client_init<W: AsyncWrite + Unpin>(stream: &mut W, identifier: &str, version: &str) -> Result<rsa::RsaPrivateKey, StarterError> {
let (key, n, e) = block_in_place(|| generate_rsa_private())?;
write_head(stream, ProtocolVariant::CompressEncryption, identifier, version).await?;
AsyncWriterHelper(stream).help_write_u8_vec(&n).await?;
AsyncWriterHelper(stream).help_write_u8_vec(&e).await?;
flush(stream).await?;
Ok(key)
}
/// Init the server side in tcp-handler compress_encrypt protocol.
///
/// Must be used in conjunction with [`server_start`].
///
/// # Runtime
/// Due to call [`block_in_place`] internally,
/// this function cannot be called in a `current_thread` runtime.
///
/// # Arguments
/// * `stream` - The tcp stream or `ReadHalf`.
/// * `identifier` - The identifier of your application.
/// * `version` - A prediction to determine whether the client version is allowed.
///
/// # Example
/// ```rust,no_run
/// use anyhow::Result;
/// use tcp_handler::protocols::compress_encrypt::{server_init, server_start};
/// use tokio::net::TcpListener;
///
/// #[tokio::main]
/// async fn main() -> Result<()> {
/// let server = TcpListener::bind("localhost:25564").await?;
/// let (mut server, _) = server.accept().await?;
/// let s_init = server_init(&mut server, "test", |v| v == "0").await;
/// let (cipher, protocol_version, client_version) = server_start(&mut server, "test", "0", s_init).await?;
/// // Now the server is ready to use.
/// # let _ = cipher;
/// # let _ = protocol_version;
/// # let _ = client_version;
/// Ok(())
/// }
/// ```
pub async fn server_init<R: AsyncRead + Unpin, P: FnOnce(&str) -> bool>(stream: &mut R, identifier: &str, version: P) -> Result<((u16, String), rsa::RsaPublicKey), StarterError> {
let versions = read_head(stream, ProtocolVariant::CompressEncryption, identifier, version).await?;
let n = AsyncReaderHelper(stream).help_read_u8_vec().await?;
let e = AsyncReaderHelper(stream).help_read_u8_vec().await?;
let key = block_in_place(move || compose_rsa_public(n, e))?;
Ok((versions, key))
}
/// Make sure the client side is ready to use in tcp-handler compress_encrypt protocol.
///
/// Must be used in conjunction with [`client_init`].
///
/// # Runtime
/// Due to call [`block_in_place`] internally,
/// this function cannot be called in a `current_thread` runtime.
///
/// # Arguments
/// * `stream` - The tcp stream or `ReadHalf`.
/// * `last` - The return value of [`client_init`].
///
/// # Example
/// ```rust,no_run
/// use anyhow::Result;
/// use tcp_handler::protocols::compress_encrypt::{client_init, client_start};
/// use tokio::net::TcpStream;
///
/// #[tokio::main]
/// async fn main() -> Result<()> {
/// let mut client = TcpStream::connect("localhost:25564").await?;
/// let c_init = client_init(&mut client, "test", "0").await;
/// let cipher = client_start(&mut client, c_init).await?;
/// // Now the client is ready to use.
/// # let _ = cipher;
/// Ok(())
/// }
/// ```
pub async fn client_start<R: AsyncRead + Unpin>(stream: &mut R, last: Result<rsa::RsaPrivateKey, StarterError>) -> Result<Cipher, StarterError> {
let rsa = read_last(stream, last).await?;
let encrypted_aes = AsyncReaderHelper(stream).help_read_u8_vec().await?;
let mut nonce = [0; 12];
stream.read_more(&mut nonce).await?;
let cipher = block_in_place(move || {
use aes_gcm::aead::KeyInit;
let aes = rsa.decrypt(rsa::Oaep::new::<rsa::sha2::Sha512>(), &encrypted_aes)?;
let cipher = aes_gcm::Aes256Gcm::new_from_slice(&aes).unwrap();
Ok::<_, StarterError>((cipher, aes_gcm::Nonce::from(nonce)))
})?;
Ok(Cipher::new(cipher))
}
/// Make sure the server side is ready to use in tcp-handler compress_encrypt protocol.
///
/// Must be used in conjunction with [`server_init`].
///
/// # Runtime
/// Due to call [`block_in_place`] internally,
/// this function cannot be called in a `current_thread` runtime.
///
/// # Arguments
/// * `stream` - The tcp stream or `WriteHalf`.
/// * `identifier` - The returned application identifier.
/// (Should be same with the para in [`server_init`].)
/// * `version` - The returned recommended application version.
/// (Should be passed the prediction in [`server_init`].)
/// * `last` - The return value of [`server_init`].
///
/// # Example
/// ```rust,no_run
/// use anyhow::Result;
/// use tcp_handler::protocols::compress_encrypt::{server_init, server_start};
/// use tokio::net::TcpListener;
///
/// #[tokio::main]
/// async fn main() -> Result<()> {
/// let server = TcpListener::bind("localhost:25564").await?;
/// let (mut server, _) = server.accept().await?;
/// let s_init = server_init(&mut server, "test", |v| v == "0").await;
/// let (cipher, protocol_version, client_version) = server_start(&mut server, "test", "0", s_init).await?;
/// // Now the server is ready to use.
/// # let _ = cipher;
/// # let _ = protocol_version;
/// # let _ = client_version;
/// Ok(())
/// }
/// ```
pub async fn server_start<W: AsyncWrite + Unpin>(stream: &mut W, identifier: &str, version: &str, last: Result<((u16, String), rsa::RsaPublicKey), StarterError>) -> Result<(Cipher, u16, String), StarterError> {
let ((va, vb), rsa) = write_last(stream, ProtocolVariant::CompressEncryption, identifier, version, last).await?;
let (cipher, nonce, encrypted_aes) = block_in_place(move || {
use aes_gcm::aead::{KeyInit, AeadCore};
let aes = aes_gcm::Aes256Gcm::generate_key(&mut rand::thread_rng());
let nonce = aes_gcm::Aes256Gcm::generate_nonce(&mut rand::thread_rng());
debug_assert_eq!(12, nonce.len());
let encrypted_aes = rsa.encrypt(&mut rand::thread_rng(), rsa::oaep::Oaep::new::<rsa::sha2::Sha512>(), &aes)?;
let cipher = aes_gcm::Aes256Gcm::new(&aes);
Ok::<_, StarterError>((cipher, nonce, encrypted_aes))
})?;
AsyncWriterHelper(stream).help_write_u8_vec(&encrypted_aes).await?;
stream.write_more(&nonce).await?;
flush(stream).await?;
Ok((Cipher::new((cipher, nonce)), va, vb))
}
/// Send the message in tcp-handler compress_encrypt protocol.
///
/// # Runtime
/// Due to call [`block_in_place`] internally,
/// this function cannot be called in a `current_thread` runtime.
///
/// # Arguments
/// * `stream` - The tcp stream or `WriteHalf`.
/// * `message` - The message to send.
/// * `cipher` - The cipher returned from [`server_start`] or [`client_start`].
///
/// # Example
/// ```rust,no_run
/// # use anyhow::Result;
/// # use bytes::{BufMut, BytesMut};
/// # use tcp_handler::protocols::compress_encrypt::{client_init, client_start};
/// use tcp_handler::protocols::compress_encrypt::send;
/// # use tokio::net::TcpStream;
/// # use variable_len_reader::VariableWriter;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
/// # let mut client = TcpStream::connect("localhost:25564").await?;
/// # let c_init = client_init(&mut client, "test", "0").await;
/// # let cipher = client_start(&mut client, c_init).await?;
/// let mut writer = BytesMut::new().writer();
/// writer.write_string("hello server.")?;
/// send(&mut client, &mut writer.into_inner(), &cipher).await?;
/// # Ok(())
/// # }
/// ```
pub async fn send<W: AsyncWrite + Unpin, B: Buf>(stream: &mut W, message: &mut B, cipher: &Cipher) -> Result<(), PacketError> {
let level = get_compression();
let mut bytes = block_in_place(|| {
use aes_gcm::aead::{AeadCore, AeadMutInPlace};
use variable_len_reader::VariableWritable;
let new_nonce = aes_gcm::Aes256Gcm::generate_nonce(&mut rand::thread_rng());
debug_assert_eq!(12, new_nonce.len());
let mut encoder = DeflateEncoder::new(BytesMut::new().writer(), level);
encoder.write_more(&new_nonce)?;
encoder.write_more_buf(message)?;
let mut bytes = encoder.finish()?.into_inner();
let ((mut cipher, nonce), lock) = Cipher::get(cipher)?;
cipher.encrypt_in_place(&nonce, &[], &mut bytes)?;
Cipher::reset(lock, (cipher, new_nonce));
Ok::<_, PacketError>(bytes)
})?;
write_packet(stream, &mut bytes).await?;
flush(stream).await?;
Ok(())
}
/// Recv the message in tcp-handler compress_encrypt protocol.
///
/// # Runtime
/// Due to call [`block_in_place`] internally,
/// this function cannot be called in a `current_thread` runtime.
///
/// # Arguments
/// * `stream` - The tcp stream or `ReadHalf`.
/// * `cipher` - The cipher returned from [`server_start`] or [`client_start`].
///
/// # Example
/// ```rust,no_run
/// # use anyhow::Result;
/// # use bytes::Buf;
/// # use tcp_handler::protocols::compress_encrypt::{server_init, server_start};
/// use tcp_handler::protocols::compress_encrypt::recv;
/// # use tokio::net::TcpListener;
/// # use variable_len_reader::VariableReader;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
/// # let server = TcpListener::bind("localhost:25564").await?;
/// # let (mut server, _) = server.accept().await?;
/// # let s_init = server_init(&mut server, "test", |v| v == "0").await;
/// # let (cipher, _, _) = server_start(&mut server, "test", "0", s_init).await?;
/// let mut reader = recv(&mut server, &cipher).await?.reader();
/// let message = reader.read_string()?;
/// # let _ = message;
/// # Ok(())
/// # }
/// ```
pub async fn recv<R: AsyncRead + Unpin>(stream: &mut R, cipher: &Cipher) -> Result<BytesMut, PacketError> {
let mut buffer = read_packet(stream).await?;
let message = block_in_place(move || {
use aes_gcm::aead::AeadMutInPlace;
use variable_len_reader::{VariableReadable, VariableWritable};
let ((mut cipher, nonce), lock) = Cipher::get(cipher)?;
cipher.decrypt_in_place(&nonce, &[], &mut buffer)?;
let mut decoder = DeflateDecoder::new(BytesMut::new().writer());
decoder.write_more_buf(&mut buffer)?;
let mut reader = decoder.finish()?.into_inner().reader();
let mut new_nonce = [0; 12];
reader.read_more(&mut new_nonce)?;
let new_nonce = aes_gcm::Nonce::from(new_nonce);
Cipher::reset(lock, (cipher, new_nonce));
Ok::<_, PacketError>(reader.into_inner())
})?;
Ok(message)
}
#[cfg(test)]
mod tests {
use anyhow::Result;
use variable_len_reader::{VariableReader, VariableWriter};
use crate::protocols::common::tests::create;
use crate::protocols::compress_encrypt::*;
#[tokio::test(flavor = "multi_thread")]
async fn connect() -> Result<()> {
let (mut client, mut server) = create().await?;
let c = client_init(&mut client, "a", "1").await;
let s = server_init(&mut server, "a", |v| v == "1").await;
let (s_cipher, _, _) = server_start(&mut server, "a", "1", s).await?;
let c_cipher = client_start(&mut client, c).await?;
for _ in 0..10 {
let mut writer = BytesMut::new().writer();
writer.write_string("hello server in encrypt.")?;
send(&mut client, &mut writer.into_inner(), &c_cipher).await?;
let mut reader = recv(&mut server, &s_cipher).await?.reader();
let message = reader.read_string()?;
assert_eq!("hello server in encrypt.", message);
let mut writer = BytesMut::new().writer();
writer.write_string("hello client in encrypt.")?;
send(&mut server, &mut writer.into_inner(), &s_cipher).await?;
let mut reader = recv(&mut client, &c_cipher).await?.reader();
let message = reader.read_string()?;
assert_eq!("hello client in encrypt.", message);
}
Ok(())
}
}