-
Notifications
You must be signed in to change notification settings - Fork 47
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
Labels
peer reviewed
technical reviewed
An SME reviewed and approved the documentation from a technical perspective.
Milestone
Comments
Merged
Merged
dmuelle
added
the
technical reviewed
An SME reviewed and approved the documentation from a technical perspective.
label
Oct 14, 2024
Peer Review
Will inserting a space in the code block be better for visual clarity? |
Merged
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.
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.
The text was updated successfully, but these errors were encountered: