mustberoot.subr revision 251264
1238438Sdteskeif [ ! "$_MUSTBEROOT_SUBR" ]; then _MUSTBEROOT_SUBR=1 2238438Sdteske# 3249746Sdteske# Copyright (c) 2006-2013 Devin Teske 4238438Sdteske# 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 16238438Sdteske# 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 20238438Sdteske# DAMAGES (INLUDING, 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: head/usr.sbin/bsdconfig/share/mustberoot.subr 251264 2013-06-02 20:02:50Z 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 35240684Sdteske 36238438SdteskeBSDCFG_LIBE="/usr/libexec/bsdconfig" 37238438Sdteskef_include_lang $BSDCFG_LIBE/include/messages.subr 38238438Sdteske 39238438Sdteske############################################################ CONFIGURATION 40238438Sdteske# NOTE: These are not able to be overridden/inherited for security purposes. 41238438Sdteske 42238438Sdteske# 43238438Sdteske# Number of tries a user gets to enter his/her password before we log the 44238438Sdteske# sudo(8) failure and exit. 45238438Sdteske# 46238438SdteskePASSWD_TRIES=3 47238438Sdteske 48238438Sdteske# 49238438Sdteske# While in SECURE mode, should authentication as `root' be allowed? Set to 50238438Sdteske# non-NULL to enable authentication as `root', otherwise disabled. 51238438Sdteske# 52238438Sdteske# WARNING: 53238438Sdteske# Unless using a custom sudo(8) configuration, user `root' should not be 54238438Sdteske# allowed because no password is required to become `root' when already `root' 55238438Sdteske# and therefore, any value entered as password will work. 56238438Sdteske# 57238438SdteskeSECURE_ALLOW_ROOT= 58238438Sdteske 59238438Sdteske# 60238438Sdteske# While in SECURE mode, should we divulge (through error message) when the 61238438Sdteske# requested authentication user does not exist? Set to non-NULL to enable, 62238438Sdteske# otherwise a non-existent user is treated like an invalid password. 63238438Sdteske# 64238438SdteskeSECURE_DIVULGE_UNKNOWN_USER= 65238438Sdteske 66238438Sdteske############################################################ FUNCTIONS 67238438Sdteske 68238438Sdteske# f_become_root_via_sudo 69238438Sdteske# 70238438Sdteske# If not running as root, prompt for sudo(8) credentials to become root. 71238438Sdteske# Re-execution of the current program via sudo is automatically handled. 72238438Sdteske# 73238438Sdteske# The following environment variables effect functionality: 74238438Sdteske# 75238438Sdteske# USE_XDIALOG Either NULL or Non-NULL. If given a value will indicate 76238438Sdteske# that Xdialog(1) should be used instead of dialog(1). 77238438Sdteske# 78238438Sdteskef_become_root_via_sudo() 79238438Sdteske{ 80251264Sdteske local prompt hline height width rows msg 81238438Sdteske 82238438Sdteske [ "$( id -u )" = "0" ] && return $SUCCESS 83238438Sdteske 84238438Sdteske f_have sudo || f_die 1 "$msg_must_be_root_to_execute" "$pgm" 85238438Sdteske 86238438Sdteske # 87241653Sdteske # Ask the user if it's OK to become root via sudo(8) and give them 88241653Sdteske # the option to save this preference (by touch(1)ing a file in the 89241653Sdteske # user's $HOME directory). 90241653Sdteske # 91241653Sdteske local checkpath="${HOME%/}/.bsdconfig_uses_sudo" 92241653Sdteske if [ ! -e "$checkpath" ]; then 93251264Sdteske prompt=$( printf "$msg_you_are_not_root_but" bsdconfig ) 94241653Sdteske msg=$( printf "$msg_always_try_sudo_when_run_as" "$USER" ) 95241653Sdteske local menu_list=" 96241653Sdteske 'X' '$msg_cancel_exit' 97241653Sdteske '1' '$msg' 98241653Sdteske '2' '$msg_try_sudo_only_this_once' 99241653Sdteske " # END-QUOTE 100241653Sdteske hline="$hline_arrows_tab_enter" 101251264Sdteske 102251190Sdteske eval f_dialog_menu_size height width rows \ 103251190Sdteske \"\$DIALOG_TITLE\" \ 104251190Sdteske \"\$DIALOG_BACKTITLE\" \ 105251264Sdteske \"\$prompt\" \ 106251190Sdteske \"\$hline\" \ 107251190Sdteske $menu_list 108241653Sdteske 109251236Sdteske local mtag 110251236Sdteske mtag=$( eval $DIALOG \ 111241653Sdteske --title \"\$DIALOG_TITLE\" \ 112241653Sdteske --backtitle \"\$DIALOG_BACKTITLE\" \ 113241653Sdteske --hline \"\$hline\" \ 114241653Sdteske --ok-label \"\$msg_ok\" \ 115241653Sdteske --cancel-label \"\$msg_cancel\" \ 116251264Sdteske --menu \"\$prompt\" \ 117251190Sdteske $height $width $rows \ 118241653Sdteske $menu_list \ 119241653Sdteske 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD 120251236Sdteske ) || f_die 121251236Sdteske f_dialog_data_sanitize mtag 122241653Sdteske 123241653Sdteske case "$mtag" in 124241653Sdteske X) # Cancel/Exit 125241653Sdteske f_die ;; 126241653Sdteske 1) # Always try sudo(8) when run as $user 127241653Sdteske local err 128241653Sdteske if ! err=$( touch "$checkpath" 2>&1 ); then 129245437Sdteske f_dialog_msgbox "$err" 130241653Sdteske else 131241653Sdteske f_show_msg "$msg_created_path" "$checkpath" 132241653Sdteske fi 133241653Sdteske esac 134241653Sdteske else 135241653Sdteske # 136241653Sdteske # This user has created the path signing-off on sudo(8)-use 137241653Sdteske # but let's still give them a short/quick/unobtrusive reminder 138241653Sdteske # 139241653Sdteske f_dialog_info "$msg_becoming_root_via_sudo" 140241653Sdteske [ "$USE_XDIALOG" ] || sleep 0.6 141241653Sdteske fi 142241653Sdteske 143241653Sdteske # 144238438Sdteske # Check sudo(8) access before prompting for password. 145238438Sdteske # 146240783Sdteske :| sudo -S -v 2> /dev/null 147238438Sdteske if [ $? -ne $SUCCESS ]; then 148238438Sdteske # 149238438Sdteske # sudo(8) access denied. Prompt for their password. 150238438Sdteske # 151251264Sdteske prompt="$msg_please_enter_password" 152238438Sdteske hline="$hline_alnum_punc_tab_enter" 153251190Sdteske f_dialog_inputbox_size height width \ 154251190Sdteske "$DIALOG_TITLE" \ 155251190Sdteske "$DIALOG_BACKTITLE" \ 156251264Sdteske "$prompt" \ 157251190Sdteske "$hline" 158238438Sdteske 159238438Sdteske # 160238438Sdteske # Continue prompting until they either Cancel, succeed 161238438Sdteske # or exceed the number of allowed failures. 162238438Sdteske # 163238438Sdteske local password nfailures=0 retval 164238438Sdteske while [ $nfailures -lt $PASSWD_TRIES ]; do 165238438Sdteske if [ "$USE_XDIALOG" ]; then 166238438Sdteske password=$( $DIALOG \ 167251190Sdteske --title "$DIALOG_TITLE" \ 168251190Sdteske --backtitle "$DIALOG_BACKTITLE" \ 169251190Sdteske --hline "$hline" \ 170251190Sdteske --ok-label "$msg_ok" \ 171251190Sdteske --cancel-label "$msg_cancel" \ 172251264Sdteske --password --inputbox "$prompt" \ 173251190Sdteske $height $width \ 174240783Sdteske 2>&1 > /dev/null ) 175238438Sdteske retval=$? 176238438Sdteske 177238438Sdteske # Catch X11-related errors 178238438Sdteske [ $retval -eq 255 ] && 179238438Sdteske f_die $retval "$password" 180238438Sdteske else 181251242Sdteske password=$( $DIALOG \ 182238438Sdteske --title "$DIALOG_TITLE" \ 183238438Sdteske --backtitle "$DIALOG_BACKTITLE" \ 184238438Sdteske --hline "$hline" \ 185238438Sdteske --ok-label "$msg_ok" \ 186238438Sdteske --cancel-label "$msg_cancel" \ 187238438Sdteske --insecure \ 188251264Sdteske --passwordbox "$prompt" \ 189251190Sdteske $height $width \ 190240768Sdteske 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD 191251242Sdteske ) || exit $? 192238438Sdteske fi 193251242Sdteske debug= f_dialog_line_sanitize password 194238438Sdteske 195238438Sdteske # 196238438Sdteske # Validate sudo(8) credentials 197238438Sdteske # 198240783Sdteske sudo -S -v 2> /dev/null <<-EOF 199238438Sdteske $password 200238438Sdteske EOF 201238438Sdteske retval=$? 202238438Sdteske unset password # scrub memory 203238438Sdteske if [ $retval -eq $SUCCESS ]; then 204238438Sdteske # Access granted... 205238438Sdteske break 206238438Sdteske else 207238438Sdteske # Access denied... 208238438Sdteske nfailures=$(( $nfailures + 1 )) 209238438Sdteske 210238438Sdteske # introduce a short delay 211238438Sdteske if [ $nfailures -lt $PASSWD_TRIES ]; then 212238438Sdteske f_dialog_info "$msg_sorry_try_again" 213238438Sdteske sleep 1 214238438Sdteske fi 215238438Sdteske fi 216238438Sdteske done 217238438Sdteske 218238438Sdteske # 219238438Sdteske # If user exhausted number of allowed password tries, log 220238438Sdteske # the security event and exit immediately. 221238438Sdteske # 222238438Sdteske if [ $nfailures -ge $PASSWD_TRIES ]; then 223238438Sdteske msg=$( printf "$msg_nfailed_attempts" "$nfailures" ) 224238438Sdteske logger -p auth.notice -t sudo " " \ 225238438Sdteske "$USER : $msg" \ 226238438Sdteske "; TTY=$(tty)" \ 227238438Sdteske "; PWD=$PWD" \ 228238438Sdteske "; USER=root" \ 229238438Sdteske "; COMMAND=$0" 230238438Sdteske f_die 1 "sudo: $msg" 231238438Sdteske fi 232238438Sdteske fi 233238438Sdteske 234238438Sdteske # Use xauth(1) to grant root the ability to use this X11/SSH session 235238438Sdteske if [ "$USE_XDIALOG" -a "$SSH_CONNECTION" -a "$DISPLAY" ]; then 236238438Sdteske f_have xauth || f_die 1 \ 237238438Sdteske "$msg_no_such_file_or_directory" "$pgm" "xauth" 238238438Sdteske local HOSTNAME displaynum 239238438Sdteske HOSTNAME=$(hostname) 240238438Sdteske displaynum="${DISPLAY#*:}" 241238438Sdteske xauth -f ~/.Xauthority extract - $HOSTNAME/unix:$displaynum \ 242238438Sdteske $HOSTNAME:$displaynum | sudo sh -c 'xauth -ivf \ 243240783Sdteske ~root/.Xauthority merge - > /dev/null 2>&1' 244238438Sdteske fi 245238438Sdteske 246238438Sdteske # Re-execute ourselves with sudo(8) 247249746Sdteske f_dprintf "%s: Becoming root via sudo(8)..." mustberoot.subr 248238438Sdteske if [ $ARGC -gt 0 ]; then 249238438Sdteske exec sudo "$0" $ARGV 250238438Sdteske else 251238438Sdteske exec sudo "$0" 252238438Sdteske fi 253238438Sdteske exit $? # Never reached unless error 254238438Sdteske} 255238438Sdteske 256238438Sdteske# f_authenticate_some_user 257238438Sdteske# 258238438Sdteske# Only used if running as root and requires X11 (see USE_XDIALOG below). 259238438Sdteske# Prompts the user to enter a username and password to be authenticated via 260238438Sdteske# sudo(8) to proceed. 261238438Sdteske# 262238438Sdteske# The following environment variables effect functionality: 263238438Sdteske# 264238438Sdteske# USE_XDIALOG Either NULL or Non-NULL. If given a value will indicate 265238438Sdteske# that Xdialog(1) should be used instead of dialog(1). 266238438Sdteske# 267238438Sdteskef_authenticate_some_user() 268238438Sdteske{ 269251190Sdteske local msg hline height width 270238438Sdteske 271238438Sdteske f_have sudo || f_die 1 "$msg_must_be_root_to_execute" "$pgm" 272238438Sdteske 273238438Sdteske # 274238438Sdteske # Secure-mode has been requested. 275238438Sdteske # 276243476Sdteske 277238438Sdteske [ "$USE_XDIALOG" ] || f_die 1 "$msg_secure_mode_requires_x11" 278238438Sdteske [ "$(id -u)" = "0" ] || f_die 1 "$msg_secure_mode_requires_root" 279238438Sdteske 280238438Sdteske # 281238438Sdteske # Prompt for sudo(8) credentials. 282238438Sdteske # 283238438Sdteske 284238438Sdteske msg="$msg_please_enter_username_password" 285238438Sdteske hline="$hline_alnum_punc_tab_enter" 286251190Sdteske f_xdialog_2inputsbox_size height width \ 287251190Sdteske "$DIALOG_TITLE" \ 288251190Sdteske "$DIALOG_BACKTITLE" \ 289251190Sdteske "$msg" \ 290251190Sdteske "$field_username" "" \ 291251190Sdteske "$field_password" "" 292238438Sdteske height=$(( $height + 2 )) # Add height for --password 293238438Sdteske 294238438Sdteske # 295238438Sdteske # Continue prompting until they either Cancel, succeed or exceed the 296238438Sdteske # number of allowed failures. 297238438Sdteske # 298238438Sdteske local user_pass nfailures=0 retval 299238438Sdteske while [ $nfailures -lt $PASSWD_TRIES ]; do 300238438Sdteske user_pass=$( $DIALOG \ 301238438Sdteske --title "$DIALOG_TITLE" \ 302238438Sdteske --backtitle "$DIALOG_BACKTITLE" \ 303238438Sdteske --hline "$hline" \ 304238438Sdteske --ok-label "$msg_ok" \ 305238438Sdteske --cancel-label "$msg_cancel" \ 306238438Sdteske --password --2inputsbox "$msg" \ 307238438Sdteske $height $width \ 308238438Sdteske "$field_username" "" \ 309238438Sdteske "$field_password" "" \ 310240783Sdteske 2>&1 > /dev/null ) 311238438Sdteske retval=$? 312238438Sdteske 313238438Sdteske # Catch X11-related errors 314238438Sdteske [ $retval -eq 255 ] && f_die $retval "$user_pass" 315238438Sdteske 316238438Sdteske # Exit if the user cancelled. 317238438Sdteske [ $retval -eq $SUCCESS ] || exit $retval 318238438Sdteske 319238438Sdteske # 320238438Sdteske # Make sure the user exists and is non-root 321238438Sdteske # 322238438Sdteske local user password 323238438Sdteske user="${user_pass%%/*}" 324238438Sdteske password="${user_pass#*/}" 325238438Sdteske unset user_pass # scrub memory 326238438Sdteske if [ ! "$user" ]; then 327238438Sdteske nfailures=$(( $nfailures + 1 )) 328238438Sdteske f_dialog_msgbox "$msg_no_username" 329238438Sdteske continue 330238438Sdteske fi 331238438Sdteske if [ ! "$SECURE_ALLOW_ROOT" ]; then 332238438Sdteske case "$user" in 333238438Sdteske root|toor) 334238438Sdteske nfailures=$(( $nfailures + 1 )) 335244554Sdteske f_show_msg "$msg_user_disallowed" "$user" 336238438Sdteske continue 337238438Sdteske esac 338238438Sdteske fi 339238438Sdteske if ! f_quietly id "$user"; then 340238438Sdteske nfailures=$(( $nfailures + 1 )) 341238438Sdteske if [ "$SECURE_DIVULGE_UNKNOWN_USER" ]; then 342244554Sdteske f_show_msg "$msg_unknown_user" "$user" 343238438Sdteske elif [ $nfailures -lt $PASSWD_TRIES ]; then 344238438Sdteske f_dialog_info "$msg_sorry_try_again" 345238438Sdteske sleep 1 346238438Sdteske fi 347238438Sdteske continue 348238438Sdteske fi 349238438Sdteske 350238438Sdteske # 351238438Sdteske # Validate sudo(8) credentials for given user 352238438Sdteske # 353238438Sdteske su -m "$user" <<-EOF 354238438Sdteske sh <<EOS 355238438Sdteske sudo -k 356240783Sdteske sudo -S -v 2> /dev/null <<EOP 357238438Sdteske $password 358238438Sdteske EOP 359238438Sdteske EOS 360238438Sdteske EOF 361238438Sdteske retval=$? 362238438Sdteske unset user 363238438Sdteske unset password # scrub memory 364238438Sdteske 365238438Sdteske if [ $retval -eq $SUCCESS ]; then 366238438Sdteske # Access granted... 367238438Sdteske break 368238438Sdteske else 369238438Sdteske # Access denied... 370238438Sdteske nfailures=$(( $nfailures + 1 )) 371238438Sdteske 372238438Sdteske # introduce a short delay 373238438Sdteske if [ $nfailures -lt $PASSWD_TRIES ]; then 374238438Sdteske f_dialog_info "$msg_sorry_try_again" 375238438Sdteske sleep 1 376238438Sdteske fi 377238438Sdteske fi 378238438Sdteske done 379238438Sdteske 380238438Sdteske # 381238438Sdteske # If user exhausted number of allowed password tries, log 382238438Sdteske # the security event and exit immediately. 383238438Sdteske # 384238438Sdteske if [ $nfailures -ge $PASSWD_TRIES ]; then 385238438Sdteske msg=$( printf "$msg_nfailed_attempts" "$nfailures" ) 386238438Sdteske logger -p auth.notice -t sudo " " \ 387238438Sdteske "${SUDO_USER:-$USER} : $msg" \ 388238438Sdteske "; TTY=$(tty)" \ 389238438Sdteske "; PWD=$PWD" \ 390238438Sdteske "; USER=root" \ 391238438Sdteske "; COMMAND=$0" 392238438Sdteske f_die 1 "sudo: $message" 393238438Sdteske fi 394238438Sdteske} 395238438Sdteske 396238438Sdteske# f_mustberoot_init 397238438Sdteske# 398238438Sdteske# If not already root, make the switch to root by re-executing ourselves via 399238438Sdteske# sudo(8) using user-supplied credentials. 400238438Sdteske# 401238438Sdteske# The following environment variables effect functionality: 402238438Sdteske# 403238438Sdteske# SECURE Either NULL or Non-NULL. If given a value will indicate 404238438Sdteske# that (while running as root) sudo(8) authentication is 405238438Sdteske# required to proceed. 406238438Sdteske# 407238438Sdteskef_mustberoot_init() 408238438Sdteske{ 409238438Sdteske if [ "$(id -u)" != "0" -a ! "$SECURE" ]; then 410238438Sdteske f_become_root_via_sudo 411238438Sdteske elif [ "$SECURE" ]; then 412238438Sdteske f_authenticate_some_user 413238438Sdteske fi 414238438Sdteske} 415238438Sdteske 416244675Sdteske############################################################ MAIN 417244675Sdteske 418244675Sdteskef_dprintf "%s: Successfully loaded." mustberoot.subr 419244675Sdteske 420238438Sdteskefi # ! $_MUSTBEROOT_SUBR 421