Implement an IPA Foreman smartproxy server

This currently server supports only host and hostgroup commands for
retrieving, adding and deleting entries.

The incoming requests are completely unauthenticated and by default
requests must be local.

Utilize GSS-Proxy to manage the TGT.

Configuration information is in the ipa-smartproxy man page.

Design: http://www.freeipa.org/page/V3/Smart_Proxy

https://fedorahosted.org/freeipa/ticket/4128

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

10 files changed, 773 insertions, 0 deletions

diff --git a/smartproxy/Makefile.am b/smartproxy/Makefile.am
new file mode 100644
index 000000000..f79aecfc3
--- /dev/null
+++ b/smartproxy/Makefile.am
@@ -0,0 +1,45 @@
+# This file will be processed with automake-1.7 to create Makefile.in
+
+AUTOMAKE_OPTIONS = 1.7
+
+NULL =
+
+etcdir = $(IPA_SYSCONF_DIR)
+etc_DATA =			\
+	ipa-smartproxy.conf	\
+	$(NULL)
+
+appdir = $(IPA_DATA_DIR)/smartproxy
+app_DATA =			\
+	ipa-smartproxy.py	\
+	$(NULL)
+
+rotatedir = $(LOGROTATE_DIR)
+rotate_DATA =			\
+	ipa-smartproxy.logrotate	\
+	$(NULL)
+
+SUBDIRS =			\
+	man			\
+	$(NULL)
+
+EXTRA_DIST =			\
+	$(app_DATA)		\
+	$(etc_DATA)		\
+	$(rotate_DATA)		\
+	$(NULL)
+
+DISTCLEANFILES =		\
+	$(NULL)
+
+MAINTAINERCLEANFILES =		\
+	*~			\
+	aclocal.m4		\
+	configure		\
+	install-sh		\
+	missing			\
+	Makefile.in		\
+	$(NULL)
+
+install-data-hook:
+	mv $(DESTDIR)/$(LOGROTATE_DIR)/ipa-smartproxy.logrotate $(DESTDIR)/$(LOGROTATE_DIR)/ipa-smartproxy
diff --git a/smartproxy/configure.ac b/smartproxy/configure.ac
new file mode 100644
index 000000000..5908a7f13
--- /dev/null
+++ b/smartproxy/configure.ac
@@ -0,0 +1,75 @@
+AC_PREREQ(2.59)
+m4_include(../version.m4)
+AC_INIT([ipa-server],
+        IPA_VERSION,
+        [https://hosted.fedoraproject.org/projects/freeipa/newticket])
+
+AM_INIT_AUTOMAKE([foreign])
+
+AM_MAINTAINER_MODE
+
+AC_SUBST(VERSION)
+AC_SUBST([INSTALL_DATA], ['$(INSTALL) -m 644 -p'])
+
+AC_PROG_MKDIR_P
+AC_PROG_AWK
+AC_PROG_SED
+
+AC_PATH_PROG(XGETTEXT, xgettext, [no])
+if test "x$XGETTEXT" = "xno"; then
+    AC_MSG_ERROR([xgettext not found, install gettext])
+fi
+
+AC_PATH_PROG(MSGFMT, msgfmt, [no])
+if test "x$MSGFMT" = "xno"; then
+    AC_MSG_ERROR([msgfmt not found, install gettext])
+fi
+
+AC_PATH_PROG(MSGINIT, msginit, [no])
+if test "x$MSGINIT" = "xno"; then
+    AC_MSG_ERROR([msginit not found, install gettext])
+fi
+
+AC_PATH_PROG(MSGMERGE, msgmerge, [no])
+if test "x$MSGMERGE" = "xno"; then
+    AC_MSG_ERROR([msgmerge not found, install gettext])
+fi
+
+AC_PATH_PROG(MSGCMP, msgcmp, [no])
+if test "x$MSGCMP" = "xno"; then
+    AC_MSG_ERROR([msgcmp not found, install gettext])
+fi
+
+AC_PATH_PROG(MSGATTRIB, msgattrib, [no])
+if test "x$MSGATTRIB" = "xno"; then
+    AC_MSG_ERROR([msgattrib not found, install gettext])
+fi
+
+AC_PATH_PROG(TX, tx, [/usr/bin/tx])
+
+AC_ARG_WITH([gettext_domain],
+  [AS_HELP_STRING([--with-gettext-domain=name],
+    [set the name of the i18n message catalog])],
+  [],
+  [with_gettext_domain=ipa])
+AC_SUBST(GETTEXT_DOMAIN, $with_gettext_domain)
+
+dnl ---------------------------------------------------------------------------
+dnl - Set the data install directory since we don't use pkgdatadir
+dnl ---------------------------------------------------------------------------
+
+IPA_DATA_DIR="$datadir/ipa"
+IPA_SYSCONF_DIR="$sysconfdir/ipa"
+LOGROTATE_DIR="$sysconfdir/logrotate.d"
+AC_SUBST(IPA_DATA_DIR)
+AC_SUBST(IPA_SYSCONF_DIR)
+AC_SUBST(LOGROTATE_DIR)
+
+# Files
+
+AC_CONFIG_FILES([
+    Makefile
+    man/Makefile
+])
+
+AC_OUTPUT
diff --git a/smartproxy/ipa-smartproxy-apache.conf b/smartproxy/ipa-smartproxy-apache.conf
new file mode 100644
index 000000000..53a62691f
--- /dev/null
+++ b/smartproxy/ipa-smartproxy-apache.conf
@@ -0,0 +1,30 @@
+Listen 8090
+
+<VirtualHost *:8090>
+
+    WSGIDaemonProcess smartproxy user=smartproxy processes=2 threads=1
+    WSGIProcessGroup smartproxy
+
+    WSGIScriptAlias /realm /usr/share/ipa/smartproxy/ipa-smartproxy.py
+    WSGIScriptAlias /features /usr/share/ipa/smartproxy/ipa-smartproxy.py
+    WSGIScriptAlias /ipa/smartproxy /usr/share/ipa/smartproxy/ipa-smartproxy.py
+
+    <Location "/realm">
+      Satisfy Any
+      Order Deny,Allow
+      Allow from all
+    </Location>
+
+    <Location "/features">
+      Satisfy Any
+      Order Deny,Allow
+      Allow from all
+    </Location>
+
+    <Location "/ipa/smartproxy">
+      Satisfy Any
+      Order Deny,Allow
+      Allow from all
+    </Location>
+
+</VirtualHost>
diff --git a/smartproxy/ipa-smartproxy.conf b/smartproxy/ipa-smartproxy.conf
new file mode 100644
index 000000000..30081e279
--- /dev/null
+++ b/smartproxy/ipa-smartproxy.conf
@@ -0,0 +1,14 @@
+[global]
+server.socket_port: 8090
+#server.socket_host: 'server.example.com'
+
+request.show_tracebacks: False
+
+# Only handle requests on 127.0.0.1 or ::1
+local_only: True
+
+# Use gssproxy to manage the ccache
+use_gssproxy: True
+
+# Remove assocaited DNS entries when deleting a host
+remove_dns: False
diff --git a/smartproxy/ipa-smartproxy.logrotate b/smartproxy/ipa-smartproxy.logrotate
new file mode 100644
index 000000000..12e25164c
--- /dev/null
+++ b/smartproxy/ipa-smartproxy.logrotate
@@ -0,0 +1,11 @@
+/var/log/ipa-smartproxy.access /var/log/ipa-smartproxy.errors {
+    weekly
+    missingok
+    notifempty
+    sharedscripts
+    rotate 52
+    compress
+    postrotate
+        /bin/systemctl reload ipa-smartproxy.service > /dev/null 2>/dev/null || true
+    endscript
+}
diff --git a/smartproxy/ipa-smartproxy.py b/smartproxy/ipa-smartproxy.py
new file mode 100644
index 000000000..23788ecf5
--- /dev/null
+++ b/smartproxy/ipa-smartproxy.py
@@ -0,0 +1,400 @@
+#!/usr/bin/python2 -E
+#
+# Authors:
+#   Rob Crittenden <rcritten@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 sys
+sys.stdout = sys.stderr
+
+import cherrypy
+import os
+import json
+from functools import wraps
+import traceback as tb_internal
+from cherrypy import response
+from ipalib import api
+from ipalib import errors
+from ipalib.request import context
+from ipaserver.rpcserver import json_encode_binary
+from ipapython.version import VERSION, API_VERSION
+from ipapython.ipa_log_manager import root_logger
+
+
+def jsonout(func):
+    '''JSON output decorator'''
+    @wraps(func)
+    def wrapper(*args, **kw):
+        value = func(*args, **kw)
+        response.headers["Content-Type"] = "application/json;charset=utf-8"
+        data = json_encode_binary(value, version=API_VERSION)
+        return json.dumps(data, sort_keys=True, indent=2)
+
+    return wrapper
+
+
+def handle_error(status, message, traceback, version):
+    """
+    Return basic messages to user and log backtrace in case of 500
+    error.
+    """
+    if status.startswith('500'):
+        root_logger.error(message)
+        root_logger.error(tb_internal.format_exc())
+
+    resp = cherrypy.response
+    resp.headers['Content-Type'] = 'application/json'
+    return json.dumps({'status': status, 'message': message})
+
+
+def convert_unicode(value):
+    """
+    IPA requires all incoming values to be unicode. Recursively
+    convert the values.
+    """
+    if not isinstance(value, basestring):
+        return value
+
+    if value is not None:
+        return unicode(value)
+    else:
+        return None
+
+
+def raise_rest_exception(e):
+    """
+    Raise a REST-specific exception.
+    """
+    try:
+        raise e
+    except (errors.DuplicateEntry, errors.DNSNotARecordError,
+            errors.ValidationError, errors.ConversionError,) as e:
+        raise IPAError(
+            status=400,
+            message=e
+        )
+    except errors.ACIError as e:
+        raise IPAError(
+            status=401,
+            message=e
+        )
+    except errors.NotFound as e:
+        raise IPAError(
+            status=404,
+            message=e
+        )
+    except Exception as e:
+        raise IPAError(
+            status=500,
+            message=e
+        )
+
+
+def popifnone(params, option):
+    """
+    If option, a string, exists in params, a dict, and is None then
+    remove it from the dict.
+
+    No return value. The dict is updated in-place if necessary.
+    """
+    if params.get(option) is None:
+        params.pop(option, None)
+
+
+def Command(command, *args, **options):
+    """
+    Execute an IPA command with the given arguments and options.
+
+    This doesn't care what the options are, it passes them along to
+    the IPA API. The exceptions are:
+
+    :param nomaskexceptions: boolean to decide if we raise the real IPA
+                             exception or a REST-specific exceptioon.
+    """
+    if (cherrypy.request.config.get('local_only', False) and
+       cherrypy.request.remote.ip not in ['::1', '127.0.0.1']):
+        raise IPAError(
+            status=401,
+            message="Not a local request"
+        )
+
+    try:
+        if not api.Backend.rpcclient.isconnected():
+            api.Backend.rpcclient.connect()
+    except errors.CCacheError as e:
+        root_logger.info('Connection failed: %s', e)
+        raise IPAError(
+            status=401,
+            message=e
+        )
+
+    # IPA wants all its strings as unicode
+    args = map(lambda v: convert_unicode(v), args)
+    options = dict(zip(options, map(convert_unicode, options.values())))
+
+    nomaskexception = options.pop('nomaskexception', False)
+
+    api.Command[command].args_options_2_params(*args, **options)
+    try:
+        return api.Command[command](*args, **options)['result']
+    except Exception as e:
+        if not nomaskexception:
+            raise_rest_exception(e)
+        else:
+            # The caller needs to be able to handle IPA-specific
+            # exceptions.
+            raise e
+
+
+@jsonout
+def GET(command, *args, **options):
+    return Command(command, *args, **options)
+
+
+@jsonout
+def POST(status, command, *args, **options):
+    cherrypy.response.status = status
+    return Command(command, *args, **options)
+
+
+@jsonout
+def DELETE(command, *args, **options):
+    return Command(command, *args, **options)
+
+
+class IPAError(cherrypy.HTTPError):
+    """
+    Return errors in IPA-style json.
+
+    Local errors are treated as strings so do not include the code and
+    name attributes within the error dict.
+
+    This is not padded for IE.
+    """
+
+    def set_response(self):
+        response = cherrypy.serving.response
+
+        cherrypy._cperror.clean_headers(self.code)
+
+        # In all cases, finalize will be called after this method,
+        # so don't bother cleaning up response values here.
+        response.status = self.status
+
+        if isinstance(self._message, Exception):
+            try:
+                code = self._message.errno
+            except AttributeError:
+                code = 0
+            error = {'code': code,
+                     'message': self._message.message,
+                     'name': self._message.__class__.__name__}
+        elif isinstance(self._message, basestring):
+            error = {'message': self._message}
+        else:
+            error = {'message':
+                     'Unable to handle error message type %s' %
+                     type(self._message)}
+
+        principal = getattr(context, 'principal', None)
+        response.headers["Content-Type"] = "application/json;charset=utf-8"
+        response.body = json.dumps({'error': error,
+                                    'id': 0,
+                                    'principal': principal,
+                                    'result': None,
+                                    'version': VERSION},
+                                    sort_keys=True, indent=2)
+
+
+class Host(object):
+    """
+    Manage IPA host objects
+    """
+
+    exposed = True
+
+    def GET(self, fqdn=None):
+
+        if fqdn is None:
+            command = 'host_find'
+        else:
+            command = 'host_show'
+
+        return GET(command, fqdn)
+
+    def POST(self, hostname, description=None,
+             macaddress=None, userclass=None, ip_address=None,
+             password=None, rebuild=None):
+        cmd = 'host_add'
+
+        if password is None:
+            random = True
+        else:
+            random = False
+
+        params = {'description' : description,
+                  'random' : random,
+                  'macaddress' : macaddress,
+                  'userclass' : userclass,
+                  'userpassword' : password}
+
+        # If the host is being rebuilt, disable it in order to revoke
+        # existing certs, keytabs, etc.
+        try:
+            Command('host_show', hostname, nomaskexception=True)
+        except errors.NotFound:
+            # Adding a new host
+            status = 201
+            params['ip_address'] = ip_address
+            params['force'] = True
+        except Exception as e:
+            raise_rest_exception(e)
+        else:
+            if ip_address is not None:
+                raise IPAError(
+                    status=400,
+                    message='IP address must be changed in DNS'
+                )
+            cmd = 'host_mod'
+
+            # Foreman doesn't pass these in on update so drop them otherwise
+            # IPA will consider these as being set to None which deletes them.
+            popifnone(params, 'description')
+            popifnone(params, 'macaddress')
+            popifnone(params, 'userclass')
+            popifnone(params, 'userpassword')
+            status = 200
+            if rebuild:
+                root_logger.info("Attempting to disable %s", hostname)
+                try:
+                    Command('host_disable', hostname, nomaskexception=True)
+                except errors.AlreadyInactive as e:
+                    pass
+                else:
+                    raise e
+        return POST(status, cmd, hostname, **params)
+
+    def DELETE(self, fqdn):
+        # The host-del behavior is a bit off due to
+        # https://fedorahosted.org/freeipa/ticket/4329
+        # A NotFound is returned if the user can't read DNS.
+        # Do a GET to see if the host exists, then we can more blindly
+        # try the delete.
+
+        # If the GET is ok then we know there is a host, though this is a
+        # bit racy.
+        GET('host_show', fqdn)
+
+        remove_dns = cherrypy.request.config.get('remove_dns', False)
+
+        return DELETE('host_del', fqdn, updatedns=remove_dns)
+
+
+class Hostgroup(object):
+    """
+    Manage IPA hostgroup objects
+    """
+
+    exposed = True
+
+    def GET(self, name=None):
+
+        if name is None:
+            command = 'hostgroup_find'
+        else:
+            command = 'hostgroup_show'
+
+        return GET(command, name)
+
+    def POST(self, name=None, description=None):
+        cherrypy.response.status = 201
+        return POST(201, 'hostgroup_add', name,
+                    description=description,)
+
+    def DELETE(self, name):
+        return DELETE('hostgroup_del', name)
+
+
+class Features(object):
+    exposed = True
+
+    def GET(self):
+        return '["realm"]'
+
+
+def start(config=None):
+    # Set the umask so only the owner can read the log files
+    old_umask = os.umask(077)
+
+    cherrypy.tree.mount(
+        Features(), '/features',
+        {'/':
+            {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
+        }
+    )
+    cherrypy.tree.mount(
+        Host(), '/ipa/smartproxy/host',
+        {'/':
+            {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
+        }
+    )
+    cherrypy.tree.mount(
+        Hostgroup(), '/ipa/smartproxy/hostgroup',
+        {'/':
+            {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
+        }
+    )
+
+    # Register the realm for requests from Foreman
+    root_logger.info("Mounting /realm/%s", api.env.realm)
+    cherrypy.tree.mount(
+        Host(), '/realm/%s' % api.env.realm,
+        {'/':
+            {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
+        }
+    )
+
+    for c in config or []:
+        try:
+            cherrypy.config.update(c)
+        except (IOError, OSError) as e:
+            root_logger.error("Exception trying to load %s: %s", c, e)
+            return 1
+
+    # Log files are created, reset umask
+    os.umask(old_umask)
+
+    cherrypy.config.update({'error_page.500': handle_error})
+
+    return 0
+
+def application(environ, start_response):
+    root_logger.info("IPA smartproxy WSGI start")
+    return cherrypy.tree(environ, start_response)
+
+wsgi_config = {'environment': 'embedded',
+               'log.screen': False,
+               'show_tracebacks': False,
+               'engine.autoreload_on': False
+}
+
+api.bootstrap(context='ipasmartproxy')
+api.finalize()
+
+cherrypy.config.update(wsgi_config)
+start(['/etc/ipa/ipa-smartproxy.conf'])
diff --git a/smartproxy/ipa-smartproxy.service b/smartproxy/ipa-smartproxy.service
new file mode 100644
index 000000000..544f55b13
--- /dev/null
+++ b/smartproxy/ipa-smartproxy.service
@@ -0,0 +1,12 @@
+[Unit]
+Description=IPA smartproxy for Foreman
+After=ipa.target
+
+[Service]
+ExecStart=/usr/sbin/ipa-smartproxy -c /etc/ipa/ipa-smartproxy.conf -d -p /var/run/ipa-smartproxy.pid
+ExecReload=/bin/kill -USR1 $MAINPID
+Type=forking
+PIDFile=/var/run/ipa-smartproxy.pid
+
+[Install]
+WantedBy=multi-user.target
diff --git a/smartproxy/man/Makefile.am b/smartproxy/man/Makefile.am
new file mode 100644
index 000000000..6626b3cb2
--- /dev/null
+++ b/smartproxy/man/Makefile.am
@@ -0,0 +1,19 @@
+# This file will be processed with automake-1.7 to create Makefile.in
+
+AUTOMAKE_OPTIONS = 1.7
+
+NULL =
+
+man1_MANS = 				\
+		ipa-smartproxy.1
+
+man5_MANS =				\
+		ipa-smartproxy.conf.5
+
+install-data-hook:
+	@for i in $(man1_MANS) ; do gzip -f $(DESTDIR)$(man1dir)/$$i ; done
+	@for i in $(man5_MANS) ; do gzip -f $(DESTDIR)$(man5dir)/$$i ; done
+
+MAINTAINERCLEANFILES =          \
+	Makefile.in		\
+	$(NULL)
diff --git a/smartproxy/man/ipa-smartproxy.1 b/smartproxy/man/ipa-smartproxy.1
new file mode 100644
index 000000000..1fb31bab4
--- /dev/null
+++ b/smartproxy/man/ipa-smartproxy.1
@@ -0,0 +1,105 @@
+.\" A man page for ipa-smartproxy
+.\" Copyright (C) 2014 Red Hat, Inc.
+.\"
+.\" 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/>.
+.\"
+.\" Author: Rob Crittenden <rcritten@redhat.com>
+.TH "ipa-smartproxy" "1" "Jan 8 2014" "FreeIPA" "FreeIPA Manual Pages"
+.SH "NAME"
+ipa\-smartproxy \- IPA Foreman Smartproxy server
+.SH "SYNOPSIS"
+ipa\-smartproxy [\fIOPTION\fR]...
+.SH "DESCRIPTION"
+A WSGI service that provides a RESTful API for a use as a Foreman smart proxy. It is run in the context of the Apache web server.
+
+The RESTful interface is not authenticated so it is expected that the server is not generally accessible. By default it listens only on the localhost interface.
+
+The server needs access to an principal that is granted permission to perform host and hostgroup operations on an IPA master.
+
+Smartproxy server\-specific privileges and roles can be created with this:
+
+.na
+ $ ipa privilege\-add 'Smart Proxy Host Management' \-\-desc='Smartproxy host management'
+ $ ipa privilege\-add\-permission 'Smart Proxy Host Management' \-\-permission='add hosts' \-\-permission='remove hosts'
+ $ ipa permission-add 'modify host password' --permissions='write' --type='host' --attrs='userpassword'
+ $ ipa permission-add 'write host certificate' --permissions='write' --type='host' --attrs='usercertificate'
+ $ ipa permission-add 'modify host userclass' --permissions='write' --type='host' --attrs='userclass'
+ $ ipa privilege-add-permission 'Smart Proxy Host Management' --permission='add hosts'  --permission='remove hosts' --permission='modify host password' --permission='modify host userclass' --permission='modify hosts' --permission='revoke certificate' --permission='manage host keytab' --permission='write host certificate' --permissions='retrieve certificates from the ca' --permissions='modify services' --permissions='manage service keytab' --permission='read dns entries' --permission='add dns entries' --permissions='update dns entries' --permissions='remove dns entries'
+ $ ipa role\-add 'Smartproxy management' \-\-desc='Smartproxy management'
+ $ ipa role\-add\-privilege 'Smartproxy management' \-\-privilege='Smart Proxy Host Management' \-\-privilege='Host Group Administrators'
+
+Create a host or user whose credentials will be used by the server to make requests and add it to the role:
+
+ $ ipa user\-add smartproxy \-\-first=Smartproxy \-\-last=Server --shell=/sbin/nologin --homedir=/var/www
+ $ ipa role\-add\-member \-\-users=smartproxy 'Smartproxy management'
+
+On the smartproxy server create a keytab for this user:
+
+ # kinit admin
+ # ipa\-getkeytab \-s ipa.example.com \-p smartproxy@EXAMPLE.COM \-k /etc/ipa/ipa\-smartproxy.keytab
+ # chown root:root /etc/ipa/ipa\-smartproxy.keytab
+ # chmod 600 /etc/ipa/ipa\-smartproxy.keytab
+
+Configure the GSS\-Proxy to manage the credentials. Add this to the top of the gssproxy configuration file (by default /etc/gssproxy/gssproxy.conf), before any other services:
+
+  [service/smartproxy]
+    mechs = krb5
+    cred_store = client_keytab:/etc/ipa/ipa\-smartproxy.keytab
+    cred_store = ccache:/var/lib/gssproxy/clients/krb5cc_%U
+    cred_usage = initiate
+    euid = <uid of the smartproxy user>
+
+Restart GSS\-Proxy
+
+ # systemctl restart gssproxy
+
+Configure Apache to enable GSS\-Proxy. Create the directory /etc/systemd/system/httpd.service.d/ and create the file smartproxy.conf in it:
+
+ # mkdir /etc/systemd/system/httpd.service.d/
+ # cat > /etc/systemd/system/httpd.service.d/smartproxy.conf <<EOF
+ [Service]
+ Environment=GSS_USE_PROXY=1
+ EOF
+ # systemctl daemon-reload
+
+Copy /usr/share/doc/freeipa-server-foreman-smartproxy/ipa-smartproxy-apache.conf to /etc/httpd/conf.d/ipa-smartproxy.conf . This will configure the smartproxy WSGI application.
+
+Add a SELinux rule so Apache can use the port
+
+ # semanage port -a -t http_port_t -p tcp 8090
+
+Restart Apache
+
+ # systemctl restart httpd
+
+.SH "TEST"
+
+To do simple verification that the proxy was installed properly and is working first confirm that it is providing the realm feature:
+
+ # curl http://localhost:8090/features
+ ["realm"]
+
+Retrieve information on the current host, using your Kerberos realm in place of EXAMPLE.COM:
+
+ # curl http://localhost:8090/realm/EXAMPLE.COM/`hostname`
+ {
+   "dn": "fqdn=..."
+   "fqdn": [
+      ...
+   ]
+   "has_keytab": true,
+   ...
+ }
+.SH "SEE ALSO"
+.BR ipa\-smartproxy.conf(5)
diff --git a/smartproxy/man/ipa-smartproxy.conf.5 b/smartproxy/man/ipa-smartproxy.conf.5
new file mode 100644
index 000000000..29adec8cd
--- /dev/null
+++ b/smartproxy/man/ipa-smartproxy.conf.5
@@ -0,0 +1,62 @@
+.\" A man page for ipa-smartproxy.conf
+.\" Copyright (C) 2014 Red Hat, Inc.
+.\"
+.\" 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/>.
+.\"
+.\" Author: Rob Crittenden <rcritten@@redhat.com>
+.\"
+.TH "ipa-smartproxy.conf" "5" "Jan 8 2014" "FreeIPA" "FreeIPA Manual Pages"
+.SH "NAME"
+ipa\-smartproxy.conf \- IPA Smartproxy server configuration file
+.SH "SYNOPSIS"
+/etc/ipa/ipa\-smartproxy.conf
+.SH "DESCRIPTION"
+The \fIipa\-smartproxy.conf \fRconfiguration file is used to set system\-wide defaults to be applied when running the IPA Foreman Smartproxy server.
+.SH "SYNTAX"
+The configuration options are not case sensitive. The values may be case sensitive, depending on the option.
+
+Blank lines are ignored.
+
+Lines beginning with # are comments and are ignored.
+
+Valid lines consist of an option name, an equals sign and a value. Spaces surrounding equals sign are ignored. An option terminates at the end of a line.
+
+The value is a Python object so needs to adhere to Python rules. If the value should be an integer then it needs to be passed as an integer (like port). If the value is a string then it must be quoted.
+
+Options must appear in the section named [global]. There are no other sections defined or used currently.
+
+Options may be defined that are not used by the IPA Foreman Smartproxy server. Be careful of misspellings, they will not be rejected.
+.SH "OPTIONS"
+The server runs using the CherryPy so all the CherryPy configuration options are valid. Here are some common ones.
+
+.TP
+.B server.socket_port\fR <port>
+Port for the server to listen on. The default port is 8090.
+.TP
+.B server.socket_host\fR <host>
+If not specified then the server will listen on localhost. This is the expected mode. Specifiy a hostname or IP address to listen on another address. See also the .B local_only\fR option if setting this to something other than a local address.
+.B request.show_tracebacks\fR <boolean>
+Display tracebacks to the client when errors occur. Errors will always log on the server side. The default is False.
+.TP
+.B local_only\fR <boolean>
+If True then requires that all requests be local. It is not recommended that this be enabled because this server accepts unathenticated requests to manage IPA entries.
+.TP
+.B remove_dns\fR <boolean>
+Remove DNS entries when deleting a host
+.SH "FILES"
+.TP
+.I /etc/ipa/ipa\-smartproxy.conf
+IPA Foreman Smartproxy server configuration file
+.SH "SEE ALSO"
+.BR ipa\-smartproxy (1)