258 lines
8.3 KiB
Groff
Executable File
258 lines
8.3 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "OPENSSL-REHASH 1"
|
|
.TH OPENSSL-REHASH 1 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
openssl\-rehash, c_rehash \- Create symbolic links to files named by the hash
|
|
values
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
\&\fBopenssl\fR
|
|
\&\fBrehash\fR
|
|
[\fB\-h\fR]
|
|
[\fB\-help\fR]
|
|
[\fB\-old\fR]
|
|
[\fB\-compat\fR]
|
|
[\fB\-n\fR]
|
|
[\fB\-v\fR]
|
|
[\fIdirectory\fR] ...
|
|
.PP
|
|
\&\fBc_rehash\fR
|
|
[\fB\-h\fR]
|
|
[\fB\-help\fR]
|
|
[\fB\-old\fR]
|
|
[\fB\-n\fR]
|
|
[\fB\-v\fR]
|
|
[\fIdirectory\fR] ...
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
This command is generally equivalent to the external
|
|
script \fBc_rehash\fR,
|
|
except for minor differences noted below.
|
|
.PP
|
|
\&\fBopenssl rehash\fR scans directories and calculates a hash value of
|
|
each \fI.pem\fR, \fI.crt\fR, \fI.cer\fR, or \fI.crl\fR
|
|
file in the specified directory list and creates symbolic links
|
|
for each file, where the name of the link is the hash value.
|
|
(If the platform does not support symbolic links, a copy is made.)
|
|
This command is useful as many programs that use OpenSSL require
|
|
directories to be set up like this in order to find certificates.
|
|
.PP
|
|
If any directories are named on the command line, then those are
|
|
processed in turn. If not, then the \fB\s-1SSL_CERT_DIR\s0\fR environment variable
|
|
is consulted; this should be a colon-separated list of directories,
|
|
like the Unix \fB\s-1PATH\s0\fR variable.
|
|
If that is not set then the default directory (installation-specific
|
|
but often \fI/usr/local/ssl/certs\fR) is processed.
|
|
.PP
|
|
In order for a directory to be processed, the user must have write
|
|
permissions on that directory, otherwise an error will be generated.
|
|
.PP
|
|
The links created are of the form \fI\s-1HHHHHHHH\s0.D\fR, where each \fIH\fR
|
|
is a hexadecimal character and \fID\fR is a single decimal digit.
|
|
When a directory is processed, all links in it that have a name
|
|
in that syntax are first removed, even if they are being used for
|
|
some other purpose.
|
|
To skip the removal step, use the \fB\-n\fR flag.
|
|
Hashes for \s-1CRL\s0's look similar except the letter \fBr\fR appears after
|
|
the period, like this: \fI\s-1HHHHHHHH\s0.\fR\fBr\fR\fID\fR.
|
|
.PP
|
|
Multiple objects may have the same hash; they will be indicated by
|
|
incrementing the \fID\fR value. Duplicates are found by comparing the
|
|
full \s-1SHA\-1\s0 fingerprint. A warning will be displayed if a duplicate
|
|
is found.
|
|
.PP
|
|
A warning will also be displayed if there are files that
|
|
cannot be parsed as either a certificate or a \s-1CRL\s0 or if
|
|
more than one such object appears in the file.
|
|
.SS "Script Configuration"
|
|
.IX Subsection "Script Configuration"
|
|
The \fBc_rehash\fR script
|
|
uses the \fBopenssl\fR program to compute the hashes and
|
|
fingerprints. If not found in the user's \fB\s-1PATH\s0\fR, then set the
|
|
\&\fB\s-1OPENSSL\s0\fR environment variable to the full pathname.
|
|
Any program can be used, it will be invoked as follows for either
|
|
a certificate or \s-1CRL:\s0
|
|
.PP
|
|
.Vb 2
|
|
\& $OPENSSL x509 \-hash \-fingerprint \-noout \-in FILENAME
|
|
\& $OPENSSL crl \-hash \-fingerprint \-noout \-in FILENAME
|
|
.Ve
|
|
.PP
|
|
where \fI\s-1FILENAME\s0\fR is the filename. It must output the hash of the
|
|
file on the first line, and the fingerprint on the second,
|
|
optionally prefixed with some text and an equals sign.
|
|
.SH "OPTIONS"
|
|
.IX Header "OPTIONS"
|
|
.IP "\fB\-help\fR \fB\-h\fR" 4
|
|
.IX Item "-help -h"
|
|
Display a brief usage message.
|
|
.IP "\fB\-old\fR" 4
|
|
.IX Item "-old"
|
|
Use old-style hashing (\s-1MD5\s0, as opposed to \s-1SHA\-1\s0) for generating
|
|
links to be used for releases before 1.0.0.
|
|
Note that current versions will not use the old style.
|
|
.IP "\fB\-n\fR" 4
|
|
.IX Item "-n"
|
|
Do not remove existing links.
|
|
This is needed when keeping new and old-style links in the same directory.
|
|
.IP "\fB\-compat\fR" 4
|
|
.IX Item "-compat"
|
|
Generate links for both old-style (\s-1MD5\s0) and new-style (\s-1SHA1\s0) hashing.
|
|
This allows releases before 1.0.0 to use these links along-side newer
|
|
releases.
|
|
.IP "\fB\-v\fR" 4
|
|
.IX Item "-v"
|
|
Print messages about old links removed and new links created.
|
|
By default, this command only lists each directory as it is processed.
|
|
.SH "ENVIRONMENT"
|
|
.IX Header "ENVIRONMENT"
|
|
.IP "\fB\s-1OPENSSL\s0\fR" 4
|
|
.IX Item "OPENSSL"
|
|
The path to an executable to use to generate hashes and
|
|
fingerprints (see above).
|
|
.IP "\fB\s-1SSL_CERT_DIR\s0\fR" 4
|
|
.IX Item "SSL_CERT_DIR"
|
|
Colon separated list of directories to operate on.
|
|
Ignored if directories are listed on the command line.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIopenssl\fR\|(1),
|
|
\&\fIopenssl\-crl\fR\|(1),
|
|
\&\fIopenssl\-x509\fR\|(1)
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2015\-2019 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|