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.

Sign up for GitHub

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

Jump to bottom

Add a note about OsRng blocking in early init. #134

Merged
merged 2 commits into from
Feb 27, 2017
Merged

Add a note about OsRng blocking in early init. #134

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
095d278
Add a note about `OsRng` blocking in early init.
tomprince Jan 8, 2017
c3fb2f6
Add some notes.
tomprince Feb 3, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/os.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ use Rng;
/// - iOS: calls SecRandomCopyBytes as /dev/(u)random is sandboxed.
/// - PNaCl: calls into the `nacl-irt-random-0.1` IRT interface.
///
/// This does not block.
/// This usually does not block. On some systems (e.g. FreeBSD, OpenBSD,
/// Max OS X, and modern Linux) this may block very early in the init
/// process, if the CSPRNG has not seeded yet.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be "has not been seeded" or "is not seeded".

In my opinion, a source/reference would be great to back this up and provide further reading.

Overall, this is good info to have in the documentation.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For instance, a link to the PEP metioned in #132 could be useful.

pub struct OsRng(imp::OsRng);

impl OsRng {
Expand Down