microsoft / microsoft/BotFramework-WebChat
Add docs on randomly-generated user ID
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.8k
- Forks
- 1.6k
- Avg merge
- 22h 58m
- Merged PRs (30d)
- 2
Description
Although our sample encourage best security practices, some users may not aware that disabling/skipping some code would introduce security risks.
In our sample doc, we should specifically point out that "Direct Line enhanced authentication" is highly preferred to mitigate risks.
Some texts we could use:
- Server-side randomly-generated user ID (a.k.a. DL enhanced auth) ensure it is not trivial to have a collision on user ID
- If user ID is not specified, Web Chat currently generate user ID of
r_xxxxx, wherexis a combination of 36 characters (0-9, a-z), with a probability of collision of about 1 in 60M
One of the doc need to be updated: https://github.com/microsoft/BotFramework-WebChat/tree/master/samples/07.advanced-web-chat-apps/b.sso-for-enterprise#threat-model
Probably we need to update multiple of them.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the threat-model section in samples/07.advanced-web-chat-apps/b.sso-for-enterprise. Review whether related sample documentation also needs the security guidance, and consider the issue's proposed wording on Direct Line enhanced authentication, server-side random user IDs, and collision risk complete when it is accurately reflected in the relevant docs.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100