([QhpddlZddlZddlZddlmZddlmZddlmZm Z  ddl Z dZ ddl Z dZGddZy#e $rdZ YwxYw#e $rdZY!wxYw) N)getpass)_sos) is_executableTIMEOUT_DEFAULTTFceZdZdZdZdZdZdZdZdZ dZ dZ dZ dZ dZdZdZdZdZdZdZdZdZdZdZdZdZdZdZid dd dd d d gdddddddddddd ddddddddddddddddiZd@dZdZdZ e!d Z"d!Z#d"Z$d#Z%d$Z&d%Z'd&Z(d'Z)d(Z*d)Z+d*Z,d+Z-dAd,Z.d-Z/d.Z0d/Z1d0Z2d1Z3d2Z4d3Z5d4Z6d5Z7d6Z8d7Z9dAd8Z:d9Z;dBd:Zd=Z?dCd>Z@ dDd?ZAy)E 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 UploadgenericN/zhttps://s3.amazonaws.com upload_filecase_id low_priorityFprofiles upload_urlupload_directory upload_user upload_pass upload_methodautoupload_no_ssl_verifyupload_protocolupload_s3_endpointupload_s3_regionupload_s3_bucketupload_s3_access_keyupload_s3_secret_keyupload_s3_object_prefix upload_targetcbtjd|_||_||_||_y)Nsos_ui)logging getLoggerui_logparsercmdlineargs)selfr$r&r%s =/usr/lib/python3/dist-packages/sos/upload/targets/__init__.py__init__zUploadTarget.__init__as)''1    cy)aSThis 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's r(check_distributionzUploadTarget.check_distributionhsr*c|jS)N)upload_target_idr-s r( get_target_idzUploadTarget.get_target_idrs$$$r*cf|jr |jS|jjS)z-Returns the upload target's name as a string.)upload_target_name__name__lower)clss r(namezUploadTarget.nameus,  ! !)) )||!!##r*c|jd|jd|jdj|jdjdS)N cmdlineoptspolicy)r9r:r r) hook_commonsr rr-s r( get_commonszUploadTarget.get_commons|sP,,];''1((7?? $ 1 1- @     r*c||_y)zMSet common host data for the Upload targets to reference N)commons)r'r>s r( set_commonszUploadTarget.set_commonss  r*c||_|j|_|jd}|jd}|jr|j |j |_|j |_|j|_|j|_ d|_ |j|_ |j|_ |j|_ |j|_|j|_|j |_|j"s|j$s|j'r0|j(dk(s!|j+|j-nO|j(dk(r@|j/|j1|j3|j5|j6j9dyyy)Nr9r:r s3)r;r<r>r_configure_low_priorityrrrrupload_passwordupload_archive_namerrrrrrbatchquietget_upload_urlrprompt_for_upload_userprompt_for_upload_passwordprompt_for_upload_s3_bucketprompt_for_upload_s3_endpointprompt_for_upload_s3_access_keyprompt_for_upload_s3_secret_keyr#info)r'r; cmdline_optsr:s r(pre_workzUploadTarget.pre_works('') ||M2 h'  $ $  * * , '11'33 , = =+77#% "."A"A , = =$0$E$E! , = ='3'K'K$$0$E$E!!!""""$$44<++-//1--5002224446446 KK  R #"r*c|js?d|jd|jd}tt ||_yy)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_keyget_upload_s3_bucketget_upload_s3_endpointinput_rr'msgs r(rLz,UploadTarget.prompt_for_upload_s3_access_keys[,,.--/01//12"6  ).af D %/r*c|js6d|jd|jd}t||_yy)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 rRrSN)get_upload_s3_secret_keyrUrVrrrYs r(rMz,UploadTarget.prompt_for_upload_s3_secret_keysW,,.--/01//12"6  )0 D % /r*c|jsq|jr;|jjdr |jdd|_|jStt d}|j d|_|jS)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 )rr startswithrWrXstrip)r' user_inputs r(rJz(UploadTarget.prompt_for_upload_s3_bucketsw$$4??#=#=g#F(,(;%$$$#1%I#JK (2(8(8(=%$$$r*c|j}|js6d|jd|d}tt |}|xs||_|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_endpointrrUrWrX)r'default_endpointrZrbs r(rKz*UploadTarget.prompt_for_upload_s3_endpointsk 33&&--/0./s4  qvJ&0&D4DD #&&&r*c|js.d|jd}tt||_yy)zcShould be overridden by targets to determine if a user needs to be provided or not zPlease provide upload user for rSN)get_upload_userrGrWrXrrYs r(rHz#UploadTarget.prompt_for_upload_users=##%3D4G4G4I3J"MC$QsV}D &r*c|jsC|j|jk7r%d|jd}t||_yyy)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 rSN)get_upload_passwordrg _upload_userrrCrYs r(rIz'UploadTarget.prompt_for_upload_passwordsZ'')t/C/C/E/3/@/@0A<**,-R1C#*3rrrlsplit)r'protsprotrXs r(rmz#UploadTarget._determine_upload_type3s??$$&&..   << & 6 6% ?m4DDE E  'AB B//''.a u DTFKL LT{r*c|s|j}|s|j}tjj ||S)ahFormats 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()`` )rgrirequestsauth HTTPBasicAuth)r'userpasswords r(get_upload_https_authz"UploadTarget.get_upload_https_authIs='')D//1H}}**4::r*cftjddxs|jxs |jS)zHelper 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`` SOSUPLOADS3ACCESSKEYN)osgetenvr_upload_s3_access_keyr-s r(rTz%UploadTarget.get_upload_s3_access_key\4 0$7+))+** ,r*cR|js|j|jS)zHelper 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`` )rrKr-s r(rVz#UploadTarget.get_upload_s3_endpointgs%&&  . . 0&&&r*c6|jxs |jS)zHelper 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-s r(get_upload_s3_regionz!UploadTarget.get_upload_s3_regionrs$$>(>(>>r*c>|jr\|jjdrA|jddjdd}|d|_t |dkDr |d|_|js|j |jxs |jS)zHelper 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`` r^r_Nr r)rr`rzrlenrrJ_upload_s3_bucket)r'bucket_and_prefixs r(rUz!UploadTarget.get_upload_s3_bucket{s ??t99'B $ 3 9 9#q A $5a$8D !$%)/@/C,$$  , , .$$>(>(>>r*c6|jxs |jS)zHelper 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-s r(get_upload_s3_object_prefixz(UploadTarget.get_upload_s3_object_prefixs++Lt/L/LLr*cftjddxs|jxs |jS)zHelper 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`` SOSUPLOADS3SECRETKEYN)rrr_upload_s3_secret_keyr-s r(r\z%UploadTarget.get_upload_s3_secret_keyrr*c|jsQ|jrE|jr9|jr-|j }|j }d|d||_|jxs |j S)zHelper 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`` r^r )rrrrrUr _upload_url)r'bucketprefixs r(rGzUploadTarget.get_upload_urlsl  ! !  % %  % %..0F557F!&vhax8D 2$"2"22r*c8d}tj|d|}|S)Nz([^:]+://[^:]+:)([^@]+)(@.+)z \1********\3)resub)r'urlpatternobfuscated_urls r(_get_obfuscated_upload_urlz'UploadTarget._get_obfuscated_upload_urls1#>r*c@|j|jS)zUsed by upload targets to potentially change the string used to report upload location from the URL to a more human-friendly string )rrGr-s r(rnz"UploadTarget.get_upload_url_strings..t/B/B/DEEr*cftjddxs|jxs |jS)zHelper 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`` SOSUPLOADUSERN)rrrrjr-s r(rgzUploadTarget.get_upload_users3 /40"  "!! #r*cftjddxs|jxs |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`` SOSUPLOADPASSWORDN)rrrC_upload_passwordr-s r(riz UploadTarget.get_upload_passwords4 -t4&$$&%% 'r*c8tds td ddl}d}|s|j }|s|j }|j jdd}d |d |}|j|d }d dd|j|jg} |j| d} | dk(rd}n| dk(ro|j|d d|j|jg} |j| ddk(}|s|jtd|j| dk(rtd|jd| dk(rtd|j| dk(rtd|j|s,|jtd|jd|j d |j#} |j| d!|j|jd"g} |j| d#}|dk(r|jd$y|dk(r td%|dk(rtd&|j|dk(r td'td(|j#t$r}td|d}~wwxYw))aAttempts 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. rtzSFTP is not locally supportedrNzFSFTP upload requires python3-pexpect, which is not currently installedFzsftp://r z sftp -oStrictHostKeyChecking=no @zutf-8)encodingzsftp>z password:zConnection refusedtimeoutTrzPermission 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: zUnable to connect via SFTP to zput  z100%zNo such file or directorybyezTimeout expired while uploadingzUnknown error during upload: z&Unable to write archive to destinationz!Unexpected response from server: )rrlpexpect ImportErrorrgrirGreplacespawnTIMEOUTEOFexpectsendlineclosernbeforerD_get_sftp_upload_name)r'rrrerrsftp_connectedsftp_urlsftp_cmdret sftp_expectsidx pass_expectsput_cmd put_expects put_successs r(rwzUploadTarget.upload_sftpsV$;< <  @  '')D//1H&&(00B?5dV1XJGmmHwm7   OO KK  jjrj2 !8!N AX LL "# L !ZZ bZAQFN!  E#'#=#=#?"@!BCC AX4#99;<? ? AXJ"zzl,- - IIK<#99;<>? ?$223100235 W  OO KK '  jjcj: !  LL  ! => > ! ;CJJ<HI I ! DE E;CJJ<HII] @67E r*cvtj|j||j|tS)zIf 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 )datarverifyr)r~putrGrr)r'rors r(_upload_https_putzUploadTarget._upload_https_putDs5||D//1!%!;!;!=#)?D Dr*ciS)zJDefine any needed headers to be passed with the POST request here r,r-s r(_get_upload_headersz UploadTarget._get_upload_headersOs  r*cd|jjdd||jfi}tj|j ||j |tS)zIf 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)filesrrr)r7rzrr~postrGrr)r'rorrs r(_upload_https_postzUploadTarget._upload_https_postTsj W\\'',R0'--/1 }}T002%"&"<"<">$*OE Er*c&ts tdt|jd5}|jdj dk(r |j }n|jdj }|jdjdu}|dk(r|j||}n|j||}|jdvr?|jdk(r td td |jd |j d d d y #1swYy xYw)zAttempts 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 libraryrbr9rFr)iz/Authentication failed: invalid user credentialszPOST request returned rSNT) REQUESTS_LOADEDrlopenrDr>r_upload_methodrrr status_codereason)r'arcmethodrrs r(rxzUploadTarget.upload_httpscs&' '$**D 1 S||M*88FB,,m4BB\\-0EENF**37++C8}}J.==C'#I "8r#$88*!.//#   s CDDcddl}ddl}|s|j}| td|j dd}|s|j }|s|j }|s|jxs |j} |j|||d}|s td|j|t!|j"d5} |j%d|j"jdd| ddd|j'y#|j$r}td ||d}~w|j$r}td ||d}~w|j$rw}t|jd} | d k(rtd |d || dk(rtd|d || dk(rtd||tdt||d}~wwxYw#1swYxYw)aTAttempts 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 rNzPno FTP server specified by upload target, use --upload-url to specify a locationzftp://r rrz3connection failed, did you set a user and password?z timeout hit while connecting to zunable to connect to 503zcould not login as ''530zinvalid password for user '550z"could not set upload directory to z#error trying to establish session: rzSTOR r rT)ftplibsocketrGrlrrgrir_upload_directoryFTPcwdrgaierror error_permstrrzrrD storbinaryquit) r'r directoryrrrrsessionrerrno_arcfiles r(rvzUploadTarget.upload_ftps* %%'C ;EF Fkk(B''')D//1H--G1G1GI jjdHbjAG!,-- KK ""$**D 1 X   0066s;B?@A8    +~~ O>seDE3 N D3C59: C  HNN$Q'E~"6tfA >?SH~"=dV1 EFCO~ D#,+!/0589A#c(LM    s=;3D2GGD--G?EG A2GGG#cts td|s|j}|s|j}|s|j j d}|sJ|j }|dk7r|jdr|dd}|dk7r|jds |r|dnd}|s|j}|s|j}tjd||||} ||jjddz}|j|j||y #t$r} td t!| | d} ~ wwxYw) aAttempts 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 rNrA) endpoint_url region_nameaws_access_key_idaws_secret_access_keyrTzFailed to upload to S3: ) BOTO3_LOADEDrlrVrrUrarr`endswithrTr\boto3clientrDrzr r) r'endpointregionrr access_key secret_key s3_clientkeyes r(ryzUploadTarget.upload_s3sW6&' '224H..0F..066s;F557F| 1 1# 6|FOOC$8)/F81R668J668JLLH-33=7AC  H43399#>rBBC  ! !$":":"(# / H6s1vh?@a G Hs">D!! E*EE)NNN)NN)T)NNNN)NNNNNN)Br4 __module__ __qualname____doc__descr3r0 _upload_filerrrjrrrdrrrrrrrrCrrrrrrr arg_defaultsr)r.r1 classmethodr7r<r?rPrLrMrJrKrHrIrqrmrrTrVrrUrr\rGrrnrgrirwrrrrrxrvryr,r*r(rr sG D* LKLN4  !JKO"Mr2  B  d  D  t t   6 d D D  !" "4#$ %L*%$$   (!T 6 5 % '-06p,;& , '?? M ,3" F # 'aJF  D E>DLIM.2?Hr*r)rrr!rsosrrX sos.utilitiesrrr~rrrrrr,r*r(rsl 8OL g Hg HO Ls :AAAAA