diff options
Diffstat (limited to 'ipapython/services.py.in')
| -rw-r--r-- | ipapython/services.py.in | 182 |
1 files changed, 181 insertions, 1 deletions
diff --git a/ipapython/services.py.in b/ipapython/services.py.in index 040ab562e..f6099a7dc 100644 --- a/ipapython/services.py.in +++ b/ipapython/services.py.in @@ -1,2 +1,182 @@ -from ipapython.platform.SUPPORTED_PLATFORM import * +# Authors: Alexander Bokovoy <abokovoy@redhat.com> +# Authors: Simo Sorce <ssorce@redhat.com> +# +# Copyright (C) 2011 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/>. + + +# Canonical names of services as IPA wants to see them. As we need to have *some* naming, +# set them as in Red Hat distributions. Actual implementation should make them available +# through knownservices.<name> and take care of remapping internally, if needed +wellknownservices = ['certmonger', 'dirsrv', 'httpd', 'ipa', 'krb5kdc', 'messagebus', + 'nlscd', 'nscd', 'ntpd', 'portmap', 'rpcbind'] + +# authconfig is an entry point to platform-provided AuthConfig implementation +authconfig = None + +# knownservices is an entry point to known platform services (instance of KnownServices) +knownservices = None + +class AuthConfig(object): + """ + AuthConfig class implements system-independent interface to configure + system authentication resources. In Red Hat systems this is done with + authconfig(8) utility. + + AuthConfig class is nothing more than a tool to gather configuration options + and execute their processing. These options then converted by an actual implementation + to series of a system calls to appropriate utilities performing real configuration. + + IPA *expects* names of AuthConfig's options to follow authconfig(8) naming scheme! + + Actual implementation should be done in ipapython/platform/<platform>.py by inheriting from ipapython.services.AuthConfig + and redefining __build_args() and execute() methods. + + class PlatformAuthConfig(ipautil.AuthConfig): + def __build_args(): + ... + + def execute(): + ... + + authconfig = PlatformAuthConfig + .... + + See ipapython/platform/redhat.py for a sample implementation that uses authconfig(8) as its backend. + + From IPA perspective, the authentication configuration should be done with use of ipapython.services.authconfig: + + auth_config = ipapython.services.authconfig() + auth_config.disable("ldap").\ + disable("krb5").\ + disable("sssd").\ + disable("sssdauth").\ + disable("mkhomedir").\ + add_option("update").\ + enable("nis").\ + add_parameter("nisdomain","foobar") + auth_config.execute() + + If you need to re-use existing AuthConfig instance for multiple runs, make sure to + call 'AuthConfig.reset()' between the runs. + """ + + def __init__(self): + self.parameters = {} + + def enable(self, option): + self.parameters[option] = True + return self + + def disable(self, option): + self.parameters[option] = False + return self + + def add_option(self, option): + self.parameters[option] = None + return self + + def add_parameter(self, option, value): + self.parameters[option] = [value] + return self + + def __build_args(self): + # do nothing + return None + + def execute(self): + # do nothing + return None + def reset(self): + self.parameters = {} + return self + +class PlatformService(object): + """ + PlatformService abstracts out external process running on the system which is possible + to administer (start, stop, check status, etc). + + """ + + def __init__(self, service_name): + self.service_name = service_name + + def start(self, instance_name="", capture_output=True): + return + + def stop(self, instance_name="", capture_output=True): + return + + def restart(self, instance_name="", capture_output=True): + return + + def is_running(self): + return False + + def is_installed(self): + return False + + def is_enabled(self): + return False + + def enable(self): + return + + def disable(self): + return + + def install(self): + return + + def remove(self): + return + +class KnownServices(object): + """ + KnownServices is an abstract class factory that produces instances of well-known + platform services. Actual implementation must create these instances on first access + and cache them. + """ + + def __init__(self): + self.__services__ = {} + + def __getattr__(self, name): + if name in self.__services__: + object.__setattr__(self, name, self.__services__[name]) + return self.__services__[name] + return None + +# restore context default implementation that does nothing +def restore_context_default(filepath): + return + +# Restore security context for a path +# If the platform has security features where context is important, implement your own +# version in platform services +restore_context = restore_context_default + +# Default implementation of backup and replace hostname that does nothing +def backup_and_replace_hostname_default(fstore, statestore, hostname): + return + +# Backup and replace system's hostname +# Since many platforms have their own way how to store system's hostname, this method must be +# implemented in platform services +backup_and_replace_hostname = backup_and_replace_hostname_default + +from ipapython.platform.SUPPORTED_PLATFORM import * |