#!/usr/bin/env python2 -tt
# -*- coding: utf-8 -*-
#
# Copyright (C) 2013-2014 Red Hat, Inc.
# This file is part of python-fedora
#
# python-fedora is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# python-fedora is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with python-fedora; if not, see
#
"""Implement a class that sets up simple communication to a Fedora Service.
.. moduleauthor:: Pierre-Yves Chibon
.. moduleauthor:: Toshio Kuratomi
.. versionadded: 0.3.35
"""
import copy
import logging
import re
# For handling an exception that's coming from requests:
import ssl
import time
from six.moves import http_client as httplib
from six.moves.urllib.parse import quote, parse_qs, urljoin, urlparse
# Hack, hack, hack around
# the horror that is logging!
# Verily, verliy, verily, verily
# We should all use something better
try:
# Python 2.7+
from logging import NullHandler
except ImportError:
class NullHandler(logging.Handler):
def emit(self, *args):
pass
import requests
#from munch import munchify
from kitchen.text.converters import to_bytes
# For handling an exception that's coming from requests:
import urllib3
from fedora import __version__
from fedora.client import AuthError, ServerError, FedoraServiceError
log = logging.getLogger(__name__)
log.addHandler(NullHandler())
OPENID_SESSION_NAME = 'FAS_OPENID'
FEDORA_OPENID_API = 'https://id.fedoraproject.org/api/v1/'
FEDORA_OPENID_RE = re.compile(r'^http(s)?:\/\/id\.(|stg.|dev.)?fedoraproject\.org(/)?')
def _parse_response_history(response):
""" Retrieve the attributes from the response history. """
data = {}
for r in response.history:
if FEDORA_OPENID_RE.match(r.url):
parsed = parse_qs(urlparse(r.url).query)
for key, value in parsed.items():
data[key] = value[0]
break
return data
def openid_login(session, login_url, username, password, otp=None,
openid_insecure=False):
""" Open a session for the user.
Log in the user with the specified username and password
against the FAS OpenID server.
:arg session: Requests session object required to persist the cookies
that are created during redirects on the openid provider.
:arg login_url: The url to the login endpoint of the application.
:arg username: the FAS username of the user that wants to log in
:arg password: the FAS password of the user that wants to log in
:kwarg otp: currently unused. Eventually a way to send an otp to the
API that the API can use.
:kwarg openid_insecure: If True, do not check the openid server
certificates against their CA's. This means that man-in-the-middle
attacks are possible against the `BaseClient`. You might turn this
option on for testing against a local version of a server with a
self-signed certificate but it should be off in production.
"""
# Log into the service
response = session.get(
login_url, headers={'Accept': 'application/json'})
try:
data = response.json()
openid_url = data.get('server_url', None)
if not FEDORA_OPENID_RE.match(openid_url):
raise FedoraServiceError(
'Un-expected openid provider asked: %s' % openid_url)
except:
# Some consumers (like pyramid_openid) return redirects with the
# openid attributes encoded in the url
if not FEDORA_OPENID_RE.match(response.url):
raise FedoraServiceError(
'Un-expected openid provider asked: %s' % response.url)
data = _parse_response_history(response)
# Contact openid provider
data['username'] = username
data['password'] = password
# Let's precise to FedOAuth that we want to authenticate with FAS
data['auth_module'] = 'fedoauth.auth.fas.Auth_FAS'
data['auth_flow'] = 'fedora'
if not 'openid.mode' in data:
data['openid.mode'] = 'checkid_setup'
response = session.post(
FEDORA_OPENID_API, data=data, verify=not openid_insecure)
if not bool(response):
raise ServerError(FEDORA_OPENID_API, response.status_code,
'Error returned from our POST to ipsilon.')
output = response.json()
if not output['success']:
raise AuthError(output['message'])
response = session.post(output['response']['openid.return_to'],
data=output['response'])
return response
def absolute_url(beginning, end):
""" Join two urls parts if the last part does not start with the first
part specified """
if not end.startswith(beginning):
end = urljoin(beginning, end)
return end
class OpenIdProxyClient(object):
# pylint: disable-msg=R0903
"""
A client to a Fedora Service. This class is optimized to proxy multiple
users to a service. OpenIdProxyClient is designed to be usable by code
that creates a single instance of this class and uses it in multiple
threads. However it is not completely threadsafe. See the information
on setting attributes below.
If you want something that can manage one user's connection to a Fedora
Service, then look into using :class:`~fedora.client.OpenIdBaseClient`
instead.
This class has several attributes. These may be changed after
instantiation. Please note, however, that changing these values when
another thread is utilizing the same instance may affect more than just
the thread that you are making the change in. (For instance, changing
the debug option could cause other threads to start logging debug
messages in the middle of a method.)
.. attribute:: base_url
Initial portion of the url to contact the server. It is highly
recommended not to change this value unless you know that no other
threads are accessing this :class:`OpenIdProxyClient` instance.
.. attribute:: useragent
Changes the useragent string that is reported to the web server.
.. attribute:: session_name
Name of the cookie that holds the authentication value.
.. attribute:: debug
If :data:`True`, then more verbose logging is performed to aid in
debugging issues.
.. attribute:: insecure
If :data:`True` then the connection to the server is not checked to be
sure that any SSL certificate information is valid. That means that
a remote host can lie about who it is. Useful for development but
should not be used in production code.
.. attribute:: retries
Setting this to a positive integer will retry failed requests to the
web server this many times. Setting to a negative integer will retry
forever.
.. attribute:: timeout
A float describing the timeout of the connection. The timeout only
affects the connection process itself, not the downloading of the
response body. Defaults to 120 seconds.
"""
def __init__(self, base_url, login_url=None, useragent=None,
session_name='session', debug=False, insecure=False,
openid_insecure=False, retries=None, timeout=None):
"""Create a client configured for a particular service.
:arg base_url: Base of every URL used to contact the server
:kwarg login_url: The url to the login endpoint of the application.
If none are specified, it uses the default `/login`.
:kwarg useragent: useragent string to use. If not given, default
to "Fedora ProxyClient/VERSION"
:kwarg session_name: name of the cookie to use with session handling
:kwarg debug: If True, log debug information
:kwarg insecure: If True, do not check server certificates against
their CA's. This means that man-in-the-middle attacks are
possible against the `BaseClient`. You might turn this option
on for testing against a local version of a server with a
self-signed certificate but it should be off in production.
:kwarg openid_insecure: If True, do not check the openid server
certificates against their CA's. This means that man-in-the-
middle attacks are possible against the `BaseClient`. You might
turn this option on for testing against a local version of a
server with a self-signed certificate but it should be off in
production.
:kwarg retries: if we get an unknown or possibly transient error
from the server, retry this many times. Setting this to a
negative number makes it try forever. Defaults to zero, no
retries.
:kwarg timeout: A float describing the timeout of the connection.
The timeout only affects the connection process itself, not the
downloading of the response body. Defaults to 120 seconds.
"""
self.debug = debug
log.debug('proxyclient.__init__:entered')
# When we are instantiated, go ahead and silence the python-requests
# log. It is kind of noisy in our app server logs.
if not debug:
requests_log = logging.getLogger("requests")
requests_log.setLevel(logging.WARN)
if base_url[-1] != '/':
base_url = base_url + '/'
self.base_url = base_url
self.login_url = login_url or urljoin(self.base_url, '/login')
self.domain = urlparse(self.base_url).netloc
self.useragent = useragent or 'Fedora ProxyClient/%(version)s' % {
'version': __version__}
self.session_name = session_name
self.insecure = insecure
self.openid_insecure = openid_insecure
# Have to do retries and timeout default values this way as BaseClient
# sends None for these values if not overridden by the user.
if retries is None:
self.retries = 0
else:
self.retries = retries
if timeout is None:
self.timeout = 120.0
else:
self.timeout = timeout
log.debug('proxyclient.__init__:exited')
def __get_debug(self):
"""Return whether we have debug logging turned on.
:Returns: True if debugging is on, False otherwise.
"""
if log.level <= logging.DEBUG:
return True
return False
def __set_debug(self, debug=False):
"""Change debug level.
:kwarg debug: A true value to turn debugging on, false value to turn it
off.
"""
if debug:
log.setLevel(logging.DEBUG)
else:
log.setLevel(logging.ERROR)
debug = property(__get_debug, __set_debug, doc="""
When True, we log extra debugging statements. When False, we only log
errors.
""")
def login(self, username, password, otp=None):
""" Open a session for the user.
Log in the user with the specified username and password
against the FAS OpenID server.
:arg username: the FAS username of the user that wants to log in
:arg password: the FAS password of the user that wants to log in
:kwarg otp: currently unused. Eventually a way to send an otp to the
API that the API can use.
:return: a tuple containing both the response from the OpenID
provider and the session used to by this provider.
"""
session = requests.session()
response = openid_login(
session=session,
login_url=self.login_url,
username=username,
password=password,
otp=otp,
openid_insecure=self.openid_insecure)
return (response, session)
def send_request(self, method, verb='POST', req_params=None,
auth_params=None, file_params=None, retries=None,
timeout=None, headers=None):
"""Make an HTTP request to a server method.
The given method is called with any parameters set in ``req_params``.
If auth is True, then the request is made with an authenticated
session cookie. Note that path parameters should be set by adding
onto the method, not via ``req_params``.
:arg method: Method to call on the server. It's a url fragment that
comes after the base_url set in __init__(). Note that any
parameters set as extra path information should be listed here,
not in ``req_params``.
:kwarg req_params: dict containing extra parameters to send to the
server
:kwarg auth_params: dict containing one or more means of
authenticating to the server. Valid entries in this dict are:
:cookie: **Deprecated** Use ``session_id`` instead. If both
``cookie`` and ``session_id`` are set, only ``session_id``
will be used. A ``Cookie.SimpleCookie`` to send as a
session cookie to the server
:session_id: Session id to put in a cookie to construct an
identity for the server
:username: Username to send to the server
:password: Password to use with username to send to the server
:httpauth: If set to ``basic`` then use HTTP Basic Authentication
to send the username and password to the server. This may
be extended in the future to support other httpauth types
than ``basic``.
Note that cookie can be sent alone but if one of username or
password is set the other must as well. Code can set all of
these if it wants and all of them will be sent to the server.
Be careful of sending cookies that do not match with the
username in this case as the server can decide what to do in
this case.
:kwarg file_params: dict of files where the key is the name of the
file field used in the remote method and the value is the local
path of the file to be uploaded. If you want to pass multiple
files to a single file field, pass the paths as a list of paths.
:kwarg retries: if we get an unknown or possibly transient error
from the server, retry this many times. Setting this to a
negative number makes it try forever. Default to use the
:attr:`retries` value set on the instance or in :meth:`__init__`.
:kwarg timeout: A float describing the timeout of the connection.
The timeout only affects the connection process itself, not the
downloading of the response body. Defaults to the :attr:`timeout`
value set on the instance or in :meth:`__init__`.
:kwarg headers: A dictionary containing specific headers to add to
the request made.
:returns: A tuple of session_id and data.
:rtype: tuple of session information and data from server
"""
log.debug('openidproxyclient.send_request: entered')
# parameter mangling
file_params = file_params or {}
# Check whether we need to authenticate for this request
session_id = None
username = None
password = None
if auth_params:
if 'session_id' in auth_params:
session_id = auth_params['session_id']
if 'username' in auth_params and 'password' in auth_params:
username = auth_params['username']
password = auth_params['password']
elif 'username' in auth_params or 'password' in auth_params:
raise AuthError(
'username and password must both be set in auth_params'
)
if not (session_id or username):
raise AuthError(
'No known authentication methods specified: set '
'"cookie" in auth_params or set both username and '
'password in auth_params')
# urljoin is slightly different than os.path.join(). Make sure
# method will work with it.
method = method.lstrip('/')
# And join to make our url.
url = urljoin(self.base_url, quote(method))
# Set standard headers
if headers:
if not 'User-agent' in headers:
headers['User-agent'] = self.useragent
if not 'Accept' in headers:
headers['Accept'] = 'application/json'
else:
headers = {
'User-agent': self.useragent,
'Accept': 'application/json',
}
# Files to upload
for field_name, local_file_name in file_params:
file_params[field_name] = open(local_file_name, 'rb')
cookies = requests.cookies.RequestsCookieJar()
# If we have a session_id, send it
if session_id:
# Anytime the session_id exists, send it so that visit tracking
# works. Will also authenticate us if there's a need. Note
# that there's no need to set other cookie attributes because
# this is a cookie generated client-side.
cookies.set(self.session_name, session_id)
complete_params = req_params or {}
auth = None
if username and password:
# OpenID login
resp, session = self.login(username, password, otp=None)
cookies = session.cookies
# If debug, give people our debug info
log.debug('Creating request %s', to_bytes(url))
log.debug('Headers: %s', to_bytes(headers, nonstring='simplerepr'))
if self.debug and complete_params:
debug_data = copy.deepcopy(complete_params)
if 'password' in debug_data:
debug_data['password'] = 'xxxxxxx'
log.debug('Data: %r', debug_data)
if retries is None:
retries = self.retries
if timeout is None:
timeout = self.timeout
num_tries = 0
while True:
try:
response = session.request(
method=verb,
url=url,
data=complete_params,
cookies=cookies,
headers=headers,
auth=auth,
verify=not self.insecure,
timeout=timeout,
)
except (requests.Timeout, requests.exceptions.SSLError) as err:
if isinstance(err, requests.exceptions.SSLError):
# And now we know how not to code a library exception
# hierarchy... We're expecting that requests is raising
# the following stupidity:
# requests.exceptions.SSLError(
# urllib3.exceptions.SSLError(
# ssl.SSLError('The read operation timed out')))
# If we weren't interested in reraising the exception with
# full traceback we could use a try: except instead of
# this gross conditional. But we need to code defensively
# because we don't want to raise an unrelated exception
# here and if requests/urllib3 can do this sort of
# nonsense, they may change the nonsense in the future
if not (err.args and isinstance(
err.args[0], urllib3.exceptions.SSLError)
and err.args[0].args
and isinstance(err.args[0].args[0], ssl.SSLError)
and err.args[0].args[0].args
and 'timed out' in err.args[0].args[0].args[0]):
# We're only interested in timeouts here
raise
log.debug('Request timed out')
if retries < 0 or num_tries < retries:
num_tries += 1
log.debug('Attempt #%s failed', num_tries)
time.sleep(0.5)
continue
# Fail and raise an error
# Raising our own exception protects the user from the
# implementation detail of requests vs pycurl vs urllib
raise ServerError(
url, -1, 'Request timed out after %s seconds' % timeout)
# When the python-requests module gets a response, it attempts to
# guess the encoding using chardet (or a fork)
# That process can take an extraordinarily long time for long
# response.text strings.. upwards of 30 minutes for FAS queries to
# /accounts/user/list JSON api! Therefore, we cut that codepath
# off at the pass by assuming that the response is 'utf-8'. We can
# make that assumption because we're only interfacing with servers
# that we run (and we know that they all return responses
# encoded 'utf-8').
response.encoding = 'utf-8'
# Check for auth failures
# Note: old TG apps returned 403 Forbidden on authentication
# failures.
# Updated apps return 401 Unauthorized
# We need to accept both until all apps are updated to return 401.
http_status = response.status_code
if http_status in (401, 403):
# Wrong username or password
log.debug('Authentication failed logging in')
raise AuthError(
'Unable to log into server. Invalid '
'authentication tokens. Send new username and password'
)
elif http_status >= 400:
if retries < 0 or num_tries < retries:
# Retry the request
num_tries += 1
log.debug('Attempt #%s failed', num_tries)
time.sleep(0.5)
continue
# Fail and raise an error
try:
msg = httplib.responses[http_status]
except (KeyError, AttributeError):
msg = 'Unknown HTTP Server Response'
raise ServerError(url, http_status, msg)
# Successfully returned data
break
# In case the server returned a new session cookie to us
new_session = session.cookies.get(self.session_name, '')
log.debug('openidproxyclient.send_request: exited')
#data = munchify(data)
return new_session, response
__all__ = (OpenIdProxyClient,)