From: "selvanair (Code Review)" Date: Sat, 15 Jun 2024 02:24:52 +0000 References: Reply-To: selva.nair@...277..., arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net, frank@...2641... Message-ID: <5840c33081c0940d5d60533dbdcab60c317d7ff6-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="qo/Y3Bc8cq0="; charset=UTF-8 Subject: [Openvpn-devel] [M] Change in openvpn[master]: Static-challenge concatentation option List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: plaisthos , flichtenheld Cc: openvpn-devel --qo/Y3Bc8cq0= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: flichtenheld, plaisthos. Hello plaisthos, flichtenheld, I'd like you to do a code review. Please visit http://gerrit.openvpn.net/c/openvpn/+/665?usp=3Demail to review the following change. Change subject: Static-challenge concatentation option ...................................................................... Static-challenge concatentation option Extend "--static-challenge" option to take a third argument (=3D0 or 1) to specify that the password and response should be concatenated instead of using the SCRV1 protocol. If unspecified, it defaults to "0" meaning that the SCRV1 protocol should be used. Change-Id: I59a90446bfe73d8856516025a58a6f62cc98ab0d --- M doc/man-sections/client-options.rst M doc/management-notes.txt M src/openvpn/manage.c M src/openvpn/misc.c M src/openvpn/misc.h M src/openvpn/options.c M src/openvpn/ssl.c 7 files changed, 63 insertions(+), 21 deletions(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/65/665/1 diff --git a/doc/man-sections/client-options.rst b/doc/man-sections/client-= options.rst index b75fe5b..ca4ccff 100644 --- a/doc/man-sections/client-options.rst +++ b/doc/man-sections/client-options.rst @@ -541,12 +541,15 @@ Valid syntax: :: - static-challenge text echo + static-challenge text echo [format] The ``text`` challenge text is presented to the user which describes what information is requested. The ``echo`` flag indicates if the user's input should be echoed on the screen. Valid ``echo`` values are - :code:`0` or :code:`1`. + :code:`0` or :code:`1`. The optional ``format`` flag indicates whether + the password and response should be combined using the SCRV1 protocol + (``format`` =3D :code: `0`) or simply concatenated (``format`` =3D :code= : `1`). + :code: `0` is the default. See management-notes.txt in the OpenVPN distribution for a description of the OpenVPN challenge/response protocol. diff --git a/doc/management-notes.txt b/doc/management-notes.txt index b9947fa..f568a36 100644 --- a/doc/management-notes.txt +++ b/doc/management-notes.txt @@ -1320,14 +1320,19 @@ OpenVPN's --static-challenge option is used to provide the challenge text to OpenVPN and indicate whether or not the response -should be echoed. +should be echoed and how the response should be combined with the +password. When credentials are needed and the --static-challenge option is used, the management interface will send: - >PASSWORD:Need 'Auth' username/password SC:, + >PASSWORD:Need 'Auth' username/password SC:, - ECHO: "1" if response should be echoed, "0" to not echo + flags: bitwise OR of ECHO and CONCAT flags + ECHO =3D 1 if response should be echoed, 0 to not echo + FORMAT =3D 1 if response should be concatenated with password + as plain text, 0 if response and password should be + encoded as described below TEXT: challenge text that should be shown to the user to facilitate their response @@ -1342,8 +1347,8 @@ The management interface client in this case should add the static challenge text to the auth dialog followed by a field for the user to -enter a response. Then the management interface client should pack the -password and response together into an encoded password and send: +enter a response. If FORMAT=3D0, the management interface client should +pack the password and response together into an encoded password and send: username "Auth" password "Auth" "SCRV1::" @@ -1354,6 +1359,12 @@ the user. The and/or the can be empty strings. +If FORMAT=3D1, the client should simply concatenate password and response +with no separator and send: + + username "Auth" + password "Auth" "SCRV1:" + (As in all username/password responses described in the "COMMAND -- password and username" section above, the username can be in quotes, and special characters such as double quotes or backslashes must be @@ -1361,10 +1372,15 @@ For example, if user "foo" entered "bar" as the password and 8675309 as the PIN, the following management interface commands should be -issued: +issued if FROMAT =3D 0: username "Auth" foo password "Auth" "SCRV1:YmFy:ODY3NTMwOQ=3D=3D" ("YmFy" is the base 64 encoding of "bar" and "ODY3NTMwOQ=3D=3D" is the base 64 encoding of "8675309".) + +or, if FORMAT =3D 1: + + username "Auth" foo + password "Auth" "bar8675309" diff --git a/src/openvpn/manage.c b/src/openvpn/manage.c index 24f3121..05b5a1a 100644 --- a/src/openvpn/manage.c +++ b/src/openvpn/manage.c @@ -3544,7 +3544,8 @@ if (sc) { buf_printf(&alert_msg, " SC:%d,%s", - BOOL_CAST(flags & GET_USER_PASS_STATIC_CHALLENGE_EC= HO), + BOOL_CAST(flags & GET_USER_PASS_STATIC_CHALLENGE_EC= HO) + |(BOOL_CAST(flags & GET_USER_PASS_STATIC_CHALLENGE_= CONCAT) << 1), sc); } diff --git a/src/openvpn/misc.c b/src/openvpn/misc.c index 598fbae..516b1ed 100644 --- a/src/openvpn/misc.c +++ b/src/openvpn/misc.c @@ -438,17 +438,28 @@ { msg(M_FATAL, "ERROR: could not retrieve static cha= llenge response"); } - if (openvpn_base64_encode(up->password, strlen(up->pas= sword), &pw64) =3D=3D -1 - || openvpn_base64_encode(response, strlen(response= ), &resp64) =3D=3D -1) + if (!(flags & GET_USER_PASS_STATIC_CHALLENGE_CONCAT)) { - msg(M_FATAL, "ERROR: could not base64-encode passw= ord/static_response"); + if (openvpn_base64_encode(up->password, strlen(up-= >password), &pw64) =3D=3D -1 + || openvpn_base64_encode(response, strlen(resp= onse), &resp64) =3D=3D -1) + { + msg(M_FATAL, "ERROR: could not base64-encode p= assword/static_response"); + } + buf_set_write(&packed_resp, (uint8_t *)up->passwor= d, USER_PASS_LEN); + buf_printf(&packed_resp, "SCRV1:%s:%s", pw64, resp= 64); + string_clear(pw64); + free(pw64); + string_clear(resp64); + free(resp64); } - buf_set_write(&packed_resp, (uint8_t *)up->password, U= SER_PASS_LEN); - buf_printf(&packed_resp, "SCRV1:%s:%s", pw64, resp64); - string_clear(pw64); - free(pw64); - string_clear(resp64); - free(resp64); + else + { + if (strlen(up->password) + strlen(response) >=3D U= SER_PASS_LEN) + { + msg(M_FATAL, "ERROR: could not concatenate pas= sword/static_response: string too long"); + } + strncat(up->password, response, USER_PASS_LEN - st= rlen(up->password) - 1); + } } #endif /* ifdef ENABLE_MANAGEMENT */ } diff --git a/src/openvpn/misc.h b/src/openvpn/misc.h index 963f3e6..1e0cb16 100644 --- a/src/openvpn/misc.h +++ b/src/openvpn/misc.h @@ -91,6 +91,7 @@ */ struct static_challenge_info { #define SC_ECHO (1<<0) /* echo response when typed by user */ +#define SC_CONCAT (1<<1) /* concatenate password and response and do no= t base64 endode */ unsigned int flags; const char *challenge_text; @@ -117,6 +118,7 @@ #define GET_USER_PASS_STATIC_CHALLENGE_ECHO (1<<9) /* SCRV1 protocol -- e= cho response */ #define GET_USER_PASS_INLINE_CREDS (1<<10) /* indicates that auth_file is= actually inline creds */ +#define GET_USER_PASS_STATIC_CHALLENGE_CONCAT (1<<11) /* indicates passwo= rd and response should be concatenated */ /** * Retrieves the user credentials from various sources depending on the fl= ags. diff --git a/src/openvpn/options.c b/src/openvpn/options.c index abcde89..270d0c9 100644 --- a/src/openvpn/options.c +++ b/src/openvpn/options.c @@ -518,8 +518,9 @@ " Add domains to DNS domain search list\n" "--auth-retry t : How to handle auth failures. Set t to\n" " none (default), interact, or nointeract.\n" - "--static-challenge t e : Enable static challenge/response protocol us= ing\n" - " challenge text t, with e indicating echo flag (0|1)= \n" + "--static-challenge t e [p]: Enable static challenge/response protocol= using\n" + " challenge text t, with f indicating echo flag (0|1)= \n" + " p indicating SCRV1 protocol or concatenate response= with password (0/1)\n" "--connect-timeout n : when polling possible remote servers to connect= to\n" " in a round-robin fashion, spend no more than n seco= nds\n" " waiting for a response before trying the next serve= r.\n" @@ -7926,7 +7927,7 @@ auth_retry_set(msglevel, p[1]); } #ifdef ENABLE_MANAGEMENT - else if (streq(p[0], "static-challenge") && p[1] && p[2] && !p[3]) + else if (streq(p[0], "static-challenge") && p[1] && p[2] && !p[4]) { VERIFY_PERMISSION(OPT_P_GENERAL); options->sc_info.challenge_text =3D p[1]; @@ -7934,6 +7935,10 @@ { options->sc_info.flags |=3D SC_ECHO; } + if (p[3] && atoi(p[3])) + { + options->sc_info.flags |=3D SC_CONCAT; + } } #endif else if (streq(p[0], "msg-channel") && p[1]) diff --git a/src/openvpn/ssl.c b/src/openvpn/ssl.c index 2054eb4..faf83a9 100644 --- a/src/openvpn/ssl.c +++ b/src/openvpn/ssl.c @@ -312,6 +312,10 @@ { flags |=3D GET_USER_PASS_STATIC_CHALLENGE_ECHO; } + if (sci->flags & SC_CONCAT) + { + flags |=3D GET_USER_PASS_STATIC_CHALLENGE_CONCAT; + } get_user_pass_cr(&auth_user_pass, auth_file, UP_TYPE_AUTH, -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/665?usp=3Demail To unsubscribe, or for help writing mail filters, visit http://gerrit.openv= pn.net/settings Gerrit-Project: openvpn Gerrit-Branch: master Gerrit-Change-Id: I59a90446bfe73d8856516025a58a6f62cc98ab0d Gerrit-Change-Number: 665 Gerrit-PatchSet: 1 Gerrit-Owner: selvanair Gerrit-Reviewer: flichtenheld Gerrit-Reviewer: plaisthos Gerrit-CC: openvpn-devel Gerrit-Attention: plaisthos Gerrit-Attention: flichtenheld Gerrit-MessageType: newchange --qo/Y3Bc8cq0= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is currently required from: flichtenheld, plaisthos.

selvanair would like plaisthos and flichtenheld to review this change.

Vi= ew Change

Static-challenge concatentation option

Extend "--= static-challenge" option to take a third
argument (=3D0 or 1) to sp= ecify that the password and
response should be concatenated instead of u= sing the
SCRV1 protocol. If unspecified, it defaults to "0"meaning that the SCRV1 protocol should be used.

Change-Id: I59a9044= 6bfe73d8856516025a58a6f62cc98ab0d
---
M doc/man-sections/client-optio= ns.rst
M doc/management-notes.txt
M src/openvpn/manage.c
M src/ope= nvpn/misc.c
M src/openvpn/misc.h
M src/openvpn/options.c
M src/ope= nvpn/ssl.c
7 files changed, 63 insertions(+), 21 deletions(-)

=
git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/65/665/1
=
diff --git a/doc/man-sections/client-options.rst b/doc/man-sections/clie=
nt-options.rst
index b75fe5b..ca4ccff 100644
--- a/doc/man-sections/client-options.rst
+++ b/doc/man-s= ections/client-options.rst
@@ -541,12 +541,15 @@
= Valid syntax:
::

- static-challenge text echo
+ static-challenge = text echo [format]

The ``text`` challe= nge text is presented to the user which describes what
i= nformation is requested. The ``echo`` flag indicates if the user's

input should be echoed on the screen. Valid ``echo`` value= s are
- :code:`0` or := code:`1`.
+ :code:`0= ` or :code:`1`. The optional ``format`` flag indicates whether
+ the password and response shou= ld be combined using the SCRV1 protocol
+ (``format`` =3D :code: `0`) or simply concatenated (`= `format`` =3D :code: `1`).
+ :code: `0` is the default.

Se= e management-notes.txt in the OpenVPN distribution for a description of
the OpenVPN challenge/response protocol.
di= ff --git a/doc/management-notes.txt b/doc/management-notes.txt
index b9947fa..f568a36 100644

--- a/doc/management-note= s.txt
+++ b/doc/management-notes.txt
@@ -13= 20,14 +1320,19 @@

OpenVPN's --static= -challenge option is used to provide the
challenge text to= OpenVPN and indicate whether or not the response
-should be echoed.
+should be echoed and how the response should be c= ombined with the
+pas= sword.

When credentials are needed and t= he --static-challenge option is
used, the management inter= face will send:

- >PASSWORD:Need 'Auth' username/password SC:<ECH= O>,<TEXT>
+ = >PASSWORD:Need 'Auth' username/password SC:<flags>,<TE= XT>

+ flags: bitwi= se OR of ECHO and CONCAT flags
+ ECHO =3D 1 if response should be echoed, 0 to not echo<= /span>
+ FORMAT =3D = 1 if response should be concatenated with password
+ as plain text, 0 if respon= se and password should be
+ encoded as described below
TEXT:= challenge text that should be shown to the user to
= facilitate their response

@@ -1342,8 +134= 7,8 @@

The management interface client i= n this case should add the static
challenge text to the au= th dialog followed by a field for the user to
-enter a response. Then the management interface cl= ient should pack the
-p= assword and response together into an encoded password and send:
= +enter a response. If FORMAT=3D= 0, the management interface client should
+pack the password and response together into an encod= ed password and send:

username "A= uth" <username>
password "Auth" &qu= ot;SCRV1:<password_base64>:<response_base64>"
@@ -1354,6 +1359,12 @@

the user. The <password_base= 64> and/or the <response_base64> can be
empty str= ings.

+If FORMAT=3D1, the client should simply concatenate password and respon= se
+with no separator= and send:
++ username "Auth" = <username>
+ p= assword "Auth" "SCRV1:<password><response>"=
+
(= As in all username/password responses described in the "COMMAND --
password and username" section above, the username can b= e in quotes,
and special characters such as double quotes = or backslashes must be
@@ -1361,10 +1372,15 @@

For example, if user "foo" entered "b= ar" as the password and 8675309
as the PIN, the follo= wing management interface commands should be
-issued:
+issued if FROMAT =3D 0:

use= rname "Auth" foo
password "Auth" &qu= ot;SCRV1:YmFy:ODY3NTMwOQ=3D=3D"

(= "YmFy" is the base 64 encoding of "bar" and "ODY3N= TMwOQ=3D=3D" is the
base 64 encoding of "8675= 309".)
+<= br>+or, if FORMAT =3D 1:=
+
+ username "Auth" foo
+ password "Auth" "= ;bar8675309"
diff --git a/src/openvpn/manage.c b/src/o= penvpn/manage.c
index 24f3121..05b5a1a 100644
--- a/src/openvpn/manage.c
+++ b/src/openvpn/manage.c

@@ -3544,7 +3544,8 @@
if (sc)=
{
buf_printf(&alert_msg= , " SC:%d,%s",
+ = BOOL_CAST(flags & GET_USER_PASS_STATIC_CHALLENGE_ECHO)
+ = |(BOOL_CAST(flags & GET_USER_PASS_STATIC_CHALLENGE_CONCAT) << 1)= ,
sc);
}

diff --git a/src/openvpn/misc.c b/src/open= vpn/misc.c
index 598fbae..516b1ed 100644
--= - a/src/openvpn/misc.c
+++ b/src/openvpn/misc.c
<= span>@@ -438,17 +438,28 @@

{ msg(M_FATAL, "ERROR: could not retriev= e static challenge response");
}<= /span>
- if= (openvpn_base64_encode(up->password, strlen(up->password), &pw64= ) =3D=3D -1
- = || openvpn_base64_encode(response, strlen(response), &res= p64) =3D=3D -1)
+ = if (!(flags & GET_USER_PASS_STATIC_CHALLENGE_CONCAT))
{
- msg(M_FATAL, "ERROR: could not= base64-encode password/static_response");
+ if (openvpn_base64_enco= de(up->password, strlen(up->password), &pw64) =3D=3D -1+ |= | openvpn_base64_encode(response, strlen(response), &resp64) =3D=3D -1)=
+ = {
+ = msg(M_FATAL, "ERROR: could not base64-encode password/s= tatic_response");
+ buf_set_write(&packed_resp, (uint8_t *= )up->password, USER_PASS_LEN);
+ buf_printf(&packed_resp, "SC= RV1:%s:%s", pw64, resp64);
+ string_clear(pw64);
+ free(pw64);
+ = string_clear(resp64);
- = buf_set_write(&packed_resp, (uint8_t *)up->password, USER_PASS_LE= N);
- = buf_printf(&packed_resp, "SCRV1:%s:%s", pw64, resp64);
- string= _clear(pw64);
- = free(pw64);
- string_clear(resp64);
- free(resp64);
+ else
+ {

+ if (strl= en(up->password) + strlen(response) >=3D USER_PASS_LEN)

+ {
<= br>+ = msg(M_FATAL, "ERROR: could not concatenate password/static_response: = string too long");
+ }
+ strncat(up->password, response, USER_P= ASS_LEN - strlen(up->password) - 1);
+ }
= }
#endif /* ifdef ENABLE_MANAGEMENT */
= }
diff --git a/src/openvpn/misc.h b/src/openvpn/m= isc.h
index 963f3e6..1e0cb16 100644
--- a/s= rc/openvpn/misc.h
+++ b/src/openvpn/misc.h
= @@ -91,6 +91,7 @@
*/
struct static_chall= enge_info {
#define SC_ECHO (1<<0) /* echo resp= onse when typed by user */
+#define SC_CONCAT (1<<1) /* concatenate password and respon= se and do not base64 endode */
unsigned int flags;

const char *challenge_text;
<= span>@@ -117,6 +118,7 @@

#define GET_USER_PASS_STATIC_CHAL= LENGE_ECHO (1<<9) /* SCRV1 protocol -- echo response */

#define GET_USER_PASS_INLINE_CREDS (1<<10) /*= indicates that auth_file is actually inline creds */
+#define GET_USER_PASS_STATIC_CHALLENGE_CO= NCAT (1<<11) /* indicates password and response should be concatenat= ed */

/**
* Retrieves = the user credentials from various sources depending on the flags.diff --git a/src/openvpn/options.c b/src/openvpn/options.cindex abcde89..270d0c9 100644
--- a/src/openvpn/opti= ons.c
+++ b/src/openvpn/options.c
@@ -518,8= +518,9 @@
" Add domains to DNS = domain search list\n"
"--auth-retry t : How= to handle auth failures. Set t to\n"
" = none (default), interact, or nointeract.\n"
- "--static-challenge t e := Enable static challenge/response protocol using\n"

- " challenge te= xt t, with e indicating echo flag (0|1)\n"
+ "--static-challenge t e [p]: Enable st= atic challenge/response protocol using\n"
+ " challenge text t, wi= th f indicating echo flag (0|1)\n"
+ " p indicating SCRV1 protocol= or concatenate response with password (0/1)\n"
&= quot;--connect-timeout n : when polling possible remote servers to connect = to\n"
" in a round-robin fa= shion, spend no more than n seconds\n"
" = waiting for a response before trying the next server.\n"=
@@ -7926,7 +7927,7 @@
auth_retry_= set(msglevel, p[1]);
}
#ifdef ENABLE_= MANAGEMENT
- else if= (streq(p[0], "static-challenge") && p[1] && p[2]= && !p[3])
+ = else if (streq(p[0], "static-challenge") && p[1] &= & p[2] && !p[4])
{
= VERIFY_PERMISSION(OPT_P_GENERAL);
options->sc= _info.challenge_text =3D p[1];
@@ -7934,6 +7935,10 @@
{
options->sc_info.flag= s |=3D SC_ECHO;
}
+ if (p[3] && atoi(p[3]))
+ {

+ options->sc_info.flags |= =3D SC_CONCAT;
+ = }
}
#endif
el= se if (streq(p[0], "msg-channel") && p[1])
diff --git a/src/openvpn/ssl.c b/src/openvpn/ssl.c
index = 2054eb4..faf83a9 100644
--- a/src/openvpn/ssl.c
<= span>+++ b/src/openvpn/ssl.c
@@ -312,6 +312,10 @@ {
flags |=3D GET_USER_= PASS_STATIC_CHALLENGE_ECHO;
}
+ if (sci->flags & = SC_CONCAT)
+ = {
+ = flags |=3D GET_USER_PASS_STATIC_CHALLENGE_CONCAT;
+ }
g= et_user_pass_cr(&auth_user_pass,
= auth_file,
UP_TYPE_AU= TH,

To view, visit change 665. To unsubscrib= e, or for help writing mail filters, visit settings.

Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I59a90446bfe73d8856516025a58= a6f62cc98ab0d
Gerrit-Change-Number: 665
Gerrit-PatchSet: 1
Gerrit-Owner: selvanair <selva.nair@...1354...= ..>
Gerrit-Reviewer: flichtenheld <frank@...2716...= 1...>
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...= .1227...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-Attention: plaisthos <arne-openvpn@...220...= ..1227...>
Gerrit-Attention: flichtenheld <frank@...2375...= 41...>
Gerrit-MessageType: newchange
--qo/Y3Bc8cq0=--