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
mod ado_net;
mod jdbc;
use std::collections::HashMap;
use std::path::PathBuf;
use super::AuthMethod;
use crate::EncryptionLevel;
use ado_net::*;
use jdbc::*;
#[derive(Clone, Debug)]
/// The `Config` struct contains all configuration information
/// required for connecting to the database with a [`Client`]. It also provides
/// the server address when connecting to a `TcpStream` via the
/// [`get_addr`] method.
///
/// When using an [ADO.NET connection string], it can be
/// constructed using the [`from_ado_string`] function.
///
/// [`Client`]: struct.Client.html
/// [ADO.NET connection string]: https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-strings
/// [`from_ado_string`]: struct.Config.html#method.from_ado_string
/// [`get_addr`]: struct.Config.html#method.get_addr
pub struct Config {
pub(crate) host: Option<String>,
pub(crate) port: Option<u16>,
pub(crate) database: Option<String>,
pub(crate) instance_name: Option<String>,
pub(crate) application_name: Option<String>,
pub(crate) encryption: EncryptionLevel,
pub(crate) trust: TrustConfig,
pub(crate) auth: AuthMethod,
}
#[derive(Clone, Debug)]
pub(crate) enum TrustConfig {
CaCertificateLocation(PathBuf),
TrustAll,
Default,
}
impl Default for Config {
fn default() -> Self {
Self {
host: None,
port: None,
database: None,
instance_name: None,
application_name: None,
#[cfg(any(
feature = "rustls",
feature = "native-tls",
feature = "vendored-openssl"
))]
encryption: EncryptionLevel::Required,
#[cfg(not(any(
feature = "rustls",
feature = "native-tls",
feature = "vendored-openssl"
)))]
encryption: EncryptionLevel::NotSupported,
trust: TrustConfig::Default,
auth: AuthMethod::None,
}
}
}
impl Config {
/// Create a new `Config` with the default settings.
pub fn new() -> Self {
Self::default()
}
/// A host or ip address to connect to.
///
/// - Defaults to `localhost`.
pub fn host(&mut self, host: impl ToString) {
self.host = Some(host.to_string());
}
/// The server port.
///
/// - Defaults to `1433`.
pub fn port(&mut self, port: u16) {
self.port = Some(port);
}
/// The database to connect to.
///
/// - Defaults to `master`.
pub fn database(&mut self, database: impl ToString) {
self.database = Some(database.to_string())
}
/// The instance name as defined in the SQL Browser. Only available on
/// Windows platforms.
///
/// If specified, the port is replaced with the value returned from the
/// browser.
///
/// - Defaults to no name specified.
pub fn instance_name(&mut self, name: impl ToString) {
self.instance_name = Some(name.to_string());
}
/// Sets the application name to the connection, queryable with the
/// `APP_NAME()` command.
///
/// - Defaults to no name specified.
pub fn application_name(&mut self, name: impl ToString) {
self.application_name = Some(name.to_string());
}
/// Set the preferred encryption level.
///
/// - With `tls` feature, defaults to `Required`.
/// - Without `tls` feature, defaults to `NotSupported`.
pub fn encryption(&mut self, encryption: EncryptionLevel) {
self.encryption = encryption;
}
/// If set, the server certificate will not be validated and it is accepted
/// as-is.
///
/// On production setting, the certificate should be added to the local key
/// storage (or use `trust_cert_ca` instead), using this setting is potentially dangerous.
///
/// # Panics
/// Will panic in case `trust_cert_ca` was called before.
///
/// - Defaults to `default`, meaning server certificate is validated against system-truststore.
pub fn trust_cert(&mut self) {
if let TrustConfig::CaCertificateLocation(_) = &self.trust {
panic!("'trust_cert' and 'trust_cert_ca' are mutual exclusive! Only use one.")
}
self.trust = TrustConfig::TrustAll;
}
/// If set, the server certificate will be validated against the given CA certificate in
/// in addition to the system-truststore.
/// Useful when using self-signed certificates on the server without having to disable the
/// trust-chain.
///
/// # Panics
/// Will panic in case `trust_cert` was called before.
///
/// - Defaults to validating the server certificate is validated against system's certificate storage.
pub fn trust_cert_ca(&mut self, path: impl ToString) {
if let TrustConfig::TrustAll = &self.trust {
panic!("'trust_cert' and 'trust_cert_ca' are mutual exclusive! Only use one.")
} else {
self.trust = TrustConfig::CaCertificateLocation(PathBuf::from(path.to_string()))
}
}
/// Sets the authentication method.
///
/// - Defaults to `None`.
pub fn authentication(&mut self, auth: AuthMethod) {
self.auth = auth;
}
pub(crate) fn get_host(&self) -> &str {
self.host
.as_deref()
.filter(|v| v != &".")
.unwrap_or("localhost")
}
pub(crate) fn get_port(&self) -> u16 {
match (self.port, self.instance_name.as_ref()) {
// A user-defined port, we must use that.
(Some(port), _) => port,
// If using a named instance, we'll give the default port of SQL
// Browser.
(None, Some(_)) => 1434,
// Otherwise the defaulting to the default SQL Server port.
(None, None) => 1433,
}
}
/// Get the host address including port
pub fn get_addr(&self) -> String {
format!("{}:{}", self.get_host(), self.get_port())
}
/// Creates a new `Config` from an [ADO.NET connection string].
///
/// # Supported parameters
///
/// All parameter keys are handled case-insensitive.
///
/// |Parameter|Allowed values|Description|
/// |--------|--------|--------|
/// |`server`|`<string>`|The name or network address of the instance of SQL Server to which to connect. The port number can be specified after the server name. The correct form of this parameter is either `tcp:host,port` or `tcp:host\\instance`|
/// |`IntegratedSecurity`|`true`,`false`,`yes`,`no`|Toggle between Windows/Kerberos authentication and SQL authentication.|
/// |`uid`,`username`,`user`,`user id`|`<string>`|The SQL Server login account.|
/// |`password`,`pwd`|`<string>`|The password for the SQL Server account logging on.|
/// |`database`|`<string>`|The name of the database.|
/// |`TrustServerCertificate`|`true`,`false`,`yes`,`no`|Specifies whether the driver trusts the server certificate when connecting using TLS. Cannot be used toghether with `TrustServerCertificateCA`|
/// |`TrustServerCertificateCA`|`<path>`|Path to a `pem`, `crt` or `der` certificate file. Cannot be used together with `TrustServerCertificate`|
/// |`encrypt`|`true`,`false`,`yes`,`no`,`DANGER_PLAINTEXT`|Specifies whether the driver uses TLS to encrypt communication.|
/// |`Application Name`, `ApplicationName`|`<string>`|Sets the application name for the connection.|
///
/// [ADO.NET connection string]: https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/connection-strings
pub fn from_ado_string(s: &str) -> crate::Result<Self> {
let ado: AdoNetConfig = s.parse()?;
Self::from_config_string(ado)
}
/// Creates a new `Config` from a [JDBC connection string].
///
/// See [`from_ado_string`] method for supported parameters.
///
/// [JDBC connection string]: https://docs.microsoft.com/en-us/sql/connect/jdbc/building-the-connection-url?view=sql-server-ver15
/// [`from_ado_string`]: #method.from_ado_string
pub fn from_jdbc_string(s: &str) -> crate::Result<Self> {
let jdbc: JdbcConfig = s.parse()?;
Self::from_config_string(jdbc)
}
fn from_config_string(s: impl ConfigString) -> crate::Result<Self> {
let mut builder = Self::new();
let server = s.server()?;
if let Some(host) = server.host {
builder.host(host);
}
if let Some(port) = server.port {
builder.port(port);
}
if let Some(instance) = server.instance {
builder.instance_name(instance);
}
builder.authentication(s.authentication()?);
if let Some(database) = s.database() {
builder.database(database);
}
if let Some(name) = s.application_name() {
builder.application_name(name);
}
if s.trust_cert()? {
builder.trust_cert();
}
if let Some(ca) = s.trust_cert_ca() {
builder.trust_cert_ca(ca);
}
builder.encryption(s.encrypt()?);
Ok(builder)
}
}
pub(crate) struct ServerDefinition {
host: Option<String>,
port: Option<u16>,
instance: Option<String>,
}
pub(crate) trait ConfigString {
fn dict(&self) -> &HashMap<String, String>;
fn server(&self) -> crate::Result<ServerDefinition>;
fn authentication(&self) -> crate::Result<AuthMethod> {
let user = self
.dict()
.get("uid")
.or_else(|| self.dict().get("username"))
.or_else(|| self.dict().get("user"))
.or_else(|| self.dict().get("user id"))
.map(|s| s.as_str());
let pw = self
.dict()
.get("password")
.or_else(|| self.dict().get("pwd"))
.map(|s| s.as_str());
match self
.dict()
.get("integratedsecurity")
.or_else(|| self.dict().get("integrated security"))
{
#[cfg(all(windows, feature = "winauth"))]
Some(val) if val.to_lowercase() == "sspi" || Self::parse_bool(val)? => match (user, pw)
{
(None, None) => Ok(AuthMethod::Integrated),
_ => Ok(AuthMethod::windows(user.unwrap_or(""), pw.unwrap_or(""))),
},
#[cfg(feature = "integrated-auth-gssapi")]
Some(val) if val.to_lowercase() == "sspi" || Self::parse_bool(val)? => {
Ok(AuthMethod::Integrated)
}
_ => Ok(AuthMethod::sql_server(user.unwrap_or(""), pw.unwrap_or(""))),
}
}
fn database(&self) -> Option<String> {
self.dict()
.get("database")
.or_else(|| self.dict().get("initial catalog"))
.or_else(|| self.dict().get("databasename"))
.map(|db| db.to_string())
}
fn application_name(&self) -> Option<String> {
self.dict()
.get("application name")
.or_else(|| self.dict().get("applicationname"))
.map(|name| name.to_string())
}
fn trust_cert(&self) -> crate::Result<bool> {
self.dict()
.get("trustservercertificate")
.map(Self::parse_bool)
.unwrap_or(Ok(false))
}
fn trust_cert_ca(&self) -> Option<String> {
self.dict()
.get("trustservercertificateca")
.map(|ca| ca.to_string())
}
#[cfg(any(
feature = "rustls",
feature = "native-tls",
feature = "vendored-openssl"
))]
fn encrypt(&self) -> crate::Result<EncryptionLevel> {
self.dict()
.get("encrypt")
.map(|val| match Self::parse_bool(val) {
Ok(true) => Ok(EncryptionLevel::Required),
Ok(false) => Ok(EncryptionLevel::Off),
Err(_) if val == "DANGER_PLAINTEXT" => Ok(EncryptionLevel::NotSupported),
Err(e) => Err(e),
})
.unwrap_or(Ok(EncryptionLevel::Off))
}
#[cfg(not(any(
feature = "rustls",
feature = "native-tls",
feature = "vendored-openssl"
)))]
fn encrypt(&self) -> crate::Result<EncryptionLevel> {
Ok(EncryptionLevel::NotSupported)
}
fn parse_bool<T: AsRef<str>>(v: T) -> crate::Result<bool> {
match v.as_ref().trim().to_lowercase().as_str() {
"true" | "yes" => Ok(true),
"false" | "no" => Ok(false),
_ => Err(crate::Error::Conversion(
"Connection string: Not a valid boolean".into(),
)),
}
}
}