752ceb1
From 347ab564463e788d31944e2ad06c0420c01fdf2d Mon Sep 17 00:00:00 2001
63f1a98
From: Michael Chang <mchang@suse.com>
63f1a98
Date: Thu, 14 Jul 2016 17:48:45 +0800
31cddd6
Subject: [PATCH] efinet: Setting DNS server from UEFI protocol
63f1a98
63f1a98
In the URI device path node, any name rahter than address can be used for
63f1a98
looking up the resources so that DNS service become needed to get answer of the
63f1a98
name's address. Unfortunately the DNS is not defined in any of the device path
63f1a98
nodes so that we use the EFI_IP4_CONFIG2_PROTOCOL and EFI_IP6_CONFIG_PROTOCOL
63f1a98
to obtain it.
63f1a98
63f1a98
These two protcols are defined the sections of UEFI specification.
63f1a98
63f1a98
 27.5 EFI IPv4 Configuration II Protocol
63f1a98
 27.7 EFI IPv6 Configuration Protocol
63f1a98
63f1a98
include/grub/efi/api.h:
63f1a98
Add new structure and protocol UUID of EFI_IP4_CONFIG2_PROTOCOL and
63f1a98
EFI_IP6_CONFIG_PROTOCOL.
63f1a98
63f1a98
grub-core/net/drivers/efi/efinet.c:
63f1a98
Use the EFI_IP4_CONFIG2_PROTOCOL and EFI_IP6_CONFIG_PROTOCOL to obtain the list
63f1a98
of DNS server address for IPv4 and IPv6 respectively. The address of DNS
63f1a98
servers is structured into DHCPACK packet and feed into the same DHCP packet
63f1a98
processing functions to ensure the network interface is setting up the same way
63f1a98
it used to be.
63f1a98
63f1a98
Signed-off-by: Michael Chang <mchang@suse.com>
63f1a98
Signed-off-by: Ken Lin <ken.lin@hpe.com>
63f1a98
---
63f1a98
 grub-core/net/drivers/efi/efinet.c | 163 +++++++++++++++++++++++++++++++++++++
63f1a98
 include/grub/efi/api.h             |  76 +++++++++++++++++
63f1a98
 2 files changed, 239 insertions(+)
63f1a98
63f1a98
diff --git a/grub-core/net/drivers/efi/efinet.c b/grub-core/net/drivers/efi/efinet.c
752ceb1
index 431b72916b6..c25a68161b8 100644
63f1a98
--- a/grub-core/net/drivers/efi/efinet.c
63f1a98
+++ b/grub-core/net/drivers/efi/efinet.c
63f1a98
@@ -34,6 +34,8 @@ GRUB_MOD_LICENSE ("GPLv3+");
63f1a98
 /* GUID.  */
63f1a98
 static grub_efi_guid_t net_io_guid = GRUB_EFI_SIMPLE_NETWORK_GUID;
63f1a98
 static grub_efi_guid_t pxe_io_guid = GRUB_EFI_PXE_GUID;
63f1a98
+static grub_efi_guid_t ip4_config_guid = GRUB_EFI_IP4_CONFIG2_PROTOCOL_GUID;
63f1a98
+static grub_efi_guid_t ip6_config_guid = GRUB_EFI_IP6_CONFIG_PROTOCOL_GUID;
63f1a98
 
63f1a98
 static grub_err_t
63f1a98
 send_card_buffer (struct grub_net_card *dev,
752ceb1
@@ -413,6 +415,125 @@ grub_efinet_findcards (void)
63f1a98
     }
63f1a98
 }
63f1a98
 
63f1a98
+static grub_efi_handle_t
63f1a98
+grub_efi_locate_device_path (grub_efi_guid_t *protocol, grub_efi_device_path_t *device_path,
63f1a98
+			    grub_efi_device_path_t **r_device_path)
63f1a98
+{
63f1a98
+  grub_efi_handle_t handle;
63f1a98
+  grub_efi_status_t status;
63f1a98
+
63f1a98
+  status = efi_call_3 (grub_efi_system_table->boot_services->locate_device_path,
63f1a98
+		      protocol, &device_path, &handle);
63f1a98
+
63f1a98
+  if (status != GRUB_EFI_SUCCESS)
63f1a98
+    return 0;
63f1a98
+
63f1a98
+  if (r_device_path)
63f1a98
+    *r_device_path = device_path;
63f1a98
+
63f1a98
+  return handle;
63f1a98
+}
63f1a98
+
63f1a98
+static grub_efi_ipv4_address_t *
63f1a98
+grub_dns_server_ip4_address (grub_efi_device_path_t *dp, grub_efi_uintn_t *num_dns)
63f1a98
+{
63f1a98
+  grub_efi_handle_t hnd;
63f1a98
+  grub_efi_status_t status;
63f1a98
+  grub_efi_ip4_config2_protocol_t *conf;
63f1a98
+  grub_efi_ipv4_address_t *addrs;
63f1a98
+  grub_efi_uintn_t data_size = 1 * sizeof (grub_efi_ipv4_address_t);
63f1a98
+
63f1a98
+  hnd = grub_efi_locate_device_path (&ip4_config_guid, dp, NULL);
63f1a98
+
63f1a98
+  if (!hnd)
63f1a98
+    return 0;
63f1a98
+
63f1a98
+  conf = grub_efi_open_protocol (hnd, &ip4_config_guid,
63f1a98
+				GRUB_EFI_OPEN_PROTOCOL_GET_PROTOCOL);
63f1a98
+
63f1a98
+  if (!conf)
63f1a98
+    return 0;
63f1a98
+
63f1a98
+  addrs  = grub_malloc (data_size);
63f1a98
+  if (!addrs)
63f1a98
+    return 0;
63f1a98
+
63f1a98
+  status = efi_call_4 (conf->get_data, conf,
63f1a98
+		      GRUB_EFI_IP4_CONFIG2_DATA_TYPE_DNSSERVER,
63f1a98
+		      &data_size, addrs);
63f1a98
+
63f1a98
+  if (status == GRUB_EFI_BUFFER_TOO_SMALL)
63f1a98
+    {
63f1a98
+      grub_free (addrs);
63f1a98
+      addrs  = grub_malloc (data_size);
63f1a98
+      if (!addrs)
63f1a98
+	return 0;
63f1a98
+
63f1a98
+      status = efi_call_4 (conf->get_data,  conf,
63f1a98
+			  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_DNSSERVER,
63f1a98
+			  &data_size, addrs);
63f1a98
+    }
63f1a98
+
63f1a98
+  if (status != GRUB_EFI_SUCCESS)
63f1a98
+    {
63f1a98
+      grub_free (addrs);
63f1a98
+      return 0;
63f1a98
+    }
63f1a98
+
63f1a98
+  *num_dns = data_size / sizeof (grub_efi_ipv4_address_t);
63f1a98
+  return addrs;
63f1a98
+}
63f1a98
+
63f1a98
+static grub_efi_ipv6_address_t *
63f1a98
+grub_dns_server_ip6_address (grub_efi_device_path_t *dp, grub_efi_uintn_t *num_dns)
63f1a98
+{
63f1a98
+  grub_efi_handle_t hnd;
63f1a98
+  grub_efi_status_t status;
63f1a98
+  grub_efi_ip6_config_protocol_t *conf;
63f1a98
+  grub_efi_ipv6_address_t *addrs;
63f1a98
+  grub_efi_uintn_t data_size = 1 * sizeof (grub_efi_ipv6_address_t);
63f1a98
+
63f1a98
+  hnd = grub_efi_locate_device_path (&ip6_config_guid, dp, NULL);
63f1a98
+
63f1a98
+  if (!hnd)
63f1a98
+    return 0;
63f1a98
+
63f1a98
+  conf = grub_efi_open_protocol (hnd, &ip6_config_guid,
63f1a98
+				GRUB_EFI_OPEN_PROTOCOL_GET_PROTOCOL);
63f1a98
+
63f1a98
+  if (!conf)
63f1a98
+    return 0;
63f1a98
+
63f1a98
+  addrs  = grub_malloc (data_size);
63f1a98
+  if (!addrs)
63f1a98
+    return 0;
63f1a98
+
63f1a98
+  status = efi_call_4 (conf->get_data, conf,
63f1a98
+		      GRUB_EFI_IP6_CONFIG_DATA_TYPE_DNSSERVER,
63f1a98
+		      &data_size, addrs);
63f1a98
+
63f1a98
+  if (status == GRUB_EFI_BUFFER_TOO_SMALL)
63f1a98
+    {
63f1a98
+      grub_free (addrs);
63f1a98
+      addrs  = grub_malloc (data_size);
63f1a98
+      if (!addrs)
63f1a98
+	return 0;
63f1a98
+
63f1a98
+      status = efi_call_4 (conf->get_data,  conf,
63f1a98
+			  GRUB_EFI_IP6_CONFIG_DATA_TYPE_DNSSERVER,
63f1a98
+			  &data_size, addrs);
63f1a98
+    }
63f1a98
+
63f1a98
+  if (status != GRUB_EFI_SUCCESS)
63f1a98
+    {
63f1a98
+      grub_free (addrs);
63f1a98
+      return 0;
63f1a98
+    }
63f1a98
+
63f1a98
+  *num_dns = data_size / sizeof (grub_efi_ipv6_address_t);
63f1a98
+  return addrs;
63f1a98
+}
63f1a98
+
63f1a98
 static struct grub_net_buff *
63f1a98
 grub_efinet_create_dhcp_ack_from_device_path (grub_efi_device_path_t *dp, int *use_ipv6)
63f1a98
 {
752ceb1
@@ -471,6 +592,8 @@ grub_efinet_create_dhcp_ack_from_device_path (grub_efi_device_path_t *dp, int *u
63f1a98
       grub_efi_ipv4_device_path_t *ipv4 = (grub_efi_ipv4_device_path_t *) ldp;
63f1a98
       struct grub_net_bootp_packet *bp;
63f1a98
       grub_uint8_t *ptr;
63f1a98
+      grub_efi_ipv4_address_t *dns;
63f1a98
+      grub_efi_uintn_t num_dns;
63f1a98
 
63f1a98
       bp = (struct grub_net_bootp_packet *) nb->tail;
63f1a98
       err = grub_netbuff_put (nb, sizeof (*bp) + 4);
752ceb1
@@ -532,6 +655,25 @@ grub_efinet_create_dhcp_ack_from_device_path (grub_efi_device_path_t *dp, int *u
63f1a98
       *ptr++ = sizeof ("HTTPClient") - 1;
63f1a98
       grub_memcpy (ptr, "HTTPClient", sizeof ("HTTPClient") - 1);
63f1a98
 
63f1a98
+      dns = grub_dns_server_ip4_address (dp, &num_dns);
63f1a98
+      if (dns)
63f1a98
+	{
63f1a98
+	  grub_efi_uintn_t size_dns = sizeof (*dns) * num_dns;
63f1a98
+
63f1a98
+	  ptr = nb->tail;
63f1a98
+	  err = grub_netbuff_put (nb, size_dns + 2);
63f1a98
+	  if (err)
63f1a98
+	    {
63f1a98
+	      grub_free (ddp);
63f1a98
+	      grub_netbuff_free (nb);
63f1a98
+	      return NULL;
63f1a98
+	    }
63f1a98
+	  *ptr++ = GRUB_NET_BOOTP_DNS;
63f1a98
+	  *ptr++ = size_dns;
63f1a98
+	  grub_memcpy (ptr, dns, size_dns);
63f1a98
+	  grub_free (dns);
63f1a98
+	}
63f1a98
+
63f1a98
       ptr = nb->tail;
63f1a98
       err = grub_netbuff_put (nb, 1);
63f1a98
       if (err)
752ceb1
@@ -564,6 +706,8 @@ grub_efinet_create_dhcp_ack_from_device_path (grub_efi_device_path_t *dp, int *u
63f1a98
       struct grub_net_dhcp6_option *opt;
63f1a98
       struct grub_net_dhcp6_option_iana *iana;
63f1a98
       struct grub_net_dhcp6_option_iaaddr *iaaddr;
63f1a98
+      grub_efi_ipv6_address_t *dns;
63f1a98
+      grub_efi_uintn_t num_dns;
63f1a98
 
63f1a98
       d6p = (struct grub_net_dhcp6_packet *)nb->tail;
63f1a98
       err = grub_netbuff_put (nb, sizeof(*d6p));
752ceb1
@@ -627,6 +771,25 @@ grub_efinet_create_dhcp_ack_from_device_path (grub_efi_device_path_t *dp, int *u
63f1a98
       opt->len = grub_cpu_to_be16 (uri_len);
63f1a98
       grub_memcpy (opt->data, uri_dp->uri, uri_len);
63f1a98
 
63f1a98
+      dns = grub_dns_server_ip6_address (dp, &num_dns);
63f1a98
+      if (dns)
63f1a98
+	{
63f1a98
+	  grub_efi_uintn_t size_dns = sizeof (*dns) * num_dns;
63f1a98
+
63f1a98
+	  opt = (struct grub_net_dhcp6_option *)nb->tail;
63f1a98
+	  err = grub_netbuff_put (nb, sizeof(*opt) + size_dns);
63f1a98
+	  if (err)
63f1a98
+	  {
63f1a98
+	    grub_free (ddp);
63f1a98
+	    grub_netbuff_free (nb);
63f1a98
+	    return NULL;
63f1a98
+	  }
63f1a98
+	  opt->code = grub_cpu_to_be16_compile_time (GRUB_NET_DHCP6_OPTION_DNS_SERVERS);
63f1a98
+	  opt->len = grub_cpu_to_be16 (size_dns);
63f1a98
+	  grub_memcpy (opt->data, dns, size_dns);
63f1a98
+	  grub_free (dns);
63f1a98
+	}
63f1a98
+
63f1a98
       *use_ipv6 = 1;
63f1a98
     }
63f1a98
 
63f1a98
diff --git a/include/grub/efi/api.h b/include/grub/efi/api.h
752ceb1
index 0b61f791850..80f6d79cfaf 100644
63f1a98
--- a/include/grub/efi/api.h
63f1a98
+++ b/include/grub/efi/api.h
63f1a98
@@ -334,6 +334,16 @@
63f1a98
       { 0x8B, 0x8C, 0xE2, 0x1B, 0x01, 0xAE, 0xF2, 0xB7 } \
63f1a98
   }
63f1a98
 
63f1a98
+#define GRUB_EFI_IP4_CONFIG2_PROTOCOL_GUID \
63f1a98
+  { 0x5b446ed1, 0xe30b, 0x4faa, \
63f1a98
+      { 0x87, 0x1a, 0x36, 0x54, 0xec, 0xa3, 0x60, 0x80 } \
63f1a98
+  }
63f1a98
+
63f1a98
+#define GRUB_EFI_IP6_CONFIG_PROTOCOL_GUID \
63f1a98
+  { 0x937fe521, 0x95ae, 0x4d1a, \
63f1a98
+      { 0x89, 0x29, 0x48, 0xbc, 0xd9, 0x0a, 0xd3, 0x1a } \
63f1a98
+  }
63f1a98
+
63f1a98
 struct grub_efi_sal_system_table
63f1a98
 {
63f1a98
   grub_uint32_t signature;
752ceb1
@@ -1842,6 +1852,72 @@ struct grub_efi_block_io
63f1a98
 };
63f1a98
 typedef struct grub_efi_block_io grub_efi_block_io_t;
63f1a98
 
63f1a98
+enum grub_efi_ip4_config2_data_type {
63f1a98
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_INTERFACEINFO,
63f1a98
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_POLICY,
63f1a98
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_MANUAL_ADDRESS,
63f1a98
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_GATEWAY,
63f1a98
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_DNSSERVER,
63f1a98
+  GRUB_EFI_IP4_CONFIG2_DATA_TYPE_MAXIMUM
63f1a98
+};
63f1a98
+typedef enum grub_efi_ip4_config2_data_type grub_efi_ip4_config2_data_type_t;
63f1a98
+
63f1a98
+struct grub_efi_ip4_config2_protocol
63f1a98
+{
63f1a98
+  grub_efi_status_t (*set_data) (struct grub_efi_ip4_config2_protocol *this,
63f1a98
+				 grub_efi_ip4_config2_data_type_t data_type,
63f1a98
+				 grub_efi_uintn_t data_size,
63f1a98
+				 void *data);
63f1a98
+
63f1a98
+  grub_efi_status_t (*get_data) (struct grub_efi_ip4_config2_protocol *this,
63f1a98
+				 grub_efi_ip4_config2_data_type_t data_type,
63f1a98
+				 grub_efi_uintn_t *data_size,
63f1a98
+				 void *data);
63f1a98
+
63f1a98
+  grub_efi_status_t (*register_data_notify) (struct grub_efi_ip4_config2_protocol *this,
63f1a98
+					     grub_efi_ip4_config2_data_type_t data_type,
63f1a98
+					     grub_efi_event_t event);
63f1a98
+
63f1a98
+  grub_efi_status_t (*unregister_datanotify) (struct grub_efi_ip4_config2_protocol *this,
63f1a98
+					     grub_efi_ip4_config2_data_type_t data_type,
63f1a98
+					     grub_efi_event_t event);
63f1a98
+};
63f1a98
+typedef struct grub_efi_ip4_config2_protocol grub_efi_ip4_config2_protocol_t;
63f1a98
+
63f1a98
+enum grub_efi_ip6_config_data_type {
63f1a98
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_INTERFACEINFO,
63f1a98
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_ALT_INTERFACEID,
63f1a98
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_POLICY,
63f1a98
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_DUP_ADDR_DETECT_TRANSMITS,
63f1a98
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_MANUAL_ADDRESS,
63f1a98
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_GATEWAY,
63f1a98
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_DNSSERVER,
63f1a98
+  GRUB_EFI_IP6_CONFIG_DATA_TYPE_MAXIMUM
63f1a98
+};
63f1a98
+typedef enum grub_efi_ip6_config_data_type grub_efi_ip6_config_data_type_t;
63f1a98
+
63f1a98
+struct grub_efi_ip6_config_protocol
63f1a98
+{
63f1a98
+  grub_efi_status_t (*set_data) (struct grub_efi_ip6_config_protocol *this,
63f1a98
+				 grub_efi_ip6_config_data_type_t data_type,
63f1a98
+				 grub_efi_uintn_t data_size,
63f1a98
+				 void *data);
63f1a98
+
63f1a98
+  grub_efi_status_t (*get_data) (struct grub_efi_ip6_config_protocol *this,
63f1a98
+				 grub_efi_ip6_config_data_type_t data_type,
63f1a98
+				 grub_efi_uintn_t *data_size,
63f1a98
+				 void *data);
63f1a98
+
63f1a98
+  grub_efi_status_t (*register_data_notify) (struct grub_efi_ip6_config_protocol *this,
63f1a98
+					     grub_efi_ip6_config_data_type_t data_type,
63f1a98
+					     grub_efi_event_t event);
63f1a98
+
63f1a98
+  grub_efi_status_t (*unregister_datanotify) (struct grub_efi_ip6_config_protocol *this,
63f1a98
+					     grub_efi_ip6_config_data_type_t data_type,
63f1a98
+					     grub_efi_event_t event);
63f1a98
+};
63f1a98
+typedef struct grub_efi_ip6_config_protocol grub_efi_ip6_config_protocol_t;
63f1a98
+
63f1a98
 #if (GRUB_TARGET_SIZEOF_VOID_P == 4) || defined (__ia64__) \
63f1a98
   || defined (__aarch64__) || defined (__MINGW64__) || defined (__CYGWIN__)
63f1a98