Split out connector trait and fns into own module

This commit is contained in:
Rudi Floren 2023-01-17 16:48:07 +01:00
parent 001d3d91ea
commit 0c28b1db62
No known key found for this signature in database
GPG Key ID: 3667D82FA1AA6CEB
5 changed files with 159 additions and 126 deletions

View File

@ -1,22 +1,10 @@
use std::io;
use std::sync::Arc;
use std::time::Duration;
use async_trait::async_trait;
#[cfg(feature = "tokio-rustls")]
use tokio::net::lookup_host;
use tokio::net::TcpStream;
#[cfg(feature = "tokio-rustls")]
use tokio_rustls::client::TlsStream;
#[cfg(feature = "tokio-rustls")]
use tokio_rustls::rustls::{ClientConfig, OwnedTrustAnchor, RootCertStore, ServerName};
#[cfg(feature = "tokio-rustls")]
use tokio_rustls::TlsConnector;
use tracing::{debug, error, info};
use tracing::{debug, error};
use crate::common::{Certificate, NoExtension, PrivateKey};
pub use crate::connection::Connector;
use crate::connection::{self, EppConnection};
use crate::common::NoExtension;
pub use crate::connect::Connector;
use crate::connection::EppConnection;
use crate::error::Error;
use crate::hello::{Greeting, GreetingDocument, HelloDocument};
use crate::request::{Command, CommandDocument, Extension, Transaction};
@ -71,28 +59,6 @@ pub struct EppClient<C: Connector> {
connection: EppConnection<C>,
}
#[cfg(feature = "tokio-rustls")]
impl EppClient<RustlsConnector> {
/// Connect to the specified `addr` and `hostname` over TLS
///
/// The `registry` is used as a name in internal logging; `host` provides the host name
/// and port to connect to), `hostname` is sent as the TLS server name indication and
/// `identity` provides optional TLS client authentication (using) rustls as the TLS
/// implementation. The `timeout` limits the time spent on any underlying network operations.
///
/// Alternatively, use `EppClient::new()` with any established `AsyncRead + AsyncWrite + Unpin`
/// implementation.
pub async fn connect(
registry: String,
server: (String, u16),
identity: Option<(Vec<Certificate>, PrivateKey)>,
timeout: Duration,
) -> Result<Self, Error> {
let connector = RustlsConnector::new(server, identity).await?;
Self::new(connector, registry, timeout).await
}
}
impl<C: Connector> EppClient<C> {
/// Create an `EppClient` from an already established connection
pub async fn new(connector: C, registry: String, timeout: Duration) -> Result<Self, Error> {
@ -204,79 +170,3 @@ impl<'c, 'e, C, E> Clone for RequestData<'c, 'e, C, E> {
// Manual impl because this does not depend on whether `C` and `E` are `Copy`
impl<'c, 'e, C, E> Copy for RequestData<'c, 'e, C, E> {}
#[cfg(feature = "tokio-rustls")]
pub struct RustlsConnector {
inner: TlsConnector,
domain: ServerName,
server: (String, u16),
}
impl RustlsConnector {
pub async fn new(
server: (String, u16),
identity: Option<(Vec<Certificate>, PrivateKey)>,
) -> Result<Self, Error> {
let mut roots = RootCertStore::empty();
roots.add_server_trust_anchors(webpki_roots::TLS_SERVER_ROOTS.0.iter().map(|ta| {
OwnedTrustAnchor::from_subject_spki_name_constraints(
ta.subject,
ta.spki,
ta.name_constraints,
)
}));
let builder = ClientConfig::builder()
.with_safe_defaults()
.with_root_certificates(roots);
let config = match identity {
Some((certs, key)) => {
let certs = certs
.into_iter()
.map(|cert| tokio_rustls::rustls::Certificate(cert.0))
.collect();
builder
.with_single_cert(certs, tokio_rustls::rustls::PrivateKey(key.0))
.map_err(|e| Error::Other(e.into()))?
}
None => builder.with_no_client_auth(),
};
let domain = server.0.as_str().try_into().map_err(|_| {
io::Error::new(
io::ErrorKind::InvalidInput,
format!("Invalid domain: {}", server.0),
)
})?;
Ok(Self {
inner: TlsConnector::from(Arc::new(config)),
domain,
server,
})
}
}
#[cfg(feature = "tokio-rustls")]
#[async_trait]
impl Connector for RustlsConnector {
type Connection = TlsStream<TcpStream>;
async fn connect(&self, timeout: Duration) -> Result<Self::Connection, Error> {
info!("Connecting to server: {}:{}", self.server.0, self.server.1);
let addr = match lookup_host(&self.server).await?.next() {
Some(addr) => addr,
None => {
return Err(Error::Io(io::Error::new(
io::ErrorKind::InvalidInput,
format!("Invalid host: {}", &self.server.0),
)))
}
};
let stream = TcpStream::connect(addr).await?;
let future = self.inner.connect(self.domain.clone(), stream);
connection::timeout(timeout, future).await
}
}

149
src/connect.rs Normal file
View File

@ -0,0 +1,149 @@
use std::sync::Arc;
use std::time::Duration;
use async_trait::async_trait;
use tokio::io;
use tokio::io::AsyncRead;
use tokio::io::AsyncWrite;
#[cfg(feature = "tokio-rustls")]
use tokio::net::lookup_host;
use tokio::net::TcpStream;
#[cfg(feature = "tokio-rustls")]
use tokio_rustls::client::TlsStream;
#[cfg(feature = "tokio-rustls")]
use tokio_rustls::rustls::{ClientConfig, OwnedTrustAnchor, RootCertStore, ServerName};
#[cfg(feature = "tokio-rustls")]
use tokio_rustls::TlsConnector;
use tracing::info;
use crate::client::EppClient;
use crate::common::{Certificate, PrivateKey};
use crate::connection;
use crate::error::Error;
/// Connect to the specified `server` and `hostname` over TLS
///
/// The `registry` is used as a name in internal logging; `addr` provides the address to
/// connect to, `hostname` is sent as the TLS server name indication and `identity` provides
/// optional TLS client authentication (using) rustls as the TLS implementation.
/// The `timeout` limits the time spent on any underlying network operations.
///
/// This returns two halves, a cloneable client and the underlying connection.
///
/// Use connect_with_connector for passing a specific connector.
#[cfg(feature = "tokio-rustls")]
pub async fn connect(
registry: String,
server: (String, u16),
identity: Option<(Vec<Certificate>, PrivateKey)>,
timeout: Duration,
) -> Result<EppClient<RustlsConnector>, Error> {
info!("Connecting to server: {:?}", server);
let connector = RustlsConnector::new(server, identity).await?;
EppClient::new(connector, registry, timeout).await
}
/// Connect to the specified `server` and `hostname` via the passed connector.
///
/// The `registry` is used as a name in internal logging; `addr` provides the address to
/// connect to, `hostname` is sent as the TLS server name indication and `identity` provides
/// optional TLS client authentication (using) rustls as the TLS implementation.
/// The `timeout` limits the time spent on any underlying network operations.
///
/// This returns two halves, a cloneable client and the underlying connection.
///
/// Use connect_with_connector for passing a specific connector.
pub async fn connect_with_connector<C>(
connector: C,
registry: String,
timeout: Duration,
) -> Result<EppClient<C>, Error>
where
C: Connector,
{
EppClient::new(connector, registry, timeout).await
}
#[cfg(feature = "tokio-rustls")]
pub struct RustlsConnector {
inner: TlsConnector,
domain: ServerName,
server: (String, u16),
}
impl RustlsConnector {
pub async fn new(
server: (String, u16),
identity: Option<(Vec<Certificate>, PrivateKey)>,
) -> Result<Self, Error> {
let mut roots = RootCertStore::empty();
roots.add_server_trust_anchors(webpki_roots::TLS_SERVER_ROOTS.0.iter().map(|ta| {
OwnedTrustAnchor::from_subject_spki_name_constraints(
ta.subject,
ta.spki,
ta.name_constraints,
)
}));
let builder = ClientConfig::builder()
.with_safe_defaults()
.with_root_certificates(roots);
let config = match identity {
Some((certs, key)) => {
let certs = certs
.into_iter()
.map(|cert| tokio_rustls::rustls::Certificate(cert.0))
.collect();
builder
.with_single_cert(certs, tokio_rustls::rustls::PrivateKey(key.0))
.map_err(|e| Error::Other(e.into()))?
}
None => builder.with_no_client_auth(),
};
let domain = server.0.as_str().try_into().map_err(|_| {
io::Error::new(
io::ErrorKind::InvalidInput,
format!("Invalid domain: {}", server.0),
)
})?;
Ok(Self {
inner: TlsConnector::from(Arc::new(config)),
domain,
server,
})
}
}
#[cfg(feature = "tokio-rustls")]
#[async_trait]
impl Connector for RustlsConnector {
type Connection = TlsStream<TcpStream>;
async fn connect(&self, timeout: Duration) -> Result<Self::Connection, Error> {
info!("Connecting to server: {}:{}", self.server.0, self.server.1);
let addr = match lookup_host(&self.server).await?.next() {
Some(addr) => addr,
None => {
return Err(Error::Io(io::Error::new(
io::ErrorKind::InvalidInput,
format!("Invalid host: {}", &self.server.0),
)))
}
};
let stream = TcpStream::connect(addr).await?;
let future = self.inner.connect(self.domain.clone(), stream);
connection::timeout(timeout, future).await
}
}
#[async_trait]
pub trait Connector {
type Connection: AsyncRead + AsyncWrite + Unpin;
async fn connect(&self, timeout: Duration) -> Result<Self::Connection, Error>;
}

View File

@ -4,10 +4,10 @@ use std::future::Future;
use std::time::Duration;
use std::{io, str, u32};
use async_trait::async_trait;
use tokio::io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt};
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tracing::{debug, info};
use crate::connect::Connector;
use crate::error::Error;
/// EPP Connection struct with some metadata for the connection
@ -139,10 +139,3 @@ pub(crate) async fn timeout<T, E: Into<Error>>(
Err(_) => Err(Error::Timeout),
}
}
#[async_trait]
pub trait Connector {
type Connection: AsyncRead + AsyncWrite + Unpin;
async fn connect(&self, timeout: Duration) -> Result<Self::Connection, Error>;
}

View File

@ -94,6 +94,7 @@
pub mod client;
pub mod common;
pub mod connect;
pub mod connection;
pub mod contact;
pub mod domain;

View File

@ -4,6 +4,7 @@ use std::str;
use std::time::Duration;
use async_trait::async_trait;
use epp_client::connect::connect_with_connector;
use regex::Regex;
use tokio::time::timeout;
use tokio_test::io::Builder;
@ -11,7 +12,6 @@ use tokio_test::io::Builder;
use epp_client::domain::{DomainCheck, DomainContact, DomainCreate, Period};
use epp_client::login::Login;
use epp_client::response::ResultCode;
use epp_client::EppClient;
const CLTRID: &str = "cltrid:1626454866";
@ -99,7 +99,7 @@ async fn client() {
}
}
let mut client = EppClient::new(FakeConnector, "test".into(), Duration::from_secs(5))
let mut client = connect_with_connector(FakeConnector, "test".into(), Duration::from_secs(5))
.await
.unwrap();
@ -173,7 +173,7 @@ async fn dropped() {
}
}
let mut client = EppClient::new(FakeConnector, "test".into(), Duration::from_secs(5))
let mut client = connect_with_connector(FakeConnector, "test".into(), Duration::from_secs(5))
.await
.unwrap();