crypto/external/bsd/openssh/dist/moduli.5

   1 .\"     $NetBSD: moduli.5,v 1.22 2009/02/16 20:55:22 christos Exp $
   2 .\" $OpenBSD: moduli.5,v 1.7 2003/03/06 20:48:35 jmc Exp $
   3 .\"
   4 .\" Copyright 1997, 2000 William Allen Simpson <wsimpson@greendragon.com>
   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 designed by William Allen Simpson.
  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 February 7, 2005
  35 .Dt MODULI 5
  36 .Os
  37 .Sh NAME
  38 .Nm moduli
  39 .Nd system moduli file
  40 .Sh DESCRIPTION
  41 The
  42 .Pa /etc/moduli
  43 file contains the system-wide Diffie-Hellman prime moduli for
  44 .Xr sshd 8 .
  45 .Pp
  46 Each line in this file contains the following fields:
  47 Time, Type, Tests, Tries, Size, Generator, Modulus.
  48 The fields are separated by white space (tab or blank).
  49 .Pp
  50 .Fa Time : yyyymmddhhmmss .
  51 Specifies the system time that the line was appended to the file.
  52 The value 00000000000000 means unknown (historic).
  53 .\"The file is sorted in ascending order.
  54 .Pp
  55 .Fa Type : decimal .
  56 Specifies the internal structure of the prime modulus.
  57 .Pp
  58 .Bl -tag -width indent -offset indent -compact
  59 .It 0 :
  60 unknown;
  61 often learned from peer during protocol operation,
  62 and saved for later analysis.
  63 .It 1 :
  64 unstructured;
  65 a common large number.
  66 .It 2 :
  67 safe (p = 2q + 1);
  68 meets basic structural requirements.
  69 .It 3 :
  70 Schnorr.
  71 .It 4 :
  72 Sophie-Germaine (q = (p-1)/2);
  73 usually generated in the process of testing safe or strong primes.
  74 .It 5 :
  75 strong;
  76 useful for RSA public key generation.
  77 .El
  78 .Pp
  79 .Fa Tests : decimal (bit field) .
  80 Specifies the methods used in checking for primality.
  81 Usually, more than one test is used.
  82 .Pp
  83 .Bl -tag -width indent -offset indent -compact
  84 .It 0 :
  85 not tested;
  86 often learned from peer during protocol operation,
  87 and saved for later analysis.
  88 .It 1 :
  89 composite;
  90 failed one or more tests.
  91 In this case, the highest bit specifies the test that failed.
  92 .It 2 :
  93 sieve;
  94 checked for division by a range of smaller primes.
  95 .It 4 :
  96 Miller-Rabin.
  97 .It 8 :
  98 Jacobi.
  99 .It 16 :
 100 Elliptic Curve.
 101 .El
 102 .Pp
 103 .Fa Tries : decimal .
 104 Depends on the value of the highest valid Test bit,
 105 where the method specified is:
 106 .Pp
 107 .Bl -tag -width indent -offset indent -compact
 108 .It 0 :
 109 not tested
 110 (always zero).
 111 .It 1 :
 112 composite
 113 (irrelevant).
 114 .It 2 :
 115 sieve;
 116 number of primes sieved.
 117 Commonly on the order of 32,000,000.
 118 .It 4 :
 119 Miller-Rabin;
 120 number of M-R iterations.
 121 Commonly on the order of 32 to 64.
 122 .It 8 :
 123 Jacobi;
 124 unknown
 125 (always zero).
 126 .It 16 :
 127 Elliptic Curve;
 128 unused
 129 (always zero).
 130 .El
 131 .Pp
 132 .Fa Size : decimal .
 133 Specifies the number of the most significant bit (0 to M).
 134 .Pp
 135 .Fa Generator : hex string .
 136 Specifies the best generator for a Diffie-Hellman exchange.
 137 0 = unknown or variable,
 138 2, 3, 5, etc.
 139 .Pp
 140 .Fa Modulus : hex string .
 141 The prime modulus.
 142 .Pp
 143 The file should be searched for moduli that meet the appropriate
 144 Time, Size and Generator criteria.
 145 When more than one meet the criteria,
 146 the selection should be weighted toward newer moduli,
 147 without completely disqualifying older moduli.
 148 .Pp
 149 Note that
 150 .Xr sshd 8
 151 uses only the Size criteria and then selects a modulus at random
 152 if more than one meet the Size criteria.
 153 .Sh FILES
 154 .Bl -tag -width /etc/moduli -compact
 155 .It Pa /etc/moduli
 156 .El
 157 .Sh SEE ALSO
 158 .Xr qsieve 1 ,
 159 .Xr sshd 8
 160 .Sh HISTORY
 161 The
 162 .Nm
 163 file appeared in
 164 .Ox 2.8
 165 and
 166 .Nx 1.6 .