share/man/man5/moduli.5

   1 .\" $OpenBSD: moduli.5,v 1.3 2001/06/24 18:50:52 provos Exp $
   2 .\"
   3 .\" Copyright 1997, 2000 William Allen Simpson <wsimpson@greendragon.com>
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"      This product includes software designed by William Allen Simpson.
  17 .\" 4. The name of the author may not be used to endorse or promote products
  18 .\"    derived from this software without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  21 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  22 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  23 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  24 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  25 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  29 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd July 28, 1997
  34 .Dt MODULI 5
  35 .Os
  36 .Sh NAME
  37 .Nm moduli
  38 .Nd system moduli file
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 file contains the system-wide Diffie-Hellman prime moduli for the
  43 .Xr photurisd 8
  44 and
  45 .Xr sshd 8
  46 programs.
  47 .Pp
  48 Each line in this file contains the following fields:
  49 .Va Time , Type , Tests , Tries , Size , Generator ,
  50 and
  51 .Va Modulus .
  52 The fields are separated by white space (tab or blank).
  53 .Bl -tag -width indent
  54 .It Va Time Pq Vt yyyymmddhhmmss
  55 Specifies the system time that the line was appended to the file.
  56 The value 00000000000000 means unknown (historic).
  57 .\"The file is sorted in ascending order.
  58 .It Va Type Pq Vt decimal
  59 Specifies the internal structure of the prime modulus.
  60 .Pp
  61 .Bl -tag -width indent -compact
  62 .It 0
  63 unknown;
  64 often learned from peer during protocol operation,
  65 and saved for later analysis.
  66 .It 1
  67 unstructured;
  68 a common large number.
  69 .It 2
  70 safe (p = 2q + 1);
  71 meets basic structural requirements.
  72 .It 3
  73 Schnorr.
  74 .It 4
  75 Sophie-Germaine (q = (p-1)/2);
  76 usually generated in the process of testing safe or strong primes.
  77 .It 5
  78 strong;
  79 useful for RSA public key generation.
  80 .El
  81 .It Xo
  82 .Va Tests Pq Vt decimal
  83 (bit field)
  84 .Xc
  85 Specifies the methods used in checking for primality.
  86 Usually, more than one test is used.
  87 .Pp
  88 .Bl -tag -width indent -compact
  89 .It 0
  90 not tested;
  91 often learned from peer during protocol operation,
  92 and saved for later analysis.
  93 .It 1
  94 composite;
  95 failed one or more tests.
  96 In this case, the highest bit specifies the test that failed.
  97 .It 2
  98 sieve;
  99 checked for division by a range of smaller primes.
 100 .It 4
 101 Miller-Rabin.
 102 .It 8
 103 Jacobi.
 104 .It 16
 105 Elliptic Curve.
 106 .El
 107 .It Va Tries Pq Vt decimal
 108 Depends on the value of the highest valid Test bit,
 109 where the method specified is:
 110 .Pp
 111 .Bl -tag -width indent -compact
 112 .It 0
 113 not tested
 114 (always zero).
 115 .It 1
 116 composite
 117 (irrelevant).
 118 .It 2
 119 sieve;
 120 number of primes sieved.
 121 Commonly on the order of 32,000,000.
 122 .It 4
 123 Miller-Rabin;
 124 number of M-R iterations.
 125 Commonly on the order of 32 to 64.
 126 .It 8
 127 Jacobi;
 128 unknown
 129 (always zero).
 130 .It 16
 131 Elliptic Curve;
 132 unused
 133 (always zero).
 134 .El
 135 .It Va Size Pq Vt decimal
 136 Specifies the number of significant bits.
 137 .It Va Generator Pq Vt "hex string"
 138 Specifies the best generator for a Diffie-Hellman exchange.
 139 0 = unknown or variable,
 140 2, 3, 5, etc.
 141 .It Va Modulus Pq Vt "hex string"
 142 The prime modulus.
 143 .El
 144 .Pp
 145 The file is searched for moduli that meet the appropriate
 146 .Va Time , Size
 147 and
 148 .Va Generator
 149 criteria.
 150 When more than one meet the criteria,
 151 the selection should be weighted toward newer moduli,
 152 without completely disqualifying older moduli.
 153 .Sh FILES
 154 .Bl -tag -width ".Pa /etc/ssh/moduli" -compact
 155 .It Pa /etc/ssh/moduli
 156 .El
 157 .Sh SEE ALSO
 158 .Xr photurisd 8 ,
 159 .Xr sshd 8