-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathlightsail-miab-installer.sh
1539 lines (1318 loc) · 46.2 KB
/
lightsail-miab-installer.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/bin/sh
#
# @author Rio Astamal <rio@rioastamal.net>
# @desc Script to automate Open Source mail server package Mail-in-a-Box on
# a single Amazon Lightsail instance
readonly LMIAB_SCRIPT_NAME=$( basename "$0" )
LMIAB_BASEDIR=$( cd -P -- "$( dirname "$0" )" && pwd -P )
LMIAB_VERSION="1.0"
LC_CTYPE="C"
# Path to directory to store application outputs
LMIAB_OUTPUT_DIR="$LMIAB_BASEDIR/.out"
LMIAB_CACHE_DIR="$LMIAB_OUTPUT_DIR/caches"
# Default config
# --------------
[ -z "$LMIAB_CLOUDFORMATION_STACKNAME_PREFIX" ] && LMIAB_CLOUDFORMATION_STACKNAME_PREFIX="miab"
[ -z "$LMIAB_NODE_PREFIX" ] && LMIAB_NODE_PREFIX="miab"
[ -z "$LMIAB_SSH_LIGHTSAIL_KEYPAIR_NAME" ] && LMIAB_SSH_LIGHTSAIL_KEYPAIR_NAME="id_rsa"
[ -z "$LMIAB_SSH_PRIVATE_KEY_FILE" ] && LMIAB_SSH_PRIVATE_KEY_FILE="$HOME/.ssh/id_rsa"
[ -z "$LMIAB_FIREWALL_SSH_ALLOW_CIDR" ] && LMIAB_FIREWALL_SSH_ALLOW_CIDR="0.0.0.0/0"
[ -z "$LMIAB_DRY_RUN" ] && LMIAB_DRY_RUN="no"
[ -z "$LMIAB_AZ" ] && LMIAB_AZ="us-east-1a"
[ -z "$LMIAB_PLAN" ] && LMIAB_PLAN="5_usd"
[ -z "$LMIAB_DEBUG" ] && LMIAB_DEBUG="true"
[ -z "$LMIAB_IS_RESTORE" ] && LMIAB_IS_RESTORE="no"
[ -z "$LMIAB_PACKAGE_URL" ] && LMIAB_PACKAGE_URL="https://github.com/mail-in-a-box/mailinabox/archive/refs/tags/v67.tar.gz"
[ -z "$LMIAB_SMTP_RELAY_ENDPOINT" ] && LMIAB_SMTP_RELAY_ENDPOINT=""
[ -z "$LMIAB_SMTP_RELAY_PORT" ] && LMIAB_SMTP_RELAY_PORT="587"
[ -z "$LMIAB_SMTP_RELAY_USER" ] && LMIAB_SMTP_RELAY_USER=""
[ -z "$LMIAB_SMTP_RELAY_PASSWORD" ] && LMIAB_SMTP_RELAY_PASSWORD=""
[ -z "$LMIAB_ADMIN_EMAIL" ] && LMIAB_ADMIN_EMAIL=""
[ -z "$LMIAB_EMAIL_DOMAIN" ] && LMIAB_EMAIL_DOMAIN=""
[ -z "$LMIAB_ADMIN_PASSWORD" ] && LMIAB_ADMIN_PASSWORD=""
[ -z "$LMIAB_BOX_HOSTNAME" ] && LMIAB_BOX_HOSTNAME=""
[ -z "$LMIAB_DISABLE_SMTP_RELAY" ] && LMIAB_DISABLE_SMTP_RELAY="no"
[ -z "$LMIAB_DISABLE_S3_BACKUP" ] && LMIAB_DISABLE_S3_BACKUP="no"
[ -z "$LMIAB_MAIL_BACKUP_BUCKET" ] && LMIAB_MAIL_BACKUP_BUCKET=""
[ -z "$LMIAB_NEXTCLOUD_BACKUP_BUCKET" ] && LMIAB_NEXTCLOUD_BACKUP_BUCKET=""
# See all available OS/Blueprint ID using: `aws lightsail get-blueprints`
# Only Ubuntu 22.04 is supported at the moment.
LMIAB_NODE_OS_ID="ubuntu_22_04"
LMIAB_OS_USERNAME="ubuntu"
# Required tools to perform tasks
LMIAB_REQUIRED_TOOLS="awk aws base64 cat cut date jq openssl sed ssh tee tr wc"
# WARNING! Undocumented flag for destroying all resources
# Only can be activated by --destroy-all-resources flag
LMIAB_DESTROY_ALL_RESOURCES="no"
# Environment below only used in conjunction with LMIAB_DESTROY_ALL_RESOURCES
[ -z "$LMIAB_DELETE_S3_BUCKET" ] && LMIAB_DELETE_S3_BUCKET="yes"
# In memory cache
LMIAB_CACHE_NODE_PUBLIC_IP=""
# Function to show the help message
lmiab_help()
{
echo "\
Usage: $0 [OPTIONS]
Where OPTIONS:
--az AZ Instance availability zone specified by AZ. Default to
'us-east-1a'.
--destroy Destroy installation specified by --installation-id.
--disable-s3-backup Do not configure Mail-in-a-Box to backup mailserver
data to Amazon S3.
--disable-smtp-relay Do not configure Postfix to use Amazon SES as SMTP
relay.
--dry-run Dry run mode, print CloudFormation template and exit.
--email EMAIL Mail-in-a-Box administrator email specified by EMAIL.
An example 'admin@example.com'.
--help Print this help and exit.
--hostname HOSTNAME Mail-in-a-Box primary hostname specified by HOSTNAME.
An example 'box.example.com'.
--installation-id ID Installation identifier by ID, e.g 'demo'.
--instance-type TYPE Amazon Lightsail plan specified by TYPE. Valid value:
'5_usd', '10_usd', '20_usd', '40_usd', '80_usd', or
'160_usd'. Default is '5_usd'.
--password PASSWD Mail-in-a-Box administrator password specified by
PASSWD.
--restore Restore installation data from backup which stored on
S3 bucket. See --restore-help for more info.
--restore-help Print help information how to restore from backup.
--version Print script version.
--------------------------- lightsail-miab-installer ---------------------------
lightsail-miab-installer is a powerful command line tool powered by
Mail-in-a-Box, designed to simplify the setup of a complete mail server on
Amazon Lightsail.
lightsail-miab-installer is free software licensed under MIT. Visit the project
homepage at http://github.com/rioastamal/lightsail-miab-installer."
}
lmiab_restore_help()
{
echo "\
In order to restore Mail-in-a-Box data from previous installation you need to
set several environment variables.
LMIAB_MAIL_BACKUP_BUCKET=
S3 bucket name which stores mail backup from previous installation.
LMIAB_NEXTCLOUD_BACKUP_BUCKET=
S3 Bucket name which stores Nextcloud backup from previous installation.
LMIAB_BACKUP_SECRET_KEY=
Mail-in-a-Box backup secret key from previous installation, which you can find
it at /home/user-data/backup/secret_key.txt or via AWS System Manager
Parameter Stores."
}
lmiab_write_log()
{
_LOG_MESSAGE="$@"
_SYSLOG_DATE_STYLE="$( date +"%b %e %H:%M:%S" )"
# Date Hostname AppName[PID]: MESSAGE
printf "[%s LMIAB]: %s\n" \
"$_SYSLOG_DATE_STYLE" \
"${_LOG_MESSAGE}">> "$LMIAB_LOG_FILE"
}
lmiab_log()
{
[ "$LMIAB_DEBUG" = "true" ] && printf "[LMIAB]: %s\n" "$@"
lmiab_write_log "$@"
}
lmiab_log_waiting()
{
[ "$LMIAB_DEBUG" = "true" ] && printf "\r[LMIAB]: %s\033[K" "$@"
lmiab_write_log "$@"
}
lmiab_err() {
printf "[LMIAB ERROR]: %s\n" "$@" >&2
lmiab_write_log "$@"
}
lmiab_missing_tool()
{
for tool in $( echo "$LMIAB_REQUIRED_TOOLS" )
do
command -v $tool >/dev/null || {
echo "$tool"
return 1
}
done
echo ""
return 0
}
lmiab_is_ssh_keypair_valid()
{
aws lightsail get-key-pair --key-pair-name $LMIAB_SSH_LIGHTSAIL_KEYPAIR_NAME >/dev/null 2>/dev/null || {
lmiab_err "Can not find SSH key pair '$LMIAB_SSH_LIGHTSAIL_KEYPAIR_NAME' in region $LMIAB_REGION"
return 1
}
return 0
}
lmiab_gen_random_chars()
{
local _LENGTH=$1
tr -dc 'a-z0-9' </dev/urandom | head -c $_LENGTH; echo
return 0
}
lmiab_sign_hmac_sha256()
{
while [ $# -gt 0 ]; do
case $1 in
# --key) local _KEY="$( echo -n "$2" | base64 -d -i )"; shift ;;
--key) local _KEY="$( echo -n "$2" | sed 's/[^A-Za-z0-9+/=]//g' | base64 -d | xxd -p | tr -d '\n' )"; shift ;;
--message) local _MESSAGE="$2"; shift ;;
*) echo "Unrecognised option passed: $1" 2>&2; return 1;;
esac
shift
done
echo -n "$_MESSAGE" | openssl dgst -sha256 -mac HMAC -macopt hexkey:"$_KEY" -binary && return 0
return 1
}
lmiab_iam_key_to_ses_credentials()
{
while [ $# -gt 0 ]; do
case $1 in
--secret-key) local _SECRET_KEY="$2"; shift ;;
--region) local _REGION="$2"; shift ;;
*) echo "Unrecognised option passed: $1" 2>&2; return 1;;
esac
shift
done
# Magic variables for calculating signature
# See https://docs.aws.amazon.com/ses/latest/dg/smtp-credentials.html
local _DATE="11111111"
local _SERVICE="ses"
local _MESSAGE="SendRawEmail"
local _TERMINAL="aws4_request"
local _VERSION="\x04"
local _SIGNATURE="$( lmiab_sign_hmac_sha256 --key "$( echo -n "AWS4${_SECRET_KEY}" | base64 )" --message "$_DATE" | base64 )"
_SIGNATURE="$( lmiab_sign_hmac_sha256 --key "$_SIGNATURE" --message "$_REGION" | base64 )"
_SIGNATURE="$( lmiab_sign_hmac_sha256 --key "$_SIGNATURE" --message "$_SERVICE" | base64 )"
_SIGNATURE="$( lmiab_sign_hmac_sha256 --key "$_SIGNATURE" --message "$_TERMINAL" | base64 )"
_SIGNATURE="$( lmiab_sign_hmac_sha256 --key "$_SIGNATURE" --message "$_MESSAGE" )"
local _SIGNATURE_AND_VERSION=$( printf $_VERSION )
_SIGNATURE_AND_VERSION="${_SIGNATURE_AND_VERSION}${_SIGNATURE}"
echo -n "$_SIGNATURE_AND_VERSION" | base64
return 0
}
lmiab_get_bundle_ids()
{
cat <<EOF
{
"5_usd": "micro_2_0",
"10_usd": "small_2_0",
"20_usd": "medium_2_0",
"40_usd": "large_2_0",
"80_usd": "xlarge_2_0",
"160_usd": "2xlarge_2_0"
}
EOF
}
lmiab_is_package_valid()
{
local _PACKAGE=$1
(lmiab_get_bundle_ids | jq -r -e ".[\"$_PACKAGE\"]" 2>/dev/null) || return 1
return 0
}
lmiab_get_lightsail_regions()
{
local _CACHEDATE="$( date +%Y%m%d )"
local _CACHEFILE="$LMIAB_CACHE_DIR/lightsail-regions-$_CACHEDATE"
local _REGIONS=""
[ -f "$_CACHEFILE" ] && _REGIONS="$( cat $_CACHEFILE )"
( [ ! -f "$_CACHEFILE" ] || [ -z "$_REGIONS" ] ) && {
_REGIONS="$( aws lightsail get-regions | jq -r '.regions[] | (.name + "\t" + .displayName)' )"
echo "$_REGIONS" > $_CACHEFILE
}
echo "$_REGIONS"
return 0
}
lmiab_is_region_valid()
{
local _REGION_NAME=$1
local _REGIONS="$( lmiab_get_lightsail_regions 2>/dev/null )"
local _VALID="false"
for region in $( echo "$_REGIONS" | awk '{print $1}' )
do
region="$( echo $region | tr -d '[:space:]' )"
[ "$region" = "$_REGION_NAME" ] && {
_VALID="true"
break
}
done
[ "$_VALID" = "false" ] && return 1
return 0
}
lmiab_get_region_az()
{
local _REGION_NAME=$1
local _CACHEDATE="$( date +%Y%m%d )"
local _CACHEFILE="$LMIAB_CACHE_DIR/lightsail-$_REGION_NAME-azs-$_CACHEDATE"
local _AZ=""
[ -f "$_CACHEFILE" ] && _AZ="$( cat $_CACHEFILE )"
[ ! -f "$_CACHEFILE" ] && {
local _AZ="$( aws ec2 describe-availability-zones --region $_REGION_NAME | \
jq -r '.AvailabilityZones[].ZoneName' )"
echo "$_AZ" > $_CACHEFILE
}
echo "$_AZ"
}
lmiab_get_region_display_name()
{
local _REGION_ID=$1
local _REGIONS="$( lmiab_get_lightsail_regions 2>/dev/null )"
echo "$_REGIONS" | grep "$_REGION_ID" | awk '{print $2}'
}
lmiab_is_az_valid()
{
local _REGION=$1
local _AZ="$2"
local _AZ_LIST="$( lmiab_get_region_az $_REGION )"
local _NUMBER_OF_AZ=$( echo "$_AZ" | wc -w | tr -d ' ' )
local _VALID=0
for our_az in $( echo "$_AZ" )
do
our_az="$( echo $our_az | tr -d '[:space:]' )"
for their_az in $( echo "$_AZ_LIST" )
do
their_az="$( echo $their_az | tr -d '[:space:]' )"
[ "$our_az" = "$their_az" ] && _VALID=$(( $_VALID + 1 ))
done
done
[ "$_VALID" = "$_NUMBER_OF_AZ" ] && return 0
return 1
}
lmiab_is_region_and_az_valid()
{
lmiab_is_region_valid $LMIAB_REGION || {
echo "[ERROR]: Region is not valid." >&2
return 1
}
lmiab_is_az_valid $LMIAB_REGION "$LMIAB_AZ" || {
echo "[ERROR]: Value of availability zone is not valid." >&2
return 1
}
return 0
}
lmiab_char_repeat()
{
# $1 -> char
# $2 -> number of repeat
for i in $( seq 1 $2 )
do
printf "%s" "$1"
done
}
lmiab_cf_template_header()
{
echo "AWSTemplateFormatVersion: '2010-09-09'"
return 0
}
lmiab_cf_template_node()
{
while [ $# -gt 0 ]; do
case $1 in
--az-id) local _AZ_ID="$2"; shift ;;
--bundle-id) local _BUNDLE_ID="$2"; shift ;;
--cf-stackname) local _CF_STACKNAME="$2"; shift ;;
--installation-id) local _INSTALLATION_ID="$2"; shift ;;
--instance-name) local _INSTANCE_NAME="$2"; shift ;;
--keypair-name) local _KEYPAIR_NAME="$2"; shift ;;
--resource-name) local _RESOURCE_NAME="$2"; shift ;;
--ssh-allow-cidr) local _SSH_ALLOW_CIDR="$2"; shift ;;
--node-type) local _NODE_TYPE="$2"; shift ;;
--os-id) local _OS_ID="$2"; shift ;;
*) echo "Unrecognised option passed: $1" 2>&2; return 1;;
esac
shift
done
[ -z "$_KEYPAIR_NAME" ] && _KEYPAIR_NAME=$LMIAB_SSH_LIGHTSAIL_KEYPAIR_NAME
local _NETWORKING_RULES="$(cat <<EOF
Ports:
- Protocol: tcp
FromPort: 22
ToPort: 22
Cidrs:
- $_SSH_ALLOW_CIDR
# HTTP
- FromPort: 80
ToPort: 80
Protocol: tcp
Cidrs:
- 0.0.0.0/0
# HTTPS
- FromPort: 443
ToPort: 443
Protocol: tcp
Cidrs:
- 0.0.0.0/0
# SMTP (STARTTLS)
- FromPort: 25
ToPort: 25
Protocol: tcp
Cidrs:
- 0.0.0.0/0
# SMTPS
- FromPort: 465
ToPort: 465
Protocol: tcp
Cidrs:
- 0.0.0.0/0
# SMTP Submission
- FromPort: 587
ToPort: 587
Protocol: tcp
Cidrs:
- 0.0.0.0/0
# IMAP (STARTTLS)
- FromPort: 143
ToPort: 143
Protocol: tcp
Cidrs:
- 0.0.0.0/0
# IMAPS
- FromPort: 993
ToPort: 993
Protocol: tcp
Cidrs:
- 0.0.0.0/0
# DNS over TCP
- FromPort: 53
ToPort: 53
Protocol: tcp
Cidrs:
- 0.0.0.0/0
# DNS over UDP
- FromPort: 53
ToPort: 53
Protocol: udp
Cidrs:
- 0.0.0.0/0
# Sieve mail filtering
- FromPort: 4190
ToPort: 4190
Protocol: tcp
Cidrs:
- 0.0.0.0/0
EOF
)"
cat <<EOF
Parameters:
IsRestoreParam:
Type: String
Default: 'no'
AllowedValues:
- 'yes'
- 'no'
Conditions:
IsNotRestoreCondition: !Equals
- !Ref IsRestoreParam
- 'no'
Resources:
$_RESOURCE_NAME:
Type: AWS::Lightsail::Instance
Properties:
AvailabilityZone: $_AZ_ID
BlueprintId: $_OS_ID
BundleId: $_BUNDLE_ID
KeyPairName: $_KEYPAIR_NAME
InstanceName: $_INSTANCE_NAME
Networking:
$_NETWORKING_RULES
Tags:
- Key: cf-$_CF_STACKNAME
- Key: lightsail-miab-installer
- Key: installation-id-$_INSTALLATION_ID
- Key: installer
Value: lightsail-miab-installer
- Key: cfstackname
Value: $_CF_STACKNAME
${_RESOURCE_NAME}SesUser:
Type: AWS::IAM::User
Properties:
UserName: $_CF_STACKNAME-user
Policies:
- PolicyName: $_CF_STACKNAME-policy
PolicyDocument:
Version: 2012-10-17
Statement:
- Sid: AllowSendEmailSes
Effect: Allow
Action:
- 'ses:SendRawEmail'
Resource: '*'
- Sid: AllowListAllBuckets
Effect: Allow
Action:
- 's3:ListAllMyBuckets'
Resource: '*'
- Sid: AllowFullAccessToBackupBuckets
Effect: Allow
Action:
- 's3:*'
Resource:
- 'arn:aws:s3:::$LMIAB_MAIL_BACKUP_BUCKET'
- 'arn:aws:s3:::$LMIAB_MAIL_BACKUP_BUCKET/*'
- 'arn:aws:s3:::$LMIAB_NEXTCLOUD_BACKUP_BUCKET'
- 'arn:aws:s3:::$LMIAB_NEXTCLOUD_BACKUP_BUCKET/*'
Tags:
- Key: installer
Value: lightsail-miab-installer
- Key: cfstackname
Value: $_CF_STACKNAME
${_RESOURCE_NAME}MailBackup:
Type: AWS::S3::Bucket
DeletionPolicy: Retain
Condition: IsNotRestoreCondition
Properties:
BucketName: $LMIAB_MAIL_BACKUP_BUCKET
LifecycleConfiguration:
Rules:
- Id: IntelligentTieringRule
Status: Enabled
Transitions:
- StorageClass: INTELLIGENT_TIERING
TransitionInDays: 0
${_RESOURCE_NAME}NextCloudBackup:
Type: AWS::S3::Bucket
DeletionPolicy: Retain
Condition: IsNotRestoreCondition
Properties:
BucketName: $LMIAB_NEXTCLOUD_BACKUP_BUCKET
LifecycleConfiguration:
Rules:
- Id: IntelligentTieringRule
Status: Enabled
Transitions:
- StorageClass: INTELLIGENT_TIERING
TransitionInDays: 0
${_RESOURCE_NAME}AccessKey:
Type: AWS::IAM::AccessKey
Properties:
UserName: !Ref ${_RESOURCE_NAME}SesUser
Status: Active
${_RESOURCE_NAME}SesIdentity:
Type: AWS::SES::EmailIdentity
DeletionPolicy: Retain
Properties:
EmailIdentity: $LMIAB_EMAIL_DOMAIN
DkimAttributes:
SigningEnabled: true
${_RESOURCE_NAME}AdminPasswordSsm:
Type: AWS::SSM::Parameter
Properties:
Name: /MailInABox/$_CF_STACKNAME/AdminPassword
Type: String
Value: UpdatedByInstaller
${_RESOURCE_NAME}SesUserSsm:
Type: AWS::SSM::Parameter
Properties:
Name: /MailInABox/$_CF_STACKNAME/Ses/SmtpUser
Type: String
Value: !Ref ${_RESOURCE_NAME}AccessKey
${_RESOURCE_NAME}SesSecretKeySsm:
Type: AWS::SSM::Parameter
Properties:
Name: /MailInABox/$_CF_STACKNAME/Ses/SecretKey
Type: String
Value: !GetAtt ${_RESOURCE_NAME}AccessKey.SecretAccessKey
${_RESOURCE_NAME}SesPasswordSsm:
Type: AWS::SSM::Parameter
Properties:
Name: /MailInABox/$_CF_STACKNAME/Ses/SmtpPassword
Type: String
Value: UpdatedByInstaller
${_RESOURCE_NAME}BackupSecretKeySsm:
Type: AWS::SSM::Parameter
DeletionPolicy: Retain
Properties:
Name: /MailInABox/$_CF_STACKNAME/BackupSecretKey
Type: String
Value: UpdatedByInstaller
${_RESOURCE_NAME}StaticIP:
Type: AWS::Lightsail::StaticIp
DeletionPolicy: Retain
Properties:
AttachedTo: !Ref $_RESOURCE_NAME
StaticIpName: ${_INSTANCE_NAME}-Ip
Outputs:
LightsailInstance:
Value: !Ref $_RESOURCE_NAME
LightsailInstanceUrl:
Value: !Sub
- 'https://lightsail.aws.amazon.com/ls/webapp/\${AWS::Region}/instances/\${INSTANCE_NAME}/connect'
- REGION: !Ref AWS::Region
INSTANCE_NAME: !Ref $_RESOURCE_NAME
LightsailIP:
Value: !Ref ${_RESOURCE_NAME}StaticIP
LightsailIPUrl:
Value: !Sub
- 'https://lightsail.aws.amazon.com/ls/webapp/\${REGION}/static-ips/\${IP_NAME}/connect'
- REGION: !Ref AWS::Region
IP_NAME: !Ref ${_RESOURCE_NAME}StaticIP
S3MailBackupBucket:
Condition: IsNotRestoreCondition
Value: !Ref ${_RESOURCE_NAME}MailBackup
S3MailBackupBucketUrl:
Condition: IsNotRestoreCondition
Value: !Sub
- 'https://s3.console.aws.amazon.com/s3/buckets/\${BUCKET_NAME}?region=\${REGION}&tab=objects'
- BUCKET_NAME: !Ref ${_RESOURCE_NAME}MailBackup
REGION: !Ref AWS::Region
S3NextCloudBackupBucket:
Condition: IsNotRestoreCondition
Value: !Ref ${_RESOURCE_NAME}NextCloudBackup
S3NextCloudBackupBucketUrl:
Condition: IsNotRestoreCondition
Value: !Sub
- 'https://s3.console.aws.amazon.com/s3/buckets/\${BUCKET_NAME}?region=\${REGION}&tab=objects'
- BUCKET_NAME: !Ref ${_RESOURCE_NAME}NextCloudBackup
REGION: !Ref AWS::Region
SesIdentity:
Value: !Ref ${_RESOURCE_NAME}SesIdentity
SesIdentityUrl:
Value: !Sub
- 'https://console.aws.amazon.com/ses/home?region=\${REGION}#/verified-identities/\${DOMAIN}'
- REGION: !Ref AWS::Region
DOMAIN: '$LMIAB_EMAIL_DOMAIN'
AdminPasswordSsm:
Value: !Ref ${_RESOURCE_NAME}AdminPasswordSsm
AdminPasswordSsmUrl:
Value: !Sub
- 'https://console.aws.amazon.com/systems-manager/parameters\${PARAM_NAME}/description?region=\${REGION}'
- PARAM_NAME: !Ref ${_RESOURCE_NAME}AdminPasswordSsm
REGION: !Ref AWS::Region
SesUserSsm:
Value: !Ref ${_RESOURCE_NAME}SesUserSsm
SesUserSsmUrl:
Value: !Sub
- 'https://console.aws.amazon.com/systems-manager/parameters\${PARAM_NAME}/description?region=\${REGION}'
- PARAM_NAME: !Ref ${_RESOURCE_NAME}SesUserSsm
REGION: !Ref AWS::Region
SesSecretKeySsm:
Value: !Ref ${_RESOURCE_NAME}SesSecretKeySsm
SesSecretKeySsmUrl:
Value: !Sub
- 'https://console.aws.amazon.com/systems-manager/parameters\${PARAM_NAME}/description?region=\${REGION}'
- PARAM_NAME: !Ref ${_RESOURCE_NAME}SesSecretKeySsm
REGION: !Ref AWS::Region
SesPasswordSsm:
Value: !Ref ${_RESOURCE_NAME}SesPasswordSsm
SesPasswordSsmUrl:
Value: !Sub
- 'https://console.aws.amazon.com/systems-manager/parameters\${PARAM_NAME}/description?region=\${REGION}'
- PARAM_NAME: !Ref ${_RESOURCE_NAME}SesPasswordSsm
REGION: !Ref AWS::Region
BackupSecretKeySsm:
Value: !Ref ${_RESOURCE_NAME}BackupSecretKeySsm
BackupSecretKeySsmUrl:
Value: !Sub
- 'https://console.aws.amazon.com/systems-manager/parameters\${PARAM_NAME}/description?region=\${REGION}'
- PARAM_NAME: !Ref ${_RESOURCE_NAME}BackupSecretKeySsm
REGION: !Ref AWS::Region
EOF
return 0
}
lmiab_gen_cloudformation_template()
{
lmiab_cf_template_header && \
lmiab_cf_template_node --az-id "$LMIAB_AZ" \
--bundle-id "$LMIAB_BUNDLE_ID" \
--cf-stackname "$LMIAB_CLOUDFORMATION_STACKNAME" \
--installation-id "$LMIAB_INSTALLATION_ID" \
--instance-name "$( lmiab_gen_node_name )" \
--keypair-name "$LMIAB_SSH_LIGHTSAIL_KEYPAIR_NAME" \
--resource-name "MailInABoxNode${LMIAB_RANDOM_ID}" \
--ssh-allow-cidr "$LMIAB_FIREWALL_SSH_ALLOW_CIDR" \
--os-id "$LMIAB_NODE_OS_ID"
return 0
}
lmiab_gen_node_name()
{
echo "$LMIAB_NODE_PREFIX-$LMIAB_INSTALLATION_ID-$LMIAB_RANDOM_ID"
return 0
}
lmiab_run_cloudformation()
{
lmiab_is_region_and_az_valid || return 1
[ "$LMIAB_DRY_RUN" = "yes" ] && {
lmiab_gen_cloudformation_template
return 1
}
local _ANSWER="no"
local _TITLE="lightsail-miab-installer v${LMIAB_VERSION}"
local _ANY_KEY=""
echo
lmiab_char_repeat "-" $( echo $_TITLE | wc -c ) && echo
echo $_TITLE
lmiab_char_repeat "-" $( echo $_TITLE | wc -c ) && echo
cat <<EOF
This process will install Mail-in-a-Box on an Amazon Lightsail instance.
CloudFormation stack: $LMIAB_CLOUDFORMATION_STACKNAME
Region: $LMIAB_REGION_DISPLAY_NAME
Availability Zone: $LMIAB_AZ
Node plan: $LMIAB_PLAN
Lightsail SSH key pair: $LMIAB_SSH_LIGHTSAIL_KEYPAIR_NAME
SSH private key file: $LMIAB_SSH_PRIVATE_KEY_FILE
Amazon SES domain identity: $LMIAB_EMAIL_DOMAIN
Mail-in-a-Box hostname: $LMIAB_BOX_HOSTNAME
Mail-in-a-Box Admin email: $LMIAB_ADMIN_EMAIL
EOF
[ "$LMIAB_IS_RESTORE" = "yes" ] && {
cat <<EOF
Data will be restored from following S3 buckets:
Mail data: s3://$LMIAB_MAIL_BACKUP_BUCKET
Nextcloud data: s3://$LMIAB_NEXTCLOUD_BACKUP_BUCKET
EOF
}
[ ! -z "$LMIAB_ADMIN_PASSWORD" ] && {
cat <<EOF
Mail-in-a-Box password: $( echo "$LMIAB_ADMIN_PASSWORD" | sed 's/./*/g' )
EOF
}
echo
printf "Press any key to continue or CTRL-C to abort: "
read _ANY_KEY
[ -z "$LMIAB_ADMIN_PASSWORD" ] && {
printf "Enter Mail-in-a-Box Admin password: "
read -s LMIAB_ADMIN_PASSWORD
}
echo "This may take several minutes, please wait..."
echo "To view detailed log, run following command on another terminal:"
echo " tail -f $LMIAB_LOG_FILE"
echo
lmiab_log "Checking SSH key pair '$LMIAB_SSH_LIGHTSAIL_KEYPAIR_NAME' in region '$LMIAB_REGION'"
lmiab_is_ssh_keypair_valid || return 1
lmiab_log "Checking existing stack '${LMIAB_CLOUDFORMATION_STACKNAME}'"
# Do not create when the stack already exists
aws cloudformation describe-stacks --stack-name=$LMIAB_CLOUDFORMATION_STACKNAME >>$LMIAB_LOG_FILE 2>&1 && {
lmiab_err "Stack already exists. Aborted!"
return 1
}
# Validating template
local _TEMPLATE_OUT_FILE="$LMIAB_OUTPUT_DIR/cf-${LMIAB_CLOUDFORMATION_STACKNAME}.yaml"
lmiab_log "Validating template of stack '${LMIAB_CLOUDFORMATION_STACKNAME}'"
lmiab_gen_cloudformation_template > $_TEMPLATE_OUT_FILE && \
aws cloudformation validate-template \
--template-body file://$_TEMPLATE_OUT_FILE >> $LMIAB_LOG_FILE 2>&1 || {
lmiab_err "CloudFormation generated template is not valid. Aborted!"
return 1
}
lmiab_log "Creating stack '${LMIAB_CLOUDFORMATION_STACKNAME}'"
aws cloudformation create-stack \
--capabilities "CAPABILITY_NAMED_IAM" \
--stack-name "$LMIAB_CLOUDFORMATION_STACKNAME" \
--parameters ParameterKey=IsRestoreParam,ParameterValue=$LMIAB_IS_RESTORE \
--template-body file://$_TEMPLATE_OUT_FILE >> $LMIAB_LOG_FILE 2>&1
local STACK_STATUS=""
local _WAIT_COUNTER=1
while [ "$STACK_STATUS" != "CREATE_COMPLETE" ]
do
lmiab_log_waiting "Waiting stack '$LMIAB_CLOUDFORMATION_STACKNAME' to be ready$( lmiab_char_repeat '.' $_WAIT_COUNTER )"
STACK_STATUS="$( aws cloudformation describe-stacks \
--stack-name "$LMIAB_CLOUDFORMATION_STACKNAME" 2>>$LMIAB_LOG_FILE | \
jq -r '.Stacks[0].StackStatus' )"
[ $_WAIT_COUNTER -ge 3 ] && _WAIT_COUNTER=0
_WAIT_COUNTER=$(( $_WAIT_COUNTER + 1 ))
sleep 2
done
echo
lmiab_log "Stack '$LMIAB_CLOUDFORMATION_STACKNAME' is ready"
return 0
}
lmiab_wait_for_node_to_be_ready()
{
local _NODE_IP="$1"
local _NODE_STATUS=""
local _WAIT_COUNTER=1
while [ "$_NODE_STATUS" != "ubuntu" ]
do
_NODE_STATUS="$( lmiab_ssh_to_node $_NODE_IP whoami 2>>$LMIAB_LOG_FILE | tr -d '[:space:]' )"
lmiab_log_waiting "Waiting SSH connection to '$_NODE_IP' to be ready$( lmiab_char_repeat '.' $_WAIT_COUNTER )"
[ $_WAIT_COUNTER -ge 3 ] && _WAIT_COUNTER=0
_WAIT_COUNTER=$(( $_WAIT_COUNTER + 1 ))
sleep 1
done
echo
lmiab_log "SSH to node $_NODE_IP is ready."
return 0
}
lmiab_init_script_commands()
{
local _CMD="$( cat <<INIT_SCRIPT
#!/bin/bash
export LMIAB_PACKAGE_URL="$LMIAB_PACKAGE_URL"
export NONINTERACTIVE=true
export SKIP_NETWORK_CHECKS=true
export STORAGE_ROOT=/home/user-data
export STORAGE_USER=user-data
export PRIVATE_IP="\$( ec2metadata --local-ipv4 )"
export PUBLIC_IP="\$( ec2metadata --public-ipv4 )"
export PRIVATE_IPV6=""
export PUBLIC_IPV6=""
export PRIMARY_HOSTNAME="$LMIAB_BOX_HOSTNAME"
export MTA_STS_MODE=enforce
export EMAIL_ADDR="$LMIAB_ADMIN_EMAIL"
export EMAIL_PW="$LMIAB_ADMIN_PASSWORD"
echo "[LMIAB Init Script]: Creating user and storage directory"
useradd -m \$STORAGE_USER
mkdir -p \$STORAGE_ROOT
rm /tmp/mail-in-a-box.tar.gz 2>/dev/null
mkdir -p /opt/mailinabox
echo "[LMIAB Init Script]: Downloading Mail-in-a-Box from $LMIAB_PACKAGE_URL"
curl -s -L "$LMIAB_PACKAGE_URL" -o /tmp/mail-in-a-box.tar.gz && \
tar xf /tmp/mail-in-a-box.tar.gz --strip-components=1 -C /opt/mailinabox
# Write hostname and it's associate public IP address to /etc/hosts. So
# it can be resolved without having to rely on DNS server. Some tools such as
# 'sudo' trying to resolv the hostname and could cause timeout.
echo "[LMIAB Init Script]: Adding hostname '\$PRIMARY_HOSTNAME' to /etc/hosts"
grep "\$PRIMARY_HOSTNAME" /etc/hosts >/dev/null 2>/dev/null || {
echo "127.0.0.1 \$PRIMARY_HOSTNAME" >> /etc/hosts
}
echo "[LMIAB Init Script]: Running setup/start.sh"
cd /opt/mailinabox/ && setup/start.sh
echo "[LMIAB Init Script]: Disabling ufw and fail2ban..."
fail2ban-client stop
ufw disable
INIT_SCRIPT
)"
echo "$_CMD" | sed 's/EMAIL_PW=.*/EMAIL_PW=******/g' >> $LMIAB_LOG_FILE 2>&1
echo "$_CMD"
}
lmiab_ssh_to_node()
{
local _NODE_IP=$1
# Remove the $1
shift
ssh -i $LMIAB_SSH_PRIVATE_KEY_FILE -o ConnectTimeout=3 \
-o StrictHostKeyChecking=no -o LogLevel=error \
$LMIAB_OS_USERNAME@$_NODE_IP $@
}
lmiab_run_post_installation_commands()
{
lmiab_log "Uploading dummy object to bucket ${LMIAB_MAIL_BACKUP_BUCKET}"
lmiab_put_dummy_object_to_bucket "$LMIAB_MAIL_BACKUP_BUCKET" >> $LMIAB_LOG_FILE
lmiab_log "Writing admin password to SSM Parameter Store"
lmiab_put_admin_password_to_ssm "$LMIAB_ADMIN_PASSWORD" >> $LMIAB_LOG_FILE
local _USERNAME="${LMIAB_CLOUDFORMATION_STACKNAME}-user"
# Get current value of SMTP AccessKeyId and SecretAccessKey
local _ACCESS_KEY="$( aws ssm get-parameter \
--name "/MailInABox/$LMIAB_CLOUDFORMATION_STACKNAME/Ses/SmtpUser" \
--query Parameter.Value --output text
)"
local _SECRET_KEY="$( aws ssm get-parameter \
--name "/MailInABox/$LMIAB_CLOUDFORMATION_STACKNAME/Ses/SecretKey" \
--query Parameter.Value --output text
)"
lmiab_log "Creating Amazon SES SMTP password"
local _SMTP_PASSWORD="$( lmiab_iam_key_to_ses_credentials --secret-key "$_SECRET_KEY" --region "$LMIAB_REGION" )"
[ -z "$LMIAB_SMTP_RELAY_USER" ] && LMIAB_SMTP_RELAY_USER="$_ACCESS_KEY"
[ -z "$LMIAB_SMTP_RELAY_PASSWORD" ] && LMIAB_SMTP_RELAY_PASSWORD="$_SMTP_PASSWORD"
lmiab_log "Writing SES SMTP user and password to SSM Parameter Store"
lmiab_put_smtp_user_to_ssm "$_ACCESS_KEY" >> $LMIAB_LOG_FILE
lmiab_put_smtp_password_to_ssm "$_SMTP_PASSWORD" >> $LMIAB_LOG_FILE
lmiab_put_smtp_secretkey_to_ssm "$_SECRET_KEY" >> $LMIAB_LOG_FILE
local _NODE_NAME="$( lmiab_gen_node_name )"
local _NODE_IP="$( lmiab_get_node_public_ip $_NODE_NAME )"
lmiab_wait_for_node_to_be_ready "$_NODE_IP"
lmiab_log "Installing Mail-in-a-Box"
# Init script to install Mail-in-a-Box
cat <<EOF | lmiab_ssh_to_node $_NODE_IP sudo bash | tee -a $LMIAB_LOG_FILE
$( lmiab_init_script_commands )
EOF
[ "$LMIAB_DISABLE_SMTP_RELAY" = "no" ] && {
lmiab_log "Creating CNAME records for Amazon SES identity verification"
lmiab_create_dns_records_for_ses_dkim \
--identity "$LMIAB_EMAIL_DOMAIN" \
--api-server "$_NODE_IP" \
--api-user "$LMIAB_ADMIN_EMAIL" \
--api-password "$LMIAB_ADMIN_PASSWORD" | tee -a $LMIAB_LOG_FILE
lmiab_configure_smtp_relay \
--relay-endpoint "$LMIAB_SMTP_RELAY_ENDPOINT" \
--relay-port "$LMIAB_SMTP_RELAY_PORT" \
--relay-user "$LMIAB_SMTP_RELAY_USER" \
--relay-password "$LMIAB_SMTP_RELAY_PASSWORD" | tee -a $LMIAB_LOG_FILE
}
# Check the existence of backup secret key
( lmiab_ssh_to_node $_NODE_IP ls /home/user-data/backup/secret_key.txt >/dev/null 2>/dev/null ) && {
lmiab_log "Updating SSM Parameter Store of backup_secret.txt value"
local _BACKUP_SECRET_KEY="$( lmiab_ssh_to_node $_NODE_IP sudo cat '/home/user-data/backup/secret_key.txt' )"
lmiab_put_backup_secret_key_to_ssm "$_BACKUP_SECRET_KEY" >> $LMIAB_LOG_FILE
}
[ "$LMIAB_DISABLE_S3_BACKUP" = "no" ] && {
lmiab_log "Updating config for S3 backup (Mail and Nextcloud)"
lmiab_create_custom_s3_backup_config \
--aws-accesskey "$_ACCESS_KEY" \
--aws-secretkey "$_SECRET_KEY" \
--mail-bucket "$LMIAB_MAIL_BACKUP_BUCKET" \
--nextcloud-bucket "$LMIAB_NEXTCLOUD_BACKUP_BUCKET" \
--node-ip "$_NODE_IP" \
--region "$LMIAB_REGION" | tee -a $LMIAB_LOG_FILE
}
lmiab_log "Disabling postgrey configuration"
lmiab_disable_postgrey $_NODE_IP | tee -a $LMIAB_LOG_FILE
[ "$LMIAB_IS_RESTORE" = "yes" ] && {
lmiab_log "Restoring data from previous installation..."
lmiab_restore_from_backup \
--aws-accesskey "$_ACCESS_KEY" \
--aws-secretkey "$_SECRET_KEY" \
--backup-key "$LMIAB_BACKUP_SECRET_KEY" \
--hostname "$LMIAB_BOX_HOSTNAME" \
--mail-bucket "$LMIAB_MAIL_BACKUP_BUCKET" \
--node-ip "$_NODE_IP" \
--region "$LMIAB_REGION"
lmiab_log "Overwriting secret_key.txt..."
cat <<SECRET_TXT | lmiab_ssh_to_node $_NODE_IP sudo bash
cp /home/user-data/backup/secret_key.txt /home/user-data/backup/secret_key.txt.orig
echo "$LMIAB_BACKUP_SECRET_KEY" > /home/user-data/backup/secret_key.txt
SECRET_TXT
lmiab_log "Reconfiguring S3 backup because it should be overridden by previous restore process..."
lmiab_create_custom_s3_backup_config \
--aws-accesskey "$_ACCESS_KEY" \
--aws-secretkey "$_SECRET_KEY" \
--mail-bucket "$LMIAB_MAIL_BACKUP_BUCKET" \
--nextcloud-bucket "$LMIAB_NEXTCLOUD_BACKUP_BUCKET" \
--node-ip "$_NODE_IP" \