3 # Copyright (c) 2002-2004 Michael Telahun Makonnen. All rights reserved.
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions
8 # 1. Redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer.
10 # 2. Redistributions in binary form must reproduce the above copyright
11 # notice, this list of conditions and the following disclaimer in the
12 # documentation and/or other materials provided with the distribution.
14 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 # IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 # OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 # IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 # NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 # Email: Mike Makonnen <mtm@FreeBSD.Org>
27 # $FreeBSD: src/usr.sbin/adduser/adduser.sh,v 1.31 2007/10/20 00:45:31 mtm Exp $
28 # $DragonFly: src/usr.sbin/adduser/adduser.sh,v 1.4 2008/07/21 23:42:02 swildner Exp $
32 # Display $msg on stderr, unless we're being quiet.
35 if [ -z "$quietflag" ]; then
36 echo 1>&2 ${THISCMD}: ERROR
: $
*
41 # Display $msg on stdout, unless we're being quiet.
44 if [ -z "$quietflag" ]; then
45 echo ${THISCMD}: INFO
: $
*
50 # Output the value of $_uid if it is available for use. If it
51 # is not, output the value of the next higher uid that is available.
52 # If a uid is not specified, output the first available uid, as indicated
59 if [ -z "$_uid" ]; then
60 _nextuid
="`${PWCMD} usernext | cut -f1 -d:`"
63 ${PWCMD} usershow
$_uid > /dev
/null
2>&1
64 if [ ! "$?" -eq 0 ]; then
75 # Display usage information for this utility.
78 echo "usage: ${THISCMD} [options]"
79 echo " options may include:"
80 echo " -C save to the configuration file only"
81 echo " -D do not attempt to create the home directory"
82 echo " -E disable this account after creation"
83 echo " -G additional groups to add accounts to"
84 echo " -L login class of the user"
85 echo " -N do not read configuration file"
86 echo " -S a nonexistent shell is not an error"
87 echo " -d home directory"
88 echo " -f file from which input will be received"
89 echo " -g default login group"
90 echo " -h display this usage message"
91 echo " -k path to skeleton home directory"
92 echo " -m user welcome message file"
93 echo " -q absolute minimal user feedback"
95 echo " -u uid to start at"
96 echo " -w password type: no, none, yes or random"
100 # Outputs a list of valid shells from /etc/shells. Only the
101 # basename of the shell is output.
106 while read _path _junk
; do
111 echo -n "${_prefix}`basename $_path`"
117 # /sbin/nologin is a special case
118 [ -x "${NOLOGIN_PATH}" ] && echo -n " ${NOLOGIN}"
121 # fullpath_from_shell shell
122 # Given $shell, which is either the full path to a shell or
123 # the basename component of a valid shell, get the
124 # full path to the shell from the /etc/shells file.
126 fullpath_from_shell
() {
128 [ -z "$_shell" ] && return 1
130 # /sbin/nologin is a special case; it needs to be handled
131 # before the cat | while loop, since a 'return' from within
132 # a subshell will not terminate the function's execution, and
133 # the path to the nologin shell might be printed out twice.
135 if [ "$_shell" = "${NOLOGIN}" -o \
136 "$_shell" = "${NOLOGIN_PATH}" ]; then
142 while read _path _junk
; do
147 if [ "$_path" = "$_shell" -o \
148 "`basename $_path`" = "$_shell" ]; then
160 # If the given shell is listed in ${ETCSHELLS} or it is
161 # the nologin shell this function will return 0.
162 # Otherwise, it will return 1. If shell is valid but
163 # the path is invalid or it is not executable it
164 # will emit an informational message saying so.
169 _shellchk
="${GREPCMD} '^$_sh$' ${ETCSHELLS} > /dev/null 2>&1"
171 if ! eval $_shellchk; then
172 # The nologin shell is not listed in /etc/shells.
173 if [ "$_sh" != "${NOLOGIN_PATH}" ]; then
174 err
"Invalid shell ($_sh) for user $username."
179 info
"The shell ($_sh) does not exist or is not executable."
185 # Save some variables to a configuration file.
186 # Note: not all script variables are saved, only those that
187 # it makes sense to save.
190 echo "# Configuration file for adduser(8)." > ${ADDUSERCONF}
191 echo "# NOTE: only *some* variables are saved." >> ${ADDUSERCONF}
192 echo "# Last Modified on `${DATECMD}`." >> ${ADDUSERCONF}
193 echo '' >> ${ADDUSERCONF}
194 echo "defaultLgroup=$ulogingroup" >> ${ADDUSERCONF}
195 echo "defaultclass=$uclass" >> ${ADDUSERCONF}
196 echo "defaultgroups=$ugroups" >> ${ADDUSERCONF}
197 echo "passwdtype=$passwdtype" >> ${ADDUSERCONF}
198 echo "homeprefix=$homeprefix" >> ${ADDUSERCONF}
199 echo "defaultshell=$ushell" >> ${ADDUSERCONF}
200 echo "udotdir=$udotdir" >> ${ADDUSERCONF}
201 echo "msgfile=$msgfile" >> ${ADDUSERCONF}
202 echo "disableflag=$disableflag" >> ${ADDUSERCONF}
203 echo "uidstart=$uidstart" >> ${ADDUSERCONF}
207 # Add a user to the user database. If the user chose to send a welcome
208 # message or lock the account, do so.
212 # Is this a configuration run? If so, don't modify user database.
214 if [ -n "$configflag" ]; then
235 _name
="-n '$username'"
236 [ -n "$uuid" ] && _uid
='-u "$uuid"'
237 [ -n "$ulogingroup" ] && _group
='-g "$ulogingroup"'
238 [ -n "$ugroups" ] && _grouplist
='-G "$ugroups"'
239 [ -n "$ushell" ] && _shell
='-s "$ushell"'
240 [ -n "$uclass" ] && _class
='-L "$uclass"'
241 [ -n "$ugecos" ] && _comment
='-c "$ugecos"'
242 [ -n "$udotdir" ] && _dotdir
='-k "$udotdir"'
243 [ -n "$uexpire" ] && _expire
='-e "$uexpire"'
244 [ -n "$upwexpire" ] && _pwexpire
='-p "$upwexpire"'
245 if [ -z "$Dflag" -a -n "$uhome" ]; then
246 # The /nonexistent home directory is special. It
247 # means the user has no home directory.
248 if [ "$uhome" = "$NOHOME" ]; then
251 _home
='-m -d "$uhome"'
253 elif [ -n "$Dflag" -a -n "$uhome" ]; then
258 _passwdmethod
="-w no"
262 # Note on processing the password: The outer double quotes
263 # make literal everything except ` and \ and $.
264 # The outer single quotes make literal ` and $.
265 # We can ensure the \ isn't treated specially by specifying
266 # the -r switch to the read command used to obtain the input.
268 _passwdmethod
="-w yes"
270 _upasswd
='echo "$upass" |'
273 _passwdmethod
="-w none"
276 _passwdmethod
="-w random"
280 _pwcmd
="$_upasswd ${PWCMD} useradd $_uid $_name $_group $_grouplist $_comment"
281 _pwcmd
="$_pwcmd $_shell $_class $_home $_dotdir $_passwdmethod $_passwd"
282 _pwcmd
="$_pwcmd $_expire $_pwexpire"
284 if ! _output
=`eval $_pwcmd` ; then
285 err
"There was an error adding user ($username)."
288 info
"Successfully added ($username) to the user database."
289 if [ "random" = "$passwdtype" ]; then
290 randompass
="$_output"
291 info
"Password for ($username) is: $randompass"
295 if [ -n "$disableflag" ]; then
296 if ${PWCMD} lock
$username ; then
297 info
"Account ($username) is locked."
299 info
"Account ($username) could NOT be locked."
306 if [ -n "$msgflag" ]; then
307 [ -r "$msgfile" ] && {
308 # We're evaluating the contents of an external file.
309 # Let's not open ourselves up for attack. _perms will
310 # be empty if it's writeable only by the owner. _owner
311 # will *NOT* be empty if the file is owned by root.
313 _dir
="`dirname $msgfile`"
314 _file
="`basename $msgfile`"
315 _perms
=`/usr/bin/find $_dir -name $_file -perm +07022 -prune`
316 _owner
=`/usr/bin/find $_dir -name $_file -user 0 -prune`
317 if [ -z "$_owner" -o -n "$_perms" ]; then
318 err
"The message file ($msgfile) may be writeable only by root."
322 while read _line
; do
324 done |
${MAILCMD} -s"Welcome" ${username}
325 info
"Sent welcome message to ($username)."
331 # Reads username of the account from standard input or from a global
332 # variable containing an account line from a file. The username is
333 # required. If this is an interactive session it will prompt in
334 # a loop until a username is entered. If it is batch processing from
335 # a file it will output an error message and return to the caller.
340 # No need to take down user names if this is a configuration saving run.
341 [ -n "$configflag" ] && return
344 if [ -z "$fflag" ]; then
348 _input
="`echo "$fileline" | cut -f1 -d:`"
351 # There *must* be a username, and it must not exist. If
352 # this is an interactive session give the user an
353 # opportunity to retry.
355 if [ -z "$_input" ]; then
356 err
"You must enter a username!"
357 [ -z "$fflag" ] && continue
359 ${PWCMD} usershow
$_input > /dev
/null
2>&1
360 if [ "$?" -eq 0 ]; then
362 [ -z "$fflag" ] && continue
370 # Reads extra information about the user. Can be used both in interactive
371 # and batch (from file) mode.
376 # No need to take down additional user information for a configuration run.
377 [ -n "$configflag" ] && return
379 if [ -z "$fflag" ]; then
380 echo -n "Full name: "
383 _input
="`echo "$fileline" | cut -f7 -d:`"
389 # Get the account's shell. Works in interactive and batch mode. It
390 # accepts either the base name of the shell or the full path.
391 # If an invalid shell is entered it will simply use the default shell.
396 ushell
="$defaultshell"
398 # Make sure the current value of the shell is a valid one
399 if [ -z "$Sflag" ]; then
400 if ! shell_exists
$ushell ; then
401 info
"Using default shell ${defaultshell}."
402 ushell
="$defaultshell"
406 if [ -z "$fflag" ]; then
407 echo -n "Shell ($shells) [`basename $ushell`]: "
410 _input
="`echo "$fileline" | cut -f9 -d:`"
412 if [ -n "$_input" ]; then
413 if [ -n "$Sflag" ]; then
416 _fullpath
=`fullpath_from_shell $_input`
417 if [ -n "$_fullpath" ]; then
420 err
"Invalid shell ($_input) for user $username."
421 info
"Using default shell ${defaultshell}."
422 ushell
="$defaultshell"
429 # Reads the account's home directory. Used both with interactive input
434 if [ -z "$fflag" ]; then
435 echo -n "Home directory [${homeprefix}/${username}]: "
438 _input
="`echo "$fileline" | cut -f8 -d:`"
441 if [ -n "$_input" ]; then
443 # if this is a configuration run, then user input is the home
444 # directory prefix. Otherwise it is understood to
447 [ -z "$configflag" ] && homeprefix
="`dirname $uhome`" || homeprefix
="$uhome"
449 uhome
="${homeprefix}/${username}"
454 # Reads a numeric userid in an interactive or batch session. Automatically
455 # allocates one if it is not specified.
462 if [ -n "$uuid" ]; then
463 _prompt
="Uid [$uuid]: "
465 _prompt
="Uid (Leave empty for default): "
467 if [ -z "$fflag" ]; then
471 _input
="`echo "$fileline" | cut -f2 -d:`"
474 [ -n "$_input" ] && uuid
=$_input
475 uuid
=`get_nextuid $uuid`
480 # Reads login class of account. Can be used in interactive or batch mode.
483 uclass
="$defaultclass"
485 _class
=${uclass:-"default"}
487 if [ -z "$fflag" ]; then
488 echo -n "Login class [$_class]: "
491 _input
="`echo "$fileline" | cut -f4 -d:`"
494 [ -n "$_input" ] && uclass
="$_input"
498 # Reads user's login group. Can be used in both interactive and batch
499 # modes. The specified value can be a group name or its numeric id.
500 # This routine leaves the field blank if nothing is provided and
501 # a default login group has not been set. The pw(8) command
502 # will then provide a login group with the same name as the username.
505 ulogingroup
="$defaultLgroup"
508 if [ -z "$fflag" ]; then
509 echo -n "Login group [${ulogingroup:-$username}]: "
512 _input
="`echo "$fileline" | cut -f3 -d:`"
515 # Pw(8) will use the username as login group if it's left empty
516 [ -n "$_input" ] && ulogingroup
="$_input"
520 # Read additional groups for the user. It can be used in both interactive
524 ugroups
="$defaultgroups"
526 _group
=${ulogingroup:-"${username}"}
528 if [ -z "$configflag" ]; then
529 [ -z "$fflag" ] && echo -n "Login group is $_group. Invite $username"
530 [ -z "$fflag" ] && echo -n " into other groups? [$ugroups]: "
532 [ -z "$fflag" ] && echo -n "Enter additional groups [$ugroups]: "
536 [ -n "$_input" ] && ugroups
="$_input"
540 # Read expiry information for the account and also for the password. This
541 # routine is used only from batch processing mode.
544 upwexpire
="`echo "$fileline" | cut -f5 -d:`"
545 uexpire
="`echo "$fileline" | cut -f6 -d:`"
549 # Read the password in batch processing mode. The password field matters
550 # only when the password type is "yes" or "random". If the field is empty and the
551 # password type is "yes", then it assumes the account has an empty passsword
552 # and changes the password type accordingly. If the password type is "random"
553 # and the password field is NOT empty, then it assumes the account will NOT
554 # have a random password and set passwdtype to "yes."
557 # We may temporarily change a password type. Make sure it's changed
558 # back to whatever it was before we process the next account.
560 [ -n "$savedpwtype" ] && {
561 passwdtype
=$savedpwtype
565 # There may be a ':' in the password
566 upass
=${fileline#*:*:*:*:*:*:*:*:*:}
568 if [ -z "$upass" ]; then
571 # if it's empty, assume an empty password
587 # Reads a line of account information from standard input and
588 # adds it to the user database.
593 while read -r fileline
; do
607 ugroups
="$defaultgroups"
616 # Prompts for user information interactively, and commits to
619 input_interactive
() {
646 # The case where group = user is handled elsewhere, so
647 # validate any other groups the user is invited to.
648 until [ "$_logingroup_ok" = yes ]; do
651 if [ -n "$ulogingroup" -a "$username" != "$ulogingroup" ]; then
652 if ! ${PWCMD} show group
$ulogingroup > /dev
/null
2>&1; then
653 echo "Group $ulogingroup does not exist!"
658 until [ "$_groups_ok" = yes ]; do
661 for i
in $ugroups; do
662 if [ "$username" != "$i" ]; then
663 if ! ${PWCMD} show group
$i > /dev
/null
2>&1; then
664 echo "Group $i does not exist!"
676 echo -n "Use password-based authentication? [$_usepass]: "
678 [ -z "$_input" ] && _input
=$_usepass
683 [Yy
][Ee
][Ss
]|
[Yy
][Ee
]|
[Yy
])
685 echo -n "Use an empty password? (yes/no) [$_emptypass]: "
687 [ -n "$_input" ] && _emptypass
=$_input
690 echo -n "Use a random password? (yes/no) [$_random]: "
692 [ -n "$_input" ] && _random
="$_input"
694 [Yy
][Ee
][Ss
]|
[Yy
][Ee
]|
[Yy
])
700 [ -n "$configflag" ] && break
701 trap 'stty echo; exit' 0 1 2 3 15
703 echo -n "Enter password: "
706 echo -n "Enter password again: "
710 # if user entered a blank password
711 # explicitly ask again.
712 [ -z "$upass" -a -z "$_passconfirm" ] \
715 [Yy
][Ee
][Ss
]|
[Yy
][Ee
]|
[Yy
])
720 # invalid answer; repeat the loop
724 if [ "$upass" != "$_passconfirm" ]; then
725 echo "Passwords did not match!"
732 # invalid answer; repeat loop
738 _disable
=${disableflag:-"no"}
740 echo -n "Lock out the account after creation? [$_disable]: "
742 [ -z "$_input" ] && _input
=$_disable
747 [Yy
][Ee
][Ss
]|
[Yy
][Ee
]|
[Yy
])
751 # invalid answer; repeat loop
758 # Display the information we have so far and prompt to
761 _disable
=${disableflag:-"no"}
762 [ -z "$configflag" ] && printf "%-10s : %s\n" Username
$username
777 [ -z "$configflag" ] && printf "%-10s : %s\n" "Password" "$_pass"
778 [ -n "$configflag" ] && printf "%-10s : %s\n" "Pass Type" "$passwdtype"
779 [ -z "$configflag" ] && printf "%-10s : %s\n" "Full Name" "$ugecos"
780 [ -z "$configflag" ] && printf "%-10s : %s\n" "Uid" "$uuid"
781 printf "%-10s : %s\n" "Class" "$uclass"
782 printf "%-10s : %s %s\n" "Groups" "${ulogingroup:-$username}" "$ugroups"
783 printf "%-10s : %s\n" "Home" "$uhome"
784 printf "%-10s : %s\n" "Shell" "$ushell"
785 printf "%-10s : %s\n" "Locked" "$_disable"
787 echo -n "OK? (yes/no): "
793 [Yy
][Ee
][Ss
]|
[Yy
][Ee
]|
[Yy
])
805 #### END SUBROUTINE DEFINITION ####
807 THISCMD
=`/usr/bin/basename $0`
809 ADDUSERCONF
="${ADDUSERCONF:-/etc/adduser.conf}"
810 PWCMD
="${PWCMD:-/usr/sbin/pw}"
811 MAILCMD
="${MAILCMD:-mail}"
812 ETCSHELLS
="${ETCSHELLS:-/etc/shells}"
813 NOHOME
="/nonexistent"
815 NOLOGIN_PATH
="/sbin/nologin"
816 GREPCMD
="/usr/bin/grep"
830 udotdir
=/usr
/share
/skel
834 shells
="`valid_shells`"
836 msgfile
=/etc
/adduser.msg
853 defaultshell
="${DEFAULTSHELL}"
855 # Make sure the user running this program is root. This isn't a security
856 # measure as much as it is a useful method of reminding the user to
857 # 'su -' before he/she wastes time entering data that won't be saved.
859 procowner
=${procowner:-`/usr/bin/id -u`}
860 if [ "$procowner" != "0" ]; then
861 err
'you must be the super-user (uid 0) to use this utility.'
865 # Overide from our conf file
866 # Quickly go through the commandline line to see if we should read
867 # from our configuration file. The actual parsing of the commandline
868 # arguments happens after we read in our configuration file (commandline
869 # should override configuration file).
872 if [ "$_i" = "-N" ]; then
877 if [ -n "$readconfig" ]; then
878 # On a long-lived system, the first time this script is run it
879 # will barf upon reading the configuration file for its perl predecessor.
880 if ( .
${ADDUSERCONF} > /dev
/null
2>&1 ); then
881 [ -r ${ADDUSERCONF} ] && .
${ADDUSERCONF} > /dev
/null
2>&1
885 # Process command-line options
910 [ "$2" != "-" ] && infile
="$2"
963 defaultshell
="`fullpath_from_shell $2`"
977 # If the -f switch was used, get input from a file. Otherwise,
978 # this is an interactive session.
980 if [ -n "$fflag" ]; then
981 if [ -z "$infile" ]; then
983 elif [ -n "$infile" ]; then
984 if [ -r "$infile" ]; then
985 input_from_file
< $infile
987 err
"File ($infile) is unreadable or does not exist."
993 if [ -z "$configflag" ]; then
994 echo -n "Add another user? (yes/no): "
996 echo -n "Re-edit the default configuration? (yes/no): "
1000 [Yy
][Ee
][Ss
]|
[Yy
][Ee
]|
[Yy
])
1001 uidstart
=`get_nextuid $uidstart`