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
use std::{
collections::HashMap,
pin::Pin,
sync::Arc,
task::{
Context,
Poll,
},
};
use async_trait::async_trait;
use futures::Stream;
#[cfg(feature = "hyper")]
use hyper::server::accept::Accept;
use muxado::Error as MuxadoError;
use thiserror::Error;
use tokio::sync::mpsc::Receiver;
use crate::{
config::{
HttpTunnelBuilder,
LabeledTunnelBuilder,
TcpTunnelBuilder,
TlsTunnelBuilder,
},
conn::{
ConnInner,
EdgeConn,
EndpointConn,
},
internals::raw_session::RpcError,
session::ConnectError,
Session,
};
/// Errors arising when accepting a [Conn] from an ngrok tunnel.
#[derive(Error, Debug, Clone)]
#[non_exhaustive]
pub enum AcceptError {
/// An error occurred in the underlying transport protocol.
#[error("transport error")]
Transport(#[from] MuxadoError),
/// An error arose during reconnect
#[error("reconnect error")]
Reconnect(#[from] Arc<ConnectError>),
/// The listener was closed.
#[error("listener closed: {message}{}", error_code.clone().map(|s| format!(", {s}")).unwrap_or_else(String::new))]
ListenerClosed {
/// The error message.
message: String,
/// The error code, if any.
error_code: Option<String>,
},
}
#[derive(Clone)]
pub(crate) struct TunnelInnerInfo {
pub(crate) id: String,
pub(crate) proto: String,
pub(crate) url: String,
pub(crate) labels: HashMap<String, String>,
pub(crate) forwards_to: String,
pub(crate) metadata: String,
}
pub(crate) struct TunnelInner {
pub(crate) info: TunnelInnerInfo,
pub(crate) incoming: Option<Receiver<Result<ConnInner, AcceptError>>>,
// Note: this session field is also used to detect tunnel liveness for the
// purposes of shutting down the accept loop. If it's ever removed, an
// awaitdrop::Ref field needs to be added that's derived from the one
// belonging to the session.
pub(crate) session: Session,
}
impl Drop for TunnelInner {
fn drop(&mut self) {
let id = self.id().to_string();
let sess = self.session.clone();
let rt = sess.runtime();
rt.spawn(async move { sess.close_tunnel(&id).await });
}
}
// This codgen indirect is required to make the hyper "Accept" trait bound
// dependent on the hyper feature. You can't put a #[cfg] on a single bound, so
// we're putting the whole trait def in a macro. Gross, but gets the job done.
macro_rules! tunnel_trait {
($($hyper_bound:tt)*) => {
/// An ngrok tunnel.
///
/// ngrok [Tunnel]s act like TCP listeners and can be used as a
/// [futures::stream::TryStream] of [Conn]ections from endpoints created on the ngrok
/// service.
pub trait Tunnel:
Stream<Item = Result<<Self as Tunnel>::Conn, AcceptError>>
+ TunnelInfo
+ TunnelCloser
$($hyper_bound)*
+ Unpin
+ Send
+ 'static
{
/// The type of connection associated with this tunnel type.
/// Agent-initiated http, tls, and tcp tunnels all produce
/// `EndpointConn`s, while labeled tunnels produce `EdgeConn`s.
type Conn: crate::Conn;
}
/// Information associated with an ngrok tunnel.
pub trait TunnelInfo {
/// Returns a tunnel's unique ID.
fn id(&self) -> &str;
/// Returns a human-readable string presented in the ngrok dashboard
/// and the Tunnels API. Use the [HttpTunnelBuilder::forwards_to],
/// [TcpTunnelBuilder::forwards_to], etc. to set this value
/// explicitly.
fn forwards_to(&self) -> &str;
/// Returns the arbitrary metadata string for this tunnel.
fn metadata(&self) -> &str;
}
/// An ngrok tunnel closer.
#[async_trait]
pub trait TunnelCloser {
/// Close the tunnel.
///
/// This is an RPC call that must be `.await`ed.
/// It is equivalent to calling `Session::close_tunnel` with this
/// tunnel's ID.
///
/// If the tunnel is dropped, a task will be spawned to close it
/// asynchronously.
async fn close(&mut self) -> Result<(), RpcError>;
}
}
}
#[cfg(not(feature = "hyper"))]
tunnel_trait!();
#[cfg(feature = "hyper")]
tunnel_trait!(+ Accept<Conn = <Self as Tunnel>::Conn, Error = AcceptError>);
/// An ngrok tunnel backing a simple endpoint.
/// Most agent-configured tunnels fall into this category, with the exception of
/// labeled tunnels.
pub trait EndpointInfo {
/// Returns the tunnel endpoint's URL.
fn url(&self) -> &str;
/// Returns the protocol of the tunnel's endpoint.
fn proto(&self) -> &str;
}
/// An ngrok tunnel backing an edge.
/// Since labels may be dynamically defined via the dashboard or API, the url
/// and protocol for the tunnel is not knowable ahead of time.
pub trait EdgeInfo {
/// Returns the labels that the tunnel was started with.
fn labels(&self) -> &HashMap<String, String>;
}
impl Stream for TunnelInner {
type Item = Result<ConnInner, AcceptError>;
fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
self.incoming
.as_mut()
.expect("tunnel inner lacks a receiver")
.poll_recv(cx)
}
}
#[cfg(feature = "hyper")]
impl Accept for TunnelInner {
type Conn = ConnInner;
type Error = AcceptError;
fn poll_accept(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<Option<Result<Self::Conn, Self::Error>>> {
self.poll_next(cx)
}
}
impl TunnelInner {
/// Get this tunnel's ID as returned by the ngrok server.
pub fn id(&self) -> &str {
&self.info.id
}
/// Get the URL for this tunnel.
/// Labeled tunnels will return an empty string.
pub fn url(&self) -> &str {
&self.info.url
}
/// Close the tunnel.
/// This is an RPC call and needs to be `.await`ed.
pub async fn close(&mut self) -> Result<(), RpcError> {
self.session.close_tunnel(self.id()).await?;
if let Some(r) = self.incoming.as_mut() {
r.close()
}
Ok(())
}
/// Get the protocol that this tunnel uses.
pub fn proto(&self) -> &str {
&self.info.proto
}
/// Get the labels this tunnel was started with.
/// The returned [`HashMap`] will be empty for non-labeled tunnels.
pub fn labels(&self) -> &HashMap<String, String> {
&self.info.labels
}
/// Get the address that this tunnel says it forwards to.
pub fn forwards_to(&self) -> &str {
&self.info.forwards_to
}
/// Get the user-supplied metadata for this tunnel.
pub fn metadata(&self) -> &str {
&self.info.metadata
}
/// Split the tunnel into two parts - the first contains the listener and
/// all tunnel information, and the second contains *only* the information.
pub(crate) fn make_info(&self) -> TunnelInner {
TunnelInner {
info: self.info.clone(),
incoming: None,
session: self.session.clone(),
}
}
}
macro_rules! make_tunnel_type {
($(#[$outer:meta])* $wrapper:ident, $builder:tt, $conn:tt, $($m:tt),*) => {
$(#[$outer])*
pub struct $wrapper {
pub(crate) inner: TunnelInner,
}
impl $wrapper {
/// Split this tunnel type into two parts - both of which have all
/// tunnel information, but only the former can be used as a
/// listener. Attempts to accept connections on the later will fail.
pub(crate) fn make_info(&self) -> $wrapper {
$wrapper {
inner: self.inner.make_info(),
}
}
}
impl Tunnel for $wrapper {
type Conn = $conn;
}
impl TunnelInfo for $wrapper {
fn id(&self) -> &str {
self.inner.id()
}
fn forwards_to(&self) -> &str {
self.inner.forwards_to()
}
fn metadata(&self) -> &str {
self.inner.metadata()
}
}
#[async_trait]
impl TunnelCloser for $wrapper {
async fn close(&mut self) -> Result<(), RpcError> {
self.inner.close().await
}
}
impl $wrapper {
/// Create a builder for this tunnel type.
pub fn builder(session: Session) -> $builder {
$builder::from(session)
}
}
$(
make_tunnel_type!($m; $wrapper);
)*
impl Stream for $wrapper {
type Item = Result<$conn, AcceptError>;
fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
Pin::new(&mut self.inner).poll_next(cx).map(|o| o.map(|r| r.map(|c| $conn { inner: c })))
}
}
#[cfg(feature = "hyper")]
#[cfg_attr(all(feature = "hyper", docsrs), doc(cfg(feature = "hyper")))]
impl Accept for $wrapper {
type Conn = $conn;
type Error = AcceptError;
fn poll_accept(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<Option<Result<Self::Conn, Self::Error>>> {
Pin::new(&mut self.inner).poll_accept(cx).map(|o| o.map(|r| r.map(|c| $conn { inner: c })))
}
}
};
(endpoint; $wrapper:ty) => {
impl EndpointInfo for $wrapper {
fn url(&self) -> &str {
self.inner.url()
}
fn proto(&self) -> &str {
self.inner.proto()
}
}
};
(edge; $wrapper:ty) => {
impl EdgeInfo for $wrapper {
fn labels(&self) -> &HashMap<String, String> {
self.inner.labels()
}
}
};
}
make_tunnel_type! {
/// An ngrok tunnel for an HTTP endpoint.
HttpTunnel, HttpTunnelBuilder, EndpointConn, endpoint
}
make_tunnel_type! {
/// An ngrok tunnel for a TCP endpoint.
TcpTunnel, TcpTunnelBuilder, EndpointConn, endpoint
}
make_tunnel_type! {
/// An ngrok tunnel for a TLS endpoint.
TlsTunnel, TlsTunnelBuilder, EndpointConn, endpoint
}
make_tunnel_type! {
/// A labeled ngrok tunnel.
LabeledTunnel, LabeledTunnelBuilder, EdgeConn, edge
}