Current File : //lib/python3.9/site-packages/sos/upload/targets/__pycache__/__init__.cpython-39.pyc
a
K�h�p � @ s� d dl Z d dlZd dlZd dlmZ d dlmZ d dlmZm Z zd dl
Z
dZ W n e yf dZ Y n0 zd dl
Z
dZW n e y� dZY n0 G dd� d�ZdS ) � N)�getpass)�_sos)�
is_executable�TIMEOUT_DEFAULTTFc @ s� e Zd ZdZdZdZdZdZdZdZ dZ
dZ dZ dZ
dZdZdZdZdZdZdZdZdZdZdZdZdZdZdZ ddd g ddddd
d d
dddddddd �Z dSd d
�Z dd� Z dd� Z e!dd� �Z"dd� Z#dd� Z$dd� Z%dd� Z&d d � Z'd d � Z(d d!� Z)d"d#� Z*d$d%� Z+d&d'� Z,d(d)� Z-dTd*d+�Z.d,d-� Z/d.d/� Z0d0d1� Z1d2d3� Z2d4d5� Z3d6d7� Z4d8d9� Z5d:d;� Z6d<d=� Z7d>d?� Z8d@dA� Z9dUdBdC�Z:dDdE� Z;dVdGdH�Z<dIdJ� Z=dWdKdL�Z>dMdN� Z?dXdOdP�Z@dYdQdR�ZAdS )Z� UploadTargetz�
This class is designed to upload files to a distribution
defined location. These files can be either sos reports,
sos collections, or other kind of files like: vmcores,
application cores, logs, etc.
z�
Upload a file (can be an sos report, a must-gather, or others) to
a distribution defined remote location
zGeneric UploadZgenericN�/zhttps://s3.amazonaws.com� F�auto)� upload_file�case_id� low_priorityZprofiles�
upload_url�upload_directory� upload_user� upload_pass�
upload_method�upload_no_ssl_verify�upload_protocol�upload_s3_endpoint�upload_s3_region�upload_s3_bucket�upload_s3_access_key�upload_s3_secret_key�upload_s3_object_prefix�
upload_targetc C s" t �d�| _|| _|| _|| _d S )NZsos_ui)�loggingZ getLogger�ui_log�parser�cmdline�args)�selfr r r � r! �?/usr/lib/python3.9/site-packages/sos/upload/targets/__init__.py�__init__a s zUploadTarget.__init__c C s dS )aS This should be overridden by upload targets
This is called by sos upload on each target type that exists, and
is meant to return True when the upload target matches a criteria
that indicates that is the local upload target that should be used.
Only the first upload target to determine a match is selectedFr! �r r! r! r" �check_distributionh s z UploadTarget.check_distributionc C s | j S )N)�upload_target_idr$ r! r! r" �
get_target_idr s zUploadTarget.get_target_idc C s | j r | j S | j�� S )z-Returns the upload target's name as a string.)�upload_target_name�__name__�lower)�clsr! r! r" �nameu s zUploadTarget.namec C s* | j d | j d | j d j| j d jd�S )N� cmdlineopts�policy)r- r. r r )� hook_commonsr r r$ r! r! r" � get_commons| s
�zUploadTarget.get_commonsc C s
|| _ dS )zMSet common host data for the Upload targets
to reference
N)�commons)r r1 r! r! r" � set_commons� s zUploadTarget.set_commonsc C s� || _ | �� | _| jd }| jd }|jr2|�� |j| _|j| _|j| _|j| _ d| _
|j | _ |j | _ |j
| _
|j| _|j| _|j| _|js�|js�| �� r�|jdks�| �� | �� n*|jdkr�| �� | �� | �� | �� | j� d� d S )Nr- r. r �s3) r/ r0 r1 r Z_configure_low_priorityr
r r r �upload_password�upload_archive_namer r r r r r Zbatch�quiet�get_upload_urlr �prompt_for_upload_user�prompt_for_upload_password�prompt_for_upload_s3_bucket� prompt_for_upload_s3_endpoint� prompt_for_upload_s3_access_key� prompt_for_upload_s3_secret_keyr �info)r r/ Z cmdline_optsr. r! r! r" �pre_work� s>
��
zUploadTarget.pre_workc C s4 | � � s0d| �� � d| �� � d�}tt|��| _dS )zuShould be overridden by targets to determine if an access key needs
to be provided for upload or not
z0Please provide the upload access key for bucket � via endpoint �: N)�get_upload_s3_access_key�get_upload_s3_bucket�get_upload_s3_endpoint�input�_r �r �msgr! r! r" r< � s ���z,UploadTarget.prompt_for_upload_s3_access_keyc C s0 | � � s,d| �� � d| �� � d�}t|�| _dS )ztShould be overridden by targets to determine if a secret key needs
to be provided for upload or not
z0Please provide the upload secret key for bucket r@ rA N)�get_upload_s3_secret_keyrC rD r r rG r! r! r" r= � s ���z,UploadTarget.prompt_for_upload_s3_secret_keyc C sH | j sB| jr*| j�d�r*| jdd� | _ nttd��}|�d�| _ | j S )zpShould be overridden by targets to determine if a bucket needs to
be provided for upload or not
�s3://� Nz"Please provide the upload bucket: r )r r
�
startswithrE rF �strip)r �
user_inputr! r! r" r: � s z(UploadTarget.prompt_for_upload_s3_bucketc C s> | j }| js8d| �� � d|� d�}tt|��}|p4|| _| jS )zsShould be overridden by targets to determine if an endpoint needs
to be provided for upload or not
z.Please provide the upload endpoint for bucket z (default: z): )�_upload_s3_endpointr rC rE rF )r Zdefault_endpointrH rN r! r! r" r; � s ���
z*UploadTarget.prompt_for_upload_s3_endpointc C s* | � � s&d| �� � d�}tt|��| _dS )zcShould be overridden by targets to determine if a user needs to
be provided or not
z Please provide upload user for rA N)�get_upload_userr7 rE rF r rG r! r! r" r8 � s z#UploadTarget.prompt_for_upload_userc C s4 | � � s0| �� | jkr0d| �� � d�}t|�| _dS )zrShould be overridden by targets to determine if a password needs to
be provided for upload or not
z'Please provide the upload password for rA N)�get_upload_passwordrP � _upload_userr r4 rG r! r! r" r9 � s ��z'UploadTarget.prompt_for_upload_passwordc C sL || _ | js| �� | _| js$td��| �� }| j�td| �� � ��� |� S )a
Entry point for sos attempts to upload the generated archive to a
target or user specified location.
Currently there is support for HTTPS, SFTP, and FTP. HTTPS uploads are
preferred for target-defined defaults.
Targets that need to override uploading methods should override the
respective upload_https(), upload_sftp(), and/or upload_ftp() methods
and should NOT override this method.
:param archive: The archive filepath to use for upload
:type archive: ``str``
In order to enable this for a target, that target needs to implement
the following:
Required Class Attrs
:_upload_url: The default location to use. Note these MUST include
protocol header
:_upload_user: Default username, if any else None
:_upload_password: Default password, if any else None
The following Class Attrs may optionally be overidden by the Target
:_upload_directory: Default FTP server directory, if any
The following methods may be overridden by ``Target`` as needed
`prompt_for_upload_user()`
Determines if sos should prompt for a username or not.
`get_upload_user()`
Determines if the default or a different username should be used
`get_upload_https_auth()`
Format authentication data for HTTPS uploads
`get_upload_url_string()`
Print a more human-friendly string than vendor URLs
zBNo upload destination provided by upload target or by --upload-urlzAttempting upload to ) r5 r
r7 � Exception�_determine_upload_typer r> rF �get_upload_url_string)r �archiveZ upload_funcr! r! r" �upload_archive� s ,
�zUploadTarget.upload_archivec C sv | j | j| j| jd�}| jd j|v r6|| jd j S d| jvrHtd��| j�d�\}}||vrntd|� ���|| S )a Based on the url provided, determine what type of upload to attempt.
Note that this requires users to provide a FQDN address, such as
https://myvendor.com/api or ftp://myvendor.com instead of
myvendor.com/api or myvendor.com
)�ftp�sftp�httpsr3 r- z://z#Must provide protocol in upload URLz&Unsupported or unrecognized protocol: ) �
upload_ftp� upload_sftp� upload_https� upload_s3r1 r r
rS �split)r ZprotsZprotrF r! r! r" rT 3 s �
z#UploadTarget._determine_upload_typec C s& |s | � � }|s| �� }tj�||�S )ah Formats the user/password credentials using basic auth
:param user: The username for upload
:type user: ``str``
:param password: Password for `user` to use for upload
:type password: ``str``
:returns: The user/password auth suitable for use in requests calls
:rtype: ``requests.auth.HTTPBasicAuth()``
)rP rQ �requests�authZ
HTTPBasicAuth)r �user�passwordr! r! r" �get_upload_https_authI s
z"UploadTarget.get_upload_https_authc C s t �dd�p| jp| jS )z�Helper function to determine if we should use the target default
upload access key or one provided by the user
:returns: The access_key to use for upload
:rtype: ``str``
ZSOSUPLOADS3ACCESSKEYN)�os�getenvr �_upload_s3_access_keyr$ r! r! r" rB \ s
��z%UploadTarget.get_upload_s3_access_keyc C s | j s| �� | j S )z�Helper function to determine if we should use the target default
upload endpoint or one provided by the user
:returns: The S3 Endpoint to use for upload
:rtype: ``str``
)r r; r$ r! r! r" rD g s z#UploadTarget.get_upload_s3_endpointc C s | j p
| jS )z�Helper function to determine if we should use the target default
upload region or one provided by the user
:returns: The S3 region to use for upload
:rtype: ``str``
)r �_upload_s3_regionr$ r! r! r" �get_upload_s3_regionr s z!UploadTarget.get_upload_s3_regionc C sb | j rH| j �d�rH| j dd� �dd�}|d | _t|�dkrH|d | _| jsV| �� | jp`| jS )z�Helper function to determine if we should use the target default
upload bucket or one provided by the user
:returns: The S3 bucket to use for upload
:rtype: ``str``
rJ rK Nr � r )r
rL r_ r �lenr r: �_upload_s3_bucket)r Zbucket_and_prefixr! r! r" rC { s
z!UploadTarget.get_upload_s3_bucketc C s | j p
| jS )z�Helper function to determine if we should use the target default
upload object prefix or one provided by the user
:returns: The S3 object prefix to use for upload
:rtype: ``str``
)r �_upload_s3_object_prefixr$ r! r! r" �get_upload_s3_object_prefix� s z(UploadTarget.get_upload_s3_object_prefixc C s t �dd�p| jp| jS )z�Helper function to determine if we should use the target default
upload secret key or one provided by the user
:returns: The S3 secret key to use for upload
:rtype: ``str``
ZSOSUPLOADS3SECRETKEYN)re rf r �_upload_s3_secret_keyr$ r! r! r" rI � s
��z%UploadTarget.get_upload_s3_secret_keyc C sF | j s:| jr:| jr:| jr:| �� }| �� }d|� d|� �| _| j pD| jS )z�Helper function to determine if we should use the target default
upload url or one provided by the user
:returns: The URL to use for upload
:rtype: ``str``
rJ r )r
r r r rC rn � _upload_url)r �bucket�prefixr! r! r" r7 � s ���zUploadTarget.get_upload_urlc C s d}t �|d|�}|S )Nz ([^:]+://[^:]+:)([^@]+)(@.+)z \1********\3)�re�sub)r �url�patternZobfuscated_urlr! r! r" �_get_obfuscated_upload_url� s z'UploadTarget._get_obfuscated_upload_urlc C s | � | �� �S )z�Used by upload targets to potentially change the string used to
report upload location from the URL to a more human-friendly string
)rw r7 r$ r! r! r" rU � s z"UploadTarget.get_upload_url_stringc C s t �dd�p| jp| jS )z�Helper function to determine if we should use the target default
upload user or one provided by the user
:returns: The username to use for upload
:rtype: ``str``
Z
SOSUPLOADUSERN)re rf r rR r$ r! r! r" rP � s
��z UploadTarget.get_upload_userc C s t �dd�p| jp| jS )a_ Helper function to determine if we should use the target default
upload password or one provided by the user
A user provided password, either via option or the 'SOSUPLOADPASSWORD'
environment variable will have precendent over any target value
:returns: The password to use for upload
:rtype: ``str``
ZSOSUPLOADPASSWORDN)re rf r4 �_upload_passwordr$ r! r! r" rQ � s
��z UploadTarget.get_upload_passwordc
C s< t d�std��z ddl}W n. tyJ } ztd�|�W Y d}~n
d}~0 0 d}|s\| �� }|sh| �� }| �� �dd�}d |� d
|� �}|j|d d �}d
dd|j |j
g} |j | dd�}
|
dkr�d}n�|
dk�r |� |� d
d|j |j
g} |j | dd�dk}|�st|�
� td| �� � ���nX|
dk�r<td| �� � d���n8|
dk�rZtd| �� � ���n|
d k�rttd |j� ���|�s�|�
� td | �� � ���d | j� d | �� � �} |� | � d!|j |j
d"g}
|j |
d#d�}|dk�r�|� d$� dS |dk�r�td%��|dk�rtd&|j� ���|dk�r(td'��td(|j� ���dS ))a� Attempts to upload the archive to an SFTP location.
Due to the lack of well maintained, secure, and generally widespread
python libraries for SFTP, sos will shell-out to the system's local ssh
installation in order to handle these uploads.
Do not override this method with one that uses python-paramiko, as the
upstream sos team will reject any PR that includes that dependency.
rY z SFTP is not locally supportedr NzFSFTP upload requires python3-pexpect, which is not currently installedFzsftp://r z sftp -oStrictHostKeyChecking=no �@zutf-8)�encodingzsftp>z password:zConnection refused� ��timeoutTrj zPermission denied�
z#Incorrect username or password for � zConnection refused by z. Incorrect port?� z!Timeout hit trying to connect to � z,Unexpected error trying to connect to sftp: z Unable to connect via SFTP to zput � z100%zNo such file or directory� Zbyez Timeout expired while uploadingz Unknown error during upload: z&Unable to write archive to destinationz!Unexpected response from server: )r rS �pexpect� ImportErrorrP rQ r7 �replaceZspawnZTIMEOUTZEOF�expectZsendline�closerU �beforer5 �_get_sftp_upload_name)r rb rc r� �errZsftp_connectedZsftp_urlZsftp_cmd�retZ sftp_expects�idxZ pass_expectsZput_cmdZ put_expectsZ put_successr! r! r" r\ � s� ��
��
�
�
��
�
�
zUploadTarget.upload_sftpc C s* | j �d�d }| jr&tj�| j|�}|S )a$ If a specific file name pattern is required by the SFTP server,
override this method in the relevant Upload Target. Otherwise the
archive's name on disk will be used
:returns: Filename as it will exist on the SFTP server
:rtype: ``str``
r ���)r5 r_ r re �path�join)r �fnamer! r! r" r� 7 s z"UploadTarget._get_sftp_upload_nameTc C s t j| �� || �� |td�S )z�If upload_https() needs to use requests.put(), use this method.
Targets should override this method instead of the base upload_https()
:param archive: The open archive file object
)�datara �verifyr} )r` �putr7 rd r )r rV r� r! r! r" �_upload_https_putD s �z UploadTarget._upload_https_putc C s i S )zJDefine any needed headers to be passed with the POST request here
r! r$ r! r! r" �_get_upload_headersO s z UploadTarget._get_upload_headersc C s: d|j �d�d || �� fi}tj| �� || �� |td�S )z�If upload_https() needs to use requests.post(), use this method.
Targets should override this method instead of the base upload_https()
:param archive: The open archive file object
�filer r� )�filesra r� r} )r, r_ r� r` Zpostr7 rd r )r rV r� r� r! r! r" �_upload_https_postT s �� �z UploadTarget._upload_https_postc C s� t s td��t| jd���}| jd jdkr2| j}n | jd j}| jd jdu }|dkrd| �||�}n | � ||�}|j
dvr�|j
dkr�td ��td
|j
� d |j � ���W d � d
S 1 s�0 Y d S )z�Attempts to upload the archive to an HTTPS location.
:returns: ``True`` if upload is successful
:rtype: ``bool``
:raises: ``Exception`` if upload was unsuccessful
z7Unable to upload due to missing python requests library�rbr- r Fr� )�� �� i� z/Authentication failed: invalid user credentialszPOST request returned rA NT) �REQUESTS_LOADEDrS �openr5 r1 r �_upload_methodr r� r� Z status_code�reason)r Zarc�methodr� �rr! r! r" r] c s&
� �zUploadTarget.upload_httpsc
C s� ddl }ddl}|s | �� }|du r,td��|�dd�}|sD| �� }|sP| �� }|s`| jp^| j}z.|j |||dd�}|s�td��|�
|� W �n |j y� } z td |� ��|�W Y d}~n�d}~0 |j y� } z td
|� ��|�W Y d}~n�d}~0 |j
�y� } z�t|��� d } | d k�r6td |� d
��|�| dk�rRtd|� d
��|�| dk�rltd|� ��|�tdt|�� ��|�W Y d}~n
d}~0 0 t| jd��.}
|�d| j�d�d � �|
� W d � n1 �s�0 Y |�� dS )aT Attempts to upload the archive to either the target defined or user
provided FTP location.
:param url: The URL to upload to
:type url: ``str``
:param directory: The directory on the FTP server to write to
:type directory: ``str`` or ``None``
:param user: The user to authenticate with
:type user: ``str``
:param password: The password to use for `user`
:type password: ``str``
:returns: ``True`` if upload is successful
:rtype: ``bool``
:raises: ``Exception`` if upload in unsuccessful
r NzPno FTP server specified by upload target, use --upload-url to specify a locationzftp://r r{ r| z3connection failed, did you set a user and password?z timeout hit while connecting to zunable to connect to Z503zcould not login as '�'Z530zinvalid password for user 'Z550z"could not set upload directory to z#error trying to establish session: r� zSTOR r r� T)�ftplib�socketr7 rS r� rP rQ r �_upload_directoryZFTP�cwdr} ZgaierrorZ
error_perm�strr_ r� r5 Z
storbinary�quit) r ru Z directoryrb rc r� r� Zsessionr� �errnoZ_arcfiler! r! r" r[ � sV $$
����$zUploadTarget.upload_ftpc
C s t s td��|s| �� }|s$| �� }|s6| �� �d�}|s�| �� }|dkr`|�d�r`|dd� }|dkr�|�d�s�|r�|� d�nd}|s�| � � }|s�| �
� }t j d||||d�}z*|| j
�d�d }|�| j
||� W d S t�y } z td
t| �� ��| �W Y d} ~ n
d} ~ 0 0 dS ) a� Attempts to upload the archive to an S3 bucket.
:param endpoint: The S3 endpoint to upload to
:type endpoint: str
:param region: The S3 region to upload to
:type region: str
:param bucket: The name of the S3 bucket to upload to
:type bucket: str
:param prefix: The prefix for the S3 object/key
:type prefix: str
:param access_key: The access key for the S3 bucket
:type access_key: str
:param secret_key: The secret key for the S3 bucket
:type secret_key: str
:returns: True if upload is successful
:rtype: bool
:raises: Exception if upload is unsuccessful
z4Unable to upload due to missing python boto3 libraryr r rj Nr3 )Z endpoint_urlZ region_nameZaws_access_key_idZaws_secret_access_keyr� TzFailed to upload to S3: )� BOTO3_LOADEDrS rD ri rC rM rn rL �endswithrB rI �boto3Zclientr5 r_ r
r� )
r ZendpointZregionrq rr Z
access_keyZ
secret_keyZ s3_client�key�er! r! r" r^ � s> ��zUploadTarget.upload_s3)NNN)NN)NN)T)T)NNNN)NNNNNN)Br) �
__module__� __qualname__�__doc__Zdescr( r& Z _upload_filerp r� rR rx r� rO rl rg ro rh rm r
r r4 r r r r r r r Z arg_defaultsr# r% r' � classmethodr, r0 r2 r? r< r= r: r; r8 r9 rW rT rd rB rD ri rC rn rI r7 rw rU rP rQ r\ r� r� r� r� r] r[ r^ r! r! r! r" r s�
�
*
8
c
F �r )re rs r r Zsosr rF Z
sos.utilitiesr r r` r� r� r� r� r r! r! r! r" �<module> s
Mini Shell