3 # Copyright (C) 2014 Simo Sorce <simo@redhat.com>
5 # see file 'COPYING' for use and warranty information
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 from ipsilon.login.common import LoginMgrsInstall
21 from ipsilon.providers.common import ProvidersInstall
22 from ipsilon.helpers.common import EnvHelpersInstall
23 from ipsilon.util.data import Store
24 from ipsilon.tools import files
38 TEMPLATES = '/usr/share/ipsilon/templates/install'
39 CONFDIR = '/etc/ipsilon'
40 DATADIR = '/var/lib/ipsilon'
41 HTTPDCONFD = '/etc/httpd/conf.d'
43 STATICDIR = '/usr/share/ipsilon'
44 WSGI_SOCKET_PREFIX = None
47 class ConfigurationError(Exception):
49 def __init__(self, message):
50 super(ConfigurationError, self).__init__(message)
51 self.message = message
54 return repr(self.message)
57 #Silence cherrypy logging to screen
58 cherrypy.log.screen = False
61 LOGFILE = '/var/log/ipsilon-install.log'
62 logger = logging.getLogger()
66 global logger # pylint: disable=W0603
67 if os.path.isfile(LOGFILE):
69 created = '%s' % time.ctime(os.path.getctime(LOGFILE))
70 shutil.move(LOGFILE, '%s.%s' % (LOGFILE, created))
73 logger = logging.getLogger()
75 lh = logging.FileHandler(LOGFILE)
77 print >> sys.stderr, 'Unable to open %s (%s)' % (LOGFILE, str(e))
78 lh = logging.StreamHandler(sys.stderr)
79 formatter = logging.Formatter('[%(asctime)s] %(message)s')
80 lh.setFormatter(formatter)
84 def install(plugins, args):
85 logger.info('Installation initiated')
86 now = time.strftime("%Y%m%d%H%M%S", time.gmtime())
87 instance_conf = os.path.join(CONFDIR, args['instance'])
89 logger.info('Installing default config files')
90 ipsilon_conf = os.path.join(instance_conf, 'ipsilon.conf')
91 idp_conf = os.path.join(instance_conf, 'idp.conf')
92 args['httpd_conf'] = os.path.join(HTTPDCONFD,
93 'ipsilon-%s.conf' % args['instance'])
94 args['data_dir'] = os.path.join(DATADIR, args['instance'])
95 if os.path.exists(ipsilon_conf):
96 shutil.move(ipsilon_conf, '%s.bakcup.%s' % (ipsilon_conf, now))
97 if os.path.exists(idp_conf):
98 shutil.move(idp_conf, '%s.backup.%s' % (idp_conf, now))
99 if not os.path.exists(instance_conf):
100 os.makedirs(instance_conf, 0700)
101 confopts = {'instance': args['instance'],
102 'datadir': args['data_dir'],
103 'sysuser': args['system_user'],
104 'ipsilondir': BINDIR,
105 'staticdir': STATICDIR}
106 if WSGI_SOCKET_PREFIX:
107 confopts['wsgi_socket'] = 'WSGISocketPrefix %s' % WSGI_SOCKET_PREFIX
108 files.write_from_template(ipsilon_conf,
109 os.path.join(TEMPLATES, 'ipsilon.conf'),
111 files.write_from_template(idp_conf,
112 os.path.join(TEMPLATES, 'idp.conf'),
114 if not os.path.exists(args['httpd_conf']):
115 os.symlink(idp_conf, args['httpd_conf'])
116 sessdir = os.path.join(args['data_dir'], 'sessions')
117 if not os.path.exists(sessdir):
118 os.makedirs(sessdir, 0700)
119 data_conf = os.path.join(args['data_dir'], 'ipsilon.conf')
120 if not os.path.exists(data_conf):
121 os.symlink(ipsilon_conf, data_conf)
122 # Load the cherrypy config from the newly installed file so
123 # that db paths and all is properly set before configuring
125 cherrypy.config.update(ipsilon_conf)
127 # Move pre-existing admin db away
128 admin_db = cherrypy.config['admin.config.db']
129 if os.path.exists(admin_db):
130 shutil.move(admin_db, '%s.backup.%s' % (admin_db, now))
133 users_db = cherrypy.config['user.prefs.db']
134 if os.path.exists(users_db):
135 shutil.move(users_db, '%s.backup.%s' % (users_db, now))
137 db.save_user_preferences(args['admin_user'], {'is_admin': 1})
139 logger.info('Configuring environment helpers')
140 for plugin_name in plugins['Environment Helpers']:
141 plugin = plugins['Environment Helpers'][plugin_name]
142 plugin.configure_server(args)
144 logger.info('Configuring login managers')
145 for plugin_name in args['lm_order']:
146 plugin = plugins['Login Managers'][plugin_name]
147 plugin.configure(args)
149 logger.info('Configuring Authentication Providers')
150 for plugin_name in plugins['Auth Providers']:
151 plugin = plugins['Auth Providers'][plugin_name]
152 plugin.configure(args)
154 # Fixup permissions so only the ipsilon user can read these files
155 files.fix_user_dirs(instance_conf, opts['system_user'])
156 files.fix_user_dirs(args['data_dir'], opts['system_user'])
158 subprocess.call(['/usr/sbin/restorecon', '-R', args['data_dir']])
159 except Exception: # pylint: disable=broad-except
162 def uninstall(plugins, args):
163 logger.info('Uninstallation initiated')
164 raise Exception('Not Implemented')
169 'Environment Helpers': EnvHelpersInstall().plugins,
170 'Login Managers': LoginMgrsInstall().plugins,
171 'Auth Providers': ProvidersInstall().plugins
176 def parse_config_profile(args):
177 config = ConfigParser.ConfigParser()
178 files = config.read(args['config_profile'])
180 raise ConfigurationError('Config Profile file %s not found!' %
181 args['config_profile'])
183 if 'globals' in config.sections():
184 G = config.options('globals')
186 val = config.get('globals', g)
190 for k in globals().keys():
191 if k.lower() == g.lower():
195 if 'arguments' in config.sections():
196 A = config.options('arguments')
198 args[a] = config.get('arguments', a)
203 def parse_args(plugins):
204 parser = argparse.ArgumentParser(description='Ipsilon Install Options')
205 parser.add_argument('--version',
206 action='version', version='%(prog)s 0.1')
207 parser.add_argument('-o', '--login-managers-order', dest='lm_order',
208 help='Comma separated list of login managers')
209 parser.add_argument('--hostname',
210 help="Machine's fully qualified host name")
211 parser.add_argument('--instance', default='idp',
212 help="IdP instance name, each is a separate idp")
213 parser.add_argument('--system-user', default='ipsilon',
214 help="User account used to run the server")
215 parser.add_argument('--admin-user', default='admin',
216 help="User account that is assigned admin privileges")
217 parser.add_argument('--config-profile', default=None,
218 help="File containing install options")
219 parser.add_argument('--uninstall', action='store_true',
220 help="Uninstall the server and all data")
224 for plugin_group in plugins:
225 group = parser.add_argument_group(plugin_group)
226 for plugin_name in plugins[plugin_group]:
227 plugin = plugins[plugin_group][plugin_name]
228 if plugin.ptype == 'login':
229 lms.append(plugin.name)
230 plugin.install_args(group)
232 args = vars(parser.parse_args())
234 if args['config_profile']:
235 args = parse_config_profile(args)
237 if not args['hostname']:
238 args['hostname'] = socket.getfqdn()
240 if len(args['hostname'].split('.')) < 2:
241 raise ConfigurationError('Hostname: %s is not a FQDN')
244 pwd.getpwnam(args['system_user'])
246 raise ConfigurationError('User: %s not found on the system')
248 if args['lm_order'] is None:
249 args['lm_order'] = []
251 if args[name] == 'yes':
252 args['lm_order'].append(name)
254 args['lm_order'] = args['lm_order'].split(',')
256 if len(args['lm_order']) == 0:
257 #force the basic pam provider if nothing else is selected
258 if 'pam' not in args:
261 args['lm_order'] = ['pam']
264 #FIXME: check instance is only alphanums
268 if __name__ == '__main__':
273 fplugins = find_plugins()
274 opts = parse_args(fplugins)
276 logger.setLevel(logging.DEBUG)
278 logger.info('Intallation arguments:')
279 for k in sorted(opts.iterkeys()):
280 logger.info('%s: %s', k, opts[k])
282 if 'uninstall' in opts and opts['uninstall'] is True:
283 uninstall(fplugins, opts)
285 install(fplugins, opts)
286 except Exception, e: # pylint: disable=broad-except
288 if 'uninstall' in opts and opts['uninstall'] is True:
289 print 'Uninstallation aborted.'
291 print 'Installation aborted.'
292 print 'See log file %s for details' % LOGFILE
296 if 'uninstall' in opts and opts['uninstall'] is True:
297 print 'Uninstallation complete.'
299 print 'Installation complete.'
300 print 'Please restart HTTPD to enable the IdP instance.'