]>
git.ipfire.org Git - people/pmueller/ipfire-2.x.git/blob - html/cgi-bin/ddns.cgi
2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2007-2014 IPFire Team <info@ipfire.org> #
7 # This program is free software: you can redistribute it and/or modify #
8 # it under the terms of the GNU General Public License as published by #
9 # the Free Software Foundation, either version 3 of the License, or #
10 # (at your option) any later version. #
12 # This program is distributed in the hope that it will be useful, #
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of #
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
15 # GNU General Public License for more details. #
17 # You should have received a copy of the GNU General Public License #
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. #
20 ###############################################################################
23 use experimental
'smartmatch';
25 # enable only the following on debugging purpose
27 #use CGI::Carp 'fatalsToBrowser';
29 require '/var/ipfire/general-functions.pl';
30 require "${General::swroot}/lang.pl";
31 require "${General::swroot}/header.pl";
33 #workaround to suppress a warning when a variable is used only once
34 my @dummy = ( ${Header
::table2colour
}, ${Header
::colouryellow
} );
38 my %mainsettings = ();
39 &General
::readhash
("${General::swroot}/main/settings", \
%mainsettings);
40 &General
::readhash
("/srv/web/ipfire/html/themes/ipfire/include/colors.txt", \
%color);
42 # Config file for basic configuration.
43 my $settingsfile = "${General::swroot}/ddns/settings";
45 # Config file to store the configured ddns providers.
46 my $datafile = "${General::swroot}/ddns/config";
48 # Call the ddnsctrl helper binary to perform the update.
49 my @ddnsprog = ("/usr/local/bin/ddnsctrl", "update-all");
52 my $errormessage = '';
54 # DDNS General settings.
55 $settings{'BEHINDROUTER'} = 'RED_IP';
58 $settings{'HOSTNAME'} = '';
59 $settings{'DOMAIN'} = '';
60 $settings{'LOGIN'} = '';
61 $settings{'PASSWORD'} = '';
62 $settings{'TOKEN'} = '';
63 $settings{'ENABLED'} = '';
64 $settings{'PROXY'} = '';
65 $settings{'SERVICE'} = '';
67 $settings{'ACTION'} = '';
69 # Get all supported ddns providers.
70 my @providers = &GetProviders
("all");
72 # Get provider which support a token based authentication mechanism.
73 my @token_provider = &GetProviders
("token-providers");
75 # Hook to regenerate the configuration files, if cgi got called from command line.
76 if ($ENV{"REMOTE_ADDR"} eq "") {
77 &GenerateDDNSConfigFile
();
81 &Header
::showhttpheaders
();
84 &Header
::getcgihash
(\
%settings);
86 # Read configuration file.
87 open(FILE
, "$datafile") or die "Unable to open $datafile.";
92 # Save General Settings.
94 if ($settings{'ACTION'} eq $Lang::tr
{'save'}) {
95 # Open /var/ipfire/ddns/settings for writing.
96 open(FILE
, ">$settingsfile") or die "Unable to open $settingsfile.";
98 # Lock file for writing.
101 # Check if BEHINDROUTER has been configured.
102 if ($settings{'BEHINDROUTER'} ne '') {
103 print FILE
"BEHINDROUTER=$settings{'BEHINDROUTER'}\n";
106 # Close file after writing.
109 # Update ddns config file.
110 &GenerateDDNSConfigFile
();
114 # Toggle enable/disable field. Field is in second position
116 if ($settings{'ACTION'} eq $Lang::tr
{'toggle enable disable'}) {
117 # Open /var/ipfire/ddns/config for writing.
118 open(FILE
, ">$datafile") or die "Unable to open $datafile.";
120 # Lock file for writing.
126 # Read file line by line.
127 foreach my $line (@current) {
131 if ($settings{'ID'} eq $id) {
132 # Splitt lines (splitting element is a single ",") and save values into temp array.
133 @temp = split(/\,/,$line);
135 # Check if we want to toggle ENABLED or WILDCARDS.
136 if ($settings{'ENABLED'} ne '') {
138 print FILE
"$temp[0],$temp[1],$temp[2],$temp[3],$temp[4],$temp[5],$temp[6],$settings{'ENABLED'}\n";
141 # Print unmodified line.
142 print FILE
"$line\n";
148 undef $settings{'ID'};
150 # Close file after writing.
153 # Write out logging notice.
154 &General
::log($Lang::tr
{'ddns hostname modified'});
156 # Update ddns config file.
157 &GenerateDDNSConfigFile
();
161 # Add new accounts, or edit existing ones.
163 if (($settings{'ACTION'} eq $Lang::tr
{'add'}) || ($settings{'ACTION'} eq $Lang::tr
{'update'})) {
164 # Check if a hostname has been given.
165 if ($settings{'HOSTNAME'} eq '') {
166 $errormessage = $Lang::tr
{'hostname not set'};
169 # Check if a valid domainname has been provided.
170 if (!&General
::validdomainname
($settings{'HOSTNAME'})) {
171 $errormessage = $Lang::tr
{'invalid domain name'};
174 # Check if the choosen provider supports token based authentication.
175 if ($settings{'SERVICE'} ~~ @token_provider) {
176 # Check if a token has been given.
177 unless ($settings{'TOKEN'}) {
178 $errormessage = $Lang::tr
{'token not set'};
181 # Automatically set the username to token.
182 $settings{'LOGIN'} = "token";
184 # A provider without token support has been choosen.
186 # Check if a username has been sent.
187 if ($settings{'LOGIN'} eq '') {
188 $errormessage = $Lang::tr
{'username not set'};
191 # Check if a password has been typed in.
192 # freedns.afraid.org does not require this field.
193 if (($settings{'PASSWORD'} eq '') && ($settings{'SERVICE'} ne 'freedns.afraid.org') && ($settings{'SERVICE'} ne 'regfish.com')) {
194 $errormessage = $Lang::tr
{'password not set'};
198 # Go furter if there was no error.
199 if (!$errormessage) {
200 # Splitt hostname field into 2 parts for storrage.
201 my($hostname, $domain) = split(/\./, $settings{'HOSTNAME'}, 2);
203 # Handle enabled checkbox. When the checkbox is selected a "on" will be returned,
204 # if the checkbox is not checked nothing is returned in this case we set the value to "off".
205 if ($settings{'ENABLED'} ne 'on') {
206 $settings{'ENABLED'} = 'off';
209 # Handle token provider.
210 if($settings{'SERVICE'} ~~ @token_provider) {
211 # Clear username and password if they contain values.
212 undef($settings{'LOGIN'});
213 undef($settings{'PASSWORD'});
215 # Assign the token as a password for saving.
216 $settings{'PASSWORD'} = $settings{'TOKEN'};
219 # Handle adding new accounts.
220 if ($settings{'ACTION'} eq $Lang::tr
{'add'}) {
221 # Open /var/ipfire/ddns/config for writing.
222 open(FILE
, ">>$datafile") or die "Unable to open $datafile.";
224 # Lock file for writing.
227 # Add account data to the file.
228 print FILE
"$settings{'SERVICE'},$hostname,$domain,$settings{'PROXY'},$settings{'WILDCARDS'},$settings{'LOGIN'},$settings{'PASSWORD'},$settings{'ENABLED'}\n";
230 # Close file after writing.
233 # Write out notice to logfile.
234 &General
::log($Lang::tr
{'ddns hostname added'});
236 # Handle account edditing.
237 } elsif ($settings{'ACTION'} eq $Lang::tr
{'update'}) {
238 # Open /var/ipfire/ddns/config for writing.
239 open(FILE
, ">$datafile") or die "Unable to open $datafile.";
241 # Lock file for writing.
246 # Read file line by line.
247 foreach my $line (@current) {
248 if ($settings{'ID'} eq $id) {
249 print FILE
"$settings{'SERVICE'},$hostname,$domain,$settings{'PROXY'},$settings{'WILDCARDS'},$settings{'LOGIN'},$settings{'PASSWORD'},$settings{'ENABLED'}\n";
258 # Close file after writing.
261 # Write out notice to logfile.
262 &General
::log($Lang::tr
{'ddns hostname modified'});
264 # Clear settings hash.
267 # Update ddns config file.
268 &GenerateDDNSConfigFile
();
273 # Remove existing accounts.
275 if ($settings{'ACTION'} eq $Lang::tr
{'remove'}) {
276 # Open /var/ipfire/ddns/config for writing.
277 open(FILE
, ">$datafile") or die "Unable to open $datafile.";
279 # Lock file for writing.
284 # Read file line by line.
285 foreach my $line (@current) {
286 # Write back every line, except the one we want to drop
287 # (identified by the ID)
288 unless ($settings{'ID'} eq $id) {
295 undef $settings{'ID'};
297 # Close file after writing.
300 # Write out notice to logfile.
301 &General
::log($Lang::tr
{'ddns hostname removed'});
303 # Update ddns config file.
304 &GenerateDDNSConfigFile
();
308 # Read items for editing.
310 if ($settings{'ACTION'} eq $Lang::tr
{'edit'}) {
314 # Read file line by line.
315 foreach my $line (@current) {
316 if ($settings{'ID'} eq $id) {
320 # Splitt lines (splitting element is a single ",") and save values into temp array.
321 @temp = split(/\,/,$line);
323 # Handle hostname details. Only connect the values with a dott if both are available.
326 if (($temp[1]) && ($temp[2])) {
327 $hostname = "$temp[1].$temp[2]";
329 $hostname = "$temp[1]";
332 $settings{'SERVICE'} = $temp[0];
333 $settings{'HOSTNAME'} = $hostname;
334 $settings{'PROXY'} = $temp[3];
335 $settings{'WILDCARDS'} = $temp[4];
336 $settings{'LOGIN'} = $temp[5];
337 $settings{'PASSWORD'} = $temp[6];
338 $settings{'TOKEN'} = $temp[6];
339 $settings{'ENABLED'} = $temp[7];
346 &GenerateDDNSConfigFile
();
350 # Handle forced updates.
352 if ($settings{'ACTION'} eq $Lang::tr
{'instant update'}) {
353 &General
::system(@ddnsprog) == 0 or die "@ddnsprog failed: $?\n";
357 # Set default values.
359 if (!$settings{'ACTION'}) {
360 $settings{'SERVICE'} = 'dyndns.org';
361 $settings{'ENABLED'} = 'on';
362 $settings{'ID'} = '';
365 &Header
::openpage
($Lang::tr
{'dynamic dns'}, 1, '');
370 # Generate Java Script Array which contains the provider that support token.
372 $line = join("', '", @token_provider);
374 print "\t// Array which contains the providers that support token.\n";
375 print "\ttoken_provider = ['$line']\;\n\n";
378 // Java Script function to swap the text input fields for
379 // username and password or token.
380 var update_auth = function() {
381 if(inArray(\$('#SERVICE').val(), token_provider)) {
382 \$('.username').hide();
383 \$('.password').hide();
386 \$('.username').show();
387 \$('.password').show();
392 // Java Script function to check if a given value is part of
394 function inArray(value,array) {
395 var count=array.length;
397 for(var i=0;i<count;i++) {
398 if(array[i]===value){
406 // JQuery function to call corresponding function when
407 // the service provider is changed or the page is loaded for showing/hiding
408 // the username/password or token area.
409 \$(document).ready(function() {
410 \$('#SERVICE').change(update_auth);
418 &Header
::openbigbox
('100%', 'left', '', $errormessage);
420 # Read file for general ddns settings.
421 &General
::readhash
($settingsfile, \
%settings);
424 $checked{'BEHINDROUTER'}{'RED_IP'} = '';
425 $checked{'BEHINDROUTER'}{'FETCH_IP'} = '';
426 $checked{'BEHINDROUTER'}{$settings{'BEHINDROUTER'}} = "checked='checked'";
428 $checked{'ENABLED'}{'on'} = '';
429 $checked{'ENABLED'}{'off'} = '';
430 $checked{'ENABLED'}{$settings{'ENABLED'}} = "checked='checked'";
432 # Show box for errormessages..
434 &Header
::openbox
('100%', 'left', $Lang::tr
{'error messages'});
435 print "<font class='base'>$errormessage </font>";
439 &Header
::openbox
('100%', 'left', $Lang::tr
{'settings'});
442 # Section for general ddns setup.
444 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
447 <td class='base'>$Lang::tr{'dyn dns source choice'}</td>
450 <td class='base'><input type='radio' name='BEHINDROUTER' value='RED_IP' $checked{'BEHINDROUTER'}{'RED_IP'} />
451 $Lang::tr{'use ipfire red ip'}</td>
454 <td class='base'><input type='radio' name='BEHINDROUTER' value='FETCH_IP' $checked{'BEHINDROUTER'}{'FETCH_IP'} />
455 $Lang::tr{'fetch ip from'}</td>
463 <td align='right' valign='top' class='base'><input type='submit' name='ACTION' value='$Lang::tr{'save'}' /></td>
473 # Section to add or edit an existing entry.
476 my $buttontext = $Lang::tr
{'add'};
478 # Change buttontext and headline if we edit an account.
479 if ($settings{'ACTION'} eq $Lang::tr
{'edit'}) {
480 # Rename button and print headline for updating.
481 $buttontext = $Lang::tr
{'update'};
482 &Header
::openbox
('100%', 'left', $Lang::tr
{'edit an existing host'});
484 # Otherwise use default button text and show headline for adding a new account.
485 &Header
::openbox
('100%', 'left', $Lang::tr
{'add a host'});
489 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
490 <input type='hidden' name='ID' value='$settings{'ID'}' />
493 <td width='25%' class='base'>$Lang::tr{'service'}:</td>
497 # Generate dropdown menu for service selection.
498 print"<select size='1' name='SERVICE' id='SERVICE'>\n";
502 # Loop to print the providerlist.
503 foreach my $provider (@providers) {
504 # Check if the current provider needs to be selected.
505 if ($provider eq $settings{'SERVICE'}) {
506 $selected = 'selected';
511 # Print out the HTML option field.
512 print "<option value=\"$provider\" $selected>$provider</option>\n";
515 print"</select></td>\n";
517 <td width='20%' class='base'>$Lang::tr{'hostname'}:</td>
518 <td width='30%'><input type='text' name='HOSTNAME' value='$settings{'HOSTNAME'}' /></td>
522 <td class='base'>$Lang::tr{'enabled'}</td>
523 <td><input type='checkbox' name='ENABLED' $checked{'ENABLED'}{'on'} /></td>
525 <td class='username'>$Lang::tr{'username'}</td>
526 <td class='username'><input type='text' name='LOGIN' value='$settings{'LOGIN'}' /></td>
528 <td class='token' style='display:none'>$Lang::tr{'token'}</td>
529 <td class='token' style='display:none'><input type='text' name='TOKEN' value='$settings{'TOKEN'}' /></td>
532 <tr class='password'>
533 <td class='base'></td>
535 <td class='base'>$Lang::tr{'password'}</td>
536 <td><input type='password' name='PASSWORD' value='$settings{'PASSWORD'}' /></td>
544 <td width='30%' align='right' class='base'>
545 <input type='hidden' name='ACTION' value='$buttontext'>
546 <input type='submit' name='SUBMIT' value='$buttontext'></td>
555 # Third section, display all created ddns hosts.
556 # Re-open file to get changes.
557 open(FILE
, $datafile) or die "Unable to open $datafile.";
561 # Get IP address of the red interface.
562 my $ip = &General
::GetDyndnsRedIP
();
567 &Header
::openbox
('100%', 'left', $Lang::tr
{'current hosts'});
570 <table width='100%' class='tbl'>
572 <th width='30%' align='center' class='boldbase'><b>$Lang::tr{'service'}</b></th>
573 <th width='50%' align='center' class='boldbase'><b>$Lang::tr{'hostname'}</b></th>
574 <th width='20%' colspan='3' class='boldbase' align='center'><b>$Lang::tr{'action'}</b></th>
578 foreach my $line (@current) {
581 my @temp = split(/\,/,$line);
583 # Handle hostname details. Only connect the values with a dott if both are available.
586 if (($temp[1]) && ($temp[2])) {
587 $hostname="$temp[1].$temp[2]";
589 $hostname="$temp[1]";
592 # Generate value for enable/disable checkbox.
597 if ($temp[7] eq "on") {
599 $gdesc = $Lang::tr
{'click to disable'};
601 # Check if the given hostname is a FQDN before doing a nslookup.
602 if (&General
::validfqdn
($hostname)) {
603 $sync = (&General
::DyndnsServiceSync
($ip,$temp[1], $temp[2]) ?
"<font color='green'>": "<font color='red'>") ;
606 $toggle_enabled = 'off';
608 $sync = "<font color='blue'>";
610 $gdesc = $Lang::tr
{'click to enable'};
611 $toggle_enabled = 'on';
617 if ($settings{'ID'} eq $id) {
618 $col="bgcolor='${Header::colouryellow}'";
619 } elsif (!($temp[0] ~~ @providers)) {
620 $col="bgcolor='#FF4D4D'";
622 $col="bgcolor='$color{'color20'}'";
624 $col="bgcolor='$color{'color22'}'";
627 # Handle hostname details. Only connect the values with a dott if both are available.
630 if (($temp[1]) && ($temp[2])) {
631 $hostname="$temp[1].$temp[2]";
633 $hostname="$temp[1]";
636 # The following HTML Code still is part of the loop.
639 <td align='center' $col><a href='http://$temp[0]'>$temp[0]</a></td>
640 <td align='center' $col>$sync$hostname</td>
642 <td align='center' $col><form method='post' action='$ENV{'SCRIPT_NAME'}'>
643 <input type='hidden' name='ID' value='$id'>
644 <input type='hidden' name='ENABLED' value='$toggle_enabled'>
645 <input type='hidden' name='ACTION' value='$Lang::tr{'toggle enable disable'}' />
646 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc' />
649 <td align='center' $col><form method='post' action='$ENV{'SCRIPT_NAME'}'>
650 <input type='hidden' name='ID' value='$id'>
651 <input type='hidden' name='ACTION' value='$Lang::tr{'edit'}' />
652 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}' />
655 <td align='center' $col><form method='post' action='$ENV{'SCRIPT_NAME'}'>
656 <input type='hidden' name='ID' value='$id'>
657 <input type='hidden' name='ACTION' value='$Lang::tr{'remove'}' />
658 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' alt='$Lang::tr{'remove'}' title='$Lang::tr{'remove'}' />
669 <td class='boldbase'> <b>$Lang::tr{'legend'}: </b></td>
670 <td><img src='/images/on.gif' alt='$Lang::tr{'click to disable'}' /></td>
671 <td class='base'>$Lang::tr{'click to disable'}</td>
672 <td> </td>
673 <td><img src='/images/off.gif' alt='$Lang::tr{'click to enable'}' /></td>
674 <td class='base'>$Lang::tr{'click to enable'}</td>
675 <td> </td>
676 <td><img src='/images/edit.gif' alt='$Lang::tr{'edit'}' /></td>
677 <td class='base'>$Lang::tr{'edit'}</td>
678 <td> </td>
679 <td><img src='/images/delete.gif' alt='$Lang::tr{'remove'}' /></td>
680 <td class='base'>$Lang::tr{'remove'}</td>
681 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
682 <td align='right' width='30%'><input type='submit' name='ACTION' value='$Lang::tr{'instant update'}' /></td>
691 &Header
::closebigbox
();
692 &Header
::closepage
();
694 # Function to generate the required configuration file for the DDNS tool.
695 sub GenerateDDNSConfigFile
{
697 open(SETTINGS
, "<$datafile") or die "Could not open $datafile.";
699 open(FILE
, ">${General::swroot}/ddns/ddns.conf");
701 # Global configuration options.
702 print FILE
"[config]\n";
704 # Check if we guess our IP address by an extranal server.
705 if ($settings{'BEHINDROUTER'} eq "FETCH_IP") {
706 print FILE
"guess_external_ip = true\n";
708 print FILE
"guess_external_ip = false\n";
711 # Use an upstream proxy and generate proxy url.
713 &General
::readhash
("${General::swroot}/proxy/settings", \
%proxysettings);
714 if ($proxysettings{'UPSTREAM_PROXY'}) {
715 my $proxy_string = "http://";
717 if ($proxysettings{'UPSTREAM_USER'} && $proxysettings{'UPSTREAM_PASSWORD'}) {
718 $proxy_string .= "$proxysettings{'UPSTREAM_USER'}:$proxysettings{'UPSTREAM_PASSWORD'}@";
721 $proxy_string .= $proxysettings{'UPSTREAM_PROXY'};
723 print FILE
"proxy = $proxy_string\n";
732 # Generate array based on the line content (seperator is a single or multiple space's)
733 my @settings = split(/,/, $line);
734 my ($provider, $hostname, $domain, $proxy, $wildcards, $username, $password, $enabled) = @settings;
736 # Skip entries if they are not (longer) supported.
737 next unless ($provider ~~ @providers);
739 # Skip disabled entries.
740 next unless ($enabled eq "on");
742 # Handle hostname details. Only connect the values with a dott if both are available.
743 if (($hostname) && ($domain)) {
744 print FILE
"[$hostname.$domain]\n";
746 print FILE
"[$hostname]\n";
749 print FILE
"provider = $provider\n";
753 # Handle token based auth for various providers.
754 if ($provider ~~ @token_provider) {
758 # Handle token auth for freedns.afraid.org and regfish.com.
759 if ($provider ~~ ["freedns.afraid.org", "regfish.com"] && $password eq "") {
761 $password = $username;
763 # Handle keys for nsupdate
764 } elsif (($provider eq "nsupdate") && $username && $password) {
765 print FILE
"key = $username\n";
766 print FILE
"secret = $password\n";
771 # Handle keys for nsupdate.info
772 } elsif (($provider eq "nsupdate.info") && $password) {
773 print FILE
"secret = $password\n";
779 # Write auth details.
781 print FILE
"token = $password\n";
782 } elsif ($username && $password) {
783 print FILE
"username = $username\n";
784 print FILE
"password = $password\n";
794 # Function which generates an array (@providers) which contains the supported providers.
795 sub GetProviders
($) {
798 # Set default type to get all providers
799 $type = $type ?
$type : "all";
801 # Check if the requested type is "token-providers".
802 if ($type eq "token-providers") {
803 # Call ddns util to only get providers which supports token based auth.
804 open(PROVIDERS
, "/usr/bin/ddns list-token-providers |");
806 # Get all supported providers.
807 open(PROVIDERS
, "/usr/bin/ddns list-providers |");
810 # Create new array to store the providers.
813 while (<PROVIDERS
>) {
816 # Remove following newlines.
819 # Add provider to the array.
820 push(@providers, $provider);