Unverified Commit 9584d98c authored by Alex Gaynor's avatar Alex Gaynor Committed by GitHub
Browse files

Merge pull request #2430 from alex/update-openssl-docs-urls 

Update OpenSSL documentation URLs to new docs.openssl.org domain
parents ae0407be 6c9a993c

openssl-macros/src/lib.rs

+1 −1
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ pub fn corresponds(attr: TokenStream, item: TokenStream) -> TokenStream { 


    let function = function.to_string();

    let line = format!(

        "This corresponds to [`{0}`](https://www.openssl.org/docs/manmaster/man3/{0}.html).",

        "This corresponds to [`{0}`](https://docs.openssl.org/master/man3/{0}/).",

        function

    );

openssl/src/asn1.rs

+6 −6
Original line number Diff line number Diff line
@@ -57,7 +57,7 @@ foreign_type_and_impl_send_sync! { 
    /// further details of implementation.  Note: these docs are from the master

    /// branch as documentation on the 1.1.0 branch did not include this page.

    ///

    /// [ASN1_GENERALIZEDTIME_set]: https://www.openssl.org/docs/manmaster/man3/ASN1_GENERALIZEDTIME_set.html

    /// [ASN1_GENERALIZEDTIME_set]: https://docs.openssl.org/master/man3/ASN1_GENERALIZEDTIME_set/

    pub struct Asn1GeneralizedTime;

    /// Reference to a [`Asn1GeneralizedTime`]

    ///
@@ -187,7 +187,7 @@ foreign_type_and_impl_send_sync! { 
    /// [ASN_TIME_set] documentation at OpenSSL explains the ASN.1 implementation

    /// used by OpenSSL.

    ///

    /// [ASN_TIME_set]: https://www.openssl.org/docs/manmaster/crypto/ASN1_TIME_set.html

    /// [ASN_TIME_set]: https://docs.openssl.org/master/man3/ASN1_TIME_set/

    pub struct Asn1Time;

    /// Reference to an [`Asn1Time`]

    ///
@@ -423,7 +423,7 @@ foreign_type_and_impl_send_sync! { 
    /// structures.  This implementation uses [ASN1_STRING-to_UTF8] to preserve

    /// compatibility with Rust's String.

    ///

    /// [ASN1_STRING-to_UTF8]: https://www.openssl.org/docs/manmaster/crypto/ASN1_STRING_to_UTF8.html

    /// [ASN1_STRING-to_UTF8]: https://docs.openssl.org/master/man3/ASN1_STRING_to_UTF8/

    pub struct Asn1String;

    /// A reference to an [`Asn1String`].

    pub struct Asn1StringRef;
@@ -492,7 +492,7 @@ foreign_type_and_impl_send_sync! { 
    /// OpenSSL documentation includes [`ASN1_INTEGER_set`].

    ///

    /// [`bn`]: ../bn/index.html

    /// [`ASN1_INTEGER_set`]: https://www.openssl.org/docs/manmaster/crypto/ASN1_INTEGER_set.html

    /// [`ASN1_INTEGER_set`]: https://docs.openssl.org/master/man3/ASN1_INTEGER_set/

    pub struct Asn1Integer;

    /// A reference to an [`Asn1Integer`].

    pub struct Asn1IntegerRef;
@@ -504,7 +504,7 @@ impl Asn1Integer { 
    /// Corresponds to [`BN_to_ASN1_INTEGER`]. Also see

    /// [`BigNumRef::to_asn1_integer`].

    ///

    /// [`BN_to_ASN1_INTEGER`]: https://www.openssl.org/docs/manmaster/crypto/BN_to_ASN1_INTEGER.html

    /// [`BN_to_ASN1_INTEGER`]: https://docs.openssl.org/master/man3/BN_to_ASN1_INTEGER/

    /// [`BigNumRef::to_asn1_integer`]: ../bn/struct.BigNumRef.html#method.to_asn1_integer

    pub fn from_bn(bn: &BigNumRef) -> Result<Self, ErrorStack> {

        bn.to_asn1_integer()
@@ -668,7 +668,7 @@ foreign_type_and_impl_send_sync! { 
    ///

    /// [`Nid`]: ../nid/index.html

    /// [`nid::COMMONNAME`]: ../nid/constant.COMMONNAME.html

    /// [`OBJ_nid2obj`]: https://www.openssl.org/docs/manmaster/crypto/OBJ_obj2nid.html

    /// [`OBJ_nid2obj`]: https://docs.openssl.org/master/man3/OBJ_obj2nid/

    pub struct Asn1Object;

    /// A reference to an [`Asn1Object`].

    pub struct Asn1ObjectRef;

openssl/src/bn.rs

+2 −6
Original line number Diff line number Diff line
@@ -101,7 +101,7 @@ foreign_type_and_impl_send_sync! { 
    /// to allocate.  BigNumContext and the OpenSSL [`BN_CTX`] structure are used

    /// internally when passing BigNum values between subroutines.

    ///

    /// [`BN_CTX`]: https://www.openssl.org/docs/manmaster/crypto/BN_CTX_new.html

    /// [`BN_CTX`]: https://docs.openssl.org/master/man3/BN_CTX_new/

    pub struct BigNumContext;

    /// Reference to [`BigNumContext`]

    ///
@@ -144,7 +144,7 @@ foreign_type_and_impl_send_sync! { 
    ///

    /// [`new`]: struct.BigNum.html#method.new

    /// [`Dref<Target = BigNumRef>`]: struct.BigNum.html#deref-methods

    /// [`BN_new`]: https://www.openssl.org/docs/manmaster/crypto/BN_new.html

    /// [`BN_new`]: https://docs.openssl.org/master/man3/BN_new/

    ///

    /// # Examples

    /// ```
@@ -1104,10 +1104,6 @@ impl BigNum { 


    /// Creates a new `BigNum` from an unsigned, big-endian encoded number of arbitrary length.

    ///

    /// OpenSSL documentation at [`BN_bin2bn`]

    ///

    /// [`BN_bin2bn`]: https://www.openssl.org/docs/manmaster/crypto/BN_bin2bn.html

    ///

    /// ```

    /// # use openssl::bn::BigNum;

    /// let bignum = BigNum::from_slice(&[0x12, 0x00, 0x34]).unwrap();

openssl/src/cms.rs

+0 −3
Original line number Diff line number Diff line
@@ -206,9 +206,6 @@ impl CmsContentInfo { 
    /// Given a certificate stack `certs`, data `data`, cipher `cipher` and flags `flags`,

    /// create a CmsContentInfo struct.

    ///

    /// OpenSSL documentation at [`CMS_encrypt`]

    ///

    /// [`CMS_encrypt`]: https://www.openssl.org/docs/manmaster/man3/CMS_encrypt.html

    #[corresponds(CMS_encrypt)]

    pub fn encrypt(

        certs: &StackRef<X509>,

openssl/src/derive.rs

+4 −10
Original line number Diff line number Diff line
@@ -67,10 +67,7 @@ unsafe impl Send for Deriver<'_> {} 
#[allow(clippy::len_without_is_empty)]

impl<'a> Deriver<'a> {

    /// Creates a new `Deriver` using the provided private key.

    ///

    /// This corresponds to [`EVP_PKEY_derive_init`].

    ///

    /// [`EVP_PKEY_derive_init`]: https://www.openssl.org/docs/manmaster/crypto/EVP_PKEY_derive_init.html

    #[corresponds(EVP_PKEY_derive_init)]

    pub fn new<T>(key: &'a PKeyRef<T>) -> Result<Deriver<'a>, ErrorStack>

    where

        T: HasPrivate,
@@ -118,10 +115,10 @@ impl<'a> Deriver<'a> { 
    ///

    /// It can be used to size the buffer passed to [`Deriver::derive`].

    ///

    /// This corresponds to [`EVP_PKEY_derive`].

    /// It can be used to size the buffer passed to [`Deriver::derive`].

    ///

    /// [`Deriver::derive`]: #method.derive

    /// [`EVP_PKEY_derive`]: https://www.openssl.org/docs/manmaster/crypto/EVP_PKEY_derive_init.html

    #[corresponds(EVP_PKEY_derive)]

    pub fn len(&mut self) -> Result<usize, ErrorStack> {

        unsafe {

            let mut len = 0;
@@ -132,10 +129,7 @@ impl<'a> Deriver<'a> { 
    /// Derives a shared secret between the two keys, writing it into the buffer.

    ///

    /// Returns the number of bytes written.

    ///

    /// This corresponds to [`EVP_PKEY_derive`].

    ///

    /// [`EVP_PKEY_derive`]: https://www.openssl.org/docs/manmaster/crypto/EVP_PKEY_derive_init.html

    #[corresponds(EVP_PKEY_derive)]

    pub fn derive(&mut self, buf: &mut [u8]) -> Result<usize, ErrorStack> {

        let mut len = buf.len();

        unsafe {