Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(transport): Add option to disable SSL verification #508

Merged
merged 5 commits into from
Oct 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
**Features**:

- Add support for Profiling feature. ([#479](https://github.com/getsentry/sentry-rust/pull/479))
- Add `SSL_VERIFY` option to control certificate verification. ([#508](https://github.com/getsentry/sentry-rust/pull/508))

**Internal**:

Expand Down
8 changes: 8 additions & 0 deletions sentry-core/src/clientoptions.rs
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,12 @@ pub struct ClientOptions {
/// The timeout on client drop for draining events on shutdown.
pub shutdown_timeout: Duration,
// Other options not documented in Unified API
/// Disable SSL verification.
///
/// # Warning
///
/// This introduces significant vulnerabilities, and should only be used as a last resort.
pub accept_invalid_certs: bool,
/// Enable Release Health Session tracking.
///
/// When automatic session tracking is enabled, a new "user-mode" session
Expand Down Expand Up @@ -206,6 +212,7 @@ impl fmt::Debug for ClientOptions {
.field("http_proxy", &self.http_proxy)
.field("https_proxy", &self.https_proxy)
.field("shutdown_timeout", &self.shutdown_timeout)
.field("accept_invalid_certs", &self.accept_invalid_certs)
.field("auto_session_tracking", &self.auto_session_tracking)
.field("session_mode", &self.session_mode)
.field("extra_border_frames", &self.extra_border_frames)
Expand Down Expand Up @@ -240,6 +247,7 @@ impl Default for ClientOptions {
http_proxy: None,
https_proxy: None,
shutdown_timeout: Duration::from_secs(2),
accept_invalid_certs: false,
auto_session_tracking: false,
session_mode: SessionMode::Application,
extra_border_frames: vec![],
Expand Down
15 changes: 10 additions & 5 deletions sentry/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ transport = ["reqwest", "native-tls"]
reqwest = ["reqwest_", "httpdate", "tokio"]
curl = ["curl_", "httpdate"]
surf-h1 = ["surf_/h1-client", "httpdate"]
surf = ["surf_/curl-client", "httpdate", "tokio"]
native-tls = ["reqwest_/default-tls"]
rustls = ["reqwest_/rustls-tls"]
ureq = ["ureq_/tls", "httpdate"]
ureq-native-tls = ["ureq_/native-tls", "httpdate"]
surf = ["surf_/curl-client", "http-client", "httpdate", "isahc", "tokio"]
native-tls = ["reqwest_/default-tls", "native-tls_", "ureq-native-tls"]
rustls = ["reqwest_/rustls-tls", "rustls_", "webpki-roots"]
ureq = ["ureq_/tls", "httpdate", "rustls_", "webpki-roots"]
ureq-native-tls = ["ureq_/native-tls", "httpdate", "native-tls_"]

[dependencies]
sentry-core = { version = "0.27.0", path = "../sentry-core", features = ["client"] }
Expand All @@ -67,9 +67,14 @@ reqwest_ = { package = "reqwest", version = "0.11", optional = true, features =
curl_ = { package = "curl", version = "0.4.25", optional = true }
httpdate = { version = "1.0.0", optional = true }
surf_ = { package = "surf", version = "2.0.0", optional = true, default-features = false }
http-client = { version = "6.5.3", optional = true }
isahc = { version = "0.9.14", optional = true }
serde_json = { version = "1.0.48", optional = true }
tokio = { version = "1.0", features = ["rt"], optional = true }
ureq_ = { package = "ureq", version = "2.3.0", optional = true, default-features = false }
native-tls_ = { package = "native-tls", version = "0.2.8", optional = true }
rustls_ = { package = "rustls", version = "0.20.6", optional = true, features = ["dangerous_configuration"] }
webpki-roots = { version = "0.22.5", optional = true }

[dev-dependencies]
sentry-anyhow = { path = "../sentry-anyhow" }
Expand Down
3 changes: 3 additions & 0 deletions sentry/src/defaults.rs
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,9 @@ pub fn apply_defaults(mut opts: ClientOptions) -> ClientOptions {
.or_else(|| std::env::var("https_proxy").ok().map(Cow::Owned))
.or_else(|| opts.http_proxy.clone());
}
if let Ok(accept_invalid_certs) = std::env::var("SSL_VERIFY") {
opts.accept_invalid_certs = !accept_invalid_certs.parse().unwrap_or(true);
}
opts
}

Expand Down
6 changes: 6 additions & 0 deletions sentry/src/transports/curl.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,19 @@ impl CurlHttpTransport {
let auth = dsn.to_auth(Some(&user_agent)).to_string();
let url = dsn.envelope_api_url().to_string();
let scheme = dsn.scheme();
let accept_invalid_certs = options.accept_invalid_certs;

let mut handle = client;
let thread = TransportThread::new(move |envelope, rl| {
handle.reset();
handle.url(&url).unwrap();
handle.custom_request("POST").unwrap();

if accept_invalid_certs {
handle.ssl_verify_host(false).unwrap();
handle.ssl_verify_peer(false).unwrap();
}

match (scheme, &http_proxy, &https_proxy) {
(Scheme::Https, _, &Some(ref proxy)) => {
if let Err(err) = handle.proxy(proxy) {
Expand Down
3 changes: 3 additions & 0 deletions sentry/src/transports/reqwest.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ impl ReqwestHttpTransport {
fn new_internal(options: &ClientOptions, client: Option<ReqwestClient>) -> Self {
let client = client.unwrap_or_else(|| {
let mut builder = reqwest_::Client::builder();
if options.accept_invalid_certs {
builder = builder.danger_accept_invalid_certs(true);
}
if let Some(url) = options.http_proxy.as_ref() {
match Proxy::http(url.as_ref()) {
Ok(proxy) => {
Expand Down
15 changes: 14 additions & 1 deletion sentry/src/transports/surf.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
use std::time::Duration;

use isahc::{
config::{Configurable, SslOption},
HttpClient,
};
use surf_::{http::headers as SurfHeaders, Client as SurfClient, StatusCode};

use super::tokio_thread::TransportThread;
Expand Down Expand Up @@ -28,7 +32,16 @@ impl SurfHttpTransport {
}

fn new_internal(options: &ClientOptions, client: Option<SurfClient>) -> Self {
let client = client.unwrap_or_else(SurfClient::new);
let mut client = client.unwrap_or_else(SurfClient::new);
if options.accept_invalid_certs {
let hc = HttpClient::builder()
.ssl_options(SslOption::DANGER_ACCEPT_INVALID_CERTS)
.build()
.unwrap();
let http_client = http_client::isahc::IsahcClient::from_client(hc);
client = SurfClient::with_http_client(http_client)
}

let dsn = options.dsn.as_ref().unwrap();
let user_agent = options.user_agent.to_owned();
let auth = dsn.to_auth(Some(&user_agent)).to_string();
Expand Down
59 changes: 59 additions & 0 deletions sentry/src/transports/ureq.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
use std::sync::Arc;
use std::time::Duration;
#[cfg(feature = "rustls")]
use std::time::SystemTime;

#[cfg(feature = "native-tls")]
use native_tls_::TlsConnector;
#[cfg(feature = "rustls")]
use rustls_::{
client::{ServerCertVerified, ServerCertVerifier},
Certificate, ClientConfig, Error, OwnedTrustAnchor, RootCertStore, ServerName,
};
#[cfg(doc)]
use ureq_ as ureq;
use ureq_::{Agent, AgentBuilder, Proxy};
#[cfg(feature = "rustls")]
use webpki_roots::TLS_SERVER_ROOTS;

use super::thread::TransportThread;

Expand Down Expand Up @@ -33,6 +45,53 @@ impl UreqHttpTransport {
let agent = agent.unwrap_or_else(|| {
let mut builder = AgentBuilder::new();

if options.accept_invalid_certs {
#[cfg(feature = "native-tls")]
{
let tls_connector = TlsConnector::builder()
.danger_accept_invalid_certs(true)
.build()
.unwrap();
builder = builder.tls_connector(Arc::new(tls_connector));
}

#[cfg(feature = "rustls")]
{
struct NoVerifier;

impl ServerCertVerifier for NoVerifier {
fn verify_server_cert(
&self,
_end_entity: &Certificate,
_intermediates: &[Certificate],
_server_name: &ServerName,
_scts: &mut dyn Iterator<Item = &[u8]>,
_ocsp_response: &[u8],
_now: SystemTime,
) -> Result<ServerCertVerified, Error> {
Ok(ServerCertVerified::assertion())
}
}

let mut root_store = RootCertStore::empty();
root_store.add_server_trust_anchors(TLS_SERVER_ROOTS.0.iter().map(|ta| {
OwnedTrustAnchor::from_subject_spki_name_constraints(
ta.subject,
ta.spki,
ta.name_constraints,
)
}));
let mut config = ClientConfig::builder()
.with_safe_defaults()
.with_root_certificates(root_store)
.with_no_client_auth();
config
.dangerous()
.set_certificate_verifier(Arc::new(NoVerifier));
builder = builder.tls_config(Arc::new(config));
}
}

match (scheme, &options.http_proxy, &options.https_proxy) {
(Scheme::Https, _, &Some(ref proxy)) => match Proxy::new(proxy) {
Ok(proxy) => {
Expand Down