def __init__(self, app, app_conf, prefix=PARAM_PREFIX, **local_conf):
"""
Sets up the server depending on the configuration.
@type app: WSGI application
@param app: wrapped application/middleware
@type app_conf: dict
@param app_conf: application configuration settings - ignored - this
method includes this arg to fit Paste middleware / app function
signature
@@type prefix: str
@param prefix: optional prefix for parameter names included in the
local_conf dict - enables these parameters to be filtered from others
which don't apply to this middleware
@type local_conf: dict
@param local_conf: attribute settings to apply
"""
self._app = app
conf = self._set_configuration(prefix, local_conf)
if self.access_token_type == 'bearer':
# Simple bearer token configuration.
access_token_generator = BearerTokenGenerator(
self.access_token_lifetime_seconds, self.access_token_type)
else:
raise ValueError(
"Invalid configuration value %s for %s" %
(self.access_token_type, self.ACCESS_TOKEN_TYPE_OPTION))
# Store user identifier with grant - this isn't needed for the OAuth
# protocol but is needed to return certificates using MyProxy.
authorizer = AuthorizerStoringIdentifier(
self.authorization_grant_lifetime_seconds,
user_identifier_env_key=self.user_identifier_env_key,
user_identifier_grant_data_key=self.USER_IDENTIFIER_GRANT_DATA_KEY)
# Determine client authentication type. A 'none' options is allowed so
# that development/testing can be performed without running on Apache.
client_register = ClientRegister(self.client_register_file)
client_authenticator = self._get_authenticator(
self.client_authentication_method, client_register, 'client',
self.CLIENT_AUTHENTICATION_METHOD_OPTION)
# same for resource authentication type.
resource_register = ResourceRegister(self.resource_register_file)
resource_authenticator = self._get_authenticator(
self.resource_authentication_method, resource_register, 'resource',
self.RESOURCE_AUTHENTICATION_METHOD_OPTION)
self._authorizationServer = AuthorizationServer(
client_register, authorizer, client_authenticator,
resource_register, resource_authenticator, access_token_generator,
conf)
def __init__(self, app, app_conf, prefix=PARAM_PREFIX, **local_conf):
"""
Sets up the server depending on the configuration.
@type app: WSGI application
@param app: wrapped application/middleware
@type app_conf: dict
@param app_conf: application configuration settings - ignored - this
method includes this arg to fit Paste middleware / app function
signature
@@type prefix: str
@param prefix: optional prefix for parameter names included in the
local_conf dict - enables these parameters to be filtered from others
which don't apply to this middleware
@type local_conf: dict
@param local_conf: attribute settings to apply
"""
self._app = app
conf = self._set_configuration(prefix, local_conf)
if self.access_token_type == 'bearer':
# Simple bearer token configuration.
access_token_generator = BearerTokenGenerator(
self.access_token_lifetime_seconds,
self.access_token_type)
else:
raise ValueError("Invalid configuration value %s for %s" %
(self.access_token_type,
self.ACCESS_TOKEN_TYPE_OPTION))
# Store user identifier with grant - this isn't needed for the OAuth
# protocol but is needed to return certificates using MyProxy.
authorizer = AuthorizerStoringIdentifier(
self.authorization_grant_lifetime_seconds,
user_identifier_env_key=self.user_identifier_env_key,
user_identifier_grant_data_key=self.USER_IDENTIFIER_GRANT_DATA_KEY)
# Determine client authentication type. A 'none' options is allowed so
# that development/testing can be performed without running on Apache.
client_register = ClientRegister(self.client_register_file)
client_authenticator = self._get_authenticator(
self.client_authentication_method, client_register,
'client', self.CLIENT_AUTHENTICATION_METHOD_OPTION)
# same for resource authentication type.
resource_register = ResourceRegister(self.resource_register_file)
resource_authenticator = self._get_authenticator(
self.resource_authentication_method, resource_register,
'resource', self.RESOURCE_AUTHENTICATION_METHOD_OPTION)
self._authorizationServer = AuthorizationServer(
client_register, authorizer, client_authenticator,
resource_register, resource_authenticator,
access_token_generator, conf)
class Oauth2ServerMiddleware(object):
"""
WSGI OAuth 2.0 server implements Authorisation and Resource server functions
Requires:
o Beaker session
o An authentication provider that sets the user's ID in the environ, e.g.,
repose.who
o MyProxyClientMiddleware (ONLY required for X.509 cert based token
generation used with SLCS config)
o Middleware to set user's decisions for authorization of OAuth clients in
the environ, e.g., ndg.oauth.server.wsgi.authorization_filter.
"""
PARAM_PREFIX = 'oauth2server.'
CERT_DN_ENVIRON_KEY = 'SSL_CLIENT_S_DN'
# Configuration options
ACCESS_TOKEN_LIFETIME_OPTION = 'access_token_lifetime'
ACCESS_TOKEN_TYPE_OPTION = 'access_token_type'
AUTHORIZATION_GRANT_LIFETIME_OPTION = 'authorization_grant_lifetime'
BASE_URL_PATH_OPTION = 'base_url_path'
CERTIFICATE_REQUEST_PARAMETER_OPTION = 'certificate_request_parameter'
CLIENT_AUTHENTICATION_METHOD_OPTION = 'client_authentication_method'
CLIENT_AUTHORIZATION_URL_OPTION = 'client_authorization_url'
CLIENT_AUTHORIZATIONS_KEY_OPTION = 'client_authorizations_key'
CLIENT_REGISTER_OPTION = 'client_register'
RESOURCE_AUTHENTICATION_METHOD_OPTION = 'resource_authentication_method'
RESOURCE_REGISTER_OPTION = 'resource_register'
MYPROXY_CLIENT_KEY_OPTION = 'myproxy_client_key'
MYPROXY_GLOBAL_PASSWORD_OPTION = 'myproxy_global_password'
USER_IDENTIFIER_KEY_OPTION = 'user_identifier_key'
USER_IDENTIFIER_GRANT_DATA_KEY = 'user_identifier'
AUTHORISATION_SERVER_ENVIRON_KEYNAME = \
'ndg.oauth.server.authorisation.server'
# Configuration option defaults
PROPERTY_DEFAULTS = {
ACCESS_TOKEN_LIFETIME_OPTION: 86400,
ACCESS_TOKEN_TYPE_OPTION: 'bearer',
AUTHORIZATION_GRANT_LIFETIME_OPTION: 600,
BASE_URL_PATH_OPTION: '',
CERTIFICATE_REQUEST_PARAMETER_OPTION: 'certificate_request',
CLIENT_AUTHENTICATION_METHOD_OPTION: 'certificate',
CLIENT_AUTHORIZATION_URL_OPTION: '/client_authorization/authorize',
CLIENT_AUTHORIZATIONS_KEY_OPTION: 'client_authorizations',
RESOURCE_AUTHENTICATION_METHOD_OPTION: 'none',
MYPROXY_CLIENT_KEY_OPTION: \
'myproxy.server.wsgi.middleware.MyProxyClientMiddleware.myProxyClient',
USER_IDENTIFIER_KEY_OPTION: 'REMOTE_USER'
}
method = {
'/access_token': 'access_token',
'/authorize': 'authorize',
'/check_token': 'check_token',
'/request_certificate': 'request_certificate'
}
def __init__(self, app, app_conf, prefix=PARAM_PREFIX, **local_conf):
"""
Sets up the server depending on the configuration.
@type app: WSGI application
@param app: wrapped application/middleware
@type app_conf: dict
@param app_conf: application configuration settings - ignored - this
method includes this arg to fit Paste middleware / app function
signature
@@type prefix: str
@param prefix: optional prefix for parameter names included in the
local_conf dict - enables these parameters to be filtered from others
which don't apply to this middleware
@type local_conf: dict
@param local_conf: attribute settings to apply
"""
self._app = app
conf = self._set_configuration(prefix, local_conf)
if self.access_token_type == 'bearer':
# Simple bearer token configuration.
access_token_generator = BearerTokenGenerator(
self.access_token_lifetime_seconds, self.access_token_type)
else:
raise ValueError(
"Invalid configuration value %s for %s" %
(self.access_token_type, self.ACCESS_TOKEN_TYPE_OPTION))
# Store user identifier with grant - this isn't needed for the OAuth
# protocol but is needed to return certificates using MyProxy.
authorizer = AuthorizerStoringIdentifier(
self.authorization_grant_lifetime_seconds,
user_identifier_env_key=self.user_identifier_env_key,
user_identifier_grant_data_key=self.USER_IDENTIFIER_GRANT_DATA_KEY)
# Determine client authentication type. A 'none' options is allowed so
# that development/testing can be performed without running on Apache.
client_register = ClientRegister(self.client_register_file)
client_authenticator = self._get_authenticator(
self.client_authentication_method, client_register, 'client',
self.CLIENT_AUTHENTICATION_METHOD_OPTION)
# same for resource authentication type.
resource_register = ResourceRegister(self.resource_register_file)
resource_authenticator = self._get_authenticator(
self.resource_authentication_method, resource_register, 'resource',
self.RESOURCE_AUTHENTICATION_METHOD_OPTION)
self._authorizationServer = AuthorizationServer(
client_register, authorizer, client_authenticator,
resource_register, resource_authenticator, access_token_generator,
conf)
def _get_authenticator(self, name, register, typ, option_name):
"""Returns new authenticator by name"""
if name == 'certificate':
return CertificateAuthenticator(typ, register)
elif name == 'password':
return PasswordAuthenticator(typ, register)
elif name == 'none':
return NoopAuthenticator(typ)
else:
raise ValueError("Invalid configuration value %s for %s" %
(name, option_name))
def __call__(self, environ, start_response):
"""
@type environ: dict
@param environ: WSGI environment
@type start_response: WSGI start response function
@param start_response: start response function
@rtype: iterable
@return: WSGI response
"""
log.debug("Oauth2ServerMiddleware.__call__ ...")
req = Request(environ)
log.debug("Request path_info: %s", req.path_info)
# Set Authorisation Server as key in environ for access by downstream
# middleware or app. For example, a resource server can use it to
# check access tokens presented to it from clients against ones issued
# by the authorisation server
environ[
self.__class__.
AUTHORISATION_SERVER_ENVIRON_KEYNAME] = self._authorizationServer
# Determine what operation the URL specifies.
actionPath = None
if req.path_info.startswith(self.base_path):
actionPath = req.path_info[len(self.base_path):]
methodName = self.__class__.method.get(actionPath, '')
if methodName:
log.debug("Method: %s" % methodName)
action = getattr(self, methodName)
return action(req, start_response)
elif self._app is not None:
log.debug("Delegating to lower filter/application.")
return self._app(environ, start_response)
else:
response = "OAuth 2.0 Server - Invalid URL"
start_response(self._get_http_status_string(httplib.NOT_FOUND),
[('Content-type', 'text/plain'),
('Content-length', str(len(response)))])
return [response]
def authorize(self, req, start_response):
"""Handles OAuth 2 authorize request.
@type req: webob.Request
@param req: HTTP request object
@type start_response: WSGI start response function
@param start_response: start response function
@rtype: iterable
@return: WSGI response
"""
# Stop immediately if the client is not registered.
(error, error_description
) = self._authorizationServer.is_registered_client(req)
if error:
log.debug("Error checking if client registered: %s - %s", error,
error_description)
return self._error_response(error, error_description,
start_response)
# User authentication is required before authorization can proceed.
user = req.environ.get(self.user_identifier_env_key)
if not user:
log.debug("%s not in environ - authentication required",
self.user_identifier_env_key)
start_response(self._get_http_status_string(httplib.UNAUTHORIZED),
[])
return []
# User authorization for the client is also required.
client_authorized, authz_uri = self._check_client_authorization(
user, req)
if authz_uri:
log.debug("Redirecting to %s", authz_uri)
return self._redirect(authz_uri, start_response)
if not client_authorized:
log.debug("User has declined authorization for client.")
# Request authorization grant or for Implicit Grant flow
(redirect_uri, error,
error_description) = self._authorizationServer.authorize(
req, client_authorized)
if error:
return self._error_response(error, error_description,
start_response)
else:
return self._redirect(redirect_uri, start_response)
def _error_response(self, error, error_description, start_response):
"""Returns and error response.
"""
response = ("%s: %s" % (error, error_description)).encode(
'ascii', 'ignore')
log.error("Returning error: %s - %s", error, error_description)
start_response(self._get_http_status_string(httplib.BAD_REQUEST),
[('Content-type', 'text/plain'),
('Content-length', str(len(response)))])
return [response]
def _check_client_authorization(self, user, req):
"""
Gets the URL to which to redirect for the user to authorize the client.
Returns: URL or None if already authorized
@type user: str
@param user: identifier of user/resource owner
@type req: webob.Request
@param req: HTTP request object
"""
client_authorizations = req.environ.get(
self.client_authorizations_env_key)
client_id = req.params.get('client_id')
scope = req.params.get('scope')
if not client_authorizations:
client_authorized = None
log.debug(
"Client authorization register not found in environ "
"(key %s).", self.client_authorizations_env_key)
else:
client_authorized = \
client_authorizations.is_client_authorized_by_user(user,
client_id,
scope)
if client_authorized is None:
log.debug(
"Client not authorized by user (client_id: %s scope: %s"
" user: %s).", client_id, scope, user)
url_params = {
'client_id': client_id,
'scope': scope,
'user': user,
'original_url': req.url
}
url = ("%s?%s" % (self._make_client_authorization_url(req),
urllib.urlencode(url_params)))
return (None, url)
return client_authorized, None
def _make_client_authorization_url(self, req):
parts = urlparse.urlparse(self.client_authorization_url)
if (parts.scheme and parts.netloc):
# Absolute URL:
return self.client_authorization_url
else:
# Relative - append to application URL:
return '/'.join([
req.application_url.rstrip('/'),
self.client_authorization_url.lstrip('/')
])
def access_token(self, req, start_response):
"""Handles OAuth 2 access token request.
@type req: webob.Request
@param req: HTTP request object
@type start_response:
@param start_response: WSGI start response function
@rtype: iterable
@return: WSGI response
"""
log.debug("access_token called")
(response, error_status,
error_description) = self._authorizationServer.access_token(req)
if response is None:
response = ''
headers = [('Content-Type', 'application/json; charset=UTF-8'),
('Cache-Control', 'no-store'),
('Content-length', str(len(response))),
('Pragma', 'no-store')]
status_str = self._get_http_status_string(
error_status if error_status else httplib.OK)
if error_status:
log.debug("Error obtaining access token: %s - %s", status_str,
error_description)
start_response(status_str, headers)
return [response]
def check_token(self, req, start_response):
"""
Service to validate bearer tokens. It would be called from a resource
service that trusts this authorization service.
@type req: webob.Request
@param req: HTTP request object
@type start_response:
@param start_response: WSGI start response function
@rtype: iterable
@return: WSGI response
"""
response, error_status = self._authorizationServer.check_token(
req)[0:2]
if response is None:
response = ''
headers = [('Content-Type', 'application/json; charset=UTF-8'),
('Cache-Control', 'no-store'),
('Content-length', str(len(response))),
('Pragma', 'no-store')]
status_str = self._get_http_status_string(
error_status if error_status else httplib.OK)
start_response(status_str, headers)
return [response]
@staticmethod
def _get_http_status_string(status):
return ("%d %s" % (status, httplib.responses[status]))
def _redirect(self, url, start_response):
"""Initiates a redirect to a specified URL.
@type param: str
@param url: URL
@type start_response:
@param start_response: WSGI start response function
@rtype: iterable
@return: WSGI response
"""
log.debug("Redirecting to %s", url)
start_response(self._get_http_status_string(httplib.FOUND),
[('Location', url.encode('ascii', 'ignore'))])
return []
def _set_configuration(self, prefix, local_conf):
"""Sets the configuration values.
@type prefix: str
@param prefix: optional prefix for parameter names included in the
local_conf dict - enables these parameters to be filtered from others
which don't apply to this middleware
@type local_conf: dict
@param local_conf: attribute settings to apply
"""
conf = {}
plen = len(prefix)
for k, v in local_conf.iteritems():
if k.startswith(prefix):
conf[k[plen:]] = v
cls = self.__class__
self.base_path = cls._get_config_option(conf, cls.BASE_URL_PATH_OPTION)
self.authorization_grant_lifetime_seconds = cls._get_config_option(
conf, cls.AUTHORIZATION_GRANT_LIFETIME_OPTION)
self.access_token_lifetime_seconds = cls._get_config_option(
conf, cls.ACCESS_TOKEN_LIFETIME_OPTION)
self.access_token_type = cls._get_config_option(
conf, cls.ACCESS_TOKEN_TYPE_OPTION)
self.certificate_request_parameter = cls._get_config_option(
conf, cls.CERTIFICATE_REQUEST_PARAMETER_OPTION)
self.client_authorization_url = cls._get_config_option(
conf, cls.CLIENT_AUTHORIZATION_URL_OPTION)
self.client_authentication_method = cls._get_config_option(
conf, cls.CLIENT_AUTHENTICATION_METHOD_OPTION)
self.client_authorizations_env_key = cls._get_config_option(
conf, cls.CLIENT_AUTHORIZATIONS_KEY_OPTION)
self.client_register_file = cls._get_config_option(
conf, cls.CLIENT_REGISTER_OPTION)
self.resource_authentication_method = cls._get_config_option(
conf, cls.RESOURCE_AUTHENTICATION_METHOD_OPTION)
self.resource_register_file = cls._get_config_option(
conf, cls.RESOURCE_REGISTER_OPTION)
self.myproxy_client_env_key = cls._get_config_option(
conf, cls.MYPROXY_CLIENT_KEY_OPTION)
self.myproxy_global_password = cls._get_config_option(
conf, cls.MYPROXY_GLOBAL_PASSWORD_OPTION)
self.user_identifier_env_key = cls._get_config_option(
conf, cls.USER_IDENTIFIER_KEY_OPTION)
# Return any options that start with the prefix but haven't been read
# above.
return conf
@classmethod
def _get_config_option(cls, conf, key):
value = conf.pop(key, cls.PROPERTY_DEFAULTS.get(key, None))
log.debug("Oauth2ServerMiddleware configuration %s=%s", key, value)
return value
@classmethod
def filter_app_factory(cls, app, app_conf, **local_conf):
return cls(app, app_conf, **local_conf)
@classmethod
def app_factory(cls, app_conf, **local_conf):
return cls(None, app_conf, **local_conf)
class Oauth2ServerMiddleware(object):
"""
WSGI OAuth 2.0 server implements Authorisation and Resource server functions
Requires:
o Beaker session
o An authentication provider that sets the user's ID in the environ, e.g.,
repose.who
o MyProxyClientMiddleware (ONLY required for X.509 cert based token
generation used with SLCS config)
o Middleware to set user's decisions for authorization of OAuth clients in
the environ, e.g., ndg.oauth.server.wsgi.authorization_filter.
"""
PARAM_PREFIX = 'oauth2server.'
CERT_DN_ENVIRON_KEY = 'SSL_CLIENT_S_DN'
# Configuration options
ACCESS_TOKEN_LIFETIME_OPTION = 'access_token_lifetime'
ACCESS_TOKEN_TYPE_OPTION = 'access_token_type'
AUTHORIZATION_GRANT_LIFETIME_OPTION = 'authorization_grant_lifetime'
BASE_URL_PATH_OPTION = 'base_url_path'
CERTIFICATE_REQUEST_PARAMETER_OPTION = 'certificate_request_parameter'
CLIENT_AUTHENTICATION_METHOD_OPTION = 'client_authentication_method'
CLIENT_AUTHORIZATION_URL_OPTION = 'client_authorization_url'
CLIENT_AUTHORIZATIONS_KEY_OPTION = 'client_authorizations_key'
CLIENT_REGISTER_OPTION = 'client_register'
RESOURCE_AUTHENTICATION_METHOD_OPTION = 'resource_authentication_method'
RESOURCE_REGISTER_OPTION = 'resource_register'
MYPROXY_CLIENT_KEY_OPTION = 'myproxy_client_key'
MYPROXY_GLOBAL_PASSWORD_OPTION = 'myproxy_global_password'
USER_IDENTIFIER_KEY_OPTION = 'user_identifier_key'
USER_IDENTIFIER_GRANT_DATA_KEY = 'user_identifier'
AUTHORISATION_SERVER_ENVIRON_KEYNAME = \
'ndg.oauth.server.authorisation.server'
# Configuration option defaults
PROPERTY_DEFAULTS = {
ACCESS_TOKEN_LIFETIME_OPTION: 86400,
ACCESS_TOKEN_TYPE_OPTION: 'bearer',
AUTHORIZATION_GRANT_LIFETIME_OPTION: 600,
BASE_URL_PATH_OPTION: '',
CERTIFICATE_REQUEST_PARAMETER_OPTION: 'certificate_request',
CLIENT_AUTHENTICATION_METHOD_OPTION: 'certificate',
CLIENT_AUTHORIZATION_URL_OPTION: '/client_authorization/authorize',
CLIENT_AUTHORIZATIONS_KEY_OPTION: 'client_authorizations',
RESOURCE_AUTHENTICATION_METHOD_OPTION: 'none',
MYPROXY_CLIENT_KEY_OPTION: \
'myproxy.server.wsgi.middleware.MyProxyClientMiddleware.myProxyClient',
USER_IDENTIFIER_KEY_OPTION: 'REMOTE_USER'
}
method = {
'/access_token': 'access_token',
'/authorize': 'authorize',
'/check_token': 'check_token',
'/request_certificate': 'request_certificate'
}
def __init__(self, app, app_conf, prefix=PARAM_PREFIX, **local_conf):
"""
Sets up the server depending on the configuration.
@type app: WSGI application
@param app: wrapped application/middleware
@type app_conf: dict
@param app_conf: application configuration settings - ignored - this
method includes this arg to fit Paste middleware / app function
signature
@@type prefix: str
@param prefix: optional prefix for parameter names included in the
local_conf dict - enables these parameters to be filtered from others
which don't apply to this middleware
@type local_conf: dict
@param local_conf: attribute settings to apply
"""
self._app = app
conf = self._set_configuration(prefix, local_conf)
if self.access_token_type == 'bearer':
# Simple bearer token configuration.
access_token_generator = BearerTokenGenerator(
self.access_token_lifetime_seconds,
self.access_token_type)
elif self.access_token_type == 'slcs':
# Configure authorization server to use MyProxy certificates as
# access tokens.
access_token_generator = MyProxyCertTokenGenerator(
self.access_token_lifetime_seconds,
self.access_token_type,
certificate_request_parameter=self.certificate_request_parameter,
myproxy_client_env_key=self.myproxy_client_env_key,
myproxy_global_password=self.myproxy_global_password,
user_identifier_grant_data_key=\
self.USER_IDENTIFIER_GRANT_DATA_KEY)
else:
raise ValueError("Invalid configuration value %s for %s" %
(self.access_token_type,
self.ACCESS_TOKEN_TYPE_OPTION))
# Store user identifier with grant - this isn't needed for the OAuth
# protocol but is needed to return certificates using MyProxy.
authorizer = AuthorizerStoringIdentifier(
self.authorization_grant_lifetime_seconds,
user_identifier_env_key=self.user_identifier_env_key,
user_identifier_grant_data_key=self.USER_IDENTIFIER_GRANT_DATA_KEY)
# Determine client authentication type. A 'none' options is allowed so
# that development/testing can be performed without running on Apache.
client_register = ClientRegister(self.client_register_file)
client_authenticator = self._get_authenticator(
self.client_authentication_method, client_register,
'client', self.CLIENT_AUTHENTICATION_METHOD_OPTION)
# same for resource authentication type.
resource_register = ResourceRegister(self.resource_register_file)
resource_authenticator = self._get_authenticator(
self.resource_authentication_method, resource_register,
'resource', self.RESOURCE_AUTHENTICATION_METHOD_OPTION)
self._authorizationServer = AuthorizationServer(
client_register, authorizer, client_authenticator,
resource_register, resource_authenticator,
access_token_generator, conf)
self._myproxy_cert_request = MyproxyCertRequest(
certificate_request_parameter=self.certificate_request_parameter,
myproxy_client_env_key=self.myproxy_client_env_key,
myproxy_global_password=self.myproxy_global_password,
user_identifier_grant_data_key=self.USER_IDENTIFIER_GRANT_DATA_KEY)
def _get_authenticator(self, name, register, typ, option_name):
"""Returns new authenticator by name"""
if name == 'certificate':
return CertificateAuthenticator(typ, register)
elif name == 'password':
return PasswordAuthenticator(typ, register)
elif name == 'none':
return NoopAuthenticator(typ)
else:
raise ValueError("Invalid configuration value %s for %s" %
(name, option_name))
def __call__(self, environ, start_response):
"""
@type environ: dict
@param environ: WSGI environment
@type start_response: WSGI start response function
@param start_response: start response function
@rtype: iterable
@return: WSGI response
"""
log.debug("Oauth2ServerMiddleware.__call__ ...")
req = Request(environ)
log.debug("Request path_info: %s", req.path_info)
# Set Authorisation Server as key in environ for access by downstream
# middleware or app. For example, a resource server can use it to
# check access tokens presented to it from clients against ones issued
# by the authorisation server
environ[self.__class__.AUTHORISATION_SERVER_ENVIRON_KEYNAME
] = self._authorizationServer
# Determine what operation the URL specifies.
actionPath = None
if req.path_info.startswith(self.base_path):
actionPath = req.path_info[len(self.base_path):]
methodName = self.__class__.method.get(actionPath, '')
if methodName:
log.debug("Method: %s" % methodName)
action = getattr(self, methodName)
return action(req, start_response)
elif self._app is not None:
log.debug("Delegating to lower filter/application.")
return self._app(environ, start_response)
else:
response = "OAuth 2.0 Server - Invalid URL"
start_response(self._get_http_status_string(httplib.NOT_FOUND),
[('Content-type', 'text/plain'),
('Content-length', str(len(response)))
])
return [response]
def authorize(self, req, start_response):
"""Handles OAuth 2 authorize request.
@type req: webob.Request
@param req: HTTP request object
@type start_response: WSGI start response function
@param start_response: start response function
@rtype: iterable
@return: WSGI response
"""
log.debug("authorize called")
# Stop immediately if the client is not registered.
(error, error_description
) = self._authorizationServer.is_registered_client(req)
if error:
log.debug("Error checking if client registered: %s - %s", error,
error_description)
return self._error_response(error, error_description,
start_response)
# User authentication is required before authorization can proceed.
user = req.environ.get(self.user_identifier_env_key)
if not user:
log.debug("%s not in environ - authentication required",
self.user_identifier_env_key)
start_response(self._get_http_status_string(httplib.UNAUTHORIZED),
[])
return []
# User authorization for the client is also required.
client_authorized, authz_uri = self._check_client_authorization(user,
req)
if authz_uri:
log.debug("Redirecting to %s", authz_uri)
return self._redirect(authz_uri, start_response)
if not client_authorized:
log.debug("User has declined authorization for client.")
# Request authorization grant.
(redirect_uri,
error,
error_description) = self._authorizationServer.authorize(
req,
client_authorized)
if error:
return self._error_response(error,
error_description,
start_response)
else:
return self._redirect(redirect_uri, start_response)
def _error_response(self, error, error_description, start_response):
"""Returns and error response.
"""
response = ("%s: %s" % (error, error_description)).encode('ascii',
'ignore')
log.error("Returning error: %s - %s", error, error_description)
start_response(self._get_http_status_string(httplib.BAD_REQUEST),
[('Content-type', 'text/plain'),
('Content-length', str(len(response)))
])
return[response]
def _check_client_authorization(self, user, req):
"""
Gets the URL to which to redirect for the user to authorize the client.
Returns: URL or None if already authorized
@type user: str
@param user: identifier of user/resource owner
@type req: webob.Request
@param req: HTTP request object
"""
client_authorizations = req.environ.get(
self.client_authorizations_env_key)
client_id = req.params.get('client_id')
scope = req.params.get('scope')
if not client_authorizations:
client_authorized = None
log.debug("Client authorization register not found in environ "
"(key %s).", self.client_authorizations_env_key)
else:
client_authorized = \
client_authorizations.is_client_authorized_by_user(user,
client_id,
scope)
if client_authorized is None:
log.debug("Client not authorized by user (client_id: %s scope: %s"
" user: %s).", client_id, scope, user)
url_params = {'client_id': client_id,
'scope': scope,
'user': user,
'original_url': req.url}
url = ("%s?%s" % (self._make_client_authorization_url(req),
urllib.urlencode(url_params)))
return (None, url)
return client_authorized, None
def _make_client_authorization_url(self, req):
parts = urlparse.urlparse(self.client_authorization_url)
if (parts.scheme and parts.netloc):
# Absolute URL:
return self.client_authorization_url
else:
# Relative - append to application URL:
return '/'.join([req.application_url.rstrip('/'),
self.client_authorization_url.lstrip('/')])
def access_token(self, req, start_response):
"""Handles OAuth 2 access token request.
@type req: webob.Request
@param req: HTTP request object
@type start_response:
@param start_response: WSGI start response function
@rtype: iterable
@return: WSGI response
"""
log.debug("access_token called")
(response,
error_status,
error_description) = self._authorizationServer.access_token(req)
if response is None:
response = ''
headers = [
('Content-Type', 'application/json; charset=UTF-8'),
('Cache-Control', 'no-store'),
('Content-length', str(len(response))),
('Pragma', 'no-store')
]
status_str = self._get_http_status_string(
error_status if error_status else httplib.OK)
if error_status:
log.debug("Error obtaining access token: %s - %s", status_str,
error_description)
start_response(status_str, headers)
return [response]
def check_token(self, req, start_response):
"""
Service to validate bearer tokens. It would be called from a resource
service that trusts this authorization service.
@type req: webob.Request
@param req: HTTP request object
@type start_response:
@param start_response: WSGI start response function
@rtype: iterable
@return: WSGI response
"""
response, error_status = self._authorizationServer.check_token(req)[0:2]
if response is None:
response = ''
headers = [
('Content-Type', 'application/json; charset=UTF-8'),
('Cache-Control', 'no-store'),
('Content-length', str(len(response))),
('Pragma', 'no-store')
]
status_str = self._get_http_status_string(
error_status if error_status else httplib.OK)
start_response(status_str, headers)
return [response]
def request_certificate(self, req, start_response):
"""
Resource service to issue a certificate based on a certificate request
contained in the request and the identity of the client for whom the
access token was issued.
@type req: webob.Request
@param req: HTTP request object
@type start_response:
@param start_response: WSGI start response function
@rtype: iterable
@return: WSGI response
"""
log.debug("request_certificate called")
cert = None
error = None
status = httplib.OK
dn = req.environ.get(self.CERT_DN_ENVIRON_KEY)
if dn:
log.debug("Found certificate DN: %s", dn)
else:
# Client must be authenticated - no other error should be included
# in this case.
status = httplib.FORBIDDEN
if status == httplib.OK:
(token,
status,
error) = self._authorizationServer.get_registered_token(req, dn)
if status == httplib.OK:
# Token is valid so get a certificate.
cert = self._myproxy_cert_request.get_resource(token, req)
if not cert:
status = httplib.INTERNAL_SERVER_ERROR
content_dict = {'status': status}
if error:
content_dict['error'] = error
if cert:
content_dict['certificate'] = cert
response = json.dumps(content_dict)
headers = [
('Content-Type', 'application/json; charset=UTF-8'),
('Cache-Control', 'no-store'),
('Content-length', str(len(response))),
('Pragma', 'no-store')
]
status_str = self._get_http_status_string(status if status
else httplib.OK)
if error:
log.debug("Error obtaining certificate: %s - %s", status_str, error)
start_response(status_str, headers)
return [response]
@staticmethod
def _get_http_status_string(status):
return ("%d %s" % (status, httplib.responses[status]))
def _redirect(self, url, start_response):
"""Initiates a redirect to a specified URL.
@type param: str
@param url: URL
@type start_response:
@param start_response: WSGI start response function
@rtype: iterable
@return: WSGI response
"""
log.debug("Redirecting to %s", url)
start_response(self._get_http_status_string(httplib.FOUND),
[('Location', url.encode('ascii', 'ignore'))])
return []
def _set_configuration(self, prefix, local_conf):
"""Sets the configuration values.
@type prefix: str
@param prefix: optional prefix for parameter names included in the
local_conf dict - enables these parameters to be filtered from others
which don't apply to this middleware
@type local_conf: dict
@param local_conf: attribute settings to apply
"""
conf = {}
plen = len(prefix)
for k, v in local_conf.iteritems():
if k.startswith(prefix):
conf[k[plen:]] = v
cls = self.__class__
self.base_path = cls._get_config_option(conf, cls.BASE_URL_PATH_OPTION)
self.authorization_grant_lifetime_seconds = cls._get_config_option(
conf, cls.AUTHORIZATION_GRANT_LIFETIME_OPTION)
self.access_token_lifetime_seconds = cls._get_config_option(
conf, cls.ACCESS_TOKEN_LIFETIME_OPTION)
self.access_token_type = cls._get_config_option(
conf, cls.ACCESS_TOKEN_TYPE_OPTION)
self.certificate_request_parameter = cls._get_config_option(
conf, cls.CERTIFICATE_REQUEST_PARAMETER_OPTION)
self.client_authorization_url = cls._get_config_option(
conf, cls.CLIENT_AUTHORIZATION_URL_OPTION)
self.client_authentication_method = cls._get_config_option(
conf, cls.CLIENT_AUTHENTICATION_METHOD_OPTION)
self.client_authorizations_env_key = cls._get_config_option(
conf, cls.CLIENT_AUTHORIZATIONS_KEY_OPTION)
self.client_register_file = cls._get_config_option(
conf, cls.CLIENT_REGISTER_OPTION)
self.resource_authentication_method = cls._get_config_option(
conf, cls.RESOURCE_AUTHENTICATION_METHOD_OPTION)
self.resource_register_file = cls._get_config_option(
conf, cls.RESOURCE_REGISTER_OPTION)
self.myproxy_client_env_key = cls._get_config_option(
conf, cls.MYPROXY_CLIENT_KEY_OPTION)
self.myproxy_global_password = cls._get_config_option(
conf, cls.MYPROXY_GLOBAL_PASSWORD_OPTION)
self.user_identifier_env_key = cls._get_config_option(
conf, cls.USER_IDENTIFIER_KEY_OPTION)
# Return any options that start with the prefix but haven't been read
# above.
return conf
@classmethod
def _get_config_option(cls, conf, key):
value = conf.pop(key, cls.PROPERTY_DEFAULTS.get(key, None))
log.debug("Oauth2ServerMiddleware configuration %s=%s", key, value)
return value
@classmethod
def filter_app_factory(cls, app, app_conf, **local_conf):
return cls(app, app_conf, **local_conf)
@classmethod
def app_factory(cls, app_conf, **local_conf):
return cls(None, app_conf, **local_conf)