docs: add security note for session management#374
Closed
CryptAm wants to merge 2 commits intophantom:mainfrom
Closed
docs: add security note for session management#374CryptAm wants to merge 2 commits intophantom:mainfrom
CryptAm wants to merge 2 commits intophantom:mainfrom
Conversation
📝 WalkthroughWalkthroughAdded a Security Note section to the embedded provider core README documenting that sessions contain sensitive cryptographic material. The note recommends secure storage practices, access controls, avoiding session data logging, and clearing sessions on logout or security events. Changes
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@packages/embedded-provider-core/README.md`:
- Line 246: Replace the bold inline text "**Security Note**" with a proper
Markdown heading (for example "### Security Note") so it becomes a heading-level
element consistent with the rest of the document; update the README entry that
currently contains the bold text to use the heading syntax and ensure
surrounding spacing/newlines match other headings to resolve the linting
violation.
garlobrian52
left a comment
There was a problem hiding this comment.
Branch protection policy must be fulfilled before merging.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary & Motivation
This PR adds an explicit security warning to the Session Management section of packages/embedded-provider-core/README.md.
Sessions contain sensitive cryptographic material, but this was not previously highlighted in the documentation. The added note helps better understand the security implications and follow best practices when implementing custom storage adapters.
How I Tested These Changes
This is a documentation-only change.
Verified that the added section renders correctly in Markdown and is placed immediately after the Session Management section.
Did you add a changeset?
No.
This PR only updates documentation and does not affect any package behavior, APIs, or interfaces.
Did you update the README files?
Yes.
The relevant README file was updated to include security guidance for session handling.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.