Hi, Some small corrections to the proposed doc below
On Fri, Dec 25, 2020 at 2:28 PM Gert Doering <g...@greenie.muc.de> wrote: > The 'echo' command can be used to signal information to an OpenVPN > GUI driving the openvpn core via management interface. Which commands > exists and their syntax has so far been mostly undocumented. > > Condense the long and good discussion between Selva Nair and > Jonathan K. Bullard into doc/gui-notes.txt (initial draft from > Jonathan, comments from Selva and Arne), with a pointer added > to doc/management-notes.txt. > > See: > > > https://sourceforge.net/p/openvpn/mailman/openvpn-users/thread/CAEsd45T%2Bd6FUJ9Po0KHwtHjfuL9Q2D-poG8yFtY45Qyh%2BtHjkg%40mail.gmail.com/#msg36136236 > > and > > > https://sourceforge.net/p/openvpn/mailman/openvpn-devel/thread/CAKuzo_jPThhvXTJAtzhqVUVOLPW1VGu6h2jQhVsHicY8P2WRqA%40mail.gmail.com/#msg36141193 > > for the details. > > Re-enable logging of 'echo' statements, but only for the particular > class of messages starting with 'echo msg...'. > > Signed-off-by: Gert Doering <g...@greenie.muc.de> > --- > doc/Makefile.am | 2 +- > doc/gui-notes.txt | 363 +++++++++++++++++++++++++++++++++++++++ > doc/management-notes.txt | 10 ++ > src/openvpn/options.c | 15 +- > 4 files changed, 382 insertions(+), 8 deletions(-) > create mode 100644 doc/gui-notes.txt > > diff --git a/doc/Makefile.am b/doc/Makefile.am > index df2f54a3..e411f5f9 100644 > --- a/doc/Makefile.am > +++ b/doc/Makefile.am > @@ -15,7 +15,7 @@ MAINTAINERCLEANFILES = \ > SUBDIRS = doxygen > > dist_doc_DATA = \ > - management-notes.txt > + management-notes.txt gui-notes.txt > > dist_noinst_DATA = \ > README.plugins interactive-service-notes.rst \ > diff --git a/doc/gui-notes.txt b/doc/gui-notes.txt > new file mode 100644 > index 00000000..9715e8f6 > --- /dev/null > +++ b/doc/gui-notes.txt > @@ -0,0 +1,363 @@ > +Management Interface "echo" protocol > + > > +================================================================================ > +THIS IS A PRELIMINARY VERSION OF THIS DOCUMENT. ALL INFORMATION IN IT > +IS SUBJECT TO CHANGE. > > +================================================================================ > + > + > + CONTENTS > + THE OPENVPN --ECHO OPTION > + ENVIRONMENT COMMAND > + MESSSAGE COMMANDS > + PASSWORD COMMANDS > + QUOTING > + COMMMAND DETAILS > + > + > > ...snipped.. > +======= > +QUOTING > +======= > + > + * In a configuration file, the rest of the line is parsed into > +separate arguments and then 'echo' and the arguments are passed, each > +separated by a single space, through the management interface. For > +example: > + > + echo argument1 argument2 > + echo " argument1 argument2" > + > +will be sent through the management interface as > + > + >ECHO:timestamp,argument1,argument2 > + >ECHO:timestamp, argument1, argument2 > Should be >ECHO:timestamp,argument1 argument2 >ECHO:timestamp, argument1 argument2 (Only a comma after timestamp, no commas added between words) + > + * In a command line option, the single argument following "--echo" is > +parsed similarly, so > + > + --echo "argument1 argument2" > Remove quotes to match with example above > + --echo "' argument1 argument2'" > Extra single quotes above are probably not intended. > + > +will be sent through the management interface as > + > + >ECHO:timestamp,argument1,argument2 replace comma after argument1 by space > + >ECHO:timestamp, argument1, argument2 remove comma after argument1 > + > + * In a "push" option in a server configuration file, the single > +option following "push" is parsed similarly, so > + > + push "echo argument1 argument2 argument3 argument4" > + push echo "' argument1 argument2 argument3 argument4'" > The opening quote should move to before echo: push "echo ' argument1 argument2 argument3 argument4'" > +will be sent through the management interface as > + > + >ECHO:timestamp,argument1,argument2,argument3 argument4 > replace commas after first one by space > + >ECHO:timestamp, argument1,argument2 argument3 argument4 > replace comma after argument1 by space .. snipped... > +COMMAND -- msg > +-------------- > + > +Syntax: msg text > + > +The text is appended to any previous text from "msg" or "msg-n" > +commands, and a newline is appended after that. > + > +A trailing newline will be removed from the completed message before > +it is displayed to the user. > + > +The text may include any UTF-8 character except a comma (","), CR > +(0x0D), LF (0x0A), or NUL (0x00). + > +The text may not contain percent ("%") except in "percent encoding" > +sequences. To display a percent sign, use %25. > + > +The text may not contain commas (",") because of constraints imposed > +by OpenVPN. Commas should be encoded using "percent encoding" (URL > +encoding): a '%' character followed by two hexadecimal digits, the > +high- and then low-nibble of the ASCII code for the character to be > +shown. Examples: a comma is encoded as %2C or %2c; a percent sign is > +encoded as %25. Here we could add: Text containing comment characters # and ; must be enclosed in quotes to survive after option parsing by openvpn. > + > +The insertion of line endings (CR, LF) in the text is discouraged > +because it is OS dependent. Instead, use the "msg" command, which > +appends a line ending appropriate for the OS on which the GUI is > +running. > + > + Android: ?????? > + > + Tunnelblick: Planned. > + > + Windows OpenVPN GUI: Planned. > + > +COMMAND -- msg-n > +---------------- > + > +Syntax: msg-n text > + > +The text is appended to any previous text from "msg"" or "msg-n"" > +commands. (Like "msg" except that no newline is appended.) > + > +See "COMMAND -- msg" for details about "text". > + > + Android: ?????? > + > + Tunnelblick: Planned. > + > + Windows OpenVPN GUI: Planned. > + > +COMMAND -- msg-notify > +--------------------- > + > +Syntax: msg-notify title > + > +The text from previous "msg" and/or "msg-n" commands is displayed to > +the user as a notification with title "title" and the previous text is > +forgotten. > + > + Android: ?????? > + > + Tunnelblick: Planned. > + > + Windows OpenVPN GUI: Planned. > + > +Note: The max length that will correctly display as a notification > +message is OS dependent. > + > + > +COMMAND -- msg-window title > +--------------------------- > + > +Syntax: msg-window title > + > +The text from previous "msg" and/or "msg-n" commands is displayed to > +the user in a non-modal popup window with title "title" and the > +previous text is forgotten.. > How the title is displayed is better left to the implementation. Could be set as the window title or as a differently formatted text as the heading of the message, for example. The latter approach is taken in the proposed OpenVPN GUI implementation. + > + Android: ?????? > + > + Tunnelblick: Planned. > + > + Windows OpenVPN GUI: Planned. > + > + > +COMMAND -- save-passwords > +------------------------- > + > +Syntax: save-passwords > + > +The GUI is instructed to allow the user to save usernames, passwords > +and private keys for the configuration. > + > +This command will be effective at startup only if present in the > +configuration file or as a command line option. If pushed from the > +server, saving passwords will be allowed in password prompts only > +after the initial prompt has been shown to the user. > + > +This command typically has the effect of presenting the password > +dialogs to the user with a "save password" checkbox checked. The user > +may still uncheck it during the dialog. > + > + Android: ?????? > + > + Tunnelblick: Planned. Tunnelblick ignores this command. Usernames, > +passwords, and private keys may be saved by default, and this command > +will not override the separate Tunnelblick global or per-configuration > +settings used to disable saving them. > + > + Windows OpenVPN GUI: Supported since release 2.4.1 (GUI version > 11.5.0) > + > + > +COMMAND -- setenv > +----------------- > + > +Syntax: setenv name value > + > +Sets an environment variable that will be available to the scripts run > +by the GUI. > + > +This will set environment variable "OPENVPN_name" to value "value" for > +the scripts run by the GUI. "name" is changed to "OPENVPN_name" to > +prevent overwriting sensitive variables such as PATH. Variables are > +set in the order received, with later values replacing earlier ones > +for the same "name". > + > +Names may include only alphanumeric characters and underscores. A > +"setenv" command with an invalid name will be ignored. > + > + Android: ?????? > + > + Tunnelblick: Planned. > + > + Windows OpenVPN GUI: Planned. When the variables set by "setenv" > +are merged with those for the process environment, the variables set > +by "setenv" are listed first, but any duplicates in the process > +environment are not removed. This means that any variables with the > +same name will have the value of the variable in the process > +environment. > The GUI supports this since v11.12.0 (release 2.4.7) Also, the description above is not correct. In case of duplicate names the one in the setenv list is chosen. The merged list is sorted as required on Windows. The rest looks good to me. Selva
_______________________________________________ Openvpn-devel mailing list Openvpn-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/openvpn-devel
