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.providers.common import ProviderBase, ProviderPageBase
21 from ipsilon.providers.common import FACILITY
22 from ipsilon.providers.saml2.auth import AuthenticateRequest
23 from ipsilon.providers.saml2.admin import AdminPage
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
35 class Redirect(AuthenticateRequest):
37 def GET(self, *args, **kwargs):
39 query = cherrypy.request.query_string
41 login = self.saml2login(query)
42 return self.auth(login)
45 class POSTAuth(AuthenticateRequest):
47 def POST(self, *args, **kwargs):
49 request = kwargs.get(lasso.SAML2_FIELD_REQUEST)
50 relaystate = kwargs.get(lasso.SAML2_FIELD_RELAYSTATE)
52 login = self.saml2login(request)
53 login.set_msgRelayState(relaystate)
54 return self.auth(login)
57 class Continue(AuthenticateRequest):
59 def GET(self, *args, **kwargs):
61 session = UserSession()
62 user = session.get_user()
63 session.nuke_data('login', 'Return')
64 self.stage = session.get_data('saml2', 'stage')
67 self._debug("User is marked anonymous?!")
68 # TODO: Return to SP with auth failed error
69 raise cherrypy.HTTPError(401)
71 self._debug('Continue auth for %s' % user.name)
73 dump = session.get_data('saml2', 'Request')
75 self._debug("Couldn't find Request dump?!")
76 # TODO: Return to SP with auth failed error
77 raise cherrypy.HTTPError(400)
80 login = self.cfg.idp.get_login_handler(dump)
81 except Exception, e: # pylint: disable=broad-except
82 self._debug('Failed to load status from dump: %r' % e)
85 self._debug("Empty Request dump?!")
86 # TODO: Return to SP with auth failed error
87 raise cherrypy.HTTPError(400)
89 return self.auth(login)
92 class SSO(ProviderPageBase):
94 def __init__(self, *args, **kwargs):
95 super(SSO, self).__init__(*args, **kwargs)
96 self.Redirect = Redirect(*args, **kwargs)
97 self.POST = POSTAuth(*args, **kwargs)
98 self.Continue = Continue(*args, **kwargs)
101 class Metadata(ProviderPageBase):
102 def GET(self, *args, **kwargs):
103 with open(self.cfg.idp_metadata_file) as m:
105 cherrypy.response.headers["Content-Type"] = "text/xml"
106 cherrypy.response.headers["Content-Disposition"] = \
107 'attachment; filename="metadata.xml"'
111 class SAML2(ProviderPageBase):
113 def __init__(self, *args, **kwargs):
114 super(SAML2, self).__init__(*args, **kwargs)
115 self.metadata = Metadata(*args, **kwargs)
119 self.cfg.idp = IdentityProvider(self.cfg)
120 except Exception, e: # pylint: disable=broad-except
121 self._debug('Failed to init SAML2 provider: %r' % e)
124 # Import all known applications
125 data = self.cfg.get_data()
128 if 'type' not in sp or sp['type'] != 'SP':
130 if 'name' not in sp or 'metadata' not in sp:
133 self.cfg.idp.add_provider(sp)
134 except Exception, e: # pylint: disable=broad-except
135 self._debug('Failed to add SP %s: %r' % (sp['name'], e))
137 self.SSO = SSO(*args, **kwargs)
140 class IdpProvider(ProviderBase):
143 super(IdpProvider, self).__init__('saml2', 'saml2')
146 self.description = """
147 Provides SAML 2.0 authentication infrastructure. """
150 'idp storage path': [
151 """ Path to data storage accessible by the IdP """,
153 '/var/lib/ipsilon/saml2'
155 'idp metadata file': [
156 """ The IdP Metadata file genearated at install time. """,
160 'idp certificate file': [
161 """ The IdP PEM Certificate genearated at install time. """,
166 """ The IdP Certificate Key genearated at install time. """,
170 'allow self registration': [
171 """ Allow authenticated users to register applications. """,
175 'default allowed nameids': [
176 """Default Allowed NameIDs for Service Providers. """,
178 ['persistent', 'transient', 'email', 'kerberos', 'x509']
181 """Default NameID used by Service Providers. """,
185 'default email domain': [
186 """Default email domain, for users missing email property.""",
191 if cherrypy.config.get('debug', False):
194 logger = logging.getLogger('lasso')
195 lh = logging.StreamHandler(sys.stderr)
196 logger.addHandler(lh)
197 logger.setLevel(logging.DEBUG)
200 def allow_self_registration(self):
201 return self.get_config_value('allow self registration')
204 def idp_storage_path(self):
205 return self.get_config_value('idp storage path')
208 def idp_metadata_file(self):
209 return os.path.join(self.idp_storage_path,
210 self.get_config_value('idp metadata file'))
213 def idp_certificate_file(self):
214 return os.path.join(self.idp_storage_path,
215 self.get_config_value('idp certificate file'))
218 def idp_key_file(self):
219 return os.path.join(self.idp_storage_path,
220 self.get_config_value('idp key file'))
223 def default_allowed_nameids(self):
224 return self.get_config_value('default allowed nameids')
227 def default_nameid(self):
228 return self.get_config_value('default nameid')
231 def default_email_domain(self):
232 return self.get_config_value('default email domain')
234 def get_tree(self, site):
235 self.page = SAML2(site, self)
236 self.admin = AdminPage(site, self)
240 class Installer(object):
244 self.ptype = 'provider'
246 def install_args(self, group):
247 group.add_argument('--saml2', choices=['yes', 'no'], default='yes',
248 help='Configure SAML2 Provider')
249 group.add_argument('--saml2-secure',
250 choices=['yes', 'no'], default='yes',
251 help='Configure SAML2 Provider')
253 def configure(self, opts):
254 if opts['saml2'] != 'yes':
257 # Check storage path is present or create it
258 path = os.path.join(opts['data_dir'], 'saml2')
259 if not os.path.exists(path):
260 os.makedirs(path, 0700)
262 # Use the same cert for signing and ecnryption for now
263 cert = Certificate(path)
264 cert.generate('idp', opts['hostname'])
266 # Generate Idp Metadata
268 if opts['saml2_secure'].lower() == 'no':
270 url = '%s://%s/%s/saml2' % (proto, opts['hostname'], opts['instance'])
271 meta = metadata.Metadata(metadata.IDP_ROLE)
272 meta.set_entity_id(url + '/metadata')
273 meta.add_certs(cert, cert)
274 meta.add_service(metadata.SAML2_SERVICE_MAP['sso-post'],
276 meta.add_service(metadata.SAML2_SERVICE_MAP['sso-redirect'],
277 url + '/SSO/Redirect')
279 meta.add_allowed_name_format(
280 lasso.SAML2_NAME_IDENTIFIER_FORMAT_TRANSIENT)
281 meta.add_allowed_name_format(
282 lasso.SAML2_NAME_IDENTIFIER_FORMAT_PERSISTENT)
283 meta.add_allowed_name_format(
284 lasso.SAML2_NAME_IDENTIFIER_FORMAT_EMAIL)
285 if 'krb' in opts and opts['krb'] == 'yes':
286 meta.add_allowed_name_format(
287 lasso.SAML2_NAME_IDENTIFIER_FORMAT_KERBEROS)
289 meta.output(os.path.join(path, 'metadata.xml'))
291 # Add configuration data to database
296 po.wipe_config_values(FACILITY)
297 config = {'idp storage path': path,
298 'idp metadata file': 'metadata.xml',
299 'idp certificate file': cert.cert,
300 'idp key file': cert.key,
302 po.set_config(config)
303 po.save_plugin_config(FACILITY)
305 # Fixup permissions so only the ipsilon user can read these files
306 files.fix_user_dirs(path, opts['system_user'])