From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-oi1-x232.google.com (mail-oi1-x232.google.com [IPv6:2607:f8b0:4864:20::232]) by sourceware.org (Postfix) with ESMTPS id 95D40385742B for ; Thu, 14 Jul 2022 10:03:19 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 95D40385742B Received: by mail-oi1-x232.google.com with SMTP id bb16so1743770oib.11 for ; Thu, 14 Jul 2022 03:03:19 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc:content-transfer-encoding; bh=3qFh5UmSNVfWyrW8yp6Nc+UyWfVk3kUmXcnpUe2MrRM=; b=ZiBkXJcALjdtadpb3BPHXNjO3j7uYVnraBm3ZqQfibI7xAhl1peAzvWLFzAiMtYxIi zqxczgcOjOhUgCpjdgOIGGBH9tMp2fx1bL5W45TcFPYV6RO/s75S8REIUr/Kgi8+xBxq j+J9PJqiJit1/S0WRdOXT+CruLRkia/LF5bqZWoaL52/CIpbckV9NFYuvDcQZ9aLOcz/ Og35wZ/gEV4Cwux76Qrf2b+tGM9kpczksD1dC4wFpFKnO3Cn/MVGFO1xDGIa6jA1VgiB wKgf5J+gHtXMbh1Ctadihv0Vi9pgL1LrUMdfa7cTw6BMNCmXKCVd2Iv0kEpZlTB4geMm 0HYA== X-Gm-Message-State: AJIora+FLcckDYwjHyiu/ihK2LW/QvHDiEcwRj8EejzeIlREmyvNmRNr 36JVuyRF8dEMCKnK5QP7TUavWugQ5UB+M3GwJ7o= X-Google-Smtp-Source: AGRyM1vf/7/B5j+116LdwY7uk5qafg5ltVPErp/2YlasRHf961a4wmq9DvtYjnXzHQwimwmBRWz+ZHCg1jHRgLZ0+Uk= X-Received: by 2002:a05:6808:1489:b0:33a:1680:8081 with SMTP id e9-20020a056808148900b0033a16808081mr7186041oiw.164.1657792998889; Thu, 14 Jul 2022 03:03:18 -0700 (PDT) MIME-Version: 1.0 References: <20220713173657.516725-1-adhemerval.zanella@linaro.org> <20220713173657.516725-10-adhemerval.zanella@linaro.org> In-Reply-To: <20220713173657.516725-10-adhemerval.zanella@linaro.org> From: Mark Harris Date: Thu, 14 Jul 2022 03:03:08 -0700 Message-ID: Subject: Re: [PATCH v9 9/9] manual: Add documentation for arc4random functions To: Adhemerval Zanella Cc: libc-alpha@sourceware.org, Florian Weimer Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-Spam-Status: No, score=-10.0 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, FREEMAIL_FROM, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: libc-alpha@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Libc-alpha mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 14 Jul 2022 10:03:21 -0000 Adhemerval Zanella via Libc-alpha wrote: > diff --git a/manual/math.texi b/manual/math.texi > index 477a18b6d1..ab96726e57 100644 > --- a/manual/math.texi > +++ b/manual/math.texi > @@ -1447,6 +1447,7 @@ systems. > * ISO Random:: @code{rand} and friends. > * BSD Random:: @code{random} and friends. > * SVID Random:: @code{drand48} and friends. > +* High Quality Random:: @code{arc4random} and friends. > @end menu > > @node ISO Random > @@ -1985,6 +1986,50 @@ This function is a GNU extension and should not be= used in portable > programs. > @end deftypefun > > +@node High Quality Random > +@subsection High Quality Random Number Functions > + > +This section describes the random number functions provided as a GNU > +extension, based on OpenBSD interfaces. > + > +@Theglibc{} uses kernel entropy obtained either through @code{getrandom} > +or by reading @file{/dev/urandom} to seed and periodically re-seed the > +internal state. A per-thread data pool is used, which allows fast outpu= t > +generation. > + > +Although these functions provide higher random quality than ISO, BSD, an= d > +SVID functions, these still use a Pseudo-Random generator and should not > +be used in cryptographic contexts. > + > +The internal state is cleared and reseed with kernel entropy on @code{fo= rk} s/reseed/reseeded/ > +and @code{_Fork}. It is not cleared for either direct @code{clone} sysc= all s/for either/on either a/ > +or when using @theglibc{} @code{syscall} function. > + > +The prototypes for these functions are in @file{stdlib.h}. > +@pindex stdlib.h > + > +@deftypefun int32_t arc4random (void) s/int32_t/uint32_t/ > +@standards{BSD, stdlib.h} > +@safety{@mtsafe{}@asunsafe{@asucorrupt{}}@acsafe{}} > +This function returns a single 32-bit value in the range of @code{0} to > +@code{2^32=E2=88=921} (inclusive), which is twice the range of @code{ran= d} and > +@code{random}. > +@end deftypefun > + > +@deftypefun void arc4random (void *@var{buffer}, size_t @var{length}) s/arc4random/arc4random_buf/ > +@standards{BSD, stdlib.h} > +@safety{@mtsafe{}@asunsafe{@asucorrupt{}}@acsafe{}} > +This function fills the region @var{buffer} of @var{length} with random = data. s/of @var{length}/of length @var{length} bytes/ > +@end deftypefun > + > +@deftypefun uint32_t arc4random_uniform (uint32_t @var{upper_bound}) > +@standards{BSD, stdlib.h} > +@safety{@mtsafe{}@asunsafe{@asucorrupt{}}@acsafe{}} > +This function returns a single 32-bit value, uniformly distributed but > +less than the @var{upper_bound}. It avoids the @w{modulo bias} when the > +upper bound is not a power of two. > +@end deftypefun > + > @node FP Function Optimizations > @section Is Fast Code or Small Code preferred? > @cindex Optimization > -- > 2.34.1 >