mustberoot.subr revision 260678
1238438Sdteskeif [ ! "$_MUSTBEROOT_SUBR" ]; then _MUSTBEROOT_SUBR=1 2238438Sdteske# 3249746Sdteske# Copyright (c) 2006-2013 Devin Teske 4252980Sdteske# All rights reserved. 5238438Sdteske# 6238438Sdteske# Redistribution and use in source and binary forms, with or without 7238438Sdteske# modification, are permitted provided that the following conditions 8238438Sdteske# are met: 9238438Sdteske# 1. Redistributions of source code must retain the above copyright 10238438Sdteske# notice, this list of conditions and the following disclaimer. 11238438Sdteske# 2. Redistributions in binary form must reproduce the above copyright 12238438Sdteske# notice, this list of conditions and the following disclaimer in the 13238438Sdteske# documentation and/or other materials provided with the distribution. 14238438Sdteske# 15238438Sdteske# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16252987Sdteske# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17238438Sdteske# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18238438Sdteske# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19238438Sdteske# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20252987Sdteske# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21238438Sdteske# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22238438Sdteske# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23238438Sdteske# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24238438Sdteske# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25238438Sdteske# SUCH DAMAGE. 26238438Sdteske# 27238438Sdteske# $FreeBSD: stable/10/usr.sbin/bsdconfig/share/mustberoot.subr 260678 2014-01-15 07:49:17Z dteske $ 28238438Sdteske# 29238438Sdteske############################################################ INCLUDES 30238438Sdteske 31240684SdteskeBSDCFG_SHARE="/usr/share/bsdconfig" 32240684Sdteske. $BSDCFG_SHARE/common.subr || exit 1 33244675Sdteskef_dprintf "%s: loading includes..." mustberoot.subr 34240684Sdteskef_include $BSDCFG_SHARE/dialog.subr 35260678Sdteskef_include $BSDCFG_SHARE/strings.subr 36240684Sdteske 37238438SdteskeBSDCFG_LIBE="/usr/libexec/bsdconfig" 38238438Sdteskef_include_lang $BSDCFG_LIBE/include/messages.subr 39238438Sdteske 40238438Sdteske############################################################ CONFIGURATION 41238438Sdteske# NOTE: These are not able to be overridden/inherited for security purposes. 42238438Sdteske 43238438Sdteske# 44238438Sdteske# Number of tries a user gets to enter his/her password before we log the 45238438Sdteske# sudo(8) failure and exit. 46238438Sdteske# 47238438SdteskePASSWD_TRIES=3 48238438Sdteske 49238438Sdteske# 50238438Sdteske# While in SECURE mode, should authentication as `root' be allowed? Set to 51238438Sdteske# non-NULL to enable authentication as `root', otherwise disabled. 52238438Sdteske# 53238438Sdteske# WARNING: 54238438Sdteske# Unless using a custom sudo(8) configuration, user `root' should not be 55238438Sdteske# allowed because no password is required to become `root' when already `root' 56238438Sdteske# and therefore, any value entered as password will work. 57238438Sdteske# 58238438SdteskeSECURE_ALLOW_ROOT= 59238438Sdteske 60238438Sdteske# 61238438Sdteske# While in SECURE mode, should we divulge (through error message) when the 62238438Sdteske# requested authentication user does not exist? Set to non-NULL to enable, 63238438Sdteske# otherwise a non-existent user is treated like an invalid password. 64238438Sdteske# 65238438SdteskeSECURE_DIVULGE_UNKNOWN_USER= 66238438Sdteske 67238438Sdteske############################################################ FUNCTIONS 68238438Sdteske 69238438Sdteske# f_become_root_via_sudo 70238438Sdteske# 71238438Sdteske# If not running as root, prompt for sudo(8) credentials to become root. 72238438Sdteske# Re-execution of the current program via sudo is automatically handled. 73238438Sdteske# 74238438Sdteske# The following environment variables effect functionality: 75238438Sdteske# 76238438Sdteske# USE_XDIALOG Either NULL or Non-NULL. If given a value will indicate 77238438Sdteske# that Xdialog(1) should be used instead of dialog(1). 78238438Sdteske# 79238438Sdteskef_become_root_via_sudo() 80238438Sdteske{ 81260678Sdteske local funcname=f_become_root_via_sudo 82251264Sdteske local prompt hline height width rows msg 83238438Sdteske 84238438Sdteske [ "$( id -u )" = "0" ] && return $SUCCESS 85238438Sdteske 86238438Sdteske f_have sudo || f_die 1 "$msg_must_be_root_to_execute" "$pgm" 87238438Sdteske 88238438Sdteske # 89241653Sdteske # Ask the user if it's OK to become root via sudo(8) and give them 90241653Sdteske # the option to save this preference (by touch(1)ing a file in the 91241653Sdteske # user's $HOME directory). 92241653Sdteske # 93241653Sdteske local checkpath="${HOME%/}/.bsdconfig_uses_sudo" 94241653Sdteske if [ ! -e "$checkpath" ]; then 95260678Sdteske f_sprintf prompt "$msg_you_are_not_root_but" bsdconfig 96260678Sdteske f_sprintf msg "$msg_always_try_sudo_when_run_as" "$USER" 97241653Sdteske local menu_list=" 98241653Sdteske 'X' '$msg_cancel_exit' 99241653Sdteske '1' '$msg' 100241653Sdteske '2' '$msg_try_sudo_only_this_once' 101241653Sdteske " # END-QUOTE 102241653Sdteske hline="$hline_arrows_tab_enter" 103251264Sdteske 104251190Sdteske eval f_dialog_menu_size height width rows \ 105251190Sdteske \"\$DIALOG_TITLE\" \ 106251190Sdteske \"\$DIALOG_BACKTITLE\" \ 107251264Sdteske \"\$prompt\" \ 108251190Sdteske \"\$hline\" \ 109251190Sdteske $menu_list 110241653Sdteske 111251236Sdteske local mtag 112251236Sdteske mtag=$( eval $DIALOG \ 113241653Sdteske --title \"\$DIALOG_TITLE\" \ 114241653Sdteske --backtitle \"\$DIALOG_BACKTITLE\" \ 115241653Sdteske --hline \"\$hline\" \ 116241653Sdteske --ok-label \"\$msg_ok\" \ 117241653Sdteske --cancel-label \"\$msg_cancel\" \ 118251264Sdteske --menu \"\$prompt\" \ 119251190Sdteske $height $width $rows \ 120241653Sdteske $menu_list \ 121241653Sdteske 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD 122251236Sdteske ) || f_die 123251236Sdteske f_dialog_data_sanitize mtag 124241653Sdteske 125241653Sdteske case "$mtag" in 126241653Sdteske X) # Cancel/Exit 127241653Sdteske f_die ;; 128241653Sdteske 1) # Always try sudo(8) when run as $user 129260678Sdteske f_eval_catch $funcname touch \ 130260678Sdteske 'touch "%s"' "$checkpath" && 131241653Sdteske f_show_msg "$msg_created_path" "$checkpath" 132241653Sdteske esac 133241653Sdteske else 134241653Sdteske # 135241653Sdteske # This user has created the path signing-off on sudo(8)-use 136241653Sdteske # but let's still give them a short/quick/unobtrusive reminder 137241653Sdteske # 138241653Sdteske f_dialog_info "$msg_becoming_root_via_sudo" 139241653Sdteske [ "$USE_XDIALOG" ] || sleep 0.6 140241653Sdteske fi 141241653Sdteske 142241653Sdteske # 143238438Sdteske # Check sudo(8) access before prompting for password. 144238438Sdteske # 145240783Sdteske :| sudo -S -v 2> /dev/null 146238438Sdteske if [ $? -ne $SUCCESS ]; then 147238438Sdteske # 148238438Sdteske # sudo(8) access denied. Prompt for their password. 149238438Sdteske # 150251264Sdteske prompt="$msg_please_enter_password" 151238438Sdteske hline="$hline_alnum_punc_tab_enter" 152251190Sdteske f_dialog_inputbox_size height width \ 153251190Sdteske "$DIALOG_TITLE" \ 154251190Sdteske "$DIALOG_BACKTITLE" \ 155251264Sdteske "$prompt" \ 156251190Sdteske "$hline" 157238438Sdteske 158238438Sdteske # 159238438Sdteske # Continue prompting until they either Cancel, succeed 160238438Sdteske # or exceed the number of allowed failures. 161238438Sdteske # 162238438Sdteske local password nfailures=0 retval 163238438Sdteske while [ $nfailures -lt $PASSWD_TRIES ]; do 164238438Sdteske if [ "$USE_XDIALOG" ]; then 165238438Sdteske password=$( $DIALOG \ 166251190Sdteske --title "$DIALOG_TITLE" \ 167251190Sdteske --backtitle "$DIALOG_BACKTITLE" \ 168251190Sdteske --hline "$hline" \ 169251190Sdteske --ok-label "$msg_ok" \ 170251190Sdteske --cancel-label "$msg_cancel" \ 171251264Sdteske --password --inputbox "$prompt" \ 172251190Sdteske $height $width \ 173251266Sdteske 2>&1 > /dev/null 174251266Sdteske ) 175238438Sdteske retval=$? 176238438Sdteske 177238438Sdteske # Catch X11-related errors 178256181Sdteske if [ $retval -eq $DIALOG_ESC ]; then 179238438Sdteske f_die $retval "$password" 180256181Sdteske elif [ $retval -ne $DIALOG_OK ]; then 181251274Sdteske # User cancelled 182251274Sdteske exit $retval 183251274Sdteske fi 184238438Sdteske else 185251242Sdteske password=$( $DIALOG \ 186238438Sdteske --title "$DIALOG_TITLE" \ 187238438Sdteske --backtitle "$DIALOG_BACKTITLE" \ 188238438Sdteske --hline "$hline" \ 189238438Sdteske --ok-label "$msg_ok" \ 190238438Sdteske --cancel-label "$msg_cancel" \ 191238438Sdteske --insecure \ 192251264Sdteske --passwordbox "$prompt" \ 193251190Sdteske $height $width \ 194240768Sdteske 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD 195251242Sdteske ) || exit $? 196238438Sdteske fi 197251242Sdteske debug= f_dialog_line_sanitize password 198238438Sdteske 199238438Sdteske # 200238438Sdteske # Validate sudo(8) credentials 201238438Sdteske # 202240783Sdteske sudo -S -v 2> /dev/null <<-EOF 203238438Sdteske $password 204238438Sdteske EOF 205238438Sdteske retval=$? 206238438Sdteske unset password # scrub memory 207238438Sdteske if [ $retval -eq $SUCCESS ]; then 208238438Sdteske # Access granted... 209238438Sdteske break 210238438Sdteske else 211238438Sdteske # Access denied... 212238438Sdteske nfailures=$(( $nfailures + 1 )) 213238438Sdteske 214238438Sdteske # introduce a short delay 215238438Sdteske if [ $nfailures -lt $PASSWD_TRIES ]; then 216238438Sdteske f_dialog_info "$msg_sorry_try_again" 217238438Sdteske sleep 1 218238438Sdteske fi 219238438Sdteske fi 220238438Sdteske done 221238438Sdteske 222238438Sdteske # 223238438Sdteske # If user exhausted number of allowed password tries, log 224238438Sdteske # the security event and exit immediately. 225238438Sdteske # 226238438Sdteske if [ $nfailures -ge $PASSWD_TRIES ]; then 227260678Sdteske f_sprintf msg "$msg_nfailed_attempts" "$nfailures" 228238438Sdteske logger -p auth.notice -t sudo " " \ 229238438Sdteske "$USER : $msg" \ 230238438Sdteske "; TTY=$(tty)" \ 231238438Sdteske "; PWD=$PWD" \ 232238438Sdteske "; USER=root" \ 233238438Sdteske "; COMMAND=$0" 234238438Sdteske f_die 1 "sudo: $msg" 235238438Sdteske fi 236238438Sdteske fi 237238438Sdteske 238238438Sdteske # Use xauth(1) to grant root the ability to use this X11/SSH session 239238438Sdteske if [ "$USE_XDIALOG" -a "$SSH_CONNECTION" -a "$DISPLAY" ]; then 240238438Sdteske f_have xauth || f_die 1 \ 241238438Sdteske "$msg_no_such_file_or_directory" "$pgm" "xauth" 242238438Sdteske local HOSTNAME displaynum 243238438Sdteske HOSTNAME=$(hostname) 244238438Sdteske displaynum="${DISPLAY#*:}" 245238438Sdteske xauth -f ~/.Xauthority extract - $HOSTNAME/unix:$displaynum \ 246238438Sdteske $HOSTNAME:$displaynum | sudo sh -c 'xauth -ivf \ 247240783Sdteske ~root/.Xauthority merge - > /dev/null 2>&1' 248238438Sdteske fi 249238438Sdteske 250238438Sdteske # Re-execute ourselves with sudo(8) 251249746Sdteske f_dprintf "%s: Becoming root via sudo(8)..." mustberoot.subr 252238438Sdteske if [ $ARGC -gt 0 ]; then 253238438Sdteske exec sudo "$0" $ARGV 254238438Sdteske else 255238438Sdteske exec sudo "$0" 256238438Sdteske fi 257238438Sdteske exit $? # Never reached unless error 258238438Sdteske} 259238438Sdteske 260238438Sdteske# f_authenticate_some_user 261238438Sdteske# 262238438Sdteske# Only used if running as root and requires X11 (see USE_XDIALOG below). 263238438Sdteske# Prompts the user to enter a username and password to be authenticated via 264238438Sdteske# sudo(8) to proceed. 265238438Sdteske# 266238438Sdteske# The following environment variables effect functionality: 267238438Sdteske# 268238438Sdteske# USE_XDIALOG Either NULL or Non-NULL. If given a value will indicate 269238438Sdteske# that Xdialog(1) should be used instead of dialog(1). 270238438Sdteske# 271238438Sdteskef_authenticate_some_user() 272238438Sdteske{ 273251190Sdteske local msg hline height width 274238438Sdteske 275238438Sdteske f_have sudo || f_die 1 "$msg_must_be_root_to_execute" "$pgm" 276238438Sdteske 277238438Sdteske # 278238438Sdteske # Secure-mode has been requested. 279238438Sdteske # 280243476Sdteske 281238438Sdteske [ "$USE_XDIALOG" ] || f_die 1 "$msg_secure_mode_requires_x11" 282238438Sdteske [ "$(id -u)" = "0" ] || f_die 1 "$msg_secure_mode_requires_root" 283238438Sdteske 284238438Sdteske # 285238438Sdteske # Prompt for sudo(8) credentials. 286238438Sdteske # 287238438Sdteske 288238438Sdteske msg="$msg_please_enter_username_password" 289238438Sdteske hline="$hline_alnum_punc_tab_enter" 290251190Sdteske f_xdialog_2inputsbox_size height width \ 291251190Sdteske "$DIALOG_TITLE" \ 292251190Sdteske "$DIALOG_BACKTITLE" \ 293251190Sdteske "$msg" \ 294251190Sdteske "$field_username" "" \ 295251190Sdteske "$field_password" "" 296238438Sdteske height=$(( $height + 2 )) # Add height for --password 297238438Sdteske 298238438Sdteske # 299238438Sdteske # Continue prompting until they either Cancel, succeed or exceed the 300238438Sdteske # number of allowed failures. 301238438Sdteske # 302238438Sdteske local user_pass nfailures=0 retval 303238438Sdteske while [ $nfailures -lt $PASSWD_TRIES ]; do 304238438Sdteske user_pass=$( $DIALOG \ 305238438Sdteske --title "$DIALOG_TITLE" \ 306238438Sdteske --backtitle "$DIALOG_BACKTITLE" \ 307238438Sdteske --hline "$hline" \ 308238438Sdteske --ok-label "$msg_ok" \ 309238438Sdteske --cancel-label "$msg_cancel" \ 310238438Sdteske --password --2inputsbox "$msg" \ 311238438Sdteske $height $width \ 312238438Sdteske "$field_username" "" \ 313238438Sdteske "$field_password" "" \ 314240783Sdteske 2>&1 > /dev/null ) 315238438Sdteske retval=$? 316238438Sdteske 317238438Sdteske # Catch X11-related errors 318256181Sdteske [ $retval -eq $DIALOG_ESC ] && f_die $retval "$user_pass" 319238438Sdteske 320238438Sdteske # Exit if the user cancelled. 321256181Sdteske [ $retval -eq $DIALOG_OK ] || exit $retval 322238438Sdteske 323238438Sdteske # 324238438Sdteske # Make sure the user exists and is non-root 325238438Sdteske # 326238438Sdteske local user password 327238438Sdteske user="${user_pass%%/*}" 328238438Sdteske password="${user_pass#*/}" 329238438Sdteske unset user_pass # scrub memory 330238438Sdteske if [ ! "$user" ]; then 331238438Sdteske nfailures=$(( $nfailures + 1 )) 332252795Sdteske f_show_msg "$msg_no_username" 333238438Sdteske continue 334238438Sdteske fi 335238438Sdteske if [ ! "$SECURE_ALLOW_ROOT" ]; then 336238438Sdteske case "$user" in 337238438Sdteske root|toor) 338238438Sdteske nfailures=$(( $nfailures + 1 )) 339244554Sdteske f_show_msg "$msg_user_disallowed" "$user" 340238438Sdteske continue 341238438Sdteske esac 342238438Sdteske fi 343238438Sdteske if ! f_quietly id "$user"; then 344238438Sdteske nfailures=$(( $nfailures + 1 )) 345238438Sdteske if [ "$SECURE_DIVULGE_UNKNOWN_USER" ]; then 346244554Sdteske f_show_msg "$msg_unknown_user" "$user" 347238438Sdteske elif [ $nfailures -lt $PASSWD_TRIES ]; then 348238438Sdteske f_dialog_info "$msg_sorry_try_again" 349238438Sdteske sleep 1 350238438Sdteske fi 351238438Sdteske continue 352238438Sdteske fi 353238438Sdteske 354238438Sdteske # 355238438Sdteske # Validate sudo(8) credentials for given user 356238438Sdteske # 357238438Sdteske su -m "$user" <<-EOF 358238438Sdteske sh <<EOS 359238438Sdteske sudo -k 360240783Sdteske sudo -S -v 2> /dev/null <<EOP 361238438Sdteske $password 362238438Sdteske EOP 363238438Sdteske EOS 364238438Sdteske EOF 365238438Sdteske retval=$? 366238438Sdteske unset user 367238438Sdteske unset password # scrub memory 368238438Sdteske 369238438Sdteske if [ $retval -eq $SUCCESS ]; then 370238438Sdteske # Access granted... 371238438Sdteske break 372238438Sdteske else 373238438Sdteske # Access denied... 374238438Sdteske nfailures=$(( $nfailures + 1 )) 375238438Sdteske 376238438Sdteske # introduce a short delay 377238438Sdteske if [ $nfailures -lt $PASSWD_TRIES ]; then 378238438Sdteske f_dialog_info "$msg_sorry_try_again" 379238438Sdteske sleep 1 380238438Sdteske fi 381238438Sdteske fi 382238438Sdteske done 383238438Sdteske 384238438Sdteske # 385238438Sdteske # If user exhausted number of allowed password tries, log 386238438Sdteske # the security event and exit immediately. 387238438Sdteske # 388238438Sdteske if [ $nfailures -ge $PASSWD_TRIES ]; then 389260678Sdteske f_sprintf msg "$msg_nfailed_attempts" "$nfailures" 390238438Sdteske logger -p auth.notice -t sudo " " \ 391238438Sdteske "${SUDO_USER:-$USER} : $msg" \ 392238438Sdteske "; TTY=$(tty)" \ 393238438Sdteske "; PWD=$PWD" \ 394238438Sdteske "; USER=root" \ 395238438Sdteske "; COMMAND=$0" 396238438Sdteske f_die 1 "sudo: $message" 397238438Sdteske fi 398238438Sdteske} 399238438Sdteske 400238438Sdteske# f_mustberoot_init 401238438Sdteske# 402238438Sdteske# If not already root, make the switch to root by re-executing ourselves via 403238438Sdteske# sudo(8) using user-supplied credentials. 404238438Sdteske# 405238438Sdteske# The following environment variables effect functionality: 406238438Sdteske# 407238438Sdteske# SECURE Either NULL or Non-NULL. If given a value will indicate 408238438Sdteske# that (while running as root) sudo(8) authentication is 409238438Sdteske# required to proceed. 410238438Sdteske# 411238438Sdteskef_mustberoot_init() 412238438Sdteske{ 413238438Sdteske if [ "$(id -u)" != "0" -a ! "$SECURE" ]; then 414238438Sdteske f_become_root_via_sudo 415238438Sdteske elif [ "$SECURE" ]; then 416238438Sdteske f_authenticate_some_user 417238438Sdteske fi 418238438Sdteske} 419238438Sdteske 420244675Sdteske############################################################ MAIN 421244675Sdteske 422244675Sdteskef_dprintf "%s: Successfully loaded." mustberoot.subr 423244675Sdteske 424238438Sdteskefi # ! $_MUSTBEROOT_SUBR 425