Blame SOURCES/0094-efinet-Setting-DNS-server-from-UEFI-protocol.patch

5593c8
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
5593c8
From: Michael Chang <mchang@suse.com>
5593c8
Date: Thu, 14 Jul 2016 17:48:45 +0800
5593c8
Subject: [PATCH] efinet: Setting DNS server from UEFI protocol
5593c8
5593c8
In the URI device path node, any name rahter than address can be used for
5593c8
looking up the resources so that DNS service become needed to get answer of the
5593c8
name's address. Unfortunately the DNS is not defined in any of the device path
5593c8
nodes so that we use the EFI_IP4_CONFIG2_PROTOCOL and EFI_IP6_CONFIG_PROTOCOL
5593c8
to obtain it.
5593c8
5593c8
These two protcols are defined the sections of UEFI specification.
5593c8
5593c8
 27.5 EFI IPv4 Configuration II Protocol
5593c8
 27.7 EFI IPv6 Configuration Protocol
5593c8
5593c8
include/grub/efi/api.h:
5593c8
Add new structure and protocol UUID of EFI_IP4_CONFIG2_PROTOCOL and
5593c8
EFI_IP6_CONFIG_PROTOCOL.
5593c8
5593c8
grub-core/net/drivers/efi/efinet.c:
5593c8
Use the EFI_IP4_CONFIG2_PROTOCOL and EFI_IP6_CONFIG_PROTOCOL to obtain the list
5593c8
of DNS server address for IPv4 and IPv6 respectively. The address of DNS
5593c8
servers is structured into DHCPACK packet and feed into the same DHCP packet
5593c8
processing functions to ensure the network interface is setting up the same way
5593c8
it used to be.
5593c8
5593c8
Signed-off-by: Michael Chang <mchang@suse.com>
5593c8
Signed-off-by: Ken Lin <ken.lin@hpe.com>
5593c8
---
5593c8
 grub-core/net/drivers/efi/efinet.c | 163 +++++++++++++++++++++++++++++++++++++
5593c8
 include/grub/efi/api.h             |  75 +++++++++++++++++
5593c8
 2 files changed, 238 insertions(+)
5593c8
5593c8
diff --git a/grub-core/net/drivers/efi/efinet.c b/grub-core/net/drivers/efi/efinet.c
d3c3ab
index 8171ecaa5e4..715a6168d77 100644
5593c8
--- a/grub-core/net/drivers/efi/efinet.c
5593c8
+++ b/grub-core/net/drivers/efi/efinet.c
5593c8
@@ -33,6 +33,8 @@ GRUB_MOD_LICENSE ("GPLv3+");
5593c8
 /* GUID.  */
5593c8
 static grub_efi_guid_t net_io_guid = GRUB_EFI_SIMPLE_NETWORK_GUID;
5593c8
 static grub_efi_guid_t pxe_io_guid = GRUB_EFI_PXE_GUID;
5593c8
+static grub_efi_guid_t ip4_config_guid = GRUB_EFI_IP4_CONFIG2_PROTOCOL_GUID;
5593c8
+static grub_efi_guid_t ip6_config_guid = GRUB_EFI_IP6_CONFIG_PROTOCOL_GUID;
5593c8
 
5593c8
 static grub_err_t
5593c8
 send_card_buffer (struct grub_net_card *dev,
5593c8
@@ -332,6 +334,125 @@ grub_efinet_findcards (void)
5593c8
   grub_free (handles);
5593c8
 }
5593c8
 
5593c8
+static grub_efi_handle_t
5593c8
+grub_efi_locate_device_path (grub_efi_guid_t *protocol, grub_efi_device_path_t *device_path,
5593c8
+			    grub_efi_device_path_t **r_device_path)
5593c8
+{
5593c8
+  grub_efi_handle_t handle;
5593c8
+  grub_efi_status_t status;
5593c8
+
5593c8
+  status = efi_call_3 (grub_efi_system_table->boot_services->locate_device_path,
5593c8
+		      protocol, &device_path, &handle);
5593c8
+
5593c8
+  if (status != GRUB_EFI_SUCCESS)
5593c8
+    return 0;
5593c8
+
5593c8
+  if (r_device_path)
5593c8
+    *r_device_path = device_path;
5593c8
+
5593c8
+  return handle;
5593c8
+}
5593c8
+
5593c8
+static grub_efi_ipv4_address_t *
5593c8
+grub_dns_server_ip4_address (grub_efi_device_path_t *dp, grub_efi_uintn_t *num_dns)
5593c8
+{
5593c8
+  grub_efi_handle_t hnd;
5593c8
+  grub_efi_status_t status;
5593c8
+  grub_efi_ip4_config2_protocol_t *conf;
5593c8
+  grub_efi_ipv4_address_t *addrs;
5593c8
+  grub_efi_uintn_t data_size = 1 * sizeof (grub_efi_ipv4_address_t);
5593c8
+
5593c8
+  hnd = grub_efi_locate_device_path (&ip4_config_guid, dp, NULL);
5593c8
+
5593c8
+  if (!hnd)
5593c8
+    return 0;
5593c8
+
5593c8
+  conf = grub_efi_open_protocol (hnd, &ip4_config_guid,
5593c8
+				GRUB_EFI_OPEN_PROTOCOL_GET_PROTOCOL);
5593c8
+
5593c8
+  if (!conf)
5593c8
+    return 0;
5593c8
+
5593c8
+  addrs  = grub_malloc (data_size);
5593c8
+  if (!addrs)
5593c8
+    return 0;
5593c8
+
5593c8
+  status = efi_call_4 (conf->get_data, conf,
5593c8
+		      GRUB_EFI_IP4_CONFIG2_DATA_TYPE_DNSSERVER,
5593c8
+		      &data_size, addrs);
5593c8
+
5593c8
+  if (status == GRUB_EFI_BUFFER_TOO_SMALL)
5593c8
+    {
5593c8
+      grub_free (addrs);
5593c8
+      addrs  = grub_malloc (data_size);
5593c8
+      if (!addrs)
5593c8
+	return 0;
5593c8
+
5593c8
+      status = efi_call_4 (conf->get_data,  conf,
5593c8
+			  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_DNSSERVER,
5593c8
+			  &data_size, addrs);
5593c8
+    }
5593c8
+
5593c8
+  if (status != GRUB_EFI_SUCCESS)
5593c8
+    {
5593c8
+      grub_free (addrs);
5593c8
+      return 0;
5593c8
+    }
5593c8
+
5593c8
+  *num_dns = data_size / sizeof (grub_efi_ipv4_address_t);
5593c8
+  return addrs;
5593c8
+}
5593c8
+
5593c8
+static grub_efi_ipv6_address_t *
5593c8
+grub_dns_server_ip6_address (grub_efi_device_path_t *dp, grub_efi_uintn_t *num_dns)
5593c8
+{
5593c8
+  grub_efi_handle_t hnd;
5593c8
+  grub_efi_status_t status;
5593c8
+  grub_efi_ip6_config_protocol_t *conf;
5593c8
+  grub_efi_ipv6_address_t *addrs;
5593c8
+  grub_efi_uintn_t data_size = 1 * sizeof (grub_efi_ipv6_address_t);
5593c8
+
5593c8
+  hnd = grub_efi_locate_device_path (&ip6_config_guid, dp, NULL);
5593c8
+
5593c8
+  if (!hnd)
5593c8
+    return 0;
5593c8
+
5593c8
+  conf = grub_efi_open_protocol (hnd, &ip6_config_guid,
5593c8
+				GRUB_EFI_OPEN_PROTOCOL_GET_PROTOCOL);
5593c8
+
5593c8
+  if (!conf)
5593c8
+    return 0;
5593c8
+
5593c8
+  addrs  = grub_malloc (data_size);
5593c8
+  if (!addrs)
5593c8
+    return 0;
5593c8
+
5593c8
+  status = efi_call_4 (conf->get_data, conf,
5593c8
+		      GRUB_EFI_IP6_CONFIG_DATA_TYPE_DNSSERVER,
5593c8
+		      &data_size, addrs);
5593c8
+
5593c8
+  if (status == GRUB_EFI_BUFFER_TOO_SMALL)
5593c8
+    {
5593c8
+      grub_free (addrs);
5593c8
+      addrs  = grub_malloc (data_size);
5593c8
+      if (!addrs)
5593c8
+	return 0;
5593c8
+
5593c8
+      status = efi_call_4 (conf->get_data,  conf,
5593c8
+			  GRUB_EFI_IP6_CONFIG_DATA_TYPE_DNSSERVER,
5593c8
+			  &data_size, addrs);
5593c8
+    }
5593c8
+
5593c8
+  if (status != GRUB_EFI_SUCCESS)
5593c8
+    {
5593c8
+      grub_free (addrs);
5593c8
+      return 0;
5593c8
+    }
5593c8
+
5593c8
+  *num_dns = data_size / sizeof (grub_efi_ipv6_address_t);
5593c8
+  return addrs;
5593c8
+}
5593c8
+
5593c8
 static struct grub_net_buff *
5593c8
 grub_efinet_create_dhcp_ack_from_device_path (grub_efi_device_path_t *dp, int *use_ipv6)
5593c8
 {
5593c8
@@ -390,6 +511,8 @@ grub_efinet_create_dhcp_ack_from_device_path (grub_efi_device_path_t *dp, int *u
5593c8
       grub_efi_ipv4_device_path_t *ipv4 = (grub_efi_ipv4_device_path_t *) ldp;
5593c8
       struct grub_net_bootp_packet *bp;
5593c8
       grub_uint8_t *ptr;
5593c8
+      grub_efi_ipv4_address_t *dns;
5593c8
+      grub_efi_uintn_t num_dns;
5593c8
 
5593c8
       bp = (struct grub_net_bootp_packet *) nb->tail;
5593c8
       err = grub_netbuff_put (nb, sizeof (*bp) + 4);
5593c8
@@ -451,6 +574,25 @@ grub_efinet_create_dhcp_ack_from_device_path (grub_efi_device_path_t *dp, int *u
5593c8
       *ptr++ = sizeof ("HTTPClient") - 1;
5593c8
       grub_memcpy (ptr, "HTTPClient", sizeof ("HTTPClient") - 1);
5593c8
 
5593c8
+      dns = grub_dns_server_ip4_address (dp, &num_dns);
5593c8
+      if (dns)
5593c8
+	{
5593c8
+	  grub_efi_uintn_t size_dns = sizeof (*dns) * num_dns;
5593c8
+
5593c8
+	  ptr = nb->tail;
5593c8
+	  err = grub_netbuff_put (nb, size_dns + 2);
5593c8
+	  if (err)
5593c8
+	    {
5593c8
+	      grub_free (ddp);
5593c8
+	      grub_netbuff_free (nb);
5593c8
+	      return NULL;
5593c8
+	    }
5593c8
+	  *ptr++ = GRUB_NET_BOOTP_DNS;
5593c8
+	  *ptr++ = size_dns;
5593c8
+	  grub_memcpy (ptr, dns, size_dns);
5593c8
+	  grub_free (dns);
5593c8
+	}
5593c8
+
5593c8
       ptr = nb->tail;
5593c8
       err = grub_netbuff_put (nb, 1);
5593c8
       if (err)
5593c8
@@ -483,6 +625,8 @@ grub_efinet_create_dhcp_ack_from_device_path (grub_efi_device_path_t *dp, int *u
5593c8
       struct grub_net_dhcp6_option *opt;
5593c8
       struct grub_net_dhcp6_option_iana *iana;
5593c8
       struct grub_net_dhcp6_option_iaaddr *iaaddr;
5593c8
+      grub_efi_ipv6_address_t *dns;
5593c8
+      grub_efi_uintn_t num_dns;
5593c8
 
5593c8
       d6p = (struct grub_net_dhcp6_packet *)nb->tail;
5593c8
       err = grub_netbuff_put (nb, sizeof(*d6p));
5593c8
@@ -546,6 +690,25 @@ grub_efinet_create_dhcp_ack_from_device_path (grub_efi_device_path_t *dp, int *u
5593c8
       opt->len = grub_cpu_to_be16 (uri_len);
5593c8
       grub_memcpy (opt->data, uri_dp->uri, uri_len);
5593c8
 
5593c8
+      dns = grub_dns_server_ip6_address (dp, &num_dns);
5593c8
+      if (dns)
5593c8
+	{
5593c8
+	  grub_efi_uintn_t size_dns = sizeof (*dns) * num_dns;
5593c8
+
5593c8
+	  opt = (struct grub_net_dhcp6_option *)nb->tail;
5593c8
+	  err = grub_netbuff_put (nb, sizeof(*opt) + size_dns);
5593c8
+	  if (err)
5593c8
+	  {
5593c8
+	    grub_free (ddp);
5593c8
+	    grub_netbuff_free (nb);
5593c8
+	    return NULL;
5593c8
+	  }
5593c8
+	  opt->code = grub_cpu_to_be16_compile_time (GRUB_NET_DHCP6_OPTION_DNS_SERVERS);
5593c8
+	  opt->len = grub_cpu_to_be16 (size_dns);
5593c8
+	  grub_memcpy (opt->data, dns, size_dns);
5593c8
+	  grub_free (dns);
5593c8
+	}
5593c8
+
5593c8
       *use_ipv6 = 1;
5593c8
     }
5593c8
 
5593c8
diff --git a/include/grub/efi/api.h b/include/grub/efi/api.h
d3c3ab
index 4a51667adb1..0b490195ad9 100644
5593c8
--- a/include/grub/efi/api.h
5593c8
+++ b/include/grub/efi/api.h
5593c8
@@ -352,6 +352,15 @@
5593c8
 #define GRUB_EFI_RNG_PROTOCOL_GUID \
5593c8
   { 0x3152bca5, 0xeade, 0x433d, \
5593c8
     { 0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44 } \
5593c8
+
5593c8
+#define GRUB_EFI_IP4_CONFIG2_PROTOCOL_GUID \
5593c8
+  { 0x5b446ed1, 0xe30b, 0x4faa, \
5593c8
+      { 0x87, 0x1a, 0x36, 0x54, 0xec, 0xa3, 0x60, 0x80 } \
5593c8
+  }
5593c8
+
5593c8
+#define GRUB_EFI_IP6_CONFIG_PROTOCOL_GUID \
5593c8
+  { 0x937fe521, 0x95ae, 0x4d1a, \
5593c8
+      { 0x89, 0x29, 0x48, 0xbc, 0xd9, 0x0a, 0xd3, 0x1a } \
5593c8
   }
5593c8
 
5593c8
 struct grub_efi_sal_system_table
5593c8
@@ -1883,6 +1892,72 @@ struct grub_efi_rng_protocol
5593c8
 };
5593c8
 typedef struct grub_efi_rng_protocol grub_efi_rng_protocol_t;
5593c8
 
5593c8
+enum grub_efi_ip4_config2_data_type {
5593c8
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_INTERFACEINFO,
5593c8
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_POLICY,
5593c8
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_MANUAL_ADDRESS,
5593c8
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_GATEWAY,
5593c8
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_DNSSERVER,
5593c8
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_MAXIMUM
5593c8
+};
5593c8
+typedef enum grub_efi_ip4_config2_data_type grub_efi_ip4_config2_data_type_t;
5593c8
+
5593c8
+struct grub_efi_ip4_config2_protocol
5593c8
+{
5593c8
+  grub_efi_status_t (*set_data) (struct grub_efi_ip4_config2_protocol *this,
5593c8
+				 grub_efi_ip4_config2_data_type_t data_type,
5593c8
+				 grub_efi_uintn_t data_size,
5593c8
+				 void *data);
5593c8
+
5593c8
+  grub_efi_status_t (*get_data) (struct grub_efi_ip4_config2_protocol *this,
5593c8
+				 grub_efi_ip4_config2_data_type_t data_type,
5593c8
+				 grub_efi_uintn_t *data_size,
5593c8
+				 void *data);
5593c8
+
5593c8
+  grub_efi_status_t (*register_data_notify) (struct grub_efi_ip4_config2_protocol *this,
5593c8
+					     grub_efi_ip4_config2_data_type_t data_type,
5593c8
+					     grub_efi_event_t event);
5593c8
+
5593c8
+  grub_efi_status_t (*unregister_datanotify) (struct grub_efi_ip4_config2_protocol *this,
5593c8
+					     grub_efi_ip4_config2_data_type_t data_type,
5593c8
+					     grub_efi_event_t event);
5593c8
+};
5593c8
+typedef struct grub_efi_ip4_config2_protocol grub_efi_ip4_config2_protocol_t;
5593c8
+
5593c8
+enum grub_efi_ip6_config_data_type {
5593c8
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_INTERFACEINFO,
5593c8
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_ALT_INTERFACEID,
5593c8
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_POLICY,
5593c8
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_DUP_ADDR_DETECT_TRANSMITS,
5593c8
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_MANUAL_ADDRESS,
5593c8
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_GATEWAY,
5593c8
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_DNSSERVER,
5593c8
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_MAXIMUM
5593c8
+};
5593c8
+typedef enum grub_efi_ip6_config_data_type grub_efi_ip6_config_data_type_t;
5593c8
+
5593c8
+struct grub_efi_ip6_config_protocol
5593c8
+{
5593c8
+  grub_efi_status_t (*set_data) (struct grub_efi_ip6_config_protocol *this,
5593c8
+				 grub_efi_ip6_config_data_type_t data_type,
5593c8
+				 grub_efi_uintn_t data_size,
5593c8
+				 void *data);
5593c8
+
5593c8
+  grub_efi_status_t (*get_data) (struct grub_efi_ip6_config_protocol *this,
5593c8
+				 grub_efi_ip6_config_data_type_t data_type,
5593c8
+				 grub_efi_uintn_t *data_size,
5593c8
+				 void *data);
5593c8
+
5593c8
+  grub_efi_status_t (*register_data_notify) (struct grub_efi_ip6_config_protocol *this,
5593c8
+					     grub_efi_ip6_config_data_type_t data_type,
5593c8
+					     grub_efi_event_t event);
5593c8
+
5593c8
+  grub_efi_status_t (*unregister_datanotify) (struct grub_efi_ip6_config_protocol *this,
5593c8
+					     grub_efi_ip6_config_data_type_t data_type,
5593c8
+					     grub_efi_event_t event);
5593c8
+};
5593c8
+typedef struct grub_efi_ip6_config_protocol grub_efi_ip6_config_protocol_t;
5593c8
+
5593c8
 #if (GRUB_TARGET_SIZEOF_VOID_P == 4) || defined (__ia64__) \
5593c8
   || defined (__aarch64__) || defined (__MINGW64__) || defined (__CYGWIN__) \
5593c8
   || defined(__riscv)