mustberoot.subr revision 251274
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 251274 2013-06-02 23:15:12Z 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 \ 174251266Sdteske 2>&1 > /dev/null 175251266Sdteske ) 176238438Sdteske retval=$? 177238438Sdteske 178238438Sdteske # Catch X11-related errors 179251274Sdteske if [ $retval -eq 255 ]; then 180238438Sdteske f_die $retval "$password" 181251274Sdteske elif [ $retval -ne 0 ]; then 182251274Sdteske # User cancelled 183251274Sdteske exit $retval 184251274Sdteske fi 185238438Sdteske else 186251242Sdteske password=$( $DIALOG \ 187238438Sdteske --title "$DIALOG_TITLE" \ 188238438Sdteske --backtitle "$DIALOG_BACKTITLE" \ 189238438Sdteske --hline "$hline" \ 190238438Sdteske --ok-label "$msg_ok" \ 191238438Sdteske --cancel-label "$msg_cancel" \ 192238438Sdteske --insecure \ 193251264Sdteske --passwordbox "$prompt" \ 194251190Sdteske $height $width \ 195240768Sdteske 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD 196251242Sdteske ) || exit $? 197238438Sdteske fi 198251242Sdteske debug= f_dialog_line_sanitize password 199238438Sdteske 200238438Sdteske # 201238438Sdteske # Validate sudo(8) credentials 202238438Sdteske # 203240783Sdteske sudo -S -v 2> /dev/null <<-EOF 204238438Sdteske $password 205238438Sdteske EOF 206238438Sdteske retval=$? 207238438Sdteske unset password # scrub memory 208238438Sdteske if [ $retval -eq $SUCCESS ]; then 209238438Sdteske # Access granted... 210238438Sdteske break 211238438Sdteske else 212238438Sdteske # Access denied... 213238438Sdteske nfailures=$(( $nfailures + 1 )) 214238438Sdteske 215238438Sdteske # introduce a short delay 216238438Sdteske if [ $nfailures -lt $PASSWD_TRIES ]; then 217238438Sdteske f_dialog_info "$msg_sorry_try_again" 218238438Sdteske sleep 1 219238438Sdteske fi 220238438Sdteske fi 221238438Sdteske done 222238438Sdteske 223238438Sdteske # 224238438Sdteske # If user exhausted number of allowed password tries, log 225238438Sdteske # the security event and exit immediately. 226238438Sdteske # 227238438Sdteske if [ $nfailures -ge $PASSWD_TRIES ]; then 228238438Sdteske msg=$( printf "$msg_nfailed_attempts" "$nfailures" ) 229238438Sdteske logger -p auth.notice -t sudo " " \ 230238438Sdteske "$USER : $msg" \ 231238438Sdteske "; TTY=$(tty)" \ 232238438Sdteske "; PWD=$PWD" \ 233238438Sdteske "; USER=root" \ 234238438Sdteske "; COMMAND=$0" 235238438Sdteske f_die 1 "sudo: $msg" 236238438Sdteske fi 237238438Sdteske fi 238238438Sdteske 239238438Sdteske # Use xauth(1) to grant root the ability to use this X11/SSH session 240238438Sdteske if [ "$USE_XDIALOG" -a "$SSH_CONNECTION" -a "$DISPLAY" ]; then 241238438Sdteske f_have xauth || f_die 1 \ 242238438Sdteske "$msg_no_such_file_or_directory" "$pgm" "xauth" 243238438Sdteske local HOSTNAME displaynum 244238438Sdteske HOSTNAME=$(hostname) 245238438Sdteske displaynum="${DISPLAY#*:}" 246238438Sdteske xauth -f ~/.Xauthority extract - $HOSTNAME/unix:$displaynum \ 247238438Sdteske $HOSTNAME:$displaynum | sudo sh -c 'xauth -ivf \ 248240783Sdteske ~root/.Xauthority merge - > /dev/null 2>&1' 249238438Sdteske fi 250238438Sdteske 251238438Sdteske # Re-execute ourselves with sudo(8) 252249746Sdteske f_dprintf "%s: Becoming root via sudo(8)..." mustberoot.subr 253238438Sdteske if [ $ARGC -gt 0 ]; then 254238438Sdteske exec sudo "$0" $ARGV 255238438Sdteske else 256238438Sdteske exec sudo "$0" 257238438Sdteske fi 258238438Sdteske exit $? # Never reached unless error 259238438Sdteske} 260238438Sdteske 261238438Sdteske# f_authenticate_some_user 262238438Sdteske# 263238438Sdteske# Only used if running as root and requires X11 (see USE_XDIALOG below). 264238438Sdteske# Prompts the user to enter a username and password to be authenticated via 265238438Sdteske# sudo(8) to proceed. 266238438Sdteske# 267238438Sdteske# The following environment variables effect functionality: 268238438Sdteske# 269238438Sdteske# USE_XDIALOG Either NULL or Non-NULL. If given a value will indicate 270238438Sdteske# that Xdialog(1) should be used instead of dialog(1). 271238438Sdteske# 272238438Sdteskef_authenticate_some_user() 273238438Sdteske{ 274251190Sdteske local msg hline height width 275238438Sdteske 276238438Sdteske f_have sudo || f_die 1 "$msg_must_be_root_to_execute" "$pgm" 277238438Sdteske 278238438Sdteske # 279238438Sdteske # Secure-mode has been requested. 280238438Sdteske # 281243476Sdteske 282238438Sdteske [ "$USE_XDIALOG" ] || f_die 1 "$msg_secure_mode_requires_x11" 283238438Sdteske [ "$(id -u)" = "0" ] || f_die 1 "$msg_secure_mode_requires_root" 284238438Sdteske 285238438Sdteske # 286238438Sdteske # Prompt for sudo(8) credentials. 287238438Sdteske # 288238438Sdteske 289238438Sdteske msg="$msg_please_enter_username_password" 290238438Sdteske hline="$hline_alnum_punc_tab_enter" 291251190Sdteske f_xdialog_2inputsbox_size height width \ 292251190Sdteske "$DIALOG_TITLE" \ 293251190Sdteske "$DIALOG_BACKTITLE" \ 294251190Sdteske "$msg" \ 295251190Sdteske "$field_username" "" \ 296251190Sdteske "$field_password" "" 297238438Sdteske height=$(( $height + 2 )) # Add height for --password 298238438Sdteske 299238438Sdteske # 300238438Sdteske # Continue prompting until they either Cancel, succeed or exceed the 301238438Sdteske # number of allowed failures. 302238438Sdteske # 303238438Sdteske local user_pass nfailures=0 retval 304238438Sdteske while [ $nfailures -lt $PASSWD_TRIES ]; do 305238438Sdteske user_pass=$( $DIALOG \ 306238438Sdteske --title "$DIALOG_TITLE" \ 307238438Sdteske --backtitle "$DIALOG_BACKTITLE" \ 308238438Sdteske --hline "$hline" \ 309238438Sdteske --ok-label "$msg_ok" \ 310238438Sdteske --cancel-label "$msg_cancel" \ 311238438Sdteske --password --2inputsbox "$msg" \ 312238438Sdteske $height $width \ 313238438Sdteske "$field_username" "" \ 314238438Sdteske "$field_password" "" \ 315240783Sdteske 2>&1 > /dev/null ) 316238438Sdteske retval=$? 317238438Sdteske 318238438Sdteske # Catch X11-related errors 319238438Sdteske [ $retval -eq 255 ] && f_die $retval "$user_pass" 320238438Sdteske 321238438Sdteske # Exit if the user cancelled. 322238438Sdteske [ $retval -eq $SUCCESS ] || exit $retval 323238438Sdteske 324238438Sdteske # 325238438Sdteske # Make sure the user exists and is non-root 326238438Sdteske # 327238438Sdteske local user password 328238438Sdteske user="${user_pass%%/*}" 329238438Sdteske password="${user_pass#*/}" 330238438Sdteske unset user_pass # scrub memory 331238438Sdteske if [ ! "$user" ]; then 332238438Sdteske nfailures=$(( $nfailures + 1 )) 333238438Sdteske f_dialog_msgbox "$msg_no_username" 334238438Sdteske continue 335238438Sdteske fi 336238438Sdteske if [ ! "$SECURE_ALLOW_ROOT" ]; then 337238438Sdteske case "$user" in 338238438Sdteske root|toor) 339238438Sdteske nfailures=$(( $nfailures + 1 )) 340244554Sdteske f_show_msg "$msg_user_disallowed" "$user" 341238438Sdteske continue 342238438Sdteske esac 343238438Sdteske fi 344238438Sdteske if ! f_quietly id "$user"; then 345238438Sdteske nfailures=$(( $nfailures + 1 )) 346238438Sdteske if [ "$SECURE_DIVULGE_UNKNOWN_USER" ]; then 347244554Sdteske f_show_msg "$msg_unknown_user" "$user" 348238438Sdteske elif [ $nfailures -lt $PASSWD_TRIES ]; then 349238438Sdteske f_dialog_info "$msg_sorry_try_again" 350238438Sdteske sleep 1 351238438Sdteske fi 352238438Sdteske continue 353238438Sdteske fi 354238438Sdteske 355238438Sdteske # 356238438Sdteske # Validate sudo(8) credentials for given user 357238438Sdteske # 358238438Sdteske su -m "$user" <<-EOF 359238438Sdteske sh <<EOS 360238438Sdteske sudo -k 361240783Sdteske sudo -S -v 2> /dev/null <<EOP 362238438Sdteske $password 363238438Sdteske EOP 364238438Sdteske EOS 365238438Sdteske EOF 366238438Sdteske retval=$? 367238438Sdteske unset user 368238438Sdteske unset password # scrub memory 369238438Sdteske 370238438Sdteske if [ $retval -eq $SUCCESS ]; then 371238438Sdteske # Access granted... 372238438Sdteske break 373238438Sdteske else 374238438Sdteske # Access denied... 375238438Sdteske nfailures=$(( $nfailures + 1 )) 376238438Sdteske 377238438Sdteske # introduce a short delay 378238438Sdteske if [ $nfailures -lt $PASSWD_TRIES ]; then 379238438Sdteske f_dialog_info "$msg_sorry_try_again" 380238438Sdteske sleep 1 381238438Sdteske fi 382238438Sdteske fi 383238438Sdteske done 384238438Sdteske 385238438Sdteske # 386238438Sdteske # If user exhausted number of allowed password tries, log 387238438Sdteske # the security event and exit immediately. 388238438Sdteske # 389238438Sdteske if [ $nfailures -ge $PASSWD_TRIES ]; then 390238438Sdteske msg=$( printf "$msg_nfailed_attempts" "$nfailures" ) 391238438Sdteske logger -p auth.notice -t sudo " " \ 392238438Sdteske "${SUDO_USER:-$USER} : $msg" \ 393238438Sdteske "; TTY=$(tty)" \ 394238438Sdteske "; PWD=$PWD" \ 395238438Sdteske "; USER=root" \ 396238438Sdteske "; COMMAND=$0" 397238438Sdteske f_die 1 "sudo: $message" 398238438Sdteske fi 399238438Sdteske} 400238438Sdteske 401238438Sdteske# f_mustberoot_init 402238438Sdteske# 403238438Sdteske# If not already root, make the switch to root by re-executing ourselves via 404238438Sdteske# sudo(8) using user-supplied credentials. 405238438Sdteske# 406238438Sdteske# The following environment variables effect functionality: 407238438Sdteske# 408238438Sdteske# SECURE Either NULL or Non-NULL. If given a value will indicate 409238438Sdteske# that (while running as root) sudo(8) authentication is 410238438Sdteske# required to proceed. 411238438Sdteske# 412238438Sdteskef_mustberoot_init() 413238438Sdteske{ 414238438Sdteske if [ "$(id -u)" != "0" -a ! "$SECURE" ]; then 415238438Sdteske f_become_root_via_sudo 416238438Sdteske elif [ "$SECURE" ]; then 417238438Sdteske f_authenticate_some_user 418238438Sdteske fi 419238438Sdteske} 420238438Sdteske 421244675Sdteske############################################################ MAIN 422244675Sdteske 423244675Sdteskef_dprintf "%s: Successfully loaded." mustberoot.subr 424244675Sdteske 425238438Sdteskefi # ! $_MUSTBEROOT_SUBR 426