1 # Copyright (C) 2014 Simo Sorce <simo@redhat.com>
3 # see file 'COPYING' for use and warranty information
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 from ipsilon.providers.common import ProviderBase, ProviderPageBase, \
20 from ipsilon.providers.saml2.auth import AuthenticateRequest
21 from ipsilon.providers.saml2.logout import LogoutRequest
22 from ipsilon.providers.saml2.admin import Saml2AdminPage
23 from ipsilon.providers.saml2.rest import Saml2RestBase
24 from ipsilon.providers.saml2.provider import IdentityProvider
25 from ipsilon.tools.certs import Certificate
26 from ipsilon.tools import saml2metadata as metadata
27 from ipsilon.tools import files
28 from ipsilon.util.user import UserSession
29 from ipsilon.util.plugin import PluginObject
30 from ipsilon.util import config as pconfig
32 from datetime import timedelta
39 class Redirect(AuthenticateRequest):
41 def GET(self, *args, **kwargs):
43 query = cherrypy.request.query_string
45 login = self.saml2login(query)
46 return self.auth(login)
49 class POSTAuth(AuthenticateRequest):
51 def POST(self, *args, **kwargs):
53 request = kwargs.get(lasso.SAML2_FIELD_REQUEST)
54 relaystate = kwargs.get(lasso.SAML2_FIELD_RELAYSTATE)
56 login = self.saml2login(request)
57 login.set_msgRelayState(relaystate)
58 return self.auth(login)
61 class Continue(AuthenticateRequest):
63 def GET(self, *args, **kwargs):
65 session = UserSession()
66 user = session.get_user()
67 transdata = self.trans.retrieve()
68 self.stage = transdata['saml2_stage']
71 self._debug("User is marked anonymous?!")
72 # TODO: Return to SP with auth failed error
73 raise cherrypy.HTTPError(401)
75 self._debug('Continue auth for %s' % user.name)
77 if 'saml2_request' not in transdata:
78 self._debug("Couldn't find Request dump?!")
79 # TODO: Return to SP with auth failed error
80 raise cherrypy.HTTPError(400)
81 dump = transdata['saml2_request']
84 login = self.cfg.idp.get_login_handler(dump)
85 except Exception, e: # pylint: disable=broad-except
86 self._debug('Failed to load status from dump: %r' % e)
89 self._debug("Empty Request dump?!")
90 # TODO: Return to SP with auth failed error
91 raise cherrypy.HTTPError(400)
93 return self.auth(login)
96 class RedirectLogout(LogoutRequest):
98 def GET(self, *args, **kwargs):
99 query = cherrypy.request.query_string
101 relaystate = kwargs.get(lasso.SAML2_FIELD_RELAYSTATE)
102 response = kwargs.get(lasso.SAML2_FIELD_RESPONSE)
104 return self.logout(query,
105 relaystate=relaystate,
106 samlresponse=response)
109 class SSO(ProviderPageBase):
111 def __init__(self, *args, **kwargs):
112 super(SSO, self).__init__(*args, **kwargs)
113 self.Redirect = Redirect(*args, **kwargs)
114 self.POST = POSTAuth(*args, **kwargs)
115 self.Continue = Continue(*args, **kwargs)
118 class SLO(ProviderPageBase):
120 def __init__(self, *args, **kwargs):
121 super(SLO, self).__init__(*args, **kwargs)
122 self._debug('SLO init')
123 self.Redirect = RedirectLogout(*args, **kwargs)
127 METADATA_RENEW_INTERVAL = 60 * 60 * 24 * 7
129 METADATA_VALIDITY_PERIOD = 30
132 class Metadata(ProviderPageBase):
133 def GET(self, *args, **kwargs):
135 body = self._get_metadata()
136 cherrypy.response.headers["Content-Type"] = "text/xml"
137 cherrypy.response.headers["Content-Disposition"] = \
138 'attachment; filename="metadata.xml"'
141 def _get_metadata(self):
142 if os.path.isfile(self.cfg.idp_metadata_file):
143 s = os.stat(self.cfg.idp_metadata_file)
144 if s.st_mtime > time.time() - METADATA_RENEW_INTERVAL:
145 with open(self.cfg.idp_metadata_file) as m:
148 # Otherwise generate and save
149 idp_cert = Certificate()
150 idp_cert.import_cert(self.cfg.idp_certificate_file,
151 self.cfg.idp_key_file)
152 meta = IdpMetadataGenerator(self.instance_base_url(), idp_cert,
153 timedelta(METADATA_VALIDITY_PERIOD))
155 with open(self.cfg.idp_metadata_file, 'w+') as m:
160 class SAML2(ProviderPageBase):
162 def __init__(self, *args, **kwargs):
163 super(SAML2, self).__init__(*args, **kwargs)
164 self.metadata = Metadata(*args, **kwargs)
165 self.SSO = SSO(*args, **kwargs)
166 self.SLO = SLO(*args, **kwargs)
169 class IdpProvider(ProviderBase):
171 def __init__(self, *pargs):
172 super(IdpProvider, self).__init__('saml2', 'saml2', *pargs)
177 self.description = """
178 Provides SAML 2.0 authentication infrastructure. """
184 'Path to data storage accessible by the IdP.',
185 '/var/lib/ipsilon/saml2'),
188 'The IdP Metadata file genearated at install time.',
191 'idp certificate file',
192 'The IdP PEM Certificate genearated at install time.',
196 'The IdP Certificate Key genearated at install time.',
200 'The salt used for persistent Name IDs.',
203 'allow self registration',
204 'Allow authenticated users to register applications.',
207 'default allowed nameids',
208 'Default Allowed NameIDs for Service Providers.',
209 metadata.SAML2_NAMEID_MAP.keys(),
210 ['persistent', 'transient', 'email', 'kerberos', 'x509']),
213 'Default NameID used by Service Providers.',
214 metadata.SAML2_NAMEID_MAP.keys(),
217 'default email domain',
218 'Used for users missing the email property.',
221 'default attribute mapping',
222 'Defines how to map attributes before returning them to SPs',
225 'default allowed attributes',
226 'Defines a list of allowed attributes, applied after mapping',
229 if cherrypy.config.get('debug', False):
232 logger = logging.getLogger('lasso')
233 lh = logging.StreamHandler(sys.stderr)
234 logger.addHandler(lh)
235 logger.setLevel(logging.DEBUG)
238 def allow_self_registration(self):
239 return self.get_config_value('allow self registration')
242 def idp_storage_path(self):
243 return self.get_config_value('idp storage path')
246 def idp_metadata_file(self):
247 return os.path.join(self.idp_storage_path,
248 self.get_config_value('idp metadata file'))
251 def idp_certificate_file(self):
252 return os.path.join(self.idp_storage_path,
253 self.get_config_value('idp certificate file'))
256 def idp_key_file(self):
257 return os.path.join(self.idp_storage_path,
258 self.get_config_value('idp key file'))
261 def idp_nameid_salt(self):
262 return self.get_config_value('idp nameid salt')
265 def default_allowed_nameids(self):
266 return self.get_config_value('default allowed nameids')
269 def default_nameid(self):
270 return self.get_config_value('default nameid')
273 def default_email_domain(self):
274 return self.get_config_value('default email domain')
277 def default_attribute_mapping(self):
278 return self.get_config_value('default attribute mapping')
281 def default_allowed_attributes(self):
282 return self.get_config_value('default allowed attributes')
284 def get_tree(self, site):
285 self.idp = self.init_idp()
286 self.page = SAML2(site, self)
287 self.admin = Saml2AdminPage(site, self)
288 self.rest = Saml2RestBase(site, self)
295 idp = IdentityProvider(self)
296 except Exception, e: # pylint: disable=broad-except
297 self._debug('Failed to init SAML2 provider: %r' % e)
300 # Import all known applications
301 data = self.get_data()
304 if 'type' not in sp or sp['type'] != 'SP':
306 if 'name' not in sp or 'metadata' not in sp:
310 except Exception, e: # pylint: disable=broad-except
311 self._debug('Failed to add SP %s: %r' % (sp['name'], e))
316 super(IdpProvider, self).on_enable()
317 self.idp = self.init_idp()
318 if hasattr(self, 'admin'):
323 class IdpMetadataGenerator(object):
325 def __init__(self, url, idp_cert, expiration=None):
326 self.meta = metadata.Metadata(metadata.IDP_ROLE, expiration)
327 self.meta.set_entity_id('%s/saml2/metadata' % url)
328 self.meta.add_certs(idp_cert, idp_cert)
329 self.meta.add_service(metadata.SAML2_SERVICE_MAP['sso-post'],
330 '%s/saml2/SSO/POST' % url)
331 self.meta.add_service(metadata.SAML2_SERVICE_MAP['sso-redirect'],
332 '%s/saml2/SSO/Redirect' % url)
333 self.meta.add_service(metadata.SAML2_SERVICE_MAP['logout-redirect'],
334 '%s/saml2/SLO/Redirect' % url)
335 self.meta.add_allowed_name_format(
336 lasso.SAML2_NAME_IDENTIFIER_FORMAT_PERSISTENT)
337 self.meta.add_allowed_name_format(
338 lasso.SAML2_NAME_IDENTIFIER_FORMAT_TRANSIENT)
339 self.meta.add_allowed_name_format(
340 lasso.SAML2_NAME_IDENTIFIER_FORMAT_EMAIL)
342 def output(self, path=None):
343 return self.meta.output(path)
346 class Installer(ProviderInstaller):
348 def __init__(self, *pargs):
349 super(Installer, self).__init__()
353 def install_args(self, group):
354 group.add_argument('--saml2', choices=['yes', 'no'], default='yes',
355 help='Configure SAML2 Provider')
357 def configure(self, opts):
358 if opts['saml2'] != 'yes':
361 # Check storage path is present or create it
362 path = os.path.join(opts['data_dir'], 'saml2')
363 if not os.path.exists(path):
364 os.makedirs(path, 0700)
366 # Use the same cert for signing and ecnryption for now
367 cert = Certificate(path)
368 cert.generate('idp', opts['hostname'])
370 # Generate Idp Metadata
372 if opts['secure'].lower() == 'no':
374 url = '%s://%s/%s' % (proto, opts['hostname'], opts['instance'])
375 meta = IdpMetadataGenerator(url, cert,
376 timedelta(METADATA_VALIDITY_PERIOD))
377 if 'krb' in opts and opts['krb'] == 'yes':
378 meta.meta.add_allowed_name_format(
379 lasso.SAML2_NAME_IDENTIFIER_FORMAT_KERBEROS)
381 meta.output(os.path.join(path, 'metadata.xml'))
383 # Add configuration data to database
384 po = PluginObject(*self.pargs)
387 po.wipe_config_values()
388 config = {'idp storage path': path,
389 'idp metadata file': 'metadata.xml',
390 'idp certificate file': cert.cert,
391 'idp key file': cert.key,
392 'idp nameid salt': uuid.uuid4().hex}
393 po.save_plugin_config(config)
395 # Update global config to add login plugin
397 po.save_enabled_state()
399 # Fixup permissions so only the ipsilon user can read these files
400 files.fix_user_dirs(path, opts['system_user'])