| Path : /scripts/ |
|
|
| Current File : //scripts/migrate-pdns-conf |
#!/usr/local/cpanel/3rdparty/bin/perl
# cpanel - scripts/migrate-pdns-conf
# Copyright 2019 cPanel, L.L.C.
# All rights Reserved.
# copyright@cpanel.net http://cpanel.net
# This code is subject to the cPanel license. Unauthorized copying is prohibited
package scripts::migrate_pdns_conf;
use strict;
use warnings;
use Try::Tiny;
use Pod::Usage ();
use Getopt::Long ();
use Cpanel::LoadFile ();
use Cpanel::Exception ();
use Cpanel::FileUtils::Write ();
use Cpanel::Rand::Get ();
my $CONF_FILE = '/etc/pdns/pdns.conf';
exit( __PACKAGE__->script( \@ARGV ) ) unless caller;
sub script {
my ( $class, $argv ) = @_;
die Cpanel::Exception::create('RootRequired')->to_string_no_id() unless ( $> == 0 && $< == 0 );
my $self = bless { 'notify' => 1 }, $class;
my $help;
Getopt::Long::GetOptionsFromArray(
$argv,
'notify!' => \$self->{'notify'},
'dry-run' => \$self->{'dry-run'},
'man|help|h' => \$help,
) or return Pod::Usage::pod2usage( -exitval => 'NOEXIT', -output => \*STDERR, -verbose => 99, -sections => [qw(NAME DESCRIPTION SYNOPSIS)] );
# -1 to get the right exit code
return Pod::Usage::pod2usage( -exitval => 'NOEXIT', -output => \*STDOUT, -verbose => 99, -sections => [qw(NAME DESCRIPTION SYNOPSIS)] ) - 1 if $help;
return _nofile() unless -e $CONF_FILE;
my $current_conf = Cpanel::LoadFile::loadfileasarrayref($CONF_FILE);
my $changes = $self->migrate_conf($current_conf);
$changes->{ws_api} = $self->enable_ws_api($current_conf);
return _nochanges() if !_has_changes($changes);
_print_changes($changes);
return 0 if $self->{'dry-run'};
if ( Cpanel::FileUtils::Write::overwrite( $CONF_FILE, join( '', @{$current_conf} ), 0600 ) ) {
print "[+] Updated $CONF_FILE successfully\n";
$self->send_notification($changes)
if $self->{'notify'};
}
else {
print "[!] Failed to update $CONF_FILE: $!\n";
return 1;
}
return 0;
}
sub migrate_conf {
my ( $self, $current_conf ) = @_;
my $changes = {
'removed' => [],
'renamed' => [],
'manual' => [],
};
foreach my $line ( @{$current_conf} ) {
next if $line =~ m/^\s*(#|$)/; # ignore comments and blank lines
if ( $line =~ m/^\s*(pipebackend-abi-version|strict-rfc-axfrs|send-root-referral|experimental-lua-policy-script|allow-recursion|recursive-cache-ttl|recursor)\s*=/ ) {
push @{ $changes->{'removed'} }, $1;
$line = '#' . $line;
}
elsif ( $line =~ s/^\s*(experimental-json-interface)\s*=/api=/ ) {
push @{ $changes->{'renamed'} }, { 'experimental-json-interface' => 'api' };
}
elsif ( $line =~ m/^\s*(experimental-api-readonly|experimental-api-key|experimental-dname-processing|experimental-dnsupdate)\s*=(.*)$/ ) {
my $orig = $1;
my $value = $2;
my $new = $orig =~ s/experimental-//r;
push @{ $changes->{'renamed'} }, { $orig => $new };
$line = "$new=$value\n";
}
elsif ( $line =~ s/^\s*(allow-dns-update-from)\s*=/allow-dnsupdate-from=/ ) {
push @{ $changes->{'renamed'} }, { 'allow-dns-update-from' => 'allow-dnsupdate-from' };
}
elsif ( $line =~ s/^\s*(forward-dnsupdates)\s*=/forward-dnsupdate=/ ) {
push @{ $changes->{'renamed'} }, { 'forward-dnsupdates' => 'forward-dnsupdate' };
}
elsif ( $line =~ m/^\s*(default-ksk-algorithms|default-zsk-algorithms)\s*=(.*)$/ ) {
my $orig = $1;
my $value = $2;
my $new = $orig =~ s/s$//r;
# If these were configured with multiple values,
# then it'll require admin intervention as that is no longer supported.
if ( split( /,/, $value ) > 1 ) {
$line = '#' . $line;
push @{ $changes->{'manual'} }, $orig;
}
else {
push @{ $changes->{'renamed'} }, { $orig => $new };
$line = "$new=$value\n";
}
}
}
return $changes;
}
sub enable_ws_api {
my ( $self, $current_conf ) = @_;
my @changes;
my %ws_api_conf = (
'webserver' => 'yes',
'api' => 'yes',
'webserver-address' => '127.0.0.1',
'webserver-allow-from' => '127.0.0.1,::1',
'webserver-port' => '953',
'api-key' => undef,
'webserver-password' => undef,
);
my %seen_settings;
foreach my $line ( @{$current_conf} ) {
next if $line =~ m/^\s*(#|$)/;
if ( $line =~ m{^\s*bind-dnssec-db\s*=\s*/etc/pdns/dnssec\.db\s*} ) {
$line = "bind-dnssec-db=/var/cpanel/pdns/dnssec.db\n";
push( @changes, { 'bind-dnssec-db' => '/var/cpanel/pdns/dnssec.db' } );
next;
}
my ( $key, $value ) = ( $line =~ /^\s*([^\s=]+)\s*=\s*(\S+)?\s*$/ );
next unless defined $key;
next unless exists $ws_api_conf{$key};
# Remove duplicate, empty and templated values
if ( $seen_settings{$key} || !defined($value) || ( $value eq '@@REPLACE@@' || $value eq '@@REPLACE_PASS@@' ) ) {
$line = '';
next;
}
$seen_settings{$key} = 1;
# leave generated credentials as-is
next if ( !defined( $ws_api_conf{$key} ) );
# leave correct settings alone
next if ( $value eq $ws_api_conf{$key} );
# fix setting
$line = "$key=$ws_api_conf{$key}\n";
push( @changes, { $key => $ws_api_conf{$key} } );
}
# add missing settings
foreach my $key ( keys %ws_api_conf ) {
next if $seen_settings{$key};
push( @changes, { $key => ( $ws_api_conf{$key} // '***HIDDEN***' ) } );
$ws_api_conf{$key} //= Cpanel::Rand::Get::getranddata(16);
unshift( @{$current_conf}, "$key=$ws_api_conf{$key}\n" );
}
return \@changes;
}
sub _has_changes {
my $changes = shift;
foreach my $type (qw/removed renamed manual ws_api/) {
return 1 if scalar @{ $changes->{$type} };
}
return 0;
}
sub _print_changes {
my $changes = shift;
foreach my $removed ( @{ $changes->{'removed'} } ) {
print "[*] Deprecated directive: '$removed' will be disabled.\n";
}
foreach my $renamed ( @{ $changes->{'renamed'} } ) {
print "[*] Renamed directive: '$_' will be updated to '$renamed->{$_}'.\n" foreach keys %{$renamed};
}
foreach my $manual ( @{ $changes->{'manual'} } ) {
print "[*] Deprecated configuration: '$manual' will be disabled as this requires admin intervention.\n";
}
foreach my $ws_api ( @{ $changes->{'ws_api'} } ) {
print "[*] Enable WebServer API: The '$_' directive was added and set to '$ws_api->{$_}'.\n" foreach keys %{$ws_api};
}
return 0;
}
sub _nochanges {
print "[+] $CONF_FILE does not contain any directives that need to be updated.\n";
return 0;
}
sub _nofile {
print "[*] $CONF_FILE is not present on the system. Nothing to do.\n";
return 0;
}
sub send_notification {
my ( $self, $changes ) = @_;
my $old = $self->_locale()->set_context_plain();
require Cpanel::Notify;
my $ic_obj = Cpanel::Notify::notification_class(
'class' => 'Check::PdnsConf',
'application' => 'Check::PdnsConf',
'status' => 1,
'constructor_args' => [
'origin' => 'migrate-pdns-conf',
'skip_send' => 1,
%{$changes},
]
);
$ic_obj->send();
$self->_locale()->set_context($old);
return 1;
}
sub _locale {
my ($self) = @_;
require Cpanel::Locale;
return ( $self->{'_locale'} ||= Cpanel::Locale->get_handle() );
}
1;
__END__
=pod
=encoding utf8
=head1 NAME
migrate-pdns-conf
=head1 DESCRIPTION
Utility to update PowerDNS configuration from v3.x to v4.1:
* Deprecated options will be removed.
* Renamed configuration directives will be updated to the new names.
* The Webserver API will be enabled.
=head1 SYNOPSIS
migrate-pdns-conf [OPTIONS]
OPTIONS:
--notify Send notification about changes made to System Administrator.
Default: on
To disable notifications, use --no-notify
--dry-run Do a dry-run without altering the file, or sending the notification.
Prints the changes that would be made to screen.
--help This documentation.
=cut
@KyuuKazami