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

Update securityUtility encode docs to escape special characters #7623

Closed
dmuelle opened this issue Oct 9, 2024 · 3 comments · Fixed by #7653
Closed

Update securityUtility encode docs to escape special characters #7623

dmuelle opened this issue Oct 9, 2024 · 3 comments · Fixed by #7653
Assignees
Labels
peer reviewed technical reviewed An SME reviewed and approved the documentation from a technical perspective.
Milestone

Comments

@dmuelle
Copy link
Member

dmuelle commented Oct 9, 2024

The encode doc needs to mention that you must escape special characters in passwords that you want to encode. Currently, we only mention that strings with spaces must be enclosed in quotes.

Because special and escape characters differ by OS, we cant exhaustively list all possible characters. Instead, add a section to the end of the doc to show how to check whether the characters are properly escaped.

In the command prompt, type "echo" followed by the password and see where the output started to differ. That's where we want the user to place the escape character. The following is the example on Ubuntu.

$ **echo pa$$word**
pa683word  <===== OK until "pa"
$ **echo pa\$$word**    <== Added escape after "pa"
pa$    <=== OK until "pa$" 
$ **echo pa\$\$word**    <== Added escape after "pa$" 
pa$$word  <== Yes, this is the password I want securityUtility to encode
@dmuelle dmuelle added this to the 24.0.0.11 milestone Oct 9, 2024
dmuelle added a commit that referenced this issue Oct 9, 2024
dmuelle added a commit that referenced this issue Oct 10, 2024
@dmuelle dmuelle mentioned this issue Oct 10, 2024
@dmuelle dmuelle self-assigned this Oct 11, 2024
@dmuelle dmuelle added the technical reviewed An SME reviewed and approved the documentation from a technical perspective. label Oct 14, 2024
@ramkumar-k-9286
Copy link
Contributor

ramkumar-k-9286 commented Oct 15, 2024

Peer Review

pa$$W0rd -> pa$$Word ( I am not sure if this was a mistake 0 (zero) used instead of o).


pa\$\$W0rd -> pa\$\$Word ( I am not sure if this was a mistake 0 (zero) used instead of o).


Will inserting a space in the code block be better for visual clarity?

dmuelle added a commit that referenced this issue Oct 21, 2024
@dmuelle dmuelle mentioned this issue Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
peer reviewed technical reviewed An SME reviewed and approved the documentation from a technical perspective.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants