-
Notifications
You must be signed in to change notification settings - Fork 687
/
__init__.py
executable file
·1219 lines (1060 loc) · 45 KB
/
__init__.py
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
#
# Copyright (C) 2013-2018 Freedom of the Press Foundation & al
# Copyright (C) 2018 Loic Dachary <[email protected]>
#
# 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 3 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, see <http://www.gnu.org/licenses/>.
#
"""
SecureDrop Admin Toolkit.
For use by administrators to install, maintain, and manage their SD
instances.
"""
import argparse
import base64
import functools
import ipaddress
import json
import logging
import os
import re
import subprocess
import sys
from typing import Any, Callable, Dict, List, Optional, Set, Tuple, Type, TypeVar, Union, cast
import prompt_toolkit
import yaml
from cryptography.hazmat.primitives import serialization
from cryptography.hazmat.primitives.asymmetric import x25519
from pkg_resources import parse_version
from prompt_toolkit.document import Document
from prompt_toolkit.validation import ValidationError, Validator
sdlog = logging.getLogger(__name__)
# In the event of a key rotation, this list can be added to
# in order to support a transition period.
RELEASE_KEYS = [
"2359E6538C0613E652955E6C188EDD3B7B22E6A3",
]
DEFAULT_KEYSERVER = "hkps://keys.openpgp.org"
SUPPORT_ONION_URL = "http://sup6h5iyiyenvjkfxbgrjynm5wsgijjoatvnvdgyyi7je3xqm4kh6uqd.onion"
SUPPORT_URL = "https://support.freedom.press"
EXIT_SUCCESS = 0
EXIT_SUBPROCESS_ERROR = 1
EXIT_INTERRUPT = 2
MAX_NAMESERVERS = 3
LIST_SPLIT_RE = re.compile(r"\s*,\s*|\s+")
I18N_CONF = "securedrop/i18n.json"
I18N_DEFAULT_LOCALES = {"en_US"}
class FingerprintException(Exception):
pass
class JournalistAlertEmailException(Exception):
pass
# The type of each entry within SiteConfig.desc
_T = TypeVar("_T", bound=Union[int, str, bool])
# The function type used for the @update_check_required decorator; see
# https://mypy.readthedocs.io/en/stable/generics.html#declaring-decorators
_FuncT = TypeVar("_FuncT", bound=Callable[..., Any])
# Configuration description tuples drive the CLI user experience and the
# validation logic of the securedrop-admin tool. A tuple is in the following
# format.
#
# (var, default, type, prompt, validator, transform, condition):
#
# var configuration variable name (will be stored in `site-specific`)
# default default value (can be a callable)
# type configuration variable type
# prompt text prompt presented to the user
# validator input validator based on `prompt_toolkit`'s Validator class
# transform transformation function to run on input
# condition condition under which this prompt is shown, receives the
# in-progress configuration object as input. Used for "if this
# then that" branching of prompts.
#
# The mypy type description of the format follows.
_DescEntryType = Tuple[str, _T, Type[_T], str, Optional[Validator], Optional[Callable], Callable]
class SiteConfig:
class ValidateNotEmpty(Validator):
def validate(self, document: Document) -> bool:
if document.text != "":
return True
raise ValidationError(message="Must not be an empty string")
class ValidateTime(Validator):
def validate(self, document: Document) -> bool:
if document.text.isdigit() and int(document.text) in range(0, 24):
return True
raise ValidationError(message="Must be an integer between 0 and 23")
class ValidateUser(Validator):
def validate(self, document: Document) -> bool:
text = document.text
if text != "" and text != "root" and text != "amnesia":
return True
raise ValidationError(message="Must not be root, amnesia or an empty string")
class ValidateIP(Validator):
def validate(self, document: Document) -> bool:
try:
ipaddress.ip_address(document.text)
return True
except ValueError as e:
raise ValidationError(message=str(e))
class ValidateNameservers(Validator):
def validate(self, document: Document) -> bool:
candidates = LIST_SPLIT_RE.split(document.text)
if len(candidates) > MAX_NAMESERVERS:
raise ValidationError(message="Specify no more than three nameservers.")
try:
all(map(ipaddress.ip_address, candidates))
except ValueError:
raise ValidationError(
message=(
"DNS server(s) should be a space/comma-separated list "
"of up to {} IP addresses"
).format(MAX_NAMESERVERS)
)
return True
@staticmethod
def split_list(text: str) -> List[str]:
"""
Splits a string containing a list of values separated by commas or whitespace.
"""
return LIST_SPLIT_RE.split(text)
class ValidatePath(Validator):
def __init__(self, basedir: str) -> None:
self.basedir = basedir
super().__init__()
def validate(self, document: Document) -> bool:
if document.text == "":
raise ValidationError(message="an existing file name is required")
path = os.path.join(self.basedir, document.text)
if os.path.exists(path):
return True
raise ValidationError(message=path + " file does not exist")
class ValidateOptionalPath(ValidatePath):
def validate(self, document: Document) -> bool:
if document.text == "":
return True
return super().validate(document)
class ValidateYesNo(Validator):
def validate(self, document: Document) -> bool:
text = document.text.lower()
if text == "yes" or text == "no":
return True
raise ValidationError(message="Must be either yes or no")
class ValidateFingerprint(Validator):
def validate(self, document: Document) -> bool:
text = document.text.replace(" ", "")
if text == "65A1B5FF195B56353CC63DFFCC40EF1228271441":
raise ValidationError(message="This is the TEST journalist fingerprint")
if text == "600BC6D5142C68F35DDBCEA87B597104EDDDC102":
raise ValidationError(message="This is the TEST admin fingerprint")
if not re.match("[a-fA-F0-9]{40}$", text):
raise ValidationError(message="fingerprints must be 40 hexadecimal characters")
return True
class ValidateOptionalFingerprint(ValidateFingerprint):
def validate(self, document: Document) -> bool:
if document.text == "":
return True
return super().validate(document)
class ValidateInt(Validator):
def validate(self, document: Document) -> bool:
if re.match(r"\d+$", document.text):
return True
raise ValidationError(message="Must be an integer")
class Locales:
def __init__(self, appdir: str) -> None:
self.translation_dir = os.path.realpath(os.path.join(appdir, "translations"))
def get_translations(self) -> Set[str]:
translations = I18N_DEFAULT_LOCALES
for dirname in os.listdir(self.translation_dir):
if dirname != "messages.pot":
translations.add(dirname)
return translations
class ValidateLocales(Validator):
def __init__(self, basedir: str, supported: Set[str]) -> None:
present = SiteConfig.Locales(basedir).get_translations()
self.available = present & supported
super().__init__()
def validate(self, document: Document) -> bool:
desired = document.text.split()
missing = set(desired) - self.available
if not missing:
return True
raise ValidationError(
message="The following locales are not available " + " ".join(missing)
)
class ValidateOSSECUsername(Validator):
def validate(self, document: Document) -> bool:
text = document.text
if text and "@" not in text and text != "test":
return True
raise ValidationError(message="The SASL username should not include the domain name")
class ValidateOSSECPassword(Validator):
def validate(self, document: Document) -> bool:
text = document.text
if len(text) >= 8 and text != "password123":
return True
raise ValidationError(message="Password for OSSEC email account must be strong")
class ValidateEmail(Validator):
def validate(self, document: Document) -> bool:
text = document.text
if text == "":
raise ValidationError(message=("Must not be empty"))
if "@" not in text:
raise ValidationError(message=("Must contain a @"))
return True
class ValidateOSSECEmail(ValidateEmail):
def validate(self, document: Document) -> bool:
super().validate(document)
text = document.text
if text != "[email protected]":
return True
raise ValidationError(
message=("Must be set to something other than " "[email protected]")
)
class ValidateOptionalEmail(ValidateEmail):
def validate(self, document: Document) -> bool:
if document.text == "":
return True
return super().validate(document)
def __init__(self, args: argparse.Namespace) -> None:
self.args = args
self.config: dict = {}
# Hold runtime configuration before save, to support
# referencing other responses during validation
self._config_in_progress: dict = {}
supported_locales = I18N_DEFAULT_LOCALES.copy()
i18n_conf_path = os.path.join(args.root, I18N_CONF)
if os.path.exists(i18n_conf_path):
with open(i18n_conf_path) as i18n_conf_file:
i18n_conf = json.load(i18n_conf_file)
supported_locales.update(set(i18n_conf["supported_locales"].keys()))
locale_validator = SiteConfig.ValidateLocales(self.args.app_path, supported_locales)
self.desc: List[_DescEntryType] = [
(
"ssh_users",
"sd",
str,
"Username for SSH access to the servers",
SiteConfig.ValidateUser(),
None,
lambda config: True,
),
(
"daily_reboot_time",
4,
int,
"Daily reboot time of the server (24-hour clock)",
SiteConfig.ValidateTime(),
int,
lambda config: True,
),
(
"app_ip",
"10.20.2.2",
str,
"Local IPv4 address for the Application Server",
SiteConfig.ValidateIP(),
None,
lambda config: True,
),
(
"monitor_ip",
"10.20.3.2",
str,
"Local IPv4 address for the Monitor Server",
SiteConfig.ValidateIP(),
None,
lambda config: True,
),
(
"app_hostname",
"app",
str,
"Hostname for Application Server",
SiteConfig.ValidateNotEmpty(),
None,
lambda config: True,
),
(
"monitor_hostname",
"mon",
str,
"Hostname for Monitor Server",
SiteConfig.ValidateNotEmpty(),
None,
lambda config: True,
),
(
"dns_server",
["8.8.8.8", "8.8.4.4"],
list,
"DNS server(s)",
SiteConfig.ValidateNameservers(),
SiteConfig.split_list,
lambda config: True,
),
(
"securedrop_app_gpg_public_key",
"SecureDrop.asc",
str,
"Local filepath to public key for " + "SecureDrop Application GPG public key",
SiteConfig.ValidatePath(self.args.ansible_path),
None,
lambda config: True,
),
(
"securedrop_app_https_on_source_interface",
False,
bool,
"Whether HTTPS should be enabled on " + "Source Interface (requires EV cert)",
SiteConfig.ValidateYesNo(),
lambda x: x.lower() == "yes",
lambda config: True,
),
(
"securedrop_app_https_certificate_cert_src",
"",
str,
"Local filepath to HTTPS certificate",
SiteConfig.ValidateOptionalPath(self.args.ansible_path),
None,
lambda config: config.get("securedrop_app_https_on_source_interface"),
),
(
"securedrop_app_https_certificate_key_src",
"",
str,
"Local filepath to HTTPS certificate key",
SiteConfig.ValidateOptionalPath(self.args.ansible_path),
None,
lambda config: config.get("securedrop_app_https_on_source_interface"),
),
(
"securedrop_app_https_certificate_chain_src",
"",
str,
"Local filepath to HTTPS certificate chain file",
SiteConfig.ValidateOptionalPath(self.args.ansible_path),
None,
lambda config: config.get("securedrop_app_https_on_source_interface"),
),
(
"securedrop_app_gpg_fingerprint",
"",
str,
"Full fingerprint for the SecureDrop Application GPG Key",
SiteConfig.ValidateFingerprint(),
self.sanitize_fingerprint,
lambda config: True,
),
(
"ossec_alert_gpg_public_key",
"ossec.pub",
str,
"Local filepath to OSSEC alerts GPG public key",
SiteConfig.ValidatePath(self.args.ansible_path),
None,
lambda config: True,
),
(
"ossec_gpg_fpr",
"",
str,
"Full fingerprint for the OSSEC alerts GPG public key",
SiteConfig.ValidateFingerprint(),
self.sanitize_fingerprint,
lambda config: True,
),
(
"ossec_alert_email",
"",
str,
"Admin email address for receiving OSSEC alerts",
SiteConfig.ValidateOSSECEmail(),
None,
lambda config: True,
),
(
"journalist_alert_gpg_public_key",
"",
str,
"Local filepath to journalist alerts GPG public key (optional)",
SiteConfig.ValidateOptionalPath(self.args.ansible_path),
None,
lambda config: True,
),
(
"journalist_gpg_fpr",
"",
str,
"Full fingerprint for the journalist alerts " + "GPG public key (optional)",
SiteConfig.ValidateOptionalFingerprint(),
self.sanitize_fingerprint,
lambda config: config.get("journalist_alert_gpg_public_key"),
),
(
"journalist_alert_email",
"",
str,
"Email address for receiving journalist alerts (optional)",
SiteConfig.ValidateOptionalEmail(),
None,
lambda config: config.get("journalist_alert_gpg_public_key"),
),
(
"smtp_relay",
"smtp.gmail.com",
str,
"SMTP relay for sending OSSEC alerts",
SiteConfig.ValidateNotEmpty(),
None,
lambda config: True,
),
(
"smtp_relay_port",
587,
int,
"SMTP port for sending OSSEC alerts",
SiteConfig.ValidateInt(),
int,
lambda config: True,
),
(
"sasl_domain",
"gmail.com",
str,
"SASL domain for sending OSSEC alerts",
None,
None,
lambda config: True,
),
(
"sasl_username",
"",
str,
"SASL username for sending OSSEC alerts",
SiteConfig.ValidateOSSECUsername(),
None,
lambda config: True,
),
(
"sasl_password",
"",
str,
"SASL password for sending OSSEC alerts",
SiteConfig.ValidateOSSECPassword(),
None,
lambda config: True,
),
(
"enable_ssh_over_tor",
True,
bool,
"Enable SSH over Tor (recommended, disables SSH over LAN). "
+ "If you respond no, SSH will be available over LAN only",
SiteConfig.ValidateYesNo(),
lambda x: x.lower() == "yes",
lambda config: True,
),
(
"securedrop_supported_locales",
[],
list,
"Space separated list of additional locales to support "
"(" + " ".join(sorted(list(locale_validator.available))) + ")",
locale_validator,
str.split,
lambda config: True,
),
]
def load_and_update_config(self, validate: bool = True, prompt: bool = True) -> bool:
if self.exists():
self.config = self.load(validate)
elif not prompt:
sdlog.error('Please run "securedrop-admin sdconfig" first.')
sys.exit(1)
return self.update_config(prompt)
def update_config(self, prompt: bool = True) -> bool:
if prompt:
self.config.update(self.user_prompt_config())
self.save()
self.validate_gpg_keys()
self.validate_journalist_alert_email()
return True
def user_prompt_config(self) -> Dict[str, Any]:
self._config_in_progress = {}
for desc in self.desc:
(var, default, type, prompt, validator, transform, condition) = desc
if not condition(self._config_in_progress):
self._config_in_progress[var] = ""
continue
self._config_in_progress[var] = self.user_prompt_config_one(desc, self.config.get(var))
return self._config_in_progress
def user_prompt_config_one(self, desc: _DescEntryType, from_config: Optional[Any]) -> Any:
(var, default, type, prompt, validator, transform, condition) = desc
if from_config is not None:
default = from_config
prompt += ": "
# The following is for the dynamic check of the user input
# for the previous question, as we are calling the default value
# function dynamically, we can get the right value based on the
# previous user input.
if callable(default):
default = default()
return self.validated_input(prompt, default, validator, transform)
def validated_input(
self, prompt: str, default: Any, validator: Validator, transform: Optional[Callable]
) -> Any:
if type(default) is bool:
default = "yes" if default else "no"
if type(default) is int:
default = str(default)
if isinstance(default, list):
default = " ".join(default)
if type(default) is not str:
default = str(default)
value = prompt_toolkit.prompt(prompt, default=default, validator=validator)
if transform:
return transform(value)
else:
return value
def sanitize_fingerprint(self, value: str) -> str:
return value.upper().replace(" ", "")
def validate_gpg_keys(self) -> bool:
keys = (
("securedrop_app_gpg_public_key", "securedrop_app_gpg_fingerprint"),
("ossec_alert_gpg_public_key", "ossec_gpg_fpr"),
("journalist_alert_gpg_public_key", "journalist_gpg_fpr"),
)
validate = os.path.join(os.path.dirname(__file__), "..", "bin", "validate-gpg-key.sh")
for (public_key, fingerprint) in keys:
if self.config[public_key] == "" and self.config[fingerprint] == "":
continue
public_key = os.path.join(self.args.ansible_path, self.config[public_key])
fingerprint = self.config[fingerprint]
try:
sdlog.debug(
subprocess.check_output(
[validate, public_key, fingerprint], stderr=subprocess.STDOUT
)
)
except subprocess.CalledProcessError as e:
sdlog.debug(e.output)
raise FingerprintException(
f"fingerprint {fingerprint} "
+ "does not match "
+ f"the public key {public_key}"
)
return True
def validate_journalist_alert_email(self) -> bool:
if (
self.config["journalist_alert_gpg_public_key"] == ""
and self.config["journalist_gpg_fpr"] == ""
):
return True
class Document:
def __init__(self, text: str) -> None:
self.text = text
try:
SiteConfig.ValidateEmail().validate(Document(self.config["journalist_alert_email"]))
except ValidationError as e:
raise JournalistAlertEmailException("journalist alerts email: " + e.message)
return True
def exists(self) -> bool:
return os.path.exists(self.args.site_config)
def save(self) -> None:
with open(self.args.site_config, "w") as site_config_file:
yaml.safe_dump(self.config, site_config_file, default_flow_style=False)
def clean_config(self, config: Dict) -> Dict:
"""
Cleans a loaded config without prompting.
For every variable defined in self.desc, validate its value in
the supplied configuration dictionary, run the value through
its defined transformer, and add the result to a clean version
of the configuration.
If no configuration variable triggers a ValidationError, the
clean configuration will be returned.
"""
clean_config = {}
clean_config.update(config)
for desc in self.desc:
var, default, vartype, prompt, validator, transform, condition = desc
if var in clean_config:
value = clean_config[var]
if isinstance(value, list):
text = " ".join(str(v) for v in value)
elif isinstance(value, bool):
text = "yes" if value else "no"
else:
text = str(value)
if validator is not None:
try:
validator.validate(Document(text))
except ValidationError as e:
sdlog.error(e)
sdlog.error(
"Error loading configuration. "
'Please run "securedrop-admin sdconfig" again.'
)
raise
clean_config[var] = transform(text) if transform else text
if var not in self._config_in_progress:
self._config_in_progress[var] = clean_config[var]
return clean_config
def load(self, validate: bool = True) -> Dict:
"""
Loads the site configuration file.
If validate is True, then each configuration variable that has
an entry in self.desc is validated and transformed according
to current specifications.
"""
try:
with open(self.args.site_config) as site_config_file:
c = yaml.safe_load(site_config_file)
return self.clean_config(c) if validate else c
except OSError:
sdlog.error("Config file missing, re-run with sdconfig")
raise
except yaml.YAMLError:
sdlog.error(f"There was an issue processing {self.args.site_config}")
raise
def setup_logger(verbose: bool = False) -> None:
"""Configure logging handler"""
# Set default level on parent
sdlog.setLevel(logging.DEBUG)
level = logging.DEBUG if verbose else logging.INFO
stdout = logging.StreamHandler(sys.stdout)
stdout.setFormatter(logging.Formatter("%(levelname)s: %(message)s"))
stdout.setLevel(level)
sdlog.addHandler(stdout)
def update_check_required(cmd_name: str) -> Callable[[_FuncT], _FuncT]:
"""
This decorator can be added to any subcommand that is part of securedrop-admin
via `@update_check_required("name_of_subcommand")`. It forces a check for
updates, and aborts if the locally installed code is out of date. It should
be generally added to all subcommands that make modifications on the
server or on the Admin Workstation.
The user can override this check by specifying the --force argument before
any subcommand.
"""
def decorator_update_check(func: _FuncT) -> _FuncT:
@functools.wraps(func)
def wrapper(*args: Any, **kwargs: Any) -> Any:
cli_args = args[0]
if cli_args.force:
sdlog.info("Skipping update check because --force argument was provided.")
return func(*args, **kwargs)
update_status, latest_tag = check_for_updates(cli_args)
if update_status is True:
# Useful for troubleshooting
branch_status = get_git_branch(cli_args)
sdlog.error(
"You are not running the most recent signed SecureDrop release "
"on this workstation."
)
sdlog.error(f"Latest available version: {latest_tag}")
if branch_status is not None:
sdlog.error(f"Current branch status: {branch_status}")
else:
sdlog.error("Problem determining current branch status.")
sdlog.error(
"Running outdated or mismatched code can cause significant " "technical issues."
)
sdlog.error(
"To display more information about your repository state, run:\n\n\t"
"git status\n"
)
sdlog.error(
"If you are certain you want to proceed, run:\n\n\t"
"./securedrop-admin --force {}\n".format(cmd_name)
)
sdlog.error("To apply the latest updates, run:\n\n\t" "./securedrop-admin update\n")
sdlog.error(
"If this fails, see the latest upgrade guide on "
"https://docs.securedrop.org/ for instructions."
)
sys.exit(1)
return func(*args, **kwargs)
return cast(_FuncT, wrapper)
return decorator_update_check
@update_check_required("sdconfig")
def sdconfig(args: argparse.Namespace) -> int:
"""Configure SD site settings"""
SiteConfig(args).load_and_update_config(validate=False)
return 0
def generate_new_v3_keys() -> Tuple[str, str]:
"""This function generate new keys for Tor v3 onion
services and returns them as as tuple.
:returns: Tuple(public_key, private_key)
"""
private_key = x25519.X25519PrivateKey.generate()
private_bytes = private_key.private_bytes(
encoding=serialization.Encoding.Raw,
format=serialization.PrivateFormat.Raw,
encryption_algorithm=serialization.NoEncryption(),
)
public_key = private_key.public_key()
public_bytes = public_key.public_bytes(
encoding=serialization.Encoding.Raw, format=serialization.PublicFormat.Raw
)
# Base32 encode and remove base32 padding characters (`=`)
public = base64.b32encode(public_bytes).replace(b"=", b"").decode("utf-8")
private = base64.b32encode(private_bytes).replace(b"=", b"").decode("utf-8")
return public, private
def find_or_generate_new_torv3_keys(args: argparse.Namespace) -> int:
"""
This method will either read v3 Tor onion service keys if found or generate
a new public/private keypair.
"""
secret_key_path = os.path.join(args.ansible_path, "tor_v3_keys.json")
if os.path.exists(secret_key_path):
print(f"Tor v3 onion service keys already exist in: {secret_key_path}")
return 0
# No old keys, generate and store them first
app_journalist_public_key, app_journalist_private_key = generate_new_v3_keys()
# For app SSH service
app_ssh_public_key, app_ssh_private_key = generate_new_v3_keys()
# For mon SSH service
mon_ssh_public_key, mon_ssh_private_key = generate_new_v3_keys()
tor_v3_service_info = {
"app_journalist_public_key": app_journalist_public_key,
"app_journalist_private_key": app_journalist_private_key,
"app_ssh_public_key": app_ssh_public_key,
"app_ssh_private_key": app_ssh_private_key,
"mon_ssh_public_key": mon_ssh_public_key,
"mon_ssh_private_key": mon_ssh_private_key,
}
with open(secret_key_path, "w") as fobj:
json.dump(tor_v3_service_info, fobj, indent=4)
print(f"Tor v3 onion service keys generated and stored in: {secret_key_path}")
return 0
@update_check_required("install")
def install_securedrop(args: argparse.Namespace) -> int:
"""Install/Update SecureDrop"""
SiteConfig(args).load_and_update_config(prompt=False)
sdlog.info("Now installing SecureDrop on remote servers.")
sdlog.info("You will be prompted for the sudo password on the " "servers.")
sdlog.info("The sudo password is only necessary during initial " "installation.")
return subprocess.check_call(
[os.path.join(args.ansible_path, "securedrop-prod.yml"), "--ask-become-pass"],
cwd=args.ansible_path,
)
def verify_install(args: argparse.Namespace) -> int:
"""Run configuration tests against SecureDrop servers"""
sdlog.info("Running configuration tests: ")
testinfra_cmd = ["./devops/scripts/run_prod_testinfra"]
return subprocess.check_call(testinfra_cmd, cwd=os.getcwd())
@update_check_required("backup")
def backup_securedrop(args: argparse.Namespace) -> int:
"""Perform backup of the SecureDrop Application Server.
Creates a tarball of submissions and server config, and fetches
back to the Admin Workstation. Future `restore` actions can be performed
with the backup tarball."""
sdlog.info("Backing up the SecureDrop Application Server")
ansible_cmd = [
"ansible-playbook",
os.path.join(args.ansible_path, "securedrop-backup.yml"),
]
return subprocess.check_call(ansible_cmd, cwd=args.ansible_path)
@update_check_required("restore")
def restore_securedrop(args: argparse.Namespace) -> int:
"""Perform restore of the SecureDrop Application Server.
Requires a tarball of submissions and server config, created via
the `backup` action."""
sdlog.info("Restoring the SecureDrop Application Server from backup")
# Canonicalize filepath to backup tarball, so Ansible sees only the
# basename. The files must live in args.ansible_path,
# but the securedrop-admin
# script will be invoked from the repo root, so preceding dirs are likely.
restore_file_basename = os.path.basename(args.restore_file)
# Would like readable output if there's a problem
os.environ["ANSIBLE_STDOUT_CALLBACK"] = "debug"
ansible_cmd = [
"ansible-playbook",
os.path.join(args.ansible_path, "securedrop-restore.yml"),
"-e",
]
ansible_cmd_extras = [
f"restore_file='{restore_file_basename}'",
]
if args.restore_skip_tor:
ansible_cmd_extras.append("restore_skip_tor='True'")
if args.restore_manual_transfer:
ansible_cmd_extras.append("restore_manual_transfer='True'")
ansible_cmd.append(" ".join(ansible_cmd_extras))
return subprocess.check_call(ansible_cmd, cwd=args.ansible_path)
@update_check_required("tailsconfig")
def run_tails_config(args: argparse.Namespace) -> int:
"""Configure Tails environment post SD install"""
sdlog.info("Configuring Tails workstation environment")
sdlog.info(
"You'll be prompted for the temporary Tails admin password,"
" which was set on Tails login screen"
)
ansible_cmd = [
os.path.join(args.ansible_path, "securedrop-tails.yml"),
"--ask-become-pass",
# Passing an empty inventory file to override the automatic dynamic
# inventory script, which fails if no site vars are configured.
"-i",
"/dev/null",
]
return subprocess.check_call(ansible_cmd, cwd=args.ansible_path)
def check_for_updates_wrapper(args: argparse.Namespace) -> int:
check_for_updates(args)
# Because the command worked properly exit with 0.
return 0
def check_for_updates(args: argparse.Namespace) -> Tuple[bool, str]:
"""Check for SecureDrop updates"""
sdlog.info("Checking for SecureDrop updates...")
# Determine what tag we are likely to be on. Caveat: git describe
# may produce very surprising results, because it will locate the most recent
# _reachable_ tag. However, in our current branching model, it can be
# relied on to determine if we're on the latest tag or not.
current_tag = (
subprocess.check_output(["git", "describe"], cwd=args.root).decode("utf-8").rstrip("\n")
)
# Fetch all branches
git_fetch_cmd = ["git", "fetch", "--all"]
subprocess.check_call(git_fetch_cmd, cwd=args.root)
# Get latest tag
git_all_tags = ["git", "tag"]
all_tags = (
subprocess.check_output(git_all_tags, cwd=args.root)
.decode("utf-8")
.rstrip("\n")
.split("\n")
)
# Do not check out any release candidate tags
all_prod_tags = [x for x in all_tags if "rc" not in x]
# We want the tags to be sorted based on semver
all_prod_tags.sort(key=parse_version)
latest_tag = all_prod_tags[-1]
if current_tag != latest_tag:
sdlog.info("Update needed")
return True, latest_tag
sdlog.info("All updates applied")
return False, latest_tag
def get_git_branch(args: argparse.Namespace) -> Optional[str]:
"""
Returns the starred line of `git branch` output.
"""
git_branch_raw = subprocess.check_output(["git", "branch"], cwd=args.root).decode("utf-8")
match = re.search(r"\* (.*)\n", git_branch_raw)
if match is not None and len(match.groups()) > 0:
return match.group(1)
else:
return None
def get_release_key_from_keyserver(
args: argparse.Namespace, keyserver: Optional[str] = None, timeout: int = 45
) -> None:
gpg_recv = ["timeout", str(timeout), "gpg", "--batch", "--no-tty", "--recv-key"]
for release_key in RELEASE_KEYS:
# We construct the gpg --recv-key command based on optional keyserver arg.
if keyserver:
get_key_cmd = gpg_recv + ["--keyserver", keyserver] + [release_key]
else:
get_key_cmd = gpg_recv + [release_key]
subprocess.check_call(get_key_cmd, cwd=args.root)
def update(args: argparse.Namespace) -> int:
"""Verify, and apply latest SecureDrop workstation update"""
sdlog.info("Applying SecureDrop updates...")
update_status, latest_tag = check_for_updates(args)
if not update_status:
# Exit if we're up to date
return 0
sdlog.info("Verifying signature on latest update...")