�
��e}_ � �� � S r SSKJrJrJrJr SSKrSSKrSSKrSSK r SS/r
" S S\5 r \R S:� a SSK
Jr O \ R " S 5 R rS
r " S S\5 rg) a4 This class extends pexpect.spawn to specialize setting up SSH connections.
This adds methods for login, logout, and expecting the shell prompt.
PEXPECT LICENSE
This license is approved by the OSI and FSF as GPL-compatible.
http://opensource.org/licenses/isc-license.txt
Copyright (c) 2012, Noah Spurrier <[email protected]>
PERMISSION TO USE, COPY, MODIFY, AND/OR DISTRIBUTE THIS SOFTWARE FOR ANY
PURPOSE WITH OR WITHOUT FEE IS HEREBY GRANTED, PROVIDED THAT THE ABOVE
COPYRIGHT NOTICE AND THIS PERMISSION NOTICE APPEAR IN ALL COPIES.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
� )�ExceptionPexpect�TIMEOUT�EOF�spawnN�ExceptionPxssh�pxsshc � � \ rS rSrSrSrg)r � z!Raised for pxssh exceptions.
� N)�__name__�
__module__� __qualname__�__firstlineno__�__doc__�__static_attributes__r � �//usr/lib/python3/dist-packages/pexpect/pxssh.pyr r s � �r )� r )�quotez[^\w@%+=:,./-]c �^ � U ( d g[ U 5 c U $ SU R SS5 - S- $ )z1Return a shell-escaped version of the string *s*.z''�'z'"'"')� _find_unsafe�replace)�ss r r r ) s4 � ��� ��?� "��H� �Q�Y�Y�s�I�.�.��4�4r c � � \ rS rSrSrSSSSSSSS0 SSSS4
S jrS
rS rSS jrSS
SSSSSSSSSS0 SSSS4S jr S r
SS jr S r Sr
g)r �4 aJ
This class extends pexpect.spawn to specialize setting up SSH
connections. This adds methods for login, logout, and expecting the shell
prompt. It does various tricky things to handle many situations in the SSH
login process. For example, if the session is your first login, then pxssh
automatically accepts the remote certificate; or if you have public key
authentication setup then pxssh won't wait for the password prompt.
pxssh uses the shell prompt to synchronize output from the remote host. In
order to make this more robust it sets the shell prompt to something more
unique than just $ or #. This should work on most Borne/Bash or Csh style
shells.
Example that runs a few commands on a remote server and prints the result::
from pexpect import pxssh
import getpass
try:
s = pxssh.pxssh()
hostname = raw_input('hostname: ')
username = raw_input('username: ')
password = getpass.getpass('password: ')
s.login(hostname, username, password)
s.sendline('uptime') # run a command
s.prompt() # match the prompt
print(s.before) # print everything before the prompt.
s.sendline('ls -l')
s.prompt()
print(s.before)
s.sendline('df')
s.prompt()
print(s.before)
s.logout()
except pxssh.ExceptionPxssh as e:
print("pxssh failed on login.")
print(e)
Example showing how to specify SSH options::
from pexpect import pxssh
s = pxssh.pxssh(options={
"StrictHostKeyChecking": "no",
"UserKnownHostsFile": "/dev/null"})
...
Note that if you have ssh-agent running while doing development with pxssh
then this can lead to a lot of confusion. Many X display managers (xdm,
gdm, kdm, etc.) will automatically start a GUI agent. You may see a GUI
dialog box popup asking for a password during development. You should turn
off any key agents during testing. The 'force_password' attribute will turn
off public key authentication. This will only work if the remote SSH server
is configured to allow password logins. Example of using 'force_password'
attribute::
s = pxssh.pxssh()
s.force_password = True
hostname = raw_input('hostname: ')
username = raw_input('username: ')
password = getpass.getpass('password: ')
s.login (hostname, username, password)
`debug_command_string` is only for the test suite to confirm that the string
generated for SSH is correct, using this will not allow you to do
anything other than get a string back from `pxssh.pxssh.login()`.
� i� NT�strictFc �� � [ R " U S XX4XVXxX�U
S9
SU l SU l U R U l SU l SU l SU l SU l SU l X�l
X�l g ) N) �timeout�maxread�searchwindowsize�logfile�cwd�env�
ignore_sighup�echo�encoding� codec_errors�use_pollz<pxssh>z\[PEXPECT\][\$\#] zPS1='[PEXPECT]\$ 'zset prompt='[PEXPECT]\$ 'z(prompt restore;
PS1='[PEXPECT]%(!.#.$) 'z -o 'PubkeyAuthentication=no'F) r �__init__�name�
UNIQUE_PROMPT�PROMPT�
PROMPT_SET_SH�PROMPT_SET_CSH�PROMPT_SET_ZSH�SSH_OPTS�force_password�debug_command_string�options)�selfr r! r" r# r$ r% r& r' r5 r( r) r4 r* s r r+ �pxssh.__init__v s| � �
���t�T�7�(8� �}� (�h� X�
�� � 3����(�(�� � 3��� :��� I���8��
� $���$8�!� � r c �B � [ U5 [ U5 pCX4:� a X!p!XCpC[ US- 5 n[ SUS- 5 H] nXV/S/U- - pW[ SUS- 5 H= nXx S- XXS-
S- p�XxS-
n XS-
X&S-
:w a U S- n [ X�U 5 XX' M? M_ XS $ )zBThis calculates the Levenshtein distance between a and b.
� r )�len�range�min) r6 �a�b�n�m�current�i�previous�j�add�delete�changes r �levenshtein_distance�pxssh.levenshtein_distance� s� � � �1�v�s�1�v�1� �5��a��a���!��*���q��1�� �A� '��a�S��U��g��1�Q�q�S�\�� &�k�!�m�W�q�S�\�!�^�V�!�A�#� ���q�S�6�Q��s�V�#� #�a�Z�F� ��f� 5��
� "� � �z�r c �
� US- nUS- nUS- nU R 5 n[ R " 5 nSnUnXt: a4 XPR SUS9-
n[ R " 5 U-
nUnXt: a M4 U$ ! [ a U$ f = f)a0 This facilitates using communication timeouts to perform
synchronization as quickly as possible, while supporting high latency
connections with a tunable worst case performance. Fast connections
should be read almost immediately. Worst case performance for this
method is timeout_multiplier * 3 seconds.
g �?皙�����?g @g r9 )�sizer )� string_type�time�read_nonblockingr ) r6 �timeout_multiplier�first_char_timeout�inter_char_timeout�
total_timeout�prompt�begin�expiredr s r �try_read_prompt�pxssh.try_read_prompt� s� � � 0�#� 5�� 0�#� 5�� +�S�0�
��!�!�#��� � � ����$���%�
��/�/�Q��/�H�H�� �)�)�+��-��,�� �%� �
�� �
���
�
�s �,A4 �4
B�Bc �� � U R 5 [ R " S5 U R U5 U R 5 U R U5 nU R 5 U R U5 nU R 5 U R U5 nU R X45 n[
U5 nUS:X a g[ U5 U- S: a gg! [ a N�f = f)a� This attempts to find the prompt. Basically, press enter and record
the response; press enter again and record the response; if the two
responses are similar then assume we are at the original prompt.
This can be a slow function. Worst case with the default sync_multiplier
can take 12 seconds. Low latency connections are more likely to fail
with a low sync_multiplier. Best case sync time gets worse with a
high sync multiplier (500 ms with default). rK r Fg�������?T)�sendlinerN �sleeprW r rH r: �float)r6 �sync_multiplier�xr= r> �ld�len_as r �sync_original_prompt�pxssh.sync_original_prompt� s� � �
�
�
�� �
�
�3�� � � � � � 1�
�
�
�� � � � � 1�� �
�
�� � � � � 1�� �
�
�� � � � � 1��
�
&�
&�q�
+���A��� �A�:�� ��9�U�?�S� ����% � � � �s �C �
C � C � �ansiz[#$]�
r9 z((?i)(?:password:)|(?:passphrase for key)�sshc �, � SX]SS[ /n/ nUR U5 UR S[ /5 SR U R R 5 VVs/ s H u nnSU< SU< S3PM snn5 nU
( a US - nU ( d US
- nU R ( a US - U R - nUb> U( a/ [ R R U5 ( d [ S
5 eUS- U- nUb US[ U5 - - nU bJ U S:X a US- nO>U( a/ [ R R U 5 ( d [ S5 eUSU - - nU0 :w au [ 0 [ U5 5 ( a[ SSSS.nU HO nUU nUU; d M UU nU H4 n US:X a [ [ U 5 5 n US- U- S - [ U 5 - nM6 MQ Ub
US- U- nGOBUc [! S5 e[# US 5 n U R% 5 V s/ s H n U R' 5 PM n n S S S 5 S U- n S n!Sn"Sn#W H� n$U"( d/ [( R* " U U$[( R, 5 ( a Sn"M9 U"( a S U$R/ 5 ; a MV U"( a S U$R/ 5 ; a Sn# O<U"( d M~ [( R* " U!U$[( R, 5 ( d M� Sn# O U ( a A$A U"( d [! S!U- 5 eU#( d [! S"U- 5 eUS U< S U< 3-
nU R0 ( a U$ U( a [2 R4 " U U5 OU R7 U5 U R9 UUS#9n%U%S$:X a" U R7 S%5 U R9 U5 n%U%S&:X a" U R7 U5 U R9 U5 n%U%S':X a" U R7 U5 U R9 U5 n%U%S(:X a U R; 5 [ S)5 eU%S$:X a U R; 5 [ S*5 eU%S+:X a O�U%S&:X a U R; 5 [ S,5 eU%S-:X a U R; 5 [ S.5 eU%S':X a U R; 5 [ S/5 eU%S0:X a O<U%S1:X a U R; 5 [ S25 eU R; 5 [ S35 eU( a1 U R= U 5 ( d U R; 5 [ S45 eU( aM U R? 5 ( d8 U R; 5 [ S5U R@ < S6U RB < S735 egs snnf s sn f ! , ( d f GN_= f)8a� This logs the user into the given server.
It uses 'original_prompt' to try to find the prompt right after login.
When it finds the prompt it immediately tries to reset the prompt to
something more easily matched. The default 'original_prompt' is very
optimistic and is easily fooled. It's more reliable to try to match the original
prompt as exactly as possible to prevent false matches by server
strings such as the "Message Of The Day". On many systems you can
disable the MOTD on the remote server by creating a zero-length file
called :file:`~/.hushlogin` on the remote server. If a prompt cannot be found
then this will not necessarily cause the login to fail. In the case of
a timeout when looking for the prompt we assume that the original
prompt was so weird that we could not match it, so we use a few tricks
to guess when we have reached the prompt. Then we hope for the best and
blindly try to reset the prompt to something more unique. If that fails
then login() raises an :class:`ExceptionPxssh` exception.
In some situations it is not possible or desirable to reset the
original prompt. In this case, pass ``auto_prompt_reset=False`` to
inhibit setting the prompt to the UNIQUE_PROMPT. Remember that pxssh
uses a unique prompt in the :meth:`prompt` method. If the original prompt is
not reset then this will disable the :meth:`prompt` method unless you
manually set the :attr:`PROMPT` attribute.
Set ``password_regex`` if there is a MOTD message with `password` in it.
Changing this is like playing in traffic, don't (p)expect it to match straight
away.
If you require to connect to another SSH server from the your original SSH
connection set ``spawn_local_ssh`` to `False` and this will use your current
session to do so. Setting this option to `False` and not having an active session
will trigger an error.
Set ``ssh_key`` to a file path to an SSH private key to use that SSH key
for the session authentication.
Set ``ssh_key`` to `True` to force passing the current SSH authentication socket
to the desired ``hostname``.
Set ``ssh_config`` to a file path string of an SSH client config file to pass that
file to the client to handle itself. You may set any options you wish in here, however
doing so will require you to post extra information that you may not want to if you
run into issues.
Alter the ``cmd`` to change the ssh client used, or to prepend it with network
namespaces. For example ```cmd="ip netns exec vlan2 ssh"``` to execute the ssh in
network namespace named ```vlan```.
z0(?i)are you sure you want to continue connectingz(?i)permission deniedz(?i)terminal typez$(?i)connection closed by remote hostrc z -o '�=r z -qz) -o'NoHostAuthenticationForLocalhost=yes'� Nz+SSH config does not exist or is not a file.z -F z -p %sTz -Az0private ssh key does not exist or is not a file.z -i %s�L�R�D)�local�remote�dynamicFz -z -l z0login() needs either a username or an ssh_config�rtz^Host\s+%s\s*$z^User\s+\w+\s*$�hostname�hostz+login() ssh_config has no Host entry for %sz+login() ssh_config has no user entry for %s�r r �yes� � � z&Could not establish connection to hostz-Weird error. Got "are you sure" prompt twice.r9 zpassword refusedr zpermission deniedz.Weird error. Got "terminal type" prompt twice.� � zconnection closedzunexpected login responsez*could not synchronize with original promptz&could not set shell prompt (received: z , expected: z).)"r �extendr �joinr5 �itemsr3 r2 �os�path�isfiler �str�
isinstance�typer � TypeError�open� readlines�strip�re�match�
IGNORECASE�lowerr4 r �_spawnrZ �expect�closera �set_unique_prompt�beforer. )&r6 �server�username�password�
terminal_type�original_prompt�
login_timeout�port�auto_prompt_reset�ssh_key�quietr] �check_local_ip�password_regex� ssh_tunnels�spawn_local_sshra �
ssh_config�cmd�session_regex_array�session_init_regex_array�o�v� ssh_options� tunnel_types� tunnel_type�cmd_type�tunnels�tunnel�f�l�lines� server_regex�
user_regex�config_has_server�server_has_username�linerB s& r �login� pxssh.login s! � �n R�Sb� uL� Na� cj� k��#%� � �'�'�(;�<� �'�'�)O�QT�(U�V��g�g�D�L�L�DV�DV�DX� Y�DX�&�1�a��1� 5�DX� Y�Z� � �%��-�K� �%�(S�S�K� � � �%��+�d�m�m�;�K� � !� �r�w�w�~�~�j�'A�'A�$�%R�S�S�%��.��;�K� � �%��#�d�)�(<�<�K� � ���}� )�E� 1� �"�2�7�7�>�>�'�+B�+B�(�)[�\�\� )�H��,@� @� � ��?�z�"�T�+�->� ?� ?�� � � �L�
,� �'� �4�� �+�-� )�+� 6�G�")��*�E�1�%*�3�v�;�%7�F�&1�D�&8�8�&C�c�&I�C�PV�K�&W� � #*� ,� � �%��.��9�K�
�
�� N�O� O��j�$�'�1�,-�K�K�M�:�M�q�����M��:� (� -�v�5�L�+�J� %� �"'� � ��(�R�X�X�l�D�"�-�-�-X�-X�(,�%�&�:���� �+E��&�6�T�Z�Z�\�+A�*/�'��&�&�2�8�8�J��b�m�m�+T�+T�*.�'�� � ���$� � M�PV� V�W�W�(� � M�PV� V�W�W� �;��/�/�� � $� $��K� � �L�L��s� #� �M�M�#� �
�K�K�0�-�K� H��
�a�4�
�M�M�%� �� � � /�0�A� �a�4� �M�M�(� #�� � � /�0�A� �a�4� �M�M�-� (�� � � /�0�A� �a�4� �J�J�L� �!I�J� J�
�a�4� �J�J�L� �!P�Q� Q�
��T� �
��T�
�J�J�L� �!3�4� 4�
��T� �J�J�L� �!4�5� 5�
��T� �J�J�L� �!Q�R� R�
��T�
�
��T� �J�J�L� �!4�5� 5� �J�J�L� �!<�=� =� ��,�,�_�=�=��
�
� �$�%Q�R�R� ��)�)�+�+��
�
� �$�)-���d�k�k�&D� E� E� ��{ Z��f ;� (�'�s$ � U9
�=V�U?�*V�?V�
Vc �� � U R S5 U R [ S/5 nUS:X a& U R S5 U R [ 5 U R 5 g)zeSends exit to the remote shell.
If there are stopped jobs then this automatically sends exit twice.
�exitz(?i)there are stopped jobsr9 N)rZ r� r r� )r6 �indexs r �logout� pxssh.logout� sL � �
�
�
�f� �� � �S�">� ?�@�� �!�8� �M�M�&� !� �K�K�� � �
�
� r c �v � US:X a U R nU R U R [ /US9nUS:X a gg)aN Match the next shell prompt.
This is little more than a short-cut to the :meth:`~pexpect.spawn.expect`
method. Note that if you called :meth:`login` with
``auto_prompt_reset=False``, then before calling :meth:`prompt` you must
set the :attr:`PROMPT` attribute to a regex that it will use for
matching the prompt.
Calling :meth:`prompt` will erase the contents of the :attr:`before`
attribute even if no prompt is ever matched. If timeout is not given or
it is set to -1 then self.timeout is used.
:return: True if the shell prompt was matched, False if the timeout was
reached.
���rs r9 FT)r r� r. r )r6 r rB s r rT � pxssh.prompt� s< � �" �b�=��l�l�G� �K�K����g�.��K� @�� �a�4��r c � � U R S5 U R U R 5 U R [ U R /SS9nUS:X a� U R U R
5 U R [ U R /SS9nUS:X aB U R U R 5 U R [ U R /SS9nUS:X a gg)a This sets the remote prompt to something more unique than ``#`` or ``$``.
This makes it easier for the :meth:`prompt` method to match the shell prompt
unambiguously. This method is called automatically by the :meth:`login`
method, but you may want to call it manually if you somehow reset the
shell prompt. For example, if you 'su' to a different user then you
will need to manually reset the prompt. This sends shell commands to
the remote host to set the prompt, so this assumes the remote host is
ready to receive commands.
Alternatively, you may use your own prompt pattern. In this case you
should call :meth:`login` with ``auto_prompt_reset=False``; then set the
:attr:`PROMPT` attribute to a regular expression. After that, the
:meth:`prompt` method will try to match your prompt pattern.
zunset PROMPT_COMMANDre rs r FT)rZ r/ r� r r. r0 r1 )r6 rB s r r� �pxssh.set_unique_prompt� s� � �
�
�
�,�-� �
�
�d�(�(�)� �K�K�'�4�;�;�/��K� <�� ��6� �M�M�$�-�-� .�� � �W�d�k�k� 2�B� �?�A��A�v��
�
�d� 1� 1�2��K�K��$�+�+� 6��K�C����6� �r )
r. r0 r/ r1 r2 r- r4 r3 r, r5 )g �?)r� )r r
r r r r+ rH rW ra r� r� rT r� r r r r r r 4 s� � �?�B !#�D�4� �d��D�t� ��H�).��, �\�& �@$�R '+�R�v� '�r��"&��D� !�$� J� ��%)�d��
Y�v
��0r )r �pexpectr r r r rN r} �sysr� �__all__r � version_info�shlexr �compile�searchr r r r r �<module>r� sp ���, :� 9� � �
� � �W�
%���%� � ���f� ���:�:� /�0�7�7�L� 5�f�U� fr