# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
-from ipsilon.providers.common import ProviderBase, ProviderPageBase
+from ipsilon.providers.common import ProviderBase, ProviderPageBase, \
+ ProviderInstaller
from ipsilon.providers.saml2.auth import AuthenticateRequest
+from ipsilon.providers.saml2.logout import LogoutRequest
from ipsilon.providers.saml2.admin import Saml2AdminPage
+from ipsilon.providers.saml2.rest import Saml2RestBase
from ipsilon.providers.saml2.provider import IdentityProvider
from ipsilon.tools.certs import Certificate
from ipsilon.tools import saml2metadata as metadata
from ipsilon.util.plugin import PluginObject
from ipsilon.util import config as pconfig
import cherrypy
+from datetime import timedelta
import lasso
import os
+import time
+import uuid
class Redirect(AuthenticateRequest):
return self.auth(login)
+class RedirectLogout(LogoutRequest):
+
+ def GET(self, *args, **kwargs):
+ query = cherrypy.request.query_string
+
+ relaystate = kwargs.get(lasso.SAML2_FIELD_RELAYSTATE)
+ response = kwargs.get(lasso.SAML2_FIELD_RESPONSE)
+
+ return self.logout(query,
+ relaystate=relaystate,
+ samlresponse=response)
+
+
class SSO(ProviderPageBase):
def __init__(self, *args, **kwargs):
self.Continue = Continue(*args, **kwargs)
+class SLO(ProviderPageBase):
+
+ def __init__(self, *args, **kwargs):
+ super(SLO, self).__init__(*args, **kwargs)
+ self._debug('SLO init')
+ self.Redirect = RedirectLogout(*args, **kwargs)
+
+
+# one week
+METADATA_RENEW_INTERVAL = 60 * 60 * 24 * 7
+# 30 days
+METADATA_VALIDITY_PERIOD = 30
+
+
class Metadata(ProviderPageBase):
def GET(self, *args, **kwargs):
- with open(self.cfg.idp_metadata_file) as m:
- body = m.read()
+
+ body = self._get_metadata()
cherrypy.response.headers["Content-Type"] = "text/xml"
cherrypy.response.headers["Content-Disposition"] = \
'attachment; filename="metadata.xml"'
return body
+ def _get_metadata(self):
+ if os.path.isfile(self.cfg.idp_metadata_file):
+ s = os.stat(self.cfg.idp_metadata_file)
+ if s.st_mtime > time.time() - METADATA_RENEW_INTERVAL:
+ with open(self.cfg.idp_metadata_file) as m:
+ return m.read()
+
+ # Otherwise generate and save
+ idp_cert = Certificate()
+ idp_cert.import_cert(self.cfg.idp_certificate_file,
+ self.cfg.idp_key_file)
+ meta = IdpMetadataGenerator(self.instance_base_url(), idp_cert,
+ timedelta(METADATA_VALIDITY_PERIOD))
+ body = meta.output()
+ with open(self.cfg.idp_metadata_file, 'w+') as m:
+ m.write(body)
+ return body
+
class SAML2(ProviderPageBase):
super(SAML2, self).__init__(*args, **kwargs)
self.metadata = Metadata(*args, **kwargs)
self.SSO = SSO(*args, **kwargs)
+ self.SLO = SLO(*args, **kwargs)
class IdpProvider(ProviderBase):
def __init__(self, *pargs):
super(IdpProvider, self).__init__('saml2', 'saml2', *pargs)
self.admin = None
+ self.rest = None
self.page = None
self.idp = None
self.description = """
'idp key file',
'The IdP Certificate Key genearated at install time.',
'certificate.key'),
+ pconfig.String(
+ 'idp nameid salt',
+ 'The salt used for persistent Name IDs.',
+ None),
pconfig.Condition(
'allow self registration',
'Allow authenticated users to register applications.',
'default allowed nameids',
'Default Allowed NameIDs for Service Providers.',
metadata.SAML2_NAMEID_MAP.keys(),
- ['persistent', 'transient', 'email', 'kerberos', 'x509']),
+ ['unspecified', 'persistent', 'transient', 'email',
+ 'kerberos', 'x509']),
pconfig.Pick(
'default nameid',
'Default NameID used by Service Providers.',
metadata.SAML2_NAMEID_MAP.keys(),
- 'persistent'),
+ 'unspecified'),
pconfig.String(
'default email domain',
'Used for users missing the email property.',
'example.com'),
+ pconfig.MappingList(
+ 'default attribute mapping',
+ 'Defines how to map attributes before returning them to SPs',
+ [['*', '*']]),
+ pconfig.ComplexList(
+ 'default allowed attributes',
+ 'Defines a list of allowed attributes, applied after mapping',
+ ['*']),
)
if cherrypy.config.get('debug', False):
import logging
return os.path.join(self.idp_storage_path,
self.get_config_value('idp key file'))
+ @property
+ def idp_nameid_salt(self):
+ return self.get_config_value('idp nameid salt')
+
@property
def default_allowed_nameids(self):
return self.get_config_value('default allowed nameids')
def default_email_domain(self):
return self.get_config_value('default email domain')
+ @property
+ def default_attribute_mapping(self):
+ return self.get_config_value('default attribute mapping')
+
+ @property
+ def default_allowed_attributes(self):
+ return self.get_config_value('default allowed attributes')
+
def get_tree(self, site):
self.idp = self.init_idp()
self.page = SAML2(site, self)
self.admin = Saml2AdminPage(site, self)
+ self.rest = Saml2RestBase(site, self)
return self.page
def init_idp(self):
self._debug('Failed to init SAML2 provider: %r' % e)
return None
+ self._root.logout.add_handler(self.name, self.idp_initiated_logout)
+
# Import all known applications
data = self.get_data()
for idval in data:
if self.admin:
self.admin.add_sps()
+ def idp_initiated_logout(self):
+ """
+ Logout all SP sessions when the logout comes from the IdP.
+
+ For the current user only.
+ """
+ self._debug("IdP-initiated SAML2 logout")
+ us = UserSession()
+
+ saml_sessions = us.get_provider_data('saml2')
+ if saml_sessions is None:
+ self._debug("No SAML2 sessions to logout")
+ return
+ session = saml_sessions.get_next_logout(remove=False)
+ if session is None:
+ return
+
+ # Add a fake session to indicate where the user should
+ # be redirected to when all SP's are logged out.
+ idpurl = self._root.instance_base_url()
+ saml_sessions.add_session("_idp_initiated_logout",
+ idpurl,
+ "")
+ init_session = saml_sessions.find_session_by_provider(idpurl)
+ init_session.set_logoutstate(idpurl, "idp_initiated_logout", None)
+ saml_sessions.start_logout(init_session)
+
+ logout = self.idp.get_logout_handler()
+ logout.setSessionFromDump(session.session.dump())
+ logout.initRequest(session.provider_id)
+ try:
+ logout.buildRequestMsg()
+ except lasso.Error, e:
+ self.error('failure to build logout request msg: %s' % e)
+ raise cherrypy.HTTPRedirect(400, 'Failed to log out user: %s '
+ % e)
+
+ raise cherrypy.HTTPRedirect(logout.msgUrl)
+
class IdpMetadataGenerator(object):
- def __init__(self, url, idp_cert):
- self.meta = metadata.Metadata(metadata.IDP_ROLE)
+ def __init__(self, url, idp_cert, expiration=None):
+ self.meta = metadata.Metadata(metadata.IDP_ROLE, expiration)
self.meta.set_entity_id('%s/saml2/metadata' % url)
self.meta.add_certs(idp_cert, idp_cert)
self.meta.add_service(metadata.SAML2_SERVICE_MAP['sso-post'],
'%s/saml2/SSO/POST' % url)
self.meta.add_service(metadata.SAML2_SERVICE_MAP['sso-redirect'],
'%s/saml2/SSO/Redirect' % url)
- self.meta.add_allowed_name_format(
- lasso.SAML2_NAME_IDENTIFIER_FORMAT_TRANSIENT)
+ self.meta.add_service(metadata.SAML2_SERVICE_MAP['logout-redirect'],
+ '%s/saml2/SLO/Redirect' % url)
self.meta.add_allowed_name_format(
lasso.SAML2_NAME_IDENTIFIER_FORMAT_PERSISTENT)
+ self.meta.add_allowed_name_format(
+ lasso.SAML2_NAME_IDENTIFIER_FORMAT_TRANSIENT)
self.meta.add_allowed_name_format(
lasso.SAML2_NAME_IDENTIFIER_FORMAT_EMAIL)
return self.meta.output(path)
-class Installer(object):
+class Installer(ProviderInstaller):
def __init__(self, *pargs):
+ super(Installer, self).__init__()
self.name = 'saml2'
- self.ptype = 'provider'
self.pargs = pargs
def install_args(self, group):
if opts['secure'].lower() == 'no':
proto = 'http'
url = '%s://%s/%s' % (proto, opts['hostname'], opts['instance'])
- meta = IdpMetadataGenerator(url, cert)
+ meta = IdpMetadataGenerator(url, cert,
+ timedelta(METADATA_VALIDITY_PERIOD))
if 'krb' in opts and opts['krb'] == 'yes':
meta.meta.add_allowed_name_format(
lasso.SAML2_NAME_IDENTIFIER_FORMAT_KERBEROS)
config = {'idp storage path': path,
'idp metadata file': 'metadata.xml',
'idp certificate file': cert.cert,
- 'idp key file': cert.key}
+ 'idp key file': cert.key,
+ 'idp nameid salt': uuid.uuid4().hex}
po.save_plugin_config(config)
# Update global config to add login plugin
projects / cascardo / ipsilon.git / blobdiff