Skip to content

Commit 9ecaf24

Browse files
klemensncron2
authored andcommitted
Fix tmp-dir documentation
Mention its default (on non-Windows systems), rephrase for brevity, fix grammar, correct the module environment variable name and remove a wrong default mentioned in a related option. Acked-by: Frank Lichtenheld <[email protected]> Message-Id: <[email protected]> URL: https://www.mail-archive.com/[email protected]/msg31514.html Signed-off-by: Gert Doering <[email protected]>
1 parent f563556 commit 9ecaf24

File tree

2 files changed

+8
-11
lines changed

2 files changed

+8
-11
lines changed

doc/man-sections/generic-options.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -454,12 +454,11 @@ which mode OpenVPN is configured as.
454454
independently of network and tunnel issues.
455455

456456
--tmp-dir dir
457-
Specify a directory ``dir`` for temporary files. This directory will be
458-
used by openvpn processes and script to communicate temporary data with
459-
openvpn main process. Note that the directory must be writable by the
460-
OpenVPN process after it has dropped it's root privileges.
457+
Specify a directory ``dir`` for temporary files instead of the default
458+
:code:`TMPDIR` (or "/tmp" if unset). Note that it must be writable by the main
459+
process after it has dropped root privileges.
461460

462-
This directory will be used by in the following cases:
461+
This directory will be used to communicate with scripts and plugins:
463462

464463
* ``--client-connect`` scripts and :code:`OPENVPN_PLUGIN_CLIENT_CONNECT`
465464
plug-in hook to dynamically generate client-specific configuration
@@ -469,7 +468,7 @@ which mode OpenVPN is configured as.
469468

470469
* :code:`OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY` plug-in hooks returns
471470
success/failure via :code:`auth_control_file` when using deferred auth
472-
method and pending authentication via :code:`pending_auth_file`.
471+
method and pending authentication via :code:`auth_pending_file`.
473472

474473
--use-prediction-resistance
475474
Enable prediction resistance on mbed TLS's RNG.

doc/man-sections/script-options.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,9 @@ SCRIPT HOOKS
8787
and password to the first two lines of a temporary file. The filename
8888
will be passed as an argument to ``cmd``, and the file will be
8989
automatically deleted by OpenVPN after the script returns. The location
90-
of the temporary file is controlled by the ``--tmp-dir`` option, and
91-
will default to the current directory if unspecified. For security,
92-
consider setting ``--tmp-dir`` to a volatile storage medium such as
93-
:code:`/dev/shm` (if available) to prevent the username/password file
94-
from touching the hard drive.
90+
of the temporary file is controlled by the ``--tmp-dir`` option. For security,
91+
consider setting it to a volatile storage medium such as :code:`/dev/shm` (if
92+
available) to prevent the username/password file from touching the hard drive.
9593

9694
The script should examine the username and password, returning a success
9795
exit code (:code:`0`) if the client's authentication request is to be

0 commit comments

Comments
 (0)