From mboxrd@z Thu Jan  1 00:00:00 1970
From: Michael Tremer <michael.tremer@ipfire.org>
To: development@lists.ipfire.org
Subject:
 Re: [PATCH] ddns.cgi: Make dealing with auth tokens more user-friendly.
Date: Mon, 04 Jan 2021 10:43:50 +0000
Message-ID: <CF7D7D24-AA1F-44E0-9B1C-96531E18A537@ipfire.org>
In-Reply-To: <20210101191221.2308-1-stefan.schantl@ipfire.org>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="===============3025465809665606814=="
List-Id: <development.lists.ipfire.org>

--===============3025465809665606814==
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable

Hello,

Do we have the required functionality in ddns already?

If not, I cannot merge this patch, yet.

-Michael

> On 1 Jan 2021, at 19:12, Stefan Schantl <stefan.schantl(a)ipfire.org> wrote:
>=20
> If a provider supports authentication with a token, now
> the username and password fileds will be swapped by some
> Java Script code in favour of an input field for the token.
>=20
> Signed-off-by: Stefan Schantl <stefan.schantl(a)ipfire.org>
> ---
> html/cgi-bin/ddns.cgi | 103 +++++++++++++++++++++++++++++++++++++-----
> 1 file changed, 91 insertions(+), 12 deletions(-)
>=20
> diff --git a/html/cgi-bin/ddns.cgi b/html/cgi-bin/ddns.cgi
> index 024eaf7f6..6eddb5124 100644
> --- a/html/cgi-bin/ddns.cgi
> +++ b/html/cgi-bin/ddns.cgi
> @@ -59,14 +59,18 @@ $settings{'HOSTNAME'} =3D '';
> $settings{'DOMAIN'} =3D '';
> $settings{'LOGIN'} =3D '';
> $settings{'PASSWORD'} =3D '';
> +$settings{'TOKEN'} =3D '';
> $settings{'ENABLED'} =3D '';
> $settings{'PROXY'} =3D '';
> $settings{'SERVICE'} =3D '';
>=20
> $settings{'ACTION'} =3D '';
>=20
> -# Get supported ddns providers.
> -my @providers =3D &GetProviders();
> +# Get all supported ddns providers.
> +my @providers =3D &GetProviders("all");
> +
> +# Get provider which support a token based authentication mechanism.
> +my @token_provider =3D &GetProviders("token-providers");
>=20
> # Hook to regenerate the configuration files, if cgi got called from comman=
d line.
> if ($ENV{"REMOTE_ADDR"} eq "") {
> @@ -189,6 +193,12 @@ if (($settings{'ACTION'} eq $Lang::tr{'add'}) || ($set=
tings{'ACTION'} eq $Lang::
> 			$settings{'ENABLED'} =3D 'off';
> 		}
>=20
> +		# Check if a token has been provided.
> +		if($settings{'TOKEN'}) {
> +			# Assign the token as a password for saving.
> +			$settings{'PASSWORD'} =3D $settings{'TOKEN'};
> +		}
> +
> 		# Handle adding new accounts.
> 		if ($settings{'ACTION'} eq $Lang::tr{'add'}) {
> 			# Open /var/ipfire/ddns/config for writing.
> @@ -234,7 +244,8 @@ if (($settings{'ACTION'} eq $Lang::tr{'add'}) || ($sett=
ings{'ACTION'} eq $Lang::
> 			# Write out notice to logfile.
> 			&General::log($Lang::tr{'ddns hostname modified'});
> 		}
> -		undef $settings{'ID'};
> +		# Clear settings hash.
> +		%settings =3D '';
>=20
> 		# Update ddns config file.
> 		&GenerateDDNSConfigFile();
> @@ -307,6 +318,7 @@ if ($settings{'ACTION'} eq $Lang::tr{'edit'}) {
> 			$settings{'WILDCARDS'} =3D $temp[4];
> 			$settings{'LOGIN'} =3D $temp[5];
> 			$settings{'PASSWORD'} =3D $temp[6];
> +			$settings{'TOKEN'} =3D $temp[6];
> 			$settings{'ENABLED'} =3D $temp[7];
> 		}
>=20
> @@ -334,6 +346,58 @@ if (!$settings{'ACTION'}) {
> }
>=20
> &Header::openpage($Lang::tr{'dynamic dns'}, 1, '');
> +
> +### Java Script ###
> +print"<script>\n";
> +
> +# Generate Java Script Array which contains the provider that support toke=
n.
> +my $line =3D "";
> +$line =3D join("', '", @token_provider);
> +
> +print "\t// Array which contains the providers that support token.\n";
> +print "\ttoken_provider =3D ['$line']\;\n\n";
> +
> +print <<END
> +	// Java Script function to swap the text input fields for
> +	// username and password or token.
> +	var update_auth =3D function() {
> +		if(inArray(\$('#SERVICE').val(), token_provider)) {
> +			\$('.username').hide();
> +			\$('.password').hide();
> +			\$('.token').show();
> +		} else {
> +			\$('.username').show();
> +			\$('.password').show();
> +			\$('.token').hide();
> +		}
> +	};
> +
> +	// Java Script function to check if a given value is part of
> +	// an array.
> +	function inArray(value,array) {
> +		var count=3Darray.length;
> +
> +		for(var i=3D0;i<count;i++) {
> +			if(array[i]=3D=3D=3Dvalue){
> +				return true;
> +			}
> +		}
> +
> +		return false;
> +	}
> +
> +	// JQuery function to call corresponding function when
> +	// the service provider is changed or the page is loaded for showing/hidi=
ng
> +	// the username/password or token area.
> +	\$(document).ready(function() {
> +		\$('#SERVICE').change(update_auth);
> +			update_auth();
> +	});
> +
> +</script>
> +END
> +;
> +
> &Header::openbigbox('100%', 'left', '', $errormessage);
>=20
> # Read file for general ddns settings.
> @@ -414,7 +478,7 @@ print <<END
> END
> ;
> 		# Generate dropdown menu for service selection.
> -		print"<select size=3D'1' name=3D'SERVICE'>\n";
> +		print"<select size=3D'1' name=3D'SERVICE' id=3D'SERVICE'>\n";
>=20
> 		my $selected;
>=20
> @@ -440,11 +504,15 @@ print <<END
> 	<tr>
> 		<td class=3D'base'>$Lang::tr{'enabled'}</td>
> 		<td><input type=3D'checkbox' name=3D'ENABLED' $checked{'ENABLED'}{'on'} /=
></td>
> -		<td class=3D'base'>$Lang::tr{'username'}</td>
> -		<td><input type=3D'text' name=3D'LOGIN' value=3D'$settings{'LOGIN'}' /><=
/td>
> +
> +		<td class=3D'username'>$Lang::tr{'username'}</td>
> +		<td class=3D'username'><input type=3D'text' name=3D'LOGIN' value=3D'$set=
tings{'LOGIN'}' /></td>
> +
> +		<td class=3D'token' style=3D'display:none'>Token:</td>
> +		<td class=3D'token' style=3D'display:none'><input type=3D'text' name=3D'=
TOKEN' value=3D'$settings{'TOKEN'}' /></td>
> 	</tr>
>=20
> -	<tr>
> +	<tr class=3D'password'>
> 		<td class=3D'base'></td>
> 		<td></td>
> 		<td class=3D'base'>$Lang::tr{'password'}</td>
> @@ -665,8 +733,8 @@ sub GenerateDDNSConfigFile {
>=20
> 		my $use_token =3D 0;
>=20
> -		# Check if token based auth is configured.
> -		if ($username eq "token") {
> +		# Handle token based auth for various providers.
> +		if ($provider ~~ @token_provider) {
> 			$use_token =3D 1;
> 		}
>=20
> @@ -707,9 +775,20 @@ sub GenerateDDNSConfigFile {
> }
>=20
> # Function which generates an array (@providers) which contains the support=
ed providers.
> -sub GetProviders {
> -	# Get supported providers.
> -	open(PROVIDERS, "/usr/bin/ddns list-providers |");
> +sub GetProviders ($) {
> +	my ($type) =3D @_;
> +
> +	# Set default type to get all providers
> +	$type =3D $type ? $type : "all";
> +
> +	# Check if the requested type is "token-providers".
> +	if ($type eq "token-providers") {
> +		# Call ddns util to only get providers which supports token based auth.
> +		open(PROVIDERS, "/usr/bin/ddns list-token-providers |");
> +	} else {
> +		# Get all supported providers.
> +		open(PROVIDERS, "/usr/bin/ddns list-providers |");
> +	}
>=20
> 	# Create new array to store the providers.
> 	my @providers =3D ();
> --=20
> 2.20.1
>=20


--===============3025465809665606814==--