aboutsummaryrefslogtreecommitdiff
path: root/openssl/src/hash.rs
diff options
context:
space:
mode:
Diffstat (limited to 'openssl/src/hash.rs')
-rw-r--r--openssl/src/hash.rs324
1 files changed, 324 insertions, 0 deletions
diff --git a/openssl/src/hash.rs b/openssl/src/hash.rs
new file mode 100644
index 00000000..6a13371d
--- /dev/null
+++ b/openssl/src/hash.rs
@@ -0,0 +1,324 @@
+use std::io::prelude::*;
+use std::io;
+use ffi;
+
+#[cfg(ossl110)]
+use ffi::{EVP_MD_CTX_new, EVP_MD_CTX_free};
+#[cfg(any(ossl101, ossl102))]
+use ffi::{EVP_MD_CTX_create as EVP_MD_CTX_new, EVP_MD_CTX_destroy as EVP_MD_CTX_free};
+
+use {cvt, cvt_p};
+use error::ErrorStack;
+
+#[derive(Copy, Clone)]
+pub struct MessageDigest(*const ffi::EVP_MD);
+
+impl MessageDigest {
+ pub fn md5() -> MessageDigest {
+ unsafe { MessageDigest(ffi::EVP_md5()) }
+ }
+
+ pub fn sha1() -> MessageDigest {
+ unsafe { MessageDigest(ffi::EVP_sha1()) }
+ }
+
+ pub fn sha224() -> MessageDigest {
+ unsafe { MessageDigest(ffi::EVP_sha224()) }
+ }
+
+ pub fn sha256() -> MessageDigest {
+ unsafe { MessageDigest(ffi::EVP_sha256()) }
+ }
+
+ pub fn sha384() -> MessageDigest {
+ unsafe { MessageDigest(ffi::EVP_sha384()) }
+ }
+
+ pub fn sha512() -> MessageDigest {
+ unsafe { MessageDigest(ffi::EVP_sha512()) }
+ }
+
+ pub fn ripemd160() -> MessageDigest {
+ unsafe { MessageDigest(ffi::EVP_ripemd160()) }
+ }
+
+ pub fn as_ptr(&self) -> *const ffi::EVP_MD {
+ self.0
+ }
+}
+
+#[derive(PartialEq, Copy, Clone)]
+enum State {
+ Reset,
+ Updated,
+ Finalized,
+}
+
+use self::State::*;
+
+/// Provides message digest (hash) computation.
+///
+/// # Examples
+///
+/// Calculate a hash in one go.
+///
+/// ```
+/// use openssl::hash::{hash, MessageDigest};
+///
+/// let data = b"\x42\xF4\x97\xE0";
+/// let spec = b"\x7c\x43\x0f\x17\x8a\xef\xdf\x14\x87\xfe\xe7\x14\x4e\x96\x41\xe2";
+/// let res = hash(MessageDigest::md5(), data).unwrap();
+/// assert_eq!(res, spec);
+/// ```
+///
+/// Use the `Write` trait to supply the input in chunks.
+///
+/// ```
+/// use openssl::hash::{Hasher, MessageDigest};
+///
+/// let data = [b"\x42\xF4", b"\x97\xE0"];
+/// let spec = b"\x7c\x43\x0f\x17\x8a\xef\xdf\x14\x87\xfe\xe7\x14\x4e\x96\x41\xe2";
+/// let mut h = Hasher::new(MessageDigest::md5()).unwrap();
+/// h.update(data[0]).unwrap();
+/// h.update(data[1]).unwrap();
+/// let res = h.finish().unwrap();
+/// assert_eq!(res, spec);
+/// ```
+///
+/// # Warning
+///
+/// Don't actually use MD5 and SHA-1 hashes, they're not secure anymore.
+///
+/// Don't ever hash passwords, use the functions in the `pkcs5` module or bcrypt/scrypt instead.
+pub struct Hasher {
+ ctx: *mut ffi::EVP_MD_CTX,
+ md: *const ffi::EVP_MD,
+ type_: MessageDigest,
+ state: State,
+}
+
+impl Hasher {
+ /// Creates a new `Hasher` with the specified hash type.
+ pub fn new(ty: MessageDigest) -> Result<Hasher, ErrorStack> {
+ ffi::init();
+
+ let ctx = unsafe { try!(cvt_p(EVP_MD_CTX_new())) };
+
+ let mut h = Hasher {
+ ctx: ctx,
+ md: ty.as_ptr(),
+ type_: ty,
+ state: Finalized,
+ };
+ try!(h.init());
+ Ok(h)
+ }
+
+ fn init(&mut self) -> Result<(), ErrorStack> {
+ match self.state {
+ Reset => return Ok(()),
+ Updated => {
+ try!(self.finish());
+ }
+ Finalized => (),
+ }
+ unsafe {
+ try!(cvt(ffi::EVP_DigestInit_ex(self.ctx, self.md, 0 as *mut _)));
+ }
+ self.state = Reset;
+ Ok(())
+ }
+
+ /// Feeds data into the hasher.
+ pub fn update(&mut self, data: &[u8]) -> Result<(), ErrorStack> {
+ if self.state == Finalized {
+ try!(self.init());
+ }
+ unsafe {
+ try!(cvt(ffi::EVP_DigestUpdate(self.ctx, data.as_ptr() as *mut _, data.len())));
+ }
+ self.state = Updated;
+ Ok(())
+ }
+
+ /// Returns the hash of the data written since creation or
+ /// the last `finish` and resets the hasher.
+ pub fn finish(&mut self) -> Result<Vec<u8>, ErrorStack> {
+ if self.state == Finalized {
+ try!(self.init());
+ }
+ unsafe {
+ let mut len = ffi::EVP_MAX_MD_SIZE;
+ let mut res = vec![0; len as usize];
+ try!(cvt(ffi::EVP_DigestFinal_ex(self.ctx, res.as_mut_ptr(), &mut len)));
+ res.truncate(len as usize);
+ self.state = Finalized;
+ Ok(res)
+ }
+ }
+}
+
+impl Write for Hasher {
+ #[inline]
+ fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
+ try!(self.update(buf));
+ Ok(buf.len())
+ }
+
+ fn flush(&mut self) -> io::Result<()> {
+ Ok(())
+ }
+}
+
+impl Clone for Hasher {
+ fn clone(&self) -> Hasher {
+ let ctx = unsafe {
+ let ctx = EVP_MD_CTX_new();
+ assert!(!ctx.is_null());
+ let r = ffi::EVP_MD_CTX_copy_ex(ctx, self.ctx);
+ assert_eq!(r, 1);
+ ctx
+ };
+ Hasher {
+ ctx: ctx,
+ md: self.md,
+ type_: self.type_,
+ state: self.state,
+ }
+ }
+}
+
+impl Drop for Hasher {
+ fn drop(&mut self) {
+ unsafe {
+ if self.state != Finalized {
+ drop(self.finish());
+ }
+ EVP_MD_CTX_free(self.ctx);
+ }
+ }
+}
+
+/// Computes the hash of the `data` with the hash `t`.
+pub fn hash(t: MessageDigest, data: &[u8]) -> Result<Vec<u8>, ErrorStack> {
+ let mut h = try!(Hasher::new(t));
+ try!(h.update(data));
+ h.finish()
+}
+
+#[cfg(test)]
+mod tests {
+ use serialize::hex::{FromHex, ToHex};
+ use super::{hash, Hasher, MessageDigest};
+ use std::io::prelude::*;
+
+ fn hash_test(hashtype: MessageDigest, hashtest: &(&str, &str)) {
+ let res = hash(hashtype, &*hashtest.0.from_hex().unwrap()).unwrap();
+ assert_eq!(res.to_hex(), hashtest.1);
+ }
+
+ fn hash_recycle_test(h: &mut Hasher, hashtest: &(&str, &str)) {
+ let _ = h.write_all(&*hashtest.0.from_hex().unwrap()).unwrap();
+ let res = h.finish().unwrap();
+ assert_eq!(res.to_hex(), hashtest.1);
+ }
+
+ // Test vectors from http://www.nsrl.nist.gov/testdata/
+ #[allow(non_upper_case_globals)]
+ const md5_tests: [(&'static str, &'static str); 13] =
+ [("", "d41d8cd98f00b204e9800998ecf8427e"),
+ ("7F", "83acb6e67e50e31db6ed341dd2de1595"),
+ ("EC9C", "0b07f0d4ca797d8ac58874f887cb0b68"),
+ ("FEE57A", "e0d583171eb06d56198fc0ef22173907"),
+ ("42F497E0", "7c430f178aefdf1487fee7144e9641e2"),
+ ("C53B777F1C", "75ef141d64cb37ec423da2d9d440c925"),
+ ("89D5B576327B", "ebbaf15eb0ed784c6faa9dc32831bf33"),
+ ("5D4CCE781EB190", "ce175c4b08172019f05e6b5279889f2c"),
+ ("81901FE94932D7B9", "cd4d2f62b8cdb3a0cf968a735a239281"),
+ ("C9FFDEE7788EFB4EC9", "e0841a231ab698db30c6c0f3f246c014"),
+ ("66AC4B7EBA95E53DC10B", "a3b3cea71910d9af56742aa0bb2fe329"),
+ ("A510CD18F7A56852EB0319", "577e216843dd11573574d3fb209b97d8"),
+ ("AAED18DBE8938C19ED734A8D", "6f80fb775f27e0a4ce5c2f42fc72c5f1")];
+
+ #[test]
+ fn test_md5() {
+ for test in md5_tests.iter() {
+ hash_test(MessageDigest::md5(), test);
+ }
+ }
+
+ #[test]
+ fn test_md5_recycle() {
+ let mut h = Hasher::new(MessageDigest::md5()).unwrap();
+ for test in md5_tests.iter() {
+ hash_recycle_test(&mut h, test);
+ }
+ }
+
+ #[test]
+ fn test_finish_twice() {
+ let mut h = Hasher::new(MessageDigest::md5()).unwrap();
+ h.write_all(&*md5_tests[6].0.from_hex().unwrap()).unwrap();
+ h.finish().unwrap();
+ let res = h.finish().unwrap();
+ let null = hash(MessageDigest::md5(), &[]).unwrap();
+ assert_eq!(res, null);
+ }
+
+ #[test]
+ fn test_clone() {
+ let i = 7;
+ let inp = md5_tests[i].0.from_hex().unwrap();
+ assert!(inp.len() > 2);
+ let p = inp.len() / 2;
+ let h0 = Hasher::new(MessageDigest::md5()).unwrap();
+
+ println!("Clone a new hasher");
+ let mut h1 = h0.clone();
+ h1.write_all(&inp[..p]).unwrap();
+ {
+ println!("Clone an updated hasher");
+ let mut h2 = h1.clone();
+ h2.write_all(&inp[p..]).unwrap();
+ let res = h2.finish().unwrap();
+ assert_eq!(res.to_hex(), md5_tests[i].1);
+ }
+ h1.write_all(&inp[p..]).unwrap();
+ let res = h1.finish().unwrap();
+ assert_eq!(res.to_hex(), md5_tests[i].1);
+
+ println!("Clone a finished hasher");
+ let mut h3 = h1.clone();
+ h3.write_all(&*md5_tests[i + 1].0.from_hex().unwrap()).unwrap();
+ let res = h3.finish().unwrap();
+ assert_eq!(res.to_hex(), md5_tests[i + 1].1);
+ }
+
+ #[test]
+ fn test_sha1() {
+ let tests = [("616263", "a9993e364706816aba3e25717850c26c9cd0d89d")];
+
+ for test in tests.iter() {
+ hash_test(MessageDigest::sha1(), test);
+ }
+ }
+
+ #[test]
+ fn test_sha256() {
+ let tests = [("616263",
+ "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad")];
+
+ for test in tests.iter() {
+ hash_test(MessageDigest::sha256(), test);
+ }
+ }
+
+ #[test]
+ fn test_ripemd160() {
+ let tests = [("616263", "8eb208f7e05d987a9b044a8e98c6b087f15a0bfc")];
+
+ for test in tests.iter() {
+ hash_test(MessageDigest::ripemd160(), test);
+ }
+ }
+}