openssl: Adjust manual pages for 1.0.1l.
[dragonfly.git] / secure / usr.bin / openssl / man / c_rehash.1
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
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 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "C_REHASH 1"
127 .TH C_REHASH 1 "2015-01-15" "1.0.1l" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 c_rehash \- Create symbolic links to files named by the hash values
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 \&\fBc_rehash\fR
137 [ \fIdirectory\fR...]
138 .SH "DESCRIPTION"
139 .IX Header "DESCRIPTION"
140 \&\fBc_rehash\fR scans directories and calculates a hash value of each \f(CW\*(C`.pem\*(C'\fR
141 file in the specified directory list and creates symbolic links
142 for each file, where the name of the link is the hash value.
143 This utility is useful as many programs that use OpenSSL require
144 directories to be set up like this in order to find certificates.
145 .PP
146 If any directories are named on the command line, then those are
147 processed in turn. If not, then the \fB\s-1SSL_CERT_DIR\s0\fR environment variable
148 is consulted; this shold be a colon-separated list of directories,
149 like the Unix \fB\s-1PATH\s0\fR variable.
150 If that is not set then the default directory (installation-specific
151 but often \fB/usr/local/ssl/certs\fR) is processed.
152 .PP
153 In order for a directory to be processed, the user must have write
154 permissions on that directory, otherwise it will be skipped.
155 The links created are of the form \f(CW\*(C`HHHHHHHH.D\*(C'\fR, where each \fBH\fR
156 is a hexadecimal character and \fBD\fR is a single decimal digit.
157 When processing a directory, \fBc_rehash\fR will first remove all links
158 that have a name in that syntax. If you have links in that format
159 used for other purposes, they will be removed.
160 Hashes for \s-1CRL\s0's look similar except the letter \fBr\fR appears after
161 the period, like this: \f(CW\*(C`HHHHHHHH.rD\*(C'\fR.
162 .PP
163 Multiple objects may have the same hash; they will be indicated by
164 incrementing the \fBD\fR value. Duplicates are found by comparing the
165 full \s-1SHA\-1\s0 fingerprint. A warning will be displayed if a duplicate
166 is found.
167 .PP
168 A warning will also be displayed if there are \fB.pem\fR files that
169 cannot be parsed as either a certificate or a \s-1CRL\s0.
170 .PP
171 The program uses the \fBopenssl\fR program to compute the hashes and
172 fingerprints. If not found in the user's \fB\s-1PATH\s0\fR, then set the
173 \&\fB\s-1OPENSSL\s0\fR environment variable to the full pathname.
174 Any program can be used, it will be invoked as follows for either
175 a certificate or \s-1CRL:\s0
176 .PP
177 .Vb 2
178 \&  $OPENSSL x509 \-hash \-fingerprint \-noout \-in FFFFFF
179 \&  $OPENSSL crl \-hash \-fingerprint \-noout \-in FFFFFF
180 .Ve
181 .PP
182 where \fB\s-1FFFFFF\s0\fR is the filename. It must output the hash of the
183 file on the first line, and the fingerprint on the second,
184 optionally prefixed with some text and an equals sign.
185 .SH "ENVIRONMENT"
186 .IX Header "ENVIRONMENT"
187 .IP "\fB\s-1OPENSSL\s0\fR" 4
188 .IX Item "OPENSSL"
189 The path to an executable to use to generate hashes and
190 fingerprints (see above).
191 .IP "\fB\s-1SSL_CERT_DIR\s0\fR" 4
192 .IX Item "SSL_CERT_DIR"
193 Colon separated list of directories to operate on.
194 Ignored if directories are listed on the command line.
195 .SH "SEE ALSO"
196 .IX Header "SEE ALSO"
197 \&\fIopenssl\fR\|(1),
198 \&\fIcrl\fR\|(1).
199 \&\fIx509\fR\|(1).