commit 7bc1a2f65f8f74fa138a8ad0a2e82d3a770c7b36
Author: Petar Yotsev <petar@yotsev.xyz>
Date: Sun, 23 May 2021 16:14:06 +0100
Initial commit
Diffstat:
16 files changed, 743 insertions(+), 0 deletions(-)
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,339 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
diff --git a/README b/README
@@ -0,0 +1,38 @@
+## About
+
+mmv - minimal mailserver virtual
+
+mmv is a script for setting up a personal email server on OpenBSD using
+virtual users.
+
+As you might have guessed, there also exists a fork -
+[mms](https://git.yotsev.xyz/mms)
+- that uses system users.
+
+WARNING: The script is still in development and liable to drastic
+changes with no backwards compatibility.
+
+## Prerequisites
+
+The script automates as much as possible but there is one thing out of
+its reach - dns. You'll need a valid A and/or AAAA record for the domain
+you're going to use and for a subdomain `mail.domain.tld`.
+
+## Installation
+
+ git clone git://git.yotsev.xyz/mmv.git
+ cd mmv
+ ./setup.sh domain.tld
+
+## Post-execution
+
+After the script has finished executing successfully, it will have
+written dns record that you have to paste into your name server or your
+registrar's interface.
+
+## Usage
+
+After everything is in place, you can use the newly created script
+`newuser` to add a user account.
+
+ ./newuser
diff --git a/files/acme-client.conf b/files/acme-client.conf
@@ -0,0 +1,10 @@
+authority letsencrypt {
+ api url "https://acme-v02.api.letsencrypt.org/directory"
+ account key "/etc/acme/letsencrypt-privkey.pem"
+}
+
+domain <maildom> {
+ domain key "/etc/ssl/private/<maildom>.key"
+ domain full chain certificate "/etc/ssl/<maildom>.crt"
+ sign with letsencrypt
+}
diff --git a/files/daily.local b/files/daily.local
@@ -0,0 +1,2 @@
+# renew Let's Encrypt certificate if necessary
+acme-client -v <maildom>
diff --git a/files/dkim_signing.conf b/files/dkim_signing.conf
@@ -0,0 +1,6 @@
+domain {
+ <domain> {
+ path = "/etc/mail/dkim/<domain>.key";
+ selector = "mail";
+ }
+}
diff --git a/files/httpd.conf b/files/httpd.conf
@@ -0,0 +1,7 @@
+server "<maildom>" {
+ listen on * port 80
+ location "/.well-known/acme-challenge/*" {
+ root "/acme"
+ request strip 2
+ }
+}
diff --git a/files/local.conf b/files/local.conf
@@ -0,0 +1,127 @@
+# listen on IPv4 and IPv6
+
+listen = *, ::
+
+#
+# authentication
+#
+
+# tls
+
+disable_plaintext_auth = yes
+ssl = required
+ssl_cert = </etc/ssl/<maildom>.crt
+ssl_key = </etc/ssl/private/<maildom>.key
+ssl_min_protocol = TLSv1.2
+ssl_cipher_list = ALL:!LOW:!EXP:!aNULL
+ssl_prefer_server_ciphers = yes
+auth_mechanisms = plain login
+auth_username_format = %n
+
+# user authentication
+
+first_valid_uid = 2000
+first_valid_gid = 2000
+userdb {
+ args = username_format=%u /etc/mail/credentials
+ driver = passwd-file
+ name =
+}
+passdb {
+ args = scheme=CRYPT username_format=%u /etc/mail/credentials
+ driver = passwd-file
+ name =
+}
+
+#
+# mailbox
+#
+
+mail_location = maildir:/var/vmail/%d/%n
+
+namespace inbox {
+ type = private
+ separator = /
+ prefix =
+ location = ~/var/vmail/%d/%n/Inbox
+ inbox = yes
+ hidden = no
+ list = yes
+ subscriptions = yes
+
+ mailbox Archive {
+ auto = subscribe
+ special_use = \Archive
+ }
+ mailbox Drafts {
+ auto = subscribe
+ special_use = \Drafts
+ }
+ mailbox Junk {
+ auto = subscribe
+ special_use = \Junk
+ }
+ mailbox Sent {
+ auto = subscribe
+ special_use = \Sent
+ }
+ mailbox Trash {
+ auto = subscribe
+ special_use = \Trash
+ }
+}
+
+mail_attachment_dir = ~/Maildir/attachments/
+
+#
+# protocol settings
+#
+
+protocols = imap
+
+service imap-login {
+ inet_listener imap {
+ port = 0
+ }
+}
+
+#
+# sieve
+#
+
+protocols = $protocols sieve
+
+mail_plugin_dir = /usr/local/lib/dovecot
+
+plugin {
+ imapsieve_mailbox1_before = file:/usr/local/lib/dovecot/sieve/report-spam.sieve
+ imapsieve_mailbox1_causes = COPY
+ imapsieve_mailbox1_name = Junk
+ imapsieve_mailbox2_before = file:/usr/local/lib/dovecot/sieve/report-ham.sieve
+ imapsieve_mailbox2_causes = COPY
+ imapsieve_mailbox2_from = Junk
+ imapsieve_mailbox2_name = *
+ sieve = file:~/sieve;active=~/.dovecot.sieve
+ sieve_global_extensions = +vnd.dovecot.pipe +vnd.dovecot.environment
+ sieve_pipe_bin_dir = /usr/local/lib/dovecot/sieve
+ sieve_plugins = sieve_imapsieve sieve_extprograms
+}
+
+service managesieve-login {
+ inet_listener sieve {
+ port = 4190
+ }
+ inet_listener sieve_deprecated {
+ port = 2000
+ }
+}
+
+protocol imap {
+ mail_plugins = "imap_sieve"
+}
+
+managesieve_notify_capability = mailto
+managesieve_sieve_capability = fileinto reject envelope encoded-character vacation subaddress comparator-i;ascii-numeric relational regex imap4flags copy include variables body enotify environment mailbox date index ihave duplicate mime foreverypart extracttext imapsieve vnd.dovecot.imapsieve
+
+# OpenBSD specific
+mmap_disable = yes
diff --git a/files/newuser b/files/newuser
@@ -0,0 +1,12 @@
+#!/bin/sh
+
+echo -n "Username: "
+read -r user
+echo -n "Password: "
+read -r password
+
+record="$(smtpctl encrypt "$password")"
+record="$user@<domain>:$record:vmail:2000:2000:/var/vmail/<domain>/$user::userdb_mail=maildir:/var/vmail/<domain>/$user"
+echo "$record" >> /etc/mail/credentials
+
+echo "$user@<domain>: vmail" >> /etc/mail/virtuals
diff --git a/files/report-ham.sieve b/files/report-ham.sieve
@@ -0,0 +1,13 @@
+require ["vnd.dovecot.pipe", "copy", "imapsieve", "environment", "variables"];
+
+if environment :matches "imap.mailbox" "*" {
+ set "mailbox" "${1}";
+}
+
+if string "${mailbox}" "Trash" {
+ stop;
+}
+
+if environment :matches "imap.user" "*" {
+ set "username" "${1}";
+}
diff --git a/files/report-spam.sieve b/files/report-spam.sieve
@@ -0,0 +1,7 @@
+require ["vnd.dovecot.pipe", "copy", "imapsieve", "environment", "variables"];
+
+if environment :matches "imap.user" "*" {
+ set "username" "${1}";
+}
+
+pipe :copy "sa-learn-spam.sh" [ "${username}" ];
diff --git a/files/sa-learn-ham.sh b/files/sa-learn-ham.sh
@@ -0,0 +1,3 @@
+#!/bin/sh
+
+exec /usr/local/bin/rspamc -d "${1}" learn_ham
diff --git a/files/sa-learn-spam.sh b/files/sa-learn-spam.sh
@@ -0,0 +1,3 @@
+#!/bin/sh
+
+exec /usr/local/bin/rspamc -d "${1}" learn_spam
diff --git a/files/smtpd.conf b/files/smtpd.conf
@@ -0,0 +1,28 @@
+# smtpd.conf
+
+# configure TLS
+pki "mail" cert "/etc/ssl/<maildom>.crt"
+pki "mail" key "/etc/ssl/private/<maildom>.key"
+
+# aliases table
+table aliases file:/etc/mail/aliases
+table credentials passwd:/etc/mail/credentials
+table virtuals file:/etc/mail/virtuals
+
+filter "rspamd" proc-exec "/usr/local/libexec/smtpd/filter-rspamd"
+
+# listen directives
+listen on all tls pki "mail" hostname "<maildom>" filter "rspamd"
+listen on egress port submission tls-require pki "mail" \
+ hostname "<maildom>" auth <credentials> filter "rspamd"
+
+action "local" mbox alias <aliases>
+action "inbound" maildir "/var/vmail/<domain>/%{dest.user:lowercase}" virtual <virtuals>
+action "outbound" relay helo "<domain>"
+
+# accept external mail
+match from any for domain "<domain>" action "inbound"
+match from local for local action "local"
+
+match from local for any action "outbound"
+match from auth for any action "outbound"
diff --git a/files/virtuals b/files/virtuals
@@ -0,0 +1,4 @@
+abuse@<domain>: admin@<domain>
+hostmaster@<domain>: admin@<domain>
+postmaster@<domain>: admin@<domain>
+webmaster@<domain>: admin@<domain>
diff --git a/key-locations b/key-locations
@@ -0,0 +1,9 @@
+tls cert
+/etc/ssl/private/<maildom>.key
+/etc/ssl/<maildom>.crt
+
+dkim cert
+/etc/mail/dkim/<domain>.key
+/etc/mail/dkim/public.key
+
+dkim selector - "mail"
diff --git a/setup.sh b/setup.sh
@@ -0,0 +1,135 @@
+#!/bin/sh
+
+domain=$1
+maildom="mail.$domain"
+
+replace() { \
+sed "s/<domain>/$domain/g;s/<maildom>/$maildom/g" $1
+}
+
+#
+# install required software
+#
+
+pkg_add opensmtpd-extras opensmtpd-filter-rspamd dovecot dovecot-pigeonhole rspamd redis sieve &&
+
+echo "\nInstalled required software\n" &&
+
+#
+# certs
+#
+
+replace files/acme-client.conf > /etc/acme-client.conf &&
+
+replace files/httpd.conf > /etc/httpd.conf &&
+
+rcctl enable httpd &&
+rcctl start httpd &&
+
+acme-client -v $maildom &&
+
+replace files/daily.local > /etc/daily.local &&
+
+echo "\nCreated and signed tls certificates (letencrypt)\n" &&
+
+#
+# vmail user & authentication
+#
+
+touch /etc/mail/credentials &&
+chmod 0440 /etc/mail/credentials &&
+chown _smtpd:_dovecot /etc/mail/credentials &&
+useradd -c "Virtual Mail Account" -d /var/vmail -s /sbin/nologin \
+ -u 2000 -g =uid -L staff vmail &&
+mkdir -p /var/vmail &&
+chown vmail:vmail /var/vmail &&
+
+replace files/virtuals > /etc/mail/virtuals &&
+replace files/newuser > ./newuser &&
+chmod +x ./newuser &&
+
+echo "\nCreated vmail user & authentication file\n" &&
+
+#
+# smtpd
+#
+
+replace files/smtpd.conf > /etc/smtpd.conf &&
+
+echo "\nConfigured OpenSMTPD\n" &&
+
+#
+# dovecot
+#
+
+echo "dovecot:\\
+ :openfiles-cur=1024:\\
+ :openfiles-max=2048:\\
+ :tc=daemon:
+" >> /etc/login.conf &&
+
+replace files/local.conf > /etc/dovecot/local.conf &&
+
+sed "s/^ssl_cert/#ssl_cert/;s/^ssl_key/#ssl_key/" \
+ /etc/dovecot/conf.d/10-ssl.conf > tempfile &&
+mv tempfile /etc/dovecot/conf.d/10-ssl.conf &&
+
+# setup training rspamd from email moving in and out of the Junk folder
+
+mkdir -p /usr/local/lib/dovecot/sieve &&
+cp files/report-ham.sieve /usr/local/lib/dovecot/sieve &&
+cp files/report-spam.sieve /usr/local/lib/dovecot/sieve &&
+sievec /usr/local/lib/dovecot/sieve/report-ham.sieve &&
+sievec /usr/local/lib/dovecot/sieve/report-spam.sieve &&
+
+cp files/sa-learn-ham.sh /usr/local/lib/dovecot/sieve/ &&
+cp files/sa-learn-spam.sh /usr/local/lib/dovecot/sieve/ &&
+chmod 0755 /usr/local/lib/dovecot/sieve/sa-learn-ham.sh &&
+chmod 0755 /usr/local/lib/dovecot/sieve/sa-learn-spam.sh &&
+
+rcctl enable dovecot &&
+rcctl start dovecot &&
+
+echo "\nConfigured Dovecot\n" &&
+
+#
+# rspamd
+#
+
+mkdir -p /etc/mail/dkim &&
+openssl genrsa -out /etc/mail/dkim/$domain.key 1024 &&
+openssl rsa -in /etc/mail/dkim/$domain.key \
+ -pubout -out /etc/mail/dkim/public.key &&
+chmod 0440 /etc/mail/dkim/$domain.key &&
+chown root:_rspamd /etc/mail/dkim/$domain.key &&
+
+replace files/dkim_signing.conf > /etc/rspamd/local.d/dkim_signing.conf &&
+
+rcctl enable redis rspamd &&
+rcctl start redis rspamd &&
+rcctl restart smtpd &&
+
+echo "\nConfigured rspamd\n" &&
+
+#
+# dns
+#
+
+pub_key=$(cat /etc/mail/dkim/public.key | grep -v --- | tr -d '\n' ) &&
+
+mkdir -p dns &&
+echo "mail._domainkey.$domain. IN TXT \"v=DKIM1;k=rsa;p=$pub_key\"" > ./dns/dkim-record &&
+echo "$domain. IN TXT \"v=spf1 mx -all\"" > ./dns/spf-record &&
+echo "_dmarc.$domain. IN TXT \"v=DMARC1;p=none;pct=100;rua=mailto:postmaster@$domain\"" > ./dns/dmarc-record &&
+
+echo "\nWrote relevant dns records in ./dns/\n" &&
+# TODO: does .forward work with virtual users?
+echo \
+"The creation of an admin account is required for this setup! Email to
+it can be forwarded to an email address written in:
+/var/vmail/$domain/admin/.forward
+New users can be similarly added by running ./newuser. Please use the
+username \"admin\" and a password of your choosing" &&
+
+./newuser &&
+rcctl restart smtpd
