share/man/man9/arc4random.9

   1 .\"     $NetBSD: arc4random.9,v 1.2 2003/04/16 13:35:24 wiz Exp $
   2 .\" $OpenBSD: arc4random.3,v 1.17 2000/12/21 14:07:41 aaron Exp $
   3 .\"
   4 .\" Copyright 1997 Niels Provos <provos@physnet.uni-hamburg.de>
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgement:
  17 .\"      This product includes software developed by Niels Provos.
  18 .\" 4. The name of the author may not be used to endorse or promote products
  19 .\"    derived from this software without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  22 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  23 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  24 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  25 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  26 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 .\"
  32 .\" Manual page, using -mandoc macros
  33 .\"
  34 .Dd April 15, 1997
  35 .Dt ARC4RANDOM 9
  36 .Os
  37 .Sh NAME
  38 .Nm arc4random
  39 .Nd arc4 random number generator
  40 .Sh SYNOPSIS
  41 .In sys/types.h
  42 .In sys/systm.h
  43 .Ft uint32_t
  44 .Fn arc4random "void"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn arc4random
  48 function provides a high quality 32-bit pseudo-random
  49 number very quickly.
  50 .Fn arc4random
  51 seeds itself on a regular basis from the kernel strong random number
  52 subsystem described in
  53 .Xr rnd 4 .
  54 On each call, an ARC4 generator is used to generate a new result.
  55 The
  56 .Fn arc4random
  57 function uses the ARC4 cipher key stream generator,
  58 which uses 8*8 8 bit S-Boxes.
  59 The S-Boxes can be in about (2**1700) states.
  60 .Pp
  61 .Fn arc4random
  62 fits into a middle ground not covered by other subsystems such as
  63 the strong, slow, and resource expensive random
  64 devices described in
  65 .Xr rnd 4
  66 versus the fast but poor quality interfaces such as
  67 .Fn random .
  68 .Sh SEE ALSO
  69 .Xr arc4random 3 ,
  70 .Xr rnd 4
  71 .Sh HISTORY
  72 An algorithm called
  73 .Pa RC4
  74 was designed by RSA Data Security, Inc.
  75 It was considered a trade secret, but not trademarked.
  76 Because it was a trade secret, it obviously could not be patented.
  77 A clone of this was posted anonymously to USENET and confirmed to
  78 be equivalent by several sources who had access to the original cipher.
  79 Because of the trade secret situation, RSA Data Security, Inc. can do
  80 nothing about the release of the ARC4 algorithm.
  81 Since
  82 .Pa RC4
  83 used to be a trade secret, the cipher is now referred to as
  84 .Pa ARC4 .
  85 .Pp
  86 These functions first appeared in
  87 .Ox 2.1 .