-
Notifications
You must be signed in to change notification settings - Fork 332
/
upgrade.py
2095 lines (1717 loc) · 67.8 KB
/
upgrade.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) 2015 FreeIPA Contributors see COPYING for license
#
from __future__ import print_function, absolute_import
import errno
import itertools
import logging
import re
import os
import glob
import shutil
import fileinput
import stat
import sys
import tempfile
from contextlib import contextmanager
from augeas import Augeas
from pkg_resources import parse_version
from ipalib import api, x509
from ipalib.constants import RENEWAL_CA_NAME, RA_AGENT_PROFILE, IPA_CA_RECORD
from ipalib.install import certmonger
from ipalib import sysrestore
from ipalib.facts import is_ipa_configured
import SSSDConfig
import ipalib.util
import ipalib.errors
from ipaclient.install import timeconf
from ipaclient.install.client import sssd_enable_ifp
from ipalib.install.dnsforwarders import detect_resolve1_resolv_conf
from ipaplatform import services
from ipaplatform.tasks import tasks
from ipapython import ipautil, version
from ipapython import ipaldap
from ipapython import directivesetter
from ipapython.dn import DN
from ipapython.version import KRB5_BUILD_VERSION
from ipaplatform.constants import constants
from ipaplatform.paths import paths
from ipaserver import servroles
from ipaserver.install import installutils
from ipaserver.install import dsinstance
from ipaserver.install import httpinstance
from ipaserver.install import bindinstance
from ipaserver.install import service
from ipaserver.install import cainstance
from ipaserver.install import krainstance
from ipaserver.install import certs
from ipaserver.install import otpdinstance
from ipaserver.install import schemaupdate
from ipaserver.install import custodiainstance
from ipaserver.install import sysupgrade
from ipaserver.install import dnskeysyncinstance
from ipaserver.install import dogtaginstance
from ipaserver.install import krbinstance
from ipaserver.install import adtrustinstance
from ipaserver.install import replication
from ipaserver.install.upgradeinstance import IPAUpgrade
from ipaserver.install.ldapupdate import BadSyntax
import six
# pylint: disable=import-error
if six.PY3:
# The SafeConfigParser class has been renamed to ConfigParser in Py3
from configparser import ConfigParser as SafeConfigParser
else:
from ConfigParser import SafeConfigParser
# pylint: enable=import-error
if six.PY3:
unicode = str
logger = logging.getLogger(__name__)
class KpasswdInstance(service.SimpleServiceInstance):
def __init__(self):
service.SimpleServiceInstance.__init__(self, "ipa_kpasswd")
def uninstall_ipa_kpasswd():
"""
We can't use the full service uninstaller because that will attempt
to stop and disable the service which by now doesn't exist. We just
want to clean up sysrestore.state to remove all references to
ipa_kpasswd.
"""
ipa_kpasswd = KpasswdInstance()
enabled = not ipa_kpasswd.restore_state("enabled")
if enabled is not None and not enabled:
ipa_kpasswd.remove()
def uninstall_ipa_memcached():
"""
We can't use the full service uninstaller because that will attempt
to stop and disable the service which by now doesn't exist. We just
want to clean up sysrestore.state to remove all references to
ipa_memcached.
"""
ipa_memcached = service.SimpleServiceInstance('ipa_memcached')
if ipa_memcached.is_configured():
ipa_memcached.uninstall()
def backup_file(filename, ext):
"""Make a backup of filename using ext as the extension. Do not overwrite
previous backups."""
if not os.path.isabs(filename):
raise ValueError("Absolute path required")
backupfile = filename + ".bak"
while os.path.exists(backupfile):
backupfile = backupfile + "." + str(ext)
try:
shutil.copy2(filename, backupfile)
except IOError as e:
if e.errno == 2: # No such file or directory
pass
else:
raise e
def update_conf(sub_dict, filename, template_filename):
template = ipautil.template_file(template_filename, sub_dict)
fd = open(filename, "w")
fd.write(template)
fd.close()
def find_autoredirect(fqdn):
"""
When upgrading ipa-rewrite.conf we need to see if the automatic redirect
was disabled during install time (or afterward). So sift through the
configuration file and see if we can determine the status.
Returns True if autoredirect is enabled, False otherwise
"""
filename = paths.HTTPD_IPA_REWRITE_CONF
if os.path.exists(filename):
pattern = r"^RewriteRule \^/\$ https://%s/ipa/ui \[L,NC,R=301\]" % fqdn
p = re.compile(pattern)
for line in fileinput.input(filename):
if p.search(line):
fileinput.close()
return True
fileinput.close()
return False
return True
def find_version(filename):
"""Find the version of a configuration file
If no VERSION entry exists in the file, returns 0.
If the file does not exist, returns -1.
"""
if os.path.exists(filename):
pattern = r"^[\s#]*VERSION\s+([0-9]+)\s+.*"
p = re.compile(pattern)
for line in fileinput.input(filename):
if p.search(line):
fileinput.close()
return p.search(line).group(1)
fileinput.close()
# no VERSION found
return 0
else:
return -1
def upgrade_file(sub_dict, filename, template, add=False, force=False):
"""
Get the version from the current and template files and update the
installed configuration file if there is a new template.
If add is True then create a new configuration file.
If force is True then the version comparison is skipped. This should
be used judiciously. It does not override add nor will it affect
files that don't exist (version == -1).
"""
old = int(find_version(filename))
new = int(find_version(template))
if old < 0 and not add:
logger.error("%s not found.", filename)
raise RuntimeError("%s not found." % filename)
if new < 0:
logger.error("%s not found.", template)
if new == 0:
logger.error("Template %s is not versioned.", template)
if old == 0:
# The original file does not have a VERSION entry. This means it's now
# managed by IPA, but previously was not.
logger.warning("%s is now managed by IPA. It will be "
"overwritten. A backup of the original will be made.",
filename)
if force:
logger.error("Forcing update of template %s", template)
if ((old < new) or (add and old == 0)) or force:
backup_file(filename, new)
update_conf(sub_dict, filename, template)
logger.info("Upgraded %s to version %d", filename, new)
def check_certs():
"""Check ca.crt is in the right place, and try to fix if not"""
logger.info('[Verifying that root certificate is published]')
if not os.path.exists(paths.CA_CRT):
ca_file = paths.IPA_CA_CRT
if os.path.exists(ca_file):
old_umask = os.umask(0o22) # make sure its readable by httpd
try:
shutil.copyfile(ca_file, paths.CA_CRT)
finally:
os.umask(old_umask)
else:
logger.error("Missing Certification Authority file.")
logger.error("You should place a copy of the CA certificate in "
"/usr/share/ipa/html/ca.crt")
else:
logger.debug('Certificate file exists')
def update_dbmodules(realm, filename=paths.KRB5_CONF):
newfile = []
found_dbrealm = False
found_realm = False
prefix = ''
logger.info('[Verifying that KDC configuration is using ipa-kdb backend]')
fd = open(filename)
lines = fd.readlines()
fd.close()
if ' db_library = ipadb.so\n' in lines:
logger.debug('dbmodules already updated in %s', filename)
return
for line in lines:
if line.startswith('[dbmodules]'):
found_dbrealm = True
if found_dbrealm and line.find(realm) > -1:
found_realm = True
prefix = '#'
if found_dbrealm and line.find('}') > -1 and found_realm:
found_realm = False
newfile.append('#%s' % line)
prefix = ''
continue
newfile.append('%s%s' % (prefix, line))
# Append updated dbmodules information
newfile.append(' %s = {\n' % realm)
newfile.append(' db_library = ipadb.so\n')
newfile.append(' }\n')
# Write out new file
fd = open(filename, 'w')
fd.write("".join(newfile))
fd.close()
logger.debug('%s updated', filename)
def cleanup_kdc(fstore):
"""
Clean up old KDC files if they exist. We need to remove the actual
file and any references in the uninstall configuration.
"""
logger.info('[Checking for deprecated KDC configuration files]')
for file in ['kpasswd.keytab', 'ldappwd']:
filename = os.path.join(paths.VAR_KERBEROS_KRB5KDC_DIR, file)
ipautil.remove_file(filename)
if fstore.has_file(filename):
fstore.untrack_file(filename)
logger.debug('Uninstalling %s', filename)
def cleanup_adtrust(fstore):
"""
Clean up any old Samba backup files that were deprecated.
"""
logger.info('[Checking for deprecated backups of Samba '
'configuration files]')
for backed_up_file in [paths.SMB_CONF]:
if fstore.has_file(backed_up_file):
fstore.untrack_file(backed_up_file)
logger.debug('Removing %s from backup', backed_up_file)
def cleanup_dogtag():
"""
pkispawn leaves some mess we were not cleaning up until recently. Try
to clean up what we can.
"""
subsystems = []
if api.Command.ca_is_enabled()['result']:
subsystems.append('CA')
if api.Command.kra_is_enabled()['result']:
subsystems.append('KRA')
for system in subsystems:
logger.debug(
"Cleaning up after pkispawn for the %s subsystem",
system)
instance = dogtaginstance.DogtagInstance(
api.env.realm, system, service_desc=None,
)
instance.clean_pkispawn_files()
def cleanup_kdcinfo():
""" Remove stale kdcinfo.*|kpasswdinfo.* files generated by SSSD """
for pattern in ('kdcinfo.*', 'kpasswdinfo.*'):
for fname in glob.glob(os.path.join(paths.SSSD_PUBCONF_DIR, pattern)):
logger.debug('Removing stale info file %s', fname)
os.unlink(fname)
def upgrade_adtrust_config():
"""
Upgrade 'dedicated keytab file' in smb.conf to omit FILE: prefix
"""
if not adtrustinstance.ipa_smb_conf_exists():
return
logger.info("[Remove FILE: prefix from 'dedicated keytab file' "
"in Samba configuration]")
args = [paths.NET, "conf", "setparm", "global",
"dedicated keytab file", paths.SAMBA_KEYTAB]
try:
ipautil.run(args)
except ipautil.CalledProcessError as e:
logger.warning("Error updating Samba registry: %s", e)
logger.info("[Update 'max smbd processes' in Samba configuration "
"to prevent unlimited SMBLoris attack amplification]")
args = [paths.NET, "conf", "getparm", "global", "max smbd processes"]
try:
ipautil.run(args)
except ipautil.CalledProcessError as e:
if e.returncode == 255:
# 'max smbd processes' does not exist
args = [paths.NET, "conf", "setparm", "global",
"max smbd processes", "1000"]
try:
ipautil.run(args)
except ipautil.CalledProcessError as e2:
logger.warning("Error updating Samba registry: %s", e2)
else:
logger.warning("Error updating Samba registry: %s", e)
logger.info("[Change 'server role' from "
"'CLASSIC PRIMARY DOMAIN CONTROLLER' "
"to 'IPA PRIMARY DOMAIN CONTROLLER' in Samba configuration]")
args = [paths.NET, "conf", "setparm", "global",
"server role", "IPA PRIMARY DOMAIN CONTROLLER"]
try:
ipautil.run(args)
except ipautil.CalledProcessError as e:
# Only report an error if return code is not 255
# which indicates that the new server role is not supported
# and we don't need to do anything
if e.returncode != 255:
logger.warning("Error updating Samba registry: %s", e)
def ca_configure_profiles_acl(ca):
logger.info('[Authorizing RA Agent to modify profiles]')
if not ca.is_configured():
logger.info('CA is not configured')
return False
return cainstance.configure_profiles_acl()
def ca_configure_lightweight_ca_acls(ca):
logger.info('[Authorizing RA Agent to manage lightweight CAs]')
if not ca.is_configured():
logger.info('CA is not configured')
return False
return cainstance.configure_lightweight_ca_acls()
def ca_enable_ldap_profile_subsystem(ca):
logger.info('[Ensuring CA is using LDAPProfileSubsystem]')
if not ca.is_configured():
logger.info('CA is not configured')
return False
needs_update = False
directive = None
try:
i = 0
while True:
# find profile subsystem
directive = "subsystem.{}.id".format(i)
value = directivesetter.get_directive(
paths.CA_CS_CFG_PATH,
directive,
separator='=')
if not value:
logger.error('Unable to find profile subsystem in %s',
paths.CA_CS_CFG_PATH)
return False
if value != 'profile':
i = i + 1
continue
# check profile subsystem class name
directive = "subsystem.{}.class".format(i)
value = directivesetter.get_directive(
paths.CA_CS_CFG_PATH,
directive,
separator='=')
if value != 'com.netscape.cmscore.profile.LDAPProfileSubsystem':
needs_update = True
# break after finding profile subsystem
break
except OSError as e:
logger.error('Cannot read CA configuration file "%s": %s',
paths.CA_CS_CFG_PATH, e)
return False
if needs_update:
directivesetter.set_directive(
paths.CA_CS_CFG_PATH,
directive,
'com.netscape.cmscore.profile.LDAPProfileSubsystem',
quotes=False,
separator='=')
ca.restart('pki-tomcat')
logger.info('[Migrating certificate profiles to LDAP]')
cainstance.migrate_profiles_to_ldap()
return needs_update
def ca_import_included_profiles(ca):
logger.info('[Ensuring presence of included profiles]')
if not ca.is_configured():
logger.info('CA is not configured')
return False
return cainstance.import_included_profiles()
def ca_ensure_lightweight_cas_container(ca):
logger.info('[Ensuring Lightweight CAs container exists in Dogtag '
'database]')
if not ca.is_configured():
logger.info('CA is not configured')
return False
return cainstance.ensure_lightweight_cas_container()
def ca_enable_lightweight_ca_monitor(ca):
logger.info('[Enabling LWCA monitor]')
if not ca.is_configured():
logger.info('CA is not configured')
return False
return cainstance.enable_lightweight_ca_monitor()
def ca_add_default_ocsp_uri(ca):
logger.info('[Adding default OCSP URI configuration]')
if not ca.is_configured():
logger.info('CA is not configured')
return False
value = directivesetter.get_directive(
paths.CA_CS_CFG_PATH,
'ca.defaultOcspUri',
separator='=')
if value:
return False # already set; restart not needed
directivesetter.set_directive(
paths.CA_CS_CFG_PATH,
'ca.defaultOcspUri',
'http://ipa-ca.%s/ca/ocsp' % ipautil.format_netloc(api.env.domain),
quotes=False,
separator='=')
return True # restart needed
def ca_disable_publish_cert(ca):
logger.info('[Disabling cert publishing]')
if not ca.is_configured():
logger.info('CA is not configured')
return False
value = directivesetter.get_directive(
paths.CA_CS_CFG_PATH,
'ca.publish.cert.enable',
separator='=')
if value:
return False # already set; restart not needed
directivesetter.set_directive(
paths.CA_CS_CFG_PATH,
'ca.publish.cert.enable',
'false',
quotes=False,
separator='=')
return True # restart needed
def ca_initialize_hsm_state(ca):
"""Initializse HSM state as False / internal token
"""
if not ca.sstore.has_state(ca.hsm_sstore):
section_name = ca.subsystem.upper()
config = SafeConfigParser()
config.add_section(section_name)
config.set(section_name, 'pki_hsm_enable', 'False')
ca.set_hsm_state(config)
def dnssec_set_openssl_engine(dnskeysyncd):
"""
Setup OpenSSL engine for BIND
"""
if constants.NAMED_OPENSSL_ENGINE is None:
return False
if sysupgrade.get_upgrade_state('dns', 'openssl_engine'):
return False
logger.info('[Set OpenSSL engine for BIND]')
dnskeysyncd.setup_named_openssl_conf()
dnskeysyncd.setup_named_sysconfig()
dnskeysyncd.setup_ipa_dnskeysyncd_sysconfig()
sysupgrade.set_upgrade_state('dns', 'openssl_engine', True)
return True
def certificate_renewal_update(ca, kra, ds, http):
"""
Update certmonger certificate renewal configuration.
"""
# First ensure the renewal helpers are defined.
ca.configure_certmonger_renewal_helpers()
template = paths.CERTMONGER_COMMAND_TEMPLATE
serverid = ipaldap.realm_to_serverid(api.env.realm)
requests = []
dogtag_reqs = ca.tracking_reqs.items()
if kra.is_installed():
dogtag_reqs = itertools.chain(dogtag_reqs, kra.tracking_reqs.items())
for nick, profile in dogtag_reqs:
req = {
'cert-database': paths.PKI_TOMCAT_ALIAS_DIR,
'cert-nickname': nick,
'ca-name': RENEWAL_CA_NAME,
'cert-presave-command': template % 'stop_pkicad',
'cert-postsave-command':
(template % 'renew_ca_cert "{}"'.format(nick)),
'template-profile': profile,
}
requests.append(req)
requests.append(
{
'cert-file': paths.RA_AGENT_PEM,
'key-file': paths.RA_AGENT_KEY,
'ca-name': RENEWAL_CA_NAME,
'template-profile': RA_AGENT_PROFILE,
'cert-presave-command': template % 'renew_ra_cert_pre',
'cert-postsave-command': template % 'renew_ra_cert',
},
)
logger.info("[Update certmonger certificate renewal configuration]")
if not ca.is_configured():
logger.info('CA is not configured')
return False
# Check the http server cert if issued by IPA
cert = x509.load_certificate_from_file(paths.HTTPD_CERT_FILE)
if certs.is_ipa_issued_cert(api, cert):
requests.append(
{
'cert-file': paths.HTTPD_CERT_FILE,
'key-file': paths.HTTPD_KEY_FILE,
'ca-name': 'IPA',
'cert-postsave-command': template % 'restart_httpd',
'template-hostname': [
http.fqdn,
f'{IPA_CA_RECORD}.{ipautil.format_netloc(api.env.domain)}',
],
}
)
# Check the ldap server cert if issued by IPA
ds_nickname = ds.get_server_cert_nickname(serverid)
ds_db_dirname = dsinstance.config_dirname(serverid)
ds_db = certs.CertDB(api.env.realm, nssdir=ds_db_dirname)
if ds_db.is_ipa_issued_cert(api, ds_nickname):
requests.append(
{
'cert-database': ds_db_dirname[:-1],
'cert-nickname': ds_nickname,
'ca-name': 'IPA',
'cert-postsave-command':
'%s %s' % (template % 'restart_dirsrv', serverid),
}
)
db = certs.CertDB(api.env.realm, paths.PKI_TOMCAT_ALIAS_DIR)
for nickname, _trust_flags in db.list_certs():
if nickname.startswith('caSigningCert cert-pki-ca '):
requests.append(
{
'cert-database': paths.PKI_TOMCAT_ALIAS_DIR,
'cert-nickname': nickname,
'ca-name': RENEWAL_CA_NAME,
'cert-presave-command': template % 'stop_pkicad',
'cert-postsave-command':
(template % ('renew_ca_cert "%s"' % nickname)),
'template-profile': 'caCACert',
}
)
# State not set, lets see if we are already configured
missing_or_misconfigured_requests = []
for request in requests:
request_id = certmonger.get_request_id(request)
if request_id is None:
missing_or_misconfigured_requests.append(request)
if len(missing_or_misconfigured_requests) == 0:
logger.info("Certmonger certificate renewal configuration already "
"up-to-date")
return False
# Print info about missing requests
logger.info("Missing or incorrect tracking request for certificates:")
for request in missing_or_misconfigured_requests:
cert = None
if 'cert-file' in request:
cert = request['cert-file']
elif 'cert-database' in request and 'cert-nickname' in request:
cert = '{cert-database}:{cert-nickname}'.format(**request)
if cert is not None:
logger.info(" %s", cert)
# Ok, now we need to stop tracking, then we can start tracking them
# again with new configuration:
ca.stop_tracking_certificates()
if kra.is_installed():
kra.stop_tracking_certificates()
ds.stop_tracking_certificates(serverid)
http.stop_tracking_certificates()
filename = paths.CERTMONGER_CAS_CA_RENEWAL
if os.path.exists(filename):
with installutils.stopped_service('certmonger'):
logger.info("Removing %s", filename)
ipautil.remove_file(filename)
ca.configure_renewal()
ca.configure_agent_renewal()
ca.add_lightweight_ca_tracking_requests()
if kra.is_installed():
kra.configure_renewal()
ds.start_tracking_certificates(serverid)
http.start_tracking_certificates()
logger.info("Certmonger certificate renewal configuration updated")
return True
def http_certificate_ensure_ipa_ca_dnsname(http):
"""
Ensure the HTTP service certificate has the ipa-ca.$DOMAIN SAN dNSName.
This subroutine should be executed *after* ``certificate_renewal_update``,
which adds the name to the tracking request. It assumes that the tracking
request already has the ipa-ca.$DOMAIN DNS name set, and all that is needed
is to resubmit the request.
If HTTP certificate is issued by a third party, print manual remediation
steps.
"""
logger.info('[Adding ipa-ca alias to HTTP certificate]')
expect = f'{IPA_CA_RECORD}.{ipautil.format_netloc(api.env.domain)}'
cert = x509.load_certificate_from_file(paths.HTTPD_CERT_FILE)
try:
cert.match_hostname(expect)
except x509.ssl_match_hostname.CertificateError:
if certs.is_ipa_issued_cert(api, cert):
request_id = certmonger.get_request_id(
{'cert-file': paths.HTTPD_CERT_FILE})
if request_id is None:
# shouldn't happen
logger.error('Could not find HTTP cert tracking request.')
else:
logger.info('Resubmitting HTTP cert tracking request')
certmonger.resubmit_request(request_id)
# NOTE: due to https://pagure.io/certmonger/issue/143, the
# resubmitted request, if it does not immediately succeed
# (fairly likely during ipa-server-upgrade) and if the notAfter
# date of the current cert is still far off (also likely), then
# Certmonger will wait 7 days before trying again (unless
# restarted). There is not much we can do about that here, in
# the middle of ipa-server-upgrade.
else:
logger.error('HTTP certificate is issued by third party.')
logger.error(
'Obtain a new certificate with the following DNS names, \n'
'and install via ipa-server-certinstall(1):\n'
' - %s\n'
' - %s',
http.fqdn,
expect,
)
else:
logger.info('Certificate is OK; nothing to do')
def copy_crl_file(old_path, new_path=None):
"""
Copy CRL to new location, update permissions and SELinux context
"""
if new_path is None:
filename = os.path.basename(old_path)
new_path = os.path.join(paths.PKI_CA_PUBLISH_DIR, filename)
logger.debug('copy_crl_file: %s -> %s', old_path, new_path)
if os.path.islink(old_path):
# update symlink to the most most recent CRL file
filename = os.path.basename(os.readlink(old_path))
realpath = os.path.join(paths.PKI_CA_PUBLISH_DIR, filename)
logger.debug('copy_crl_file: Create symlink %s -> %s',
new_path, realpath)
os.symlink(realpath, new_path)
else:
shutil.copy2(old_path, new_path)
constants.PKI_USER.chown(new_path)
tasks.restore_context(new_path)
def migrate_crl_publish_dir(ca):
"""
Move CRL publish dir from /var/lib/pki-ca/publish to IPA controlled tree:
/var/lib/ipa/pki-ca/publish
"""
logger.info('[Migrate CRL publish directory]')
if sysupgrade.get_upgrade_state('dogtag', 'moved_crl_publish_dir'):
logger.info('CRL tree already moved')
return False
if not ca.is_configured():
logger.info('CA is not configured')
return False
try:
old_publish_dir = directivesetter.get_directive(
paths.CA_CS_CFG_PATH,
'ca.publish.publisher.instance.FileBaseCRLPublisher.directory',
separator='=')
except OSError as e:
logger.error('Cannot read CA configuration file "%s": %s',
paths.CA_CS_CFG_PATH, e)
return False
# Prepare target publish dir (creation, permissions, SELinux context)
# Run this every update to ensure proper values
publishdir = ca.prepare_crl_publish_dir()
if old_publish_dir == paths.PKI_CA_PUBLISH_DIR:
# publish dir is already updated
logger.info('Publish directory already set to new location')
sysupgrade.set_upgrade_state('dogtag', 'moved_crl_publish_dir', True)
return False
# Copy all CRLs to new directory
logger.info('Copy all CRLs to new publish directory')
try:
crl_files_unsorted = cainstance.get_crl_files(old_publish_dir)
except OSError as e:
logger.error('Cannot move CRL files to new directory: %s', e)
else:
# Move CRL files at the end of the list to make sure that the actual
# CRL files are copied first
crl_files = sorted(crl_files_unsorted,
key=lambda f: os.path.islink(f))
for f in crl_files:
try:
copy_crl_file(f)
except Exception as e:
logger.error('Cannot move CRL file to new directory: %s', e)
try:
directivesetter.set_directive(
paths.CA_CS_CFG_PATH,
'ca.publish.publisher.instance.FileBaseCRLPublisher.directory',
publishdir, quotes=False, separator='=')
except OSError as e:
logger.error('Cannot update CA configuration file "%s": %s',
paths.CA_CS_CFG_PATH, e)
return False
sysupgrade.set_upgrade_state('dogtag', 'moved_crl_publish_dir', True)
logger.info('CRL publish directory has been migrated, '
'request pki-tomcat restart')
return True
def ca_enable_pkix(ca):
logger.info('[Enable PKIX certificate path discovery and validation]')
if sysupgrade.get_upgrade_state('dogtag', 'pkix_enabled'):
logger.info('PKIX already enabled')
return False
if not ca.is_configured():
logger.info('CA is not configured')
return False
ca.enable_pkix()
sysupgrade.set_upgrade_state('dogtag', 'pkix_enabled', True)
return True
def add_ca_dns_records(bind):
logger.info('[Add missing CA DNS records]')
if sysupgrade.get_upgrade_state('dns', 'ipa_ca_records'):
logger.info('IPA CA DNS records already processed')
return False
ret = api.Command['dns_is_enabled']()
if not ret['result']:
logger.info('DNS is not configured')
sysupgrade.set_upgrade_state('dns', 'ipa_ca_records', True)
return False
bind.remove_ipa_ca_cnames(api.env.domain)
bind.update_system_records()
sysupgrade.set_upgrade_state('dns', 'ipa_ca_records', True)
return True
def find_subject_base():
"""
Try to find the current value of certificate subject base.
See the docstring in dsinstance.DsInstance for details.
"""
subject_base = dsinstance.DsInstance().find_subject_base()
if subject_base:
sysupgrade.set_upgrade_state(
'certmap.conf',
'subject_base',
subject_base
)
return subject_base
logger.error('Unable to determine certificate subject base. '
'certmap.conf will not be updated.')
return None
def uninstall_selfsign(ds, http):
logger.info('[Removing self-signed CA]')
"""Replace self-signed CA by a CA-less install"""
if api.env.ra_plugin != 'selfsign':
logger.debug('Self-signed CA is not installed')
return
logger.warning(
'Removing self-signed CA. Certificates will need to managed manually.')
p = SafeConfigParser()
p.read(paths.IPA_DEFAULT_CONF)
p.set('global', 'enable_ra', 'False')
p.set('global', 'ra_plugin', 'none')
with open(paths.IPA_DEFAULT_CONF, 'w') as f:
p.write(f)
ds.stop_tracking_certificates()
http.stop_tracking_certificates()
def uninstall_dogtag_9(ds, http):
logger.info('[Removing Dogtag 9 CA]')
if api.env.ra_plugin != 'dogtag':
logger.debug('Dogtag CA is not installed')
return
if api.env.dogtag_version >= 10:
logger.debug('Dogtag is version 10 or above')
return
dn = DN(('cn', 'CA'), ('cn', api.env.host), api.env.container_masters,
api.env.basedn)
try:
api.Backend.ldap2.delete_entry(dn)
except ipalib.errors.PublicError as e:
logger.error("Cannot delete %s: %s", dn, e)
p = SafeConfigParser()
p.read(paths.IPA_DEFAULT_CONF)
p.set('global', 'dogtag_version', '10')
with open(paths.IPA_DEFAULT_CONF, 'w') as f:
p.write(f)
sstore = sysrestore.StateFile(paths.SYSRESTORE)
sstore.restore_state('pkids', 'enabled')
sstore.restore_state('pkids', 'running')
sstore.restore_state('pkids', 'user_exists')
serverid = sstore.restore_state('pkids', 'serverid')
sstore.save()
ca = dogtaginstance.DogtagInstance(
api.env.realm, "CA", "certificate server",
nss_db=paths.VAR_LIB_PKI_CA_ALIAS_DIR)
ca.stop_tracking_certificates()
if serverid is not None:
# drop the trailing / off the config_dirname so the directory
# will match what is in certmonger
dirname = dsinstance.config_dirname(serverid)[:-1]
dsdb = certs.CertDB(api.env.realm, nssdir=dirname)
dsdb.untrack_server_cert("Server-Cert")
try:
services.service('pki-cad', api).disable('pki-ca')
except Exception as e:
logger.warning("Failed to disable pki-cad: %s", e)
try:
services.service('pki-cad', api).stop('pki-ca')
except Exception as e:
logger.warning("Failed to stop pki-cad: %s", e)
if serverid is not None:
try:
services.service('dirsrv', api).disable(serverid)
except Exception as e:
logger.warning("Failed to disable dirsrv: %s", e)
try:
services.service('dirsrv', api).stop(serverid)
except Exception as e:
logger.warning("Failed to stop dirsrv: %s", e)
http.restart()
def fix_schema_file_syntax():
"""Fix syntax errors in schema files
https://fedorahosted.org/freeipa/ticket/3578
"""
logger.info('[Fix DS schema file syntax]')
# This is not handled by normal schema updates, because pre-1.3.2 DS will
# ignore (auto-fix) these syntax errors, and 1.3.2 and above will choke on
# them before checking dynamic schema updates.
if sysupgrade.get_upgrade_state('ds', 'fix_schema_syntax'):
logger.info('Syntax already fixed')