[X2Go-Commits] [x2goserver] 45/99: X2Go/Server/Agent/NX/Options.pm: document that NUL bytes can only be URL-encoded, but that this not recommended.

[git-admin at x2go.org]

This is an automated email from the git hooks/post-receive script.

x2go pushed a commit to branch master
in repository x2goserver.

commit 2d52f9c7e98bdcb6c01a529d87f12001c8d3bc7a
Author: Mihai Moldovan <ionic at ionic.de>
Date:   Tue Nov 10 08:10:25 2020 +0100

    X2Go/Server/Agent/NX/Options.pm: document that NUL bytes can only be URL-encoded, but that this not recommended.
---
 X2Go/Server/Agent/NX/Options.pm | 15 +++++++++++++++
 debian/changelog                |  2 ++
 2 files changed, 17 insertions(+)

diff --git a/X2Go/Server/Agent/NX/Options.pm b/X2Go/Server/Agent/NX/Options.pm
index 56b28297..ee0d8b0a 100644
--- a/X2Go/Server/Agent/NX/Options.pm
+++ b/X2Go/Server/Agent/NX/Options.pm
@@ -999,6 +999,21 @@ verbatim without any special meaning.
 
 =item *
 
+Since options strings are typically parsed by C applications, C<NUL> (control)
+characters are prematurely terminating the string and hence cannot be directly
+embedded.
+Indirectly, they can be embedded by URL-encoding them as C<%00>.
+
+There is, however, no guarantee that an application unpacking such a string
+will be able to scan any data after the first embedded C<NUL> character.
+
+It is highly recommended to avoid using embedded C<NUL> characters.
+
+This module will not explicitly scan for them, and, hence, also not issue warnings
+related to those characters.
+
+=item *
+
 There are no provisions (other than the mentioned invalid characters) on the
 content of keys and values.
 
diff --git a/debian/changelog b/debian/changelog
index bc041346..54af6d1a 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -273,6 +273,8 @@ x2goserver (4.1.0.4-0x2go1.2) UNRELEASED; urgency=medium
       compact options strings.
     - x2goserver/lib/x2goupdateoptionsstring: add options terminators to
       example calls.
+    - X2Go/Server/Agent/NX/Options.pm: document that NUL bytes can only be
+      URL-encoded, but that this not recommended.
   * debian/control:
     + Build-depend upon lsb-release for distro version detection.
   * debian/x2goserver.manpages:

--
Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/x2goserver.git