Module level documentaiton rewrite

This commit is contained in:
Andy Gauge 2017-10-04 08:22:40 -07:00
parent 4e59fab753
commit 040287dbb5
1 changed files with 4 additions and 7 deletions

View File

@ -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 //! 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 //! X.509 certificates. The OpenSSL implementation of CMS is used in email encryption
//! SMIME upgrade to e-mail encryption. Changes to adding CMS to the SMIME implementation //! generated from a `Vec` of bytes. This `Vec` follows the smime protocol standards.
//! would break SMIME backwards compatbility so the authors of OpenSSL added the CMS //! Data accepted by this module will be smime type `enveloped-data`.
//! keyword.
//!
//!
use ffi; use ffi;
use foreign_types::{ForeignType, ForeignTypeRef}; use foreign_types::{ForeignType, ForeignTypeRef};