path: root/base/server/src/pkispawn

#!/usr/bin/python -tu
# 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) 2011 Red Hat, Inc.
# All rights reserved.
#

# System Imports
import sys
import signal

if not hasattr(sys, "hexversion") or sys.hexversion < 0x020700f0:
    print "Python version %s.%s.%s is too old." % sys.version_info[:3]
    print "Please upgrade to at least Python 2.7.0."
    sys.exit(1)
try:
    import argparse
    import ldap
    import logging
    import os
    import requests
    import socket
    import struct
    import subprocess
    import time
    import urllib2
    import traceback
    from time import strftime as date
    from pki.deployment import pkiconfig as config
    from pki.deployment.pkiparser import PKIConfigParser
    from pki.deployment import pkilogging
    from pki.deployment import pkimessages as log
except ImportError:
    print >> sys.stderr, """\
There was a problem importing one of the required Python modules. The
error was:

    %s
""" % sys.exc_value
    sys.exit(1)

# Handle the Keyboard Interrupt
def interrupt_handler(signal, frame):
    print
    print '\nInstallation canceled.'
    sys.exit(1)

# PKI Deployment Functions
def main(argv):
    "main entry point"

    config.pki_deployment_executable = os.path.basename(argv[0])

    # Only run this program as "root".
    if not os.geteuid() == 0:
        sys.exit("'%s' must be run as root!" % argv[0])

    # Set the umask
    os.umask(config.PKI_DEPLOYMENT_DEFAULT_UMASK)

    # Set installation time
    ticks = time.time()
    config.pki_install_time = time.asctime(time.localtime(ticks))

    # Generate a timestamp
    config.pki_timestamp = date('%Y%m%d%H%M%S', time.localtime(ticks))
    config.pki_certificate_timestamp = \
        date('%Y-%m-%d %H:%M:%S', time.localtime(ticks))

    # Obtain the architecture bit-size
    config.pki_architecture = struct.calcsize("P") * 8

    # Retrieve hostname
    config.pki_hostname = socket.getfqdn()

    # Retrieve DNS domainname
    config.pki_dns_domainname = None
    try:
        config.pki_dns_domainname = subprocess.check_output("dnsdomainname",
                                                            shell = True)
        config.pki_dns_domainname = config.pki_dns_domainname.rstrip('\n')
        if not len(config.pki_dns_domainname):
            print log.PKI_DNS_DOMAIN_NOT_SET
            sys.exit(1)
    except subprocess.CalledProcessError as exc:
        print log.PKI_SUBPROCESS_ERROR_1 % exc
        sys.exit(1)

    # Read and process command-line arguments.
    parser = PKIConfigParser(
        'PKI Instance Installation and Configuration',
        log.PKISPAWN_EPILOG)

    parser.optional.add_argument('-f',
        dest='user_deployment_cfg', action='store',
        nargs=1, metavar='<file>',
        help='configuration filename '
            '(MUST specify complete path)')

    args = parser.process_command_line_arguments(argv)

    config.default_deployment_cfg = config.PKI_DEPLOYMENT_DEFAULT_CONFIGURATION_FILE

    # -f <user deployment config>
    if args.user_deployment_cfg is not None:
        config.user_deployment_cfg = str(args.user_deployment_cfg).strip('[\']')

    parser.validate()
    interactive = False

    while True:

        # -s <subsystem>
        if args.pki_subsystem is None:
            interactive = True
            parser.indent = 0

            config.pki_subsystem = parser.read_text('Subsystem (CA/KRA/OCSP/TKS)',
                options=['CA', 'KRA', 'OCSP', 'TKS'],
                default='CA', caseSensitive=False).upper()
            print
        else:
            config.pki_subsystem = str(args.pki_subsystem).strip('[\']')

        parser.init_config()

        if config.user_deployment_cfg is None:
            interactive = True
            parser.indent = 2

            print "Tomcat:"
            parser.read_text('Instance', 'DEFAULT', 'pki_instance_name')
            parser.read_text('HTTP port', config.pki_subsystem, 'pki_http_port')
            parser.read_text('Secure HTTP port', config.pki_subsystem, 'pki_https_port')
            parser.read_text('AJP port', config.pki_subsystem, 'pki_ajp_port')
            parser.read_text('Management port', config.pki_subsystem, 'pki_tomcat_server_port')
            print

            print "Administrator:"
            parser.read_text('Username', config.pki_subsystem, 'pki_admin_uid')

            admin_password = parser.read_password(
                'Password', config.pki_subsystem, 'pki_admin_password',
                verifyMessage='Verify password')

            parser.set_property(config.pki_subsystem, 'pki_backup_password', admin_password)
            parser.set_property(config.pki_subsystem, 'pki_client_database_password', admin_password)
            parser.set_property(config.pki_subsystem, 'pki_client_pkcs12_password', admin_password)

            if config.pki_master_dict['pki_import_admin_cert'] == 'True':
                import_cert = 'Y'
            else:
                import_cert = 'N'

            import_cert = parser.read_text('Import certificate (Yes/No)',
                default=import_cert, options=['Yes', 'Y', 'No', 'N'],
                sign='?', caseSensitive=False).lower()

            if import_cert == 'y' or import_cert == 'yes':
                parser.set_property(config.pki_subsystem, 'pki_import_admin_cert', 'True')
                parser.read_text('Import certificate from', config.pki_subsystem, 'pki_admin_cert_file')
            else:
                parser.set_property(config.pki_subsystem, 'pki_import_admin_cert', 'False')

            parser.read_text('Export certificate to', config.pki_subsystem, 'pki_client_admin_cert')
            print

            print "Directory Server:"
            while True:
                parser.read_text('Hostname', config.pki_subsystem, 'pki_ds_hostname')
                parser.read_text('Port', config.pki_subsystem, 'pki_ds_ldap_port')

                try:
                    parser.ds_connect()
                    break

                except ldap.LDAPError as e:
                    parser.print_text('ERROR: ' + e.message['desc'])

            while True:
                parser.read_text('Bind DN', config.pki_subsystem, 'pki_ds_bind_dn')
                parser.read_password('Password', config.pki_subsystem, 'pki_ds_password')

                try:
                    parser.ds_bind()
                    break

                except ldap.LDAPError as e:
                    parser.print_text('ERROR: ' + e.message['desc'])

            while True:
                parser.read_text('Base DN', config.pki_subsystem, 'pki_ds_base_dn')
                try:
                    if not parser.ds_base_dn_exists():
                        break

                except ldap.LDAPError as e:
                    parser.print_text('ERROR: ' + e.message['desc'])
                    continue

                remove = parser.read_text('Base DN already exists. Overwrite (Yes/No/Quit)',
                    options=['Yes', 'Y', 'No', 'N', 'Quit', 'Q'],
                    sign='?', allowEmpty=False, caseSensitive=False).lower()

                if remove == 'q' or remove == 'quit':
                    print "Installation canceled."
                    sys.exit(0)

                if remove == 'y' or remove == 'yes':
                    break

            parser.ds_close()

            print

            print "Security Domain:"

            if config.pki_subsystem == "CA":
                parser.read_text('Name', config.pki_subsystem, 'pki_security_domain_name')

            else:
                while True:
                    parser.read_text('Hostname', config.pki_subsystem, 'pki_security_domain_hostname')
                    parser.read_text('Secure HTTP port', config.pki_subsystem, 'pki_security_domain_https_port')

                    try:
                        parser.sd_connect()
                        info = parser.sd_get_info()
                        parser.print_text('Name: ' + info.name)
                        parser.set_property(config.pki_subsystem, 'pki_security_domain_name', info.name)
                        break
                    except requests.exceptions.ConnectionError as e:
                        parser.print_text('ERROR: ' + str(e))

                while True:
                    parser.read_text('Username', config.pki_subsystem, 'pki_security_domain_user')
                    parser.read_password('Password', config.pki_subsystem, 'pki_security_domain_password')

                    try:
                        parser.sd_authenticate()
                        break
                    except requests.exceptions.HTTPError as e:
                        parser.print_text('ERROR: ' + str(e))

            print

        if interactive:
            parser.indent = 0

            begin = parser.read_text('Begin installation (Yes/No/Quit)',
                options=['Yes', 'Y', 'No', 'N', 'Quit', 'Q'],
                sign='?', allowEmpty=False, caseSensitive=False).lower()
            print

            if begin == 'q' or begin == 'quit':
                print "Installation canceled."
                sys.exit(0)

            if begin == 'y' or begin == 'yes':
                break

        else:
            break

    if not os.path.exists(config.PKI_DEPLOYMENT_SOURCE_ROOT + \
                          "/" + config.pki_subsystem.lower()):
        print "ERROR:  " + log.PKI_SUBSYSTEM_NOT_INSTALLED_1 % \
            config.pki_subsystem.lower()
        sys.exit(1)

    # Enable 'pkispawn' logging.
    rv = 0
    config.pki_log_dir = config.pki_root_prefix + \
                         config.PKI_DEPLOYMENT_LOG_ROOT
    config.pki_log_name = "pki" + "-" + \
                          config.pki_subsystem.lower() + \
                          "-" + "spawn" + "." + \
                          config.pki_timestamp + "." + "log"
    rv = pkilogging.enable_pki_logger(config.pki_log_dir,
                                      config.pki_log_name,
                                      config.pki_log_level,
                                      config.pki_console_log_level,
                                      "pkispawn")
    if rv != OSError:
        config.pki_log = rv
    else:
        print log.PKI_UNABLE_TO_CREATE_LOG_DIRECTORY_1 % config.pki_log_dir
        sys.exit(1)

    # Read the specified PKI configuration file.
    rv = parser.read_pki_configuration_file()
    if rv != 0:
        config.pki_log.error(log.PKI_UNABLE_TO_PARSE_1, rv,
                             extra=config.PKI_INDENTATION_LEVEL_0)
        sys.exit(1)

    # Read in the PKI slots configuration file.
    parser.compose_pki_slots_dictionary()
    config.pki_log.debug(log.PKI_DICTIONARY_SLOTS,
                         extra=config.PKI_INDENTATION_LEVEL_0)
    config.pki_log.debug(pkilogging.format(config.pki_slots_dict),
                         extra=config.PKI_INDENTATION_LEVEL_0)

    # Combine the various sectional dictionaries into a PKI master dictionary
    parser.compose_pki_master_dictionary()

    config.pki_master_dict['pki_spawn_log'] = config.pki_log_dir + "/" + \
                                              config.pki_log_name
    config.pki_log.debug(log.PKI_DICTIONARY_MASTER,
                         extra=config.PKI_INDENTATION_LEVEL_0)
    config.pki_log.debug(pkilogging.format(config.pki_master_dict),
                         extra=config.PKI_INDENTATION_LEVEL_0)

    if not interactive and\
        not config.str2bool(config.pki_master_dict['pki_skip_configuration']):
        try:
            parser.ds_connect()
            parser.ds_bind()

            if parser.ds_base_dn_exists() and\
                not config.str2bool(config.pki_master_dict['pki_ds_remove_data']):
                print 'ERROR:  Base DN already exists.'
                sys.exit(1)

            parser.ds_close()

        except ldap.LDAPError as e:
            print 'ERROR:  Unable to access directory server: ' + e.message['desc']
            sys.exit(1)

        if config.pki_subsystem != "CA" or\
            config.str2bool(config.pki_master_dict['pki_clone']) or\
            config.str2bool(config.pki_master_dict['pki_subordinate']):
            try:
                parser.sd_connect()
                info = parser.sd_get_info()
                parser.set_property(config.pki_subsystem, 'pki_security_domain_name', info.name)
                parser.sd_authenticate()

            except requests.exceptions.ConnectionError as e:
                print('ERROR:  Unable to access security domain: ' + str(e))
                sys.exit(1)

            except requests.exceptions.HTTPError as e:
                print('ERROR:  Unable to access security domain: ' + str(e))
                sys.exit(1)

    print "Installing " + config.pki_subsystem + " into " + config.pki_master_dict['pki_instance_path'] + "."

    # Process the various "scriptlets" to create the specified PKI subsystem.
    pki_subsystem_scriptlets = config.pki_master_dict['spawn_scriplets'].split()
    rv = 0
    for pki_scriptlet in pki_subsystem_scriptlets:
        scriptlet = __import__("pki.deployment." +
                               pki_scriptlet,
                               fromlist=[pki_scriptlet])
        instance = scriptlet.PkiScriptlet()
        try:
            rv = instance.spawn()
        except:
            log_error_details()
            print
            print "Installation failed."
            print
            sys.exit(1)
        if rv != 0:
            print "Installation failed."
            sys.exit(1)
    config.pki_log.debug(log.PKI_DICTIONARY_MASTER,
                         extra=config.PKI_INDENTATION_LEVEL_0)
    config.pki_log.debug(pkilogging.format(config.pki_master_dict),
                         extra=config.PKI_INDENTATION_LEVEL_0)

    print_install_information()

def print_install_information():

    skip_configuration = config.str2bool(config.pki_master_dict['pki_skip_configuration'])
    print log.PKI_SPAWN_INFORMATION_HEADER
    if skip_configuration:
        print log.PKI_CONFIGURATION_URL_1 % config.pki_master_dict['pki_configuration_url']
        print
        print log.PKI_CONFIGURATION_RESTART_1 % \
              config.pki_master_dict['pki_registry_initscript_command']
    else:
        print "    Admin username: %s" % config.pki_master_dict['pki_admin_uid']
        if not config.str2bool(config.pki_master_dict['pki_client_database_purge']):
            print "    Location of client database: %s" % config.pki_master_dict['pki_client_database_dir']
        print "    Client certificate nickname: %s" % config.pki_master_dict['pki_admin_nickname']
        print log.PKI_CHECK_STATUS_MESSAGE % config.pki_master_dict['pki_instance_name']
        print log.PKI_INSTANCE_RESTART_MESSAGE % config.pki_master_dict['pki_instance_name']
        print log.PKI_ACCESS_URL % (config.pki_master_dict['pki_hostname'],
                                    config.pki_master_dict['pki_https_port'],
                                    config.pki_subsystem.lower())
    print log.PKI_SPAWN_INFORMATION_FOOTER

def log_error_details():
        type, value, stacktrace = sys.exc_info()
        config.pki_log.debug("Error Type: " + type.__name__, extra=config.PKI_INDENTATION_LEVEL_2)
        config.pki_log.debug("Error Message: " + str(value), extra=config.PKI_INDENTATION_LEVEL_2)
        stacktrace_list = traceback.format_list(traceback.extract_tb(stacktrace))
        stacktrace = ""
        for l in stacktrace_list:
            stacktrace += l
        config.pki_log.debug(stacktrace, extra=config.PKI_INDENTATION_LEVEL_2)
        sys.exc_clear()

# PKI Deployment Entry Point
if __name__ == "__main__":
    signal.signal(signal.SIGINT, interrupt_handler)
    main(sys.argv)