use libc::{c_int, c_void, c_long}; use std::io::{IoResult, IoError, EndOfFile, Stream, Reader, Writer}; use std::mem; use std::ptr; use std::sync::{Once, ONCE_INIT, Arc}; use bio::{MemBio}; use ffi; use ssl::error::{SslError, SslSessionClosed, StreamError}; use x509::{X509StoreContext, X509FileType, X509}; pub mod error; #[cfg(test)] mod tests; static mut VERIFY_IDX: c_int = -1; fn init() { static mut INIT: Once = ONCE_INIT; unsafe { INIT.doit(|| { ffi::init(); let verify_idx = ffi::SSL_CTX_get_ex_new_index(0, ptr::null(), None, None, None); assert!(verify_idx >= 0); VERIFY_IDX = verify_idx; }); } } /// Determines the SSL method supported #[deriving(Show, Hash, PartialEq, Eq)] #[allow(non_camel_case_types)] #[deriving(Copy)] pub enum SslMethod { #[cfg(feature = "sslv2")] /// Only support the SSLv2 protocol, requires `feature="sslv2"` Sslv2, /// Support the SSLv2, SSLv3 and TLSv1 protocols Sslv23, /// Only support the SSLv3 protocol Sslv3, /// Only support the TLSv1 protocol Tlsv1, #[cfg(feature = "tlsv1_1")] /// Support TLSv1.1 protocol, requires `feature="tlsv1_1"` Tlsv1_1, #[cfg(feature = "tlsv1_2")] /// Support TLSv1.2 protocol, requires `feature="tlsv1_2"` Tlsv1_2, } impl SslMethod { unsafe fn to_raw(&self) -> *const ffi::SSL_METHOD { match *self { #[cfg(feature = "sslv2")] SslMethod::Sslv2 => ffi::SSLv2_method(), SslMethod::Sslv3 => ffi::SSLv3_method(), SslMethod::Tlsv1 => ffi::TLSv1_method(), SslMethod::Sslv23 => ffi::SSLv23_method(), #[cfg(feature = "tlsv1_1")] SslMethod::Tlsv1_1 => ffi::TLSv1_1_method(), #[cfg(feature = "tlsv1_2")] SslMethod::Tlsv1_2 => ffi::TLSv1_2_method() } } } /// Determines the type of certificate verification used #[deriving(Copy)] #[repr(i32)] pub enum SslVerifyMode { /// Verify that the server's certificate is trusted SslVerifyPeer = ffi::SSL_VERIFY_PEER, /// Do not verify the server's certificate SslVerifyNone = ffi::SSL_VERIFY_NONE } // Creates a static index for user data of type T // Registers a destructor for the data which will be called // when context is freed fn get_verify_data_idx() -> c_int { static mut VERIFY_DATA_IDX: c_int = -1; static mut INIT: Once = ONCE_INIT; extern fn free_data_box(_parent: *mut c_void, ptr: *mut c_void, _ad: *mut ffi::CRYPTO_EX_DATA, _idx: c_int, _argl: c_long, _argp: *mut c_void) { let _: Box = unsafe { mem::transmute(ptr) }; } unsafe { INIT.doit(|| { let idx = ffi::SSL_CTX_get_ex_new_index(0, ptr::null(), None, None, Some(free_data_box::)); assert!(idx >= 0); VERIFY_DATA_IDX = idx; }); VERIFY_DATA_IDX } } extern fn raw_verify(preverify_ok: c_int, x509_ctx: *mut ffi::X509_STORE_CTX) -> c_int { unsafe { let idx = ffi::SSL_get_ex_data_X509_STORE_CTX_idx(); let ssl = ffi::X509_STORE_CTX_get_ex_data(x509_ctx, idx); let ssl_ctx = ffi::SSL_get_SSL_CTX(ssl); let verify = ffi::SSL_CTX_get_ex_data(ssl_ctx, VERIFY_IDX); let verify: Option = mem::transmute(verify); let ctx = X509StoreContext::new(x509_ctx); match verify { None => preverify_ok, Some(verify) => verify(preverify_ok != 0, &ctx) as c_int } } } extern fn raw_verify_with_data(preverify_ok: c_int, x509_ctx: *mut ffi::X509_STORE_CTX) -> c_int { unsafe { let idx = ffi::SSL_get_ex_data_X509_STORE_CTX_idx(); let ssl = ffi::X509_STORE_CTX_get_ex_data(x509_ctx, idx); let ssl_ctx = ffi::SSL_get_SSL_CTX(ssl); let verify = ffi::SSL_CTX_get_ex_data(ssl_ctx, VERIFY_IDX); let verify: Option> = mem::transmute(verify); let data = ffi::SSL_CTX_get_ex_data(ssl_ctx, get_verify_data_idx::()); let data: Box = mem::transmute(data); let ctx = X509StoreContext::new(x509_ctx); let res = match verify { None => preverify_ok, Some(verify) => verify(preverify_ok != 0, &ctx, &*data) as c_int }; // Since data might be required on the next verification // it is time to forget about it and avoid dropping // data will be freed once OpenSSL considers it is time // to free all context data mem::forget(data); res } } /// The signature of functions that can be used to manually verify certificates pub type VerifyCallback = fn(preverify_ok: bool, x509_ctx: &X509StoreContext) -> bool; /// The signature of functions that can be used to manually verify certificates /// when user-data should be carried for all verification process pub type VerifyCallbackData = fn(preverify_ok: bool, x509_ctx: &X509StoreContext, data: &T) -> bool; // FIXME: macro may be instead of inlining? #[inline] fn wrap_ssl_result(res: c_int) -> Option { if res == 0 { Some(SslError::get()) } else { None } } /// An SSL context object pub struct SslContext { ctx: *mut ffi::SSL_CTX } impl Drop for SslContext { fn drop(&mut self) { unsafe { ffi::SSL_CTX_free(self.ctx) } } } impl SslContext { /// Creates a new SSL context. pub fn new(method: SslMethod) -> Result { init(); let ctx = unsafe { ffi::SSL_CTX_new(method.to_raw()) }; if ctx == ptr::null_mut() { return Err(SslError::get()); } Ok(SslContext { ctx: ctx }) } /// Configures the certificate verification method for new connections. pub fn set_verify(&mut self, mode: SslVerifyMode, verify: Option) { unsafe { ffi::SSL_CTX_set_ex_data(self.ctx, VERIFY_IDX, mem::transmute(verify)); ffi::SSL_CTX_set_verify(self.ctx, mode as c_int, Some(raw_verify)); } } /// Configures the certificate verification method for new connections also /// carrying supplied data. // Note: no option because there is no point to set data without providing // a function handling it pub fn set_verify_with_data(&mut self, mode: SslVerifyMode, verify: VerifyCallbackData, data: T) { let data = box data; unsafe { ffi::SSL_CTX_set_ex_data(self.ctx, VERIFY_IDX, mem::transmute(Some(verify))); ffi::SSL_CTX_set_ex_data(self.ctx, get_verify_data_idx::(), mem::transmute(data)); ffi::SSL_CTX_set_verify(self.ctx, mode as c_int, Some(raw_verify_with_data::)); } } /// Sets verification depth pub fn set_verify_depth(&mut self, depth: uint) { unsafe { ffi::SSL_CTX_set_verify_depth(self.ctx, depth as c_int); } } #[allow(non_snake_case)] /// Specifies the file that contains trusted CA certificates. pub fn set_CA_file(&mut self, file: &Path) -> Option { wrap_ssl_result(file.with_c_str(|file| { unsafe { ffi::SSL_CTX_load_verify_locations(self.ctx, file, ptr::null()) } })) } /// Specifies the file that contains certificate pub fn set_certificate_file(&mut self, file: &Path, file_type: X509FileType) -> Option { wrap_ssl_result(file.with_c_str(|file| { unsafe { ffi::SSL_CTX_use_certificate_file(self.ctx, file, file_type as c_int) } })) } /// Specifies the file that contains private key pub fn set_private_key_file(&mut self, file: &Path, file_type: X509FileType) -> Option { wrap_ssl_result(file.with_c_str(|file| { unsafe { ffi::SSL_CTX_use_PrivateKey_file(self.ctx, file, file_type as c_int) } })) } pub fn set_cipher_list(&mut self, cipher_list: &str) -> Option { wrap_ssl_result(cipher_list.with_c_str(|cipher_list| { unsafe { ffi::SSL_CTX_set_cipher_list(self.ctx, cipher_list) } })) } } #[allow(dead_code)] struct MemBioRef<'ssl> { ssl: &'ssl Ssl, bio: MemBio, } impl<'ssl> MemBioRef<'ssl> { fn read(&mut self, buf: &mut [u8]) -> Option { (&mut self.bio as &mut Reader).read(buf).ok() } fn write(&mut self, buf: &[u8]) { let _ = (&mut self.bio as &mut Writer).write(buf); } } pub struct Ssl { ssl: *mut ffi::SSL } impl Drop for Ssl { fn drop(&mut self) { unsafe { ffi::SSL_free(self.ssl) } } } impl Ssl { pub fn new(ctx: &SslContext) -> Result { let ssl = unsafe { ffi::SSL_new(ctx.ctx) }; if ssl == ptr::null_mut() { return Err(SslError::get()); } let ssl = Ssl { ssl: ssl }; let rbio = try!(MemBio::new()); let wbio = try!(MemBio::new()); unsafe { ffi::SSL_set_bio(ssl.ssl, rbio.unwrap(), wbio.unwrap()) } Ok(ssl) } fn get_rbio<'a>(&'a self) -> MemBioRef<'a> { unsafe { self.wrap_bio(ffi::SSL_get_rbio(self.ssl)) } } fn get_wbio<'a>(&'a self) -> MemBioRef<'a> { unsafe { self.wrap_bio(ffi::SSL_get_wbio(self.ssl)) } } fn wrap_bio<'a>(&'a self, bio: *mut ffi::BIO) -> MemBioRef<'a> { assert!(bio != ptr::null_mut()); MemBioRef { ssl: self, bio: MemBio::borrowed(bio) } } fn connect(&self) -> c_int { unsafe { ffi::SSL_connect(self.ssl) } } fn accept(&self) -> c_int { unsafe { ffi::SSL_accept(self.ssl) } } fn read(&self, buf: &mut [u8]) -> c_int { unsafe { ffi::SSL_read(self.ssl, buf.as_ptr() as *mut c_void, buf.len() as c_int) } } fn write(&self, buf: &[u8]) -> c_int { unsafe { ffi::SSL_write(self.ssl, buf.as_ptr() as *const c_void, buf.len() as c_int) } } fn get_error(&self, ret: c_int) -> LibSslError { let err = unsafe { ffi::SSL_get_error(self.ssl, ret) }; match FromPrimitive::from_int(err as int) { Some(err) => err, None => unreachable!() } } /// Set the host name to be used with SNI (Server Name Indication). pub fn set_hostname(&self, hostname: &str) -> Result<(), SslError> { let ret = hostname.with_c_str(|hostname| { unsafe { // This is defined as a macro: // #define SSL_set_tlsext_host_name(s,name) \ // SSL_ctrl(s,SSL_CTRL_SET_TLSEXT_HOSTNAME,TLSEXT_NAMETYPE_host_name,(char *)name) ffi::SSL_ctrl(self.ssl, ffi::SSL_CTRL_SET_TLSEXT_HOSTNAME, ffi::TLSEXT_NAMETYPE_host_name, hostname as *const c_void as *mut c_void) } }); // For this case, 0 indicates failure. if ret == 0 { Err(SslError::get()) } else { Ok(()) } } pub fn get_peer_certificate(&self) -> Option { unsafe { let ptr = ffi::SSL_get_peer_certificate(self.ssl); if ptr.is_null() { None } else { Some(X509::new(ptr, true)) } } } } #[deriving(FromPrimitive, Show)] #[repr(i32)] enum LibSslError { ErrorNone = ffi::SSL_ERROR_NONE, ErrorSsl = ffi::SSL_ERROR_SSL, ErrorWantRead = ffi::SSL_ERROR_WANT_READ, ErrorWantWrite = ffi::SSL_ERROR_WANT_WRITE, ErrorWantX509Lookup = ffi::SSL_ERROR_WANT_X509_LOOKUP, ErrorSyscall = ffi::SSL_ERROR_SYSCALL, ErrorZeroReturn = ffi::SSL_ERROR_ZERO_RETURN, ErrorWantConnect = ffi::SSL_ERROR_WANT_CONNECT, ErrorWantAccept = ffi::SSL_ERROR_WANT_ACCEPT, } /// A stream wrapper which handles SSL encryption for an underlying stream. #[deriving(Clone)] pub struct SslStream { stream: S, ssl: Arc, buf: Vec } impl SslStream { fn new_base(ssl:Ssl, stream: S) -> SslStream { SslStream { stream: stream, ssl: Arc::new(ssl), // Maximum TLS record size is 16k // We're just using this as a buffer, so there's no reason to pay // to memset it buf: { const CAP: uint = 16 * 1024; let mut v = Vec::with_capacity(CAP); unsafe { v.set_len(CAP); } v } } } pub fn new_server_from(ssl: Ssl, stream: S) -> Result, SslError> { let mut ssl = SslStream::new_base(ssl, stream); ssl.in_retry_wrapper(|ssl| { ssl.accept() }).and(Ok(ssl)) } /// Attempts to create a new SSL stream from a given `Ssl` instance. pub fn new_from(ssl: Ssl, stream: S) -> Result, SslError> { let mut ssl = SslStream::new_base(ssl, stream); ssl.in_retry_wrapper(|ssl| { ssl.connect() }).and(Ok(ssl)) } /// Creates a new SSL stream pub fn new(ctx: &SslContext, stream: S) -> Result, SslError> { let ssl = try!(Ssl::new(ctx)); SslStream::new_from(ssl, stream) } /// Creates a new SSL server stream pub fn new_server(ctx: &SslContext, stream: S) -> Result, SslError> { let ssl = try!(Ssl::new(ctx)); SslStream::new_server_from(ssl, stream) } /// Returns a mutable reference to the underlying stream. /// /// ## Warning /// /// `read`ing or `write`ing directly to the underlying stream will most /// likely desynchronize the SSL session. #[deprecated="use get_mut instead"] pub fn get_inner(&mut self) -> &mut S { self.get_mut() } /// Returns a reference to the underlying stream. pub fn get_ref(&self) -> &S { &self.stream } /// Returns a mutable reference to the underlying stream. /// /// ## Warning /// /// It is inadvisable to read from or write to the underlying stream as it /// will most likely desynchronize the SSL session. pub fn get_mut(&mut self) -> &mut S { &mut self.stream } fn in_retry_wrapper(&mut self, blk: |&Ssl| -> c_int) -> Result { loop { let ret = blk(&*self.ssl); if ret > 0 { return Ok(ret); } match self.ssl.get_error(ret) { LibSslError::ErrorWantRead => { try_ssl_stream!(self.flush()); let len = try_ssl_stream!(self.stream.read(self.buf.as_mut_slice())); self.ssl.get_rbio().write(self.buf.slice_to(len)); } LibSslError::ErrorWantWrite => { try_ssl_stream!(self.flush()) } LibSslError::ErrorZeroReturn => return Err(SslSessionClosed), LibSslError::ErrorSsl => return Err(SslError::get()), err => panic!("unexpected error {}", err), } } } fn write_through(&mut self) -> IoResult<()> { loop { match self.ssl.get_wbio().read(self.buf.as_mut_slice()) { Some(len) => try!(self.stream.write(self.buf.slice_to(len))), None => break }; } Ok(()) } /// Get the compression currently in use. The result will be /// either None, indicating no compression is in use, or a string /// with the compression name. pub fn get_compression(&self) -> Option { let ptr = unsafe { ffi::SSL_get_current_compression(self.ssl.ssl) }; if ptr == ptr::null() { return None; } let meth = unsafe { ffi::SSL_COMP_get_name(ptr) }; let s = unsafe { String::from_raw_buf(meth as *const u8) }; Some(s) } } impl Reader for SslStream { fn read(&mut self, buf: &mut [u8]) -> IoResult { match self.in_retry_wrapper(|ssl| { ssl.read(buf) }) { Ok(len) => Ok(len as uint), Err(SslSessionClosed) => Err(IoError { kind: EndOfFile, desc: "SSL session closed", detail: None }), Err(StreamError(e)) => Err(e), _ => unreachable!() } } } impl Writer for SslStream { fn write(&mut self, buf: &[u8]) -> IoResult<()> { let mut start = 0; while start < buf.len() { let ret = self.in_retry_wrapper(|ssl| { ssl.write(buf.split_at(start).1) }); match ret { Ok(len) => start += len as uint, _ => unreachable!() } try!(self.write_through()); } Ok(()) } fn flush(&mut self) -> IoResult<()> { try!(self.write_through()); self.stream.flush() } } /// A utility type to help in cases where the use of SSL is decided at runtime. pub enum MaybeSslStream where S: Stream { /// A connection using SSL Ssl(SslStream), /// A connection not using SSL Normal(S), } impl Reader for MaybeSslStream where S: Stream { fn read(&mut self, buf: &mut [u8]) -> IoResult { match *self { MaybeSslStream::Ssl(ref mut s) => s.read(buf), MaybeSslStream::Normal(ref mut s) => s.read(buf), } } } impl Writer for MaybeSslStream where S: Stream{ fn write(&mut self, buf: &[u8]) -> IoResult<()> { match *self { MaybeSslStream::Ssl(ref mut s) => s.write(buf), MaybeSslStream::Normal(ref mut s) => s.write(buf), } } fn flush(&mut self) -> IoResult<()> { match *self { MaybeSslStream::Ssl(ref mut s) => s.flush(), MaybeSslStream::Normal(ref mut s) => s.flush(), } } } impl MaybeSslStream where S: Stream { /// Returns a reference to the underlying stream. pub fn get_ref(&self) -> &S { match *self { MaybeSslStream::Ssl(ref s) => s.get_ref(), MaybeSslStream::Normal(ref s) => s, } } /// Returns a mutable reference to the underlying stream. /// /// ## Warning /// /// It is inadvisable to read from or write to the underlying stream. pub fn get_mut(&mut self) -> &mut S { match *self { MaybeSslStream::Ssl(ref mut s) => s.get_mut(), MaybeSslStream::Normal(ref mut s) => s, } } }