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
//!
//! This crate allows you to run your [axum][1] http server as a tor hidden service using [arti][2].
//!
//! ## Example
//!
//! ```rust
//! # use arti_client::{TorClient, TorClientConfig};
//! # use axum::{routing, Router};
//! # use tor_hsservice::{config::OnionServiceConfigBuilder, handle_rend_requests};
//! # fn main() {
//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
//! let tor_client = TorClient::create_bootstrapped(TorClientConfig::default()).await?;
//!
//! let (onion_service, rend_requests) = tor_client.launch_onion_service(
//! OnionServiceConfigBuilder::default()
//! .nickname("hello-world".to_owned().try_into().unwrap())
//! .build()?,
//! )?;
//!
//! let stream_requests = handle_rend_requests(rend_requests);
//!
//! let app = Router::new().route("/", routing::get(|| async { "Hello, World!" }));
//!
//! println!("serving at: http://{}", onion_service.onion_name().unwrap());
//!
//! arti_axum::serve(stream_requests, app).await;
//! # Ok(())
//! # }
//! # example(); // we're intentionally not polling the future
//! # }
//! ```
//!
//! [1]: https://docs.rs/axum/latest/axum/index.html
//! [2]: https://gitlab.torproject.org/tpo/core/arti/
//!
use std::{
convert::Infallible,
future::{
poll_fn,
Future,
IntoFuture,
},
marker::PhantomData,
pin::Pin,
task::{
Context,
Poll,
},
};
use axum::{
body::Body,
extract::Request,
response::Response,
Router,
};
use futures_util::{
future::{
BoxFuture,
FutureExt,
},
stream::{
BoxStream,
Stream,
StreamExt,
},
};
use hyper::body::Incoming;
use hyper_util::{
rt::{
TokioExecutor,
TokioIo,
},
server::conn::auto::Builder,
};
use pin_project_lite::pin_project;
use tor_cell::relaycell::msg::Connected;
use tor_hsservice::StreamRequest;
use tor_proto::stream::{
DataStream,
IncomingStreamRequest,
};
use tower::util::{
Oneshot,
ServiceExt,
};
use tower_service::Service;
/// Serve the service with the supplied stream requests.
///
/// See the [crate documentation](`crate`) for an example.
pub fn serve<M, S>(
stream_requests: impl Stream<Item = StreamRequest> + Send + 'static,
make_service: M,
) -> Serve<M, S>
where
M: for<'a> Service<IncomingStream<'a>, Error = Infallible, Response = S>,
S: Service<Request, Error = Infallible, Response = Response>,
{
Serve {
stream_requests: stream_requests.boxed(),
make_service,
_marker: PhantomData,
}
}
/// Future returned by [`serve`].
pub struct Serve<M, S> {
stream_requests: BoxStream<'static, StreamRequest>,
make_service: M,
_marker: PhantomData<S>,
}
impl<M, S> IntoFuture for Serve<M, S>
where
M: for<'a> Service<IncomingStream<'a>, Error = Infallible, Response = S> + Send + 'static,
for<'a> <M as Service<IncomingStream<'a>>>::Future: Send,
S: Service<Request, Response = Response, Error = Infallible> + Clone + Send + 'static,
S::Future: Send,
{
type Output = ();
type IntoFuture = private::ServeFuture;
fn into_future(mut self) -> Self::IntoFuture {
private::ServeFuture {
inner: async move {
while let Some(stream_request) = self.stream_requests.next().await {
let data_stream = match stream_request.request() {
IncomingStreamRequest::Begin(_) => {
match stream_request.accept(Connected::new_empty()).await {
Ok(data_stream) => data_stream,
Err(error) => {
tracing::trace!("failed to accept incoming stream: {error}");
continue;
}
}
}
_ => {
// we only accept BEGIN streams
continue;
}
};
poll_fn(|cx| self.make_service.poll_ready(cx))
.await
.unwrap_or_else(|err| match err {});
let incoming_stream = IncomingStream {
data_stream: &data_stream,
};
let tower_service = self
.make_service
.call(incoming_stream)
.await
.unwrap_or_else(|err| match err {});
let hyper_service = TowerToHyperService {
service: tower_service,
};
tokio::spawn(async move {
match Builder::new(TokioExecutor::new())
// upgrades needed for websockets
.serve_connection_with_upgrades(
TokioIo::new(data_stream),
hyper_service,
)
.await
{
Ok(()) => {}
Err(_err) => {
// This error only appears when the client
// doesn't send a request and
// terminate the connection.
//
// If client sends one request then terminate
// connection whenever, it doesn't
// appear.
}
}
});
}
}
.boxed(),
}
}
}
mod private {
use super::*;
pub struct ServeFuture {
pub inner: BoxFuture<'static, ()>,
}
impl Future for ServeFuture {
type Output = ();
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
self.inner.poll_unpin(cx)
}
}
}
#[derive(Debug, Copy, Clone)]
struct TowerToHyperService<S> {
service: S,
}
impl<S> hyper::service::Service<Request<Incoming>> for TowerToHyperService<S>
where
S: tower_service::Service<Request> + Clone,
{
type Response = S::Response;
type Error = S::Error;
type Future = TowerToHyperServiceFuture<S, Request>;
fn call(&self, req: Request<Incoming>) -> Self::Future {
let req = req.map(Body::new);
TowerToHyperServiceFuture {
future: self.service.clone().oneshot(req),
}
}
}
pin_project! {
struct TowerToHyperServiceFuture<S, R>
where
S: tower_service::Service<R>,
{
#[pin]
future: Oneshot<S, R>,
}
}
impl<S, R> Future for TowerToHyperServiceFuture<S, R>
where
S: tower_service::Service<R>,
{
type Output = Result<S::Response, S::Error>;
#[inline]
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
self.project().future.poll(cx)
}
}
/// An incoming stream.
///
/// This is a single client connecting over the TOR network to your onion service.
///
pub struct IncomingStream<'a> {
// in the future we can use this to return information about the circuit used etc.
#[allow(dead_code)]
data_stream: &'a DataStream,
}
impl Service<IncomingStream<'_>> for Router<()> {
type Response = Router;
type Error = Infallible;
type Future = std::future::Ready<Result<Self::Response, Self::Error>>;
fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
Poll::Ready(Ok(()))
}
fn call(&mut self, _req: IncomingStream<'_>) -> Self::Future {
std::future::ready(Ok(self.clone()))
}
}