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 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
use std::{
collections::{
HashMap,
VecDeque,
},
env,
io,
sync::{
atomic::{
AtomicBool,
Ordering,
},
Arc,
},
time::Duration,
};
use arc_swap::ArcSwap;
use async_trait::async_trait;
use bytes::Bytes;
use futures::{
prelude::*,
FutureExt,
};
use futures_rustls::rustls::{
self,
pki_types,
RootCertStore,
};
use hyper::{
client::HttpConnector,
service::Service,
};
use hyper_proxy::{
Intercept,
Proxy,
ProxyConnector,
};
use muxado::heartbeat::HeartbeatConfig;
pub use muxado::heartbeat::HeartbeatHandler;
use once_cell::sync::{
Lazy,
OnceCell,
};
use regex::Regex;
use rustls_pemfile::Item;
use thiserror::Error;
use tokio::{
io::{
AsyncRead,
AsyncWrite,
},
runtime::Handle,
sync::{
mpsc::{
channel,
Sender,
},
Mutex,
RwLock,
},
};
use tokio_retry::{
strategy::ExponentialBackoff,
RetryIf,
};
use tokio_util::compat::{
FuturesAsyncReadCompatExt,
TokioAsyncReadCompatExt,
};
use tracing::{
debug,
warn,
};
use url::Url;
pub use crate::internals::{
proto::{
CommandResp,
Restart,
Stop,
StopTunnel,
Update,
},
raw_session::{
CommandHandler,
RpcError,
},
};
use crate::{
config::{
HttpTunnelBuilder,
LabeledTunnelBuilder,
ProxyProto,
TcpTunnelBuilder,
TlsTunnelBuilder,
TunnelConfig,
},
conn::ConnInner,
internals::{
proto::{
AuthExtra,
BindExtra,
BindOpts,
Error,
HttpEndpoint,
SecretString,
TcpEndpoint,
TlsEndpoint,
},
raw_session::{
AcceptError as RawAcceptError,
CommandHandlers,
IncomingStreams,
RawSession,
RpcClient,
StartSessionError,
NOT_IMPLEMENTED,
},
},
tunnel::{
AcceptError,
TunnelInner,
TunnelInnerInfo,
},
};
pub(crate) const CERT_BYTES: &[u8] = include_bytes!("../assets/ngrok.ca.crt");
const CLIENT_TYPE: &str = "ngrok-rust";
const VERSION: &str = env!("CARGO_PKG_VERSION");
#[derive(Clone)]
struct BoundTunnel {
proto: String,
opts: Option<BindOpts>,
extra: BindExtra,
labels: HashMap<String, String>,
forwards_to: String,
forwards_proto: String,
verify_upstream_tls: bool,
tx: Sender<Result<ConnInner, AcceptError>>,
}
type TunnelConns = HashMap<String, BoundTunnel>;
/// An ngrok session.
///
/// Encapsulates an established session with the ngrok service. Sessions recover
/// from network failures by automatically reconnecting.
#[derive(Clone)]
pub struct Session {
// Note: this is implicitly used to detect when the session (and its
// tunnels) have been dropped in order to shut down the accept loop.
_dropref: awaitdrop::Ref,
inner: Arc<ArcSwap<SessionInner>>,
}
struct SessionInner {
runtime: Handle,
client: Mutex<RpcClient>,
closed: AtomicBool,
tunnels: RwLock<TunnelConns>,
builder: SessionBuilder,
}
/// A trait alias for types that can provide the base ngrok transport, i.e.
/// bidirectional byte streams.
///
/// It is blanket-implemented for all types that satisfy its bounds. Most
/// commonly, it will be a tls-wrapped tcp stream.
pub trait IoStream: AsyncRead + AsyncWrite + Unpin + Send + 'static {}
impl<T> IoStream for T where T: AsyncRead + AsyncWrite + Unpin + Send + 'static {}
/// Trait for establishing the connection to the ngrok server.
#[async_trait]
pub trait Connector: Sync + Send + 'static {
/// The function used to establish the connection to the ngrok server.
///
/// This is effectively `async |addr, tls_config, err| -> Result<IoStream>`.
///
/// If it is being called due to a disconnect, the [AcceptError] argument will
/// be populated.
///
/// If it returns `Err(ConnectError::Canceled)`, reconnecting will be canceled
/// and the session will be terminated. Note that this error will never be
/// returned from the [default_connect] function.
async fn connect(
&self,
host: String,
port: u16,
tls_config: Arc<rustls::ClientConfig>,
err: Option<AcceptError>,
) -> Result<Box<dyn IoStream>, ConnectError>;
}
#[async_trait]
impl<F, U> Connector for F
where
F: Fn(String, u16, Arc<rustls::ClientConfig>, Option<AcceptError>) -> U + Send + Sync + 'static,
U: Future<Output = Result<Box<dyn IoStream>, ConnectError>> + Send,
{
async fn connect(
&self,
host: String,
port: u16,
tls_config: Arc<rustls::ClientConfig>,
err: Option<AcceptError>,
) -> Result<Box<dyn IoStream>, ConnectError> {
self(host, port, tls_config, err).await
}
}
/// The default ngrok connector.
///
/// Establishes a TCP connection to `addr`, and then performs a TLS handshake
/// using the `tls_config`.
///
/// Discards any errors during reconnect, allowing attempts to recur
/// indefinitely.
pub async fn default_connect(
host: String,
port: u16,
tls_config: Arc<rustls::ClientConfig>,
_: Option<AcceptError>,
) -> Result<Box<dyn IoStream>, ConnectError> {
let stream = tokio::net::TcpStream::connect(&(host.as_str(), port))
.await
.map_err(ConnectError::Tcp)?
.compat();
let domain = pki_types::ServerName::try_from(host)
.expect("host should have been validated by SessionBuilder::server_addr");
let tls_conn = futures_rustls::TlsConnector::from(tls_config)
.connect(domain, stream)
.await
.map_err(ConnectError::Tls)?;
Ok(Box::new(tls_conn.compat()) as Box<dyn IoStream>)
}
#[derive(Debug, Clone, Error)]
#[error("unsupported proxy address: {0}")]
/// An unsupported proxy address was provided.
pub struct ProxyUnsupportedError(Url);
fn connect_proxy(url: Url) -> Result<Arc<dyn Connector>, ProxyUnsupportedError> {
Ok(match url.scheme() {
"http" | "https" => Arc::new(connect_http_proxy(url)),
"socks5" => {
let host = url.host_str().unwrap_or_default();
let port = url.port().unwrap_or(1080);
Arc::new(connect_socks_proxy(format!("{host}:{port}")))
}
_ => return Err(ProxyUnsupportedError(url)),
})
}
fn connect_http_proxy(url: Url) -> impl Connector {
move |host: String, port, tls_config, _| {
let mut proxy = Proxy::new(
Intercept::All,
url.as_str().try_into().expect("urls should be valid uris"),
);
proxy.force_connect();
let connector = HttpConnector::new();
async move {
let mut connector = ProxyConnector::from_proxy(connector, proxy)
.map_err(|e| ConnectError::ProxyConnect(Box::new(e)))?;
let server_uri = format!("http://{host}:{port}")
.parse()
.expect("host should have been validated by SessionBuilder::server_addr");
let conn = connector
.call(server_uri)
.await
.map_err(|e| ConnectError::ProxyConnect(Box::new(e)))?
.compat();
let tls_conn = futures_rustls::TlsConnector::from(tls_config)
.connect(
pki_types::ServerName::try_from(host)
.expect("host should have been validated by SessionBuilder::server_addr"),
conn,
)
.await
.map_err(ConnectError::Tls)?;
Ok(Box::new(tls_conn.compat()) as Box<dyn IoStream>)
}
}
}
fn connect_socks_proxy(proxy_addr: String) -> impl Connector {
move |server_host: String, server_port, tls_config, _| {
let proxy_addr = proxy_addr.clone();
async move {
let conn = tokio_socks::tcp::Socks5Stream::connect(
proxy_addr.as_str(),
format!("{server_host}:{server_port}"),
)
.await
.map_err(|e| ConnectError::ProxyConnect(Box::new(e)))?
.compat();
let tls_conn = futures_rustls::TlsConnector::from(tls_config)
.connect(
pki_types::ServerName::try_from(server_host)
.expect("host should have been validated by SessionBuilder::server_addr"),
conn,
)
.await
.map_err(ConnectError::Tls)?;
Ok(Box::new(tls_conn.compat()) as Box<dyn IoStream>)
}
}
}
/// The builder for an ngrok [Session].
#[derive(Clone)]
pub struct SessionBuilder {
// Consuming libraries and applications can add a client type and version on
// top of the "base" type and version declared by this library.
versions: VecDeque<(String, String, Option<String>)>,
authtoken: Option<SecretString>,
metadata: Option<String>,
heartbeat_interval: Option<i64>,
heartbeat_tolerance: Option<i64>,
heartbeat_handler: Option<Arc<dyn HeartbeatHandler>>,
server_host: String,
server_port: u16,
ca_cert: Option<bytes::Bytes>,
tls_config: Option<rustls::ClientConfig>,
connector: Arc<dyn Connector>,
handlers: CommandHandlers,
cookie: Option<SecretString>,
id: Option<String>,
}
/// Errors arising at [SessionBuilder::connect] time.
#[derive(Error, Debug)]
#[non_exhaustive]
pub enum ConnectError {
/// An error occurred when establishing a TCP connection to the ngrok
/// server.
#[error("failed to establish tcp connection")]
Tcp(#[source] io::Error),
/// A TLS handshake error occurred.
///
/// This is usually a certificate validation issue, or an attempt to connect
/// to something that doesn't actually speak TLS.
#[error("tls handshake error")]
Tls(#[source] io::Error),
/// An error occurred when starting the ngrok session.
///
/// This might occur when there's a protocol mismatch interfering with the
/// heartbeat routine.
#[error("failed to start ngrok session")]
Start(#[source] StartSessionError),
/// An error occurred when attempting to authenticate.
#[error("authentication failure")]
Auth(#[source] RpcError),
/// An error occurred when rebinding tunnels during a reconnect
#[error("error rebinding tunnel after reconnect")]
Rebind(#[source] RpcError),
/// An error arising from a failure to connect through a proxy.
#[error("failed to connect through proxy")]
ProxyConnect(#[source] Box<dyn std::error::Error + Send + Sync + 'static>),
/// The (re)connect function gave up.
///
/// This will never be returned by the default connect function, and is
/// instead used to cancel the reconnect loop.
#[error("the connect function gave up")]
Canceled,
}
impl Error for ConnectError {
fn error_code(&self) -> Option<&str> {
match self {
ConnectError::Auth(resp) | ConnectError::Rebind(resp) => resp.error_code(),
_ => None,
}
}
fn msg(&self) -> String {
match self {
ConnectError::Auth(resp) | ConnectError::Rebind(resp) => resp.msg(),
_ => format!("{self}"),
}
}
}
/// The builder specified an invalid heartbeat interval.
///
/// This is most likely caused a [Duration] that's outside of the [i64::MAX]
/// nanosecond range.
#[derive(Copy, Clone, Debug, Error)]
#[error("invalid heartbeat interval: {0}")]
pub struct InvalidHeartbeatInterval(u128);
/// The builder specified an invalid heartbeat tolerance.
///
/// This is most likely caused a [Duration] that's outside of the [i64::MAX]
/// nanosecond range.
#[derive(Copy, Clone, Debug, Error)]
#[error("invalid heartbeat tolerance: {0}")]
pub struct InvalidHeartbeatTolerance(u128);
/// The builder provided an invalid server address
#[derive(Error, Debug, Clone)]
#[error("invalid server address: {0}")]
pub struct InvalidServerAddr(String);
impl Default for SessionBuilder {
fn default() -> Self {
SessionBuilder {
versions: [(CLIENT_TYPE.to_string(), VERSION.to_string(), None)]
.into_iter()
.collect(),
authtoken: None,
metadata: None,
heartbeat_interval: None,
heartbeat_tolerance: None,
heartbeat_handler: None,
server_host: "connect.ngrok-agent.com".into(),
server_port: 443,
ca_cert: None,
tls_config: None,
connector: Arc::new(default_connect),
handlers: Default::default(),
cookie: None,
id: None,
}
}
}
fn sanitize_ua_string(s: impl AsRef<str>) -> String {
static UA_BANNED: OnceCell<Regex> = OnceCell::new();
UA_BANNED
.get_or_init(|| Regex::new("[^/!#$%&'*+-.^_`|~0-9a-zA-Z]").unwrap())
.replace_all(s.as_ref(), "#")
.replace('/', "-")
}
impl SessionBuilder {
/// Configures the session to authenticate with the provided authtoken. You
/// can [find your existing authtoken] or [create a new one] in the ngrok
/// dashboard.
///
/// See the [authtoken parameter in the ngrok docs] for additional details.
///
/// [find your existing authtoken]: https://dashboard.ngrok.com/get-started/your-authtoken
/// [create a new one]: https://dashboard.ngrok.com/tunnels/authtokens
/// [authtoken parameter in the ngrok docs]: https://ngrok.com/docs/ngrok-agent/config#authtoken
pub fn authtoken(&mut self, authtoken: impl Into<String>) -> &mut Self {
self.authtoken = Some(authtoken.into().into());
self
}
/// Shortcut for calling [SessionBuilder::authtoken] with the value of the
/// NGROK_AUTHTOKEN environment variable.
pub fn authtoken_from_env(&mut self) -> &mut Self {
self.authtoken = env::var("NGROK_AUTHTOKEN").ok().map(From::from);
self
}
/// Configures how often the session will send heartbeat messages to the ngrok
/// service to check session liveness.
///
/// See the [heartbeat_interval parameter in the ngrok docs] for additional
/// details.
///
/// [heartbeat_interval parameter in the ngrok docs]: https://ngrok.com/docs/ngrok-agent/config#heartbeat_interval
pub fn heartbeat_interval(
&mut self,
heartbeat_interval: Duration,
) -> Result<&mut Self, InvalidHeartbeatInterval> {
let nanos = heartbeat_interval.as_nanos();
let nanos = i64::try_from(nanos).map_err(|_| InvalidHeartbeatInterval(nanos))?;
self.heartbeat_interval = Some(nanos);
Ok(self)
}
/// Configures the duration to wait for a response to a heartbeat before
/// assuming the session connection is dead and attempting to reconnect.
///
/// See the [heartbeat_tolerance parameter in the ngrok docs] for additional
/// details.
///
/// [heartbeat_tolerance parameter in the ngrok docs]: https://ngrok.com/docs/ngrok-agent/config#heartbeat_tolerance
pub fn heartbeat_tolerance(
&mut self,
heartbeat_tolerance: Duration,
) -> Result<&mut Self, InvalidHeartbeatTolerance> {
let nanos = heartbeat_tolerance.as_nanos();
let nanos = i64::try_from(nanos).map_err(|_| InvalidHeartbeatTolerance(nanos))?;
self.heartbeat_tolerance = Some(nanos);
Ok(self)
}
/// Configures the opaque, machine-readable metadata string for this session.
/// Metadata is made available to you in the ngrok dashboard and the Agents API
/// resource. It is a useful way to allow you to uniquely identify sessions. We
/// suggest encoding the value in a structured format like JSON.
///
/// See the [metdata parameter in the ngrok docs] for additional details.
///
/// [metdata parameter in the ngrok docs]: https://ngrok.com/docs/ngrok-agent/config#metadata
pub fn metadata(&mut self, metadata: impl Into<String>) -> &mut Self {
self.metadata = Some(metadata.into());
self
}
/// Configures the network address to dial to connect to the ngrok service.
/// Use this option only if you are connecting to a custom agent ingress.
///
/// See the [server_addr parameter in the ngrok docs] for additional details.
///
/// [server_addr parameter in the ngrok docs]: https://ngrok.com/docs/ngrok-agent/config#server_addr
pub fn server_addr(&mut self, addr: impl Into<String>) -> Result<&mut Self, InvalidServerAddr> {
let addr = addr.into();
let server_uri: Url = format!("http://{addr}")
.parse()
.map_err(|_| InvalidServerAddr(addr.clone()))?;
self.server_host = server_uri
.host_str()
.map(String::from)
.ok_or_else(|| InvalidServerAddr(addr.clone()))?;
pki_types::ServerName::try_from(self.server_host.as_str())
.map_err(|_| InvalidServerAddr(addr.clone()))?;
self.server_port = server_uri.port().unwrap_or(443);
Ok(self)
}
/// Sets the file path to a default certificate in PEM format to validate ngrok Session TLS connections.
/// Setting to "trusted" is the default, using the ngrok CA certificate.
/// Setting to "host" will verify using the certificates on the host operating system.
/// A client config set via tls_config after calling root_cas will override this value.
///
/// Corresponds to the [root_cas parameter in the ngrok docs]
///
/// [root_cas parameter in the ngrok docs]: https://ngrok.com/docs/ngrok-agent/config#root_cas
pub fn root_cas(&mut self, root_cas: impl Into<String>) -> Result<&mut Self, io::Error> {
match root_cas.into().clone().as_str() {
"trusted" => self.ca_cert = None,
"host" => self.tls_config = Some(host_certs_tls_config().map_err(|e| e.kind())?),
v => {
std::fs::read(v).map(|root_cas| self.ca_cert = Some(Bytes::from(root_cas)))?;
}
}
Ok(self)
}
/// Sets the default certificate in PEM format to validate ngrok Session TLS connections.
/// A client config set via tls_config will override this value.
///
/// Roughly corresponds to the "path to a certificate PEM file" option in the
/// [root_cas parameter in the ngrok docs]
///
/// [root_cas parameter in the ngrok docs]: https://ngrok.com/docs/ngrok-agent/config#root_cas
pub fn ca_cert(&mut self, ca_cert: Bytes) -> &mut Self {
self.ca_cert = Some(ca_cert);
self
}
/// Configures the TLS client used to connect to the ngrok service while
/// establishing the session. Use this option only if you are connecting through
/// a man-in-the-middle or deep packet inspection proxy. Passed to the
/// connect callback set with `SessionBuilder::connect`.
///
/// Roughly corresponds to the [root_cas parameter in the ngrok docs], but allows
/// for deeper TLS configuration.
///
/// [root_cas parameter in the ngrok docs]: https://ngrok.com/docs/ngrok-agent/config#root_cas
pub fn tls_config(&mut self, config: rustls::ClientConfig) -> &mut Self {
self.tls_config = Some(config);
self
}
/// Configures a function which is called to establish the connection to the
/// ngrok service. Use this option if you need to connect through an outbound
/// proxy. In the event of network disruptions, it will be called each time
/// the session reconnects.
pub fn connector(&mut self, connect: impl Connector) -> &mut Self {
self.connector = Arc::new(connect);
self
}
/// Configures the session to connect to ngrok through an outbound
/// HTTP or SOCKS5 proxy. This parameter is ignored if you override the connector
/// with [SessionBuilder::connector].
///
/// See the [proxy url parameter in the ngrok docs] for additional details.
///
/// [proxy url parameter in the ngrok docs]: https://ngrok.com/docs/ngrok-agent/config#proxy_url
pub fn proxy_url(&mut self, url: Url) -> Result<&mut Self, ProxyUnsupportedError> {
self.connector = connect_proxy(url)?;
Ok(self)
}
/// Configures a function which is called when the ngrok service requests that
/// this [Session] stops. Your application may choose to interpret this callback
/// as a request to terminate the [Session] or the entire process.
///
/// Errors returned by this function will be visible to the ngrok dashboard or
/// API as the response to the Stop operation.
///
/// Do not block inside this callback. It will cause the Dashboard or API
/// stop operation to time out. Do not call [std::process::exit] inside this
/// callback, it will also cause the operation to time out.
pub fn handle_stop_command(&mut self, handler: impl CommandHandler<Stop>) -> &mut Self {
self.handlers.on_stop = Some(Arc::new(handler));
self
}
/// Configures a function which is called when the ngrok service requests
/// that this [Session] updates. Your application may choose to interpret
/// this callback as a request to restart the [Session] or the entire
/// process.
///
/// Errors returned by this function will be visible to the ngrok dashboard or
/// API as the response to the Restart operation.
///
/// Do not block inside this callback. It will cause the Dashboard or API
/// stop operation to time out. Do not call [std::process::exit] inside this
/// callback, it will also cause the operation to time out.
pub fn handle_restart_command(&mut self, handler: impl CommandHandler<Restart>) -> &mut Self {
self.handlers.on_restart = Some(Arc::new(handler));
self
}
/// Configures a function which is called when the ngrok service requests
/// that this [Session] updates. Your application may choose to interpret
/// this callback as a request to update its configuration, itself, or to
/// invoke some other application-specific behavior.
///
/// Errors returned by this function will be visible to the ngrok dashboard or
/// API as the response to the Restart operation.
///
/// Do not block inside this callback. It will cause the Dashboard or API
/// stop operation to time out. Do not call [std::process::exit] inside this
/// callback, it will also cause the operation to time out.
pub fn handle_update_command(&mut self, handler: impl CommandHandler<Update>) -> &mut Self {
self.handlers.on_update = Some(Arc::new(handler));
self
}
/// Call the provided handler whenever a heartbeat response is received.
///
/// If the handler returns an error, the heartbeat task will exit, resulting
/// in the session eventually dying as well.
pub fn handle_heartbeat(&mut self, callback: impl HeartbeatHandler) -> &mut Self {
self.heartbeat_handler = Some(Arc::new(callback));
self
}
/// Add client type and version information for a client application.
///
/// This is a way for applications and library consumers of this crate
/// identify themselves.
///
/// This will add a new entry to the `User-Agent` field in the "most significant"
/// (first) position. Comments must follow [RFC 7230] or a connection error may occur.
///
/// [RFC 7230]: https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6
pub fn client_info(
&mut self,
client_type: impl Into<String>,
version: impl Into<String>,
comments: Option<impl Into<String>>,
) -> &mut Self {
self.versions.push_front((
client_type.into(),
version.into(),
comments.map(|c| c.into()),
));
self
}
/// Begins a new ngrok [Session] by connecting to the ngrok service.
/// `connect` blocks until the session is successfully established or fails with
/// an error.
pub async fn connect(&self) -> Result<Session, ConnectError> {
let (dropref, dropped) = awaitdrop::awaitdrop();
let (inner, mut incoming) = self.connect_inner(None).await?;
let rt = inner.runtime.clone();
let inner = Arc::new(ArcSwap::new(inner.into()));
let session = Session {
_dropref: dropref,
inner: inner.clone(),
};
// store the session for use with StopTunnel
incoming.session = Some(session.clone());
rt.spawn(future::select(
accept_incoming(incoming, inner).boxed(),
dropped.wait(),
));
Ok(session)
}
pub(crate) fn get_or_create_tls_config(&self) -> rustls::ClientConfig {
// if the user has provided a custom TLS config, use that
if let Some(tls_config) = &self.tls_config {
return tls_config.clone();
}
// generate a default TLS config
let mut root_store = rustls::RootCertStore::empty();
let cert_pem = self.ca_cert.as_ref().map_or(CERT_BYTES, |it| it.as_ref());
let certs = rustls_pemfile::read_all(&mut io::Cursor::new(cert_pem))
.filter_map(|it| match it {
Ok(Item::X509Certificate(bs)) => Some(bs),
Err(e) => {
warn!(error = ?e, "skipping certificate which failed to parse");
None
}
Ok(_) => {
warn!("skipping non-x509 certificate");
None
}
})
.collect::<Vec<_>>();
root_store.add_parsable_certificates(certs);
rustls::ClientConfig::builder()
.with_root_certificates(root_store)
.with_no_client_auth()
}
async fn connect_inner(
&self,
err: impl Into<Option<AcceptError>>,
) -> Result<(SessionInner, IncomingStreams), ConnectError> {
let conn = self
.connector
.connect(
self.server_host.clone(),
self.server_port,
Arc::new(self.get_or_create_tls_config()),
err.into(),
)
.await?;
let mut heartbeat_config = HeartbeatConfig::default();
if let Some(interval) = self.heartbeat_interval {
heartbeat_config.interval = Duration::from_nanos(interval as u64);
}
if let Some(tolerance) = self.heartbeat_tolerance {
heartbeat_config.tolerance = Duration::from_nanos(tolerance as u64);
}
heartbeat_config.handler = self.heartbeat_handler.clone();
// convert these while we have ownership
let heartbeat_interval = heartbeat_config.interval.as_nanos() as i64;
let heartbeat_tolerance = heartbeat_config.tolerance.as_nanos() as i64;
let mut raw = RawSession::start(conn, heartbeat_config, self.handlers.clone())
.await
.map_err(ConnectError::Start)?;
// list of possibilities: https://doc.rust-lang.org/std/env/consts/constant.OS.html
let os = match env::consts::OS {
"macos" => "darwin",
_ => env::consts::OS,
};
let user_agent = self
.versions
.iter()
.map(|(name, version, comments)| {
format!(
"{}/{}{}",
sanitize_ua_string(name),
sanitize_ua_string(version),
comments
.as_ref()
.map_or(String::new(), |f| format!(" ({f})"))
)
})
.collect::<Vec<_>>()
.join(" ");
let client_type = self.versions[0].0.clone();
let version = self.versions[0].1.clone();
let resp = raw
.auth(
self.id.as_deref().unwrap_or_default(),
AuthExtra {
version,
client_type,
user_agent,
auth_token: self.authtoken.clone().unwrap_or_default(),
metadata: self.metadata.clone().unwrap_or_default(),
os: os.into(),
arch: std::env::consts::ARCH.into(),
heartbeat_interval,
heartbeat_tolerance,
restart_unsupported_error: self
.handlers
.on_restart
.is_none()
.then_some(NOT_IMPLEMENTED.into())
.or(Some("".into())),
stop_unsupported_error: self
.handlers
.on_stop
.is_none()
.then_some(NOT_IMPLEMENTED.into())
.or(Some("".into())),
update_unsupported_error: self
.handlers
.on_update
.is_none()
.then_some(NOT_IMPLEMENTED.into())
.or(Some("".into())),
cookie: self.cookie.clone().unwrap_or_default(),
..Default::default()
},
)
.await
.map_err(ConnectError::Auth)?;
let (client, incoming) = raw.split();
let builder = SessionBuilder {
cookie: resp.extra.cookie,
id: resp.client_id.into(),
..self.clone()
};
Ok((
SessionInner {
runtime: Handle::current(),
client: client.into(),
tunnels: Default::default(),
closed: Default::default(),
builder,
},
incoming,
))
}
}
impl Session {
/// Create a new [SessionBuilder] to configure a new ngrok session.
pub fn builder() -> SessionBuilder {
SessionBuilder::default()
}
/// Start building a tunnel for an HTTP endpoint.
///
/// https://ngrok.com/docs/http/
pub fn http_endpoint(&self) -> HttpTunnelBuilder {
self.clone().into()
}
/// Start building a tunnel for a TCP endpoint.
///
/// https://ngrok.com/docs/tcp/
pub fn tcp_endpoint(&self) -> TcpTunnelBuilder {
self.clone().into()
}
/// Start building a tunnel for a TLS endpoint.
///
/// https://ngrok.com/docs/tls/
pub fn tls_endpoint(&self) -> TlsTunnelBuilder {
self.clone().into()
}
/// Start building a labeled tunnel.
///
/// https://ngrok.com/docs/network-edge/edges/#tunnel-group
pub fn labeled_tunnel(&self) -> LabeledTunnelBuilder {
self.clone().into()
}
/// Get the unique ID of this session.
pub fn id(&self) -> String {
self.inner
.load()
.builder
.id
.as_ref()
.expect("Session ID not set")
.clone()
}
/// Start a new tunnel in this session.
pub(crate) async fn start_tunnel<C>(&self, tunnel_cfg: C) -> Result<TunnelInner, RpcError>
where
C: TunnelConfig,
{
let inner = self.inner.load();
let mut client = inner.client.lock().await;
// let tunnelCfg: dyn TunnelConfig = TunnelConfig(opts);
let (tx, rx) = channel(64);
let proto = tunnel_cfg.proto();
let opts = tunnel_cfg.opts();
let mut extra = tunnel_cfg.extra();
let labels = tunnel_cfg.labels();
let forwards_to = tunnel_cfg.forwards_to();
let forwards_proto = tunnel_cfg.forwards_proto();
let verify_upstream_tls = tunnel_cfg.verify_upstream_tls();
// non-labeled tunnel
let (tunnel, bound) = if tunnel_cfg.proto() != "" {
let resp = client
.listen(
&proto,
opts.clone().unwrap(), // this is crate-defined, and must exist if proto is non-empty
extra.clone(),
"",
&forwards_to,
&forwards_proto,
)
.await?;
extra.token = resp.extra.token;
let info = TunnelInnerInfo {
id: resp.client_id,
proto: resp.proto.clone(),
url: resp.url,
labels: HashMap::new(),
forwards_to: tunnel_cfg.forwards_to(),
metadata: extra.metadata.clone(),
};
(
TunnelInner {
info,
session: self.clone(),
incoming: rx.into(),
},
BoundTunnel {
proto: resp.proto,
opts: resp.bind_opts.into(),
extra,
labels,
forwards_to,
forwards_proto,
verify_upstream_tls,
tx,
},
)
} else {
// labeled tunnel
let resp = client
.listen_label(
labels.clone(),
&extra.metadata,
&forwards_to,
&forwards_proto,
)
.await?;
let info = TunnelInnerInfo {
id: resp.id,
proto: Default::default(),
url: Default::default(),
labels: tunnel_cfg.labels(),
forwards_to: tunnel_cfg.forwards_to(),
metadata: extra.metadata.clone(),
};
(
TunnelInner {
info,
session: self.clone(),
incoming: rx.into(),
},
BoundTunnel {
extra,
proto: Default::default(),
opts: Default::default(),
forwards_to,
forwards_proto,
verify_upstream_tls,
labels,
tx,
},
)
};
let mut tunnels = inner.tunnels.write().await;
tunnels.insert(tunnel.info.id.clone(), bound);
Ok(tunnel)
}
/// Close a tunnel with an error from the remote.
/// Skips the call to unlisten, since the remote has already rejected it.
pub(crate) async fn close_tunnel_with_error(&self, id: impl AsRef<str>, err: AcceptError) {
let id = id.as_ref();
let inner = self.inner.load();
if let Some(tun) = inner.tunnels.write().await.remove(id) {
let _ = tun.tx.send(Err(err)).await;
};
}
/// Close a tunnel with the given ID.
pub async fn close_tunnel(&self, id: impl AsRef<str>) -> Result<(), RpcError> {
let id = id.as_ref();
let inner = self.inner.load();
inner.client.lock().await.unlisten(id).await?;
inner.tunnels.write().await.remove(id);
Ok(())
}
pub(crate) fn runtime(&self) -> Handle {
self.inner.load().runtime.clone()
}
/// Close the ngrok session.
pub async fn close(&mut self) -> Result<(), RpcError> {
let inner = self.inner.load();
let res = inner.client.lock().await.close().await;
inner.closed.store(true, Ordering::SeqCst);
res
}
}
pub(crate) fn host_certs_tls_config() -> Result<rustls::ClientConfig, &'static io::Error> {
// The root certificate store, lazily loaded once.
static ROOT_STORE: Lazy<Result<RootCertStore, io::Error>> = Lazy::new(|| {
let der_certs = rustls_native_certs::load_native_certs()?
.into_iter()
.collect::<Vec<_>>();
let mut root_store = RootCertStore::empty();
root_store.add_parsable_certificates(der_certs);
Ok(root_store)
});
let root_store = ROOT_STORE.as_ref()?;
Ok(rustls::ClientConfig::builder()
.with_root_certificates(root_store.clone())
.with_no_client_auth())
}
async fn accept_one(
incoming: &mut IncomingStreams,
inner: &ArcSwap<SessionInner>,
) -> Result<(), AcceptError> {
let conn = match incoming.accept().await {
Ok(conn) => conn,
// Assume if we got a muxado error, the session is borked. Break and
// propagate the error to all of the tunnels out in the wild.
Err(RawAcceptError::Transport(error)) => return Err(error.into()),
// The other errors are either a bad header or an unrecognized
// stream type. They're non-fatal, but could signal a protocol
// mismatch.
Err(error) => {
warn!(?error, "protocol error when accepting tunnel connection");
return Ok(());
}
};
let id = conn.header.id.clone();
let remote_addr = conn.header.client_addr.parse().unwrap_or_else(|error| {
warn!(
client_addr = conn.header.client_addr,
%error,
"invalid remote addr for tunnel connection",
);
"0.0.0.0:0".parse().unwrap()
});
let inner = inner.load();
let guard = inner.tunnels.read().await;
let res = if let Some(tun) = guard.get(&id) {
let mut header = conn.header;
let app_protocol = Some(tun.forwards_proto.to_string()).filter(|s| !s.is_empty());
let verify_upstream_tls = tun.verify_upstream_tls;
// Note: this is a bit of a hack. Normally, passthrough_tls is only
// a thing on edge connections, but we're making sure it's set for
// endpoint connections as well. In their case, we have to look at the
// options used to bind the endpoint.
if let Some(BindOpts::Tls(opts)) = &tun.opts {
header.passthrough_tls = opts.tls_termination.is_none();
}
let proxy_proto = if let Some(
BindOpts::Tls(TlsEndpoint { proxy_proto, .. })
| BindOpts::Http(HttpEndpoint { proxy_proto, .. })
| BindOpts::Tcp(TcpEndpoint { proxy_proto, .. }),
) = tun.opts
{
proxy_proto
} else {
ProxyProto::None
};
tun.tx
.send(Ok(ConnInner {
info: crate::conn::Info {
app_protocol,
verify_upstream_tls,
remote_addr,
header,
proxy_proto,
},
stream: conn.stream,
}))
.await
} else {
Ok(())
};
drop(guard);
if res.is_err() {
RwLock::write(&inner.tunnels).await.remove(&id);
}
Ok(())
}
async fn try_reconnect(
inner: Arc<ArcSwap<SessionInner>>,
err: impl Into<Option<AcceptError>>,
) -> Result<IncomingStreams, ConnectError> {
let old_inner = inner.load();
if old_inner.closed.load(Ordering::SeqCst) {
return Err(ConnectError::Canceled);
}
let (new_inner, new_incoming) = old_inner.builder.connect_inner(err).await?;
let mut client = new_inner.client.lock().await;
let mut new_tunnels = new_inner.tunnels.write().await;
let old_tunnels = old_inner.tunnels.read().await;
for (id, tun) in old_tunnels.iter() {
if !tun.proto.is_empty() {
let resp = client
.listen(
&tun.proto,
tun.opts.clone().unwrap(),
tun.extra.clone(),
id,
&tun.forwards_to,
&tun.forwards_proto,
)
.await
.map_err(ConnectError::Rebind)?;
debug!(?resp, %id, %tun.proto, ?tun.opts, ?tun.extra, %tun.forwards_to, "rebound tunnel");
new_tunnels.insert(id.clone(), tun.clone());
} else {
let resp = client
.listen_label(
tun.labels.clone(),
&tun.extra.metadata,
&tun.forwards_to,
&tun.forwards_proto,
)
.await
.map_err(ConnectError::Rebind)?;
if !resp.id.is_empty() {
new_tunnels.insert(resp.id, tun.clone());
} else {
new_tunnels.insert(id.clone(), tun.clone());
}
}
}
drop(old_tunnels);
drop(client);
drop(new_tunnels);
inner.store(new_inner.into());
Ok(new_incoming)
}
async fn accept_incoming(mut incoming: IncomingStreams, inner: Arc<ArcSwap<SessionInner>>) {
let error: AcceptError = loop {
if let Err(error) = accept_one(&mut incoming, &inner).await {
debug!(%error, "failed to accept stream, attempting reconnect");
// This is gross, but should perform fine. Couple of notes:
// * Mutex so that both the action and condition can share access to
// `error`. Realistically, the lock calls should be non-concurrent,
// but Rust can't prove that.
// * Not setting the error in the action because then a a reference
// to a FnMut closure would escape via the returned Future, which is
// a no-no.
let error = parking_lot::Mutex::new(Some(error));
let reconnect = RetryIf::spawn(
ExponentialBackoff::from_millis(50),
|| try_reconnect(inner.clone(), error.lock().clone()).map_err(Arc::new),
|err: &Arc<ConnectError>| {
if let ConnectError::Canceled = **err {
false
} else {
*error.lock() = Some(AcceptError::Reconnect(err.clone()));
true
}
},
);
incoming = match reconnect.await {
Ok(incoming) => incoming,
Err(error) => {
debug!(%error, "reconnect failed, giving up");
break AcceptError::Reconnect(error);
}
};
}
};
for (_id, tun) in inner.load().tunnels.write().await.drain() {
let _ = tun.tx.send(Err(error.clone())).await;
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_sanitize_ua() {
assert_eq!(
sanitize_ua_string("library/official/rust"),
"library-official-rust"
);
assert_eq!(
sanitize_ua_string("something@really☺weird"),
"something#really#weird"
);
}
}