Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WSManListener parameter DN should be BaseDN #89

Open
lamawithonel opened this issue Apr 7, 2021 · 0 comments · May be fixed by #106
Open

WSManListener parameter DN should be BaseDN #89

lamawithonel opened this issue Apr 7, 2021 · 0 comments · May be fixed by #106

Comments

@lamawithonel
Copy link

lamawithonel commented Apr 7, 2021

In X.500 parlance, the Distinguished Name (DN) is the fully-qualified object path.1,2 For example, CN=example.com, O=IANA, C=US is a DN. In the WSManListener resource, however, the DN parameter specifies only the path part, O=IANA, C=US, better known as the Base DN.2,3 Misnamed parameters like this create cognitive dissonance and poor usability. The documentation should be updated to note that it references the Base DN, not a DN, and the parameter name should be updated to BaseDN.

On a personal note/to give a real-world example, this has cost me time and frustration. I initially ignored the parameter because of the documentation, but when it didn't work I had to trace the code to find the problem. It's difficult for me to submit patches due to my job's legal requirements, but let me know if you have any questions.

lamawithonel added a commit to lamawithonel/WSManDsc that referenced this issue Oct 4, 2021
In X.500 parlance, a _Distinguished Name_ (_DN_) is a fully-qualified
object path<sup>[1][1],[2][2]</sup>  For example, `CN=example.com,
O=IANA, C=US` is a DN.  Prior to this, however, the `DN` parameter did
not specify the fully-qualified DN, but instead only the path part,
minus the _Common Name_.  In the above example, that would be `O=IANA,
C=US`, were the common name is `CN=example.com`.  This path part is
properly known as the _Base DN_.<sup>[2][2],[3][3]</sup>  Therefore,
this commit updates the documentation for the `DN` parameter with the
appropriate names.

Fixes dsccommunity#89

[1]: https://ldapwiki.com/wiki/Distinguished%20Names
[2]: https://www.novell.com/documentation/extend5/Docs/help/Composer/books/LDAPGlossary.html
[3]: https://ldapwiki.com/wiki/BaseDN
@dan-hughes dan-hughes linked a pull request Sep 18, 2024 that will close this issue
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant