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

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