Unverified Commit a523219f authored by Steven Fackler's avatar Steven Fackler Committed by GitHub
Browse files

Merge pull request #929 from marcoh00/nid-names 

Get Nid string representations
parents 4f3d72d9 2977f6ed

openssl-sys/src/lib.rs

+1 −0
Original line number Diff line number Diff line
@@ -2106,6 +2106,7 @@ extern "C" { 
        a: *const ASN1_OBJECT,

        no_name: c_int,

    ) -> c_int;

    pub fn OBJ_nid2ln(nid: c_int) -> *const c_char;

    pub fn OBJ_nid2sn(nid: c_int) -> *const c_char;

    pub fn OBJ_find_sigid_algs(signid: c_int, pdig_nid: *mut c_int, ppkey_nid: *mut c_int)

        -> c_int;

openssl/src/nid.rs

+63 −1
Original line number Diff line number Diff line 
//! A collection of numerical identifiers for OpenSSL objects.

use ffi;

use libc::c_int;

use libc::{c_int,c_char};

use std::ptr;



use std::ffi::CStr;

use std::str;



use error::ErrorStack;

use cvt_p;



/// A numerical identifier for an OpenSSL object.

///

/// Objects in OpenSSL can have a short name, a long name, and
@@ -57,6 +63,28 @@ impl Nid { 
        }

    }



    /// Return the string representation of a `Nid` (long)

    /// This corresponds to [`OBJ_nid2ln`]

    ///

    /// [`OBJ_nid2ln`]: https://www.openssl.org/docs/man1.1.0/crypto/OBJ_nid2ln.html

    pub fn long_name(&self) -> Result<&'static str, ErrorStack> {

        unsafe {

            cvt_p(ffi::OBJ_nid2ln(self.0) as *mut c_char)

                .map(|nameptr| str::from_utf8(CStr::from_ptr(nameptr).to_bytes()).unwrap())

        }

    }



    /// Return the string representation of a `Nid` (short)

    /// This corresponds to [`OBJ_nid2sn`]

    ///

    /// [`OBJ_nid2sn`]: https://www.openssl.org/docs/man1.1.0/crypto/OBJ_nid2sn.html

    pub fn short_name(&self) -> Result<&'static str, ErrorStack> {

        unsafe {

            cvt_p(ffi::OBJ_nid2sn(self.0) as *mut c_char)

                .map(|nameptr| str::from_utf8(CStr::from_ptr(nameptr).to_bytes()).unwrap())

        }

    }



    pub const UNDEF: Nid = Nid(ffi::NID_undef);

    pub const ITU_T: Nid = Nid(ffi::NID_itu_t);

    pub const CCITT: Nid = Nid(ffi::NID_ccitt);
@@ -1018,4 +1046,38 @@ mod test { 
            Some(Nid::SHA256)

        );

    }



    #[test]

    fn test_long_name_conversion() {

        let common_name = Nid::COMMONNAME;

        let organizational_unit_name = Nid::ORGANIZATIONALUNITNAME;

        let aes256_cbc_hmac_sha1 = Nid::AES_256_CBC_HMAC_SHA1;

        let id_cmc_lrapopwitness = Nid::ID_CMC_LRAPOPWITNESS;

        let ms_ctl_sign = Nid::MS_CTL_SIGN;

        let undefined_nid = Nid::from_raw(118);



        assert_eq!(common_name.long_name().unwrap(), "commonName");

        assert_eq!(organizational_unit_name.long_name().unwrap(), "organizationalUnitName");

        assert_eq!(aes256_cbc_hmac_sha1.long_name().unwrap(), "aes-256-cbc-hmac-sha1");

        assert_eq!(id_cmc_lrapopwitness.long_name().unwrap(), "id-cmc-lraPOPWitness");

        assert_eq!(ms_ctl_sign.long_name().unwrap(), "Microsoft Trust List Signing");

        assert!(undefined_nid.long_name().is_err(), "undefined_nid should not return a valid value");

    }



    #[test]

    fn test_short_name_conversion() {

        let common_name = Nid::COMMONNAME;

        let organizational_unit_name = Nid::ORGANIZATIONALUNITNAME;

        let aes256_cbc_hmac_sha1 = Nid::AES_256_CBC_HMAC_SHA1;

        let id_cmc_lrapopwitness = Nid::ID_CMC_LRAPOPWITNESS;

        let ms_ctl_sign = Nid::MS_CTL_SIGN;

        let undefined_nid = Nid::from_raw(118);



        assert_eq!(common_name.short_name().unwrap(), "CN");

        assert_eq!(organizational_unit_name.short_name().unwrap(), "OU");

        assert_eq!(aes256_cbc_hmac_sha1.short_name().unwrap(), "AES-256-CBC-HMAC-SHA1");

        assert_eq!(id_cmc_lrapopwitness.short_name().unwrap(), "id-cmc-lraPOPWitness");

        assert_eq!(ms_ctl_sign.short_name().unwrap(), "msCTLSign");

        assert!(undefined_nid.short_name().is_err(), "undefined_nid should not return a valid value");

    }

}