mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-06-12 14:48:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update sysrand documentation (#17676)

Browse Source 
Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
This commit is contained in:
konsumlamm
2021-04-08 19:41:43 +02:00
committed by GitHub
parent 42687457b0
commit 9f0f477552
2 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/lib.rst
View File

@@ -272,18 +272,18 @@ Math libraries
* `random <random.html>`_
Fast and tiny random number generator.
* `sysrand <sysrand.html>`_
Cryptographically secure pseudorandom number generator.
* `rationals <rationals.html>`_
This module implements rational numbers and relevant mathematical operations.
* `stats <stats.html>`_
Statistical analysis
Statistical analysis.
* `sums <sums.html>`_
Accurate summation functions.
* `sysrand <sysrand.html>`_
Cryptographically secure pseudorandom number generator.
Internet Protocols and Support
------------------------------

32
lib/std/sysrand.nim
View File

@@ -12,21 +12,21 @@
## therefore may not be secure.
##
## `std/sysrand` generates random numbers from a secure source provided by the operating system.
## It is also called Cryptographically secure pseudorandom number generator.
## It should be unpredictable enough for cryptographic applications,
## It is a cryptographically secure pseudorandom number generator
## and should be unpredictable enough for cryptographic applications,
## though its exact quality depends on the OS implementation.
##
## | Targets | Implementation|
## | :--- | ----: |
## | Windows | `BCryptGenRandom`_ |
## | Linux | `getrandom`_ |
## | MacOSX | `getentropy`_ |
## | IOS | `SecRandomCopyBytes`_ |
## | OpenBSD | `getentropy openbsd`_ |
## | FreeBSD | `getrandom freebsd`_ |
## | JS(Web Browser) | `getRandomValues`_ |
## | Nodejs | `randomFillSync`_ |
## | Other Unix platforms | `/dev/urandom`_ |
## | Targets | Implementation |
## | :--- | ----: |
## | Windows | `BCryptGenRandom`_ |
## | Linux | `getrandom`_ |
## | MacOSX | `getentropy`_ |
## | iOS | `SecRandomCopyBytes`_ |
## | OpenBSD | `getentropy openbsd`_ |
## | FreeBSD | `getrandom freebsd`_ |
## | JS (Web Browser) | `getRandomValues`_ |
## | Node.js | `randomFillSync`_ |
## | Other Unix platforms | `/dev/urandom`_ |
##
## .. _BCryptGenRandom: https://docs.microsoft.com/en-us/windows/win32/api/bcrypt/nf-bcrypt-bcryptgenrandom
## .. _getrandom: https://man7.org/linux/man-pages/man2/getrandom.2.html
@@ -195,7 +195,7 @@ elif defined(linux):
elif defined(openbsd):
proc getentropy(p: pointer, size: cint): cint {.importc: "getentropy", header: "<unistd.h>".}
# fills a buffer with high-quality entropy,
# Fills a buffer with high-quality entropy,
# which can be used as input for process-context pseudorandom generators like `arc4random`.
# The maximum buffer size permitted is 256 bytes.
@@ -227,7 +227,7 @@ elif defined(ios):
proc secRandomCopyBytes(
rnd: SecRandomRef, count: csize_t, bytes: pointer
): cint {.importc: "SecRandomCopyBytes", header: "<Security/SecRandom.h>".}
): cint {.importc: "SecRandomCopyBytes", header: "<Security/SecRandom.h>".}
## https://developer.apple.com/documentation/security/1399291-secrandomcopybytes
template urandomImpl(result: var int, dest: var openArray[byte]) =
@@ -292,7 +292,7 @@ proc urandom*(dest: var openArray[byte]): bool =
## If the call succeeds, returns `true`.
##
## If `dest` is empty, `urandom` immediately returns success,
## without calling underlying operating system api.
## without calling the underlying operating system API.
##
## .. warning:: The code hasn't been audited by cryptography experts and
## is provided as-is without guarantees. Use at your own risks. For production