Fix rehash/c_rehash doc and behavior.
[openssl.git] / doc / apps / rehash.pod
1 =pod
2
3 =for comment
4 Original text by James Westby, contributed under the OpenSSL license.
5
6 =head1 NAME
7
8 c_rehash, rehash - Create symbolic links to files named by the hash values
9
10 =head1 SYNOPSIS
11
12 B<openssl>
13 B<rehash>
14 B<[-old]>
15 B<[-h]>
16 B<[-n]>
17 B<[-v]>
18 [ I<directory>...]
19
20 B<c_rehash>
21 I<flags...>
22
23 =head1 DESCRIPTION
24
25 On some platforms, the OpenSSL B<rehash> command is available as
26 an external script called B<c_rehash>.  They are functionally equivalent,
27 except for minor differences noted below.
28
29 B<rehash> scans directories and calculates a hash value of each
30 C<.pem>, C<.crt>, C<.cer>, or C<.crl>
31 file in the specified directory list and creates symbolic links
32 for each file, where the name of the link is the hash value.
33 (If the platform does not support symbolic links, a copy is made.)
34 This utility is useful as many programs that use OpenSSL require
35 directories to be set up like this in order to find certificates.
36
37 If any directories are named on the command line, then those are
38 processed in turn. If not, then the B<SSL_CERT_DIR> environment variable
39 is consulted; this should be a colon-separated list of directories,
40 like the Unix B<PATH> variable.
41 If that is not set then the default directory (installation-specific
42 but often B</usr/local/ssl/certs>) is processed.
43
44 In order for a directory to be processed, the user must have write
45 permissions on that directory, otherwise an error will be generated.
46
47 The links created are of the form C<HHHHHHHH.D>, where each B<H>
48 is a hexadecimal character and B<D> is a single decimal digit.
49 When processing a directory, B<rehash> will first remove all links
50 that have a name in that syntax, even if they are being used for some
51 other purpose.
52 To skip the removal step, use the B<-n> flag.
53 Hashes for CRL's look similar except the letter B<r> appears after
54 the period, like this: C<HHHHHHHH.rD>.
55
56 Multiple objects may have the same hash; they will be indicated by
57 incrementing the B<D> value. Duplicates are found by comparing the
58 full SHA-1 fingerprint. A warning will be displayed if a duplicate
59 is found.
60
61 A warning will also be displayed if there are files that
62 cannot be parsed as either a certificate or a CRL or if
63 more than one such object appears in the file.
64
65 =head2 Script Configuration
66
67 The B<c_rehash> script
68 uses the B<openssl> program to compute the hashes and
69 fingerprints. If not found in the user's B<PATH>, then set the
70 B<OPENSSL> environment variable to the full pathname.
71 Any program can be used, it will be invoked as follows for either
72 a certificate or CRL:
73
74   $OPENSSL x509 -hash -fingerprint -noout -in FILENAME
75   $OPENSSL crl -hash -fingerprint -noout -in FILENAME
76
77 where B<FILENAME> is the filename. It must output the hash of the
78 file on the first line, and the fingerprint on the second,
79 optionally prefixed with some text and an equals sign.
80
81 =head1 OPTIONS
82
83 =over 4
84
85 =item B<-old>
86
87 Use old-style hashing (MD5, as opposed to SHA-1) for generating
88 links to be used for releases before 1.0.0.
89 Note that current versions will not use the old style.
90
91 =item B<-h>
92
93 Display a brief usage message.
94
95 =item B<-n>
96
97 Do not remove existing links.
98 This is needed when keeping new and old-style links in the same directory.
99
100 =item B<-v>
101
102 Print messages about old links removed and new links created.
103 By default, B<rehash> only lists each directory as it is processed.
104
105 =back
106
107 =head1 ENVIRONMENT
108
109 =over
110
111 =item B<OPENSSL>
112
113 The path to an executable to use to generate hashes and
114 fingerprints (see above).
115
116 =item B<SSL_CERT_DIR>
117
118 Colon separated list of directories to operate on.
119 Ignored if directories are listed on the command line.
120
121 =back
122
123 =head1 SEE ALSO
124
125 L<openssl(1)>,
126 L<crl(1)>.
127 L<x509(1)>.