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']
96 c.generate('certificate', args['hostname'])
97 m.set_entity_id(url_sp)
99 m.add_service(SAML2_SERVICE_MAP['logout-redirect'], url_logout)
100 m.add_service(SAML2_SERVICE_MAP['slo-soap'], url_logout)
101 m.add_service(SAML2_SERVICE_MAP['response-post'], url_post, index="0")
102 m.add_allowed_name_format(SAML2_NAMEID_MAP[args['saml_nameid']])
103 sp_metafile = os.path.join(path, 'metadata.xml')
104 m.output(sp_metafile)
106 # Register with the IDP if the IDP URL was provided
107 if args['saml_idp_url']:
108 if args['admin_password']:
109 if args['admin_password'] == '-':
110 admin_password = sys.stdin.readline().rstrip('\n')
113 with open(args['admin_password']) as f:
114 admin_password = f.read().rstrip('\n')
115 except Exception as e: # pylint: disable=broad-except
116 logger.error("Failed to read password file!\n" +
119 elif ('IPSILON_ADMIN_PASSWORD' in os.environ) and \
120 (os.environ['IPSILON_ADMIN_PASSWORD']):
121 admin_password = os.environ['IPSILON_ADMIN_PASSWORD']
123 admin_password = getpass.getpass('%s password: ' %
129 with open(sp_metafile) as f:
131 sp_metadata += line.strip()
132 except Exception as e: # pylint: disable=broad-except
133 logger.error("Failed to read SP Metadata file!\n" +
139 saml2_register_sp(args['saml_idp_url'], args['admin_user'],
140 admin_password, args['saml_sp_name'],
142 except Exception as e: # pylint: disable=broad-except
143 logger.error("Failed to register SP with IDP!\n" +
147 if not args['saml_no_httpd']:
148 idp_metafile = os.path.join(path, 'idp-metadata.xml')
149 with open(idp_metafile, 'w+') as f:
152 saml_protect = 'auth'
154 if args['saml_base'] != args['saml_auth']:
155 saml_protect = 'info'
156 saml_auth = '<Location %s>\n' \
157 ' MellonEnable "auth"\n' \
158 ' Header append Cache-Control "no-cache"\n' \
159 '</Location>\n' % args['saml_auth']
162 if args['saml_auth'] == SAML2_PROTECTED:
163 # default location, enable the default page
170 ssl_port = args['port']
174 if args['saml_secure_setup']:
179 samlopts = {'saml_base': args['saml_base'],
180 'saml_protect': saml_protect,
181 'saml_sp_key': c.key,
182 'saml_sp_cert': c.cert,
183 'saml_sp_meta': sp_metafile,
184 'saml_idp_meta': idp_metafile,
185 'saml_sp': args['saml_sp'],
186 'saml_secure_on': saml_secure,
187 'saml_auth': saml_auth,
188 'ssl_require': ssl_require,
189 'ssl_rewrite': ssl_rewrite,
190 'ssl_port': ssl_port,
191 'sp_hostname': args['hostname'],
194 files.write_from_template(SAML2_CONFFILE, SAML2_TEMPLATE, samlopts)
196 files.fix_user_dirs(SAML2_HTTPDIR, args['httpd_user'])
198 logger.info('SAML Service Provider configured.')
199 logger.info('You should be able to restart the HTTPD server and' +
200 ' then access it at %s%s' % (url, args['saml_auth']))
202 logger.info('SAML Service Provider configuration ready.')
203 logger.info('Use the certificate, key and metadata.xml files to' +
204 ' configure your Service Provider')
207 def saml2_register_sp(url, user, password, sp_name, sp_metadata):
208 s = requests.Session()
210 # Authenticate to the IdP
211 form_auth_url = '%s/login/form' % url.rstrip('/')
212 test_auth_url = '%s/login/testauth' % url.rstrip('/')
213 auth_data = {'login_name': user,
214 'login_password': password}
216 r = s.post(form_auth_url, data=auth_data)
217 if r.status_code == 404:
218 r = s.post(test_auth_url, data=auth_data)
220 if r.status_code != 200:
221 raise Exception('Unable to authenticate to IdP (%d)' % r.status_code)
224 sp_url = '%s/rest/providers/saml2/SPS/%s' % (url.rstrip('/'), sp_name)
225 sp_headers = {'Content-type': 'application/x-www-form-urlencoded',
227 sp_data = urlencode({'metadata': sp_metadata})
229 r = s.post(sp_url, headers=sp_headers, data=sp_data)
230 if r.status_code != 201:
231 message = json.loads(r.text)['message']
232 raise Exception('%s' % message)
240 def saml2_uninstall():
242 shutil.rmtree(os.path.join(SAML2_HTTPDIR, args['hostname']))
243 except Exception, e: # pylint: disable=broad-except
246 os.remove(SAML2_CONFFILE)
247 except Exception, e: # pylint: disable=broad-except
252 logger.info('Uninstalling Service Provider')
253 #FXIME: ask confirmation
255 logger.info('Uninstalled SAML2 data')
258 def log_exception(e):
259 if 'debug' in args and args['debug']:
265 def parse_config_profile(args):
266 config = ConfigParser.ConfigParser()
267 files = config.read(args['config_profile'])
269 raise ConfigurationError('Config Profile file %s not found!' %
270 args['config_profile'])
272 if 'globals' in config.sections():
273 G = config.options('globals')
275 val = config.get('globals', g)
283 for k in globals().keys():
284 if k.lower() == g.lower():
288 if 'arguments' in config.sections():
289 A = config.options('arguments')
291 val = config.get('arguments', a)
304 fc = argparse.ArgumentDefaultsHelpFormatter
305 parser = argparse.ArgumentParser(description='Client Install Options',
307 parser.add_argument('--version',
308 action='version', version='%(prog)s 0.1')
309 parser.add_argument('--hostname', default=socket.getfqdn(),
310 help="Machine's fully qualified host name")
311 parser.add_argument('--port', default=None,
312 help="Port number that SP listens on")
313 parser.add_argument('--admin-user', default='admin',
314 help="Account allowed to create a SP")
315 parser.add_argument('--admin-password', default=None,
316 help="File containing the password for the account " +
317 "used to create a SP (- to read from stdin)")
318 parser.add_argument('--httpd-user', default='apache',
319 help="Web server account used to read certs")
320 parser.add_argument('--saml', action='store_true', default=True,
321 help="Whether to install a saml2 SP")
322 parser.add_argument('--saml-idp-url', default=None,
323 help="A URL of the IDP to register the SP with")
324 parser.add_argument('--saml-idp-metadata', default=None,
325 help="A URL pointing at the IDP Metadata (FILE or HTTP)")
326 parser.add_argument('--saml-no-httpd', action='store_true', default=False,
327 help="Do not configure httpd")
328 parser.add_argument('--saml-base', default='/',
329 help="Where saml2 authdata is available")
330 parser.add_argument('--saml-auth', default=SAML2_PROTECTED,
331 help="Where saml2 authentication is enforced")
332 parser.add_argument('--saml-sp', default='/saml2',
333 help="Where saml communication happens")
334 parser.add_argument('--saml-sp-logout', default=None,
335 help="Single Logout URL")
336 parser.add_argument('--saml-sp-post', default=None,
337 help="Post response URL")
338 parser.add_argument('--saml-secure-setup', action='store_true',
339 default=True, help="Turn on all security checks")
340 parser.add_argument('--saml-nameid', default='unspecified',
341 choices=SAML2_NAMEID_MAP.keys(),
342 help="SAML NameID format to use")
343 parser.add_argument('--saml-sp-name', default=None,
344 help="The SP name to register with the IdP")
345 parser.add_argument('--debug', action='store_true', default=False,
346 help="Turn on script debugging")
347 parser.add_argument('--config-profile', default=None,
348 help=argparse.SUPPRESS)
349 parser.add_argument('--uninstall', action='store_true',
350 help="Uninstall the server and all data")
352 args = vars(parser.parse_args())
354 if args['config_profile']:
355 args = parse_config_profile(args)
357 if len(args['hostname'].split('.')) < 2:
358 raise ValueError('Hostname: %s is not a FQDN.' % args['hostname'])
360 if args['port'] and not args['port'].isdigit():
361 raise ValueError('Port number: %s is not an integer.' % args['port'])
363 # Validate that all path options begin with '/'
364 path_args = ['saml_base', 'saml_auth', 'saml_sp', 'saml_sp_logout',
366 for path_arg in path_args:
367 if args[path_arg] is not None and not args[path_arg].startswith('/'):
368 raise ValueError('--%s must begin with a / character.' %
369 path_arg.replace('_', '-'))
371 # The saml_sp setting must be a subpath of saml_base since it is
372 # used as the MellonEndpointPath.
373 if not args['saml_sp'].startswith(args['saml_base']):
374 raise ValueError('--saml-sp must be a subpath of --saml-base.')
376 # The saml_sp_logout and saml_sp_post settings must be subpaths
377 # of saml_sp (the mellon endpoint).
378 path_args = {'saml_sp_logout': 'logout',
379 'saml_sp_post': 'postResponse'}
380 for path_arg, default_path in path_args.items():
381 if args[path_arg] is None:
382 args[path_arg] = '%s/%s' % (args['saml_sp'].rstrip('/'),
385 elif not args[path_arg].startswith(args['saml_sp']):
386 raise ValueError('--%s must be a subpath of --saml-sp' %
387 path_arg.replace('_', '-'))
389 # If saml_idp_url if being used, we require saml_sp_name to
390 # use when registering the SP.
391 if args['saml_idp_url'] and not args['saml_sp_name']:
392 raise ValueError('--saml-sp-name must be specified when using' +
395 # At least one on this list needs to be specified or we do nothing
401 if not present and not args['uninstall']:
402 raise ValueError('Nothing to install, please select a Service type.')
405 if __name__ == '__main__':
411 if 'uninstall' in args and args['uninstall'] is True:
415 except Exception, e: # pylint: disable=broad-except
417 if 'uninstall' in args and args['uninstall'] is True:
418 logging.info('Uninstallation aborted.')
420 logging.info('Installation aborted.')
424 if 'uninstall' in args and args['uninstall'] is True:
425 logging.info('Uninstallation complete.')
427 logging.info('Installation complete.')