2010-01-20 14:53:09 +01:00
#!/bin/sh
set -u
2010-01-20 16:13:51 +01:00
# Display usage.
2010-01-20 14:53:09 +01:00
usage ()
{
local - progname
progname=$1
echo "Usage :"
echo
echo "$progname emailaccount [emailalias]"
echo "$progname -h | --help"
echo
2010-01-20 16:13:51 +01:00
echo "Fist form adds an email account named emailaccount if it doesn't already exist"
echo "and creates an alias named emailalias for this email account if specified."
2010-01-20 14:53:09 +01:00
echo
2010-01-20 16:13:51 +01:00
echo "Second form prints this help."
2010-01-20 14:53:09 +01:00
}
2010-01-20 16:13:51 +01:00
# Test an email is valid and exit if it isn't.
2010-01-20 14:53:09 +01:00
test_email ()
{
local -
user=$(echo "$1" | cut -d '@' -f 1)
if [ -z "$user" ]
then
2010-01-20 16:13:51 +01:00
echo "Error! Missing user in email account."
2010-01-20 14:53:09 +01:00
exit 1
fi
domain=$(echo "$1" | cut -d '@' -f 2)
if echo "$domain" | grep -E -v "^([[:alnum:]]+\.)+[[:alnum:]]+$" > /dev/null
then
2010-01-20 16:13:51 +01:00
echo "Error! Invalid domain for email account."
2010-01-20 14:53:09 +01:00
exit 1
fi
}
2010-01-20 16:13:51 +01:00
# Ask a question to the user. Return 1 if the answer is negative,
# or 0 if it is positive.
2010-01-20 14:53:09 +01:00
ask_user_default_no ()
{
local - answer
answer="unset"
echo -n "$1 [y/N] "
while [ -n "$answer" -a "$answer" != "y" -a "$answer" != "Y" -a "$answer" != "n" -a "$answer" != "N" ]
do
read answer
if [ -z "$answer" -o "$answer" = "n" -o "$answer" = "N" ]
then
return 1
fi
if [ "$answer" = "y" -o "$answer" = "Y" ]
then
break
fi
echo -n "$2 [y/N] "
done
return 0
}
2010-01-20 16:13:51 +01:00
# Test number of argument is correct and their value are correct also.
2010-01-20 14:53:09 +01:00
test_args ()
{
local - user domain first_ask next_ask
if [ \( $# -ge 1 -a "$1" = "-h" -a $# -gt 1 \) -o $# -gt 2 ]
then
2010-01-20 16:13:51 +01:00
echo "Error! Too many arguments."
2010-01-20 14:53:09 +01:00
exit 1
fi
if [ $# -eq 0 -o "$1" = "-h" -o "$1" = "-help" ]
then
usage $(basename $0)
exit 0
else
# Test email arguments
test_email "$1"
emailuser="$user"
emaildomain="$domain"
if [ $# -eq 2 ]
then
test_email "$2"
aliasuser="$user"
aliasdomain="$domain"
if [ "$emaildomain" != "$aliasdomain" ]
then
2010-01-20 16:13:51 +01:00
echo "Error! Domain of the alias must be identical to the domain of the email account."
2010-01-20 14:53:09 +01:00
exit 1
fi
fi
fi
2010-01-20 16:13:51 +01:00
first_ask="Be aware that you'll need to restart cyrus twice and postfix once. Are you ready?"
next_ask="Incorrect answer. Are you ready to restart cyrus and postfix?"
2010-01-20 14:53:09 +01:00
ask_user_default_no "$first_ask" "$next_ask"
if [ $? -eq 1 ]
then
2010-01-20 16:13:51 +01:00
echo "Ok, exiting…"
2010-01-20 14:53:09 +01:00
exit 1
fi
}
2010-01-20 16:13:51 +01:00
# Are we root?
2010-01-20 14:53:09 +01:00
must_sudo ()
{
uid="$(id -u)"
[ ! $uid -eq 0 ]
return $?
}
2010-01-20 16:13:51 +01:00
# This function tries to become root with sudo and execute this script.
# NB: This function doesn't return.
2010-01-20 14:53:09 +01:00
try_sudo ()
{
local - ret
echo "You aren't root. Trying to use sudo to become root…"
2010-01-20 16:13:51 +01:00
sudo $0 "$@" # Try to execute the script with sudo
2010-01-20 14:53:09 +01:00
ret=$?
if [ ! $ret -eq 0 ]
then
2010-01-20 16:13:51 +01:00
echo "Error! You must be root or being able to become root by sudo without password to create an email account or add an email alias."
2010-01-20 14:53:09 +01:00
fi
exit $ret
}
2010-01-20 16:13:51 +01:00
# Test cyrus password is OK.
2010-01-20 14:53:09 +01:00
test_cyrus_admin ()
{
local -
cyruser=$(grep -E "^[[:space:]]*admins:" /etc/imapd.conf | cut -d ':' -f 2- | sed -r "s/[[:alnum:]]+@[[:alnum:].]+//g" | tr -d ' ')
cyrpwd=$(cat /root/cyrus_main_admin_password)
2010-01-20 16:13:51 +01:00
testsaslauthd -u $cyruser -p $cyrpwd > /dev/null || { echo "Error! Password for main cyrus admin has changed but has not been modified in /root/" && exit 1 ; }
2010-01-20 14:53:09 +01:00
}
# Save cyrus state and make it cyradm ready, that is save and change
# allowplaintext and virtdomain and make it listen on localhost:imap
# instead of *:imap
save_cyrus_state_and_become_cyradm_ready ()
{
local -
sed -r -i "s/^(.*cmd=\"imapd.* listen=\")(imap\".*)$/\1localhost:\2/" /etc/cyrus.conf
sed -r -i "s/^([[:space:]]*allowplaintext:.*)$/#\1\nallowplaintext: 1/" /etc/imapd.conf
sed -r -i "s/^([[:space:]]*virtdomains:.*)$/#\1\nvirtdomains: userid/" /etc/imapd.conf
invoke-rc.d cyrus2.2 restart
if [ ! $? -eq 0 ]
then
2010-01-20 16:13:51 +01:00
echo "Error! Restarting cyrus failed. The requested action coudn't be performed."
2010-01-20 14:53:09 +01:00
echo "Look at the logs and restart Cyrus manually."
return 1
fi
return 0
}
2010-01-20 16:13:51 +01:00
# Ask a password to the user and create the entry in sasldb database.
2010-01-20 14:53:09 +01:00
ask_and_create_password ()
{
local - newemailpassword
emailpassword=""
newemailpassword="different"
while [ "$emailpassword" != "$newemailpassword" ]
do
emailpassword=""
2010-01-20 16:13:51 +01:00
echo "What password do you want for your email account?"
2010-01-20 14:53:09 +01:00
while [ -z "$emailpassword" ]
do
2010-01-20 16:13:51 +01:00
echo -n "Password: "
2010-01-20 14:53:09 +01:00
read emailpassword
done
newemailpassword=""
2010-01-20 16:13:51 +01:00
echo "Please re-enter your password to ensure you typed it correctly."
2010-01-20 14:53:09 +01:00
while [ -z "$newemailpassword" ]
do
2010-01-20 16:13:51 +01:00
echo -n "Password (bis): "
2010-01-20 14:53:09 +01:00
read newemailpassword
done
if [ "$emailpassword" != "$newemailpassword" ]
then
2010-01-20 16:13:51 +01:00
echo "Passwords don't match!"
2010-01-20 14:53:09 +01:00
fi
done
echo "$emailpassword" | saslpasswd2 -p -u "$emaildomain" "$emailuser"
}
2010-01-20 16:13:51 +01:00
# Check if a password already exists in the sasldb database.
2010-01-20 14:53:09 +01:00
# Then ask a password to the user and create the entry in sasldb
2010-01-20 16:13:51 +01:00
# database if password doesn't exist are user want to change it.
2010-01-20 14:53:09 +01:00
create_sasldb_password ()
{
local - first_ask next_ask
sasldblistusers2 | grep "$emailuser@$emaildomain" > /dev/null
if [ $? -eq 0 ]
then
2010-01-20 16:13:51 +01:00
first_ask="There is already a password for this user, do you want to change it?"
next_ask="Do you want to change the existing password for your email account?"
2010-01-20 14:53:09 +01:00
ask_user_default_no "$first_ask" "$next_ask"
if [ $? -eq 0 ]
then
ask_and_create_password
else
emailpassword="has remained unchanged"
fi
else
ask_and_create_password
fi
}
# Add the domain of the email account to the list of virtual domain
2010-01-20 16:13:51 +01:00
# in cyrus and postfix if necessary.
2010-01-20 14:53:09 +01:00
update_virtual_domains ()
{
local -
grep "defaultdomain:" /etc/imapd.conf | grep "$emaildomain" > /dev/null
if [ ! $? -eq 0 ]
then
grep "loginrealms:" /etc/imapd.conf | grep "$emaildomain" > /dev/null
if [ ! $? -eq 0 ]
then
sed -r -i "s/^([[:space:]]*loginrealms): ?(.*)$/\1: $emaildomain \2/" /etc/imapd.conf
fi
fi
grep "mydomain[[:space:]]*=" /etc/postfix/main.cf | grep "$emaildomain" > /dev/null
if [ ! $? -eq 0 ]
then
grep "virtual_mailbox_domains[[:space:]]*=" /etc/postfix/main.cf | grep "$emaildomain" /dev/null
if [ ! $? -eq 0 ]
then
sed -r -i "s/^([[:space:]]*virtual_mailbox_domains[[:space:]]*)= ?(.*)$/\1= $emaildomain \2/" /etc/postfix/main.cf
fi
fi
}
# Print the first parameter and then the second parameter at a distance
2010-01-20 16:13:51 +01:00
# of $3 tabs.
2010-01-20 14:53:09 +01:00
echo_with_tabs ()
{
local - nbchars nbtabs
nbchars=$(echo "$1" | wc -m)
nbtabs=$(($3-nbchars/8))
2010-01-20 15:53:23 +01:00
[ $nbtabs -lt 1 ] && nbtabs=1
2010-01-20 14:53:09 +01:00
echo -n "$1"
for i in $(seq $nbtabs)
do
echo -n "\t"
done
echo "$2"
}
2010-01-20 16:13:51 +01:00
# Add requested email to postfix virtual_mailbox_maps.
2010-01-20 14:53:09 +01:00
update_postfix_email_account ()
{
local -
grep "^[[:space:]]*$emailuser@$emaildomain" /etc/postfix/vmailbox > /dev/null
if [ ! $? -eq 0 ]
then
echo_with_tabs "$emailuser@$emaildomain" "whatever" 4 >> /etc/postfix/vmailbox
fi
if [ ! $# -eq 0 ]
then
grep "^[[:space:]]*$aliasuser@$aliasdomain" /etc/postfix/vmailbox > /dev/null
if [ ! $? -eq 0 ]
then
echo_with_tabs "$aliasuser@$aliasdomain" "whatever" 4 >> /etc/postfix/vmailbox
fi
fi
2010-01-20 15:03:14 +01:00
postmap /etc/postfix/vmailbox
2010-01-20 14:53:09 +01:00
}
2010-01-20 16:13:51 +01:00
# Add requested alias to postfix virtual_alias_maps.
2010-01-20 14:53:09 +01:00
update_email_aliases ()
{
local -
grep "$aliasuser@$aliasdomain[[:space:]]+$emailuser@$emaildomain" /etc/postfix/virtual > /dev/null
if [ ! $? -eq 0 ]
then
echo_with_tabs "$aliasuser@$aliasdomain" "$emailuser@$emaildomain" 4 >> /etc/postfix/virtual
fi
2010-01-20 15:03:14 +01:00
postmap /etc/postfix/virtual
2010-01-20 14:53:09 +01:00
}
display_infos ()
{
local - imap imaps imapret imapsret security
set +u
grep "defaultdomain:" /etc/imapd.conf | grep "$emaildomain" > /dev/null
if [ $? -eq 0 ]
then
echo "Your email login is $emailuser and your password $emailpassword"
else
echo "Your email login is $emailuser@$emaildomain and your password $emailpassword"
fi
2010-01-20 16:13:51 +01:00
echo -n "Supported mechanism for imap authentification are: "
2010-01-20 14:53:09 +01:00
sed -r -n "{s/sasl_mech_list: *(.*)$/\1/;t success;T;: success;p}" /etc/imapd.conf
echo -n "The imap server listen on port "
imap=$(grep -E "^[^#]+cmd=\"imapd[^#]+listen=\"imap\"" /etc/cyrus.conf)
imapret=$?
if [ $imapret -eq 0 ]
then
security=$(echo "$imap" | sed -r -n "{s/^.*cmd=\".* -s.*$/(SSL\/TLS)/;t success;T;: success;p}")
if [ -z "$security" ]
then
security="(STARTTLS)"
fi
echo -n "143 ($security)"
fi
imaps=$(grep -E "^[^#]+cmd=\"imapd[^#]+listen=\"imaps\"" /etc/cyrus.conf)
imapsret=$?
if [ $imapsret -eq 0 ]
then
security=$(echo "$imaps" | sed -r -n "{s/^.*cmd=\".* -s.*$/(SSL\/TLS)/;t success;T;: success;p}")
if [ -z "$security" ]
then
security="(STARTTLS)"
fi
if [ $imapret -eq 0 ]
then
echo -n " and on port "
fi
echo -n "993 ($security)"
fi
2010-01-20 16:13:51 +01:00
echo "."
2010-01-20 14:53:09 +01:00
}
# Restore cyrus state as it was before making it cyradm ready, that is
# restore allowplaintext, virtdomain and make it listen on *:imap
# instead of localhost:imap
restore_cyrus_state ()
{
local -
sed -r -i "s/^(.*cmd=\"imapd.* listen=\")localhost:(imap\".*)$/\1\2/" /etc/cyrus.conf
2010-01-20 16:13:51 +01:00
# OK, let's explain the following sed line.
# First you must understand that for each line, all the commands inside
# the {} block and separated by ; are executed.
2010-01-20 14:53:09 +01:00
# When the allowplaintext commented line is found, the # is removed by
# a s/pattern/replacement/ command. Then, as this substitution is
# successful, we jump at success which copy the substituted line in
# the hold space, get the next line in the pattern space and replace
# it by the substituted line. We've just deleted the next line. Then,
# we print the line in the pattern space. If from the beginning we
# have a non allowplaintext line, then T makes us jump to fail and
2010-01-20 16:13:51 +01:00
# print the line in the pattern space (that is the current line).
2010-01-20 14:53:09 +01:00
sed -r -n -i "{s/^#([[:space:]]*allowplaintext:.*)$/\1/;t success;T fail;: success;h;n;g;: fail;p}" /etc/imapd.conf
2010-01-20 16:13:51 +01:00
# Same as above for virtdomains
2010-01-20 14:53:09 +01:00
sed -r -n -i "{s/^#([[:space:]]*virtdomains:.*)$/\1/;t success;T fail;: success;h;n;g;: fail;p}" /etc/imapd.conf
invoke-rc.d --quiet cyrus2.2 restart
if [ ! $? -eq 0 ]
then
2010-01-20 16:13:51 +01:00
echo "Error! Restarting cyrus failed."
2010-01-20 14:53:09 +01:00
exit 1
fi
2010-01-20 15:01:31 +01:00
invoke-rc.d --quiet postfix reload
2010-01-20 14:53:09 +01:00
if [ ! $? -eq 0 ]
then
2010-01-20 16:13:51 +01:00
echo "Error! Reloading postfix failed."
2010-01-20 14:53:09 +01:00
exit 1
fi
}
# Create the mailbox
create_mail_account ()
{
local - nblines
nblines=$(echo "listmailbox user.$emailuser@$emaildomain" | cyradm --user $cyruser --auth login --pass $cyrpwd localhost | wc -l)
if [ $nblines -eq 0 ]
then
echo "Mailbox for $emailuser@$emaildomain doesn't exist, creating it…"
echo "createmailbox user.$emailuser@$emaildomain" | cyradm --user $cyruser --auth login --pass $cyrpwd localhost
fi
}
main ()
{
ret=0
# This test should be useless if rights on this file are corrects
# (that is 770 for root:gt owner)
test_args "$@"
if must_sudo
then
try_sudo "$@"
fi
test_cyrus_admin
save_cyrus_state_and_become_cyradm_ready
if [ $? -eq 0 ]
then
create_sasldb_password
update_virtual_domains
aliasuser="${aliasuser:-""}"
if [ -n "$aliasuser" ]
then
update_postfix_email_account 1
update_email_aliases
else
update_postfix_email_account
fi
create_mail_account
display_infos
else
ret=1
fi
restore_cyrus_state
return $ret
}
main "$@"
exit $?