2008-11-24 13:51:03 -06:00
|
|
|
# Authors:
|
|
|
|
# Jason Gerard DeRose <jderose@redhat.com>
|
2009-01-22 15:00:37 -06:00
|
|
|
# Rob Crittenden <rcritten@redhat.com>
|
2008-11-24 13:51:03 -06:00
|
|
|
#
|
|
|
|
# Copyright (C) 2008 Red Hat
|
|
|
|
# see file 'COPYING' for use and warranty information
|
|
|
|
#
|
2010-12-09 06:59:11 -06:00
|
|
|
# This program is free software; you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU General Public License as published by
|
|
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
|
|
# (at your option) any later version.
|
2008-11-24 13:51:03 -06:00
|
|
|
#
|
|
|
|
# This program 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 General Public License for more details.
|
|
|
|
#
|
|
|
|
# You should have received a copy of the GNU General Public License
|
2010-12-09 06:59:11 -06:00
|
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2008-11-24 13:51:03 -06:00
|
|
|
|
|
|
|
"""
|
2009-01-16 02:56:39 -06:00
|
|
|
RPC client and shared RPC client/server functionality.
|
2009-01-16 02:23:55 -06:00
|
|
|
|
2015-09-14 06:22:38 -05:00
|
|
|
This module adds some additional functionality on top of the ``xmlrpc.client``
|
|
|
|
module in the Python standard library (``xmlrpclib`` in Python 2).
|
|
|
|
For documentation on the ``xmlrpclib`` module, see:
|
2009-01-16 02:23:55 -06:00
|
|
|
|
2015-09-14 06:22:38 -05:00
|
|
|
http://docs.python.org/2/library/xmlrpclib.html
|
2009-01-16 02:56:39 -06:00
|
|
|
|
|
|
|
Also see the `ipaserver.rpcserver` module.
|
2008-11-24 13:51:03 -06:00
|
|
|
"""
|
|
|
|
|
2016-06-01 07:55:13 -05:00
|
|
|
from __future__ import absolute_import
|
|
|
|
|
2012-01-17 04:19:00 -06:00
|
|
|
from decimal import Decimal
|
2014-01-09 04:14:56 -06:00
|
|
|
import datetime
|
2017-05-23 11:35:57 -05:00
|
|
|
import logging
|
2009-02-19 16:20:37 -06:00
|
|
|
import os
|
2011-02-15 13:10:38 -06:00
|
|
|
import locale
|
2012-12-19 03:25:24 -06:00
|
|
|
import base64
|
|
|
|
import json
|
2017-03-23 16:49:27 -05:00
|
|
|
import re
|
2012-12-19 03:25:24 -06:00
|
|
|
import socket
|
2015-09-17 11:48:30 -05:00
|
|
|
import gzip
|
2018-09-27 00:47:07 -05:00
|
|
|
import urllib
|
|
|
|
from ssl import SSLError
|
2015-08-10 11:29:33 -05:00
|
|
|
|
2018-09-27 00:47:07 -05:00
|
|
|
from cryptography import x509 as crypto_x509
|
2015-07-16 11:22:00 -05:00
|
|
|
import gssapi
|
2012-05-11 07:38:09 -05:00
|
|
|
from dns.exception import DNSException
|
2015-08-10 11:29:33 -05:00
|
|
|
import six
|
2012-05-11 07:38:09 -05:00
|
|
|
|
2009-01-23 19:02:32 -06:00
|
|
|
from ipalib.backend import Connectible
|
2014-01-09 04:14:56 -06:00
|
|
|
from ipalib.constants import LDAP_GENERALIZED_TIME_FORMAT
|
2017-03-05 20:03:44 -06:00
|
|
|
from ipalib.errors import (errors_by_code, UnknownError, NetworkError,
|
2017-05-31 08:45:19 -05:00
|
|
|
XMLRPCMarshallError, JSONError)
|
2014-01-09 04:14:56 -06:00
|
|
|
from ipalib import errors, capabilities
|
2012-03-03 18:50:21 -06:00
|
|
|
from ipalib.request import context, Connection
|
2017-07-03 10:10:34 -05:00
|
|
|
from ipalib.x509 import Encoding as x509_Encoding
|
2012-05-11 07:38:09 -05:00
|
|
|
from ipapython import ipautil
|
2017-03-06 17:47:56 -06:00
|
|
|
from ipapython import session_storage
|
2012-12-04 17:20:17 -06:00
|
|
|
from ipapython.cookie import Cookie
|
2018-06-15 10:03:29 -05:00
|
|
|
from ipapython.dnsutil import DNSName, query_srv
|
2012-07-04 07:52:47 -05:00
|
|
|
from ipalib.text import _
|
2016-12-20 03:05:36 -06:00
|
|
|
from ipalib.util import create_https_connection
|
add session manager and cache krb auth
This patch adds a session manager and support for caching
authentication in the session. Major elements of the patch are:
* Add a session manager to support cookie based sessions which
stores session data in a memcached entry.
* Add ipalib/krb_utils.py which contains functions to parse ccache
names, format principals, format KRB timestamps, and a KRB_CCache
class which reads ccache entry and allows one to extract information
such as the principal, credentials, credential timestamps, etc.
* Move krb constants defined in ipalib/rpc.py to ipa_krb_utils.py so
that all kerberos items are co-located.
* Modify javascript in ipa.js so that the IPA.command() RPC call
checks for authentication needed error response and if it receives
it sends a GET request to /ipa/login URL to refresh credentials.
* Add session_auth_duration config item to constants.py, used to
configure how long a session remains valid.
* Add parse_time_duration utility to ipalib/util.py. Used to parse the
session_auth_duration config item.
* Update the default.conf.5 man page to document session_auth_duration
config item (also added documentation for log_manager config items
which had been inadvertantly omitted from a previous commit).
* Add SessionError object to ipalib/errors.py
* Move Kerberos protection in Apache config from /ipa to /ipa/xml and
/ipa/login
* Add SessionCCache class to session.py to manage temporary Kerberos
ccache file in effect for the duration of an RPC command.
* Adds a krblogin plugin used to implement the /ipa/login
handler. login handler sets the session expiration time, currently
60 minutes or the expiration of the TGT, whichever is shorter. It
also copies the ccache provied by mod_auth_kerb into the session
data. The json handler will later extract and validate the ccache
belonging to the session.
* Refactored the WSGI handlers so that json and xlmrpc could have
independent behavior, this also moves where create and destroy
context occurs, now done in the individual handler rather than the
parent class.
* The json handler now looks up the session data, validates the ccache
bound to the session, if it's expired replies with authenicated
needed error.
* Add documentation to session.py. Fully documents the entire process,
got questions, read the doc.
* Add exclusions to make-lint as needed.
2012-02-06 12:29:56 -06:00
|
|
|
from ipalib.krb_utils import KRB5KDC_ERR_S_PRINCIPAL_UNKNOWN, KRB5KRB_AP_ERR_TKT_EXPIRED, \
|
2015-07-20 09:04:07 -05:00
|
|
|
KRB5_FCC_PERM, KRB5_FCC_NOFILE, KRB5_CC_FORMAT, \
|
2015-08-31 07:04:33 -05:00
|
|
|
KRB5_REALM_CANT_RESOLVE, KRB5_CC_NOTFOUND, get_principal
|
Use DN objects instead of strings
* Convert every string specifying a DN into a DN object
* Every place a dn was manipulated in some fashion it was replaced by
the use of DN operators
* Add new DNParam parameter type for parameters which are DN's
* DN objects are used 100% of the time throughout the entire data
pipeline whenever something is logically a dn.
* Many classes now enforce DN usage for their attributes which are
dn's. This is implmented via ipautil.dn_attribute_property(). The
only permitted types for a class attribute specified to be a DN are
either None or a DN object.
* Require that every place a dn is used it must be a DN object.
This translates into lot of::
assert isinstance(dn, DN)
sprinkled through out the code. Maintaining these asserts is
valuable to preserve DN type enforcement. The asserts can be
disabled in production.
The goal of 100% DN usage 100% of the time has been realized, these
asserts are meant to preserve that.
The asserts also proved valuable in detecting functions which did
not obey their function signatures, such as the baseldap pre and
post callbacks.
* Moved ipalib.dn to ipapython.dn because DN class is shared with all
components, not just the server which uses ipalib.
* All API's now accept DN's natively, no need to convert to str (or
unicode).
* Removed ipalib.encoder and encode/decode decorators. Type conversion
is now explicitly performed in each IPASimpleLDAPObject method which
emulates a ldap.SimpleLDAPObject method.
* Entity & Entry classes now utilize DN's
* Removed __getattr__ in Entity & Entity clases. There were two
problems with it. It presented synthetic Python object attributes
based on the current LDAP data it contained. There is no way to
validate synthetic attributes using code checkers, you can't search
the code to find LDAP attribute accesses (because synthetic
attriutes look like Python attributes instead of LDAP data) and
error handling is circumscribed. Secondly __getattr__ was hiding
Python internal methods which broke class semantics.
* Replace use of methods inherited from ldap.SimpleLDAPObject via
IPAdmin class with IPAdmin methods. Directly using inherited methods
was causing us to bypass IPA logic. Mostly this meant replacing the
use of search_s() with getEntry() or getList(). Similarly direct
access of the LDAP data in classes using IPAdmin were replaced with
calls to getValue() or getValues().
* Objects returned by ldap2.find_entries() are now compatible with
either the python-ldap access methodology or the Entity/Entry access
methodology.
* All ldap operations now funnel through the common
IPASimpleLDAPObject giving us a single location where we interface
to python-ldap and perform conversions.
* The above 4 modifications means we've greatly reduced the
proliferation of multiple inconsistent ways to perform LDAP
operations. We are well on the way to having a single API in IPA for
doing LDAP (a long range goal).
* All certificate subject bases are now DN's
* DN objects were enhanced thusly:
- find, rfind, index, rindex, replace and insert methods were added
- AVA, RDN and DN classes were refactored in immutable and mutable
variants, the mutable variants are EditableAVA, EditableRDN and
EditableDN. By default we use the immutable variants preserving
important semantics. To edit a DN cast it to an EditableDN and
cast it back to DN when done editing. These issues are fully
described in other documentation.
- first_key_match was removed
- DN equalty comparison permits comparison to a basestring
* Fixed ldapupdate to work with DN's. This work included:
- Enhance test_updates.py to do more checking after applying
update. Add test for update_from_dict(). Convert code to use
unittest classes.
- Consolidated duplicate code.
- Moved code which should have been in the class into the class.
- Fix the handling of the 'deleteentry' update action. It's no longer
necessary to supply fake attributes to make it work. Detect case
where subsequent update applies a change to entry previously marked
for deletetion. General clean-up and simplification of the
'deleteentry' logic.
- Rewrote a couple of functions to be clearer and more Pythonic.
- Added documentation on the data structure being used.
- Simplfy the use of update_from_dict()
* Removed all usage of get_schema() which was being called prior to
accessing the .schema attribute of an object. If a class is using
internal lazy loading as an optimization it's not right to require
users of the interface to be aware of internal
optimization's. schema is now a property and when the schema
property is accessed it calls a private internal method to perform
the lazy loading.
* Added SchemaCache class to cache the schema's from individual
servers. This was done because of the observation we talk to
different LDAP servers, each of which may have it's own
schema. Previously we globally cached the schema from the first
server we connected to and returned that schema in all contexts. The
cache includes controls to invalidate it thus forcing a schema
refresh.
* Schema caching is now senstive to the run time context. During
install and upgrade the schema can change leading to errors due to
out-of-date cached schema. The schema cache is refreshed in these
contexts.
* We are aware of the LDAP syntax of all LDAP attributes. Every
attribute returned from an LDAP operation is passed through a
central table look-up based on it's LDAP syntax. The table key is
the LDAP syntax it's value is a Python callable that returns a
Python object matching the LDAP syntax. There are a handful of LDAP
attributes whose syntax is historically incorrect
(e.g. DistguishedNames that are defined as DirectoryStrings). The
table driven conversion mechanism is augmented with a table of
hard coded exceptions.
Currently only the following conversions occur via the table:
- dn's are converted to DN objects
- binary objects are converted to Python str objects (IPA
convention).
- everything else is converted to unicode using UTF-8 decoding (IPA
convention).
However, now that the table driven conversion mechanism is in place
it would be trivial to do things such as converting attributes
which have LDAP integer syntax into a Python integer, etc.
* Expected values in the unit tests which are a DN no longer need to
use lambda expressions to promote the returned value to a DN for
equality comparison. The return value is automatically promoted to
a DN. The lambda expressions have been removed making the code much
simpler and easier to read.
* Add class level logging to a number of classes which did not support
logging, less need for use of root_logger.
* Remove ipaserver/conn.py, it was unused.
* Consolidated duplicate code wherever it was found.
* Fixed many places that used string concatenation to form a new
string rather than string formatting operators. This is necessary
because string formatting converts it's arguments to a string prior
to building the result string. You can't concatenate a string and a
non-string.
* Simplify logic in rename_managed plugin. Use DN operators to edit
dn's.
* The live version of ipa-ldap-updater did not generate a log file.
The offline version did, now both do.
https://fedorahosted.org/freeipa/ticket/1670
https://fedorahosted.org/freeipa/ticket/1671
https://fedorahosted.org/freeipa/ticket/1672
https://fedorahosted.org/freeipa/ticket/1673
https://fedorahosted.org/freeipa/ticket/1674
https://fedorahosted.org/freeipa/ticket/1392
https://fedorahosted.org/freeipa/ticket/2872
2012-05-13 06:36:35 -05:00
|
|
|
from ipapython.dn import DN
|
2016-06-23 11:23:00 -05:00
|
|
|
from ipapython.kerberos import Principal
|
2014-03-28 03:51:10 -05:00
|
|
|
from ipalib.capabilities import VERSION_WITHOUT_CAPABILITIES
|
2014-10-30 10:52:14 -05:00
|
|
|
from ipalib import api
|
2008-11-24 13:51:03 -06:00
|
|
|
|
2015-09-14 06:22:38 -05:00
|
|
|
# The XMLRPC client is in "six.moves.xmlrpc_client", but pylint
|
|
|
|
# cannot handle that
|
|
|
|
try:
|
|
|
|
from xmlrpclib import (Binary, Fault, DateTime, dumps, loads, ServerProxy,
|
|
|
|
Transport, ProtocolError, MININT, MAXINT)
|
|
|
|
except ImportError:
|
2016-08-24 06:37:30 -05:00
|
|
|
# pylint: disable=import-error
|
2015-09-14 06:22:38 -05:00
|
|
|
from xmlrpc.client import (Binary, Fault, DateTime, dumps, loads, ServerProxy,
|
|
|
|
Transport, ProtocolError, MININT, MAXINT)
|
|
|
|
|
2017-03-20 02:47:51 -05:00
|
|
|
# pylint: disable=import-error
|
|
|
|
if six.PY3:
|
|
|
|
from http.client import RemoteDisconnected
|
|
|
|
else:
|
|
|
|
from httplib import BadStatusLine as RemoteDisconnected
|
|
|
|
# pylint: enable=import-error
|
|
|
|
|
2015-09-14 06:22:38 -05:00
|
|
|
|
2015-09-11 06:43:28 -05:00
|
|
|
if six.PY3:
|
|
|
|
unicode = str
|
|
|
|
|
2017-05-23 11:35:57 -05:00
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
2012-12-04 17:20:17 -06:00
|
|
|
COOKIE_NAME = 'ipa_session'
|
2017-03-06 17:47:56 -06:00
|
|
|
CCACHE_COOKIE_KEY = 'X-IPA-Session-Cookie'
|
2012-12-04 17:20:17 -06:00
|
|
|
|
|
|
|
|
|
|
|
def update_persistent_client_session_data(principal, data):
|
|
|
|
'''
|
|
|
|
Given a principal create or update the session data for that
|
|
|
|
principal in the persistent secure storage.
|
|
|
|
|
|
|
|
Raises ValueError if unable to perform the action for any reason.
|
|
|
|
'''
|
|
|
|
|
|
|
|
try:
|
2017-03-06 17:47:56 -06:00
|
|
|
session_storage.store_data(principal, CCACHE_COOKIE_KEY, data)
|
2015-07-30 09:49:29 -05:00
|
|
|
except Exception as e:
|
2012-12-04 17:20:17 -06:00
|
|
|
raise ValueError(str(e))
|
|
|
|
|
|
|
|
def read_persistent_client_session_data(principal):
|
|
|
|
'''
|
|
|
|
Given a principal return the stored session data for that
|
|
|
|
principal from the persistent secure storage.
|
|
|
|
|
|
|
|
Raises ValueError if unable to perform the action for any reason.
|
|
|
|
'''
|
|
|
|
|
|
|
|
try:
|
2017-03-06 17:47:56 -06:00
|
|
|
return session_storage.get_data(principal, CCACHE_COOKIE_KEY)
|
2015-07-30 09:49:29 -05:00
|
|
|
except Exception as e:
|
2012-12-04 17:20:17 -06:00
|
|
|
raise ValueError(str(e))
|
|
|
|
|
|
|
|
def delete_persistent_client_session_data(principal):
|
|
|
|
'''
|
|
|
|
Given a principal remove the session data for that
|
|
|
|
principal from the persistent secure storage.
|
|
|
|
|
|
|
|
Raises ValueError if unable to perform the action for any reason.
|
|
|
|
'''
|
|
|
|
|
|
|
|
try:
|
2017-03-06 17:47:56 -06:00
|
|
|
session_storage.remove_data(principal, CCACHE_COOKIE_KEY)
|
2015-07-30 09:49:29 -05:00
|
|
|
except Exception as e:
|
2012-12-04 17:20:17 -06:00
|
|
|
raise ValueError(str(e))
|
|
|
|
|
2014-03-28 03:51:10 -05:00
|
|
|
def xml_wrap(value, version):
|
2008-11-24 13:51:03 -06:00
|
|
|
"""
|
2015-09-14 06:22:38 -05:00
|
|
|
Wrap all ``str`` in ``xmlrpc.client.Binary``.
|
2008-11-24 13:51:03 -06:00
|
|
|
|
2015-09-14 06:22:38 -05:00
|
|
|
Because ``xmlrpc.client.dumps()`` will itself convert all ``unicode`` instances
|
2008-11-24 13:51:03 -06:00
|
|
|
into UTF-8 encoded ``str`` instances, we don't do it here.
|
|
|
|
|
2009-01-16 02:23:55 -06:00
|
|
|
So in total, when encoding data for an XML-RPC packet, the following
|
2008-11-24 13:51:03 -06:00
|
|
|
transformations occur:
|
|
|
|
|
|
|
|
* All ``str`` instances are treated as binary data and are wrapped in
|
2015-09-14 06:22:38 -05:00
|
|
|
an ``xmlrpc.client.Binary()`` instance.
|
2008-11-24 13:51:03 -06:00
|
|
|
|
|
|
|
* Only ``unicode`` instances are treated as character data. They get
|
|
|
|
converted to UTF-8 encoded ``str`` instances (although as mentioned,
|
|
|
|
not by this function).
|
|
|
|
|
2009-01-16 02:23:55 -06:00
|
|
|
Also see `xml_unwrap()`.
|
|
|
|
|
|
|
|
:param value: The simple scalar or simple compound value to wrap.
|
2008-11-24 13:51:03 -06:00
|
|
|
"""
|
|
|
|
if type(value) in (list, tuple):
|
2014-03-28 03:51:10 -05:00
|
|
|
return tuple(xml_wrap(v, version) for v in value)
|
Use DN objects instead of strings
* Convert every string specifying a DN into a DN object
* Every place a dn was manipulated in some fashion it was replaced by
the use of DN operators
* Add new DNParam parameter type for parameters which are DN's
* DN objects are used 100% of the time throughout the entire data
pipeline whenever something is logically a dn.
* Many classes now enforce DN usage for their attributes which are
dn's. This is implmented via ipautil.dn_attribute_property(). The
only permitted types for a class attribute specified to be a DN are
either None or a DN object.
* Require that every place a dn is used it must be a DN object.
This translates into lot of::
assert isinstance(dn, DN)
sprinkled through out the code. Maintaining these asserts is
valuable to preserve DN type enforcement. The asserts can be
disabled in production.
The goal of 100% DN usage 100% of the time has been realized, these
asserts are meant to preserve that.
The asserts also proved valuable in detecting functions which did
not obey their function signatures, such as the baseldap pre and
post callbacks.
* Moved ipalib.dn to ipapython.dn because DN class is shared with all
components, not just the server which uses ipalib.
* All API's now accept DN's natively, no need to convert to str (or
unicode).
* Removed ipalib.encoder and encode/decode decorators. Type conversion
is now explicitly performed in each IPASimpleLDAPObject method which
emulates a ldap.SimpleLDAPObject method.
* Entity & Entry classes now utilize DN's
* Removed __getattr__ in Entity & Entity clases. There were two
problems with it. It presented synthetic Python object attributes
based on the current LDAP data it contained. There is no way to
validate synthetic attributes using code checkers, you can't search
the code to find LDAP attribute accesses (because synthetic
attriutes look like Python attributes instead of LDAP data) and
error handling is circumscribed. Secondly __getattr__ was hiding
Python internal methods which broke class semantics.
* Replace use of methods inherited from ldap.SimpleLDAPObject via
IPAdmin class with IPAdmin methods. Directly using inherited methods
was causing us to bypass IPA logic. Mostly this meant replacing the
use of search_s() with getEntry() or getList(). Similarly direct
access of the LDAP data in classes using IPAdmin were replaced with
calls to getValue() or getValues().
* Objects returned by ldap2.find_entries() are now compatible with
either the python-ldap access methodology or the Entity/Entry access
methodology.
* All ldap operations now funnel through the common
IPASimpleLDAPObject giving us a single location where we interface
to python-ldap and perform conversions.
* The above 4 modifications means we've greatly reduced the
proliferation of multiple inconsistent ways to perform LDAP
operations. We are well on the way to having a single API in IPA for
doing LDAP (a long range goal).
* All certificate subject bases are now DN's
* DN objects were enhanced thusly:
- find, rfind, index, rindex, replace and insert methods were added
- AVA, RDN and DN classes were refactored in immutable and mutable
variants, the mutable variants are EditableAVA, EditableRDN and
EditableDN. By default we use the immutable variants preserving
important semantics. To edit a DN cast it to an EditableDN and
cast it back to DN when done editing. These issues are fully
described in other documentation.
- first_key_match was removed
- DN equalty comparison permits comparison to a basestring
* Fixed ldapupdate to work with DN's. This work included:
- Enhance test_updates.py to do more checking after applying
update. Add test for update_from_dict(). Convert code to use
unittest classes.
- Consolidated duplicate code.
- Moved code which should have been in the class into the class.
- Fix the handling of the 'deleteentry' update action. It's no longer
necessary to supply fake attributes to make it work. Detect case
where subsequent update applies a change to entry previously marked
for deletetion. General clean-up and simplification of the
'deleteentry' logic.
- Rewrote a couple of functions to be clearer and more Pythonic.
- Added documentation on the data structure being used.
- Simplfy the use of update_from_dict()
* Removed all usage of get_schema() which was being called prior to
accessing the .schema attribute of an object. If a class is using
internal lazy loading as an optimization it's not right to require
users of the interface to be aware of internal
optimization's. schema is now a property and when the schema
property is accessed it calls a private internal method to perform
the lazy loading.
* Added SchemaCache class to cache the schema's from individual
servers. This was done because of the observation we talk to
different LDAP servers, each of which may have it's own
schema. Previously we globally cached the schema from the first
server we connected to and returned that schema in all contexts. The
cache includes controls to invalidate it thus forcing a schema
refresh.
* Schema caching is now senstive to the run time context. During
install and upgrade the schema can change leading to errors due to
out-of-date cached schema. The schema cache is refreshed in these
contexts.
* We are aware of the LDAP syntax of all LDAP attributes. Every
attribute returned from an LDAP operation is passed through a
central table look-up based on it's LDAP syntax. The table key is
the LDAP syntax it's value is a Python callable that returns a
Python object matching the LDAP syntax. There are a handful of LDAP
attributes whose syntax is historically incorrect
(e.g. DistguishedNames that are defined as DirectoryStrings). The
table driven conversion mechanism is augmented with a table of
hard coded exceptions.
Currently only the following conversions occur via the table:
- dn's are converted to DN objects
- binary objects are converted to Python str objects (IPA
convention).
- everything else is converted to unicode using UTF-8 decoding (IPA
convention).
However, now that the table driven conversion mechanism is in place
it would be trivial to do things such as converting attributes
which have LDAP integer syntax into a Python integer, etc.
* Expected values in the unit tests which are a DN no longer need to
use lambda expressions to promote the returned value to a DN for
equality comparison. The return value is automatically promoted to
a DN. The lambda expressions have been removed making the code much
simpler and easier to read.
* Add class level logging to a number of classes which did not support
logging, less need for use of root_logger.
* Remove ipaserver/conn.py, it was unused.
* Consolidated duplicate code wherever it was found.
* Fixed many places that used string concatenation to form a new
string rather than string formatting operators. This is necessary
because string formatting converts it's arguments to a string prior
to building the result string. You can't concatenate a string and a
non-string.
* Simplify logic in rename_managed plugin. Use DN operators to edit
dn's.
* The live version of ipa-ldap-updater did not generate a log file.
The offline version did, now both do.
https://fedorahosted.org/freeipa/ticket/1670
https://fedorahosted.org/freeipa/ticket/1671
https://fedorahosted.org/freeipa/ticket/1672
https://fedorahosted.org/freeipa/ticket/1673
https://fedorahosted.org/freeipa/ticket/1674
https://fedorahosted.org/freeipa/ticket/1392
https://fedorahosted.org/freeipa/ticket/2872
2012-05-13 06:36:35 -05:00
|
|
|
if isinstance(value, dict):
|
2008-11-24 13:51:03 -06:00
|
|
|
return dict(
|
Use Python3-compatible dict method names
Python 2 has keys()/values()/items(), which return lists,
iterkeys()/itervalues()/iteritems(), which return iterators,
and viewkeys()/viewvalues()/viewitems() which return views.
Python 3 has only keys()/values()/items(), which return views.
To get iterators, one can use iter() or a for loop/comprehension;
for lists there's the list() constructor.
When iterating through the entire dict, without modifying the dict,
the difference between Python 2's items() and iteritems() is
negligible, especially on small dicts (the main overhead is
extra memory, not CPU time). In the interest of simpler code,
this patch changes many instances of iteritems() to items(),
iterkeys() to keys() etc.
In other cases, helpers like six.itervalues are used.
Reviewed-By: Christian Heimes <cheimes@redhat.com>
Reviewed-By: Jan Cholasta <jcholast@redhat.com>
2015-08-11 06:51:14 -05:00
|
|
|
(k, xml_wrap(v, version)) for (k, v) in value.items()
|
2008-11-24 13:51:03 -06:00
|
|
|
)
|
2015-09-11 07:02:13 -05:00
|
|
|
if type(value) is bytes:
|
2008-11-24 13:51:03 -06:00
|
|
|
return Binary(value)
|
2012-01-17 04:19:00 -06:00
|
|
|
if type(value) is Decimal:
|
|
|
|
# transfer Decimal as a string
|
|
|
|
return unicode(value)
|
2018-09-26 05:33:30 -05:00
|
|
|
if isinstance(value, int) and (value < MININT or value > MAXINT):
|
2012-09-04 08:49:26 -05:00
|
|
|
return unicode(value)
|
Use DN objects instead of strings
* Convert every string specifying a DN into a DN object
* Every place a dn was manipulated in some fashion it was replaced by
the use of DN operators
* Add new DNParam parameter type for parameters which are DN's
* DN objects are used 100% of the time throughout the entire data
pipeline whenever something is logically a dn.
* Many classes now enforce DN usage for their attributes which are
dn's. This is implmented via ipautil.dn_attribute_property(). The
only permitted types for a class attribute specified to be a DN are
either None or a DN object.
* Require that every place a dn is used it must be a DN object.
This translates into lot of::
assert isinstance(dn, DN)
sprinkled through out the code. Maintaining these asserts is
valuable to preserve DN type enforcement. The asserts can be
disabled in production.
The goal of 100% DN usage 100% of the time has been realized, these
asserts are meant to preserve that.
The asserts also proved valuable in detecting functions which did
not obey their function signatures, such as the baseldap pre and
post callbacks.
* Moved ipalib.dn to ipapython.dn because DN class is shared with all
components, not just the server which uses ipalib.
* All API's now accept DN's natively, no need to convert to str (or
unicode).
* Removed ipalib.encoder and encode/decode decorators. Type conversion
is now explicitly performed in each IPASimpleLDAPObject method which
emulates a ldap.SimpleLDAPObject method.
* Entity & Entry classes now utilize DN's
* Removed __getattr__ in Entity & Entity clases. There were two
problems with it. It presented synthetic Python object attributes
based on the current LDAP data it contained. There is no way to
validate synthetic attributes using code checkers, you can't search
the code to find LDAP attribute accesses (because synthetic
attriutes look like Python attributes instead of LDAP data) and
error handling is circumscribed. Secondly __getattr__ was hiding
Python internal methods which broke class semantics.
* Replace use of methods inherited from ldap.SimpleLDAPObject via
IPAdmin class with IPAdmin methods. Directly using inherited methods
was causing us to bypass IPA logic. Mostly this meant replacing the
use of search_s() with getEntry() or getList(). Similarly direct
access of the LDAP data in classes using IPAdmin were replaced with
calls to getValue() or getValues().
* Objects returned by ldap2.find_entries() are now compatible with
either the python-ldap access methodology or the Entity/Entry access
methodology.
* All ldap operations now funnel through the common
IPASimpleLDAPObject giving us a single location where we interface
to python-ldap and perform conversions.
* The above 4 modifications means we've greatly reduced the
proliferation of multiple inconsistent ways to perform LDAP
operations. We are well on the way to having a single API in IPA for
doing LDAP (a long range goal).
* All certificate subject bases are now DN's
* DN objects were enhanced thusly:
- find, rfind, index, rindex, replace and insert methods were added
- AVA, RDN and DN classes were refactored in immutable and mutable
variants, the mutable variants are EditableAVA, EditableRDN and
EditableDN. By default we use the immutable variants preserving
important semantics. To edit a DN cast it to an EditableDN and
cast it back to DN when done editing. These issues are fully
described in other documentation.
- first_key_match was removed
- DN equalty comparison permits comparison to a basestring
* Fixed ldapupdate to work with DN's. This work included:
- Enhance test_updates.py to do more checking after applying
update. Add test for update_from_dict(). Convert code to use
unittest classes.
- Consolidated duplicate code.
- Moved code which should have been in the class into the class.
- Fix the handling of the 'deleteentry' update action. It's no longer
necessary to supply fake attributes to make it work. Detect case
where subsequent update applies a change to entry previously marked
for deletetion. General clean-up and simplification of the
'deleteentry' logic.
- Rewrote a couple of functions to be clearer and more Pythonic.
- Added documentation on the data structure being used.
- Simplfy the use of update_from_dict()
* Removed all usage of get_schema() which was being called prior to
accessing the .schema attribute of an object. If a class is using
internal lazy loading as an optimization it's not right to require
users of the interface to be aware of internal
optimization's. schema is now a property and when the schema
property is accessed it calls a private internal method to perform
the lazy loading.
* Added SchemaCache class to cache the schema's from individual
servers. This was done because of the observation we talk to
different LDAP servers, each of which may have it's own
schema. Previously we globally cached the schema from the first
server we connected to and returned that schema in all contexts. The
cache includes controls to invalidate it thus forcing a schema
refresh.
* Schema caching is now senstive to the run time context. During
install and upgrade the schema can change leading to errors due to
out-of-date cached schema. The schema cache is refreshed in these
contexts.
* We are aware of the LDAP syntax of all LDAP attributes. Every
attribute returned from an LDAP operation is passed through a
central table look-up based on it's LDAP syntax. The table key is
the LDAP syntax it's value is a Python callable that returns a
Python object matching the LDAP syntax. There are a handful of LDAP
attributes whose syntax is historically incorrect
(e.g. DistguishedNames that are defined as DirectoryStrings). The
table driven conversion mechanism is augmented with a table of
hard coded exceptions.
Currently only the following conversions occur via the table:
- dn's are converted to DN objects
- binary objects are converted to Python str objects (IPA
convention).
- everything else is converted to unicode using UTF-8 decoding (IPA
convention).
However, now that the table driven conversion mechanism is in place
it would be trivial to do things such as converting attributes
which have LDAP integer syntax into a Python integer, etc.
* Expected values in the unit tests which are a DN no longer need to
use lambda expressions to promote the returned value to a DN for
equality comparison. The return value is automatically promoted to
a DN. The lambda expressions have been removed making the code much
simpler and easier to read.
* Add class level logging to a number of classes which did not support
logging, less need for use of root_logger.
* Remove ipaserver/conn.py, it was unused.
* Consolidated duplicate code wherever it was found.
* Fixed many places that used string concatenation to form a new
string rather than string formatting operators. This is necessary
because string formatting converts it's arguments to a string prior
to building the result string. You can't concatenate a string and a
non-string.
* Simplify logic in rename_managed plugin. Use DN operators to edit
dn's.
* The live version of ipa-ldap-updater did not generate a log file.
The offline version did, now both do.
https://fedorahosted.org/freeipa/ticket/1670
https://fedorahosted.org/freeipa/ticket/1671
https://fedorahosted.org/freeipa/ticket/1672
https://fedorahosted.org/freeipa/ticket/1673
https://fedorahosted.org/freeipa/ticket/1674
https://fedorahosted.org/freeipa/ticket/1392
https://fedorahosted.org/freeipa/ticket/2872
2012-05-13 06:36:35 -05:00
|
|
|
if isinstance(value, DN):
|
|
|
|
return str(value)
|
2014-01-09 04:14:56 -06:00
|
|
|
|
2015-09-14 06:22:38 -05:00
|
|
|
# Encode datetime.datetime objects as xmlrpc.client.DateTime objects
|
2014-01-09 04:14:56 -06:00
|
|
|
if isinstance(value, datetime.datetime):
|
|
|
|
if capabilities.client_has_capability(version, 'datetime_values'):
|
|
|
|
return DateTime(value)
|
|
|
|
else:
|
|
|
|
return value.strftime(LDAP_GENERALIZED_TIME_FORMAT)
|
|
|
|
|
2014-04-11 07:45:43 -05:00
|
|
|
if isinstance(value, DNSName):
|
|
|
|
if capabilities.client_has_capability(version, 'dns_name_values'):
|
|
|
|
return {'__dns_name__': unicode(value)}
|
|
|
|
else:
|
|
|
|
return unicode(value)
|
|
|
|
|
2016-06-23 11:23:00 -05:00
|
|
|
if isinstance(value, Principal):
|
|
|
|
return unicode(value)
|
|
|
|
|
2017-07-03 10:10:34 -05:00
|
|
|
if isinstance(value, crypto_x509.Certificate):
|
|
|
|
return base64.b64encode(
|
2017-08-28 03:52:15 -05:00
|
|
|
value.public_bytes(x509_Encoding.DER)).decode('ascii')
|
2017-07-03 10:10:34 -05:00
|
|
|
|
2017-09-22 07:52:36 -05:00
|
|
|
if isinstance(value, crypto_x509.CertificateSigningRequest):
|
|
|
|
return base64.b64encode(
|
|
|
|
value.public_bytes(x509_Encoding.DER)).decode('ascii')
|
|
|
|
|
2018-09-26 05:33:30 -05:00
|
|
|
assert type(value) in (unicode, float, int, bool, type(None))
|
2008-11-24 13:51:03 -06:00
|
|
|
return value
|
|
|
|
|
|
|
|
|
2009-01-16 00:52:50 -06:00
|
|
|
def xml_unwrap(value, encoding='UTF-8'):
|
2008-11-24 13:51:03 -06:00
|
|
|
"""
|
|
|
|
Unwrap all ``xmlrpc.Binary``, decode all ``str`` into ``unicode``.
|
|
|
|
|
2009-01-16 02:23:55 -06:00
|
|
|
When decoding data from an XML-RPC packet, the following transformations
|
2008-11-24 13:51:03 -06:00
|
|
|
occur:
|
|
|
|
|
2015-09-14 06:22:38 -05:00
|
|
|
* The binary payloads of all ``xmlrpc.client.Binary`` instances are
|
2008-11-24 13:51:03 -06:00
|
|
|
returned as ``str`` instances.
|
|
|
|
|
2009-01-16 02:23:55 -06:00
|
|
|
* All ``str`` instances are treated as UTF-8 encoded Unicode strings.
|
2008-11-24 13:51:03 -06:00
|
|
|
They are decoded and the resulting ``unicode`` instance is returned.
|
|
|
|
|
2009-01-16 02:23:55 -06:00
|
|
|
Also see `xml_wrap()`.
|
|
|
|
|
|
|
|
:param value: The value to unwrap.
|
|
|
|
:param encoding: The Unicode encoding to use (defaults to ``'UTF-8'``).
|
2008-11-24 13:51:03 -06:00
|
|
|
"""
|
2018-01-03 03:17:40 -06:00
|
|
|
if isinstance(value, (unicode, int, float, bool)):
|
|
|
|
# most common first
|
|
|
|
return value
|
|
|
|
elif value is None:
|
|
|
|
return value
|
|
|
|
elif isinstance(value, bytes):
|
|
|
|
return value.decode(encoding)
|
|
|
|
elif isinstance(value, (list, tuple)):
|
2009-01-16 00:52:50 -06:00
|
|
|
return tuple(xml_unwrap(v, encoding) for v in value)
|
2018-01-03 03:17:40 -06:00
|
|
|
elif isinstance(value, dict):
|
2014-04-11 07:45:43 -05:00
|
|
|
if '__dns_name__' in value:
|
|
|
|
return DNSName(value['__dns_name__'])
|
|
|
|
else:
|
|
|
|
return dict(
|
Use Python3-compatible dict method names
Python 2 has keys()/values()/items(), which return lists,
iterkeys()/itervalues()/iteritems(), which return iterators,
and viewkeys()/viewvalues()/viewitems() which return views.
Python 3 has only keys()/values()/items(), which return views.
To get iterators, one can use iter() or a for loop/comprehension;
for lists there's the list() constructor.
When iterating through the entire dict, without modifying the dict,
the difference between Python 2's items() and iteritems() is
negligible, especially on small dicts (the main overhead is
extra memory, not CPU time). In the interest of simpler code,
this patch changes many instances of iteritems() to items(),
iterkeys() to keys() etc.
In other cases, helpers like six.itervalues are used.
Reviewed-By: Christian Heimes <cheimes@redhat.com>
Reviewed-By: Jan Cholasta <jcholast@redhat.com>
2015-08-11 06:51:14 -05:00
|
|
|
(k, xml_unwrap(v, encoding)) for (k, v) in value.items()
|
2014-04-11 07:45:43 -05:00
|
|
|
)
|
2018-01-03 03:17:40 -06:00
|
|
|
elif isinstance(value, Binary):
|
2015-09-11 07:02:13 -05:00
|
|
|
assert type(value.data) is bytes
|
2008-11-24 13:51:03 -06:00
|
|
|
return value.data
|
2018-01-03 03:17:40 -06:00
|
|
|
elif isinstance(value, DateTime):
|
2014-01-09 04:14:56 -06:00
|
|
|
# xmlprc DateTime is converted to string of %Y%m%dT%H:%M:%S format
|
|
|
|
return datetime.datetime.strptime(str(value), "%Y%m%dT%H:%M:%S")
|
2018-01-03 03:17:40 -06:00
|
|
|
raise TypeError(value)
|
2009-01-16 00:52:50 -06:00
|
|
|
|
|
|
|
|
2014-03-28 03:51:10 -05:00
|
|
|
def xml_dumps(params, version, methodname=None, methodresponse=False,
|
|
|
|
encoding='UTF-8'):
|
2009-01-16 02:23:55 -06:00
|
|
|
"""
|
|
|
|
Encode an XML-RPC data packet, transparently wraping ``params``.
|
|
|
|
|
|
|
|
This function will wrap ``params`` using `xml_wrap()` and will
|
2015-09-14 06:22:38 -05:00
|
|
|
then encode the XML-RPC data packet using ``xmlrpc.client.dumps()`` (from the
|
2009-01-16 02:23:55 -06:00
|
|
|
Python standard library).
|
|
|
|
|
2015-09-14 06:22:38 -05:00
|
|
|
For documentation on the ``xmlrpc.client.dumps()`` function, see:
|
2009-01-16 02:23:55 -06:00
|
|
|
|
2015-09-14 06:22:38 -05:00
|
|
|
http://docs.python.org/library/xmlrpc.client.html#convenience-functions
|
2009-01-16 02:23:55 -06:00
|
|
|
|
|
|
|
Also see `xml_loads()`.
|
|
|
|
|
2015-09-14 06:22:38 -05:00
|
|
|
:param params: A ``tuple`` or an ``xmlrpc.client.Fault`` instance.
|
2009-01-16 02:23:55 -06:00
|
|
|
:param methodname: The name of the method to call if this is a request.
|
|
|
|
:param methodresponse: Set this to ``True`` if this is a response.
|
|
|
|
:param encoding: The Unicode encoding to use (defaults to ``'UTF-8'``).
|
|
|
|
"""
|
2009-01-16 00:52:50 -06:00
|
|
|
if type(params) is tuple:
|
2014-03-28 03:51:10 -05:00
|
|
|
params = xml_wrap(params, version)
|
2009-01-16 00:52:50 -06:00
|
|
|
else:
|
|
|
|
assert isinstance(params, Fault)
|
|
|
|
return dumps(params,
|
|
|
|
methodname=methodname,
|
|
|
|
methodresponse=methodresponse,
|
|
|
|
encoding=encoding,
|
|
|
|
allow_none=True,
|
|
|
|
)
|
|
|
|
|
2009-01-31 00:46:51 -06:00
|
|
|
|
2017-02-13 12:09:14 -06:00
|
|
|
class _JSONPrimer(dict):
|
|
|
|
"""Fast JSON primer and pre-converter
|
|
|
|
|
|
|
|
Prepare a data structure for JSON serialization. In an ideal world, priming
|
|
|
|
could be handled by the default hook of json.dumps(). Unfortunately the
|
|
|
|
hook treats Python 2 str as text while FreeIPA considers str as bytes.
|
|
|
|
|
|
|
|
The primer uses a couple of tricks to archive maximum performance:
|
|
|
|
|
|
|
|
* O(1) type look instead of O(n) chain of costly isinstance() calls
|
|
|
|
* __missing__ and __mro__ with caching to handle subclasses
|
2017-02-14 06:19:19 -06:00
|
|
|
* inline code with minor code duplication (func lookup in enc_list/dict)
|
|
|
|
* avoid surplus function calls (e.g. func is _identity, obj.__class__
|
|
|
|
instead if type(obj))
|
2017-02-13 12:09:14 -06:00
|
|
|
* function default arguments to turn global into local lookups
|
2017-02-14 06:19:19 -06:00
|
|
|
* avoid re-creation of bound method objects (e.g. result.append)
|
|
|
|
* on-demand lookup of client capabilities with cached values
|
2017-02-13 12:09:14 -06:00
|
|
|
|
|
|
|
Depending on the client version number, the primer converts:
|
|
|
|
|
|
|
|
* bytes -> {'__base64__': b64encode}
|
|
|
|
* datetime -> {'__datetime__': LDAP_GENERALIZED_TIME}
|
|
|
|
* DNSName -> {'__dns_name__': unicode}
|
|
|
|
|
|
|
|
The _ipa_obj_hook() functions unserializes the marked JSON objects to
|
|
|
|
bytes, datetime and DNSName.
|
|
|
|
|
|
|
|
:see: _ipa_obj_hook
|
|
|
|
"""
|
2017-02-13 02:46:39 -06:00
|
|
|
__slots__ = ('version', '_cap_datetime', '_cap_dnsname')
|
|
|
|
|
|
|
|
_identity = object()
|
|
|
|
|
|
|
|
def __init__(self, version, _identity=_identity):
|
2017-02-13 12:09:14 -06:00
|
|
|
super(_JSONPrimer, self).__init__()
|
2017-02-13 02:46:39 -06:00
|
|
|
self.version = version
|
|
|
|
self._cap_datetime = None
|
|
|
|
self._cap_dnsname = None
|
|
|
|
self.update({
|
|
|
|
unicode: _identity,
|
|
|
|
bool: _identity,
|
2018-09-26 05:33:30 -05:00
|
|
|
int: _identity,
|
2017-02-13 02:46:39 -06:00
|
|
|
type(None): _identity,
|
|
|
|
float: _identity,
|
|
|
|
Decimal: unicode,
|
|
|
|
DN: str,
|
|
|
|
Principal: unicode,
|
|
|
|
DNSName: self._enc_dnsname,
|
|
|
|
datetime.datetime: self._enc_datetime,
|
|
|
|
bytes: self._enc_bytes,
|
|
|
|
list: self._enc_list,
|
|
|
|
tuple: self._enc_list,
|
|
|
|
dict: self._enc_dict,
|
2017-07-03 10:10:34 -05:00
|
|
|
crypto_x509.Certificate: self._enc_certificate,
|
2017-09-22 07:52:36 -05:00
|
|
|
crypto_x509.CertificateSigningRequest: self._enc_certificate,
|
2017-02-13 02:46:39 -06:00
|
|
|
})
|
|
|
|
|
|
|
|
def __missing__(self, typ):
|
|
|
|
# walk MRO to find best match
|
|
|
|
for c in typ.__mro__:
|
|
|
|
if c in self:
|
|
|
|
self[typ] = self[c]
|
|
|
|
return self[c]
|
|
|
|
# use issubclass to check for registered ABCs
|
|
|
|
for c in self:
|
|
|
|
if issubclass(typ, c):
|
|
|
|
self[typ] = self[c]
|
|
|
|
return self[c]
|
|
|
|
raise TypeError(typ)
|
|
|
|
|
|
|
|
def convert(self, obj, _identity=_identity):
|
|
|
|
# obj.__class__ is twice as fast as type(obj)
|
|
|
|
func = self[obj.__class__]
|
|
|
|
return obj if func is _identity else func(obj)
|
|
|
|
|
|
|
|
def _enc_datetime(self, val):
|
|
|
|
cap = self._cap_datetime
|
|
|
|
if cap is None:
|
|
|
|
cap = capabilities.client_has_capability(self.version,
|
|
|
|
'datetime_values')
|
|
|
|
self._cap_datetime = cap
|
|
|
|
if cap:
|
2014-01-09 04:14:56 -06:00
|
|
|
return {'__datetime__': val.strftime(LDAP_GENERALIZED_TIME_FORMAT)}
|
|
|
|
else:
|
|
|
|
return val.strftime(LDAP_GENERALIZED_TIME_FORMAT)
|
2017-02-13 02:46:39 -06:00
|
|
|
|
|
|
|
def _enc_dnsname(self, val):
|
|
|
|
cap = self._cap_dnsname
|
|
|
|
if cap is None:
|
|
|
|
cap = capabilities.client_has_capability(self.version,
|
|
|
|
'dns_name_values')
|
|
|
|
self._cap_dnsname = cap
|
|
|
|
if cap:
|
2014-04-11 07:45:43 -05:00
|
|
|
return {'__dns_name__': unicode(val)}
|
|
|
|
else:
|
|
|
|
return unicode(val)
|
2017-02-13 02:46:39 -06:00
|
|
|
|
|
|
|
def _enc_bytes(self, val):
|
|
|
|
encoded = base64.b64encode(val)
|
|
|
|
if not six.PY2:
|
|
|
|
encoded = encoded.decode('ascii')
|
|
|
|
return {'__base64__': encoded}
|
|
|
|
|
|
|
|
def _enc_list(self, val, _identity=_identity):
|
|
|
|
result = []
|
|
|
|
append = result.append
|
|
|
|
for v in val:
|
|
|
|
func = self[v.__class__]
|
|
|
|
append(v if func is _identity else func(v))
|
|
|
|
return result
|
|
|
|
|
|
|
|
def _enc_dict(self, val, _identity=_identity, _iteritems=six.iteritems):
|
|
|
|
result = {}
|
|
|
|
for k, v in _iteritems(val):
|
|
|
|
func = self[v.__class__]
|
|
|
|
result[k] = v if func is _identity else func(v)
|
|
|
|
return result
|
|
|
|
|
2017-07-03 10:10:34 -05:00
|
|
|
def _enc_certificate(self, val):
|
|
|
|
return self._enc_bytes(val.public_bytes(x509_Encoding.DER))
|
|
|
|
|
2017-02-13 02:46:39 -06:00
|
|
|
|
2017-02-13 12:09:14 -06:00
|
|
|
def json_encode_binary(val, version, pretty_print=False):
|
|
|
|
"""Serialize a Python object structure to JSON
|
|
|
|
|
|
|
|
:param object val: Python object structure
|
|
|
|
:param str version: client version
|
|
|
|
:param bool pretty_print: indent and sort JSON (warning: slow!)
|
|
|
|
:return: text
|
|
|
|
:note: pretty printing triggers a slow path in Python's JSON module. Only
|
|
|
|
use pretty_print in debug mode.
|
2017-02-13 02:46:39 -06:00
|
|
|
"""
|
2017-02-13 12:09:14 -06:00
|
|
|
result = _JSONPrimer(version).convert(val)
|
|
|
|
if pretty_print:
|
|
|
|
return json.dumps(result, indent=4, sort_keys=True)
|
|
|
|
else:
|
|
|
|
return json.dumps(result)
|
2017-02-13 02:46:39 -06:00
|
|
|
|
|
|
|
|
2017-02-13 03:46:36 -06:00
|
|
|
def _ipa_obj_hook(dct, _iteritems=six.iteritems, _list=list):
|
2017-02-13 12:09:14 -06:00
|
|
|
"""JSON object hook
|
|
|
|
|
|
|
|
:see: _JSONPrimer
|
|
|
|
"""
|
2017-02-13 02:46:39 -06:00
|
|
|
if '__base64__' in dct:
|
|
|
|
return base64.b64decode(dct['__base64__'])
|
|
|
|
elif '__datetime__' in dct:
|
|
|
|
return datetime.datetime.strptime(dct['__datetime__'],
|
|
|
|
LDAP_GENERALIZED_TIME_FORMAT)
|
|
|
|
elif '__dns_name__' in dct:
|
|
|
|
return DNSName(dct['__dns_name__'])
|
2012-12-19 03:25:24 -06:00
|
|
|
else:
|
2017-02-13 03:46:36 -06:00
|
|
|
# XXX tests assume tuples. Is this really necessary?
|
|
|
|
for k, v in _iteritems(dct):
|
|
|
|
if v.__class__ is _list:
|
|
|
|
dct[k] = tuple(v)
|
2017-02-13 02:46:39 -06:00
|
|
|
return dct
|
2012-12-19 03:25:24 -06:00
|
|
|
|
|
|
|
|
|
|
|
def json_decode_binary(val):
|
2017-02-13 12:09:14 -06:00
|
|
|
"""Convert serialized JSON string back to Python data structure
|
|
|
|
|
|
|
|
:param val: JSON string
|
|
|
|
:type val: str, bytes
|
|
|
|
:return: Python data structure
|
|
|
|
:see: _ipa_obj_hook, _JSONPrimer
|
2017-02-13 02:46:39 -06:00
|
|
|
"""
|
|
|
|
if isinstance(val, bytes):
|
|
|
|
val = val.decode('utf-8')
|
2012-12-19 03:25:24 -06:00
|
|
|
|
2017-02-13 02:46:39 -06:00
|
|
|
return json.loads(val, object_hook=_ipa_obj_hook)
|
2012-12-19 03:25:24 -06:00
|
|
|
|
|
|
|
|
2009-01-22 16:41:54 -06:00
|
|
|
def decode_fault(e, encoding='UTF-8'):
|
|
|
|
assert isinstance(e, Fault)
|
2015-09-17 11:46:14 -05:00
|
|
|
if isinstance(e.faultString, bytes):
|
2009-01-22 16:41:54 -06:00
|
|
|
return Fault(e.faultCode, e.faultString.decode(encoding))
|
|
|
|
return e
|
2009-01-16 00:52:50 -06:00
|
|
|
|
2009-01-31 00:46:51 -06:00
|
|
|
|
2009-01-22 16:41:54 -06:00
|
|
|
def xml_loads(data, encoding='UTF-8'):
|
2009-01-16 02:23:55 -06:00
|
|
|
"""
|
2009-01-16 02:56:39 -06:00
|
|
|
Decode the XML-RPC packet in ``data``, transparently unwrapping its params.
|
2009-01-16 02:23:55 -06:00
|
|
|
|
|
|
|
This function will decode the XML-RPC packet in ``data`` using
|
2015-09-14 06:22:38 -05:00
|
|
|
``xmlrpc.client.loads()`` (from the Python standard library). If ``data``
|
|
|
|
contains a fault, ``xmlrpc.client.loads()`` will itself raise an
|
|
|
|
``xmlrpc.client.Fault`` exception.
|
2009-01-16 02:23:55 -06:00
|
|
|
|
|
|
|
Assuming an exception is not raised, this function will then unwrap the
|
|
|
|
params in ``data`` using `xml_unwrap()`. Finally, a
|
|
|
|
``(params, methodname)`` tuple is returned containing the unwrapped params
|
|
|
|
and the name of the method being called. If the packet contains no method
|
|
|
|
name, ``methodname`` will be ``None``.
|
|
|
|
|
2015-09-14 06:22:38 -05:00
|
|
|
For documentation on the ``xmlrpc.client.loads()`` function, see:
|
2009-01-16 02:23:55 -06:00
|
|
|
|
2015-09-14 06:22:38 -05:00
|
|
|
http://docs.python.org/2/library/xmlrpclib.html#convenience-functions
|
2009-01-16 02:23:55 -06:00
|
|
|
|
|
|
|
Also see `xml_dumps()`.
|
|
|
|
|
|
|
|
:param data: The XML-RPC packet to decode.
|
|
|
|
"""
|
2009-01-22 16:41:54 -06:00
|
|
|
try:
|
|
|
|
(params, method) = loads(data)
|
|
|
|
return (xml_unwrap(params), method)
|
2015-07-30 09:49:29 -05:00
|
|
|
except Fault as e:
|
2009-01-22 16:41:54 -06:00
|
|
|
raise decode_fault(e)
|
2009-01-19 22:10:42 -06:00
|
|
|
|
|
|
|
|
2018-09-26 04:59:50 -05:00
|
|
|
class DummyParser:
|
2012-12-19 03:25:24 -06:00
|
|
|
def __init__(self):
|
2016-05-25 05:43:02 -05:00
|
|
|
self.data = []
|
2012-12-19 03:25:24 -06:00
|
|
|
|
|
|
|
def feed(self, data):
|
2016-05-25 05:43:02 -05:00
|
|
|
self.data.append(data)
|
2012-12-19 03:25:24 -06:00
|
|
|
|
|
|
|
def close(self):
|
2016-05-25 05:43:02 -05:00
|
|
|
return b''.join(self.data)
|
2012-12-19 03:25:24 -06:00
|
|
|
|
|
|
|
|
|
|
|
class MultiProtocolTransport(Transport):
|
|
|
|
"""Transport that handles both XML-RPC and JSON"""
|
2017-02-13 07:29:35 -06:00
|
|
|
def __init__(self, *args, **kwargs):
|
2012-12-19 03:25:24 -06:00
|
|
|
Transport.__init__(self)
|
2017-02-13 07:29:35 -06:00
|
|
|
self.protocol = kwargs.get('protocol', None)
|
2012-12-19 03:25:24 -06:00
|
|
|
|
|
|
|
def getparser(self):
|
|
|
|
if self.protocol == 'json':
|
|
|
|
parser = DummyParser()
|
|
|
|
return parser, parser
|
|
|
|
else:
|
|
|
|
return Transport.getparser(self)
|
|
|
|
|
|
|
|
def send_content(self, connection, request_body):
|
|
|
|
if self.protocol == 'json':
|
|
|
|
connection.putheader("Content-Type", "application/json")
|
|
|
|
else:
|
|
|
|
connection.putheader("Content-Type", "text/xml")
|
|
|
|
|
|
|
|
# gzip compression would be set up here, but we have it turned off
|
|
|
|
# (encode_threshold is None)
|
|
|
|
|
|
|
|
connection.putheader("Content-Length", str(len(request_body)))
|
|
|
|
connection.endheaders(request_body)
|
|
|
|
|
|
|
|
|
|
|
|
class LanguageAwareTransport(MultiProtocolTransport):
|
2011-02-15 13:10:38 -06:00
|
|
|
"""Transport sending Accept-Language header"""
|
|
|
|
def get_host_info(self, host):
|
2012-12-19 03:25:24 -06:00
|
|
|
host, extra_headers, x509 = MultiProtocolTransport.get_host_info(
|
|
|
|
self, host)
|
2011-02-15 13:10:38 -06:00
|
|
|
|
2011-02-07 12:26:25 -06:00
|
|
|
try:
|
2018-01-23 07:41:25 -06:00
|
|
|
lang = locale.setlocale(
|
|
|
|
locale.LC_MESSAGES, ''
|
|
|
|
).split('.')[0].lower()
|
2011-02-07 12:26:25 -06:00
|
|
|
except locale.Error:
|
|
|
|
# fallback to default locale
|
|
|
|
lang = 'en_us'
|
2011-02-15 13:10:38 -06:00
|
|
|
|
|
|
|
if not isinstance(extra_headers, list):
|
|
|
|
extra_headers = []
|
|
|
|
|
|
|
|
extra_headers.append(
|
|
|
|
('Accept-Language', lang.replace('_', '-'))
|
|
|
|
)
|
2011-10-20 10:29:26 -05:00
|
|
|
extra_headers.append(
|
|
|
|
('Referer', 'https://%s/ipa/xml' % str(host))
|
|
|
|
)
|
2011-02-15 13:10:38 -06:00
|
|
|
|
|
|
|
return (host, extra_headers, x509)
|
|
|
|
|
2016-12-20 03:05:36 -06:00
|
|
|
|
2011-02-15 13:10:38 -06:00
|
|
|
class SSLTransport(LanguageAwareTransport):
|
2009-02-19 16:20:37 -06:00
|
|
|
"""Handles an HTTPS transaction to an XML-RPC server."""
|
|
|
|
def make_connection(self, host):
|
2016-10-07 08:07:49 -05:00
|
|
|
host, self._extra_headers, _x509 = self.get_host_info(host)
|
2012-03-03 18:50:21 -06:00
|
|
|
|
2015-10-20 12:01:23 -05:00
|
|
|
if self._connection and host == self._connection[0]:
|
2017-05-24 09:35:07 -05:00
|
|
|
logger.debug("HTTP connection keep-alive (%s)", host)
|
2015-10-20 12:01:23 -05:00
|
|
|
return self._connection[1]
|
2012-10-17 15:58:54 -05:00
|
|
|
|
2016-12-20 03:05:36 -06:00
|
|
|
conn = create_https_connection(
|
|
|
|
host, 443,
|
2017-09-06 15:23:03 -05:00
|
|
|
getattr(context, 'ca_certfile', None),
|
2016-12-20 03:05:36 -06:00
|
|
|
tls_version_min=api.env.tls_version_min,
|
|
|
|
tls_version_max=api.env.tls_version_max)
|
2012-10-17 15:58:54 -05:00
|
|
|
|
2010-05-31 06:40:17 -05:00
|
|
|
conn.connect()
|
2017-05-24 09:35:07 -05:00
|
|
|
logger.debug("New HTTP connection (%s)", host)
|
2015-10-20 12:01:23 -05:00
|
|
|
|
|
|
|
self._connection = host, conn
|
|
|
|
return self._connection[1]
|
2009-02-19 16:20:37 -06:00
|
|
|
|
2012-06-06 21:54:16 -05:00
|
|
|
|
2009-02-19 16:20:37 -06:00
|
|
|
class KerbTransport(SSLTransport):
|
2009-01-22 15:00:37 -06:00
|
|
|
"""
|
|
|
|
Handles Kerberos Negotiation authentication to an XML-RPC server.
|
|
|
|
"""
|
2015-07-16 11:22:00 -05:00
|
|
|
flags = [gssapi.RequirementFlag.mutual_authentication,
|
|
|
|
gssapi.RequirementFlag.out_of_sequence_detection]
|
|
|
|
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
|
|
SSLTransport.__init__(self, *args, **kwargs)
|
|
|
|
self._sec_context = None
|
2017-02-13 07:29:35 -06:00
|
|
|
self.service = kwargs.pop("service", "HTTP")
|
|
|
|
self.ccache = kwargs.pop("ccache", None)
|
2009-01-22 15:00:37 -06:00
|
|
|
|
2009-04-13 17:01:58 -05:00
|
|
|
def _handle_exception(self, e, service=None):
|
2015-07-16 11:22:00 -05:00
|
|
|
minor = e.min_code
|
|
|
|
if minor == KRB5KDC_ERR_S_PRINCIPAL_UNKNOWN:
|
2009-04-23 07:51:59 -05:00
|
|
|
raise errors.ServiceError(service=service)
|
2015-07-16 11:22:00 -05:00
|
|
|
elif minor == KRB5_FCC_NOFILE:
|
2009-04-23 07:51:59 -05:00
|
|
|
raise errors.NoCCacheError()
|
2015-07-16 11:22:00 -05:00
|
|
|
elif minor == KRB5KRB_AP_ERR_TKT_EXPIRED:
|
2009-04-23 07:51:59 -05:00
|
|
|
raise errors.TicketExpired()
|
2015-07-16 11:22:00 -05:00
|
|
|
elif minor == KRB5_FCC_PERM:
|
2009-04-23 07:51:59 -05:00
|
|
|
raise errors.BadCCachePerms()
|
2015-07-16 11:22:00 -05:00
|
|
|
elif minor == KRB5_CC_FORMAT:
|
2009-04-23 07:51:59 -05:00
|
|
|
raise errors.BadCCacheFormat()
|
2015-07-16 11:22:00 -05:00
|
|
|
elif minor == KRB5_REALM_CANT_RESOLVE:
|
2009-04-23 07:51:59 -05:00
|
|
|
raise errors.CannotResolveKDC()
|
2015-08-31 07:04:33 -05:00
|
|
|
elif minor == KRB5_CC_NOTFOUND:
|
|
|
|
raise errors.CCacheError()
|
2009-04-13 17:01:58 -05:00
|
|
|
else:
|
2015-08-31 07:04:33 -05:00
|
|
|
raise errors.KerberosError(message=unicode(e))
|
2009-04-13 17:01:58 -05:00
|
|
|
|
2017-03-22 17:38:22 -05:00
|
|
|
def _get_host(self):
|
|
|
|
return self._connection[0]
|
|
|
|
|
|
|
|
def _remove_extra_header(self, name):
|
|
|
|
for (h, v) in self._extra_headers:
|
|
|
|
if h == name:
|
|
|
|
self._extra_headers.remove((h, v))
|
|
|
|
break
|
|
|
|
|
|
|
|
def get_auth_info(self, use_cookie=True):
|
2012-06-06 21:54:16 -05:00
|
|
|
"""
|
|
|
|
Two things can happen here. If we have a session we will add
|
|
|
|
a cookie for that. If not we will set an Authorization header.
|
|
|
|
"""
|
2017-03-22 17:38:22 -05:00
|
|
|
if not isinstance(self._extra_headers, list):
|
|
|
|
self._extra_headers = []
|
2012-06-06 21:54:16 -05:00
|
|
|
|
2017-03-22 17:38:22 -05:00
|
|
|
# Remove any existing Cookie first
|
|
|
|
self._remove_extra_header('Cookie')
|
|
|
|
if use_cookie:
|
|
|
|
session_cookie = getattr(context, 'session_cookie', None)
|
|
|
|
if session_cookie:
|
|
|
|
self._extra_headers.append(('Cookie', session_cookie))
|
|
|
|
return
|
2012-06-06 21:54:16 -05:00
|
|
|
|
2009-01-22 15:00:37 -06:00
|
|
|
# Set the remote host principal
|
2017-03-22 17:38:22 -05:00
|
|
|
host = self._get_host()
|
2017-02-13 07:29:35 -06:00
|
|
|
service = self.service + "@" + host.split(':')[0]
|
2009-01-22 15:00:37 -06:00
|
|
|
|
|
|
|
try:
|
2017-02-13 07:29:35 -06:00
|
|
|
creds = None
|
|
|
|
if self.ccache:
|
|
|
|
creds = gssapi.Credentials(usage='initiate',
|
|
|
|
store={'ccache': self.ccache})
|
2015-07-16 11:22:00 -05:00
|
|
|
name = gssapi.Name(service, gssapi.NameType.hostbased_service)
|
2017-02-13 07:29:35 -06:00
|
|
|
self._sec_context = gssapi.SecurityContext(creds=creds, name=name,
|
|
|
|
flags=self.flags)
|
2015-07-16 11:22:00 -05:00
|
|
|
response = self._sec_context.step()
|
|
|
|
except gssapi.exceptions.GSSError as e:
|
2009-04-13 17:01:58 -05:00
|
|
|
self._handle_exception(e, service=service)
|
2009-01-22 15:00:37 -06:00
|
|
|
|
2017-03-22 17:38:22 -05:00
|
|
|
self._set_auth_header(response)
|
2015-07-16 11:22:00 -05:00
|
|
|
|
2017-03-22 17:38:22 -05:00
|
|
|
def _set_auth_header(self, token):
|
|
|
|
# Remove any existing authorization header first
|
|
|
|
self._remove_extra_header('Authorization')
|
2011-02-15 13:10:38 -06:00
|
|
|
|
2015-07-16 11:22:00 -05:00
|
|
|
if token:
|
2017-03-22 17:38:22 -05:00
|
|
|
self._extra_headers.append(
|
2015-09-22 03:29:32 -05:00
|
|
|
('Authorization', 'negotiate %s' % base64.b64encode(token).decode('ascii'))
|
2015-07-16 11:22:00 -05:00
|
|
|
)
|
2009-01-22 15:00:37 -06:00
|
|
|
|
2015-07-16 11:22:00 -05:00
|
|
|
def _auth_complete(self, response):
|
|
|
|
if self._sec_context:
|
|
|
|
header = response.getheader('www-authenticate', '')
|
|
|
|
token = None
|
|
|
|
for field in header.split(','):
|
2016-10-07 08:07:49 -05:00
|
|
|
k, _dummy, v = field.strip().partition(' ')
|
2015-07-16 11:22:00 -05:00
|
|
|
if k.lower() == 'negotiate':
|
|
|
|
try:
|
2015-09-22 03:29:32 -05:00
|
|
|
token = base64.b64decode(v.encode('ascii'))
|
2015-07-16 11:22:00 -05:00
|
|
|
break
|
|
|
|
# b64decode raises TypeError on invalid input
|
2015-09-22 03:29:32 -05:00
|
|
|
except (TypeError, UnicodeError):
|
2015-07-16 11:22:00 -05:00
|
|
|
pass
|
|
|
|
if not token:
|
2017-05-31 08:45:19 -05:00
|
|
|
raise errors.KerberosError(
|
2016-10-05 14:16:30 -05:00
|
|
|
message=u"No valid Negotiate header in server response")
|
2015-07-16 11:22:00 -05:00
|
|
|
token = self._sec_context.step(token=token)
|
|
|
|
if self._sec_context.complete:
|
|
|
|
self._sec_context = None
|
|
|
|
return True
|
2017-03-22 17:38:22 -05:00
|
|
|
self._set_auth_header(token)
|
|
|
|
return False
|
|
|
|
elif response.status == 401:
|
|
|
|
self.get_auth_info(use_cookie=False)
|
2015-07-16 11:22:00 -05:00
|
|
|
return False
|
|
|
|
return True
|
2009-01-22 15:00:37 -06:00
|
|
|
|
2012-10-17 15:58:54 -05:00
|
|
|
def single_request(self, host, handler, request_body, verbose=0):
|
2015-09-17 11:48:30 -05:00
|
|
|
# Based on Python 2.7's xmllib.Transport.single_request
|
2012-10-17 15:58:54 -05:00
|
|
|
try:
|
2017-03-22 17:38:22 -05:00
|
|
|
h = self.make_connection(host)
|
2015-09-17 11:48:30 -05:00
|
|
|
|
2015-07-16 11:22:00 -05:00
|
|
|
if verbose:
|
|
|
|
h.set_debuglevel(1)
|
|
|
|
|
2017-03-22 17:38:22 -05:00
|
|
|
self.get_auth_info()
|
|
|
|
|
2015-07-16 11:22:00 -05:00
|
|
|
while True:
|
2015-09-17 11:48:30 -05:00
|
|
|
if six.PY2:
|
2016-11-23 03:04:43 -06:00
|
|
|
# pylint: disable=no-value-for-parameter
|
2015-09-17 11:48:30 -05:00
|
|
|
self.send_request(h, handler, request_body)
|
2016-11-23 03:04:43 -06:00
|
|
|
# pylint: enable=no-value-for-parameter
|
2015-09-17 11:48:30 -05:00
|
|
|
self.send_host(h, host)
|
|
|
|
self.send_user_agent(h)
|
|
|
|
self.send_content(h, request_body)
|
|
|
|
response = h.getresponse(buffering=True)
|
|
|
|
else:
|
|
|
|
self.__send_request(h, host, handler, request_body, verbose)
|
|
|
|
response = h.getresponse()
|
2015-07-16 11:22:00 -05:00
|
|
|
|
|
|
|
if response.status != 200:
|
rpc: always read response
If the server responds 401 and the response body is empty, the
client raises ResponseNotReady. This occurs because:
1. For a non-200 response, the response read only if the
Content-Length header occurs.
2. The response must be read before another request (e.g. the
follow-up request with WWW-Authenticate header set), and this
condition was not met. For details see
https://github.com/python/cpython/blob/v3.6.7/Lib/http/client.py#L1305-L1321.
This situation should not arise in regular use, because the client
either has a session cookie, or, knowing the details of the server
it is contacting, it establishes the GSS-API context and includes
the WWW-Authenticate header in the initial request.
Nevertheless, this problem has been observed in the wild. I do not
know its ordinary cause(s), but one can force the issue by removing
an authenticated user's session cache from /run/ipa/ccaches, then
performing a request.
Resolve the issue by always reading the response. It is safe to
call response.read() regardless of whether the Content-Length header
appears, or whether the body is empty.
Fixes: https://pagure.io/freeipa/issue/7752
Reviewed-By: Christian Heimes <cheimes@redhat.com>
2018-11-07 00:06:47 -06:00
|
|
|
# Must read response (even if it is empty)
|
|
|
|
# before sending another request.
|
|
|
|
#
|
|
|
|
# https://docs.python.org/3/library/http.client.html
|
|
|
|
# #http.client.HTTPConnection.getresponse
|
|
|
|
#
|
|
|
|
# https://pagure.io/freeipa/issue/7752
|
|
|
|
#
|
|
|
|
response.read()
|
2015-07-16 11:22:00 -05:00
|
|
|
|
|
|
|
if response.status == 401:
|
|
|
|
if not self._auth_complete(response):
|
|
|
|
continue
|
|
|
|
|
|
|
|
raise ProtocolError(
|
|
|
|
host + handler,
|
|
|
|
response.status, response.reason,
|
|
|
|
response.msg)
|
|
|
|
|
|
|
|
self.verbose = verbose
|
|
|
|
if not self._auth_complete(response):
|
|
|
|
continue
|
|
|
|
return self.parse_response(response)
|
|
|
|
except gssapi.exceptions.GSSError as e:
|
|
|
|
self._handle_exception(e)
|
2017-03-20 02:47:51 -05:00
|
|
|
except RemoteDisconnected:
|
|
|
|
# keep-alive connection was terminated by remote peer, close
|
|
|
|
# connection and let transport handle reconnect for us.
|
|
|
|
self.close()
|
2017-05-24 09:35:07 -05:00
|
|
|
logger.debug("HTTP server has closed connection (%s)", host)
|
2017-03-20 02:47:51 -05:00
|
|
|
raise
|
|
|
|
except BaseException as e:
|
|
|
|
# Unexpected exception may leave connections in a bad state.
|
2012-10-17 15:58:54 -05:00
|
|
|
self.close()
|
2017-05-24 09:35:07 -05:00
|
|
|
logger.debug("HTTP connection destroyed (%s)",
|
|
|
|
host, exc_info=True)
|
2017-03-20 02:47:51 -05:00
|
|
|
raise
|
2012-10-17 15:58:54 -05:00
|
|
|
|
2015-09-17 11:48:30 -05:00
|
|
|
if six.PY3:
|
|
|
|
def __send_request(self, connection, host, handler, request_body, debug):
|
|
|
|
# Based on xmlrpc.client.Transport.send_request
|
|
|
|
headers = self._extra_headers[:]
|
|
|
|
if debug:
|
|
|
|
connection.set_debuglevel(1)
|
|
|
|
if self.accept_gzip_encoding and gzip:
|
|
|
|
connection.putrequest("POST", handler, skip_accept_encoding=True)
|
|
|
|
connection.putheader("Accept-Encoding", "gzip")
|
|
|
|
headers.append(("Accept-Encoding", "gzip"))
|
|
|
|
else:
|
|
|
|
connection.putrequest("POST", handler)
|
|
|
|
headers.append(("User-Agent", self.user_agent))
|
2015-10-27 12:18:26 -05:00
|
|
|
self.send_headers(connection, headers) # pylint: disable=E1101
|
2015-09-17 11:48:30 -05:00
|
|
|
self.send_content(connection, request_body)
|
|
|
|
return connection
|
|
|
|
|
2017-03-23 16:49:27 -05:00
|
|
|
# Find all occurrences of the expiry component
|
|
|
|
expiry_re = re.compile(r'.*?(&expiry=\d+).*?')
|
|
|
|
|
|
|
|
def _slice_session_cookie(self, session_cookie):
|
|
|
|
# Keep only the cookie value and strip away all other info.
|
|
|
|
# This is to reduce the churn on FILE ccaches which grow every time we
|
|
|
|
# set new data. The expiration time for the cookie is set in the
|
|
|
|
# encrypted data anyway and will be enforced by the server
|
|
|
|
http_cookie = session_cookie.http_cookie()
|
|
|
|
# We also remove the "expiry" part from the data which is not required
|
|
|
|
for exp in self.expiry_re.findall(http_cookie):
|
|
|
|
http_cookie = http_cookie.replace(exp, '')
|
|
|
|
return http_cookie
|
|
|
|
|
2012-12-04 17:20:17 -06:00
|
|
|
def store_session_cookie(self, cookie_header):
|
|
|
|
'''
|
|
|
|
Given the contents of a Set-Cookie header scan the header and
|
|
|
|
extract each cookie contained within until the session cookie
|
|
|
|
is located. Examine the session cookie if the domain and path
|
|
|
|
are specified, if not update the cookie with those values from
|
|
|
|
the request URL. Then write the session cookie into the key
|
|
|
|
store for the principal. If the cookie header is None or the
|
|
|
|
session cookie is not present in the header no action is
|
|
|
|
taken.
|
|
|
|
|
|
|
|
Context Dependencies:
|
|
|
|
|
|
|
|
The per thread context is expected to contain:
|
|
|
|
principal
|
|
|
|
The current pricipal the HTTP request was issued for.
|
|
|
|
request_url
|
|
|
|
The URL of the HTTP request.
|
|
|
|
|
|
|
|
'''
|
|
|
|
|
|
|
|
if cookie_header is None:
|
|
|
|
return
|
|
|
|
|
|
|
|
principal = getattr(context, 'principal', None)
|
|
|
|
request_url = getattr(context, 'request_url', None)
|
2017-05-24 09:35:07 -05:00
|
|
|
logger.debug("received Set-Cookie (%s)'%s'", type(cookie_header),
|
|
|
|
cookie_header)
|
2016-09-30 15:17:31 -05:00
|
|
|
|
|
|
|
if not isinstance(cookie_header, list):
|
|
|
|
cookie_header = [cookie_header]
|
2012-12-04 17:20:17 -06:00
|
|
|
|
|
|
|
# Search for the session cookie
|
2017-01-30 19:23:58 -06:00
|
|
|
session_cookie = None
|
2012-12-04 17:20:17 -06:00
|
|
|
try:
|
2016-09-30 15:17:31 -05:00
|
|
|
for cookie in cookie_header:
|
2017-03-02 02:11:34 -06:00
|
|
|
session_cookie = (
|
|
|
|
Cookie.get_named_cookie_from_string(
|
|
|
|
cookie, COOKIE_NAME, request_url,
|
|
|
|
timestamp=datetime.datetime.utcnow())
|
|
|
|
)
|
2016-09-30 15:17:31 -05:00
|
|
|
if session_cookie is not None:
|
|
|
|
break
|
2015-07-30 09:49:29 -05:00
|
|
|
except Exception as e:
|
2017-05-24 09:35:07 -05:00
|
|
|
logger.error("unable to parse cookie header '%s': %s",
|
|
|
|
cookie_header, e)
|
2012-12-04 17:20:17 -06:00
|
|
|
return
|
|
|
|
|
|
|
|
if session_cookie is None:
|
|
|
|
return
|
|
|
|
|
2017-03-23 16:49:27 -05:00
|
|
|
cookie_string = self._slice_session_cookie(session_cookie)
|
2017-05-24 09:35:07 -05:00
|
|
|
logger.debug("storing cookie '%s' for principal %s",
|
|
|
|
cookie_string, principal)
|
2012-12-04 17:20:17 -06:00
|
|
|
try:
|
|
|
|
update_persistent_client_session_data(principal, cookie_string)
|
2015-07-30 09:49:29 -05:00
|
|
|
except Exception as e:
|
2012-12-04 17:20:17 -06:00
|
|
|
# Not fatal, we just can't use the session cookie we were sent.
|
|
|
|
pass
|
|
|
|
|
2012-07-16 09:40:12 -05:00
|
|
|
def parse_response(self, response):
|
2016-12-14 05:20:15 -06:00
|
|
|
if six.PY2:
|
|
|
|
header = response.msg.getheaders('Set-Cookie')
|
|
|
|
else:
|
|
|
|
header = response.msg.get_all('Set-Cookie')
|
|
|
|
self.store_session_cookie(header)
|
2012-07-16 09:40:12 -05:00
|
|
|
return SSLTransport.parse_response(self, response)
|
|
|
|
|
2009-01-22 15:00:37 -06:00
|
|
|
|
2012-02-15 10:06:54 -06:00
|
|
|
class DelegatedKerbTransport(KerbTransport):
|
|
|
|
"""
|
|
|
|
Handles Kerberos Negotiation authentication and TGT delegation to an
|
|
|
|
XML-RPC server.
|
|
|
|
"""
|
2015-07-16 11:22:00 -05:00
|
|
|
flags = [gssapi.RequirementFlag.delegate_to_peer,
|
|
|
|
gssapi.RequirementFlag.mutual_authentication,
|
|
|
|
gssapi.RequirementFlag.out_of_sequence_detection]
|
2012-02-15 10:06:54 -06:00
|
|
|
|
2012-12-19 03:25:24 -06:00
|
|
|
|
|
|
|
class RPCClient(Connectible):
|
2009-01-19 22:10:42 -06:00
|
|
|
"""
|
2009-01-23 14:08:24 -06:00
|
|
|
Forwarding backend plugin for XML-RPC client.
|
|
|
|
|
|
|
|
Also see the `ipaserver.rpcserver.xmlserver` plugin.
|
2009-01-19 22:10:42 -06:00
|
|
|
"""
|
|
|
|
|
2012-12-19 03:25:24 -06:00
|
|
|
# Values to set on subclasses:
|
|
|
|
session_path = None
|
|
|
|
server_proxy_class = ServerProxy
|
|
|
|
protocol = None
|
|
|
|
env_rpc_uri_key = None
|
2009-01-19 22:10:42 -06:00
|
|
|
|
2012-12-19 03:25:24 -06:00
|
|
|
def get_url_list(self, rpc_uri):
|
2010-07-26 16:54:38 -05:00
|
|
|
"""
|
|
|
|
Create a list of urls consisting of the available IPA servers.
|
|
|
|
"""
|
|
|
|
# the configured URL defines what we use for the discovered servers
|
2016-10-07 08:07:49 -05:00
|
|
|
(_scheme, _netloc, path, _params, _query, _fragment
|
2015-09-14 05:52:29 -05:00
|
|
|
) = urllib.parse.urlparse(rpc_uri)
|
2010-07-26 16:54:38 -05:00
|
|
|
servers = []
|
|
|
|
name = '_ldap._tcp.%s.' % self.env.domain
|
2012-05-11 07:38:09 -05:00
|
|
|
|
|
|
|
try:
|
2018-06-15 10:03:29 -05:00
|
|
|
answers = query_srv(name)
|
2016-10-07 08:07:49 -05:00
|
|
|
except DNSException:
|
2012-05-11 07:38:09 -05:00
|
|
|
answers = []
|
|
|
|
|
|
|
|
for answer in answers:
|
|
|
|
server = str(answer.target).rstrip(".")
|
|
|
|
servers.append('https://%s%s' % (ipautil.format_netloc(server), path))
|
|
|
|
|
2018-06-15 10:03:29 -05:00
|
|
|
# make sure the configured master server is there just once and
|
|
|
|
# it is the first one.
|
|
|
|
if rpc_uri in servers:
|
|
|
|
servers.remove(rpc_uri)
|
|
|
|
servers.insert(0, rpc_uri)
|
2011-09-19 11:37:27 -05:00
|
|
|
|
2010-07-26 16:54:38 -05:00
|
|
|
return servers
|
|
|
|
|
2012-12-04 17:20:17 -06:00
|
|
|
def get_session_cookie_from_persistent_storage(self, principal):
|
|
|
|
'''
|
|
|
|
Retrieves the session cookie for the given principal from the
|
|
|
|
persistent secure storage. Returns None if not found or unable
|
|
|
|
to retrieve the session cookie for any reason, otherwise
|
|
|
|
returns a Cookie object containing the session cookie.
|
|
|
|
'''
|
|
|
|
|
|
|
|
# Get the session data, it should contain a cookie string
|
|
|
|
# (possibly with more than one cookie).
|
|
|
|
try:
|
|
|
|
cookie_string = read_persistent_client_session_data(principal)
|
2017-09-19 07:00:43 -05:00
|
|
|
if cookie_string is None:
|
2017-12-15 10:00:04 -06:00
|
|
|
return None
|
2017-06-02 08:12:09 -05:00
|
|
|
cookie_string = cookie_string.decode('utf-8')
|
|
|
|
except Exception as e:
|
2017-05-23 11:35:57 -05:00
|
|
|
logger.debug('Error reading client session data: %s', e)
|
2012-12-04 17:20:17 -06:00
|
|
|
return None
|
|
|
|
|
|
|
|
# Search for the session cookie within the cookie string
|
|
|
|
try:
|
2017-03-02 02:11:34 -06:00
|
|
|
session_cookie = Cookie.get_named_cookie_from_string(
|
|
|
|
cookie_string, COOKIE_NAME,
|
|
|
|
timestamp=datetime.datetime.utcnow())
|
2017-03-17 02:55:30 -05:00
|
|
|
except Exception as e:
|
2017-05-23 11:35:57 -05:00
|
|
|
logger.debug(
|
|
|
|
'Error retrieving cookie from the persistent storage: %s',
|
|
|
|
e)
|
2012-12-04 17:20:17 -06:00
|
|
|
return None
|
|
|
|
|
|
|
|
return session_cookie
|
|
|
|
|
|
|
|
def apply_session_cookie(self, url):
|
|
|
|
'''
|
|
|
|
Attempt to load a session cookie for the current principal
|
|
|
|
from the persistent secure storage. If the cookie is
|
|
|
|
successfully loaded adjust the input url's to point to the
|
|
|
|
session path and insert the session cookie into the per thread
|
|
|
|
context for later insertion into the HTTP request. If the
|
|
|
|
cookie is not successfully loaded then the original url is
|
|
|
|
returned and the per thread context is not modified.
|
|
|
|
|
|
|
|
Context Dependencies:
|
|
|
|
|
|
|
|
The per thread context is expected to contain:
|
|
|
|
principal
|
|
|
|
The current pricipal the HTTP request was issued for.
|
|
|
|
|
|
|
|
The per thread context will be updated with:
|
|
|
|
session_cookie
|
|
|
|
A cookie string to be inserted into the Cookie header
|
|
|
|
of the HTPP request.
|
|
|
|
|
|
|
|
'''
|
|
|
|
|
|
|
|
original_url = url
|
|
|
|
principal = getattr(context, 'principal', None)
|
|
|
|
|
|
|
|
session_cookie = self.get_session_cookie_from_persistent_storage(principal)
|
|
|
|
if session_cookie is None:
|
2017-05-23 11:35:57 -05:00
|
|
|
logger.debug("failed to find session_cookie in persistent storage "
|
|
|
|
"for principal '%s'",
|
|
|
|
principal)
|
2012-12-04 17:20:17 -06:00
|
|
|
return original_url
|
|
|
|
else:
|
2017-05-23 11:35:57 -05:00
|
|
|
logger.debug("found session_cookie in persistent storage for "
|
|
|
|
"principal '%s', cookie: '%s'",
|
|
|
|
principal, session_cookie)
|
2012-12-04 17:20:17 -06:00
|
|
|
|
|
|
|
# Decide if we should send the cookie to the server
|
|
|
|
try:
|
|
|
|
session_cookie.http_return_ok(original_url)
|
2015-07-30 09:49:29 -05:00
|
|
|
except Cookie.Expired as e:
|
2017-05-23 11:35:57 -05:00
|
|
|
logger.debug("deleting session data for principal '%s': %s",
|
|
|
|
principal, e)
|
2012-12-04 17:20:17 -06:00
|
|
|
try:
|
|
|
|
delete_persistent_client_session_data(principal)
|
2015-07-30 09:49:29 -05:00
|
|
|
except Exception as e:
|
2012-12-04 17:20:17 -06:00
|
|
|
pass
|
|
|
|
return original_url
|
2015-07-30 09:49:29 -05:00
|
|
|
except Cookie.URLMismatch as e:
|
2017-05-23 11:35:57 -05:00
|
|
|
logger.debug("not sending session cookie, URL mismatch: %s", e)
|
2012-12-04 17:20:17 -06:00
|
|
|
return original_url
|
2015-07-30 09:49:29 -05:00
|
|
|
except Exception as e:
|
2017-05-23 11:35:57 -05:00
|
|
|
logger.error("not sending session cookie, unknown error: %s", e)
|
2012-12-04 17:20:17 -06:00
|
|
|
return original_url
|
|
|
|
|
|
|
|
# O.K. session_cookie is valid to be returned, stash it away where it will will
|
|
|
|
# get included in a HTTP Cookie headed sent to the server.
|
2017-05-23 11:35:57 -05:00
|
|
|
logger.debug("setting session_cookie into context '%s'",
|
|
|
|
session_cookie.http_cookie())
|
2012-12-04 17:20:17 -06:00
|
|
|
setattr(context, 'session_cookie', session_cookie.http_cookie())
|
|
|
|
|
|
|
|
# Form the session URL by substituting the session path into the original URL
|
2015-09-14 05:52:29 -05:00
|
|
|
scheme, netloc, path, params, query, fragment = urllib.parse.urlparse(original_url)
|
2012-12-19 03:25:24 -06:00
|
|
|
path = self.session_path
|
2015-09-14 05:52:29 -05:00
|
|
|
# urlencode *can* take one argument
|
|
|
|
# pylint: disable=too-many-function-args
|
|
|
|
session_url = urllib.parse.urlunparse((scheme, netloc, path, params, query, fragment))
|
2012-12-04 17:20:17 -06:00
|
|
|
|
|
|
|
return session_url
|
|
|
|
|
2016-05-25 05:20:31 -05:00
|
|
|
def create_connection(self, ccache=None, verbose=None, fallback=None,
|
2016-12-20 03:05:36 -06:00
|
|
|
delegate=None, ca_certfile=None):
|
2016-05-25 05:20:31 -05:00
|
|
|
if verbose is None:
|
|
|
|
verbose = self.api.env.verbose
|
|
|
|
if fallback is None:
|
|
|
|
fallback = self.api.env.fallback
|
|
|
|
if delegate is None:
|
|
|
|
delegate = self.api.env.delegate
|
2016-12-20 03:05:36 -06:00
|
|
|
if ca_certfile is None:
|
|
|
|
ca_certfile = self.api.env.tls_ca_cert
|
2017-05-31 08:45:19 -05:00
|
|
|
context.ca_certfile = ca_certfile
|
|
|
|
|
|
|
|
rpc_uri = self.env[self.env_rpc_uri_key]
|
2012-06-06 21:54:16 -05:00
|
|
|
try:
|
2017-02-13 07:29:35 -06:00
|
|
|
principal = get_principal(ccache_name=ccache)
|
2017-02-14 06:16:54 -06:00
|
|
|
stored_principal = getattr(context, 'principal', None)
|
|
|
|
if principal != stored_principal:
|
|
|
|
try:
|
|
|
|
delattr(context, 'session_cookie')
|
|
|
|
except AttributeError:
|
|
|
|
pass
|
2012-07-16 09:40:12 -05:00
|
|
|
setattr(context, 'principal', principal)
|
2012-06-06 21:54:16 -05:00
|
|
|
# We have a session cookie, try using the session URI to see if it
|
|
|
|
# is still valid
|
|
|
|
if not delegate:
|
2012-12-19 03:25:24 -06:00
|
|
|
rpc_uri = self.apply_session_cookie(rpc_uri)
|
2015-08-31 07:04:33 -05:00
|
|
|
except (errors.CCacheError, ValueError):
|
2012-06-06 21:54:16 -05:00
|
|
|
# No session key, do full Kerberos auth
|
|
|
|
pass
|
2012-12-19 03:25:24 -06:00
|
|
|
urls = self.get_url_list(rpc_uri)
|
2017-06-01 02:00:15 -05:00
|
|
|
|
|
|
|
proxy_kw = {
|
|
|
|
'allow_none': True,
|
|
|
|
'encoding': 'UTF-8',
|
|
|
|
'verbose': verbose
|
|
|
|
}
|
|
|
|
|
2012-12-04 17:20:17 -06:00
|
|
|
for url in urls:
|
2017-06-01 02:00:15 -05:00
|
|
|
# should we get ProtocolError (=> error in HTTP response) and
|
|
|
|
# 401 (=> Unauthorized), we'll be re-trying with new session
|
|
|
|
# cookies several times
|
|
|
|
for _try_num in range(0, 5):
|
|
|
|
if url.startswith('https://'):
|
|
|
|
if delegate:
|
|
|
|
transport_class = DelegatedKerbTransport
|
|
|
|
else:
|
|
|
|
transport_class = KerbTransport
|
2012-02-15 10:06:54 -06:00
|
|
|
else:
|
2017-06-01 02:00:15 -05:00
|
|
|
transport_class = LanguageAwareTransport
|
|
|
|
proxy_kw['transport'] = transport_class(
|
|
|
|
protocol=self.protocol, service='HTTP', ccache=ccache)
|
2018-05-02 10:43:09 -05:00
|
|
|
logger.debug('trying %s', url)
|
2017-06-01 02:00:15 -05:00
|
|
|
setattr(context, 'request_url', url)
|
|
|
|
serverproxy = self.server_proxy_class(url, **proxy_kw)
|
|
|
|
if len(urls) == 1:
|
|
|
|
# if we have only 1 server and then let the
|
|
|
|
# main requester handle any errors. This also means it
|
|
|
|
# must handle a 401 but we save a ping.
|
|
|
|
return serverproxy
|
2011-05-17 14:09:39 -05:00
|
|
|
try:
|
2017-06-01 02:00:15 -05:00
|
|
|
command = getattr(serverproxy, 'ping')
|
2012-06-06 21:54:16 -05:00
|
|
|
try:
|
2017-06-01 02:00:15 -05:00
|
|
|
command([], {})
|
|
|
|
except Fault as e:
|
|
|
|
e = decode_fault(e)
|
|
|
|
if e.faultCode in errors_by_code:
|
|
|
|
error = errors_by_code[e.faultCode]
|
|
|
|
raise error(message=e.faultString)
|
|
|
|
else:
|
|
|
|
raise UnknownError(
|
|
|
|
code=e.faultCode,
|
|
|
|
error=e.faultString,
|
|
|
|
server=url,
|
|
|
|
)
|
|
|
|
# We don't care about the response, just that we got one
|
|
|
|
return serverproxy
|
2018-07-12 09:21:34 -05:00
|
|
|
# pylint: disable=try-except-raise
|
2017-06-01 02:00:15 -05:00
|
|
|
except errors.KerberosError:
|
|
|
|
# kerberos error on one server is likely on all
|
2012-06-06 21:54:16 -05:00
|
|
|
raise
|
2018-07-12 09:21:34 -05:00
|
|
|
# pylint: enable=try-except-raise
|
2017-06-01 02:00:15 -05:00
|
|
|
except ProtocolError as e:
|
|
|
|
if hasattr(context, 'session_cookie') and e.errcode == 401:
|
|
|
|
# Unauthorized. Remove the session and try again.
|
|
|
|
delattr(context, 'session_cookie')
|
|
|
|
try:
|
|
|
|
delete_persistent_client_session_data(principal)
|
|
|
|
except Exception:
|
|
|
|
# This shouldn't happen if we have a session but
|
|
|
|
# it isn't fatal.
|
|
|
|
pass
|
|
|
|
# try the same url once more with a new session cookie
|
|
|
|
continue
|
|
|
|
if not fallback:
|
|
|
|
raise
|
|
|
|
else:
|
2017-05-23 11:35:57 -05:00
|
|
|
logger.info(
|
2017-06-01 02:00:15 -05:00
|
|
|
'Connection to %s failed with %s', url, e)
|
|
|
|
# try the next url
|
|
|
|
break
|
|
|
|
except Exception as e:
|
|
|
|
if not fallback:
|
|
|
|
raise
|
|
|
|
else:
|
2017-05-23 11:35:57 -05:00
|
|
|
logger.info(
|
2017-06-01 02:00:15 -05:00
|
|
|
'Connection to %s failed with %s', url, e)
|
|
|
|
# try the next url
|
|
|
|
break
|
|
|
|
# finished all tries but no serverproxy was found
|
|
|
|
raise NetworkError(uri=_('any of the configured servers'),
|
|
|
|
error=', '.join(urls))
|
2009-01-22 15:00:37 -06:00
|
|
|
|
2009-01-23 19:02:32 -06:00
|
|
|
def destroy_connection(self):
|
2015-10-20 12:01:23 -05:00
|
|
|
conn = getattr(context, self.id, None)
|
|
|
|
if conn is not None:
|
|
|
|
conn = conn.conn._ServerProxy__transport
|
|
|
|
conn.close()
|
2009-01-22 15:00:37 -06:00
|
|
|
|
2012-12-19 03:25:24 -06:00
|
|
|
def _call_command(self, command, params):
|
|
|
|
"""Call the command with given params"""
|
|
|
|
# For XML, this method will wrap/unwrap binary values
|
|
|
|
# For JSON we do that in the proxy
|
|
|
|
return command(*params)
|
|
|
|
|
2009-01-19 22:10:42 -06:00
|
|
|
def forward(self, name, *args, **kw):
|
|
|
|
"""
|
|
|
|
Forward call to command named ``name`` over XML-RPC.
|
|
|
|
|
|
|
|
This method will encode and forward an XML-RPC request, and will then
|
|
|
|
decode and return the corresponding XML-RPC response.
|
|
|
|
|
|
|
|
:param command: The name of the command being forwarded.
|
|
|
|
:param args: Positional arguments to pass to remote command.
|
|
|
|
:param kw: Keyword arguments to pass to remote command.
|
|
|
|
"""
|
2012-12-04 17:20:17 -06:00
|
|
|
server = getattr(context, 'request_url', None)
|
2009-01-23 19:02:32 -06:00
|
|
|
command = getattr(self.conn, name)
|
2010-03-26 04:56:53 -05:00
|
|
|
params = [args, kw]
|
2012-10-01 12:05:11 -05:00
|
|
|
|
2017-05-26 01:37:36 -05:00
|
|
|
# we'll be trying to connect multiple times with a new session cookie
|
|
|
|
# each time should we be getting UNAUTHORIZED error from the server
|
|
|
|
max_tries = 5
|
|
|
|
for try_num in range(0, max_tries):
|
2018-05-02 10:43:09 -05:00
|
|
|
logger.debug("[try %d]: Forwarding '%s' to %s server '%s'",
|
|
|
|
try_num + 1, name, self.protocol, server)
|
2017-05-26 01:37:36 -05:00
|
|
|
try:
|
|
|
|
return self._call_command(command, params)
|
|
|
|
except Fault as e:
|
|
|
|
e = decode_fault(e)
|
2017-05-23 11:35:57 -05:00
|
|
|
logger.debug('Caught fault %d from server %s: %s', e.faultCode,
|
|
|
|
server, e.faultString)
|
2017-05-26 01:37:36 -05:00
|
|
|
if e.faultCode in errors_by_code:
|
|
|
|
error = errors_by_code[e.faultCode]
|
|
|
|
raise error(message=e.faultString)
|
|
|
|
raise UnknownError(
|
|
|
|
code=e.faultCode,
|
|
|
|
error=e.faultString,
|
|
|
|
server=server,
|
|
|
|
)
|
|
|
|
except ProtocolError as e:
|
|
|
|
# By catching a 401 here we can detect the case where we have
|
|
|
|
# a single IPA server and the session is invalid. Otherwise
|
|
|
|
# we always have to do a ping().
|
|
|
|
session_cookie = getattr(context, 'session_cookie', None)
|
|
|
|
if session_cookie and e.errcode == 401:
|
|
|
|
# Unauthorized. Remove the session and try again.
|
|
|
|
delattr(context, 'session_cookie')
|
|
|
|
try:
|
|
|
|
principal = getattr(context, 'principal', None)
|
|
|
|
delete_persistent_client_session_data(principal)
|
2020-04-27 07:33:17 -05:00
|
|
|
except Exception as e2:
|
2017-05-26 01:37:36 -05:00
|
|
|
# This shouldn't happen if we have a session
|
|
|
|
# but it isn't fatal.
|
2017-05-23 11:35:57 -05:00
|
|
|
logger.debug("Error trying to remove persisent "
|
2020-04-27 07:33:17 -05:00
|
|
|
"session data: %s", e2)
|
2017-05-26 01:37:36 -05:00
|
|
|
|
|
|
|
# Create a new serverproxy with the non-session URI
|
|
|
|
serverproxy = self.create_connection(
|
|
|
|
os.environ.get('KRB5CCNAME'), self.env.verbose,
|
|
|
|
self.env.fallback, self.env.delegate)
|
|
|
|
|
|
|
|
setattr(context, self.id,
|
|
|
|
Connection(serverproxy, self.disconnect))
|
|
|
|
# try to connect again with the new session cookie
|
|
|
|
continue
|
|
|
|
raise NetworkError(uri=server, error=e.errmsg)
|
|
|
|
except (SSLError, socket.error) as e:
|
|
|
|
raise NetworkError(uri=server, error=str(e))
|
|
|
|
except (OverflowError, TypeError) as e:
|
|
|
|
raise XMLRPCMarshallError(error=str(e))
|
|
|
|
raise NetworkError(
|
|
|
|
uri=server,
|
|
|
|
error=_("Exceeded number of tries to forward a request."))
|
2012-12-19 03:25:24 -06:00
|
|
|
|
|
|
|
|
|
|
|
class xmlclient(RPCClient):
|
|
|
|
session_path = '/ipa/session/xml'
|
|
|
|
server_proxy_class = ServerProxy
|
|
|
|
protocol = 'xml'
|
|
|
|
env_rpc_uri_key = 'xmlrpc_uri'
|
|
|
|
|
|
|
|
def _call_command(self, command, params):
|
2014-03-28 03:51:10 -05:00
|
|
|
version = params[1].get('version', VERSION_WITHOUT_CAPABILITIES)
|
|
|
|
params = xml_wrap(params, version)
|
2012-12-19 03:25:24 -06:00
|
|
|
result = command(*params)
|
|
|
|
return xml_unwrap(result)
|
|
|
|
|
|
|
|
|
2018-09-26 04:59:50 -05:00
|
|
|
class JSONServerProxy:
|
2012-12-19 03:25:24 -06:00
|
|
|
def __init__(self, uri, transport, encoding, verbose, allow_none):
|
2015-09-14 05:52:29 -05:00
|
|
|
split_uri = urllib.parse.urlsplit(uri)
|
2015-09-18 03:50:46 -05:00
|
|
|
if split_uri.scheme not in ("http", "https"):
|
2012-12-19 03:25:24 -06:00
|
|
|
raise IOError("unsupported XML-RPC protocol")
|
2015-09-18 03:50:46 -05:00
|
|
|
self.__host = split_uri.netloc
|
|
|
|
self.__handler = split_uri.path
|
2012-12-19 03:25:24 -06:00
|
|
|
self.__transport = transport
|
|
|
|
|
|
|
|
assert encoding == 'UTF-8'
|
|
|
|
assert allow_none
|
|
|
|
self.__verbose = verbose
|
|
|
|
|
|
|
|
# FIXME: Some of our code requires ServerProxy internals.
|
2015-09-14 06:22:38 -05:00
|
|
|
# But, xmlrpc.client.ServerProxy's _ServerProxy__transport can be accessed
|
2012-12-19 03:25:24 -06:00
|
|
|
# by calling serverproxy('transport')
|
|
|
|
self._ServerProxy__transport = transport
|
|
|
|
|
|
|
|
def __request(self, name, args):
|
2017-02-13 12:09:14 -06:00
|
|
|
print_json = self.__verbose >= 2
|
2012-12-19 03:25:24 -06:00
|
|
|
payload = {'method': unicode(name), 'params': args, 'id': 0}
|
2014-03-28 03:51:10 -05:00
|
|
|
version = args[1].get('version', VERSION_WITHOUT_CAPABILITIES)
|
2017-02-13 12:09:14 -06:00
|
|
|
payload = json_encode_binary(
|
|
|
|
payload, version, pretty_print=print_json)
|
2012-12-19 03:25:24 -06:00
|
|
|
|
2017-02-13 12:09:14 -06:00
|
|
|
if print_json:
|
2017-05-24 09:35:07 -05:00
|
|
|
logger.info(
|
2017-02-13 02:46:39 -06:00
|
|
|
'Request: %s',
|
2017-02-13 12:09:14 -06:00
|
|
|
payload
|
2017-02-13 02:46:39 -06:00
|
|
|
)
|
2014-09-23 05:10:56 -05:00
|
|
|
|
2012-12-19 03:25:24 -06:00
|
|
|
response = self.__transport.request(
|
|
|
|
self.__host,
|
|
|
|
self.__handler,
|
2017-02-13 02:46:39 -06:00
|
|
|
payload.encode('utf-8'),
|
2014-09-23 05:10:56 -05:00
|
|
|
verbose=self.__verbose >= 3,
|
2012-12-19 03:25:24 -06:00
|
|
|
)
|
|
|
|
|
2017-03-10 03:33:15 -06:00
|
|
|
if print_json:
|
2017-05-24 09:35:07 -05:00
|
|
|
logger.info(
|
2017-03-10 03:33:15 -06:00
|
|
|
'Response: %s',
|
|
|
|
json.dumps(json.loads(response), sort_keys=True, indent=4)
|
|
|
|
)
|
|
|
|
|
2012-12-19 03:25:24 -06:00
|
|
|
try:
|
2017-02-13 02:46:39 -06:00
|
|
|
response = json_decode_binary(response)
|
2015-07-30 09:49:29 -05:00
|
|
|
except ValueError as e:
|
2016-05-23 06:01:47 -05:00
|
|
|
raise JSONError(error=str(e))
|
2012-12-19 03:25:24 -06:00
|
|
|
|
|
|
|
error = response.get('error')
|
|
|
|
if error:
|
|
|
|
try:
|
|
|
|
error_class = errors_by_code[error['code']]
|
|
|
|
except KeyError:
|
|
|
|
raise UnknownError(
|
|
|
|
code=error.get('code'),
|
|
|
|
error=error.get('message'),
|
|
|
|
server=self.__host,
|
|
|
|
)
|
|
|
|
else:
|
2016-05-18 02:42:56 -05:00
|
|
|
kw = error.get('data', {})
|
|
|
|
kw['message'] = error['message']
|
|
|
|
raise error_class(**kw)
|
2012-12-19 03:25:24 -06:00
|
|
|
|
|
|
|
return response['result']
|
|
|
|
|
|
|
|
def __getattr__(self, name):
|
|
|
|
def _call(*args):
|
|
|
|
return self.__request(name, args)
|
|
|
|
return _call
|
|
|
|
|
|
|
|
|
|
|
|
class jsonclient(RPCClient):
|
|
|
|
session_path = '/ipa/session/json'
|
|
|
|
server_proxy_class = JSONServerProxy
|
|
|
|
protocol = 'json'
|
|
|
|
env_rpc_uri_key = 'jsonrpc_uri'
|