aboutsummaryrefslogtreecommitdiff
path: root/openssl/src/ssl
diff options
context:
space:
mode:
authorSteven Fackler <[email protected]>2015-02-07 21:28:54 -0800
committerSteven Fackler <[email protected]>2015-02-07 21:30:05 -0800
commitec65b0c67b452539fded5e06cbb6ce1d165074e0 (patch)
treec50c22c2ce4ca095149c96a0f3a3b935b4012a5c /openssl/src/ssl
parentFix deprecation warnings in openssl-sys (diff)
downloadrust-openssl-ec65b0c67b452539fded5e06cbb6ce1d165074e0.tar.xz
rust-openssl-ec65b0c67b452539fded5e06cbb6ce1d165074e0.zip
Move docs to this repo and auto build
Diffstat (limited to 'openssl/src/ssl')
-rw-r--r--openssl/src/ssl/error.rs122
-rw-r--r--openssl/src/ssl/mod.rs643
-rw-r--r--openssl/src/ssl/tests.rs207
3 files changed, 972 insertions, 0 deletions
diff --git a/openssl/src/ssl/error.rs b/openssl/src/ssl/error.rs
new file mode 100644
index 00000000..027554c5
--- /dev/null
+++ b/openssl/src/ssl/error.rs
@@ -0,0 +1,122 @@
+pub use self::SslError::*;
+pub use self::OpensslError::*;
+
+use libc::c_ulong;
+use std::error;
+use std::fmt;
+use std::ffi::c_str_to_bytes;
+use std::old_io::IoError;
+
+use ffi;
+
+/// An SSL error
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub enum SslError {
+ /// The underlying stream reported an error
+ StreamError(IoError),
+ /// The SSL session has been closed by the other end
+ SslSessionClosed,
+ /// An error in the OpenSSL library
+ OpenSslErrors(Vec<OpensslError>)
+}
+
+impl fmt::Display for SslError {
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ fmt.write_str(error::Error::description(self))
+ }
+}
+
+impl error::Error for SslError {
+ fn description(&self) -> &str {
+ match *self {
+ StreamError(_) => "The underlying stream reported an error",
+ SslSessionClosed => "The SSL session has been closed by the other end",
+ OpenSslErrors(_) => "An error in the OpenSSL library",
+ }
+ }
+
+ fn cause(&self) -> Option<&error::Error> {
+ match *self {
+ StreamError(ref err) => Some(err as &error::Error),
+ _ => None
+ }
+ }
+}
+
+/// An error from the OpenSSL library
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub enum OpensslError {
+ /// An unknown error
+ UnknownError {
+ /// The library reporting the error
+ library: String,
+ /// The function reporting the error
+ function: String,
+ /// The reason for the error
+ reason: String
+ }
+}
+
+fn get_lib(err: c_ulong) -> String {
+ unsafe {
+ let bytes = c_str_to_bytes(&ffi::ERR_lib_error_string(err)).to_vec();
+ String::from_utf8(bytes).unwrap()
+ }
+}
+
+fn get_func(err: c_ulong) -> String {
+ unsafe {
+ let bytes = c_str_to_bytes(&ffi::ERR_func_error_string(err)).to_vec();
+ String::from_utf8(bytes).unwrap()
+ }
+}
+
+fn get_reason(err: c_ulong) -> String {
+ unsafe {
+ let bytes = c_str_to_bytes(&ffi::ERR_reason_error_string(err)).to_vec();
+ String::from_utf8(bytes).unwrap()
+ }
+}
+
+impl SslError {
+ /// Creates a new `OpenSslErrors` with the current contents of the error
+ /// stack.
+ pub fn get() -> SslError {
+ let mut errs = vec!();
+ loop {
+ match unsafe { ffi::ERR_get_error() } {
+ 0 => break,
+ err => errs.push(SslError::from_error_code(err))
+ }
+ }
+ OpenSslErrors(errs)
+ }
+
+ /// Creates an `SslError` from the raw numeric error code.
+ pub fn from_error(err: c_ulong) -> SslError {
+ OpenSslErrors(vec![SslError::from_error_code(err)])
+ }
+
+ fn from_error_code(err: c_ulong) -> OpensslError {
+ ffi::init();
+ UnknownError {
+ library: get_lib(err),
+ function: get_func(err),
+ reason: get_reason(err)
+ }
+ }
+}
+
+#[test]
+fn test_uknown_error_should_have_correct_messages() {
+ let errs = match SslError::from_error(336032784) {
+ OpenSslErrors(errs) => errs,
+ _ => panic!("This should always be an `OpenSslErrors` variant.")
+ };
+
+ let UnknownError { ref library, ref function, ref reason } = errs[0];
+
+ assert_eq!(library.as_slice(), "SSL routines");
+ assert_eq!(function.as_slice(), "SSL23_GET_SERVER_HELLO");
+ assert_eq!(reason.as_slice(), "sslv3 alert handshake failure");
+}
diff --git a/openssl/src/ssl/mod.rs b/openssl/src/ssl/mod.rs
new file mode 100644
index 00000000..35649e24
--- /dev/null
+++ b/openssl/src/ssl/mod.rs
@@ -0,0 +1,643 @@
+use libc::{c_int, c_void, c_long};
+use std::ffi::{CString, c_str_to_bytes};
+use std::old_io::{IoResult, IoError, EndOfFile, Stream, Reader, Writer};
+use std::mem;
+use std::fmt;
+use std::num::FromPrimitive;
+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.call_once(|| {
+ 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
+#[allow(non_camel_case_types)]
+#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
+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
+#[derive(Copy, Clone, Debug)]
+#[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<T>() -> c_int {
+ static mut VERIFY_DATA_IDX: c_int = -1;
+ static mut INIT: Once = ONCE_INIT;
+
+ extern fn free_data_box<T>(_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<T> = unsafe { mem::transmute(ptr) };
+ }
+
+ unsafe {
+ INIT.call_once(|| {
+ let f: ffi::CRYPTO_EX_free = free_data_box::<T>;
+ let idx = ffi::SSL_CTX_get_ex_new_index(0, ptr::null(), None,
+ None, Some(f));
+ 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<VerifyCallback> = 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<T>(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<VerifyCallbackData<T>> = mem::transmute(verify);
+
+ let data = ffi::SSL_CTX_get_ex_data(ssl_ctx, get_verify_data_idx::<T>());
+ let data: Box<T> = 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<T> = 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<SslError> {
+ if res == 0 {
+ Some(SslError::get())
+ } else {
+ None
+ }
+}
+
+/// An SSL context object
+pub struct SslContext {
+ ctx: ptr::Unique<ffi::SSL_CTX>
+}
+
+// TODO: add useful info here
+impl fmt::Debug for SslContext {
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ write!(fmt, "SslContext")
+ }
+}
+
+impl Drop for SslContext {
+ fn drop(&mut self) {
+ unsafe { ffi::SSL_CTX_free(self.ctx.0) }
+ }
+}
+
+impl SslContext {
+ /// Creates a new SSL context.
+ pub fn new(method: SslMethod) -> Result<SslContext, SslError> {
+ init();
+
+ let ctx = unsafe { ffi::SSL_CTX_new(method.to_raw()) };
+ if ctx == ptr::null_mut() {
+ return Err(SslError::get());
+ }
+
+ Ok(SslContext { ctx: ptr::Unique(ctx) })
+ }
+
+ /// Configures the certificate verification method for new connections.
+ pub fn set_verify(&mut self, mode: SslVerifyMode,
+ verify: Option<VerifyCallback>) {
+ unsafe {
+ ffi::SSL_CTX_set_ex_data(self.ctx.0, VERIFY_IDX,
+ mem::transmute(verify));
+ let f: extern fn(c_int, *mut ffi::X509_STORE_CTX) -> c_int =
+ raw_verify;
+ ffi::SSL_CTX_set_verify(self.ctx.0, mode as c_int, Some(f));
+ }
+ }
+
+ /// 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<T>(&mut self, mode: SslVerifyMode,
+ verify: VerifyCallbackData<T>,
+ data: T) {
+ let data = Box::new(data);
+ unsafe {
+ ffi::SSL_CTX_set_ex_data(self.ctx.0, VERIFY_IDX,
+ mem::transmute(Some(verify)));
+ ffi::SSL_CTX_set_ex_data(self.ctx.0, get_verify_data_idx::<T>(),
+ mem::transmute(data));
+ let f: extern fn(c_int, *mut ffi::X509_STORE_CTX) -> c_int =
+ raw_verify_with_data::<T>;
+ ffi::SSL_CTX_set_verify(self.ctx.0, mode as c_int, Some(f));
+ }
+ }
+
+ /// Sets verification depth
+ pub fn set_verify_depth(&mut self, depth: u32) {
+ unsafe {
+ ffi::SSL_CTX_set_verify_depth(self.ctx.0, 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<SslError> {
+ wrap_ssl_result(
+ unsafe {
+ let file = CString::from_slice(file.as_vec());
+ ffi::SSL_CTX_load_verify_locations(self.ctx.0, file.as_ptr(), ptr::null())
+ })
+ }
+
+ /// Specifies the file that contains certificate
+ pub fn set_certificate_file(&mut self, file: &Path,
+ file_type: X509FileType) -> Option<SslError> {
+ wrap_ssl_result(
+ unsafe {
+ let file = CString::from_slice(file.as_vec());
+ ffi::SSL_CTX_use_certificate_file(self.ctx.0, file.as_ptr(), 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<SslError> {
+ wrap_ssl_result(
+ unsafe {
+ let file = CString::from_slice(file.as_vec());
+ ffi::SSL_CTX_use_PrivateKey_file(self.ctx.0, file.as_ptr(), file_type as c_int)
+ })
+ }
+
+ pub fn set_cipher_list(&mut self, cipher_list: &str) -> Option<SslError> {
+ wrap_ssl_result(
+ unsafe {
+ let cipher_list = CString::from_slice(cipher_list.as_bytes());
+ ffi::SSL_CTX_set_cipher_list(self.ctx.0, cipher_list.as_ptr())
+ })
+ }
+}
+
+#[allow(dead_code)]
+struct MemBioRef<'ssl> {
+ ssl: &'ssl Ssl,
+ bio: MemBio,
+}
+
+impl<'ssl> MemBioRef<'ssl> {
+ fn read(&mut self, buf: &mut [u8]) -> Option<usize> {
+ (&mut self.bio as &mut Reader).read(buf).ok()
+ }
+
+ fn write_all(&mut self, buf: &[u8]) {
+ let _ = (&mut self.bio as &mut Writer).write_all(buf);
+ }
+}
+
+pub struct Ssl {
+ ssl: ptr::Unique<ffi::SSL>
+}
+
+// TODO: put useful information here
+impl fmt::Debug for Ssl {
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ write!(fmt, "Ssl")
+ }
+}
+
+impl Drop for Ssl {
+ fn drop(&mut self) {
+ unsafe { ffi::SSL_free(self.ssl.0) }
+ }
+}
+
+impl Ssl {
+ pub fn new(ctx: &SslContext) -> Result<Ssl, SslError> {
+ let ssl = unsafe { ffi::SSL_new(ctx.ctx.0) };
+ if ssl == ptr::null_mut() {
+ return Err(SslError::get());
+ }
+ let ssl = Ssl { ssl: ptr::Unique(ssl) };
+
+ let rbio = try!(MemBio::new());
+ let wbio = try!(MemBio::new());
+
+ unsafe { ffi::SSL_set_bio(ssl.ssl.0, rbio.unwrap(), wbio.unwrap()) }
+ Ok(ssl)
+ }
+
+ fn get_rbio<'a>(&'a self) -> MemBioRef<'a> {
+ unsafe { self.wrap_bio(ffi::SSL_get_rbio(self.ssl.0)) }
+ }
+
+ fn get_wbio<'a>(&'a self) -> MemBioRef<'a> {
+ unsafe { self.wrap_bio(ffi::SSL_get_wbio(self.ssl.0)) }
+ }
+
+ 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.0) }
+ }
+
+ fn accept(&self) -> c_int {
+ unsafe { ffi::SSL_accept(self.ssl.0) }
+ }
+
+ fn read(&self, buf: &mut [u8]) -> c_int {
+ unsafe { ffi::SSL_read(self.ssl.0, buf.as_ptr() as *mut c_void,
+ buf.len() as c_int) }
+ }
+
+ fn write_all(&self, buf: &[u8]) -> c_int {
+ unsafe { ffi::SSL_write(self.ssl.0, 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.0, ret) };
+ match FromPrimitive::from_int(err as isize) {
+ 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 = 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)
+
+ let hostname = CString::from_slice(hostname.as_bytes());
+ ffi::SSL_ctrl(self.ssl.0, ffi::SSL_CTRL_SET_TLSEXT_HOSTNAME,
+ ffi::TLSEXT_NAMETYPE_host_name,
+ hostname.as_ptr() 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<X509> {
+ unsafe {
+ let ptr = ffi::SSL_get_peer_certificate(self.ssl.0);
+ if ptr.is_null() {
+ None
+ } else {
+ Some(X509::new(ptr, true))
+ }
+ }
+ }
+
+}
+
+#[derive(FromPrimitive, Debug)]
+#[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.
+#[derive(Clone)]
+pub struct SslStream<S> {
+ stream: S,
+ ssl: Arc<Ssl>,
+ buf: Vec<u8>
+}
+
+impl<S> fmt::Debug for SslStream<S> where S: fmt::Debug {
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ write!(fmt, "SslStream {{ stream: {:?}, ssl: {:?} }}", self.stream, self.ssl)
+ }
+}
+
+impl<S: Stream> SslStream<S> {
+ fn new_base(ssl:Ssl, stream: S) -> SslStream<S> {
+ 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: usize = 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<SslStream<S>, 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<SslStream<S>, 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<SslStream<S>, 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<SslStream<S>, 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<F>(&mut self, mut blk: F)
+ -> Result<c_int, SslError> where F: FnMut(&Ssl) -> c_int {
+ 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_all(&self.buf[..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_all(&self.buf[..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<String> {
+ let ptr = unsafe { ffi::SSL_get_current_compression(self.ssl.ssl.0) };
+ if ptr == ptr::null() {
+ return None;
+ }
+
+ let meth = unsafe { ffi::SSL_COMP_get_name(ptr) };
+ let s = unsafe {
+ String::from_utf8(c_str_to_bytes(&meth).to_vec()).unwrap()
+ };
+
+ Some(s)
+ }
+}
+
+impl<S: Stream> Reader for SslStream<S> {
+ fn read(&mut self, buf: &mut [u8]) -> IoResult<usize> {
+ match self.in_retry_wrapper(|ssl| { ssl.read(buf) }) {
+ Ok(len) => Ok(len as usize),
+ Err(SslSessionClosed) =>
+ Err(IoError {
+ kind: EndOfFile,
+ desc: "SSL session closed",
+ detail: None
+ }),
+ Err(StreamError(e)) => Err(e),
+ _ => unreachable!()
+ }
+ }
+}
+
+impl<S: Stream> Writer for SslStream<S> {
+ fn write_all(&mut self, buf: &[u8]) -> IoResult<()> {
+ let mut start = 0;
+ while start < buf.len() {
+ let ret = self.in_retry_wrapper(|ssl| {
+ ssl.write_all(buf.split_at(start).1)
+ });
+ match ret {
+ Ok(len) => start += len as usize,
+ _ => 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.
+#[derive(Debug)]
+pub enum MaybeSslStream<S> where S: Stream {
+ /// A connection using SSL
+ Ssl(SslStream<S>),
+ /// A connection not using SSL
+ Normal(S),
+}
+
+impl<S> Reader for MaybeSslStream<S> where S: Stream {
+ fn read(&mut self, buf: &mut [u8]) -> IoResult<usize> {
+ match *self {
+ MaybeSslStream::Ssl(ref mut s) => s.read(buf),
+ MaybeSslStream::Normal(ref mut s) => s.read(buf),
+ }
+ }
+}
+
+impl<S> Writer for MaybeSslStream<S> where S: Stream{
+ fn write_all(&mut self, buf: &[u8]) -> IoResult<()> {
+ match *self {
+ MaybeSslStream::Ssl(ref mut s) => s.write_all(buf),
+ MaybeSslStream::Normal(ref mut s) => s.write_all(buf),
+ }
+ }
+
+ fn flush(&mut self) -> IoResult<()> {
+ match *self {
+ MaybeSslStream::Ssl(ref mut s) => s.flush(),
+ MaybeSslStream::Normal(ref mut s) => s.flush(),
+ }
+ }
+}
+
+impl<S> MaybeSslStream<S> 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,
+ }
+ }
+}
diff --git a/openssl/src/ssl/tests.rs b/openssl/src/ssl/tests.rs
new file mode 100644
index 00000000..73f479bf
--- /dev/null
+++ b/openssl/src/ssl/tests.rs
@@ -0,0 +1,207 @@
+use serialize::hex::FromHex;
+use std::old_io::net::tcp::TcpStream;
+use std::old_io::{Writer};
+use std::thread::Thread;
+
+use crypto::hash::Type::{SHA256};
+use ssl::SslMethod::Sslv23;
+use ssl::{SslContext, SslStream, VerifyCallback};
+use ssl::SslVerifyMode::SslVerifyPeer;
+use x509::{X509StoreContext};
+
+#[test]
+fn test_new_ctx() {
+ SslContext::new(Sslv23).unwrap();
+}
+
+#[test]
+fn test_new_sslstream() {
+ let stream = TcpStream::connect("127.0.0.1:15418").unwrap();
+ SslStream::new(&SslContext::new(Sslv23).unwrap(), stream).unwrap();
+}
+
+#[test]
+fn test_verify_untrusted() {
+ let stream = TcpStream::connect("127.0.0.1:15418").unwrap();
+ let mut ctx = SslContext::new(Sslv23).unwrap();
+ ctx.set_verify(SslVerifyPeer, None);
+ match SslStream::new(&ctx, stream) {
+ Ok(_) => panic!("expected failure"),
+ Err(err) => println!("error {:?}", err)
+ }
+}
+
+#[test]
+fn test_verify_trusted() {
+ let stream = TcpStream::connect("127.0.0.1:15418").unwrap();
+ let mut ctx = SslContext::new(Sslv23).unwrap();
+ ctx.set_verify(SslVerifyPeer, None);
+ match ctx.set_CA_file(&Path::new("test/cert.pem")) {
+ None => {}
+ Some(err) => panic!("Unexpected error {:?}", err)
+ }
+ match SslStream::new(&ctx, stream) {
+ Ok(_) => (),
+ Err(err) => panic!("Expected success, got {:?}", err)
+ }
+}
+
+#[test]
+fn test_verify_untrusted_callback_override_ok() {
+ fn callback(_preverify_ok: bool, _x509_ctx: &X509StoreContext) -> bool {
+ true
+ }
+ let stream = TcpStream::connect("127.0.0.1:15418").unwrap();
+ let mut ctx = SslContext::new(Sslv23).unwrap();
+ ctx.set_verify(SslVerifyPeer, Some(callback as VerifyCallback));
+ match SslStream::new(&ctx, stream) {
+ Ok(_) => (),
+ Err(err) => panic!("Expected success, got {:?}", err)
+ }
+}
+
+#[test]
+fn test_verify_untrusted_callback_override_bad() {
+ fn callback(_preverify_ok: bool, _x509_ctx: &X509StoreContext) -> bool {
+ false
+ }
+ let stream = TcpStream::connect("127.0.0.1:15418").unwrap();
+ let mut ctx = SslContext::new(Sslv23).unwrap();
+ ctx.set_verify(SslVerifyPeer, Some(callback as VerifyCallback));
+ assert!(SslStream::new(&ctx, stream).is_err());
+}
+
+#[test]
+fn test_verify_trusted_callback_override_ok() {
+ fn callback(_preverify_ok: bool, _x509_ctx: &X509StoreContext) -> bool {
+ true
+ }
+ let stream = TcpStream::connect("127.0.0.1:15418").unwrap();
+ let mut ctx = SslContext::new(Sslv23).unwrap();
+ ctx.set_verify(SslVerifyPeer, Some(callback as VerifyCallback));
+ match ctx.set_CA_file(&Path::new("test/cert.pem")) {
+ None => {}
+ Some(err) => panic!("Unexpected error {:?}", err)
+ }
+ match SslStream::new(&ctx, stream) {
+ Ok(_) => (),
+ Err(err) => panic!("Expected success, got {:?}", err)
+ }
+}
+
+#[test]
+fn test_verify_trusted_callback_override_bad() {
+ fn callback(_preverify_ok: bool, _x509_ctx: &X509StoreContext) -> bool {
+ false
+ }
+ let stream = TcpStream::connect("127.0.0.1:15418").unwrap();
+ let mut ctx = SslContext::new(Sslv23).unwrap();
+ ctx.set_verify(SslVerifyPeer, Some(callback as VerifyCallback));
+ match ctx.set_CA_file(&Path::new("test/cert.pem")) {
+ None => {}
+ Some(err) => panic!("Unexpected error {:?}", err)
+ }
+ assert!(SslStream::new(&ctx, stream).is_err());
+}
+
+#[test]
+fn test_verify_callback_load_certs() {
+ fn callback(_preverify_ok: bool, x509_ctx: &X509StoreContext) -> bool {
+ assert!(x509_ctx.get_current_cert().is_some());
+ true
+ }
+ let stream = TcpStream::connect("127.0.0.1:15418").unwrap();
+ let mut ctx = SslContext::new(Sslv23).unwrap();
+ ctx.set_verify(SslVerifyPeer, Some(callback as VerifyCallback));
+ assert!(SslStream::new(&ctx, stream).is_ok());
+}
+
+#[test]
+fn test_verify_trusted_get_error_ok() {
+ fn callback(_preverify_ok: bool, x509_ctx: &X509StoreContext) -> bool {
+ assert!(x509_ctx.get_error().is_none());
+ true
+ }
+ let stream = TcpStream::connect("127.0.0.1:15418").unwrap();
+ let mut ctx = SslContext::new(Sslv23).unwrap();
+ ctx.set_verify(SslVerifyPeer, Some(callback as VerifyCallback));
+ match ctx.set_CA_file(&Path::new("test/cert.pem")) {
+ None => {}
+ Some(err) => panic!("Unexpected error {:?}", err)
+ }
+ assert!(SslStream::new(&ctx, stream).is_ok());
+}
+
+#[test]
+fn test_verify_trusted_get_error_err() {
+ fn callback(_preverify_ok: bool, x509_ctx: &X509StoreContext) -> bool {
+ assert!(x509_ctx.get_error().is_some());
+ false
+ }
+ let stream = TcpStream::connect("127.0.0.1:15418").unwrap();
+ let mut ctx = SslContext::new(Sslv23).unwrap();
+ ctx.set_verify(SslVerifyPeer, Some(callback as VerifyCallback));
+ assert!(SslStream::new(&ctx, stream).is_err());
+}
+
+#[test]
+fn test_verify_callback_data() {
+ fn callback(_preverify_ok: bool, x509_ctx: &X509StoreContext, node_id: &Vec<u8>) -> bool {
+ let cert = x509_ctx.get_current_cert();
+ match cert {
+ None => false,
+ Some(cert) => {
+ let fingerprint = cert.fingerprint(SHA256).unwrap();
+ fingerprint.as_slice() == node_id.as_slice()
+ }
+ }
+ }
+ let stream = TcpStream::connect("127.0.0.1:15418").unwrap();
+ let mut ctx = SslContext::new(Sslv23).unwrap();
+
+ // Node id was generated as SHA256 hash of certificate "test/cert.pem"
+ // in DER format.
+ // Command: openssl x509 -in test/cert.pem -outform DER | openssl dgst -sha256
+ // Please update if "test/cert.pem" will ever change
+ let node_hash_str = "46e3f1a6d17a41ce70d0c66ef51cee2ab4ba67cac8940e23f10c1f944b49fb5c";
+ let node_id = node_hash_str.from_hex().unwrap();
+ ctx.set_verify_with_data(SslVerifyPeer, callback, node_id);
+ ctx.set_verify_depth(1);
+
+ match SslStream::new(&ctx, stream) {
+ Ok(_) => (),
+ Err(err) => panic!("Expected success, got {:?}", err)
+ }
+}
+
+
+#[test]
+fn test_write() {
+ let stream = TcpStream::connect("127.0.0.1:15418").unwrap();
+ let mut stream = SslStream::new(&SslContext::new(Sslv23).unwrap(), stream).unwrap();
+ stream.write_all("hello".as_bytes()).unwrap();
+ stream.flush().unwrap();
+ stream.write_all(" there".as_bytes()).unwrap();
+ stream.flush().unwrap();
+}
+
+#[test]
+fn test_read() {
+ let stream = TcpStream::connect("127.0.0.1:15418").unwrap();
+ let mut stream = SslStream::new(&SslContext::new(Sslv23).unwrap(), stream).unwrap();
+ stream.write_all("GET /\r\n\r\n".as_bytes()).unwrap();
+ stream.flush().unwrap();
+ stream.read_to_end().ok().expect("read error");
+}
+
+#[test]
+fn test_clone() {
+ let stream = TcpStream::connect("127.0.0.1:15418").unwrap();
+ let mut stream = SslStream::new(&SslContext::new(Sslv23).unwrap(), stream).unwrap();
+ let mut stream2 = stream.clone();
+ let _t = Thread::spawn(move || {
+ stream2.write_all("GET /\r\n\r\n".as_bytes()).unwrap();
+ stream2.flush().unwrap();
+ });
+ stream.read_to_end().ok().expect("read error");
+}