secure/usr.bin/openssl/man/c_rehash.1

   1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "C_REHASH 1"
 132 .TH C_REHASH 1 "2017-11-02" "1.0.2m" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 c_rehash \- Create symbolic links to files named by the hash values
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 \&\fBc_rehash\fR
 142 \&\fB[\-old]\fR
 143 \&\fB[\-h]\fR
 144 \&\fB[\-n]\fR
 145 \&\fB[\-v]\fR
 146 [ \fIdirectory\fR...]
 147 .SH "DESCRIPTION"
 148 .IX Header "DESCRIPTION"
 149 \&\fBc_rehash\fR scans directories and calculates a hash value of each
 150 \&\f(CW\*(C`.pem\*(C'\fR, \f(CW\*(C`.crt\*(C'\fR, \f(CW\*(C`.cer\*(C'\fR, or \f(CW\*(C`.crl\*(C'\fR
 151 file in the specified directory list and creates symbolic links
 152 for each file, where the name of the link is the hash value.
 153 (If the platform does not support symbolic links, a copy is made.)
 154 This utility is useful as many programs that use OpenSSL require
 155 directories to be set up like this in order to find certificates.
 156 .PP
 157 If any directories are named on the command line, then those are
 158 processed in turn. If not, then the \fB\s-1SSL_CERT_DIR\s0\fR environment variable
 159 is consulted; this shold be a colon-separated list of directories,
 160 like the Unix \fB\s-1PATH\s0\fR variable.
 161 If that is not set then the default directory (installation-specific
 162 but often \fB/usr/local/ssl/certs\fR) is processed.
 163 .PP
 164 In order for a directory to be processed, the user must have write
 165 permissions on that directory, otherwise it will be skipped.
 166 The links created are of the form \f(CW\*(C`HHHHHHHH.D\*(C'\fR, where each \fBH\fR
 167 is a hexadecimal character and \fBD\fR is a single decimal digit.
 168 When processing a directory, \fBc_rehash\fR will first remove all links
 169 that have a name in that syntax. If you have links in that format
 170 used for other purposes, they will be removed.
 171 To skip the removal step, use the \fB\-n\fR flag.
 172 Hashes for \s-1CRL\s0's look similar except the letter \fBr\fR appears after
 173 the period, like this: \f(CW\*(C`HHHHHHHH.rD\*(C'\fR.
 174 .PP
 175 Multiple objects may have the same hash; they will be indicated by
 176 incrementing the \fBD\fR value. Duplicates are found by comparing the
 177 full \s-1SHA\-1\s0 fingerprint. A warning will be displayed if a duplicate
 178 is found.
 179 .PP
 180 A warning will also be displayed if there are files that
 181 cannot be parsed as either a certificate or a \s-1CRL.\s0
 182 .PP
 183 The program uses the \fBopenssl\fR program to compute the hashes and
 184 fingerprints. If not found in the user's \fB\s-1PATH\s0\fR, then set the
 185 \&\fB\s-1OPENSSL\s0\fR environment variable to the full pathname.
 186 Any program can be used, it will be invoked as follows for either
 187 a certificate or \s-1CRL:\s0
 188 .PP
 189 .Vb 2
 190 \&  $OPENSSL x509 \-hash \-fingerprint \-noout \-in FILENAME
 191 \&  $OPENSSL crl \-hash \-fingerprint \-noout \-in FILENAME
 192 .Ve
 193 .PP
 194 where \fB\s-1FILENAME\s0\fR is the filename. It must output the hash of the
 195 file on the first line, and the fingerprint on the second,
 196 optionally prefixed with some text and an equals sign.
 197 .SH "OPTIONS"
 198 .IX Header "OPTIONS"
 199 .IP "\fB\-old\fR" 4
 200 .IX Item "-old"
 201 Use old-style hashing (\s-1MD5,\s0 as opposed to \s-1SHA\-1\s0) for generating
 202 links for releases before 1.0.0.  Note that current versions will
 203 not use the old style.
 204 .IP "\fB\-h\fR" 4
 205 .IX Item "-h"
 206 Display a brief usage message.
 207 .IP "\fB\-n\fR" 4
 208 .IX Item "-n"
 209 Do not remove existing links.
 210 This is needed when keeping new and old-style links in the same directory.
 211 .IP "\fB\-v\fR" 4
 212 .IX Item "-v"
 213 Print messages about old links removed and new links created.
 214 By default, \fBc_rehash\fR only lists each directory as it is processed.
 215 .SH "ENVIRONMENT"
 216 .IX Header "ENVIRONMENT"
 217 .IP "\fB\s-1OPENSSL\s0\fR" 4
 218 .IX Item "OPENSSL"
 219 The path to an executable to use to generate hashes and
 220 fingerprints (see above).
 221 .IP "\fB\s-1SSL_CERT_DIR\s0\fR" 4
 222 .IX Item "SSL_CERT_DIR"
 223 Colon separated list of directories to operate on.
 224 Ignored if directories are listed on the command line.
 225 .SH "SEE ALSO"
 226 .IX Header "SEE ALSO"
 227 \&\fIopenssl\fR\|(1),
 228 \&\fIcrl\fR\|(1).
 229 \&\fIx509\fR\|(1).