From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=192.55.52.43; helo=mga05.intel.com; envelope-from=zhichao.gao@intel.com; receiver=edk2-devel@lists.01.org Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 03F36211E82E1 for ; Sun, 24 Mar 2019 21:01:20 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 24 Mar 2019 21:01:20 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,256,1549958400"; d="scan'208";a="310115880" Received: from gaozhic-mobl.ccr.corp.intel.com ([10.239.196.107]) by orsmga005.jf.intel.com with ESMTP; 24 Mar 2019 21:01:19 -0700 From: Zhichao Gao To: edk2-devel@lists.01.org Cc: Bret Barkelew , Ting Ye , Gang Wei , Wang Jian J , Liming Gao , Sean Brogan , Michael Turner Date: Mon, 25 Mar 2019 12:01:09 +0800 Message-Id: <20190325040113.18848-3-zhichao.gao@intel.com> X-Mailer: git-send-email 2.16.2.windows.1 In-Reply-To: <20190325040113.18848-1-zhichao.gao@intel.com> References: <20190325040113.18848-1-zhichao.gao@intel.com> Subject: [PATCH 2/6] CryptoPkg/BaseCryptLib: Add new API to get organization name X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 25 Mar 2019 04:01:21 -0000 From: Bret Barkelew REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1401 Implement a common function to get the NID name. And use this function to get common name and organization name. Add a null function API X509GetOrganizationName of null function source file. Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Zhichao Gao Cc: Ting Ye Cc: Gang Wei Cc: Wang Jian J Cc: Liming Gao Cc: Sean Brogan Cc: Michael Turner Cc: Bret Barkelew --- CryptoPkg/Library/BaseCryptLib/Pk/CryptX509.c | 102 +++++++++++++++++++--- CryptoPkg/Library/BaseCryptLib/Pk/CryptX509Null.c | 32 +++++++ 2 files changed, 122 insertions(+), 12 deletions(-) diff --git a/CryptoPkg/Library/BaseCryptLib/Pk/CryptX509.c b/CryptoPkg/Library/BaseCryptLib/Pk/CryptX509.c index 75337ed32b..bcdefabbb7 100644 --- a/CryptoPkg/Library/BaseCryptLib/Pk/CryptX509.c +++ b/CryptoPkg/Library/BaseCryptLib/Pk/CryptX509.c @@ -298,10 +298,11 @@ _Exit: } /** - Retrieve the common name (CN) string from one X.509 certificate. + Retrieve a string from one X.509 certificate base on the Request_NID. @param[in] Cert Pointer to the DER-encoded X509 certificate. @param[in] CertSize Size of the X509 certificate in bytes. + @param[in] Request_NID NID of string to obtain @param[out] CommonName Buffer to contain the retrieved certificate common name string (UTF8). At most CommonNameSize bytes will be written and the string will be null terminated. May be @@ -316,20 +317,21 @@ _Exit: If CommonNameSize is NULL. If CommonName is not NULL and *CommonNameSize is 0. If Certificate is invalid. - @retval RETURN_NOT_FOUND If no CommonName entry exists. + @retval RETURN_NOT_FOUND If no NID Name entry exists. @retval RETURN_BUFFER_TOO_SMALL If the CommonName is NULL. The required buffer size (including the final null) is returned in the CommonNameSize parameter. @retval RETURN_UNSUPPORTED The operation is not supported. **/ +STATIC RETURN_STATUS -EFIAPI -X509GetCommonName ( - IN CONST UINT8 *Cert, - IN UINTN CertSize, - OUT CHAR8 *CommonName, OPTIONAL - IN OUT UINTN *CommonNameSize +InternalX509GetNIDName ( + IN CONST UINT8 *Cert, + IN UINTN CertSize, + IN INT32 Request_NID, + OUT CHAR8 *CommonName, OPTIONAL + IN OUT UINTN *CommonNameSize ) { RETURN_STATUS ReturnStatus; @@ -381,12 +383,12 @@ X509GetCommonName ( } // - // Retrieve the CommonName information from X.509 Subject + // Retrive the string from X.509 Subject base on the Request_NID // - Index = X509_NAME_get_index_by_NID (X509Name, NID_commonName, -1); + Index = X509_NAME_get_index_by_NID (X509Name, Request_NID, -1); if (Index < 0) { // - // No CommonName entry exists in X509_NAME object + // No Request_NID name entry exists in X509_NAME object // *CommonNameSize = 0; ReturnStatus = RETURN_NOT_FOUND; @@ -408,7 +410,7 @@ X509GetCommonName ( Length = ASN1_STRING_to_UTF8 (&UTF8Name, EntryData); if (Length < 0) { // - // Fail to convert the commonName string + // Fail to convert the Name string // *CommonNameSize = 0; ReturnStatus = RETURN_INVALID_PARAMETER; @@ -439,6 +441,82 @@ _Exit: return ReturnStatus; } +/** + Retrieve the common name (CN) string from one X.509 certificate. + + @param[in] Cert Pointer to the DER-encoded X509 certificate. + @param[in] CertSize Size of the X509 certificate in bytes. + @param[out] CommonName Buffer to contain the retrieved certificate common + name string. At most CommonNameSize bytes will be + written and the string will be null terminated. May be + NULL in order to determine the size buffer needed. + @param[in,out] CommonNameSize The size in bytes of the CommonName buffer on input, + and the size of buffer returned CommonName on output. + If CommonName is NULL then the amount of space needed + in buffer (including the final null) is returned. + + @retval RETURN_SUCCESS The certificate CommonName retrieved successfully. + @retval RETURN_INVALID_PARAMETER If Cert is NULL. + If CommonNameSize is NULL. + If CommonName is not NULL and *CommonNameSize is 0. + If Certificate is invalid. + @retval RETURN_NOT_FOUND If no CommonName entry exists. + @retval RETURN_BUFFER_TOO_SMALL If the CommonName is NULL. The required buffer size + (including the final null) is returned in the + CommonNameSize parameter. + @retval RETURN_UNSUPPORTED The operation is not supported. + +**/ +RETURN_STATUS +EFIAPI +X509GetCommonName ( + IN CONST UINT8 *Cert, + IN UINTN CertSize, + OUT CHAR8 *CommonName, OPTIONAL + IN OUT UINTN *CommonNameSize + ) +{ + return InternalX509GetNIDName (Cert, CertSize, NID_commonName, CommonName, CommonNameSize); +} + +/** + Retrieve the organization name (ON) string from one X.509 certificate. + + @param[in] Cert Pointer to the DER-encoded X509 certificate. + @param[in] CertSize Size of the X509 certificate in bytes. + @param[out] NameBuffer Buffer to contain the retrieved certificate organization + name string. At most NameBufferSize bytes will be + written and the string will be null terminated. May be + NULL in order to determine the size buffer needed. + @param[in,out] NameBufferSize The size in bytes of the Name buffer on input, + and the size of buffer returned Name on output. + If NameBuffer is NULL then the amount of space needed + in buffer (including the final null) is returned. + + @retval RETURN_SUCCESS The certificate Organization Name retrieved successfully. + @retval RETURN_INVALID_PARAMETER If Cert is NULL. + If NameBufferSize is NULL. + If NameBuffer is not NULL and *CommonNameSize is 0. + If Certificate is invalid. + @retval RETURN_NOT_FOUND If no Organization Name entry exists. + @retval RETURN_BUFFER_TOO_SMALL If the NameBuffer is NULL. The required buffer size + (including the final null) is returned in the + CommonNameSize parameter. + @retval RETURN_UNSUPPORTED The operation is not supported. + +**/ +RETURN_STATUS +EFIAPI +X509GetOrganizationName ( + IN CONST UINT8 *Cert, + IN UINTN CertSize, + OUT CHAR8 *NameBuffer, OPTIONAL + IN OUT UINTN *NameBufferSize + ) +{ + return InternalX509GetNIDName (Cert, CertSize, NID_organizationName, NameBuffer, NameBufferSize); +} + /** Retrieve the RSA Public Key from one DER-encoded X509 certificate. diff --git a/CryptoPkg/Library/BaseCryptLib/Pk/CryptX509Null.c b/CryptoPkg/Library/BaseCryptLib/Pk/CryptX509Null.c index 31cae46154..cfbb02791f 100644 --- a/CryptoPkg/Library/BaseCryptLib/Pk/CryptX509Null.c +++ b/CryptoPkg/Library/BaseCryptLib/Pk/CryptX509Null.c @@ -159,6 +159,38 @@ X509GetCommonName ( return RETURN_UNSUPPORTED; } +/** + Retrieve the organization name (ON) string from one X.509 certificate. + + Return RETURN_UNSUPPORTED to indicate this interface is not supported. + + @param[in] Cert Pointer to the DER-encoded X509 certificate. + @param[in] CertSize Size of the X509 certificate in bytes. + @param[out] NameBuffer Buffer to contain the retrieved certificate organization + name string. At most NameBufferSize bytes will be + written and the string will be null terminated. May be + NULL in order to determine the size buffer needed. + @param[in,out] NameBufferSize The size in bytes of the Name buffer on input, + and the size of buffer returned Name on output. + If NameBuffer is NULL then the amount of space needed + in buffer (including the final null) is returned. + + @retval RETURN_UNSUPPORTED The operation is not supported. + +**/ +RETURN_STATUS +EFIAPI +X509GetOrganizationName ( + IN CONST UINT8 *Cert, + IN UINTN CertSize, + OUT CHAR8 *NameBuffer, OPTIONAL + IN OUT UINTN *NameBufferSize + ) +{ + ASSERT (FALSE); + return RETURN_UNSUPPORTED; +} + /** Retrieve the RSA Public Key from one DER-encoded X509 certificate. -- 2.16.2.windows.1