Debian Codegraph @

upstream/debian-unstable/man1/openssl-passphrase-options.1ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OPENSSL-PASSPHRASE-OPTIONS 1SSL"
58 .TH OPENSSL-PASSPHRASE-OPTIONS 1SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 openssl\-passphrase\-options \- Pass phrase options
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 \&\fBopenssl\fR
68 \&\fIcommand\fR
69 [ \fIoptions\fR ... ]
70 [ \fIparameters\fR ... ]
71 .SH DESCRIPTION
72 .IX Header "DESCRIPTION"
73 Several OpenSSL commands accept password arguments, typically using \fB\-passin\fR
74 and \fB\-passout\fR for input and output passwords respectively. These allow
75 the password to be obtained from a variety of sources. Both of these
76 options take a single argument whose format is described below. If no
77 password argument is given and a password is required then the user is
78 prompted to enter one: this will typically be read from the current
79 terminal with echoing turned off.
80 .PP
81 Note that character encoding may be relevant, please see
82 \&\fBpassphrase\-encoding\fR\|(7).
83 .SH OPTIONS
84 .IX Header "OPTIONS"
85 .SS "Pass Phrase Option Arguments"
86 .IX Subsection "Pass Phrase Option Arguments"
87 Pass phrase arguments can be formatted as follows.
88 .IP \fBpass:\fR\fIpassword\fR 4
89 .IX Item "pass:password"
90 The actual password is \fIpassword\fR. Since the password is visible
91 to utilities (like 'ps' under Unix) this form should only be used
92 where security is not important.
93 .IP \fBenv:\fR\fIvar\fR 4
94 .IX Item "env:var"
95 Obtain the password from the environment variable \fIvar\fR. Since
96 the environment of other processes is visible on certain platforms
97 (e.g. ps under certain Unix OSes) this option should be used with caution.
98 .IP \fBfile:\fR\fIpathname\fR 4
99 .IX Item "file:pathname"
100 Reads the password from the specified file \fIpathname\fR, which can be a regular
101 file, device, or named pipe. Only the first line, up to the newline character,
102 is read from the stream.
103 .Sp
104 If the same \fIpathname\fR argument is supplied to both \fB\-passin\fR and \fB\-passout\fR
105 arguments, the first line will be used for the input password, and the next
106 line will be used for the output password.
107 .IP \fBfd:\fR\fInumber\fR 4
108 .IX Item "fd:number"
109 Reads the password from the file descriptor \fInumber\fR. This can be useful for
110 sending data via a pipe, for example. The same line handling as described for
111 \&\fBfile:\fR applies to passwords read from file descriptors.
112 .Sp
113 \&\fBfd:\fR is not supported on Windows.
114 .IP \fBstdin\fR 4
115 .IX Item "stdin"
116 Reads the password from standard input. The same line handling as described for
117 \&\fBfile:\fR applies to passwords read from standard input.
118 .SH COPYRIGHT
119 .IX Header "COPYRIGHT"
120 Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved.
121 .PP
122 Licensed under the Apache License 2.0 (the "License"). You may not use
123 this file except in compliance with the License. You can obtain a copy
124 in the file LICENSE in the source distribution or at
125 <https://www.openssl.org/source/license.html>.