3 # Copyright (C) 2014 Ipsilon project Contributors, for license see COPYING
5 from ipsilon.tools.saml2metadata import Metadata
6 from ipsilon.tools.saml2metadata import SAML2_NAMEID_MAP
7 from ipsilon.tools.saml2metadata import SAML2_SERVICE_MAP
8 from ipsilon.tools.certs import Certificate
9 from ipsilon.tools import files
10 from urllib import urlencode
24 HTTPDCONFD = '/etc/httpd/conf.d'
25 SAML2_TEMPLATE = '/usr/share/ipsilon/templates/install/saml2/sp.conf'
26 SAML2_CONFFILE = '/etc/httpd/conf.d/ipsilon-saml.conf'
27 SAML2_HTTPDIR = '/etc/httpd/saml2'
28 SAML2_PROTECTED = '/saml2protected'
30 #Installation arguments
34 logger = logging.getLogger()
38 global logger # pylint: disable=W0603
39 logger = logging.getLogger()
40 lh = logging.StreamHandler(sys.stderr)
45 logger.info('Installing SAML2 Service Provider')
47 if args['saml_idp_metadata'] is None:
48 #TODO: detect via SRV records ?
49 if args['saml_idp_url']:
50 args['saml_idp_metadata'] = ('%s/saml2/metadata' %
51 args['saml_idp_url'].rstrip('/'))
53 raise ValueError('An IDP URL or metadata file/URL is required.')
58 if os.path.exists(args['saml_idp_metadata']):
59 with open(args['saml_idp_metadata']) as f:
61 elif args['saml_idp_metadata'].startswith('file://'):
62 with open(args['saml_idp_metadata'][7:]) as f:
65 r = requests.get(args['saml_idp_metadata'])
68 except Exception, e: # pylint: disable=broad-except
69 logger.error("Failed to retrieve IDP Metadata file!\n" +
70 "Error: [%s]" % repr(e))
74 if not args['saml_no_httpd']:
75 path = os.path.join(SAML2_HTTPDIR, args['hostname'])
76 os.makedirs(path, 0750)
81 if not args['saml_secure_setup']:
86 port_str = ':%s' % args['port']
88 url = '%s://%s%s' % (proto, args['hostname'], port_str)
89 url_sp = url + args['saml_sp']
90 url_logout = url + args['saml_sp_logout']
91 url_post = url + args['saml_sp_post']
92 url_paos = url + args['saml_sp_paos']
97 c.generate('certificate', args['hostname'])
98 m.set_entity_id(url_sp)
100 m.add_service(SAML2_SERVICE_MAP['logout-redirect'], url_logout)
101 if not args['no_saml_soap_logout']:
102 m.add_service(SAML2_SERVICE_MAP['slo-soap'], url_logout)
103 m.add_service(SAML2_SERVICE_MAP['response-post'], url_post,
104 index="0", isDefault="true")
105 m.add_service(SAML2_SERVICE_MAP['response-paos'], url_paos,
107 m.add_allowed_name_format(SAML2_NAMEID_MAP[args['saml_nameid']])
108 sp_metafile = os.path.join(path, 'metadata.xml')
109 m.output(sp_metafile)
111 # Register with the IDP if the IDP URL was provided
112 if args['saml_idp_url']:
113 if args['admin_password']:
114 if args['admin_password'] == '-':
115 admin_password = sys.stdin.readline().rstrip('\n')
118 with open(args['admin_password']) as f:
119 admin_password = f.read().rstrip('\n')
120 except Exception as e: # pylint: disable=broad-except
121 logger.error("Failed to read password file!\n" +
124 elif ('IPSILON_ADMIN_PASSWORD' in os.environ) and \
125 (os.environ['IPSILON_ADMIN_PASSWORD']):
126 admin_password = os.environ['IPSILON_ADMIN_PASSWORD']
128 admin_password = getpass.getpass('%s password: ' %
134 with open(sp_metafile) as f:
136 sp_metadata += line.strip()
137 except Exception as e: # pylint: disable=broad-except
138 logger.error("Failed to read SP Metadata file!\n" +
144 saml2_register_sp(args['saml_idp_url'], args['admin_user'],
145 admin_password, args['saml_sp_name'],
147 except Exception as e: # pylint: disable=broad-except
148 logger.error("Failed to register SP with IDP!\n" +
152 if not args['saml_no_httpd']:
153 idp_metafile = os.path.join(path, 'idp-metadata.xml')
154 with open(idp_metafile, 'w+') as f:
157 saml_protect = 'auth'
159 if args['saml_base'] != args['saml_auth']:
160 saml_protect = 'info'
161 saml_auth = '<Location %s>\n' \
162 ' MellonEnable "auth"\n' \
163 ' Header append Cache-Control "no-cache"\n' \
164 '</Location>\n' % args['saml_auth']
167 if args['saml_auth'] == SAML2_PROTECTED:
168 # default location, enable the default page
175 ssl_port = args['port']
179 if args['saml_secure_setup']:
184 samlopts = {'saml_base': args['saml_base'],
185 'saml_protect': saml_protect,
186 'saml_sp_key': c.key,
187 'saml_sp_cert': c.cert,
188 'saml_sp_meta': sp_metafile,
189 'saml_idp_meta': idp_metafile,
190 'saml_sp': args['saml_sp'],
191 'saml_secure_on': saml_secure,
192 'saml_auth': saml_auth,
193 'ssl_require': ssl_require,
194 'ssl_rewrite': ssl_rewrite,
195 'ssl_port': ssl_port,
196 'sp_hostname': args['hostname'],
199 files.write_from_template(SAML2_CONFFILE, SAML2_TEMPLATE, samlopts)
201 files.fix_user_dirs(SAML2_HTTPDIR, args['httpd_user'])
203 logger.info('SAML Service Provider configured.')
204 logger.info('You should be able to restart the HTTPD server and' +
205 ' then access it at %s%s' % (url, args['saml_auth']))
207 logger.info('SAML Service Provider configuration ready.')
208 logger.info('Use the certificate, key and metadata.xml files to' +
209 ' configure your Service Provider')
212 def saml2_register_sp(url, user, password, sp_name, sp_metadata):
213 s = requests.Session()
215 # Authenticate to the IdP
216 form_auth_url = '%s/login/form' % url.rstrip('/')
217 test_auth_url = '%s/login/testauth' % url.rstrip('/')
218 auth_data = {'login_name': user,
219 'login_password': password}
221 r = s.post(form_auth_url, data=auth_data)
222 if r.status_code == 404:
223 r = s.post(test_auth_url, data=auth_data)
225 if r.status_code != 200:
226 raise Exception('Unable to authenticate to IdP (%d)' % r.status_code)
229 sp_url = '%s/rest/providers/saml2/SPS/%s' % (url.rstrip('/'), sp_name)
230 sp_headers = {'Content-type': 'application/x-www-form-urlencoded',
232 sp_data = urlencode({'metadata': sp_metadata})
234 r = s.post(sp_url, headers=sp_headers, data=sp_data)
235 if r.status_code != 201:
236 message = json.loads(r.text)['message']
237 raise Exception('%s' % message)
245 def saml2_uninstall():
247 shutil.rmtree(os.path.join(SAML2_HTTPDIR, args['hostname']))
248 except Exception, e: # pylint: disable=broad-except
251 os.remove(SAML2_CONFFILE)
252 except Exception, e: # pylint: disable=broad-except
257 logger.info('Uninstalling Service Provider')
258 #FXIME: ask confirmation
260 logger.info('Uninstalled SAML2 data')
263 def log_exception(e):
264 if 'debug' in args and args['debug']:
270 def parse_config_profile(args):
271 config = ConfigParser.ConfigParser()
272 files = config.read(args['config_profile'])
274 raise ConfigurationError('Config Profile file %s not found!' %
275 args['config_profile'])
277 if 'globals' in config.sections():
278 G = config.options('globals')
280 val = config.get('globals', g)
289 if k.lower() == g.lower():
293 if 'arguments' in config.sections():
294 A = config.options('arguments')
296 val = config.get('arguments', a)
309 fc = argparse.ArgumentDefaultsHelpFormatter
310 parser = argparse.ArgumentParser(description='Client Install Options',
312 parser.add_argument('--version',
313 action='version', version='%(prog)s 0.1')
314 parser.add_argument('--hostname', default=socket.getfqdn(),
315 help="Machine's fully qualified host name")
316 parser.add_argument('--port', default=None,
317 help="Port number that SP listens on")
318 parser.add_argument('--admin-user', default='admin',
319 help="Account allowed to create a SP")
320 parser.add_argument('--admin-password', default=None,
321 help="File containing the password for the account " +
322 "used to create a SP (- to read from stdin)")
323 parser.add_argument('--httpd-user', default='apache',
324 help="Web server account used to read certs")
325 parser.add_argument('--saml', action='store_true', default=True,
326 help="Whether to install a saml2 SP")
327 parser.add_argument('--saml-idp-url', default=None,
328 help="A URL of the IDP to register the SP with")
329 parser.add_argument('--saml-idp-metadata', default=None,
330 help="A URL pointing at the IDP Metadata (FILE or HTTP)")
331 parser.add_argument('--saml-no-httpd', action='store_true', default=False,
332 help="Do not configure httpd")
333 parser.add_argument('--saml-base', default='/',
334 help="Where saml2 authdata is available")
335 parser.add_argument('--saml-auth', default=SAML2_PROTECTED,
336 help="Where saml2 authentication is enforced")
337 parser.add_argument('--saml-sp', default='/saml2',
338 help="Where saml communication happens")
339 parser.add_argument('--saml-sp-logout', default=None,
340 help="Single Logout URL")
341 parser.add_argument('--saml-sp-post', default=None,
342 help="Post response URL")
343 parser.add_argument('--saml-sp-paos', default=None,
344 help="PAOS response URL, used for ECP")
345 parser.add_argument('--no-saml-soap-logout', action='store_true',
347 help="Disable Single Logout over SOAP")
348 parser.add_argument('--saml-secure-setup', action='store_true',
349 default=True, help="Turn on all security checks")
350 parser.add_argument('--saml-nameid', default='unspecified',
351 choices=SAML2_NAMEID_MAP.keys(),
352 help="SAML NameID format to use")
353 parser.add_argument('--saml-sp-name', default=None,
354 help="The SP name to register with the IdP")
355 parser.add_argument('--debug', action='store_true', default=False,
356 help="Turn on script debugging")
357 parser.add_argument('--config-profile', default=None,
358 help=argparse.SUPPRESS)
359 parser.add_argument('--uninstall', action='store_true',
360 help="Uninstall the server and all data")
362 args = vars(parser.parse_args())
364 if args['config_profile']:
365 args = parse_config_profile(args)
367 if len(args['hostname'].split('.')) < 2:
368 raise ValueError('Hostname: %s is not a FQDN.' % args['hostname'])
370 if args['port'] and not args['port'].isdigit():
371 raise ValueError('Port number: %s is not an integer.' % args['port'])
373 # Validate that all path options begin with '/'
374 path_args = ['saml_base', 'saml_auth', 'saml_sp', 'saml_sp_logout',
375 'saml_sp_post', 'saml_sp_paos']
376 for path_arg in path_args:
377 if args[path_arg] is not None and not args[path_arg].startswith('/'):
378 raise ValueError('--%s must begin with a / character.' %
379 path_arg.replace('_', '-'))
381 # The saml_sp setting must be a subpath of saml_base since it is
382 # used as the MellonEndpointPath.
383 if not args['saml_sp'].startswith(args['saml_base']):
384 raise ValueError('--saml-sp must be a subpath of --saml-base.')
386 # The saml_sp_logout, saml_sp_post and saml_sp_paos settings must
387 # be subpaths of saml_sp (the mellon endpoint).
388 path_args = {'saml_sp_logout': 'logout',
389 'saml_sp_post': 'postResponse',
390 'saml_sp_paos': 'paosResponse'}
391 for path_arg, default_path in path_args.items():
392 if args[path_arg] is None:
393 args[path_arg] = '%s/%s' % (args['saml_sp'].rstrip('/'),
396 elif not args[path_arg].startswith(args['saml_sp']):
397 raise ValueError('--%s must be a subpath of --saml-sp' %
398 path_arg.replace('_', '-'))
400 # If saml_idp_url if being used, we require saml_sp_name to
401 # use when registering the SP.
402 if args['saml_idp_url'] and not args['saml_sp_name']:
403 raise ValueError('--saml-sp-name must be specified when using' +
406 # At least one on this list needs to be specified or we do nothing
412 if not present and not args['uninstall']:
413 raise ValueError('Nothing to install, please select a Service type.')
416 if __name__ == '__main__':
422 if 'uninstall' in args and args['uninstall'] is True:
426 except Exception, e: # pylint: disable=broad-except
428 if 'uninstall' in args and args['uninstall'] is True:
429 logging.info('Uninstallation aborted.')
431 logging.info('Installation aborted.')
435 if 'uninstall' in args and args['uninstall'] is True:
436 logging.info('Uninstallation complete.')
438 logging.info('Installation complete.')