summaryrefslogtreecommitdiffstats
path: root/base/server/src/scriptlets/configuration.py
blob: 7bd1b017a8bef03aa584160912ed50546295a88a (plain)
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
#!/usr/bin/python -t
# Authors:
#     Matthew Harmsen <mharmsen@redhat.com>
#
# 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; version 2 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright (C) 2012 Red Hat, Inc.
# All rights reserved.
#

# PKI Deployment Imports
import pkiconfig as config
from pkiconfig import pki_master_dict as master
import pkihelper as util
import pkimessages as log
import pkiscriptlet
import json
import pki.system
import pki.encoder


# PKI Deployment Configuration Scriptlet
class PkiScriptlet(pkiscriptlet.AbstractBasePkiScriptlet):
    rv = 0

    def spawn(self):
        if config.str2bool(master['pki_skip_configuration']):
            config.pki_log.info(log.SKIP_CONFIGURATION_SPAWN_1, __name__,
                                extra=config.PKI_INDENTATION_LEVEL_1)
            return self.rv
        config.pki_log.info(log.CONFIGURATION_SPAWN_1, __name__,
                            extra=config.PKI_INDENTATION_LEVEL_1)

        # Place "slightly" less restrictive permissions on
        # the top-level client directory ONLY
        util.directory.create(master['pki_client_subsystem_dir'],
            uid=0, gid=0,
            perms=config.PKI_DEPLOYMENT_DEFAULT_CLIENT_DIR_PERMISSIONS)
        # Since 'certutil' does NOT strip the 'token=' portion of
        # the 'token=password' entries, create a client password file
        # which ONLY contains the 'password' for the purposes of
        # allowing 'certutil' to generate the security databases
        util.password.create_password_conf(
            master['pki_client_password_conf'],
            master['pki_client_database_password'], pin_sans_token=True)
        util.file.modify(master['pki_client_password_conf'],
                         uid=0, gid=0)
        # Similarly, create a simple password file containing the
        # PKCS #12 password used when exporting the "Admin Certificate"
        # into a PKCS #12 file
        util.password.create_client_pkcs12_password_conf(
            master['pki_client_pkcs12_password_conf'])
        util.file.modify(master['pki_client_pkcs12_password_conf'])
        util.directory.create(master['pki_client_database_dir'],
                              uid=0, gid=0)
        util.certutil.create_security_databases(
            master['pki_client_database_dir'],
            master['pki_client_cert_database'],
            master['pki_client_key_database'],
            master['pki_client_secmod_database'],
            password_file=master['pki_client_password_conf'])
        util.symlink.create(master['pki_systemd_service'],
                            master['pki_systemd_service_link'])

        # Start/Restart this Apache/Tomcat PKI Process
        if master['pki_subsystem'] in config.PKI_APACHE_SUBSYSTEMS:
            apache_instance_subsystems =\
                util.instance.apache_instance_subsystems()
            if apache_instance_subsystems == 1:
                util.systemd.start()
            elif apache_instance_subsystems > 1:
                util.systemd.restart()
        elif master['pki_subsystem'] in config.PKI_TOMCAT_SUBSYSTEMS:
            # Optionally prepare to enable a java debugger
            # (e. g. - 'eclipse'):
            if config.str2bool(master['pki_enable_java_debugger']):
                config.prepare_for_an_external_java_debugger(
                    master['pki_target_tomcat_conf_instance_id'])
            tomcat_instance_subsystems =\
                len(util.instance.tomcat_instance_subsystems())
            if tomcat_instance_subsystems == 1:
                util.systemd.start()
            elif tomcat_instance_subsystems > 1:
                util.systemd.restart()

        # wait for startup
        status = util.instance.wait_for_startup(60)
        if status == None:
            config.pki_log.error("server failed to restart",
                    extra=config.PKI_INDENTATION_LEVEL_2)
            sys.exit(1)

        # Optionally wait for debugger to attach (e. g. - 'eclipse'):
        if config.str2bool(master['pki_enable_java_debugger']):
            config.wait_to_attach_an_external_java_debugger()

        config_client = util.config_client()
        # Construct PKI Subsystem Configuration Data
        data = None
        if master['pki_instance_type'] == "Apache":
            if master['pki_subsystem'] == "RA":
                config.pki_log.info(log.PKI_CONFIG_NOT_YET_IMPLEMENTED_1,
                    master['pki_subsystem'],
                    extra=config.PKI_INDENTATION_LEVEL_2)
                return rv
        elif master['pki_subsystem'] == "TPS":
                config.pki_log.info(log.PKI_CONFIG_NOT_YET_IMPLEMENTED_1,
                    master['pki_subsystem'],
                    extra=config.PKI_INDENTATION_LEVEL_2)
                return rv
        elif master['pki_instance_type'] == "Tomcat":
            # CA, KRA, OCSP, or TKS
            data = config_client.construct_pki_configuration_data()
        
        # Configure the substem
        config_client.configure_pki_data(
            json.dumps(data, cls=pki.encoder.CustomTypeEncoder))

        return self.rv

    def respawn(self):
        config.pki_log.info(log.CONFIGURATION_RESPAWN_1, __name__,
                            extra=config.PKI_INDENTATION_LEVEL_1)
        return self.rv

    def destroy(self):
        config.pki_log.info(log.CONFIGURATION_DESTROY_1, __name__,
                            extra=config.PKI_INDENTATION_LEVEL_1)
        if master['pki_subsystem'] in config.PKI_APACHE_SUBSYSTEMS and\
           util.instance.apache_instance_subsystems() == 1:
            if util.directory.exists(master['pki_client_dir']):
                util.directory.delete(master['pki_client_dir'])
            util.symlink.delete(master['pki_systemd_service_link'])
        elif master['pki_subsystem'] in config.PKI_TOMCAT_SUBSYSTEMS and\
             len(util.instance.tomcat_instance_subsystems()) == 1:
            if util.directory.exists(master['pki_client_dir']):
                util.directory.delete(master['pki_client_dir'])
            util.symlink.delete(master['pki_systemd_service_link'])
        return self.rv