From 64106c4d3d4ddba8c7bc2af75376e6d3d3d75601 Mon Sep 17 00:00:00 2001 From: Date: Mon, 29 Jun 2015 20:16:15 +0000 Subject: Update documentation --- openssl/crypto/hmac/fn.hmac.html | 102 ++++++++++++++++++++++++ openssl/crypto/hmac/index.html | 121 +++++++++++++++++++++++++++++ openssl/crypto/hmac/sidebar-items.js | 1 + openssl/crypto/hmac/struct.HMAC.html | 146 +++++++++++++++++++++++++++++++++++ 4 files changed, 370 insertions(+) create mode 100644 openssl/crypto/hmac/fn.hmac.html create mode 100644 openssl/crypto/hmac/index.html create mode 100644 openssl/crypto/hmac/sidebar-items.js create mode 100644 openssl/crypto/hmac/struct.HMAC.html (limited to 'openssl/crypto/hmac') diff --git a/openssl/crypto/hmac/fn.hmac.html b/openssl/crypto/hmac/fn.hmac.html new file mode 100644 index 0000000..a9af0d5 --- /dev/null +++ b/openssl/crypto/hmac/fn.hmac.html @@ -0,0 +1,102 @@ + + + + + + + + + + openssl::crypto::hmac::hmac - Rust + + + + + + + + + + + +
+ +

openssl::crypto::hmac

+
+ + + +
+

Function openssl::crypto::hmac::hmac + + [−] + + [src]

+
pub fn hmac(t: Type, key: &[u8], data: &[u8]) -> Vec<u8>

Computes the HMAC of the data with the hash t and key.

+
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/openssl/crypto/hmac/index.html b/openssl/crypto/hmac/index.html new file mode 100644 index 0000000..b00fe49 --- /dev/null +++ b/openssl/crypto/hmac/index.html @@ -0,0 +1,121 @@ + + + + + + + + + + openssl::crypto::hmac - Rust + + + + + + + + + + + +
+ +

openssl::crypto

+
+ + + +
+

Module openssl::crypto::hmac + + [−] + + [src]

+

Structs

+ + + + + +
HMAC +

Provides HMAC computation.

+ +

Functions

+ + + + + +
hmac +

Computes the HMAC of the data with the hash t and key.

+ +
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/openssl/crypto/hmac/sidebar-items.js b/openssl/crypto/hmac/sidebar-items.js new file mode 100644 index 0000000..eeb5a4b --- /dev/null +++ b/openssl/crypto/hmac/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"fn":[["hmac","Computes the HMAC of the `data` with the hash `t` and `key`."]],"struct":[["HMAC","Provides HMAC computation."]]}); \ No newline at end of file diff --git a/openssl/crypto/hmac/struct.HMAC.html b/openssl/crypto/hmac/struct.HMAC.html new file mode 100644 index 0000000..4f062e2 --- /dev/null +++ b/openssl/crypto/hmac/struct.HMAC.html @@ -0,0 +1,146 @@ + + + + + + + + + + openssl::crypto::hmac::HMAC - Rust + + + + + + + + + + + +
+ +

openssl::crypto::hmac

+
+ + + +
+

Struct openssl::crypto::hmac::HMAC + + [−] + + [src]

+
pub struct HMAC {
+    // some fields omitted
+}

Provides HMAC computation.

+ +

Examples

+

Calculate a HMAC in one go.

+
+use openssl::crypto::hash::Type;
+use openssl::crypto::hmac::hmac;
+let key = b"Jefe";
+let data = b"what do ya want for nothing?";
+let spec = b"\x75\x0c\x78\x3e\x6a\xb0\xb5\x03\xea\xa8\x6e\x31\x0a\x5d\xb7\x38";
+let res = hmac(Type::MD5, key, data);
+assert_eq!(res, spec);
+
+ +

Use the Write trait to supply the input in chunks.

+
+use std::io::prelude::*;
+use openssl::crypto::hash::Type;
+use openssl::crypto::hmac::HMAC;
+let key = b"Jefe";
+let data: &[&[u8]] = &[b"what do ya ", b"want for nothing?"];
+let spec = b"\x75\x0c\x78\x3e\x6a\xb0\xb5\x03\xea\xa8\x6e\x31\x0a\x5d\xb7\x38";
+let mut h = HMAC::new(Type::MD5, &*key);
+h.write_all(data[0]);
+h.write_all(data[1]);
+let res = h.finish();
+assert_eq!(res, spec);
+
+

Methods

impl HMAC

fn new(ty: Type, key: &[u8]) -> HMAC

+

Creates a new HMAC with the specified hash type using the key.

+

fn finish(&mut self) -> Vec<u8>

+

Returns the hash of the data written since creation or +the last finish and resets the hasher.

+

Trait Implementations

impl Write for HMAC

fn write(&mut self, buf: &[u8]) -> Result<usize>

+

fn flush(&mut self) -> Result<()>

+

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

+

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

+

fn by_ref(&mut self) -> &mut Self

+

fn broadcast<W>(self, other: W) -> Broadcast<Self, W> where W: Write

+

impl Clone for HMAC

fn clone(&self) -> HMAC

+

fn clone_from(&mut self, source: &Self)

+

impl Drop for HMAC

fn drop(&mut self)

+
+ + +
+ + + + + + + + + + + + \ No newline at end of file -- cgit v1.2.3