1. Patchew
  2. EDK2
  3. [edk2-devel] [PATCH v2 0/8] support server identity validation in HTTPS Boot (CVE-2019-14553)
  4. View patch

[edk2-devel] [PATCH v2 1/8] MdePkg/Include/Protocol/Tls.h: Add the data type of EfiTlsVerifyHost (CVE-2019-14553)

Laszlo Ersek posted 8 patches 6 years, 3 months ago
[edk2-devel] [PATCH v2 1/8] MdePkg/Include/Protocol/Tls.h: Add the data type of EfiTlsVerifyHost (CVE-2019-14553)
Posted by Laszlo Ersek 6 years, 3 months ago 
From: "Wu, Jiaxin" <jiaxin.wu@intel.com>

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=960
CVE: CVE-2019-14553
In the patch, we add the new data type named "EfiTlsVerifyHost" and
the EFI_TLS_VERIFY_HOST_FLAG for the TLS protocol consumer (HTTP)
to enable the host name check so as to avoid the potential
Man-In-The-Middle attack.

Signed-off-by: Wu Jiaxin <jiaxin.wu@intel.com>
Reviewed-by: Ye Ting <ting.ye@intel.com>
Reviewed-by: Long Qin <qin.long@intel.com>
Reviewed-by: Fu Siyuan <siyuan.fu@intel.com>
Acked-by: Laszlo Ersek <lersek@redhat.com>
Message-Id: <20190927034441.3096-2-Jiaxin.wu@intel.com>
Cc: David Woodhouse <dwmw2@infradead.org>
Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Jiaxin Wu <jiaxin.wu@intel.com>
Cc: Sivaraman Nainar <sivaramann@amiindia.co.in>
Cc: Xiaoyu Lu <xiaoyux.lu@intel.com>
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
---

Notes:
    v2:
    - fix whitespace in subject line
    - drop Contributed-under line per BZ#1373

 MdePkg/Include/Protocol/Tls.h | 68 ++++++++++++++++----
 1 file changed, 57 insertions(+), 11 deletions(-)

diff --git a/MdePkg/Include/Protocol/Tls.h b/MdePkg/Include/Protocol/Tls.h
index bf1b6727a1e9..af524ae2a60e 100644
--- a/MdePkg/Include/Protocol/Tls.h
+++ b/MdePkg/Include/Protocol/Tls.h
@@ -40,12 +40,8 @@ typedef struct _EFI_TLS_PROTOCOL EFI_TLS_PROTOCOL;
 ///
 /// EFI_TLS_SESSION_DATA_TYPE
 ///
 typedef enum {
-  ///
-  /// Session Configuration
-  ///
-
   ///
   /// TLS session Version. The corresponding Data is of type EFI_TLS_VERSION.
   ///
   EfiTlsVersion,
@@ -85,13 +81,8 @@ typedef enum {
   /// TLS session data session state.
   /// The corresponding Data is of type EFI_TLS_SESSION_STATE.
   ///
   EfiTlsSessionState,
-
-  ///
-  /// Session information
-  ///
-
   ///
   /// TLS session data client random.
   /// The corresponding Data is of type EFI_TLS_RANDOM.
   ///
@@ -105,11 +96,17 @@ typedef enum {
   /// TLS session data key material.
   /// The corresponding Data is of type EFI_TLS_MASTER_SECRET.
   ///
   EfiTlsKeyMaterial,
+  ///
+  /// TLS session hostname for validation which is used to verify whether the name
+  /// within the peer certificate matches a given host name.
+  /// This parameter is invalid when EfiTlsVerifyMethod is EFI_TLS_VERIFY_NONE.
+  /// The corresponding Data is of type EFI_TLS_VERIFY_HOST.
+  ///
+  EfiTlsVerifyHost,
 
   EfiTlsSessionDataTypeMaximum
-
 } EFI_TLS_SESSION_DATA_TYPE;
 
 ///
 /// EFI_TLS_VERSION
@@ -177,17 +174,66 @@ typedef UINT32  EFI_TLS_VERIFY;
 /// the reason for the certificate verification failure.
 ///
 #define EFI_TLS_VERIFY_PEER                  0x1
 ///
-/// TLS session will fail peer certificate is absent.
+/// EFI_TLS_VERIFY_FAIL_IF_NO_PEER_CERT is only meaningful in the server mode.
+/// TLS session will fail if client certificate is absent.
 ///
 #define EFI_TLS_VERIFY_FAIL_IF_NO_PEER_CERT  0x2
 ///
 /// TLS session only verify client once, and doesn't request certificate during
 /// re-negotiation.
 ///
 #define EFI_TLS_VERIFY_CLIENT_ONCE           0x4
 
+///
+/// EFI_TLS_VERIFY_HOST_FLAG
+///
+typedef UINT32 EFI_TLS_VERIFY_HOST_FLAG;
+///
+/// There is no additional flags set for hostname validation.
+/// Wildcards are supported and they match only in the left-most label.
+///
+#define EFI_TLS_VERIFY_FLAG_NONE                    0x00
+///
+/// Always check the Subject Distinguished Name (DN) in the peer certificate even if the
+/// certificate contains Subject Alternative Name (SAN).
+///
+#define EFI_TLS_VERIFY_FLAG_ALWAYS_CHECK_SUBJECT    0x01
+///
+/// Disable the match of all wildcards.
+///
+#define EFI_TLS_VERIFY_FLAG_NO_WILDCARDS            0x02
+///
+/// Disable the "*" as wildcard in labels that have a prefix or suffix (e.g. "www*" or "*www").
+///
+#define EFI_TLS_VERIFY_FLAG_NO_PARTIAL_WILDCARDS    0x04
+///
+/// Allow the "*" to match more than one labels. Otherwise, only matches a single label.
+///
+#define EFI_TLS_VERIFY_FLAG_MULTI_LABEL_WILDCARDS   0x08
+///
+/// Restrict to only match direct child sub-domains which start with ".".
+/// For example, a name of ".example.com" would match "www.example.com" with this flag,
+/// but would not match "www.sub.example.com".
+///
+#define EFI_TLS_VERIFY_FLAG_SINGLE_LABEL_SUBDOMAINS 0x10
+///
+/// Never check the Subject Distinguished Name (DN) even there is no
+/// Subject Alternative Name (SAN) in the certificate.
+///
+#define EFI_TLS_VERIFY_FLAG_NEVER_CHECK_SUBJECT     0x20
+
+///
+/// EFI_TLS_VERIFY_HOST
+///
+#pragma pack (1)
+typedef struct {
+  EFI_TLS_VERIFY_HOST_FLAG Flags;
+  CHAR8                    *HostName;
+} EFI_TLS_VERIFY_HOST;
+#pragma pack ()
+
 ///
 /// EFI_TLS_RANDOM
 /// Note: The definition of EFI_TLS_RANDOM is from "RFC 5246 A.4.1.
 ///       Hello Messages".
-- 
2.19.1.3.g30247aa5d201



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#49463): https://edk2.groups.io/g/devel/message/49463
Mute This Topic: https://groups.io/mt/37952585/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH v2 1/8] MdePkg/Include/Protocol/Tls.h: Add the data type of EfiTlsVerifyHost (CVE-2019-14553)
Posted by Liming Gao 6 years, 3 months ago 
Reviewed-by: Liming Gao <liming.gao@intel.com>

>-----Original Message-----
>From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
>Laszlo Ersek
>Sent: Saturday, October 26, 2019 1:37 PM
>To: edk2-devel-groups-io <devel@edk2.groups.io>
>Cc: David Woodhouse <dwmw2@infradead.org>; Wang, Jian J
><jian.j.wang@intel.com>; Wu, Jiaxin <jiaxin.wu@intel.com>; Sivaraman
>Nainar <sivaramann@amiindia.co.in>; Lu, XiaoyuX <xiaoyux.lu@intel.com>
>Subject: [edk2-devel] [PATCH v2 1/8] MdePkg/Include/Protocol/Tls.h: Add
>the data type of EfiTlsVerifyHost (CVE-2019-14553)
>
>From: "Wu, Jiaxin" <jiaxin.wu@intel.com>
>
>REF: https://bugzilla.tianocore.org/show_bug.cgi?id=960
>CVE: CVE-2019-14553
>In the patch, we add the new data type named "EfiTlsVerifyHost" and
>the EFI_TLS_VERIFY_HOST_FLAG for the TLS protocol consumer (HTTP)
>to enable the host name check so as to avoid the potential
>Man-In-The-Middle attack.
>
>Signed-off-by: Wu Jiaxin <jiaxin.wu@intel.com>
>Reviewed-by: Ye Ting <ting.ye@intel.com>
>Reviewed-by: Long Qin <qin.long@intel.com>
>Reviewed-by: Fu Siyuan <siyuan.fu@intel.com>
>Acked-by: Laszlo Ersek <lersek@redhat.com>
>Message-Id: <20190927034441.3096-2-Jiaxin.wu@intel.com>
>Cc: David Woodhouse <dwmw2@infradead.org>
>Cc: Jian J Wang <jian.j.wang@intel.com>
>Cc: Jiaxin Wu <jiaxin.wu@intel.com>
>Cc: Sivaraman Nainar <sivaramann@amiindia.co.in>
>Cc: Xiaoyu Lu <xiaoyux.lu@intel.com>
>Signed-off-by: Laszlo Ersek <lersek@redhat.com>
>---
>
>Notes:
>    v2:
>    - fix whitespace in subject line
>    - drop Contributed-under line per BZ#1373
>
> MdePkg/Include/Protocol/Tls.h | 68 ++++++++++++++++----
> 1 file changed, 57 insertions(+), 11 deletions(-)
>
>diff --git a/MdePkg/Include/Protocol/Tls.h b/MdePkg/Include/Protocol/Tls.h
>index bf1b6727a1e9..af524ae2a60e 100644
>--- a/MdePkg/Include/Protocol/Tls.h
>+++ b/MdePkg/Include/Protocol/Tls.h
>@@ -40,12 +40,8 @@ typedef struct _EFI_TLS_PROTOCOL
>EFI_TLS_PROTOCOL;
> ///
> /// EFI_TLS_SESSION_DATA_TYPE
> ///
> typedef enum {
>-  ///
>-  /// Session Configuration
>-  ///
>-
>   ///
>   /// TLS session Version. The corresponding Data is of type EFI_TLS_VERSION.
>   ///
>   EfiTlsVersion,
>@@ -85,13 +81,8 @@ typedef enum {
>   /// TLS session data session state.
>   /// The corresponding Data is of type EFI_TLS_SESSION_STATE.
>   ///
>   EfiTlsSessionState,
>-
>-  ///
>-  /// Session information
>-  ///
>-
>   ///
>   /// TLS session data client random.
>   /// The corresponding Data is of type EFI_TLS_RANDOM.
>   ///
>@@ -105,11 +96,17 @@ typedef enum {
>   /// TLS session data key material.
>   /// The corresponding Data is of type EFI_TLS_MASTER_SECRET.
>   ///
>   EfiTlsKeyMaterial,
>+  ///
>+  /// TLS session hostname for validation which is used to verify whether the
>name
>+  /// within the peer certificate matches a given host name.
>+  /// This parameter is invalid when EfiTlsVerifyMethod is
>EFI_TLS_VERIFY_NONE.
>+  /// The corresponding Data is of type EFI_TLS_VERIFY_HOST.
>+  ///
>+  EfiTlsVerifyHost,
>
>   EfiTlsSessionDataTypeMaximum
>-
> } EFI_TLS_SESSION_DATA_TYPE;
>
> ///
> /// EFI_TLS_VERSION
>@@ -177,17 +174,66 @@ typedef UINT32  EFI_TLS_VERIFY;
> /// the reason for the certificate verification failure.
> ///
> #define EFI_TLS_VERIFY_PEER                  0x1
> ///
>-/// TLS session will fail peer certificate is absent.
>+/// EFI_TLS_VERIFY_FAIL_IF_NO_PEER_CERT is only meaningful in the server
>mode.
>+/// TLS session will fail if client certificate is absent.
> ///
> #define EFI_TLS_VERIFY_FAIL_IF_NO_PEER_CERT  0x2
> ///
> /// TLS session only verify client once, and doesn't request certificate during
> /// re-negotiation.
> ///
> #define EFI_TLS_VERIFY_CLIENT_ONCE           0x4
>
>+///
>+/// EFI_TLS_VERIFY_HOST_FLAG
>+///
>+typedef UINT32 EFI_TLS_VERIFY_HOST_FLAG;
>+///
>+/// There is no additional flags set for hostname validation.
>+/// Wildcards are supported and they match only in the left-most label.
>+///
>+#define EFI_TLS_VERIFY_FLAG_NONE                    0x00
>+///
>+/// Always check the Subject Distinguished Name (DN) in the peer certificate
>even if the
>+/// certificate contains Subject Alternative Name (SAN).
>+///
>+#define EFI_TLS_VERIFY_FLAG_ALWAYS_CHECK_SUBJECT    0x01
>+///
>+/// Disable the match of all wildcards.
>+///
>+#define EFI_TLS_VERIFY_FLAG_NO_WILDCARDS            0x02
>+///
>+/// Disable the "*" as wildcard in labels that have a prefix or suffix (e.g.
>"www*" or "*www").
>+///
>+#define EFI_TLS_VERIFY_FLAG_NO_PARTIAL_WILDCARDS    0x04
>+///
>+/// Allow the "*" to match more than one labels. Otherwise, only matches a
>single label.
>+///
>+#define EFI_TLS_VERIFY_FLAG_MULTI_LABEL_WILDCARDS   0x08
>+///
>+/// Restrict to only match direct child sub-domains which start with ".".
>+/// For example, a name of ".example.com" would match
>"www.example.com" with this flag,
>+/// but would not match "www.sub.example.com".
>+///
>+#define EFI_TLS_VERIFY_FLAG_SINGLE_LABEL_SUBDOMAINS 0x10
>+///
>+/// Never check the Subject Distinguished Name (DN) even there is no
>+/// Subject Alternative Name (SAN) in the certificate.
>+///
>+#define EFI_TLS_VERIFY_FLAG_NEVER_CHECK_SUBJECT     0x20
>+
>+///
>+/// EFI_TLS_VERIFY_HOST
>+///
>+#pragma pack (1)
>+typedef struct {
>+  EFI_TLS_VERIFY_HOST_FLAG Flags;
>+  CHAR8                    *HostName;
>+} EFI_TLS_VERIFY_HOST;
>+#pragma pack ()
>+
> ///
> /// EFI_TLS_RANDOM
> /// Note: The definition of EFI_TLS_RANDOM is from "RFC 5246 A.4.1.
> ///       Hello Messages".
>--
>2.19.1.3.g30247aa5d201
>
>
>
>


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#49544): https://edk2.groups.io/g/devel/message/49544
Mute This Topic: https://groups.io/mt/37952585/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Patchew 2.1-devel-b67e4c2

© 2016 - 2026 Red Hat, Inc.