http.subr revision 256181
1if [ ! "$_MEDIA_HTTP_SUBR" ]; then _MEDIA_HTTP_SUBR=1 2# 3# Copyright (c) 2012-2013 Devin Teske 4# All rights reserved. 5# 6# Redistribution and use in source and binary forms, with or without 7# modification, are permitted provided that the following conditions 8# are met: 9# 1. Redistributions of source code must retain the above copyright 10# notice, this list of conditions and the following disclaimer. 11# 2. Redistributions in binary form must reproduce the above copyright 12# notice, this list of conditions and the following disclaimer in the 13# documentation and/or other materials provided with the distribution. 14# 15# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25# SUCH DAMAGE. 26# 27# $FreeBSD: head/usr.sbin/bsdconfig/share/media/http.subr 256181 2013-10-09 08:12:26Z dteske $ 28# 29############################################################ INCLUDES 30 31BSDCFG_SHARE="/usr/share/bsdconfig" 32. $BSDCFG_SHARE/common.subr || exit 1 33f_dprintf "%s: loading includes..." media/http.subr 34f_include $BSDCFG_SHARE/device.subr 35f_include $BSDCFG_SHARE/dialog.subr 36f_include $BSDCFG_SHARE/media/common.subr 37f_include $BSDCFG_SHARE/media/tcpip.subr 38f_include $BSDCFG_SHARE/strings.subr 39f_include $BSDCFG_SHARE/struct.subr 40f_include $BSDCFG_SHARE/variable.subr 41 42BSDCFG_LIBE="/usr/libexec/bsdconfig" 43f_include_lang $BSDCFG_LIBE/include/messages.subr 44 45############################################################ GLOBALS 46 47HTTP_SKIP_RESOLV= 48 49URL_MAX=261261 50 # NOTE: This is according to actual fetch(1) test-results. We actually 51 # use nc(1) to retrieve files, but it's still a good idea to keep the 52 # URLs short enough that fetch(1) won't complain. 53 54HTTP_DIRS=" 55 . 56 releases/$UNAME_P 57 snapshots/$UNAME_P 58 pub/FreeBSD 59 pub/FreeBSD/releases/$UNAME_P 60 pub/FreeBSD/snapshots/$UNAME_P 61 pub/FreeBSD-Archive/old-releases/$UNAME_P 62" # END-QUOTE 63 64############################################################ FUNCTIONS 65 66# f_dialog_menu_media_http 67# 68# Prompt the user to select from a range of ``built-in'' HTTP servers or 69# specify their own. If the user makes a choice and doesn't cancel or press 70# Esc, stores the user's choice in VAR_FTP_PATH (see variable.subr) and returns 71# success. 72# 73f_dialog_menu_media_http() 74{ 75 f_dialog_title "$msg_please_select_a_freebsd_http_distribution_site" 76 local title="$DIALOG_TITLE" btitle="$DIALOG_BACKTITLE" 77 f_dialog_title_restore 78 local prompt="$msg_please_select_the_site_closest_to_you_or_other" 79 local menu_list=" 80 '$msg_main_site' 'ftp.freebsd.org' 81 'URL' '$msg_specify_some_other_http_site' 82 " # END-QUOTE 83 local hline="$msg_select_a_site_thats_close" 84 85 local height width rows 86 eval f_dialog_menu_size height width rows \ 87 \"\$title\" \ 88 \"\$btitle\" \ 89 \"\$prompt\" \ 90 \"\$hline\" \ 91 $menu_list 92 93 local mtag 94 mtag=$( eval $DIALOG \ 95 --title \"\$title\" \ 96 --backtitle \"\$btitle\" \ 97 --hline \"\$hline\" \ 98 --ok-label \"\$msg_ok\" \ 99 --cancel-label \"\$msg_cancel\" \ 100 --menu \"\$prompt\" \ 101 $height $width $rows \ 102 $menu_list \ 103 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD 104 ) || return $DIALOG_CANCEL 105 f_dialog_data_sanitize mtag 106 107 case "$mtag" in 108 URL) setvar $VAR_HTTP_PATH "other" ;; 109 *) 110 local value 111 value=$( eval f_dialog_menutag2item \"\$mtag\" $menu_list ) 112 setvar $VAR_HTTP_PATH "http://$value" 113 esac 114 115 return $DIALOG_OK 116} 117 118# f_media_set_http 119# 120# Return success if we both found and set the media type to be an HTTP server. 121# 122# Variables from variable.subr that can be used to script user input: 123# 124# VAR_HTTP_PATH 125# URL containing host and optionally a target path to the release 126# repository on the HTTP server. Valid examples include: 127# http://myhost 128# http://somename:80/pub/ 129# http://192.168.2.3/pub/ 130# http://[::1]:8000/ 131# The default port if not specified is 80. 132# VAR_NAMESERVER [Optional] 133# If set, overrides resolv.conf(5) and sets the nameserver that 134# is used to convert names into addresses (when a name converts 135# into multiple addresses, the first address to successfully 136# connect is used). 137# 138# Meanwhile, the following variables from variable.subr are set after 139# successful execution: 140# 141# VAR_HTTP_HOST 142# The HTTP host to connect to, parsed from VAR_HTTP_PATH. In the 143# example case of IPv6 where VAR_HTTP_PATH is "http://[::1]" this 144# variable will be set to "::1" (the outer brackets are removed). 145# VAR_HTTP_PORT 146# The TCP port to connect to, parsed from VAR_HTTP_PATH. Usually 147# 80 unless VAR_HTTP_PATH was one of the following forms: 148# http://hostname:OTHER_PORT 149# http://hostname:OTHER_PORT/* 150# http://ip:OTHER_PORT 151# http://ip:OTHER_PORT/* 152# http://[ip6]:OTHER_PORT 153# http://[ip6]:OTHER_PORT/* 154# VAR_HTTP_DIR 155# If VAR_HTTP_PATH contained a directory element (e.g., 156# "http://localhost/pub") this variable contains only the 157# directory element (e.g., "/pub"). 158# 159f_media_set_http() 160{ 161 f_media_close 162 163 local url 164 f_getvar $VAR_HTTP_PATH url 165 166 # If we've been through here before ... 167 if f_struct device_network && [ "${url#$msg_other}" ]; then 168 f_dialog_yesno "$msg_reuse_old_http_site_settings" || url= 169 fi 170 171 if [ ! "$url" ]; then 172 f_dialog_menu_media_http || return $FAILURE 173 f_getvar $VAR_HTTP_PATH url 174 fi 175 [ "$url" ] || return $FAILURE 176 177 case "$url" in 178 other) 179 setvar $VAR_HTTP_PATH "http://" 180 f_variable_get_value $VAR_HTTP_PATH \ 181 "$msg_please_specify_url_of_freebsd_http_distribution" 182 f_getvar $VAR_HTTP_PATH url 183 if [ ! "${url#http://}" ]; then 184 unset $VAR_HTTP_PATH 185 return $FAILURE 186 fi 187 if [ ${#url} -gt ${URL_MAX:-261261} ]; then 188 f_show_msg "$msg_length_of_specified_url_is_too_long" \ 189 ${#url} ${URL_MAX:-261261} 190 unset $VAR_HTTP_PATH 191 return $FAILURE 192 fi 193 case "$url" in 194 http://*) : valid URL ;; 195 *) 196 f_show_msg "$msg_sorry_invalid_url" "$url" 197 unset $VAR_HTTP_PATH 198 return $FAILURE 199 esac 200 esac 201 case "$url" in 202 http://*) : valid URL ;; 203 *) 204 f_show_msg "$msg_sorry_invalid_url" "$url" 205 unset $VAR_HTTP_PATH 206 return $FAILURE 207 esac 208 209 # Set the name of the HTTP device to the URL 210 f_struct_new DEVICE device_http 211 device_http set name "$url" 212 213 if ! f_struct device_network || 214 ! f_dialog_yesno "$msg_youve_already_done_the_network_configuration" 215 then 216 f_struct device_network && 217 f_device_shutdown network 218 if ! f_device_select_tcp; then 219 unset $VAR_HTTP_PATH 220 return $FAILURE 221 fi 222 local dev 223 f_getvar $VAR_NETWORK_DEVICE dev 224 f_struct_copy "device_$dev" device_network 225 fi 226 if ! f_device_init network; then 227 f_dprintf "f_media_set_http: %s" "$msg_net_device_init_failed" 228 unset $VAR_HTTP_PATH 229 return $FAILURE 230 fi 231 232 local hostname="${url#*://}" port=80 dir=/ 233 case "$hostname" in 234 # 235 # The order in-which the below individual cases appear is important! 236 # 237 "["*"]":*/*) # IPv6 address with port and directory 238 f_dprintf "Looks like an IPv6 addr with port/dir: %s" \ 239 "$hostname" 240 hostname="${hostname#\[}" 241 port="${hostname#*\]:}" 242 port="${port%%[!0-9]*}" 243 dir="/${hostname#*/}" 244 hostname="${hostname%%\]:*}" 245 ;; 246 "["*"]":*) # IPv6 address with port 247 f_dprintf "Looks like an IPv6 addr with port: %s" "$hostname" 248 hostname="${hostname#\[}" 249 port="${hostname#*\]:}" 250 port="${port%%[!0-9]*}" 251 hostname="${hostname%%\]:*}" 252 ;; 253 "["*"]"/*) # IPv6 address with directory 254 f_dprintf "Looks like an IPv6 addr with dir: %s" "$hostname" 255 hostname="${hostname#\[}" 256 dir="/${hostname#*/}" 257 hostname="${hostname%%\]*}" 258 ;; 259 "["*"]") # IPv6 address 260 f_dprintf "Looks like an IPv6 addr: %s" "$hostname" 261 hostname="${hostname#\[}" 262 hostname="${hostname%\]}" 263 ;; 264 # 265 # ^^^ IPv6 above / DNS Name or IPv4 below vvv 266 # 267 *:*/*) # DNS name or IPv4 address with port and directory 268 f_dprintf "Looks like a %s with port/dir: %s" \ 269 "DNS name or IPv4 addr" "$hostname" 270 port="${hostname#*:}" 271 port="${port%%[!0-9]*}" 272 dir="/${hostname#*/}" 273 hostname="${hostname%%:*}" 274 ;; 275 *:*) # DNS name or IPv4 address with port 276 f_dprintf "Looks like a DNS name or IPv4 addr with port: %s" \ 277 "$hostname" 278 port="${hostname#*:}" 279 hostname="${hostname%%:*}" 280 ;; 281 */*) # DNS name or IPv4 address with directory 282 f_dprintf "Looks like a DNS name or IPv4 addr with dir: %s" \ 283 "$hostname" 284 dir="/${hostname#*/}" 285 hostname="${hostname%%/*}" 286 ;; 287 *) # DNS name or IPv4 address 288 f_dprintf "Looks like a DNS name or IPv4 addr: %s" "$hostname" 289 : leave hostname as-is 290 esac 291 292 f_dprintf "hostname = \`%s'" "$hostname" 293 f_dprintf "dir = \`%s'" "$dir" 294 f_dprintf "port \# = \`%d'" "$port" 295 296 local ns 297 f_getvar $VAR_NAMESERVER ns 298 [ "$ns" ] || f_resolv_conf_nameservers ns 299 if [ "$ns" -a ! "$HTTP_SKIP_RESOLV" ] && ! { 300 f_validate_ipaddr "$hostname" || 301 f_validate_ipaddr6 "$hostname" 302 }; then 303 f_show_info "$msg_looking_up_host" "$hostname" 304 f_dprintf "%s: Looking up hostname, %s, using host(1)" \ 305 "f_media_set_http" "$hostname" 306 if ! f_quietly f_host_lookup "$hostname"; then 307 f_show_msg "$msg_cannot_resolve_hostname" "$hostname" 308 f_struct device_network && 309 f_device_shutdown network 310 f_struct_free device_network 311 unset $VAR_HTTP_PATH 312 return $FAILURE 313 fi 314 f_dprintf "Found DNS entry for %s successfully." "$hostname" 315 fi 316 317 setvar $VAR_HTTP_HOST "$hostname" 318 setvar $VAR_HTTP_PORT "$port" 319 setvar $VAR_HTTP_DIR "$dir" 320 321 device_http set type $DEVICE_TYPE_HTTP 322 device_http set init f_media_init_http 323 device_http set get f_media_get_http 324 device_http set shutdown f_media_shutdown_http 325 device_http set private network 326 f_struct_copy device_http device_media 327 f_struct_free device_http 328 329 return $SUCCESS 330} 331 332# f_http_check_access [$connect_only] 333# 334# Return success if able list a remote HTTP directory. If $connect_only is 335# present and non-null, then returns success if a connection can be made. 336# Variables from variable.subr that can be used to script user input: 337# 338# VAR_HTTP_HOST 339# The HTTP server host name, IPv4 address or IPv6 address. 340# Valid examples include: 341# myhost 342# 192.168.2.3 343# ::1 344# VAR_HTTP_PORT 345# The TCP port to connect to when communicating with the server. 346# VAR_HTTP_PATH 347# The HTTP path sent to the server. Unused if $connect_only is 348# present and non-NULL. 349# 350f_http_check_access() 351{ 352 local connect_only="$1" hosts= 353 354 local http_host http_port 355 f_getvar $VAR_HTTP_HOST http_host 356 f_getvar $VAR_HTTP_PORT http_port 357 358 if ! { 359 f_validate_ipaddr "$http_host" || 360 f_validate_ipaddr6 "$http_host" || 361 { 362 f_dprintf "%s: Looking up hostname, %s, using host(1)" \ 363 "f_http_check_access" "$http_host" 364 f_host_lookup "$http_host" hosts 365 } 366 }; then 367 # All the above validations failed 368 [ "$hosts" ] && f_dialog_msgbox "$hosts" 369 unset $VAR_HTTP_HOST 370 return $FAILURE 371 elif [ ! "$hosts" ]; then 372 # One of the first two validations passed 373 hosts="$http_host" 374 fi 375 376 local host connected= 377 for host in $hosts; do 378 f_quietly nc -nz "$host" "$http_port" || continue 379 connected=1; break 380 done 381 if [ ! "$connected" ]; then 382 f_show_msg "$msg_couldnt_connect_to_server http://%s:%s/" \ 383 "$http_host" "$http_port" 384 unset $VAR_HTTP_HOST 385 return $FAILURE 386 fi 387 [ "$connect_only" ] && return $SUCCESS 388 389 local http_path 390 f_getvar $VAR_HTTP_PATH http_path 391 f_show_info "$msg_checking_access_to" "$http_path" 392 393 local rx 394 case "$http_path" in 395 http://*|/*) : valid request ;; 396 *) http_path="/$http_path" # full URI requests only 397 esac 398 if ! rx=$( 399 printf "GET %s/ HTTP/1.0\r\n\r\n" "${http_path%/}" | 400 nc -n "$host" "$http_port" 401 ); then 402 f_show_msg "$msg_couldnt_connect_to_server http://%s:%s/" \ 403 "$http_host" "$http_port" 404 unset $VAR_HTTP_HOST 405 return $FAILURE 406 fi 407 408 local hdr 409 hdr=$( echo "$rx" | awk '/^\r$/{exit}{print}' ) 410 411 local http_found=$FAILURE 412 if echo "$hdr" | awk ' 413 BEGIN { found = 0 } 414 /^HTTP.... 200 / { 415 found = 1 416 exit 417 } 418 END { exit ! found } 419 '; then 420 http_found=$SUCCESS 421 fi 422 423 return $http_found 424} 425 426# f_media_init_http $device 427# 428# Initializes the HTTP media device. Returns success if able to confirm the 429# existence of at least one known HTTP server release path directly via HTTP 430# using f_http_check_access(), above. 431# 432# Variables from variable.subr that can be used to script user input: 433# 434# VAR_HTTP_HOST 435# The HTTP server to connect to. Must be set. Also see 436# f_http_check_access() for additional variables. 437# VAR_RELNAME 438# Usually set to `uname -r' but can be overridden. 439# VAR_HTTP_PATH 440# The HTTP path sent to the server. Usually set by calling 441# f_media_set_http(). 442# 443# Meanwhile, after successful execution, the following variables (also from 444# variable.subr) are set: 445# 446# VAR_HTTP_PATH 447# The [possibly] adjusted VAR_HTTP_PATH that was found to contain 448# a valid FreeBSD repository. 449# 450f_media_init_http() 451{ 452 local dev="$1" 453 f_dprintf "Init routine called for HTTP device. dev=[%s]" "$dev" 454 455 # 456 # First verify access 457 # 458 local connect_only=1 459 f_http_check_access $connect_only 460 461 local http_host 462 f_getvar $VAR_HTTP_HOST http_host 463 while [ ! "$http_host" ]; do 464 f_media_set_http || return $FAILURE 465 f_http_check_access $connect_only 466 f_getvar $VAR_HTTP_HOST http_host 467 done 468 469 local http_path http_found=$FAILURE 470 while :; do 471 # 472 # Now that we've verified that the path we're given is ok, 473 # let's try to be a bit intelligent in locating the release we 474 # are looking for. First off, if the release is specified as 475 # "__RELEASE" or "any", then just assume that the current 476 # directory is the one we want and give up. 477 # 478 local rel 479 f_getvar $VAR_RELNAME rel 480 f_dprintf "f_media_init_http: rel=[%s]" "$rel" 481 482 case "$rel" in 483 __RELEASE|any) 484 setvar $VAR_HTTP_PATH "$VAR_HTTP_DIR" 485 f_http_check_access 486 http_found=$? 487 ;; 488 *) 489 # 490 # Ok, since we have a release variable, let's walk 491 # through the list of directories looking for a release 492 # directory. First successful path wins. 493 # 494 local fdir hp 495 f_getvar $VAR_HTTP_PATH%/ hp 496 for fdir in $HTTP_DIRS; do 497 setvar $VAR_HTTP_PATH "$hp/$fdir/$rel" 498 if f_http_check_access; then 499 http_found=$SUCCESS 500 break 501 fi 502 done 503 esac 504 505 [ $http_found -eq $SUCCESS ] && break 506 507 f_getvar $VAR_HTTP_PATH http_path 508 f_show_msg "$msg_please_check_the_url_and_try_again" \ 509 "$http_path" 510 511 unset $VAR_HTTP_PATH 512 f_media_set_http || break 513 done 514 515 return $http_found 516} 517 518# f_media_get_http $device $file [$probe_type] 519# 520# Returns data from $file on an HTTP server using nc(1). Please note that 521# $device is unused but must be present (even if null). Information is instead 522# gathered from the environment. If $probe_type is both present and non-NULL, 523# this function exits after receiving the HTTP header response from the server 524# (if the HTTP response code is 200, success is returned; otherwise failure). 525# If $probe_type is equal to $PROBE_SIZE, prints the content-length in bytes 526# from the response (or -1 if not found) to standard-out. 527# 528# The variables used to configure the connection are as follows (all of which 529# are configured by f_media_set_http above): 530# 531# VAR_HTTP_HOST 532# HTTP server which to connect. Can be an IPv4 address, IPv6 533# address, or DNS hostname of your choice. 534# VAR_HTTP_PORT 535# TCP port to connect on; see f_media_set_http above. 536# VAR_HTTP_PATH 537# Directory prefix to use when requesting $file. Default is `/' 538# unless f_media_init_http was able to use f_http_check_access 539# to validate one of the defaults in $HTTP_DIRS (see GLOBALS at 540# the top of this file); assuming VAR_RELNAME was not set to 541# either `__RELEASE' or `any' (indicating that the global set of 542# $HTTP_DIRS should be ignored). 543# 544# See variable.subr for additional information. 545# 546# Example usage: 547# f_media_set_http 548# f_media_get_http media $file 549# 550f_media_get_http() 551{ 552 local dev="$1" file="$2" probe_type="$3" hosts= 553 554 f_dprintf "f_media_get_http: dev=[%s] file=[%s] probe_type=%s" \ 555 "$dev" "$file" "$probe_type" 556 557 local http_host http_port 558 f_getvar $VAR_HTTP_HOST http_host 559 f_getvar $VAR_HTTP_PORT http_port 560 561 if ! { 562 f_validate_ipaddr "$http_host" || 563 f_validate_ipaddr6 "$http_host" || 564 { 565 f_dprintf "%s: Looking up hostname, %s, using host(1)" \ 566 "f_media_get_http" "$http_host" 567 f_host_lookup "$http_host" hosts 568 } 569 }; then 570 # All the above validations failed 571 [ "$hosts" ] && f_dialog_msgbox "$hosts" 572 return $FAILURE 573 elif [ ! "$hosts" ]; then 574 # One of the first two validations passed 575 hosts="$http_host" 576 fi 577 578 local host connected= 579 for host in $hosts; do 580 f_quietly nc -nz "$host" "$http_port" || continue 581 connected=1; break 582 done 583 if [ ! "$connected" ]; then 584 f_show_msg "$msg_couldnt_connect_to_server http://%s:%s/" \ 585 "$http_host" "$http_port" 586 return $FAILURE 587 fi 588 589 local http_path 590 f_getvar $VAR_HTTP_PATH%/ http_path 591 case "$http_path" in 592 http://*|/*) : valid request ;; 593 *) http_path="/$http_path" # full URI requests only 594 esac 595 596 local url="$http_path/$file" rx 597 f_dprintf "sending http request for: %s" "$url" 598 printf "GET %s HTTP/1.0\r\n\r\n" "$url" | nc -n "$host" "$http_port" | 599 ( 600 # 601 # scan the headers of the response 602 # this is extremely quick'n dirty 603 # 604 605 rv=0 length=-1 606 while read LINE; do 607 case "$LINE" in 608 HTTP*) 609 f_dprintf "received response: %s" "$LINE" 610 set -- $LINE; rv=$2 611 f_isinteger "$rv" || rv=0 612 ;; 613 "Content-Length: "*) 614 length="${LINE% 615}" 616 length="${length#Content-Length: }" 617 f_dprintf "received content-length: %s" \ 618 "$length" 619 ;; 620 *) 621 [ "${LINE% 622}" ] || break # End of headers 623 esac 624 done 625 626 [ $rv -ge 500 ] && exit 5 627 [ $rv -eq 404 ] && exit 44 628 [ $rv -ge 400 ] && exit 4 629 [ $rv -ge 300 ] && exit 3 630 [ $rv -eq 200 ] || exit $FAILURE 631 632 if [ ! "$probe_type" ]; then 633 cat # output the rest ``as-is'' 634 elif [ "$probe_type" = "$PROBE_SIZE" ]; then 635 f_isinteger "$length" || length=-1 636 echo "$length" 637 fi 638 exit 200 639 ) 640 local retval=$? 641 [ $retval -eq 200 ] && return $SUCCESS 642 [ "$probe_type" ] && return $FAILURE 643 644 case "$retval" in 645 5) f_show_msg "$msg_server_error_when_requesting_url" "$url" ;; 646 44) f_show_msg "$msg_url_was_not_found" "$url" ;; 647 4) f_show_msg "$msg_client_error" ;; 648 *) f_show_msg "$msg_error_when_requesting_url" "$url" ;; 649 esac 650 return $FAILURE 651} 652 653############################################################ MAIN 654 655f_dprintf "%s: Successfully loaded." media/http.subr 656 657fi # ! $_MEDIA_HTTP_SUBR 658