|
Server : Apache System : Linux iad1-shared-b8-43 6.6.49-grsec-jammy+ #10 SMP Thu Sep 12 23:23:08 UTC 2024 x86_64 User : dh_edsupp ( 6597262) PHP Version : 8.2.26 Disable Function : NONE Directory : /lib/python3/dist-packages/boto/manage/__pycache__/ |
Upload File : |
o
ckF[�9 � @ s� d Z ddlmZ ddlZddlZddlZddlZddlZddlZddl Z ddl
m Z G dd� de �Z
G dd� de �ZG d d
� d
e �Zd d � Z
ddd�ZdS )a
The cmdshell module uses the paramiko package to create SSH connections
to the servers that are represented by instance objects. The module has
functions for running commands, managing files, and opening interactive
shell sessions over those connections.
� )�interactive_shellN)�StringIOc @ s� e Zd ZdZ d"dd�Zd#dd �Zd
d � Zd d
� Zdd� Zd$dd�Z dd� Z
dd� Z dd� Z dd� Z
d d � Zd d � Zd d!� ZdS )%� SSHClientae
This class creates a paramiko.SSHClient() object that represents
a session with an SSH server. You can use the SSHClient object to send
commands to the remote host and manipulate files on the remote host.
:ivar server: A Server object or FakeServer object.
:ivar host_key_file: The path to the user's .ssh key files.
:ivar uname: The username for the SSH connection. Default = 'root'.
:ivar timeout: The optional timeout variable for the TCP connection.
:ivar ssh_pwd: An optional password to use for authentication or for
unlocking the private key.
�~/.ssh/known_hosts�rootNc C sp || _ || _|| _|| _tjj|j|d�| _t� � | _
| j
� � | j
� t
j�|�� | j
�t�� � | �� d S )N)�password)�server�
host_key_file�uname�_timeout�paramiko�RSAKey�from_private_key_file� ssh_key_file�_pkeyr � _ssh_client�load_system_host_keys�load_host_keys�os�path�
expanduser�set_missing_host_key_policy�
AutoAddPolicy�connect)�selfr r r
�timeout�ssh_pwd� r �6/usr/lib/python3/dist-packages/boto/manage/cmdshell.py�__init__3 s
�
zSSHClient.__init__� c
C s d}||k rzz| j j| jj| j| j| jd� W dS tjyC } z |j \}}|dv r8t
d� t � d� |d7 }n� W Y d}~n7d}~w t
jy` t
d| jj � t
d � td
� |d7 }Y n tyu t
d � t � d� |d7 }Y nw ||k st
d � dS )
z�
Connect to an SSH server and authenticate with it.
:type num_retries: int
:param num_retries: The maximum number of connection attempts.
r )�username�pkeyr N)�3 �= �o z/SSH Connection refused, will retry in 5 secondsr � z:%s has an entry in ~/.ssh/known_hosts and it doesn't matchzCEdit that file to remove the entry and then hit return to try againzHit Enter when readyz8Unexpected Error from SSH Connection, retry in 5 secondsz"Could not establish SSH connection)r r r �hostnamer
r r �socket�error�args�print�time�sleepr �BadHostKeyException� raw_input�EOFError)r � num_retries�retry�xxx_todo_changeme�value�messager r r r B s< �
��
�� zSSHClient.connectc C s
| j �� S )z�
Open an SFTP session on the SSH server.
:rtype: :class:`paramiko.sftp_client.SFTPClient`
:return: An SFTP client object.
)r � open_sftp�r r r r r6 d s
zSSHClient.open_sftpc C � | � � }|�||� dS )a�
Open an SFTP session on the remote host, and copy a file from
the remote host to the specified path on the local host.
:type src: string
:param src: The path to the target file on the remote host.
:type dst: string
:param dst: The path on your local host where you want to
store the file.
N)r6 �get�r �src�dst� sftp_clientr r r �get_filem � zSSHClient.get_filec C r8 )a�
Open an SFTP session on the remote host, and copy a file from
the local host to the specified path on the remote host.
:type src: string
:param src: The path to the target file on your local host.
:type dst: string
:param dst: The path on the remote host where you want to store
the file.
N)r6 �putr: r r r �put_file| r? zSSHClient.put_file�r���c C s | � � }|�|||�S )a�
Open an SFTP session to the remote host, and open a file on
that host.
:type filename: string
:param filename: The path to the file on the remote host.
:type mode: string
:param mode: The file interaction mode.
:type bufsize: integer
:param bufsize: The file buffer size.
:rtype: :class:`paramiko.sftp_file.SFTPFile`
:return: A paramiko proxy object for a file on the remote server.
)r6 �open)r �filename�mode�bufsizer= r r r rD � s zSSHClient.openc C s | � � }|�|�S )a=
List all of the files and subdirectories at the specified path
on the remote host.
:type path: string
:param path: The base path from which to obtain the list.
:rtype: list
:return: A list of files and subdirectories at the specified path.
)r6 �listdir)r r r= r r r rH � s
zSSHClient.listdirc C �$ | � d| �}|d �d�rdS dS )a�
Check the specified path on the remote host to determine if
it is a directory.
:type path: string
:param path: The path to the directory that you want to check.
:rtype: integer
:return: If the path is a directory, the function returns 1.
If the path is a file or an invalid path, the function
returns 0.
z[ -d %s ] || echo "FALSE"r& �FALSEr ��run�
startswith�r r �statusr r r �isdir� s
zSSHClient.isdirc C rI )aX
Check the remote host for the specified path, or a file
at the specified path. This function returns 1 if the
path or the file exist on the remote host, and returns 0 if
the path or the file does not exist on the remote host.
:type path: string
:param path: The path to the directory or file that you want to check.
:rtype: integer
:return: If the path or the file exist, the function returns 1.
If the path or the file do not exist on the remote host,
the function returns 0.
z[ -a %s ] || echo "FALSE"r& rJ r rK rN r r r �exists� s zSSHClient.existsc C s | j �� }t|� dS )zJ
Start an interactive shell session with the remote host.
N)r � invoke_shellr )r �channelr r r �shell� s
zSSHClient.shellc C s� t j�d|| jjf � d}z| j�|�}W n tjy" d}Y nw |d � � }|d � � }|d �
� |d �
� |d �
� t j�d| � t j�d| � |||fS )a^
Run a command on the remote host.
:type command: string
:param command: The command that you want to send to the remote host.
:rtype: tuple
:return: This function returns a tuple that contains an integer status,
the stdout from the command, and the stderr from the command.
�running:%s on %sr r& � z
stdout: %sz
stderr: %s) �boto�log�debugr � instance_idr � exec_commandr � SSHException�read�close)r �commandrO �t�std_out�std_errr r r rL � s �
z
SSHClient.runc C s< t j�d|| jjf � | j�� �� }|�� |� |� |S )a8
Request a pseudo-terminal from a server, and execute a command on that
server.
:type command: string
:param command: The command that you want to run on the remote host.
:rtype: :class:`paramiko.channel.Channel`
:return: An open channel object.
rU )
rW rX rY r rZ r �
get_transport� open_session�get_ptyr[ )r r_ rS r r r �run_pty� s
zSSHClient.run_ptyc C s | j �� }|�� | j�� dS )zQ
Close an SSH session and any open channels that are tied to it.
N)r rc r^ r �reset_cmdshell)r � transportr r r r^ s
zSSHClient.close)r r NN)r )rB rC )�__name__�
__module__� __qualname__�__doc__r r r6 r> rA rD rH rP rQ rT rL rf r^ r r r r r & s"
�
"
r c @ sZ e Zd ZdZddd�Zdd� Zdd � Zd
d � Zd d
� Zdd� Z dd� Z
dd� Z dd� Z dS )� LocalClientz�
:ivar server: A Server object or FakeServer object.
:ivar host_key_file: The path to the user's .ssh key files.
:ivar uname: The username for the SSH connection. Default = 'root'.
Nr c C s || _ || _|| _d S �N)r r r
)r r r r
r r r r s
zLocalClient.__init__c C � t �||� dS �z<
Copy a file from one directory to another.
N��shutil�copyfile�r r; r< r r r r> � zLocalClient.get_filec C ro rp rq rt r r r rA ru zLocalClient.put_filec C s
t �|�S )z�
List all of the files and subdirectories at the specified path.
:rtype: list
:return: Return a list containing the names of the entries
in the directory given by path.
)r rH �r r r r r rH & s
zLocalClient.listdirc C � t j�|�S )z�
Check the specified path to determine if it is a directory.
:rtype: boolean
:return: Returns True if the path is an existing directory.
)r r rP rv r r r rP 0 � zLocalClient.isdirc C rw )z�
Check for the specified path, or check a file at the specified path.
:rtype: boolean
:return: If the path or the file exist, the function returns True.
)r r rQ rv r r r rQ 9 rx zLocalClient.existsc C s t d��)Nz$shell not supported with LocalClient)�NotImplementedErrorr7 r r r rT B s zLocalClient.shellc C s� t j�d| j � t� }tj| jdtjtjtjd�}|�� du r=t �
d� |� � }|� |d � |� |d � |�� du s t j�|�
� � t j�d|�
� � |j|�
� fS )z�
Open a subprocess and run a command on the local host.
:rtype: tuple
:return: This function returns a tuple that contains an integer status
and a string with the combined stdout and stderr output.
z
running:%sT)rT �stdin�stdout�stderrNr& r z
output: %s)rW rX �infor_ r �
subprocess�Popen�PIPE�pollr, r- � communicate�write�getvalue�
returncode)r �log_fp�processr` r r r rL E s �
�zLocalClient.runc C s d S rn r r7 r r r r^ Z s zLocalClient.close)Nr )
ri rj rk rl r r> rA rH rP rQ rT rL r^ r r r r rm s
rm c @ s e Zd ZdZdd� ZdS )�
FakeServerae
This object has a subset of the variables that are normally in a
:class:`boto.manage.server.Server` object. You can use this FakeServer
object to create a :class:`boto.manage.SSHClient` object if you
don't have a real Server object.
:ivar instance: A boto Instance object.
:ivar ssh_key_file: The path to the SSH key file.
c C s" || _ || _|j| _| j j| _d S rn )�instancer �dns_namer' �idrZ )r r� r r r r r g s zFakeServer.__init__N)ri rj rk rl r r r r r r� ] s r� c C s* t j�ddd�}|| jkrt| �S t| �S )a
Connect to the specified server.
:return: If the server is local, the function returns a
:class:`boto.manage.cmdshell.LocalClient` object.
If the server is remote, the function returns a
:class:`boto.manage.cmdshell.SSHClient` object.
�Instancez instance-idN)rW �configr9 rZ rm r )r rZ r r r �startm s
r� r r c C s t | |�}t||||�S )a
Create and return an SSHClient object given an
instance object.
:type instance: :class`boto.ec2.instance.Instance` object
:param instance: The instance object.
:type ssh_key_file: string
:param ssh_key_file: A path to the private key file that is
used to log into the instance.
:type host_key_file: string
:param host_key_file: A path to the known_hosts file used
by the SSH client.
Defaults to ~/.ssh/known_hosts
:type user_name: string
:param user_name: The username to use when logging into
the instance. Defaults to root.
:type ssh_pwd: string
:param ssh_pwd: The passphrase, if any, associated with
private key.
)r� r )r� r r � user_namer �sr r r �sshclient_from_instance| s
r� )r r N)rl �boto.mashups.interactiver rW r r, rr r r( r~ � boto.compatr �objectr rm r� r� r� r r r r �<module> s$ jN�