openssl-passphrase-options.html 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. <?xml version="1.0" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <title>openssl-passphrase-options</title>
  6. <meta http-equiv="content-type" content="text/html; charset=utf-8" />
  7. <link rev="made" href="mailto:root@localhost" />
  8. </head>
  9. <body>
  10. <ul id="index">
  11. <li><a href="#NAME">NAME</a></li>
  12. <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
  13. <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
  14. <li><a href="#OPTIONS">OPTIONS</a>
  15. <ul>
  16. <li><a href="#Pass-Phrase-Option-Arguments">Pass Phrase Option Arguments</a></li>
  17. </ul>
  18. </li>
  19. <li><a href="#COPYRIGHT">COPYRIGHT</a></li>
  20. </ul>
  21. <h1 id="NAME">NAME</h1>
  22. <p>openssl-passphrase-options - Pass phrase options</p>
  23. <h1 id="SYNOPSIS">SYNOPSIS</h1>
  24. <p><b>openssl</b> <i>command</i> [ <i>options</i> ... ] [ <i>parameters</i> ... ]</p>
  25. <h1 id="DESCRIPTION">DESCRIPTION</h1>
  26. <p>Several OpenSSL commands accept password arguments, typically using <b>-passin</b> and <b>-passout</b> for input and output passwords respectively. These allow the password to be obtained from a variety of sources. Both of these options take a single argument whose format is described below. If no password argument is given and a password is required then the user is prompted to enter one: this will typically be read from the current terminal with echoing turned off.</p>
  27. <p>Note that character encoding may be relevant, please see <a href="../man7/passphrase-encoding.html">passphrase-encoding(7)</a>.</p>
  28. <h1 id="OPTIONS">OPTIONS</h1>
  29. <h2 id="Pass-Phrase-Option-Arguments">Pass Phrase Option Arguments</h2>
  30. <p>Pass phrase arguments can be formatted as follows.</p>
  31. <dl>
  32. <dt id="pass:password"><b>pass:</b><i>password</i></dt>
  33. <dd>
  34. <p>The actual password is <i>password</i>. Since the password is visible to utilities (like &#39;ps&#39; under Unix) this form should only be used where security is not important.</p>
  35. </dd>
  36. <dt id="env:var"><b>env:</b><i>var</i></dt>
  37. <dd>
  38. <p>Obtain the password from the environment variable <i>var</i>. Since the environment of other processes is visible on certain platforms (e.g. ps under certain Unix OSes) this option should be used with caution.</p>
  39. </dd>
  40. <dt id="file:pathname"><b>file:</b><i>pathname</i></dt>
  41. <dd>
  42. <p>Reads the password from the specified file <i>pathname</i>, which can be a regular file, device, or named pipe. Only the first line, up to the newline character, is read from the stream.</p>
  43. <p>If the same <i>pathname</i> argument is supplied to both <b>-passin</b> and <b>-passout</b> arguments, the first line will be used for the input password, and the next line will be used for the output password.</p>
  44. </dd>
  45. <dt id="fd:number"><b>fd:</b><i>number</i></dt>
  46. <dd>
  47. <p>Reads the password from the file descriptor <i>number</i>. This can be useful for sending data via a pipe, for example. The same line handling as described for <b>file:</b> applies to passwords read from file descriptors.</p>
  48. <p><b>fd:</b> is not supported on Windows.</p>
  49. </dd>
  50. <dt id="stdin"><b>stdin</b></dt>
  51. <dd>
  52. <p>Reads the password from standard input. The same line handling as described for <b>file:</b> applies to passwords read from standard input.</p>
  53. </dd>
  54. </dl>
  55. <h1 id="COPYRIGHT">COPYRIGHT</h1>
  56. <p>Copyright 2000-2024 The OpenSSL Project Authors. All Rights Reserved.</p>
  57. <p>Licensed under the Apache License 2.0 (the &quot;License&quot;). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <a href="https://www.openssl.org/source/license.html">https://www.openssl.org/source/license.html</a>.</p>
  58. </body>
  59. </html>