WIP: Add support for flags in ldap.dn2str()
#466
Conversation
In C `dn2str()` supports `flags` which works by providing `LDAP_DN_FORMAT_UFN`, `LDAP_DN_FORMAT_AD_CANONICAL`. These symbols do exist in Python, but could not be used ultimately because the Python counterpart was pure Python and did not pass to `dn2str(3)`. Fix python-ldap#257
|
@spaceone hi! |
|
Overall, I think it'll be nice to have the feature. |
|
I agree, getting better DN handling would be nice. |
| @@ -158,15 +158,42 @@ def test_dn2str(self): | |||
| [('dc', 'example', 1)], | |||
| [('dc', 'com', 1)] | |||
| ]), | |||
| 'uid=test\\, 42,ou=Testing,dc=example,dc=com' | |||
| 'uid=test\\2C 42,ou=Testing,dc=example,dc=com' | |||
There was a problem hiding this comment.
API change: I don't find a way to prevent this
There was a problem hiding this comment.
Even though libldap does some DN normalisation, we can't guarantee to our users that the output of dn2str is going to be (character to character) identical. Maybe we should make it explicit that the DN they get from it is always going to be "the same one" but the string representation might evolve without notice? Certainly something that makes them think twice before using it as a dict key, etc.
| ) | ||
| self.assertEqual( | ||
| ldap.dn.dn2str([ | ||
| [('cn', 'äöüÄÖÜß', 4)], | ||
| [('dc', 'example', 1)], | ||
| [('dc', 'com', 1)] | ||
| ]), | ||
| 'cn=äöüÄÖÜß,dc=example,dc=com' | ||
| r'cn=\C3\A4\C3\B6\C3\BC\C3\84\C3\96\C3\9C\C3\9F,dc=example,dc=com' |
There was a problem hiding this comment.
API change: I don't find a way to prevent this
There was a problem hiding this comment.
This is definitely intentional and the old value incorrect, we're telling libldap to treat the value as non-printable (LDAP_AVA_NONPRINTABLE == 0x04) and escape accordingly.
There was a problem hiding this comment.
ah yes, I overlooked that!
There was a problem hiding this comment.
Same vor LDAP_AVA_STRING:
>>> ldap.dn.dn2str([[('cn', 'äöüÄÖÜß', ldap.AVA_BINARY)],[('dc', 'example', 1)],[('dc', 'com', 1)]])
'cn=#C3A4C3B6C3BCC384C396C39CC39F,dc=example,dc=com'
>>> ldap.dn.dn2str([[('cn', 'äöüÄÖÜß', ldap.AVA_NULL)],[('dc', 'example', 1)],[('dc', 'com', 1)]])
'cn=\\C3\\A4\\C3\\B6\\C3\\BC\\C3\\84\\C3\\96\\C3\\9C\\C3\\9F,dc=example,dc=com'
>>> ldap.dn.dn2str([[('cn', 'äöüÄÖÜß', ldap.AVA_STRING)],[('dc', 'example', 1)],[('dc', 'com', 1)]])
'cn=\\C3\\A4\\C3\\B6\\C3\\BC\\C3\\84\\C3\\96\\C3\\9C\\C3\\9F,dc=example,dc=com'
>>> ldap.dn.dn2str([[('cn', 'äöüÄÖÜß', ldap.AVA_NONPRINTABLE)],[('dc', 'example', 1)],[('dc', 'com', 1)]])
'cn=\\C3\\A4\\C3\\B6\\C3\\BC\\C3\\84\\C3\\96\\C3\\9C\\C3\\9F,dc=example,dc=com'| #if not dn: | ||
| # return '' |
There was a problem hiding this comment.
libldap isn't too sure either, but allows it: https://git.openldap.org/openldap/openldap/-/blob/OPENLDAP_REL_ENG_2_6_3/libraries/libldap/getdn.c#L3021-3028
There was a problem hiding this comment.
Unless we want to make the distinction for None and make dn2str(None) is None, might be too much hassle though.
In C
dn2str()supportsflagswhich works by providingLDAP_DN_FORMAT_UFN,LDAP_DN_FORMAT_AD_CANONICAL, ….These symbols do exist in Python, but could not be used ultimately because the Python counterpart was pure Python and did not pass to
dn2str(3).Fix #257