From: "flichtenheld (Code Review)" Date: Thu, 2 Apr 2026 10:41:47 +0000 References: Reply-To: frank@...2641..., arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net Message-ID: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="Q7t5F2TeOjE="; charset=UTF-8 Subject: [Openvpn-devel] [S] Change in openvpn[master]: doc: Remove some explanations for pre-2.3 configurations List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: plaisthos Cc: openvpn-devel --Q7t5F2TeOjE= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: plaisthos. Hello plaisthos, I'd like you to do a code review. Please visit http://gerrit.openvpn.net/c/openvpn/+/1603?usp=3Demail to review the following change. Change subject: doc: Remove some explanations for pre-2.3 configurations ...................................................................... doc: Remove some explanations for pre-2.3 configurations Just streamline the documentation a bit. Change-Id: Ieaaf3a79642c8f7914f9bfc6762ad601c4f5695b Signed-off-by: Frank Lichtenheld --- M doc/man-sections/generic-options.rst 1 file changed, 7 insertions(+), 19 deletions(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/03/1603/1 diff --git a/doc/man-sections/generic-options.rst b/doc/man-sections/generi= c-options.rst index 8132b48..415b81f 100644 --- a/doc/man-sections/generic-options.rst +++ b/doc/man-sections/generic-options.rst @@ -43,11 +43,11 @@ however complications can result when scripts or restarts are executed after the chroot operation. - Note: The SSL library will probably need /dev/urandom to be available + Note: The SSL library will probably need ``/dev/urandom`` to be available inside the chroot directory ``dir``. This is because SSL libraries occasionally need to collect fresh randomness. Newer linux kernels and s= ome BSDs implement a getrandom() or getentropy() syscall that removes the - need for /dev/urandom to be available. + need for ``/dev/urandom`` to be available. --compat-mode version This option provides a convenient way to alter the defaults of OpenVPN @@ -170,9 +170,7 @@ Note: as soon as OpenVPN has daemonized, it can not ask for usernames, passwords, or key pass phrases anymore. This has certain consequences, namely that using a password-protected private key will fail unless the - ``--askpass`` option is used to tell OpenVPN to ask for the pass phrase - (this requirement is new in v2.3.7, and is a consequence of calling - daemon() before initializing the crypto layer). + ``--askpass`` option is used to tell OpenVPN to ask for the pass phrase. Further, using ``--daemon`` together with ``--auth-user-pass`` (entered on console) and ``--auth-nocache`` will fail as soon as key @@ -330,32 +328,22 @@ OpenVPN releases before v2.3 also supported a ``method`` flag which indicated how OpenVPN should call external commands and scripts. This could be either :code:`execve` or :code:`system`. As of OpenVPN 2.3, this - flag is no longer accepted. In most \*nix environments the execve() - approach has been used without any issues. + flag is no longer accepted. Some directives such as ``--up`` allow options to be passed to the external script. In these cases make sure the script name does not contain any spaces or the configuration parser will choke because it can't determine where the script name ends and script options start. - To run scripts in Windows in earlier OpenVPN versions you needed to - either add a full path to the script interpreter which can parse the - script or use the ``system`` flag to run these scripts. As of OpenVPN - 2.3 it is now a strict requirement to have full path to the script + On Windoes it is a strict requirement to have the full path to the script interpreter when running non-executables files. This is not needed for executable files, such as .exe, .com, .bat or .cmd files. For example, - if you have a Visual Basic script, you must use this syntax now: - - :: + if you have a Visual Basic script, you must use this syntax:: --up 'C:\\Windows\\System32\\wscript.exe C:\\Program\ Files\\OpenVPN\= \config\\my-up-script.vbs' Please note the single quote marks and the escaping of the backslashes - (\\) and the space character. - - The reason the support for the :code:`system` flag was removed is due to - the security implications with shell expansions when executing scripts - via the :code:`system()` call. + (``\\``) and the space character. --setcon context Apply SELinux ``context`` after initialization. This essentially -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/1603?usp=3Demail To unsubscribe, or for help writing mail filters, visit http://gerrit.openv= pn.net/settings?usp=3Demail Gerrit-MessageType: newchange Gerrit-Project: openvpn Gerrit-Branch: master Gerrit-Change-Id: Ieaaf3a79642c8f7914f9bfc6762ad601c4f5695b Gerrit-Change-Number: 1603 Gerrit-PatchSet: 1 Gerrit-Owner: flichtenheld Gerrit-Reviewer: plaisthos Gerrit-CC: openvpn-devel Gerrit-Attention: plaisthos --Q7t5F2TeOjE= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is cur= rently required from: plaisthos.

flichtenheld would like plaisthos to review this change.

V= iew Change

doc: Remove some explanations for pre-2.3 c=
onfigurations

Just streamline the documentation a bit.

Change= -Id: Ieaaf3a79642c8f7914f9bfc6762ad601c4f5695b
Signed-off-by: Frank Lich= tenheld <frank@...2641...>
---
M doc/man-sections/generic-optio= ns.rst
1 file changed, 7 insertions(+), 19 deletions(-)

git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/03/= 1603/1
diff --git a/doc/man-sections/generic-options.rst b/doc/man-=
sections/generic-options.rst
index 8132b48..415b81f 100644<= /span>
--- a/doc/man-sections/generic-options.rst
= +++ b/doc/man-sections/generic-options.rst
@@ -43,11 +43,11= @@
however complications can result when scripts or res= tarts are executed
after the chroot operation.
- Note: The S= SL library will probably need /dev/urandom to be available
+ Note: The SSL library will probabl= y need ``/dev/urandom`` to be available
inside the chroo= t directory ``dir``. This is because SSL libraries
occas= ionally need to collect fresh randomness. Newer linux kernels and some
BSDs implement a getrandom() or getentropy() syscall that re= moves the
- need for /= dev/urandom to be available.
+ need for ``/dev/urandom`` to be available.

--compat-mode version
This option provides= a convenient way to alter the defaults of OpenVPN
@@ -170,= 9 +170,7 @@
Note: as soon as OpenVPN has daemonized, it = can not ask for usernames,
passwords, or key pass phrase= s anymore. This has certain consequences,
namely that us= ing a password-protected private key will fail unless the
- ``--askpass`` option is used to tell = OpenVPN to ask for the pass phrase
- (this requirement is new in v2.3.7, and is a consequence of = calling
- daemon() bef= ore initializing the crypto layer).
+ ``--askpass`` option is used to tell OpenVPN to ask for t= he pass phrase.

Further, using ``--dae= mon`` together with ``--auth-user-pass`` (entered
on con= sole) and ``--auth-nocache`` will fail as soon as key
@@ -3= 30,32 +328,22 @@
OpenVPN releases before v2.3 also suppo= rted a ``method`` flag which
indicated how OpenVPN shoul= d call external commands and scripts. This
could be eith= er :code:`execve` or :code:`system`. As of OpenVPN 2.3, this
- flag is no longer accepted. In mos= t \*nix environments the execve()

- approach has been used without any issues.
+ flag is no longer accepted.
Some directives such as ``--up`` allow options= to be passed to the
external script. In these cases mak= e sure the script name does not
contain any spaces or th= e configuration parser will choke because it
can't d= etermine where the script name ends and script options start.

- To run scripts = in Windows in earlier OpenVPN versions you needed to
- either add a full path to the script inte= rpreter which can parse the
- script or use the ``system`` flag to run these scripts. As of OpenV= PN
- 2.3 it is now a s= trict requirement to have full path to the script
+ On Windoes it is a strict requirement to ha= ve the full path to the script
interpreter when running = non-executables files. This is not needed for
executable= files, such as .exe, .com, .bat or .cmd files. For example,
- if you have a Visual Basic script,= you must use this syntax now:

-
- ::<= br>+ if you have a Visual Basi= c script, you must use this syntax::

= --up 'C:\\Windows\\System32\\wscript.exe C:\\Program\ Files\\OpenVPN\= \config\\my-up-script.vbs'

Please = note the single quote marks and the escaping of the backslashes
<= span style=3D"color: hsl(0, 100%, 40%);">- (\\) and the space character.
-
- The reason the support for the :code:`sys= tem` flag was removed is due to
- the security implications with shell expansions when executing = scripts
- via the :cod= e:`system()` call.
+ = (``\\``) and the space character.

--set= con context
Apply SELinux ``context`` after initializati= on. This essentially

To view, visit change 1603= . To unsubscribe, or for help writing mail filters, visit settings.

Gerrit-MessageType: newchange
Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: Ieaaf3a79642c8f7914f9bfc6762= ad601c4f5695b
Gerrit-Change-Number: 1603
Gerrit-PatchSet: 1
Gerrit-Owner: flichtenheld <frank@...2723...= .>
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...= .1227...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-Attention: plaisthos <arne-openvpn@...220...= ..1227...>
= --Q7t5F2TeOjE=--