xref: /freebsd/crypto/openssl/doc/man1/openssl-passphrase-options.pod (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
1=pod
2
3=head1 NAME
4
5openssl-passphrase-options - Pass phrase options
6
7=head1 SYNOPSIS
8
9B<openssl>
10I<command>
11[ I<options> ... ]
12[ I<parameters> ... ]
13
14=head1 DESCRIPTION
15
16Several OpenSSL commands accept password arguments, typically using B<-passin>
17and B<-passout> for input and output passwords respectively. These allow
18the password to be obtained from a variety of sources. Both of these
19options take a single argument whose format is described below. If no
20password argument is given and a password is required then the user is
21prompted to enter one: this will typically be read from the current
22terminal with echoing turned off.
23
24Note that character encoding may be relevant, please see
25L<passphrase-encoding(7)>.
26
27=head1 OPTIONS
28
29=head2 Pass Phrase Option Arguments
30
31Pass phrase arguments can be formatted as follows.
32
33=over 4
34
35=item B<pass:>I<password>
36
37The actual password is I<password>. Since the password is visible
38to utilities (like 'ps' under Unix) this form should only be used
39where security is not important.
40
41=item B<env:>I<var>
42
43Obtain the password from the environment variable I<var>. Since
44the environment of other processes is visible on certain platforms
45(e.g. ps under certain Unix OSes) this option should be used with caution.
46
47=item B<file:>I<pathname>
48
49The first line of I<pathname> is the password. If the same I<pathname>
50argument is supplied to B<-passin> and B<-passout> arguments then the first
51line will be used for the input password and the next line for the output
52password. I<pathname> need not refer to a regular file: it could for example
53refer to a device or named pipe.
54
55=item B<fd:>I<number>
56
57Read the password from the file descriptor I<number>. This can be used to
58send the data via a pipe for example.
59
60=item B<stdin>
61
62Read the password from standard input.
63
64=back
65
66=head1 COPYRIGHT
67
68Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
69
70Licensed under the Apache License 2.0 (the "License").  You may not use
71this file except in compliance with the License.  You can obtain a copy
72in the file LICENSE in the source distribution or at
73L<https://www.openssl.org/source/license.html>.
74
75=cut
76