Search for specific config files using UUID, MAC and IP
v2 cover Search for specific config files using UUID, MAC and IP
Hello,
This is a 2nd version of a series that have been carried in Fedora (and other distros) for a long time. It allows to fetch GRUB configurations that are customized for each machine by using the client UUID, MAC and IP addresses as suffixes for the grub.cfg file.
The procedure is similar to what is used by pxelinux and yaboot, i.e:
http://www.syslinux.org/wiki/index.php/PXELINUX#config
Patch #1 adds a %X format specifier to make the grub_printf() function more similar to printf() and not require to use %x plus grub_toupper().
Patch #2 sets net_<interface>_client{id,uuid} environment variables by using the DHCP client ID and UUID options if these are found.
Finally Patch #3 adds the support to fetch the config files using the UUID, MAC and IP as suffixes. If these aren't found, the default GRUB config filename is used as a fallback.
Best regards,
Javier
Changes in v2:
- Put patch that adds the %X format specifier first in the series.
- Use the existing grub_env_set_net_property() and remove duplicated code.
- Add Reviewed-by tag from Daniel Kiper.
Paulo Flabiano Smorigo (3):
Add %X option to printf functions
Set net_<interface>_client{id,uuid} variables from DHCP options Search for specific config files for netboot
grub-core/kern/misc.c | 7 ++- grub-core/net/bootp.c | 48 ++++++++++++++--- grub-core/net/net.c | 117 ++++++++++++++++++++++++++++++++++++++++ grub-core/normal/main.c | 17 ++++-- include/grub/net.h | 5 ++ 5 files changed, 180 insertions(+), 14 deletions(-)
Signature · 1 line
2.21.0
PATCH v2 1/3 Add %X option to printf functions
From: Paulo Flabiano Smorigo <[email protected]>
The printf(3) function has support for the %X format specifier, to output an unsigned hexadecimal integer in uppercase.
This can be achived in GRUB using the %x format specifier in grub_printf() and calling grub_toupper(), but it is more convenient if there is support for %X in grub_printf().
---
Changes in v2:
- Put patch that adds the %X format specifier first in the series.
grub-core/kern/misc.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
grub-core/kern/misc.c +5 -2
@@ -588,7 +588,7 @@ grub_divmod64 (grub_uint64_t n, grub_uint64_t d, grub_uint64_t *r)static inline char *grub_lltoa (char *str,int c,unsigned long long n) { -unsigned base = (c =='x' ) ?16 :10 ; +unsigned base = ((c =='x' ) || (c =='X' )) ?16 :10 ;char *p;if ((long long ) n <0 && c =='d' )
@@ -603,7 +603,7 @@ grub_lltoa (char *str, int c, unsigned long long n)do {unsigned d = (unsigned ) (n &0xf ); - *p++ = (d >9 ) ? d +'a' -10 : d +'0' ; + *p++ = (d >9 ) ? d + ((c =='x' ) ?'a' :'A' ) -10 : d +'0' ; }while (n >>=4 ); else
@@ -676,6 +676,7 @@ parse_printf_args (const char *fmt0, struct printf_args *args, {case 'p' :case 'x' : +case 'X' :case 'u' :case 'd' :case 'c' :
@@ -762,6 +763,7 @@ parse_printf_args (const char *fmt0, struct printf_args *args,switch (c) {case 'x' : +case 'X' :case 'u' : args->ptr[curn].type =UNSIGNED_INT + longfmt;break ;
@@ -900,6 +902,7 @@ grub_vsnprintf_real (char *str, grub_size_t max_len, const char *fmt0, c ='x' ;/* Fall through. */ case 'x' : +case 'X' :case 'u' :case 'd' : {
Signature · 1 line
2.21.0
PATCH v2 2/3 Set net_<interface>_client{id, uuid} variables from DHCP options
In reply to Javier Martinez CanillasFrom: Paulo Flabiano Smorigo <[email protected]>
This patch sets a net_<interface>_clientid and net_<interface>_clientuuid GRUB environment variables, using the DHCP client ID and UUID options if these are found.
In the same way than net_<interface>_<option> variables are set for other options such domain name, boot file, next server, etc.
---
Changes in v2:
- Use the existing grub_env_set_net_property() and remove duplicated code.
grub-core/net/bootp.c | 48 +++++++++++++++++++++++++++++++++++-------- include/grub/net.h | 2 ++ 2 files changed, 42 insertions(+), 8 deletions(-)
grub-core/net/bootp.c +40 -8
@@ -95,6 +95,14 @@ enum/* Max timeout when waiting for BOOTP/DHCP reply */ #define GRUB_DHCP_MAX_PACKET_TIMEOUT 32 +static char +hexdigit (grub_uint8_t val) +{ +if (val <10 ) +return val +'0' ; +return val +'a' -10 ; +} +static const void *find_dhcp_option (const struct grub_net_bootp_packet *bp,grub_size_t size,grub_uint8_t opt_code,grub_uint8_t *opt_len)
@@ -152,6 +160,9 @@ again:if (i + taglength >= size)return NULL ; +grub_dprintf ("net" ,"DHCP option %u (0x%02x) found with length %u.\n" , + tagtype, tagtype, taglength); +/* FIXME RFC 3396 options concatentation */ if (tagtype == opt_code) {
@@ -406,6 +417,35 @@ grub_net_configure_by_dhcp_ack (const char *name,if (opt && opt_len)grub_env_set_net_property (name,"extensionspath" , (const char *) opt, opt_len); + opt =find_dhcp_option (bp, size,GRUB_NET_BOOTP_CLIENT_ID , &opt_len); +if (opt && opt_len) +grub_env_set_net_property (name,"clientid" , (const char *) opt, opt_len); + + opt =find_dhcp_option (bp, size,GRUB_NET_BOOTP_CLIENT_UUID , &opt_len); +if (opt && opt_len ==17 ) + { +/* The format is 9cfe245e-d0c8-bd45-a79f-54ea5fbd3d97 */ + + opt +=1 ; + opt_len -=1 ; + +char *val =grub_malloc (2 * opt_len +4 +1 ); +int i =0 ; +int j =0 ; +for (i =0 ; i < opt_len; i++) + { + val[2 * i + j] =hexdigit (opt[i] >>4 ); + val[2 * i +1 + j] =hexdigit (opt[i] &0xf ); + +if ((i ==3 ) || (i ==5 ) || (i ==7 ) || (i ==9 )) + { + j++; + val[2 * i +1 + j] ='-' ; + } + } +grub_env_set_net_property (name,"clientuuid" , (char *) val,2 * opt_len +4 ); + } + inter->dhcp_ack =grub_malloc (size);if (inter->dhcp_ack) {
@@ -631,14 +671,6 @@ grub_net_process_dhcp (struct grub_net_buff *nb, } } -static char -hexdigit (grub_uint8_t val) -{ -if (val <10 ) -return val +'0' ; -return val +'a' -10 ; -} -static grub_err_t grub_cmd_dhcpopt (struct grub_command *cmd __attribute__ ((unused)),int argc,char **args)
include/grub/net.h +2 -0
@@ -462,6 +462,8 @@ enumGRUB_NET_BOOTP_DOMAIN =0x0f ,GRUB_NET_BOOTP_ROOT_PATH =0x11 ,GRUB_NET_BOOTP_EXTENSIONS_PATH =0x12 , +GRUB_NET_BOOTP_CLIENT_ID =0x3d , +GRUB_NET_BOOTP_CLIENT_UUID =0x61 ,GRUB_NET_DHCP_REQUESTED_IP_ADDRESS =50 ,GRUB_NET_DHCP_OVERLOAD =52 , GRUB_NET_DHCP_MESSAGE_TYPE = 53,
Signature · 1 line
2.21.0
Re: [PATCH v2 2/3] Set net_<interface>_client{id,uuid} variables from DHCP options
Quoted 6 lines · Javier Martinez Canillas
From: Paulo Flabiano Smorigo <[email protected]>
This patch sets a net_<interface>_clientid and net_<interface>_clientuuid GRUB environment variables, using the DHCP client ID and UUID options if these are found.
Quoted 6 lines
In the same way than net_<interface>_<option> variables are set for other options such domain name, boot file, next server, etc.
Signed-off-by Paulo Flabiano Smorigo <[email protected]>Signed-off-by Javier Martinez Canillas <[email protected]>Reviewed-by Daniel Kiper <[email protected]>
It seems to me that this RB should land in patch #3. Does not it? Anyway, Reviewed-by: Daniel Kiper <[email protected]> :-) except one thing...
Quoted 94 lines
---
Changes in v2:
- Use the existinggrub_env_set_net_property()and remove duplicated code.grub-core/net/bootp.c | 48 +++++++++++++++++++++++++++++++++++-------- include/grub/net.h | 2 ++ 2 files changed, 42 insertions(+), 8 deletions(-)grub-core/net/bootp.c +40
-8@@ -95,6 +95,14 @@ enum/* Max timeout when waiting for BOOTP/DHCP reply */ #define GRUB_DHCP_MAX_PACKET_TIMEOUT 32 +static char +hexdigit (grub_uint8_t val) +{ +if (val <10 ) +return val +'0' ; +return val +'a' -10 ; +} +static const void *find_dhcp_option (const struct grub_net_bootp_packet *bp,grub_size_t size,grub_uint8_t opt_code,grub_uint8_t *opt_len)@@ -152,6 +160,9 @@ again:if (i + taglength >= size)return NULL ; +grub_dprintf ("net" ,"DHCP option %u (0x%02x) found with length %u.\n" , + tagtype, tagtype, taglength); +/* FIXME RFC 3396 options concatentation */ if (tagtype == opt_code) {@@ -406,6 +417,35 @@ grub_net_configure_by_dhcp_ack (const char *name,if (opt && opt_len)grub_env_set_net_property (name,"extensionspath" , (const char *) opt, opt_len); + opt =find_dhcp_option (bp, size,GRUB_NET_BOOTP_CLIENT_ID , &opt_len); +if (opt && opt_len) +grub_env_set_net_property (name,"clientid" , (const char *) opt, opt_len); + + opt =find_dhcp_option (bp, size,GRUB_NET_BOOTP_CLIENT_UUID , &opt_len); +if (opt && opt_len ==17 ) + { +/* The format is 9cfe245e-d0c8-bd45-a79f-54ea5fbd3d97 */ + + opt +=1 ; + opt_len -=1 ; + +char *val =grub_malloc (2 * opt_len +4 +1 ); +int i =0 ; +int j =0 ; +for (i =0 ; i < opt_len; i++) + { + val[2 * i + j] =hexdigit (opt[i] >>4 ); + val[2 * i +1 + j] =hexdigit (opt[i] &0xf ); + +if ((i ==3 ) || (i ==5 ) || (i ==7 ) || (i ==9 )) + { + j++; + val[2 * i +1 + j] ='-' ; + } + } +grub_env_set_net_property (name,"clientuuid" , (char *) val,2 * opt_len +4 ); + } + inter->dhcp_ack =grub_malloc (size);if (inter->dhcp_ack) {@@ -631,14 +671,6 @@ grub_net_process_dhcp (struct grub_net_buff *nb, } } -static char -hexdigit (grub_uint8_t val) -{ -if (val <10 ) -return val +'0' ; -return val +'a' -10 ; -} -static grub_err_t grub_cmd_dhcpopt (struct grub_command *cmd __attribute__ ((unused)),int argc,char **args)include/grub/net.h +0
-0
include/grub/net.h enum · line 469
Quoted 8 lines
include/grub/net.h +2
-0@@ -462,6 +462,8 @@ enumGRUB_NET_BOOTP_DOMAIN =0x0f ,GRUB_NET_BOOTP_ROOT_PATH =0x11 ,GRUB_NET_BOOTP_EXTENSIONS_PATH =0x12 , +GRUB_NET_BOOTP_CLIENT_ID =0x3d , +GRUB_NET_BOOTP_CLIENT_UUID =0x61 ,GRUB_NET_DHCP_REQUESTED_IP_ADDRESS =50 ,GRUB_NET_DHCP_OVERLOAD =52 , GRUB_NET_DHCP_MESSAGE_TYPE = 53,
I have just realized that this enum is a mixture of decimals and hexes. This is a mess. Could you add a patch before that patch changing all decimals to hexes and sort them properly?
Daniel
Re: [PATCH v2 2/3] Set net_<interface>_client{id, uuid} variables from DHCP options
Hello Daniel,
Quoted 7 lines · Daniel Kiper
Quoted 6 lines · Javier Martinez Canillas
From: Paulo Flabiano Smorigo <[email protected]>
This patch sets a net_<interface>_clientid and net_<interface>_clientuuid GRUB environment variables, using the DHCP client ID and UUID options if these are found.
Quoted 8 lines
Quoted 6 lines
In the same way than net_<interface>_<option> variables are set for other options such domain name, boot file, next server, etc.
Signed-off-by Paulo Flabiano Smorigo <[email protected]>Signed-off-by Javier Martinez Canillas <[email protected]>Reviewed-by Daniel Kiper <[email protected]>It seems to me that this RB should land in patch #3. Does not it?
Ups, sorry about that.
Quoted 101 lines
Anyway, Reviewed-by: Daniel Kiper <[email protected]> :-) except one thing...
Quoted 98 lines
---
Changes in v2:
- Use the existinggrub_env_set_net_property()and remove duplicated code.grub-core/net/bootp.c | 48 +++++++++++++++++++++++++++++++++++-------- include/grub/net.h | 2 ++ 2 files changed, 42 insertions(+), 8 deletions(-)grub-core/net/bootp.c +40
-8@@ -95,6 +95,14 @@ enum/* Max timeout when waiting for BOOTP/DHCP reply */ #define GRUB_DHCP_MAX_PACKET_TIMEOUT 32 +static char +hexdigit (grub_uint8_t val) +{ +if (val <10 ) +return val +'0' ; +return val +'a' -10 ; +} +static const void *find_dhcp_option (const struct grub_net_bootp_packet *bp,grub_size_t size,grub_uint8_t opt_code,grub_uint8_t *opt_len)@@ -152,6 +160,9 @@ again:if (i + taglength >= size)return NULL ; +grub_dprintf ("net" ,"DHCP option %u (0x%02x) found with length %u.\n" , + tagtype, tagtype, taglength); +/* FIXME RFC 3396 options concatentation */ if (tagtype == opt_code) {@@ -406,6 +417,35 @@ grub_net_configure_by_dhcp_ack (const char *name,if (opt && opt_len)grub_env_set_net_property (name,"extensionspath" , (const char *) opt, opt_len); + opt =find_dhcp_option (bp, size,GRUB_NET_BOOTP_CLIENT_ID , &opt_len); +if (opt && opt_len) +grub_env_set_net_property (name,"clientid" , (const char *) opt, opt_len); + + opt =find_dhcp_option (bp, size,GRUB_NET_BOOTP_CLIENT_UUID , &opt_len); +if (opt && opt_len ==17 ) + { +/* The format is 9cfe245e-d0c8-bd45-a79f-54ea5fbd3d97 */ + + opt +=1 ; + opt_len -=1 ; + +char *val =grub_malloc (2 * opt_len +4 +1 ); +int i =0 ; +int j =0 ; +for (i =0 ; i < opt_len; i++) + { + val[2 * i + j] =hexdigit (opt[i] >>4 ); + val[2 * i +1 + j] =hexdigit (opt[i] &0xf ); + +if ((i ==3 ) || (i ==5 ) || (i ==7 ) || (i ==9 )) + { + j++; + val[2 * i +1 + j] ='-' ; + } + } +grub_env_set_net_property (name,"clientuuid" , (char *) val,2 * opt_len +4 ); + } + inter->dhcp_ack =grub_malloc (size);if (inter->dhcp_ack) {@@ -631,14 +671,6 @@ grub_net_process_dhcp (struct grub_net_buff *nb, } } -static char -hexdigit (grub_uint8_t val) -{ -if (val <10 ) -return val +'0' ; -return val +'a' -10 ; -} -static grub_err_t grub_cmd_dhcpopt (struct grub_command *cmd __attribute__ ((unused)),int argc,char **args)include/grub/net.h +1
-0@@ -462,6 +462,8 @@ enumGRUB_NET_BOOTP_DOMAIN =0x0f ,GRUB_NET_BOOTP_ROOT_PATH =0x11 ,GRUB_NET_BOOTP_EXTENSIONS_PATH =0x12 , + GRUB_NET_BOOTP_CLIENT_ID = 0x3d,
Quoted 9 lines
include/grub/net.h enum · line 469
Quoted 4 lines
include/grub/net.h +1
-0+GRUB_NET_BOOTP_CLIENT_UUID =0x61 ,GRUB_NET_DHCP_REQUESTED_IP_ADDRESS =50 ,GRUB_NET_DHCP_OVERLOAD =52 , GRUB_NET_DHCP_MESSAGE_TYPE = 53,I have just realized that this enum is a mixture of decimals and hexes. This is a mess. Could you add a patch before that patch changing all decimals to hexes and sort them properly?
Sure. I'll do that.
I also noticed that we have a patch that adds documentation about the netboot grub.cfg selection order so I'll also include that patch in v3.
Quoted 2 lines
Daniel
Best regards,
Signature · 3 lines
Javier Martinez Canillas Software Engineer - Desktop Hardware Enablement Red Hat
PATCH v2 3/3 Search for specific config files for netboot
In reply to Javier Martinez CanillasFrom: Paulo Flabiano Smorigo <[email protected]>
This patch implements a search for a specific configuration when the config file is on a remoteserver. It uses the following order:
1) DHCP client UUID option.
2) MAC address (in lower case hexadecimal with dash separators);
3) IP (in upper case hexadecimal) or IPv6;
4) The original grub.cfg file.
This procedure is similar to what is used by pxelinux and yaboot:
http://www.syslinux.org/wiki/index.php/PXELINUX#config
---
Changes in v2:
- Add Reviewed-by tag from Daniel Kiper.
grub-core/net/net.c | 117 ++++++++++++++++++++++++++++++++++++++++ grub-core/normal/main.c | 17 ++++-- include/grub/net.h | 3 ++ 3 files changed, 133 insertions(+), 4 deletions(-)
grub-core/net/net.c +117 -0
@@ -1735,6 +1735,123 @@ grub_net_restore_hw (void)return GRUB_ERR_NONE ; } +grub_err_t +grub_net_search_config_file (char *config) +{ +grub_size_t config_len; +char *suffix; + + autoint search_through (grub_size_t num_tries,grub_size_t slice_size); +int search_through (grub_size_t num_tries,grub_size_t slice_size) + { +while (num_tries-- >0 ) + { +grub_dprintf ("net" ,"attempt to fetch config %s\n" , config); + +grub_file_t file; + file =grub_file_open (config,GRUB_FILE_TYPE_CONFIG ); + +if (file) + { +grub_file_close (file); +return 0 ; + } +else + { +if (grub_errno ==GRUB_ERR_IO ) + grub_errno =GRUB_ERR_NONE ; + } + +if (grub_strlen (suffix) < slice_size) +break ; + + config[grub_strlen (config) - slice_size] ='\0' ; + } + +return 1 ; + } + + config_len =grub_strlen (config); + config[config_len] ='-' ; + suffix = config + config_len +1 ; + +struct grub_net_network_level_interface *inf; +FOR_NET_NETWORK_LEVEL_INTERFACES (inf) + { +/* By the Client UUID. */ + +char client_uuid_var[sizeof ("net_" ) +grub_strlen (inf->name) + +sizeof ("_clientuuid" ) +1 ]; +grub_snprintf (client_uuid_var,sizeof (client_uuid_var), +"net_%s_clientuuid" , inf->name); + +const char *client_uuid; + client_uuid =grub_env_get (client_uuid_var); + +if (client_uuid) + { +grub_strcpy (suffix, client_uuid); +if (search_through (1 ,0 ) ==0 )return GRUB_ERR_NONE ; + } + +/* By the MAC address. */ + +/* Add ethernet type */ +grub_strcpy (suffix,"01-" ); + +grub_net_hwaddr_to_str (&inf->hwaddress, suffix +3 ); + +char *ptr; +for (ptr = suffix; *ptr; ptr++) +if (*ptr ==':' ) + *ptr ='-' ; + +if (search_through (1 ,0 ) ==0 )return GRUB_ERR_NONE ; + +/* By IP address */ + +switch ((&inf->address)->type) + { +case GRUB_NET_NETWORK_LEVEL_PROTOCOL_IPV4 : + { +grub_uint32_t n =grub_be_to_cpu32 ((&inf->address)->ipv4); +grub_snprintf (suffix,GRUB_NET_MAX_STR_ADDR_LEN ,"%02X%02X%02X%02X" , \ + ((n >>24 ) &0xff ), ((n >>16 ) &0xff ), \ + ((n >>8 ) &0xff ), ((n >>0 ) &0xff )); + +if (search_through (8 ,1 ) ==0 )return GRUB_ERR_NONE ; +break ; + } +case GRUB_NET_NETWORK_LEVEL_PROTOCOL_IPV6 : + { +char buf[GRUB_NET_MAX_STR_ADDR_LEN ]; +struct grub_net_network_level_address base; + base.type =GRUB_NET_NETWORK_LEVEL_PROTOCOL_IPV6 ; +grub_memcpy (&base.ipv6, ((&inf->address)->ipv6),16 ); +grub_net_addr_to_str (&base, buf); + +for (ptr = buf; *ptr; ptr++) +if (*ptr ==':' ) + *ptr ='-' ; + +grub_snprintf (suffix,GRUB_NET_MAX_STR_ADDR_LEN ,"%s" , buf); +if (search_through (1 ,0 ) ==0 )return GRUB_ERR_NONE ; +break ; + } +case GRUB_NET_NETWORK_LEVEL_PROTOCOL_DHCP_RECV : +return grub_error (GRUB_ERR_BUG ,"shouldn't reach here" ); +default : +return grub_error (GRUB_ERR_BUG , +"unsupported address type %d" , (&inf->address)->type); + } + } + +/* Remove the remaining minus sign at the end. */ + config[config_len] ='\0' ; + +return GRUB_ERR_NONE ; +} +static struct grub_preboot *fini_hnd;static grub_command_t cmd_addaddr, cmd_deladdr, cmd_addroute, cmd_delroute;
grub-core/normal/main.c +13 -4
@@ -323,10 +323,19 @@ grub_cmd_normal (struct grub_command *cmd __attribute__ ((unused)), prefix =grub_env_get ("prefix" );if (prefix) - { - config =grub_xasprintf ("%s/grub.cfg" , prefix); -if (! config) - goto quit; + { +grub_size_t config_len; + config_len =grub_strlen (prefix) + +sizeof ("/grub.cfg-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ); + config =grub_malloc (config_len); + +if (! config) + goto quit; + +grub_snprintf (config, config_len,"%s/grub.cfg" , prefix); + +if (grub_strncmp (prefix +1 ,"tftp" ,sizeof ("tftp" ) -1 ) ==0 ) +grub_net_search_config_file (config);grub_enter_normal_mode (config);grub_free (config);
include/grub/net.h +3 -0
@@ -578,4 +578,7 @@ extern char *grub_net_default_server;#define VLANTAG_IDENTIFIER 0x8100 +grub_err_t +grub_net_search_configfile (char *config); +#endif /* ! GRUB_NET_HEADER */
Signature · 1 line
2.21.0