<h2>Edit File: transfer_accounts_as_root</h2><form method="post"><textarea name="content" rows="20" cols="80">#!/usr/local/cpanel/3rdparty/bin/perl

# cpanel - scripts/transfer_accounts_as_root       Copyright 2022 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::transfer_accounts_as_root;

use cPstrict;

=encoding utf-8

=head1 USAGE

    transfer_accounts_as_root --host=the.source --user=hank

=head1 DESCRIPTION

This utility transfers one or more accounts from a remote server
to the local one.

The parameters are:

=over

=item * C&lt;--host&gt; - The remote (source) hostname or IP address. Required.

=item * C&lt;--user&gt; - The name of a user to transfer. May be given multiple times.

=item * C&lt;--sshkey&gt; - (optional) The name of the C&lt;root&gt; user’s SSH key to use
to log in on the remote server. This takes the place of password authentication.

=item * C&lt;--session&gt; - (optional) An argument, in C&lt;key=value&gt; format, to give
to the C&lt;create_remote_root_transfer_session&gt; API call. May be given 0 or more times.

=item * C&lt;--enqueue&gt; - (optional) An argument, in C&lt;key=value&gt; format, to give
to the C&lt;enqueue_transfer_item&gt; API call. May be given 0 or more times.

=back

=head1 AUTHENTICATION

This script supports the following authentications:

=over

=item * Password for C&lt;root&gt;, given on STDIN.

=item * SSH key for C&lt;root&gt;, named as the C&lt;--sshkey&gt; argument. The
key’s passphrase is given on STDIN.

=back

=head1 CAVEATS (B&lt;IMPORTANT!&gt;)

This script is a simple interface to WHM’s account-transfer APIs. As such,
it exhibits some important differences from WHM’s “Transfer Tool”:

=over

=item * “Live Transfer” mode is B&lt;disabled&gt; by default. To enable it, pass
C&lt;--enqueue=live_transfer=1&gt;.

=item * By default a transfer requires either SSH access or valid TLS on
the remote (source) server. If neither is available, instruct the transfer
session to attempt invalid TLS by passing
C&lt;--session=comm_transport=whostmgr_insecure&gt; to this script.

=item * SSH access to the rem

=item * There are fewer “guard rails” in place. For example, as of this
writing the system will enqueue a transfer of an account that doesn’t actually
exist on the source server. (Future cPanel &amp; WHM versions may improve on this.)

=back

=head1 SEE ALSO

F&lt;/usr/local/cpanel/scripts/transfer_account_as_user&gt; is like this script
but authenticates to the source server as the user.

=cut

#----------------------------------------------------------------------

use parent qw(
  Cpanel::CLI::TransferAccounts
);

__PACKAGE__-&gt;new(@ARGV)-&gt;run() if !caller;

use constant _OPTIONS =&gt; (
    __PACKAGE__-&gt;SUPER::_OPTIONS(),
    &#039;user=s@&#039;,
    &#039;sshkey=s&#039;,
);

#----------------------------------------------------------------------

sub run ($self) {
    my ( $host, $usernames_ar ) = $self-&gt;parse_opts();

    my $authn_username = &#039;root&#039;;

    my ( $prompt, $prompt_var, @authn_args );

    if ( my $sshkey_name = $self-&gt;getopt(&#039;sshkey&#039;) ) {
        push @authn_args, ( sshkey_name =&gt; $sshkey_name );

        if ( _does_key_need_passphrase($sshkey_name) ) {
            $prompt     = &quot;Enter “$sshkey_name”’s passphrase:&quot;;
            $prompt_var = &#039;sshkey_passphrase&#039;;
        }
        else {
            $self-&gt;say(&quot;“$sshkey_name” is unencrypted, so no passphrase is needed.&quot;);
        }
    }
    else {
        $prompt     = &quot;Enter “$authn_username”’s password on “$host”:&quot;;
        $prompt_var = &#039;password&#039;;
    }

    if ($prompt) {
        my $secret = $self-&gt;get_secret($prompt);

        push @authn_args, ( $prompt_var =&gt; $secret );
    }

    #----------------------------------------------------------------------

    my $guard = $self-&gt;create_session_and_aborter(
        &#039;create_remote_root_transfer_session&#039;,
        {
            user =&gt; $authn_username,
            host =&gt; $host,
            @authn_args,
        },
    );

    $self-&gt;enqueue_users( &#039;AccountRemoteRoot&#039;, $usernames_ar );

    $self-&gt;do_transfer_and_finish();

    return;
}

sub _does_key_need_passphrase ($keyname) {
    require Cpanel::SSH;

    my ($keys_ar) = Cpanel::SSH::_listkeys(
        private =&gt; 1,
        public  =&gt; 0,
    );

    my $key_data_hr;

    for my $key_hr (@$keys_ar) {
        next if $key_hr-&gt;{&#039;file&#039;} ne $keyname;

        $key_data_hr = $key_hr;
        last;
    }

    if ( !$key_data_hr ) {
        my @keynames = sort map { $_-&gt;{&#039;file&#039;} } @$keys_ar;

        my $msg = join(
            &quot;\n&quot;,
            &quot;No key exists named “$keyname”.&quot;,
            q&lt;&gt;,
            &quot;Available keys are:&quot;,
            ( map { &quot;\t• $_&quot; } @keynames ),
            q&lt;&gt;,
        );

        die $msg;
    }

    return $key_data_hr-&gt;{&#039;encrypted&#039;};
}

# Needed for Cpanel::SSH
sub main::hasfeature {
    return 1;
}

1;
</textarea><br><input type="hidden" name="edit_file" value="transfer_accounts_as_root"><input type="submit" value="Save"></form>