94d457e Use DN objects instead of strings

123 files Authored by jdennis 7 years ago , Committed by rcritten 7 years ago ,
123 files changed. 5498 lines added. 4157 lines removed.
API.txt
file modified
+7 -7
contrib/RHEL4/ipa-client-setup
file modified
+5 -3
install/certmonger/dogtag-ipa-retrieve-agent-submit
file modified
+2 -2
install/migration/migration.py
file modified
+3 -2
install/restart_scripts/renew_ca_cert
file modified
+2 -2
install/restart_scripts/renew_ra_cert
file modified
+4 -4
install/tools/ipa-adtrust-install
file modified
+1 -0
install/tools/ipa-compat-manage
file modified
+4 -3
install/tools/ipa-compliance
file modified
+3 -2
install/tools/ipa-csreplica-manage
file modified
+20 -21
install/tools/ipa-dns-install
file modified
+1 -1
install/tools/ipa-managed-entries
file modified
+7 -12
install/tools/ipa-nis-manage
file modified
+4 -3
install/tools/ipa-replica-install
file modified
+10 -9
install/tools/ipa-replica-manage
file modified
+37 -32
install/tools/ipa-replica-prepare
file modified
+9 -5
install/tools/ipa-server-certinstall
file modified
+3 -2
install/tools/ipa-server-install
file modified
+9 -9
install/tools/ipa-upgradeconfig
file modified
+1 -1
install/tools/ipactl
file modified
+6 -9
ipa-client/ipa-install/ipa-client-automount
file modified
+1 -1
ipa-client/ipa-install/ipa-client-install
file modified
+10 -8
ipa-client/ipaclient/ipadiscovery.py
file modified
+2 -2
ipalib/__init__.py
file modified
+1 -1
ipalib/aci.py
file modified
+0 -26
ipalib/config.py
file modified
+4 -1
ipalib/constants.py
file modified
+37 -36
ipalib/encoder.py
file removed
-213
ipalib/parameters.py
file modified
+18 -1
ipalib/plugins/aci.py
file modified
+26 -26
ipalib/plugins/automember.py
file modified
+12 -13
ipalib/plugins/automount.py
file modified
+5 -1
ipalib/plugins/baseldap.py
file modified
+124 -64
ipalib/plugins/config.py
file modified
+4 -3
ipalib/plugins/dns.py
file modified
+27 -7
ipalib/plugins/entitle.py
file modified
+7 -2
ipalib/plugins/group.py
file modified
+8 -0
ipalib/plugins/hbacrule.py
file modified
+9 -0
ipalib/plugins/host.py
file modified
+12 -3
ipalib/plugins/hostgroup.py
file modified
+7 -1
ipalib/plugins/krbtpolicy.py
file modified
+4 -1
ipalib/plugins/migration.py
file modified
+39 -47
ipalib/plugins/netgroup.py
file modified
+7 -0
ipalib/plugins/passwd.py
file modified
+2 -1
ipalib/plugins/permission.py
file modified
+15 -4
ipalib/plugins/pkinit.py
file modified
+2 -3
ipalib/plugins/pwpolicy.py
file modified
+18 -8
ipalib/plugins/range.py
file modified
+7 -1
ipalib/plugins/selinuxusermap.py
file modified
+7 -0
ipalib/plugins/service.py
file modified
+7 -0
ipalib/plugins/sudorule.py
file modified
+16 -0
ipalib/plugins/trust.py
file modified
+6 -2
ipalib/plugins/user.py
file modified
+14 -4
ipalib/plugins/virtual.py
file modified
+2 -1
ipalib/rpc.py
file modified
+4 -1
ipalib/session.py
file modified
+1 -1
ipalib/util.py
file modified
+1 -8
ipalib/x509.py
file modified
+1 -1
ipapython/dn.pyipalib/dn.py
file renamed
+514 -208
ipapython/entity.py
file modified
+13 -19
ipapython/ipa_log_manager.py
file modified
+2 -2
ipapython/ipautil.py
file modified
+40 -3
ipaserver/conn.py
file removed
-69
ipaserver/dcerpc.py
file modified
+2 -4
ipaserver/install/adtrustinstance.py
file modified
+30 -33
ipaserver/install/bindinstance.py
file modified
+19 -9
ipaserver/install/cainstance.py
file modified
+35 -29
ipaserver/install/certs.py
file modified
+14 -12
ipaserver/install/dsinstance.py
file modified
+21 -21
ipaserver/install/httpinstance.py
file modified
+2 -0
ipaserver/install/installutils.py
file modified
+4 -1
ipaserver/install/ipa_ldap_updater.py
file modified
+2 -0
ipaserver/install/krbinstance.py
file modified
+14 -9
ipaserver/install/ldapupdate.py
file modified
+357 -331
ipaserver/install/plugins/adtrust.py
file modified
+7 -9
ipaserver/install/plugins/dns.py
file modified
+18 -23
ipaserver/install/plugins/fix_replica_memberof.py
file modified
+2 -2
ipaserver/install/plugins/rename_managed.py
file modified
+96 -63
ipaserver/install/plugins/updateclient.py
file modified
+7 -16
ipaserver/install/replication.py
file modified
+106 -98
ipaserver/install/service.py
file modified
+14 -12
ipaserver/ipaldap.py
file modified
+62 -53
ipaserver/plugins/dogtag.py
file modified
+9 -5
ipaserver/plugins/ldap2.py
file modified
+758 -365
ipaserver/plugins/selfsign.py
file modified
+5 -6
ipaserver/rpcserver.py
file modified
+10 -24
make-lint
file modified
+4 -0
make-testcert
file modified
+3 -2
tests/test_cmdline/test_ipagetkeytab.py
file modified
+1 -1
tests/test_install/0_reset.update
file modified
+1 -1
tests/test_install/test_updates.py
file modified
+180 -58
tests/test_ipalib/test_dn.py
file removed
-1085
tests/test_ipalib/test_encoder.py
file removed
-149
tests/test_ipalib/test_x509.py
file modified
+1 -1
tests/test_ipapython/test_dn.py
file added
+1937
tests/test_ipaserver/test_changepw.py
file modified
+2 -4
tests/test_ipaserver/test_ldap.py
file modified
+5 -6
tests/test_xmlrpc/test_attr.py
file modified
+11 -93
tests/test_xmlrpc/test_automember_plugin.py
file modified
+68 -61
tests/test_xmlrpc/test_automount_plugin.py
file modified
+16 -20
tests/test_xmlrpc/test_batch_plugin.py
file modified
+9 -11
tests/test_xmlrpc/test_cert.py
file modified
+1 -1
tests/test_xmlrpc/test_delegation_plugin.py
file modified
+7 -4
tests/test_xmlrpc/test_dns_plugin.py
file modified
+29 -30
tests/test_xmlrpc/test_group_plugin.py
file modified
+34 -38
tests/test_xmlrpc/test_hbacsvcgroup_plugin.py
file modified
+8 -8
tests/test_xmlrpc/test_host_plugin.py
file modified
+20 -24
tests/test_xmlrpc/test_hostgroup_plugin.py
file modified
+13 -16
tests/test_xmlrpc/test_krbtpolicy.py
file modified
+8 -13
tests/test_xmlrpc/test_nesting.py
file modified
+68 -98
tests/test_xmlrpc/test_netgroup_plugin.py
file modified
+21 -32
tests/test_xmlrpc/test_permission_plugin.py
file modified
+51 -46
tests/test_xmlrpc/test_privilege_plugin.py
file modified
+15 -15
tests/test_xmlrpc/test_range_plugin.py
file modified
+5 -7
tests/test_xmlrpc/test_replace.py
file modified
+7 -10
tests/test_xmlrpc/test_role_plugin.py
file modified
+22 -22
tests/test_xmlrpc/test_selinuxusermap_plugin.py
file modified
+16 -20
tests/test_xmlrpc/test_service_plugin.py
file modified
+18 -20
tests/test_xmlrpc/test_sudocmd_plugin.py
file modified
+9 -13
tests/test_xmlrpc/test_sudocmdgroup_plugin.py
file modified
+41 -61
tests/test_xmlrpc/test_user_plugin.py
file modified
+93 -138
tests/test_xmlrpc/xmlrpc_test.py
file modified
+2 -2
tests/util.py
file modified
+4 -0
    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
    
        
file modified
+7 -7
file modified
+3 -2
file modified
+4 -3
file modified
+6 -9
file modified
+1 -1
file modified
+0 -26
file modified
+4 -1
file modified
+37 -36
file removed
-213
file modified
+18 -1
file modified
+26 -26
file modified
+12 -13
file modified
+5 -1
file modified
+124 -64
file modified
+4 -3
file modified
+27 -7
file modified
+7 -2
file modified
+8 -0
file modified
+9 -0
file modified
+12 -3
file modified
+7 -1
file modified
+4 -1
file modified
+39 -47
file modified
+7 -0
file modified
+2 -1
file modified
+15 -4
file modified
+2 -3
file modified
+18 -8
file modified
+7 -1
file modified
+7 -0
file modified
+16 -0
file modified
+6 -2
file modified
+14 -4
file modified
+2 -1
file modified
+4 -1
file modified
+1 -1
file modified
+1 -8
file modified
+1 -1
ipapython/dn.py ipalib/dn.py
file renamed
+514 -208
file modified
+13 -19
file modified
+2 -2
file modified
+40 -3
file removed
-69
file modified
+2 -4
file modified
+35 -29
file modified
+14 -12
file modified
+21 -21
file modified
+357 -331
file modified
+106 -98
file modified
+14 -12
file modified
+62 -53
file modified
+9 -5
file modified
+758 -365
file modified
+10 -24
file modified
+4 -0
file modified
+3 -2
file modified
+11 -93
file modified
+4 -0