aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndy Gauge <[email protected]>2017-10-04 08:22:40 -0700
committerAndy Gauge <[email protected]>2017-10-04 08:22:40 -0700
commit040287dbb54b86ec633b22e00489dc4c6845d13c (patch)
tree5adf22e4cc9943cf770e95833e19deba503df315
parentCMS module documentation (diff)
downloadrust-openssl-040287dbb54b86ec633b22e00489dc4c6845d13c.tar.xz
rust-openssl-040287dbb54b86ec633b22e00489dc4c6845d13c.zip
Module level documentaiton rewrite
-rw-r--r--openssl/src/cms.rs11
1 files changed, 4 insertions, 7 deletions
diff --git a/openssl/src/cms.rs b/openssl/src/cms.rs
index 381b048d..6745e8a6 100644
--- a/openssl/src/cms.rs
+++ b/openssl/src/cms.rs
@@ -1,12 +1,9 @@
-//! SMIME implementation using CMS
+//! SMIME implementation using CMS
//!
//! CMS (PKCS#7) is an encyption standard. It allows signing and ecrypting data using
-//! X.509 certificates. cms is a command implemented in OpenSSL to support a
-//! SMIME upgrade to e-mail encryption. Changes to adding CMS to the SMIME implementation
-//! would break SMIME backwards compatbility so the authors of OpenSSL added the CMS
-//! keyword.
-//!
-//!
+//! X.509 certificates. The OpenSSL implementation of CMS is used in email encryption
+//! generated from a `Vec` of bytes. This `Vec` follows the smime protocol standards.
+//! Data accepted by this module will be smime type `enveloped-data`.
use ffi;
use foreign_types::{ForeignType, ForeignTypeRef};