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
//! Compression and encryption protocol.
//!
//! Recommended to use this protocol.
//!
//! # Example
//! ```rust
//! use anyhow::Result;
//! use bytes::{Buf, BufMut, BytesMut};
//! use flate2::Compression;
//! use tcp_handler::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 level = Compression::default();
//!
//! let c_init = client_init(&mut client, &"test", &"0").await;
//! let s_init = server_init(&mut server, &"test", |v| v == "0").await;
//! let mut s_cipher = server_start(&mut server, s_init).await?;
//! let mut c_cipher = client_start(&mut client, c_init).await?;
//!
//! let mut writer = BytesMut::new().writer();
//! writer.write_string("hello server.")?;
//! let mut bytes = writer.into_inner();
//! c_cipher = send(&mut client, &mut bytes, c_cipher, level).await?;
//!
//! let (reader, s) = recv(&mut server, s_cipher).await?;
//! let mut reader = reader.reader(); s_cipher = s;
//! 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();
//! s_cipher = send(&mut server, &mut bytes, s_cipher, level).await?;
//!
//! let (reader, c) = recv(&mut client, c_cipher).await?;
//! let mut reader = reader.reader(); c_cipher = c;
//! let message = reader.read_string()?;
//! assert_eq!("hello client.", message);
//!
//! # let _ = s_cipher;
//! # let _ = c_cipher;
//! Ok(())
//! }
//! ```
//!
//! This protocol is like this:
//! ```text
//! ┌────┬────────┬────────────┐ (It may not be in contiguous memory.)
//! in --> │ ** │ ****** │ ********** │
//! └────┴────────┴────────────┘
//! Nonce │
//! | │
//! v │
//! ┌────┐ │
//! │ ** │ ─│
//! └────┘ │
//! │─ DeflateEncoder
//! v
//! ┌──────────────────────┐ (Compressed bytes. In contiguous memory.)
//! │ ******************** │
//! └──────────────────────┘
//! │
//! │─ Encrypt in-place
//! v
//! ┌──────────────────────┐ (Compressed and encrypted bytes.)
//! out <-- │ ******************** │
//! └──────────────────────┘
//! ```
use aead::{AeadCore, AeadInPlace};
use aes_gcm::aead::rand_core::OsRng as AesRng;
use aes_gcm::{Aes256Gcm, Nonce};
use bytes::{Buf, BufMut, BytesMut};
use flate2::Compression;
use flate2::write::{DeflateDecoder, DeflateEncoder};
use rsa::rand_core::OsRng as RsaRng;
use rsa::{RsaPrivateKey, RsaPublicKey};
use rsa::traits::PublicKeyParts;
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use variable_len_reader::{VariableReadable, VariableReader, VariableWritable, VariableWriter};
use crate::common::{AesCipher, PacketError, read_head, read_packet, StarterError, write_head, write_packet};
/// Init the client side in tcp-handler compress_encrypt protocol.
///
/// Must be used in conjunction with `tcp_handler::compress_encrypt::client_start`.
///
/// # 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::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: AsyncWriteExt + Unpin + Send>(stream: &mut W, identifier: &str, version: &str) -> Result<RsaPrivateKey, StarterError> {
let key = RsaPrivateKey::new(&mut RsaRng, 2048)?;
let mut writer = write_head(stream, identifier, version, true, true).await?;
writer.write_u8_vec(&key.n().to_bytes_le())?;
writer.write_u8_vec(&key.e().to_bytes_le())?;
write_packet(stream, &mut writer.into_inner()).await?;
Ok(key)
}
/// Init the server side in tcp-handler compress_encrypt protocol.
///
/// Must be used in conjunction with `tcp_handler::compress_encrypt::server_start`.
///
/// # 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::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 = server_start(&mut server, s_init).await?;
/// // Now the server is ready to use.
/// # let _ = cipher;
/// Ok(())
/// }
/// ```
///
/// You can get the client version from this function:
/// ```rust,no_run
/// use anyhow::Result;
/// use tcp_handler::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 mut version = None;
/// let s_init = server_init(&mut server, &"test", |v| {
/// version = Some(v.to_string());
/// v == "0"
/// }).await;
/// let cipher = server_start(&mut server, s_init).await?;
/// let version = version.unwrap();
/// // Now the version is got.
/// # let _ = cipher;
/// # let _ = version;
/// Ok(())
/// }
/// ```
pub async fn server_init<R: AsyncReadExt + Unpin + Send, P: FnOnce(&str) -> bool>(stream: &mut R, identifier: &str, version: P) -> Result<RsaPublicKey, StarterError> {
let mut reader = read_head(stream, identifier, version, true, true).await?;
let n = rsa::BigUint::from_bytes_le(&reader.read_u8_vec()?);
let e = rsa::BigUint::from_bytes_le(&reader.read_u8_vec()?);
let key = RsaPublicKey::new(n, e)?;
Ok(key)
}
/// Make sure the server side is ready to use in tcp-handler compress_encrypt protocol.
///
/// Must be used in conjunction with `tcp_handler::compress_encrypt::server_init`.
///
/// # Arguments
/// * `stream` - The tcp stream or `WriteHalf`.
/// * `last` - The return value of `tcp_handler::compress_encrypt::server_init`.
///
/// # Example
/// ```rust,no_run
/// use anyhow::Result;
/// use tcp_handler::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 = server_start(&mut server, s_init).await?;
/// // Now the server is ready to use.
/// # let _ = cipher;
/// Ok(())
/// }
/// ```
#[inline]
pub async fn server_start<W: AsyncWriteExt + Unpin + Send>(stream: &mut W, last: Result<RsaPublicKey, StarterError>) -> Result<AesCipher, StarterError> {
crate::encrypt::server_start(stream, last).await
}
/// Make sure the client side is ready to use in tcp-handler compress_encrypt protocol.
///
/// Must be used in conjunction with `tcp_handler::compress_encrypt::client_init`.
///
/// # Arguments
/// * `stream` - The tcp stream or `ReadHalf`.
/// * `last` - The return value of `tcp_handler::compress_encrypt::client_init`.
///
/// # Example
/// ```rust,no_run
/// use anyhow::Result;
/// use tcp_handler::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(())
/// }
/// ```
#[inline]
pub async fn client_start<R: AsyncReadExt + Unpin + Send>(stream: &mut R, last: Result<RsaPrivateKey, StarterError>) -> Result<AesCipher, StarterError> {
crate::encrypt::client_start(stream, last).await
}
/// Send message in compress_encrypt tcp-handler protocol.
///
/// You may use some crate to read and write data,
/// such as [`serde`](https://crates.io/crates/serde),
/// [`postcard`](https://crates.io/crates/postcard) and
/// [`variable-len-reader`](https://crates.io/crates/variable-len-reader).
///
/// # Arguments
/// * `stream` - The tcp stream or `WriteHalf`.
/// * `message` - The message to send.
/// * `level` - The level of compression.
///
/// # Example
/// ```rust,no_run
/// use anyhow::Result;
/// use bytes::{BufMut, BytesMut};
/// use flate2::Compression;
/// use tcp_handler::compress_encrypt::{client_init, client_start, 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 mut cipher = client_start(&mut client, c_init).await?;
///
/// let mut writer = BytesMut::new().writer();
/// writer.write_string("hello server.")?;
/// cipher = send(&mut client, &mut writer.into_inner(), cipher, Compression::default()).await?;
///
/// # let _ = cipher;
/// Ok(())
/// }
/// ```
pub async fn send<W: AsyncWriteExt + Unpin + Send, B: Buf>(stream: &mut W, message: &mut B, cipher: AesCipher, level: Compression) -> Result<AesCipher, PacketError> {
let (cipher, nonce) = cipher;
let new_nonce = Aes256Gcm::generate_nonce(&mut AesRng);
debug_assert_eq!(12, 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();
cipher.encrypt_in_place(&nonce, &[], &mut bytes)?;
write_packet(stream, &mut bytes).await?;
Ok((cipher, new_nonce))
}
/// Recv message in compress_encrypt tcp-handler protocol.
///
/// You may use some crate to read and write data,
/// such as [`serde`](https://crates.io/crates/serde),
/// [`postcard`](https://crates.io/crates/postcard) and
/// [`variable-len-reader`](https://crates.io/crates/variable-len-reader).
///
/// # Arguments
/// * `stream` - The tcp stream or `ReadHalf`.
///
/// # Example
/// ```rust,no_run
/// use anyhow::Result;
/// use bytes::Buf;
/// use tcp_handler::compress_encrypt::{recv, server_init, server_start};
/// 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 mut cipher = server_start(&mut server, s_init).await?;
///
/// let (reader, c) = recv(&mut server, cipher).await?;
/// let mut reader = reader.reader(); cipher = c;
/// let _message = reader.read_string()?;
/// Ok(())
/// }
/// ```
pub async fn recv<R: AsyncReadExt + Unpin + Send>(stream: &mut R, cipher: AesCipher) -> Result<(BytesMut, AesCipher), PacketError> {
let (cipher, nonce) = cipher;
let mut bytes = read_packet(stream).await?;
cipher.decrypt_in_place(&nonce, &[], &mut bytes)?;
let mut decoder = DeflateDecoder::new(BytesMut::new().writer());
decoder.write_more_buf(&mut bytes)?;
let mut reader = decoder.finish()?.into_inner().reader();
let mut new_nonce = [0; 12];
reader.read_more(&mut new_nonce)?;
Ok((reader.into_inner(), (cipher, Nonce::from(new_nonce))))
}
#[cfg(test)]
mod test {
use anyhow::Result;
use bytes::{Buf, BufMut, BytesMut};
use flate2::Compression;
use variable_len_reader::{VariableReader, VariableWriter};
use crate::compress_encrypt::{recv, send};
use crate::common::test::{create, test_incorrect};
#[tokio::test]
async fn connect() -> Result<()> {
let (mut client, mut server) = create().await?;
let c = crate::compress_encrypt::client_init(&mut client, &"a", &"1").await;
let s = crate::compress_encrypt::server_init(&mut server, &"a", |v| v == "1").await;
let mut s_cipher = crate::compress_encrypt::server_start(&mut server, s).await?;
let mut c_cipher = crate::compress_encrypt::client_start(&mut client, c).await?;
let mut writer = BytesMut::new().writer();
writer.write_string("hello server.")?;
let mut bytes = writer.into_inner();
c_cipher = send(&mut client, &mut bytes, c_cipher, Compression::default()).await?;
let (reader, s) = recv(&mut server, s_cipher).await?;
let mut reader = reader.reader(); s_cipher = s;
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();
s_cipher = send(&mut server, &mut bytes, s_cipher, Compression::fast()).await?;
let (reader, c) = recv(&mut client, c_cipher).await?;
let mut reader = reader.reader(); c_cipher = c;
let message = reader.read_string()?;
assert_eq!("hello client.", message);
let _ = s_cipher;
let _ = c_cipher;
Ok(())
}
test_incorrect!(compress_encrypt);
}