mustberoot.subr revision 251242
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 251242 2013-06-02 05:45:25Z 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{ 80251190Sdteske local msg hline height width rows 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 93241653Sdteske msg=$( printf "$msg_always_try_sudo_when_run_as" "$USER" ) 94241653Sdteske local menu_list=" 95241653Sdteske 'X' '$msg_cancel_exit' 96241653Sdteske '1' '$msg' 97241653Sdteske '2' '$msg_try_sudo_only_this_once' 98241653Sdteske " # END-QUOTE 99241653Sdteske msg=$( printf "$msg_you_are_not_root_but" bsdconfig ) 100241653Sdteske hline="$hline_arrows_tab_enter" 101251190Sdteske eval f_dialog_menu_size height width rows \ 102251190Sdteske \"\$DIALOG_TITLE\" \ 103251190Sdteske \"\$DIALOG_BACKTITLE\" \ 104251190Sdteske \"\$msg\" \ 105251190Sdteske \"\$hline\" \ 106251190Sdteske $menu_list 107241653Sdteske 108251236Sdteske local mtag 109251236Sdteske mtag=$( eval $DIALOG \ 110241653Sdteske --title \"\$DIALOG_TITLE\" \ 111241653Sdteske --backtitle \"\$DIALOG_BACKTITLE\" \ 112241653Sdteske --hline \"\$hline\" \ 113241653Sdteske --ok-label \"\$msg_ok\" \ 114241653Sdteske --cancel-label \"\$msg_cancel\" \ 115251190Sdteske --menu \"\$msg\" \ 116251190Sdteske $height $width $rows \ 117241653Sdteske $menu_list \ 118241653Sdteske 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD 119251236Sdteske ) || f_die 120251236Sdteske f_dialog_data_sanitize mtag 121241653Sdteske 122241653Sdteske case "$mtag" in 123241653Sdteske X) # Cancel/Exit 124241653Sdteske f_die ;; 125241653Sdteske 1) # Always try sudo(8) when run as $user 126241653Sdteske local err 127241653Sdteske if ! err=$( touch "$checkpath" 2>&1 ); then 128245437Sdteske f_dialog_msgbox "$err" 129241653Sdteske else 130241653Sdteske f_show_msg "$msg_created_path" "$checkpath" 131241653Sdteske fi 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 # 150238438Sdteske msg="$msg_please_enter_password" 151238438Sdteske hline="$hline_alnum_punc_tab_enter" 152251190Sdteske f_dialog_inputbox_size height width \ 153251190Sdteske "$DIALOG_TITLE" \ 154251190Sdteske "$DIALOG_BACKTITLE" \ 155251190Sdteske "$msg" \ 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" \ 171251190Sdteske --password --inputbox "$msg" \ 172251190Sdteske $height $width \ 173240783Sdteske 2>&1 > /dev/null ) 174238438Sdteske retval=$? 175238438Sdteske 176238438Sdteske # Catch X11-related errors 177238438Sdteske [ $retval -eq 255 ] && 178238438Sdteske f_die $retval "$password" 179238438Sdteske else 180251242Sdteske password=$( $DIALOG \ 181238438Sdteske --title "$DIALOG_TITLE" \ 182238438Sdteske --backtitle "$DIALOG_BACKTITLE" \ 183238438Sdteske --hline "$hline" \ 184238438Sdteske --ok-label "$msg_ok" \ 185238438Sdteske --cancel-label "$msg_cancel" \ 186238438Sdteske --insecure \ 187251190Sdteske --passwordbox "$msg" \ 188251190Sdteske $height $width \ 189240768Sdteske 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD 190251242Sdteske ) || exit $? 191238438Sdteske fi 192251242Sdteske debug= f_dialog_line_sanitize password 193238438Sdteske 194238438Sdteske # 195238438Sdteske # Validate sudo(8) credentials 196238438Sdteske # 197240783Sdteske sudo -S -v 2> /dev/null <<-EOF 198238438Sdteske $password 199238438Sdteske EOF 200238438Sdteske retval=$? 201238438Sdteske unset password # scrub memory 202238438Sdteske if [ $retval -eq $SUCCESS ]; then 203238438Sdteske # Access granted... 204238438Sdteske break 205238438Sdteske else 206238438Sdteske # Access denied... 207238438Sdteske nfailures=$(( $nfailures + 1 )) 208238438Sdteske 209238438Sdteske # introduce a short delay 210238438Sdteske if [ $nfailures -lt $PASSWD_TRIES ]; then 211238438Sdteske f_dialog_info "$msg_sorry_try_again" 212238438Sdteske sleep 1 213238438Sdteske fi 214238438Sdteske fi 215238438Sdteske done 216238438Sdteske 217238438Sdteske # 218238438Sdteske # If user exhausted number of allowed password tries, log 219238438Sdteske # the security event and exit immediately. 220238438Sdteske # 221238438Sdteske if [ $nfailures -ge $PASSWD_TRIES ]; then 222238438Sdteske msg=$( printf "$msg_nfailed_attempts" "$nfailures" ) 223238438Sdteske logger -p auth.notice -t sudo " " \ 224238438Sdteske "$USER : $msg" \ 225238438Sdteske "; TTY=$(tty)" \ 226238438Sdteske "; PWD=$PWD" \ 227238438Sdteske "; USER=root" \ 228238438Sdteske "; COMMAND=$0" 229238438Sdteske f_die 1 "sudo: $msg" 230238438Sdteske fi 231238438Sdteske fi 232238438Sdteske 233238438Sdteske # Use xauth(1) to grant root the ability to use this X11/SSH session 234238438Sdteske if [ "$USE_XDIALOG" -a "$SSH_CONNECTION" -a "$DISPLAY" ]; then 235238438Sdteske f_have xauth || f_die 1 \ 236238438Sdteske "$msg_no_such_file_or_directory" "$pgm" "xauth" 237238438Sdteske local HOSTNAME displaynum 238238438Sdteske HOSTNAME=$(hostname) 239238438Sdteske displaynum="${DISPLAY#*:}" 240238438Sdteske xauth -f ~/.Xauthority extract - $HOSTNAME/unix:$displaynum \ 241238438Sdteske $HOSTNAME:$displaynum | sudo sh -c 'xauth -ivf \ 242240783Sdteske ~root/.Xauthority merge - > /dev/null 2>&1' 243238438Sdteske fi 244238438Sdteske 245238438Sdteske # Re-execute ourselves with sudo(8) 246249746Sdteske f_dprintf "%s: Becoming root via sudo(8)..." mustberoot.subr 247238438Sdteske if [ $ARGC -gt 0 ]; then 248238438Sdteske exec sudo "$0" $ARGV 249238438Sdteske else 250238438Sdteske exec sudo "$0" 251238438Sdteske fi 252238438Sdteske exit $? # Never reached unless error 253238438Sdteske} 254238438Sdteske 255238438Sdteske# f_authenticate_some_user 256238438Sdteske# 257238438Sdteske# Only used if running as root and requires X11 (see USE_XDIALOG below). 258238438Sdteske# Prompts the user to enter a username and password to be authenticated via 259238438Sdteske# sudo(8) to proceed. 260238438Sdteske# 261238438Sdteske# The following environment variables effect functionality: 262238438Sdteske# 263238438Sdteske# USE_XDIALOG Either NULL or Non-NULL. If given a value will indicate 264238438Sdteske# that Xdialog(1) should be used instead of dialog(1). 265238438Sdteske# 266238438Sdteskef_authenticate_some_user() 267238438Sdteske{ 268251190Sdteske local msg hline height width 269238438Sdteske 270238438Sdteske f_have sudo || f_die 1 "$msg_must_be_root_to_execute" "$pgm" 271238438Sdteske 272238438Sdteske # 273238438Sdteske # Secure-mode has been requested. 274238438Sdteske # 275243476Sdteske 276238438Sdteske [ "$USE_XDIALOG" ] || f_die 1 "$msg_secure_mode_requires_x11" 277238438Sdteske [ "$(id -u)" = "0" ] || f_die 1 "$msg_secure_mode_requires_root" 278238438Sdteske 279238438Sdteske # 280238438Sdteske # Prompt for sudo(8) credentials. 281238438Sdteske # 282238438Sdteske 283238438Sdteske msg="$msg_please_enter_username_password" 284238438Sdteske hline="$hline_alnum_punc_tab_enter" 285251190Sdteske f_xdialog_2inputsbox_size height width \ 286251190Sdteske "$DIALOG_TITLE" \ 287251190Sdteske "$DIALOG_BACKTITLE" \ 288251190Sdteske "$msg" \ 289251190Sdteske "$field_username" "" \ 290251190Sdteske "$field_password" "" 291238438Sdteske height=$(( $height + 2 )) # Add height for --password 292238438Sdteske 293238438Sdteske # 294238438Sdteske # Continue prompting until they either Cancel, succeed or exceed the 295238438Sdteske # number of allowed failures. 296238438Sdteske # 297238438Sdteske local user_pass nfailures=0 retval 298238438Sdteske while [ $nfailures -lt $PASSWD_TRIES ]; do 299238438Sdteske user_pass=$( $DIALOG \ 300238438Sdteske --title "$DIALOG_TITLE" \ 301238438Sdteske --backtitle "$DIALOG_BACKTITLE" \ 302238438Sdteske --hline "$hline" \ 303238438Sdteske --ok-label "$msg_ok" \ 304238438Sdteske --cancel-label "$msg_cancel" \ 305238438Sdteske --password --2inputsbox "$msg" \ 306238438Sdteske $height $width \ 307238438Sdteske "$field_username" "" \ 308238438Sdteske "$field_password" "" \ 309240783Sdteske 2>&1 > /dev/null ) 310238438Sdteske retval=$? 311238438Sdteske 312238438Sdteske # Catch X11-related errors 313238438Sdteske [ $retval -eq 255 ] && f_die $retval "$user_pass" 314238438Sdteske 315238438Sdteske # Exit if the user cancelled. 316238438Sdteske [ $retval -eq $SUCCESS ] || exit $retval 317238438Sdteske 318238438Sdteske # 319238438Sdteske # Make sure the user exists and is non-root 320238438Sdteske # 321238438Sdteske local user password 322238438Sdteske user="${user_pass%%/*}" 323238438Sdteske password="${user_pass#*/}" 324238438Sdteske unset user_pass # scrub memory 325238438Sdteske if [ ! "$user" ]; then 326238438Sdteske nfailures=$(( $nfailures + 1 )) 327238438Sdteske f_dialog_msgbox "$msg_no_username" 328238438Sdteske continue 329238438Sdteske fi 330238438Sdteske if [ ! "$SECURE_ALLOW_ROOT" ]; then 331238438Sdteske case "$user" in 332238438Sdteske root|toor) 333238438Sdteske nfailures=$(( $nfailures + 1 )) 334244554Sdteske f_show_msg "$msg_user_disallowed" "$user" 335238438Sdteske continue 336238438Sdteske esac 337238438Sdteske fi 338238438Sdteske if ! f_quietly id "$user"; then 339238438Sdteske nfailures=$(( $nfailures + 1 )) 340238438Sdteske if [ "$SECURE_DIVULGE_UNKNOWN_USER" ]; then 341244554Sdteske f_show_msg "$msg_unknown_user" "$user" 342238438Sdteske elif [ $nfailures -lt $PASSWD_TRIES ]; then 343238438Sdteske f_dialog_info "$msg_sorry_try_again" 344238438Sdteske sleep 1 345238438Sdteske fi 346238438Sdteske continue 347238438Sdteske fi 348238438Sdteske 349238438Sdteske # 350238438Sdteske # Validate sudo(8) credentials for given user 351238438Sdteske # 352238438Sdteske su -m "$user" <<-EOF 353238438Sdteske sh <<EOS 354238438Sdteske sudo -k 355240783Sdteske sudo -S -v 2> /dev/null <<EOP 356238438Sdteske $password 357238438Sdteske EOP 358238438Sdteske EOS 359238438Sdteske EOF 360238438Sdteske retval=$? 361238438Sdteske unset user 362238438Sdteske unset password # scrub memory 363238438Sdteske 364238438Sdteske if [ $retval -eq $SUCCESS ]; then 365238438Sdteske # Access granted... 366238438Sdteske break 367238438Sdteske else 368238438Sdteske # Access denied... 369238438Sdteske nfailures=$(( $nfailures + 1 )) 370238438Sdteske 371238438Sdteske # introduce a short delay 372238438Sdteske if [ $nfailures -lt $PASSWD_TRIES ]; then 373238438Sdteske f_dialog_info "$msg_sorry_try_again" 374238438Sdteske sleep 1 375238438Sdteske fi 376238438Sdteske fi 377238438Sdteske done 378238438Sdteske 379238438Sdteske # 380238438Sdteske # If user exhausted number of allowed password tries, log 381238438Sdteske # the security event and exit immediately. 382238438Sdteske # 383238438Sdteske if [ $nfailures -ge $PASSWD_TRIES ]; then 384238438Sdteske msg=$( printf "$msg_nfailed_attempts" "$nfailures" ) 385238438Sdteske logger -p auth.notice -t sudo " " \ 386238438Sdteske "${SUDO_USER:-$USER} : $msg" \ 387238438Sdteske "; TTY=$(tty)" \ 388238438Sdteske "; PWD=$PWD" \ 389238438Sdteske "; USER=root" \ 390238438Sdteske "; COMMAND=$0" 391238438Sdteske f_die 1 "sudo: $message" 392238438Sdteske fi 393238438Sdteske} 394238438Sdteske 395238438Sdteske# f_mustberoot_init 396238438Sdteske# 397238438Sdteske# If not already root, make the switch to root by re-executing ourselves via 398238438Sdteske# sudo(8) using user-supplied credentials. 399238438Sdteske# 400238438Sdteske# The following environment variables effect functionality: 401238438Sdteske# 402238438Sdteske# SECURE Either NULL or Non-NULL. If given a value will indicate 403238438Sdteske# that (while running as root) sudo(8) authentication is 404238438Sdteske# required to proceed. 405238438Sdteske# 406238438Sdteskef_mustberoot_init() 407238438Sdteske{ 408238438Sdteske if [ "$(id -u)" != "0" -a ! "$SECURE" ]; then 409238438Sdteske f_become_root_via_sudo 410238438Sdteske elif [ "$SECURE" ]; then 411238438Sdteske f_authenticate_some_user 412238438Sdteske fi 413238438Sdteske} 414238438Sdteske 415244675Sdteske############################################################ MAIN 416244675Sdteske 417244675Sdteskef_dprintf "%s: Successfully loaded." mustberoot.subr 418244675Sdteske 419238438Sdteskefi # ! $_MUSTBEROOT_SUBR 420