| Message ID | 20210101191221.2308-1-stefan.schantl@ipfire.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | ddns.cgi: Make dealing with auth tokens more user-friendly. | expand |
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@ipfire.org> wrote: > > 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. > > Signed-off-by: Stefan Schantl <stefan.schantl@ipfire.org> > --- > html/cgi-bin/ddns.cgi | 103 +++++++++++++++++++++++++++++++++++++----- > 1 file changed, 91 insertions(+), 12 deletions(-) > > 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'} = ''; > $settings{'DOMAIN'} = ''; > $settings{'LOGIN'} = ''; > $settings{'PASSWORD'} = ''; > +$settings{'TOKEN'} = ''; > $settings{'ENABLED'} = ''; > $settings{'PROXY'} = ''; > $settings{'SERVICE'} = ''; > > $settings{'ACTION'} = ''; > > -# Get supported ddns providers. > -my @providers = &GetProviders(); > +# Get all supported ddns providers. > +my @providers = &GetProviders("all"); > + > +# Get provider which support a token based authentication mechanism. > +my @token_provider = &GetProviders("token-providers"); > > # Hook to regenerate the configuration files, if cgi got called from command line. > if ($ENV{"REMOTE_ADDR"} eq "") { > @@ -189,6 +193,12 @@ if (($settings{'ACTION'} eq $Lang::tr{'add'}) || ($settings{'ACTION'} eq $Lang:: > $settings{'ENABLED'} = 'off'; > } > > + # Check if a token has been provided. > + if($settings{'TOKEN'}) { > + # Assign the token as a password for saving. > + $settings{'PASSWORD'} = $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'}) || ($settings{'ACTION'} eq $Lang:: > # Write out notice to logfile. > &General::log($Lang::tr{'ddns hostname modified'}); > } > - undef $settings{'ID'}; > + # Clear settings hash. > + %settings = ''; > > # Update ddns config file. > &GenerateDDNSConfigFile(); > @@ -307,6 +318,7 @@ if ($settings{'ACTION'} eq $Lang::tr{'edit'}) { > $settings{'WILDCARDS'} = $temp[4]; > $settings{'LOGIN'} = $temp[5]; > $settings{'PASSWORD'} = $temp[6]; > + $settings{'TOKEN'} = $temp[6]; > $settings{'ENABLED'} = $temp[7]; > } > > @@ -334,6 +346,58 @@ if (!$settings{'ACTION'}) { > } > > &Header::openpage($Lang::tr{'dynamic dns'}, 1, ''); > + > +### Java Script ### > +print"<script>\n"; > + > +# Generate Java Script Array which contains the provider that support token. > +my $line = ""; > +$line = join("', '", @token_provider); > + > +print "\t// Array which contains the providers that support token.\n"; > +print "\ttoken_provider = ['$line']\;\n\n"; > + > +print <<END > + // Java Script function to swap the text input fields for > + // username and password or token. > + var update_auth = 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=array.length; > + > + for(var i=0;i<count;i++) { > + if(array[i]===value){ > + return true; > + } > + } > + > + return false; > + } > + > + // JQuery function to call corresponding function when > + // the service provider is changed or the page is loaded for showing/hiding > + // the username/password or token area. > + \$(document).ready(function() { > + \$('#SERVICE').change(update_auth); > + update_auth(); > + }); > + > +</script> > +END > +; > + > &Header::openbigbox('100%', 'left', '', $errormessage); > > # Read file for general ddns settings. > @@ -414,7 +478,7 @@ print <<END > END > ; > # Generate dropdown menu for service selection. > - print"<select size='1' name='SERVICE'>\n"; > + print"<select size='1' name='SERVICE' id='SERVICE'>\n"; > > my $selected; > > @@ -440,11 +504,15 @@ print <<END > <tr> > <td class='base'>$Lang::tr{'enabled'}</td> > <td><input type='checkbox' name='ENABLED' $checked{'ENABLED'}{'on'} /></td> > - <td class='base'>$Lang::tr{'username'}</td> > - <td><input type='text' name='LOGIN' value='$settings{'LOGIN'}' /></td> > + > + <td class='username'>$Lang::tr{'username'}</td> > + <td class='username'><input type='text' name='LOGIN' value='$settings{'LOGIN'}' /></td> > + > + <td class='token' style='display:none'>Token:</td> > + <td class='token' style='display:none'><input type='text' name='TOKEN' value='$settings{'TOKEN'}' /></td> > </tr> > > - <tr> > + <tr class='password'> > <td class='base'></td> > <td></td> > <td class='base'>$Lang::tr{'password'}</td> > @@ -665,8 +733,8 @@ sub GenerateDDNSConfigFile { > > my $use_token = 0; > > - # Check if token based auth is configured. > - if ($username eq "token") { > + # Handle token based auth for various providers. > + if ($provider ~~ @token_provider) { > $use_token = 1; > } > > @@ -707,9 +775,20 @@ sub GenerateDDNSConfigFile { > } > > # Function which generates an array (@providers) which contains the supported providers. > -sub GetProviders { > - # Get supported providers. > - open(PROVIDERS, "/usr/bin/ddns list-providers |"); > +sub GetProviders ($) { > + my ($type) = @_; > + > + # Set default type to get all providers > + $type = $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 |"); > + } > > # Create new array to store the providers. > my @providers = (); > -- > 2.20.1 >
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'} = ''; $settings{'DOMAIN'} = ''; $settings{'LOGIN'} = ''; $settings{'PASSWORD'} = ''; +$settings{'TOKEN'} = ''; $settings{'ENABLED'} = ''; $settings{'PROXY'} = ''; $settings{'SERVICE'} = ''; $settings{'ACTION'} = ''; -# Get supported ddns providers. -my @providers = &GetProviders(); +# Get all supported ddns providers. +my @providers = &GetProviders("all"); + +# Get provider which support a token based authentication mechanism. +my @token_provider = &GetProviders("token-providers"); # Hook to regenerate the configuration files, if cgi got called from command line. if ($ENV{"REMOTE_ADDR"} eq "") { @@ -189,6 +193,12 @@ if (($settings{'ACTION'} eq $Lang::tr{'add'}) || ($settings{'ACTION'} eq $Lang:: $settings{'ENABLED'} = 'off'; } + # Check if a token has been provided. + if($settings{'TOKEN'}) { + # Assign the token as a password for saving. + $settings{'PASSWORD'} = $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'}) || ($settings{'ACTION'} eq $Lang:: # Write out notice to logfile. &General::log($Lang::tr{'ddns hostname modified'}); } - undef $settings{'ID'}; + # Clear settings hash. + %settings = ''; # Update ddns config file. &GenerateDDNSConfigFile(); @@ -307,6 +318,7 @@ if ($settings{'ACTION'} eq $Lang::tr{'edit'}) { $settings{'WILDCARDS'} = $temp[4]; $settings{'LOGIN'} = $temp[5]; $settings{'PASSWORD'} = $temp[6]; + $settings{'TOKEN'} = $temp[6]; $settings{'ENABLED'} = $temp[7]; } @@ -334,6 +346,58 @@ if (!$settings{'ACTION'}) { } &Header::openpage($Lang::tr{'dynamic dns'}, 1, ''); + +### Java Script ### +print"<script>\n"; + +# Generate Java Script Array which contains the provider that support token. +my $line = ""; +$line = join("', '", @token_provider); + +print "\t// Array which contains the providers that support token.\n"; +print "\ttoken_provider = ['$line']\;\n\n"; + +print <<END + // Java Script function to swap the text input fields for + // username and password or token. + var update_auth = 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=array.length; + + for(var i=0;i<count;i++) { + if(array[i]===value){ + return true; + } + } + + return false; + } + + // JQuery function to call corresponding function when + // the service provider is changed or the page is loaded for showing/hiding + // the username/password or token area. + \$(document).ready(function() { + \$('#SERVICE').change(update_auth); + update_auth(); + }); + +</script> +END +; + &Header::openbigbox('100%', 'left', '', $errormessage); # Read file for general ddns settings. @@ -414,7 +478,7 @@ print <<END END ; # Generate dropdown menu for service selection. - print"<select size='1' name='SERVICE'>\n"; + print"<select size='1' name='SERVICE' id='SERVICE'>\n"; my $selected; @@ -440,11 +504,15 @@ print <<END <tr> <td class='base'>$Lang::tr{'enabled'}</td> <td><input type='checkbox' name='ENABLED' $checked{'ENABLED'}{'on'} /></td> - <td class='base'>$Lang::tr{'username'}</td> - <td><input type='text' name='LOGIN' value='$settings{'LOGIN'}' /></td> + + <td class='username'>$Lang::tr{'username'}</td> + <td class='username'><input type='text' name='LOGIN' value='$settings{'LOGIN'}' /></td> + + <td class='token' style='display:none'>Token:</td> + <td class='token' style='display:none'><input type='text' name='TOKEN' value='$settings{'TOKEN'}' /></td> </tr> - <tr> + <tr class='password'> <td class='base'></td> <td></td> <td class='base'>$Lang::tr{'password'}</td> @@ -665,8 +733,8 @@ sub GenerateDDNSConfigFile { my $use_token = 0; - # Check if token based auth is configured. - if ($username eq "token") { + # Handle token based auth for various providers. + if ($provider ~~ @token_provider) { $use_token = 1; } @@ -707,9 +775,20 @@ sub GenerateDDNSConfigFile { } # Function which generates an array (@providers) which contains the supported providers. -sub GetProviders { - # Get supported providers. - open(PROVIDERS, "/usr/bin/ddns list-providers |"); +sub GetProviders ($) { + my ($type) = @_; + + # Set default type to get all providers + $type = $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 |"); + } # Create new array to store the providers. my @providers = ();
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. Signed-off-by: Stefan Schantl <stefan.schantl@ipfire.org> --- html/cgi-bin/ddns.cgi | 103 +++++++++++++++++++++++++++++++++++++----- 1 file changed, 91 insertions(+), 12 deletions(-)