Add a KRA to IPA

This patch adds the capability of installing a Dogtag KRA
to an IPA instance.  With this patch,  a KRA is NOT configured
by default when ipa-server-install is run.  Rather, the command
ipa-kra-install must be executed on an instance on which a Dogtag
CA has already been configured.

The KRA shares the same tomcat instance and DS instance as the
Dogtag CA.  Moreover, the same admin user/agent (and agent cert) can
be used for both subsystems.  Certmonger is also confgured to
monitor the new subsystem certificates.

To create a clone KRA, simply execute ipa-kra-install <replica_file>
on a replica on which a Dogtag CA has already been replicated.
ipa-kra-install will use the security domain to detect whether the
system being installed is a replica, and will error out if a needed
replica file is not provided.

The install scripts have been refactored somewhat to minimize
duplication of code.  A new base class dogtagintance.py has
been introduced containing code that is common to KRA and CA
installs.  This will become very useful when we add more PKI
subsystems.

The KRA will install its database as a subtree of o=ipaca,
specifically o=ipakra,o=ipaca.  This means that replication
agreements created to replicate CA data will also replicate KRA
data.  No new replication agreements are required.

Added dogtag plugin for KRA.  This is an initial commit providing
the basic vault functionality needed for vault.  This plugin will
likely be modified as we create the code to call some of these
functions.

Part of the work for: https://fedorahosted.org/freeipa/ticket/3872

The uninstallation option in ipa-kra-install is temporarily disabled.

Reviewed-By: Rob Crittenden <rcritten@redhat.com>
Reviewed-By: Petr Viktorin <pviktori@redhat.com>

1 files changed, 399 insertions, 0 deletions

diff --git a/ipaserver/install/dogtaginstance.py b/ipaserver/install/dogtaginstance.py
new file mode 100644
index 000000000..c872f3103
--- /dev/null
+++ b/ipaserver/install/dogtaginstance.py
@@ -0,0 +1,399 @@
+# Authors: Ade Lee <alee@redhat.com>
+#
+# Copyright (C) 2014  Red Hat
+# see file 'COPYING' for use and warranty information
+#
+# 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/>.
+#
+
+import base64
+import os
+import shutil
+import tempfile
+import traceback
+
+from pki.client import PKIConnection
+import pki.system
+
+from ipaplatform import services
+from ipaplatform.paths import paths
+from ipapython import certmonger
+from ipapython import dogtag
+from ipapython import ipaldap
+from ipapython import ipautil
+from ipapython.dn import DN
+from ipaserver.install import service
+from ipaserver.install import installutils
+from ipaserver.install.installutils import stopped_service
+from ipapython.ipa_log_manager import log_mgr
+
+DEFAULT_DSPORT = dogtag.install_constants.DS_PORT
+
+PKI_USER = "pkiuser"
+PKI_DS_USER = dogtag.install_constants.DS_USER
+
+
+def check_inst(subsystem):
+    """
+    Validate that the appropriate dogtag/RHCS packages have been installed.
+    """
+
+    # Check for a couple of binaries we need
+    if not os.path.exists(dogtag.install_constants.SPAWN_BINARY):
+        return False
+    if not os.path.exists(dogtag.install_constants.DESTROY_BINARY):
+        return False
+
+    if not os.path.exists(paths.PKI_CONF_SERVER_XML_TEMPLATE % subsystem):
+        return False
+
+    return True
+
+
+def get_security_domain():
+    """
+    Get the security domain from the REST interface on the local Dogtag CA
+    This function will succeed if the local dogtag CA is up.
+    """
+    connection = PKIConnection()
+    domain_client = pki.system.SecurityDomainClient(connection)
+    info = domain_client.get_security_domain_info()
+    return info
+
+
+def is_installing_replica(sys_type):
+    """
+    We expect only one of each type of Dogtag subsystem in an IPA deployment.
+    That means that if a subsystem of the specified type has already been
+    deployed - and therefore appears in the security domain - then we must be
+    installing a replica.
+    """
+    info = get_security_domain()
+    try:
+        sys_list = info.systems[sys_type]
+        return len(sys_list.hosts) > 0
+    except KeyError:
+        return False
+
+
+class DogtagInstance(service.Service):
+    """
+    This is the base class for a Dogtag 10+ instance, which uses a
+    shared tomcat instance and DS to host the relevant subsystems.
+
+    It contains functions that will be common to installations of the
+    CA, KRA, and eventually TKS and TPS.
+    """
+
+    def __init__(self, realm, subsystem, service_desc, dogtag_constants=None,
+                 host_name=None, dm_password=None, ldapi=True):
+        """Initializer"""
+
+        if dogtag_constants is None:
+            dogtag_constants = dogtag.configured_constants()
+
+        super(DogtagInstance, self).__init__(
+            '%sd' % dogtag_constants.PKI_INSTANCE_NAME,
+            service_desc=service_desc,
+            dm_password=dm_password,
+            ldapi=ldapi
+        )
+
+        self.dogtag_constants = dogtag_constants
+        self.realm = realm
+        self.dm_password = None
+        self.admin_password = None
+        self.fqdn = host_name
+        self.domain = None
+        self.pkcs12_info = None
+        self.clone = False
+
+        self.basedn = DN(('o', 'ipa%s' % subsystem.lower()))
+        self.admin_user = DN(('uid', 'admin'), ('ou', 'people'), ('o', 'ipaca'))
+        self.agent_db = tempfile.mkdtemp(prefix="tmp-")
+        self.ds_port = DEFAULT_DSPORT
+        self.server_root = dogtag_constants.SERVER_ROOT
+        self.subsystem = subsystem
+        self.security_domain_name = "IPA"
+        self.tracking_reqs = None
+
+        # replication parameters
+        self.master_host = None
+        self.master_replication_port = None
+        self.subject_base = None
+
+        self.log = log_mgr.get_logger(self)
+
+    def __del__(self):
+        shutil.rmtree(self.agent_db, ignore_errors=True)
+
+    def is_installed(self):
+        """
+        Determine if subsystem instance has been installed.
+
+        Returns True/False
+        """
+        return os.path.exists(os.path.join(
+            self.server_root, self.dogtag_constants.PKI_INSTANCE_NAME,
+            self.subsystem.lower()))
+
+    def spawn_instance(self, cfg_file, nolog_list=None):
+        """
+        Create and configure a new Dogtag instance using pkispawn.
+        Passes in a configuration file with IPA-specific
+        parameters.
+        """
+        subsystem = self.subsystem
+
+        # Define the things we don't want logged
+        if nolog_list is None:
+            nolog_list = []
+        nolog = tuple(nolog_list) + (self.admin_password, self.dm_password)
+
+        args = [paths.PKISPAWN,
+                "-s", subsystem,
+                "-f", cfg_file]
+
+        with open(cfg_file) as f:
+            self.log.debug(
+                'Contents of pkispawn configuration file (%s):\n%s',
+                cfg_file, ipautil.nolog_replace(f.read(), nolog))
+
+        try:
+            ipautil.run(args, nolog=nolog)
+        except ipautil.CalledProcessError, e:
+            self.log.critical("failed to configure %s instance %s",
+                              subsystem, e)
+            raise RuntimeError('Configuration of %s failed' % subsystem)
+
+    def enable(self):
+        self.backup_state("enabled", self.is_enabled())
+        # We do not let the system start IPA components on its own,
+        # Instead we reply on the IPA init script to start only enabled
+        # components as found in our LDAP configuration tree
+        # We need to install DS before we can actually ldap_enable a service.
+        # so actual enablement is delayed.
+
+    def restart_instance(self):
+        try:
+            self.restart(self.dogtag_constants.PKI_INSTANCE_NAME)
+        except Exception:
+            self.log.debug(traceback.format_exc())
+            self.log.critical(
+                "Failed to restart the Dogtag instance."
+                "See the installation log for details.")
+
+    def start_instance(self):
+        try:
+            self.start(self.dogtag_constants.PKI_INSTANCE_NAME)
+        except Exception:
+            self.log.debug(traceback.format_exc())
+            self.log.critical(
+                "Failed to restart the Dogtag instance."
+                "See the installation log for details.")
+
+    def stop_instance(self):
+        try:
+            self.stop(self.dogtag_constants.PKI_INSTANCE_NAME)
+        except Exception:
+            self.log.debug(traceback.format_exc())
+            self.log.critical(
+                "Failed to restart the Dogtag instance."
+                "See the installation log for details.")
+
+    def enable_client_auth_to_db(self, config):
+        """
+        Enable client auth connection to the internal db.
+        Path to CS.cfg config file passed in.
+        """
+
+        with stopped_service(
+                self.dogtag_constants.SERVICE_NAME,
+                instance_name=self.dogtag_constants.PKI_INSTANCE_NAME):
+            installutils.set_directive(
+                config,
+                'authz.instance.DirAclAuthz.ldap.ldapauth.authtype',
+                'SslClientAuth', quotes=False, separator='=')
+            installutils.set_directive(
+                config,
+                'authz.instance.DirAclAuthz.ldap.ldapauth.bindDN',
+                'uid=pkidbuser,ou=people,o=ipaca', quotes=False, separator='=')
+            installutils.set_directive(
+                config,
+                'authz.instance.DirAclAuthz.ldap.ldapauth.clientCertNickname',
+                'subsystemCert cert-pki-ca', quotes=False, separator='=')
+            installutils.set_directive(
+                config,
+                'authz.instance.DirAclAuthz.ldap.ldapconn.port',
+                str(dogtag.install_constants.DS_SECURE_PORT),
+                quotes=False, separator='=')
+            installutils.set_directive(
+                config,
+                'authz.instance.DirAclAuthz.ldap.ldapconn.secureConn',
+                'true', quotes=False, separator='=')
+
+            installutils.set_directive(
+                config,
+                'internaldb.ldapauth.authtype',
+                'SslClientAuth', quotes=False, separator='=')
+
+            installutils.set_directive(
+                config,
+                'internaldb.ldapauth.bindDN',
+                'uid=pkidbuser,ou=people,o=ipaca', quotes=False, separator='=')
+            installutils.set_directive(
+                config,
+                'internaldb.ldapauth.clientCertNickname',
+                'subsystemCert cert-pki-ca', quotes=False, separator='=')
+            installutils.set_directive(
+                config,
+                'internaldb.ldapconn.port',
+                str(dogtag.install_constants.DS_SECURE_PORT),
+                quotes=False, separator='=')
+            installutils.set_directive(
+                config,
+                'internaldb.ldapconn.secureConn', 'true', quotes=False,
+                separator='=')
+
+    def uninstall(self):
+        if self.is_installed():
+            self.print_msg("Unconfiguring %s" % self.subsystem)
+
+        try:
+            ipautil.run([paths.PKIDESTROY, "-i",
+                         self.dogtag_constants.PKI_INSTANCE_NAME,
+                         "-s", self.subsystem])
+        except ipautil.CalledProcessError, e:
+            self.log.critical("failed to uninstall %s instance %s",
+                              self.subsystem, e)
+
+    def http_proxy(self):
+        """ Update the http proxy file  """
+        template_filename = ipautil.SHARE_DIR + "ipa-pki-proxy.conf"
+        sub_dict = dict(
+            DOGTAG_PORT=self.dogtag_constants.AJP_PORT,
+            CLONE='' if self.clone else '#',
+            FQDN=self.fqdn,
+        )
+        template = ipautil.template_file(template_filename, sub_dict)
+        with open(paths.HTTPD_IPA_PKI_PROXY_CONF, "w") as fd:
+            fd.write(template)
+
+    def __get_pin(self):
+        try:
+            return certmonger.get_pin('internal',
+                                      dogtag_constants=self.dogtag_constants)
+        except IOError, e:
+            self.log.debug(
+                'Unable to determine PIN for the Dogtag instance: %s', e)
+            raise RuntimeError(e)
+
+    def configure_renewal(self, reqs=None):
+        """ Configure certmonger to renew system certs
+
+        @param reqs: list of nicknames and profiles
+        """
+        cmonger = services.knownservices.certmonger
+        cmonger.enable()
+        services.knownservices.messagebus.start()
+        cmonger.start()
+
+        pin = self.__get_pin()
+
+        if reqs is None:
+            reqs = self.tracking_reqs
+
+        for nickname, profile in reqs:
+            try:
+                certmonger.dogtag_start_tracking(
+                    ca='dogtag-ipa-ca-renew-agent',
+                    nickname=nickname,
+                    pin=pin,
+                    pinfile=None,
+                    secdir=self.dogtag_constants.ALIAS_DIR,
+                    pre_command='stop_pkicad',
+                    post_command='renew_ca_cert "%s"' % nickname,
+                    profile=profile)
+            except (ipautil.CalledProcessError, RuntimeError), e:
+                self.log.error(
+                    "certmonger failed to start tracking certificate: %s", e)
+
+    def stop_tracking_certificates(self, dogtag_constants, reqs=None):
+        """Stop tracking our certificates. Called on uninstall.
+        """
+        cmonger = services.knownservices.certmonger
+        services.knownservices.messagebus.start()
+        cmonger.start()
+
+        if reqs is None:
+            reqs = self.tracking_reqs
+
+        for nickname, _profile in reqs:
+            try:
+                certmonger.stop_tracking(
+                    dogtag_constants.ALIAS_DIR, nickname=nickname)
+            except (ipautil.CalledProcessError, RuntimeError), e:
+                self.log.error(
+                    "certmonger failed to stop tracking certificate: %s", e)
+
+        cmonger.stop()
+
+    @staticmethod
+    def update_cert_cs_cfg(nickname, cert, directives, cs_cfg,
+                           dogtag_constants=None):
+        """
+        When renewing a Dogtag subsystem certificate the configuration file
+        needs to get the new certificate as well.
+
+        nickname is one of the known nicknames.
+        cert is a DER-encoded certificate.
+        directives is the list of directives to be updated for the subsystem
+        cs_cfg is the path to the CS.cfg file
+        """
+
+        if dogtag_constants is None:
+            dogtag_constants = dogtag.configured_constants()
+
+        with stopped_service(dogtag_constants.SERVICE_NAME,
+                             instance_name=dogtag_constants.PKI_INSTANCE_NAME):
+            installutils.set_directive(
+                cs_cfg,
+                directives[nickname],
+                base64.b64encode(cert),
+                quotes=False,
+                separator='=')
+
+    def get_admin_cert(self):
+        """
+        Get the certificate for the admin user by checking the ldap entry
+        for the user.  There should be only one certificate per user.
+        """
+        self.log.debug('Trying to find the certificate for the admin user')
+        conn = None
+
+        try:
+            conn = ipaldap.IPAdmin(self.fqdn, self.ds_port)
+            conn.do_simple_bind(
+                DN(('cn', 'Directory Manager')),
+                self.dm_password)
+
+            entry_attrs = conn.get_entry(self.admin_user, ['usercertificate'])
+            admin_cert = entry_attrs.get('usercertificate')[0]
+
+            # TODO(edewata) Add check to warn if there is more than one cert.
+        finally:
+            if conn is not None:
+                conn.unbind()
+
+        return base64.b64encode(admin_cert)