2018-04-02 08:45:58 +00:00
|
|
|
#! /bin/bash
|
|
|
|
|
2022-02-21 10:56:57 +00:00
|
|
|
# shellcheck source=../scripts/helpers/index.sh
|
|
|
|
source /usr/local/bin/helpers/index.sh
|
2018-04-02 08:45:58 +00:00
|
|
|
|
refactor: CLI commands for database management (#2654)
See the associated PR for more detailed commentary on specific changes.
### Commands refactored:
- User (**All:** add / list / update / del + _dovecot-master variants_)
- Quota (**All:** set / del)
- Virtual Alias (**All:** add / list /del)
- Relay (**All:** add-relayhost / add-sasl / exclude-domain)
### Overall changes involve:
- **Fairly common structure:**
- `_main` method at the top provides an overview of logical steps:
- After all methods are declared beneath it (_and imported from the new `helpers/database/db.sh`_), the `_main` is called at the bottom of the file.
- `delmailuser` additionally processes option support for `-y` prior to calling `_main`.
- `__usage` is now consistent with each of these commands, along with the `help` command.
- Most logic delegated to new helper scripts. Some duplicate content remains on the basis that it's low-risk to maintenance and avoids less hassle to jump between files to check a single line, usually this is arg validation.
- Error handling should be more consistent, along with var names (_no more `USER`/`EMAIL`/`FULL_EMAIL` to refer to the same expected value_).
- **Three new management scripts** (in `helpers/database/manage/`) using a common structure for managing changes to their respective "Database" config file.
- `postfix-accounts.sh` unified not only add and update commands, but also all the dovecot-master versions, a single password call for all 4 of them, with a 5th consumer of the password prompt from the relay command `addsaslpassword`.
- These scripts delegate actual writes to `helpers/database/db.sh` which provides a common API to support the changes made.
- This is more verbose/complex vs the current inline operations each command currently has, as it provides generic support instead of slightly different variations being maintained, along with handling some edge cases that existed and would lead to bugs (notably substring matches).
- Centralizing changes here seems wiser than scattered about. I've tried to make it easy to grok, hopefully it's not worse than the current situation.
- List operations were kept in their respective commands, `db.sh` is only really managing writes. I didn't see a nice way for removing the code duplication for list commands as the duplication was fairly minimal, especially for `listalias` and `listdovecotmasteruser` which were quite simple in their differences in the loop body.
- `listmailuser` and `delmailuser` also retain methods exclusive to respective commands, I wasn't sure if there was any benefit to move those, but they were refactored.
2022-07-29 00:10:23 +00:00
|
|
|
function _main
|
|
|
|
{
|
|
|
|
[[ ${1:-} == 'help' ]] && { __usage ; exit 0 ; }
|
|
|
|
|
|
|
|
local DOMAIN="${1}"
|
|
|
|
local RELAY_ACCOUNT="${2}"
|
|
|
|
shift 2
|
|
|
|
local PASSWD="${*}"
|
|
|
|
|
|
|
|
_validate_parameters
|
|
|
|
_add_relayhost_credentials
|
|
|
|
}
|
|
|
|
|
|
|
|
function __usage
|
|
|
|
{
|
|
|
|
printf '%s' "${PURPLE}addsaslpassword${RED}(${YELLOW}8${RED})
|
|
|
|
|
|
|
|
${ORANGE}USAGE${RESET}
|
|
|
|
./setup.sh relay add-auth <SENDER DOMAIN> <RELAY ACCOUNT> [<RELAY PASSWORD>]
|
|
|
|
|
|
|
|
${ORANGE}OPTIONS${RESET}
|
|
|
|
${BLUE}Generic Program Information${RESET}
|
|
|
|
help Print the usage information.
|
|
|
|
|
|
|
|
${ORANGE}DESCRIPTION${RESET}
|
|
|
|
Add credentials to authenticate to a relay-host service.
|
|
|
|
|
|
|
|
To avoid a password being logged in the command history of your shell,
|
|
|
|
you may omit it, you'll be prompted to input the password instead.
|
|
|
|
|
|
|
|
${ORANGE}EXAMPLES${RESET}
|
|
|
|
${LWHITE}./setup.sh relay add-auth example.com relay-account${RESET}
|
|
|
|
Any mail submitted for your '@example.com' accounts that is sent
|
|
|
|
through a relay-host service will authenticate with the credentials:
|
|
|
|
'relay-account' + the password you entered at the prompt.
|
|
|
|
|
|
|
|
${ORANGE}EXIT STATUS${RESET}
|
|
|
|
Exit status is 0 if command was successful. If wrong arguments are provided
|
|
|
|
or arguments contain errors, the script will exit early with exit status 1.
|
|
|
|
|
|
|
|
"
|
|
|
|
}
|
|
|
|
|
|
|
|
function _validate_parameters
|
|
|
|
{
|
|
|
|
[[ -z ${DOMAIN} ]] && { __usage ; _exit_with_error 'No domain specified' ; }
|
|
|
|
[[ -z ${RELAY_ACCOUNT} ]] && { __usage ; _exit_with_error 'No relay account specified' ; }
|
|
|
|
_password_request_if_missing
|
|
|
|
}
|
|
|
|
|
|
|
|
# Config is for sender dependent relay-host auth,
|
|
|
|
# current support restricts senders to their domain scope.
|
|
|
|
#
|
|
|
|
# NOTE: This command does not support providing a relay-host
|
|
|
|
# as the lookup key, it only supports a lookup via sender domain.
|
|
|
|
function _add_relayhost_credentials
|
|
|
|
{
|
|
|
|
local SENDER="@${DOMAIN}"
|
|
|
|
local RELAY_HOST_ENTRY_AUTH="${RELAY_ACCOUNT}:${PASSWD}"
|
|
|
|
local DATABASE_PASSWD='/tmp/docker-mailserver/postfix-sasl-password.cf'
|
|
|
|
|
|
|
|
_db_entry_add_or_replace "${DATABASE_PASSWD}" "${SENDER}" "${RELAY_HOST_ENTRY_AUTH}"
|
|
|
|
}
|
|
|
|
|
|
|
|
_main "${@}"
|