Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@CrockAgile
Copy link
Collaborator

Summary

This PR addresses issue #172 by clarifying the cryptographic security properties of sentence generation methods.

Changes

  • Documentation Updates: Added comprehensive documentation to all sentence generation methods (, , , ) explaining that cryptographic security is the caller's responsibility
  • Security Guidance: Provided clear guidance on when to use secure RNGs vs deterministic RNGs for different use cases
  • API Preservation: Maintained the existing API while adding clarity about security implications

Key Points Clarified

  1. Caller Responsibility: Made it explicit that cryptographic security depends on the RNG implementation provided by the caller
  2. RNG Choice Guidance: Directed users to use secure RNGs like for cryptographic applications
  3. Deterministic Output: Informed users about using seedable RNGs with fixed seeds for testing/reproducibility
  4. Future Considerations: Acknowledged the potential migration to mentioned in the original issue

Impact

This change resolves the ambiguity about whether the library intentionally supports cryptographically secure generation by making it clear that:

  • The library provides the infrastructure for random sentence generation
  • The security properties depend entirely on the RNG choice made by the caller
  • Users have full control over the cryptographic properties through their RNG selection

Closes #172

@coveralls
Copy link

Coverage Status

coverage: 96.85%. remained the same
when pulling 4a4cebc on fix-172-clarify-sentence-generation-security
into 07a1756 on main.

@CrockAgile CrockAgile merged commit bafbee9 into main Jul 13, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

clarify security of sentence generation

2 participants