use libc::{c_int, c_uint, c_void, c_char}; use std::io::{IoResult, IoError, EndOfFile, Stream, Reader, Writer}; use std::mem; use std::ptr; use std::rt::mutex::NativeMutex; use std::string; use sync::one::{Once, ONCE_INIT}; use crypto::hash::{HashType, evpmd}; use ssl::error::{SslError, SslSessionClosed, StreamError}; pub mod error; mod ffi; #[cfg(test)] mod tests; static mut VERIFY_IDX: c_int = -1; static mut MUTEXES: *mut Vec = 0 as *mut Vec; macro_rules! try_ssl( ($e:expr) => ( match $e { Ok(ok) => ok, Err(err) => return Err(StreamError(err)) } ) ) fn init() { static mut INIT: Once = ONCE_INIT; unsafe { INIT.doit(|| { ffi::SSL_library_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; let num_locks = ffi::CRYPTO_num_locks(); let mutexes = box Vec::from_fn(num_locks as uint, |_| NativeMutex::new()); MUTEXES = mem::transmute(mutexes); ffi::CRYPTO_set_locking_callback(locking_function); }); } } /// Determines the SSL method supported #[deriving(Show, Hash, PartialEq, Eq)] pub enum SslMethod { #[cfg(sslv2)] /// Only support the SSLv2 protocol Sslv2, /// Only support the SSLv3 protocol Sslv3, /// Only support the TLSv1 protocol Tlsv1, /// Support the SSLv2, SSLv3 and TLSv1 protocols Sslv23, } impl SslMethod { unsafe fn to_raw(&self) -> *const ffi::SSL_METHOD { match *self { #[cfg(sslv2)] Sslv2 => ffi::SSLv2_method(), Sslv3 => ffi::SSLv3_method(), Tlsv1 => ffi::TLSv1_method(), Sslv23 => ffi::SSLv23_method() } } } /// Determines the type of certificate verification used #[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 } extern fn locking_function(mode: c_int, n: c_int, _file: *const c_char, _line: c_int) { unsafe { let mutex = (*MUTEXES).get_mut(n as uint); if mode & ffi::CRYPTO_LOCK != 0 { mutex.lock_noguard(); } else { mutex.unlock_noguard(); } } } 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 { ctx: x509_ctx }; match verify { None => preverify_ok, Some(verify) => verify(preverify_ok != 0, &ctx) as c_int } } } /// The signature of functions that can be used to manually verify certificates pub type VerifyCallback = fn(preverify_ok: bool, x509_ctx: &X509StoreContext) -> bool; #[repr(i32)] pub enum X509FileType { PEM = ffi::X509_FILETYPE_PEM, ASN1 = ffi::X509_FILETYPE_ASN1, Default = ffi::X509_FILETYPE_DEFAULT } // 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)); } } #[allow(non_snake_case)] /// Specifies the file that contains trusted CA certificates. pub fn set_CA_file(&mut self, file: &str) -> 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 is client certificate pub fn set_certificate_file(&mut self, file: &str, 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 is client private key pub fn set_private_key_file(&mut self, file: &str, 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 struct X509StoreContext { ctx: *mut ffi::X509_STORE_CTX } impl X509StoreContext { pub fn get_error(&self) -> Option { let err = unsafe { ffi::X509_STORE_CTX_get_error(self.ctx) }; X509ValidationError::from_raw(err) } pub fn get_current_cert<'a>(&'a self) -> Option> { let ptr = unsafe { ffi::X509_STORE_CTX_get_current_cert(self.ctx) }; if ptr.is_null() { None } else { Some(X509 { ctx: self, x509: ptr }) } } } #[allow(dead_code)] /// A public key certificate pub struct X509<'ctx> { ctx: &'ctx X509StoreContext, x509: *mut ffi::X509 } impl<'ctx> X509<'ctx> { pub fn subject_name<'a>(&'a self) -> X509Name<'a> { let name = unsafe { ffi::X509_get_subject_name(self.x509) }; X509Name { x509: self, name: name } } /// Returns certificate fingerprint calculated using provided hash pub fn fingerprint(&self, hash_type: HashType) -> Option> { let (evp, len) = evpmd(hash_type); let v: Vec = Vec::from_elem(len, 0); let act_len: c_uint = 0; let res = unsafe { ffi::X509_digest(self.x509, evp, mem::transmute(v.as_ptr()), mem::transmute(&act_len)) }; match res { 0 => None, _ => { let act_len = act_len as uint; match len.cmp(&act_len) { Greater => None, Equal => Some(v), Less => fail!("Fingerprint buffer was corrupted!") } } } } } #[allow(dead_code)] pub struct X509Name<'x> { x509: &'x X509<'x>, name: *mut ffi::X509_NAME } macro_rules! make_validation_error( ($ok_val:ident, $($name:ident = $val:ident,)+) => ( pub enum X509ValidationError { $($name,)+ X509UnknownError(c_int) } impl X509ValidationError { #[doc(hidden)] pub fn from_raw(err: c_int) -> Option { match err { self::ffi::$ok_val => None, $(self::ffi::$val => Some($name),)+ err => Some(X509UnknownError(err)) } } } ) ) make_validation_error!(X509_V_OK, X509UnableToGetIssuerCert = X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT, X509UnableToGetCrl = X509_V_ERR_UNABLE_TO_GET_CRL, X509UnableToDecryptCertSignature = X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE, X509UnableToDecryptCrlSignature = X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE, X509UnableToDecodeIssuerPublicKey = X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY, X509CertSignatureFailure = X509_V_ERR_CERT_SIGNATURE_FAILURE, X509CrlSignatureFailure = X509_V_ERR_CRL_SIGNATURE_FAILURE, X509CertNotYetValid = X509_V_ERR_CERT_NOT_YET_VALID, X509CertHasExpired = X509_V_ERR_CERT_HAS_EXPIRED, X509CrlNotYetValid = X509_V_ERR_CRL_NOT_YET_VALID, X509CrlHasExpired = X509_V_ERR_CRL_HAS_EXPIRED, X509ErrorInCertNotBeforeField = X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD, X509ErrorInCertNotAfterField = X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD, X509ErrorInCrlLastUpdateField = X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD, X509ErrorInCrlNextUpdateField = X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD, X509OutOfMem = X509_V_ERR_OUT_OF_MEM, X509DepthZeroSelfSignedCert = X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT, X509SelfSignedCertInChain = X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN, X509UnableToGetIssuerCertLocally = X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY, X509UnableToVerifyLeafSignature = X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE, X509CertChainTooLong = X509_V_ERR_CERT_CHAIN_TOO_LONG, X509CertRevoked = X509_V_ERR_CERT_REVOKED, X509InvalidCA = X509_V_ERR_INVALID_CA, X509PathLengthExceeded = X509_V_ERR_PATH_LENGTH_EXCEEDED, X509InvalidPurpose = X509_V_ERR_INVALID_PURPOSE, X509CertUntrusted = X509_V_ERR_CERT_UNTRUSTED, X509CertRejected = X509_V_ERR_CERT_REJECTED, X509SubjectIssuerMismatch = X509_V_ERR_SUBJECT_ISSUER_MISMATCH, X509AkidSkidMismatch = X509_V_ERR_AKID_SKID_MISMATCH, X509AkidIssuerSerialMismatch = X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH, X509KeyusageNoCertsign = X509_V_ERR_KEYUSAGE_NO_CERTSIGN, X509UnableToGetCrlIssuer = X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER, X509UnhandledCriticalExtension = X509_V_ERR_UNHANDLED_CRITICAL_EXTENSION, X509KeyusageNoCrlSign = X509_V_ERR_KEYUSAGE_NO_CRL_SIGN, X509UnhandledCriticalCrlExtension = X509_V_ERR_UNHANDLED_CRITICAL_CRL_EXTENSION, X509InvalidNonCA = X509_V_ERR_INVALID_NON_CA, X509ProxyPathLengthExceeded = X509_V_ERR_PROXY_PATH_LENGTH_EXCEEDED, X509KeyusageNoDigitalSignature = X509_V_ERR_KEYUSAGE_NO_DIGITAL_SIGNATURE, X509ProxyCertificatesNotAllowed = X509_V_ERR_PROXY_CERTIFICATES_NOT_ALLOWED, X509InvalidExtension = X509_V_ERR_INVALID_EXTENSION, X509InavlidPolicyExtension = X509_V_ERR_INVALID_POLICY_EXTENSION, X509NoExplicitPolicy = X509_V_ERR_NO_EXPLICIT_POLICY, X509DifferentCrlScope = X509_V_ERR_DIFFERENT_CRL_SCOPE, X509UnsupportedExtensionFeature = X509_V_ERR_UNSUPPORTED_EXTENSION_FEATURE, X509UnnestedResource = X509_V_ERR_UNNESTED_RESOURCE, X509PermittedVolation = X509_V_ERR_PERMITTED_VIOLATION, X509ExcludedViolation = X509_V_ERR_EXCLUDED_VIOLATION, X509SubtreeMinmax = X509_V_ERR_SUBTREE_MINMAX, X509UnsupportedConstraintType = X509_V_ERR_UNSUPPORTED_CONSTRAINT_TYPE, X509UnsupportedConstraintSyntax = X509_V_ERR_UNSUPPORTED_CONSTRAINT_SYNTAX, X509UnsupportedNameSyntax = X509_V_ERR_UNSUPPORTED_NAME_SYNTAX, X509CrlPathValidationError= X509_V_ERR_CRL_PATH_VALIDATION_ERROR, X509ApplicationVerification = X509_V_ERR_APPLICATION_VERIFICATION, ) 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 = unsafe { ffi::BIO_new(ffi::BIO_s_mem()) }; if rbio == ptr::null_mut() { return Err(SslError::get()); } let wbio = unsafe { ffi::BIO_new(ffi::BIO_s_mem()) }; if wbio == ptr::null_mut() { unsafe { ffi::BIO_free_all(rbio) } return Err(SslError::get()); } unsafe { ffi::SSL_set_bio(ssl.ssl, rbio, wbio) } 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::mut_null()); MemBioRef { ssl: self, bio: MemBio { bio: bio, owned: false } } } fn connect(&self) -> c_int { unsafe { ffi::SSL_connect(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(()) } } } #[deriving(FromPrimitive)] #[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, } #[allow(dead_code)] struct MemBioRef<'ssl> { ssl: &'ssl Ssl, bio: MemBio, } impl<'ssl> MemBioRef<'ssl> { fn read(&self, buf: &mut [u8]) -> Option { self.bio.read(buf) } fn write(&self, buf: &[u8]) { self.bio.write(buf) } } struct MemBio { bio: *mut ffi::BIO, owned: bool } impl Drop for MemBio { fn drop(&mut self) { if self.owned { unsafe { ffi::BIO_free_all(self.bio); } } } } impl MemBio { fn read(&self, buf: &mut [u8]) -> Option { let ret = unsafe { ffi::BIO_read(self.bio, buf.as_ptr() as *mut c_void, buf.len() as c_int) }; if ret < 0 { None } else { Some(ret as uint) } } fn write(&self, buf: &[u8]) { let ret = unsafe { ffi::BIO_write(self.bio, buf.as_ptr() as *const c_void, buf.len() as c_int) }; assert_eq!(buf.len(), ret as uint); } } /// A stream wrapper which handles SSL encryption for an underlying stream. pub struct SslStream { stream: S, ssl: Ssl, buf: Vec } impl SslStream { /// 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 { stream: stream, ssl: ssl, // Maximum TLS record size is 16k buf: Vec::from_elem(16 * 1024, 0u8) }; match ssl.in_retry_wrapper(|ssl| { ssl.connect() }) { Ok(_) => Ok(ssl), Err(err) => Err(err) } } /// Creates a new SSL stream pub fn new(ctx: &SslContext, stream: S) -> Result, SslError> { let ssl = match Ssl::new(ctx) { Ok(ssl) => ssl, Err(err) => return Err(err) }; SslStream::new_from(ssl, 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) { ErrorWantRead => { try_ssl!(self.flush()); let len = try_ssl!(self.stream.read(self.buf.as_mut_slice())); self.ssl.get_rbio().write(self.buf.slice_to(len)); } ErrorWantWrite => { try_ssl!(self.flush()) } ErrorZeroReturn => return Err(SslSessionClosed), ErrorSsl => return Err(SslError::get()), _ => unreachable!() } } } 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::raw::from_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.slice_from(start)) }); 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() } }