Commit 99d9fb9d authored by Nick Ashley's avatar Nick Ashley
Browse files

Some miscellaneous documentation fixes 

Mostly fixing typos, uncommon spellings, etc.
parent 16f65124

openssl/src/aes.rs

+1 −1
Original line number Diff line number Diff line
@@ -13,7 +13,7 @@ 
//! [`aes_ige`]: fn.aes_ige.html

//!

//! The [`symm`] module should be used in preference to this module in most cases.

//! The IGE block cypher is a non-traditional cipher mode.  More traditional AES

//! The IGE block cipher is a non-traditional cipher mode.  More traditional AES

//! encryption methods are found in the [`Crypter`] and [`Cipher`] structs.

//!

//! [`symm`]: ../symm/index.html

openssl/src/asn1.rs

+1 −1
Original line number Diff line number Diff line 
#![deny(missing_docs)]



//! Defines the format of certificiates

//! Defines the format of certificates

//!

//! This module is used by [`x509`] and other certificate building functions

//! to describe time, strings, and objects.

openssl/src/cms.rs

+1 −1
Original line number Diff line number Diff line
@@ -68,7 +68,7 @@ foreign_type_and_impl_send_sync! { 
}



impl CmsContentInfoRef {

    /// Given the sender's private key, `pkey` and the recipient's certificiate, `cert`,

    /// Given the sender's private key, `pkey` and the recipient's certificate, `cert`,

    /// decrypt the data in `self`.

    #[corresponds(CMS_decrypt)]

    pub fn decrypt<T>(&self, pkey: &PKeyRef<T>, cert: &X509) -> Result<Vec<u8>, ErrorStack>

openssl/src/dsa.rs

+1 −1
Original line number Diff line number Diff line
@@ -83,7 +83,7 @@ where 
    T: HasPublic,

{

    to_pem! {

        /// Serialies the public key into a PEM-encoded SubjectPublicKeyInfo structure.

        /// Serializes the public key into a PEM-encoded SubjectPublicKeyInfo structure.

        ///

        /// The output will have a header of `-----BEGIN PUBLIC KEY-----`.

        #[corresponds(PEM_write_bio_DSA_PUBKEY)]

openssl/src/ec.rs

+8 −8
Original line number Diff line number Diff line 
//! Elliptic Curve

//!

//! Cryptology relies on the difficulty of solving mathematical problems, such as the factor

//! Cryptography relies on the difficulty of solving mathematical problems, such as the factor

//! of large integers composed of two large prime numbers and the discrete logarithm of a

//! random eliptic curve.  This module provides low-level features of the latter.

//! random elliptic curve.  This module provides low-level features of the latter.

//! Elliptic Curve protocols can provide the same security with smaller keys.

//!

//! There are 2 forms of elliptic curves, `Fp` and `F2^m`.  These curves use irreducible

//! trinomial or pentanomial.  Being a generic interface to a wide range of algorithms,

//! the cuves are generally referenced by [`EcGroup`].  There are many built in groups

//! the curves are generally referenced by [`EcGroup`].  There are many built-in groups

//! found in [`Nid`].

//!

//! OpenSSL Wiki explains the fields and curves in detail at [Eliptic Curve Cryptography].

//! OpenSSL Wiki explains the fields and curves in detail at [Elliptic Curve Cryptography].

//!

//! [`EcGroup`]: struct.EcGroup.html

//! [`Nid`]: ../nid/struct.Nid.html
@@ -454,7 +454,7 @@ impl EcPointRef { 
        }

    }



    /// Place affine coordinates of a curve over a prime field in the provided

    /// Places affine coordinates of a curve over a prime field in the provided

    /// `x` and `y` `BigNum`s

    #[corresponds(EC_POINT_get_affine_coordinates_GFp)]

    pub fn affine_coordinates_gfp(
@@ -476,7 +476,7 @@ impl EcPointRef { 
        }

    }



    /// Place affine coordinates of a curve over a binary field in the provided

    /// Places affine coordinates of a curve over a binary field in the provided

    /// `x` and `y` `BigNum`s

    #[corresponds(EC_POINT_get_affine_coordinates_GF2m)]

    #[cfg(not(osslconf = "OPENSSL_NO_EC2M"))]
@@ -613,7 +613,7 @@ where 
    }



    to_pem! {

        /// Serialies the public key into a PEM-encoded SubjectPublicKeyInfo structure.

        /// Serializes the public key into a PEM-encoded SubjectPublicKeyInfo structure.

        ///

        /// The output will have a header of `-----BEGIN PUBLIC KEY-----`.

        #[corresponds(PEM_write_bio_EC_PUBKEY)]