inejge / ldap3

A pure-Rust LDAP library using the Tokio stack
Apache License 2.0
220 stars 38 forks source link

Improve LDAP primer #121

Closed chrisridd closed 7 months ago

chrisridd commented 7 months ago

A minor point was added about LDIF, just to avoid readers thinking servers held their databases in that form.

I tried to make it clear that dn is not an attribute. This is a really common misconception and it could surprise callers looking for the DN in the returned attrs.

In the filter section I added a note about other filter types. I also clarified the slightly confusing examples searching for "john.doe" explaining which attributes matched.

I thought it was useful to note that LDAP is asynchronous, so clients can issue multiple operations at once.

I added a small section on controls and extended operations.

Lots of other small little improvements.

chrisridd commented 7 months ago

I'm probably using the wrong markdown syntax for things, please advise.

inejge commented 7 months ago

Thanks a lot for this; believe it or not, it's the first feedback of any kind about the primer since I wrote it. I agree with some of the changes, and disagree with others, but since I'm not a fan of back-and-forth refinement where it's a matter of difference of opinion, I will a) leave the comments on the proposed changes to (mostly) explain disagreements, b) merge the changes in toto, c) revert or fix the parts where I don't think the changes are warranted.

Please note that even in disagreement, I think that all your changes are reasonable. I'm only reluctant to accept them when I think that they widen the scope of the text too far from the basics. There is already too much of that in LDAP land, IMO, and the primer is an experiment in concentrating on the essentials.

The changes may take some time. As you can see, I'm not too prompt in responding to PRs, but I believe the situation will be better in the following days.