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 ProviderPageBase, ProviderException
21 from ipsilon.providers.common import AuthenticationError, InvalidRequest
22 from ipsilon.providers.saml2.provider import ServiceProvider
23 from ipsilon.providers.saml2.provider import InvalidProviderId
24 from ipsilon.providers.saml2.provider import NameIdNotAllowed
25 from ipsilon.util.user import UserSession
26 from ipsilon.util.trans import Transaction
32 class UnknownProvider(ProviderException):
34 def __init__(self, message):
35 super(UnknownProvider, self).__init__(message)
39 class AuthenticateRequest(ProviderPageBase):
41 def __init__(self, *args, **kwargs):
42 super(AuthenticateRequest, self).__init__(*args, **kwargs)
46 def _preop(self, *args, **kwargs):
48 # generate a new id or get current one
49 self.trans = Transaction('saml2', **kwargs)
50 if self.trans.cookie.value != self.trans.provider:
51 self.debug('Invalid transaction, %s != %s' % (
52 self.trans.cookie.value, self.trans.provider))
53 except Exception, e: # pylint: disable=broad-except
54 self.debug('Transaction initialization failed: %s' % repr(e))
55 raise cherrypy.HTTPError(400, 'Invalid transaction id')
57 def pre_GET(self, *args, **kwargs):
58 self._preop(*args, **kwargs)
60 def pre_POST(self, *args, **kwargs):
61 self._preop(*args, **kwargs)
63 def auth(self, login):
65 self.saml2checks(login)
66 except AuthenticationError, e:
67 self.saml2error(login, e.code, e.message)
68 return self.reply(login)
70 def _parse_request(self, message):
72 login = self.cfg.idp.get_login_handler()
75 login.processAuthnRequestMsg(message)
76 except (lasso.ProfileInvalidMsgError,
77 lasso.ProfileMissingIssuerError), e:
79 msg = 'Malformed Request %r [%r]' % (e, message)
80 raise InvalidRequest(msg)
82 except (lasso.ProfileInvalidProtocolprofileError,
85 msg = 'Invalid SAML Request: %r (%r [%r])' % (login.request,
87 raise InvalidRequest(msg)
89 except (lasso.ServerProviderNotFoundError,
90 lasso.ProfileUnknownProviderError), e:
92 msg = 'Invalid SP [%s] (%r [%r])' % (login.remoteProviderId,
94 raise UnknownProvider(msg)
96 self._debug('SP %s requested authentication' % login.remoteProviderId)
100 def saml2login(self, request):
103 raise cherrypy.HTTPError(400,
104 'SAML request token missing or empty')
107 login = self._parse_request(request)
108 except InvalidRequest, e:
110 raise cherrypy.HTTPError(400, 'Invalid SAML request token')
111 except UnknownProvider, e:
113 raise cherrypy.HTTPError(400, 'Unknown Service Provider')
114 except Exception, e: # pylint: disable=broad-except
116 raise cherrypy.HTTPError(500)
120 def saml2checks(self, login):
124 if user.is_anonymous:
125 if self.stage == 'init':
126 returl = '%s/saml2/SSO/Continue?%s' % (
127 self.basepath, self.trans.get_GET_arg())
128 data = {'saml2_stage': 'auth',
129 'saml2_request': login.dump(),
130 'login_return': returl}
131 self.trans.store(data)
132 redirect = '%s/login?%s' % (self.basepath,
133 self.trans.get_GET_arg())
134 raise cherrypy.HTTPRedirect(redirect)
136 raise AuthenticationError(
137 "Unknown user", lasso.SAML2_STATUS_CODE_AUTHN_FAILED)
139 self._audit("Logged in user: %s [%s]" % (user.name, user.fullname))
141 # We can wipe the transaction now, as this is the last step
144 # TODO: check if this is the first time this user access this SP
145 # If required by user prefs, ask user for consent once and then
149 # TODO: check destination
152 provider = ServiceProvider(self.cfg, login.remoteProviderId)
153 nameidfmt = provider.get_valid_nameid(login.request.nameIdPolicy)
154 except NameIdNotAllowed, e:
155 raise AuthenticationError(
156 str(e), lasso.SAML2_STATUS_CODE_INVALID_NAME_ID_POLICY)
157 except InvalidProviderId, e:
158 raise AuthenticationError(
159 str(e), lasso.SAML2_STATUS_CODE_AUTHN_FAILED)
161 # TODO: check login.request.forceAuthn
163 login.validateRequestMsg(not user.is_anonymous, consent)
165 authtime = datetime.datetime.utcnow()
166 skew = datetime.timedelta(0, 60)
167 authtime_notbefore = authtime - skew
168 authtime_notafter = authtime + skew
170 # TODO: get authentication type fnd name format from session
171 # need to save which login manager authenticated and map it to a
172 # saml2 authentication context
173 authn_context = lasso.SAML2_AUTHN_CONTEXT_UNSPECIFIED
175 timeformat = '%Y-%m-%dT%H:%M:%SZ'
176 login.buildAssertion(authn_context,
177 authtime.strftime(timeformat),
179 authtime_notbefore.strftime(timeformat),
180 authtime_notafter.strftime(timeformat))
183 if nameidfmt == lasso.SAML2_NAME_IDENTIFIER_FORMAT_PERSISTENT:
184 # TODO map to something else ?
185 nameid = provider.normalize_username(user.name)
186 elif nameidfmt == lasso.SAML2_NAME_IDENTIFIER_FORMAT_TRANSIENT:
187 # TODO map to something else ?
188 nameid = provider.normalize_username(user.name)
189 elif nameidfmt == lasso.SAML2_NAME_IDENTIFIER_FORMAT_KERBEROS:
190 nameid = us.get_data('user', 'krb_principal_name')
191 elif nameidfmt == lasso.SAML2_NAME_IDENTIFIER_FORMAT_EMAIL:
192 nameid = us.get_user().email
194 nameid = '%s@%s' % (user.name, self.cfg.default_email_domain)
197 login.assertion.subject.nameId.format = nameidfmt
198 login.assertion.subject.nameId.content = nameid
201 raise AuthenticationError("Unavailable Name ID type",
202 lasso.SAML2_STATUS_CODE_AUTHN_FAILED)
204 # TODO: filter user attributes as policy requires from 'usersession'
205 if not login.assertion.attributeStatement:
206 attrstat = lasso.Saml2AttributeStatement()
207 login.assertion.attributeStatement = [attrstat]
209 attrstat = login.assertion.attributeStatement[0]
210 if not attrstat.attribute:
211 attrstat.attribute = ()
214 userattrs = us.get_user_attrs()
215 for key, value in userattrs.get('userdata', {}).iteritems():
216 if type(value) is str:
217 attributes[key] = value
218 if 'groups' in userattrs:
219 attributes['group'] = userattrs['groups']
220 for _, info in userattrs.get('extras', {}).iteritems():
221 for key, value in info.items():
222 attributes[key] = value
224 for key in attributes:
225 values = attributes[key]
226 if type(values) is not list:
229 attr = lasso.Saml2Attribute()
231 attr.nameFormat = lasso.SAML2_ATTRIBUTE_NAME_FORMAT_BASIC
232 value = str(value).encode('utf-8')
233 self.debug('value %s' % value)
234 node = lasso.MiscTextNode.newWithString(value)
235 node.textChild = True
236 attrvalue = lasso.Saml2AttributeValue()
237 attrvalue.any = [node]
238 attr.attributeValue = [attrvalue]
239 attrstat.attribute = attrstat.attribute + (attr,)
241 self.debug('Assertion: %s' % login.assertion.dump())
243 def saml2error(self, login, code, message):
244 status = lasso.Samlp2Status()
245 status.statusCode = lasso.Samlp2StatusCode()
246 status.statusCode.value = lasso.SAML2_STATUS_CODE_RESPONDER
247 status.statusCode.statusCode = lasso.Samlp2StatusCode()
248 status.statusCode.statusCode.value = code
249 login.response.status = status
251 def reply(self, login):
252 if login.protocolProfile == lasso.LOGIN_PROTOCOL_PROFILE_BRWS_ART:
254 raise cherrypy.HTTPError(501)
255 elif login.protocolProfile == lasso.LOGIN_PROTOCOL_PROFILE_BRWS_POST:
256 login.buildAuthnResponseMsg()
257 self._debug('POSTing back to SP [%s]' % (login.msgUrl))
259 "title": 'Redirecting back to the web application',
260 "action": login.msgUrl,
262 [lasso.SAML2_FIELD_RESPONSE, login.msgBody],
263 [lasso.SAML2_FIELD_RELAYSTATE, login.msgRelayState],
265 "submit": 'Return to application',
267 # pylint: disable=star-args
268 return self._template('saml2/post_response.html', **context)
271 raise cherrypy.HTTPError(500)