U TgO@sdZddlmZddlZddlZddlmZmZm Z ddl m Z ddl m Z ddlmZmZmZddlmZdd lmZmZmZdd lmZdd lmZmZmZdd lmZdd l m!Z!ddl"m#Z#ddl$m%Z%ddl&m'Z'ddl(m)Z)ddl*m+Z+e#Z,ddZ-ddZ.GdddZ/eeGddde/Z0eeGdddZ1ddZ2eeGdd d e/e+Z3Gd!d"d"Z4Gd#d$d$Z5dS)%zE An implementation of the OpenSSH known_hosts database. @since: 8.2 ) annotationsN)Error a2b_base64 b2a_base64)closing)sha1)IOCallableLiteral) implementer)HostKeyChanged InvalidEntryUserRejectedKey)IKnownHostEntry) BadKeyErrorFingerprintFormatsKey)defer)Deferred)Logger) nativeString)FilePath) secureRandom) FancyEqMixincCs t|S)z Encode a binary string as base64 with no trailing newline. @param s: The string to encode. @type s: L{bytes} @return: The base64-encoded string. @rtype: L{bytes} )rstrip)srC/tmp/pip-unpacked-wheel-1_7di8ic/twisted/conch/client/knownhosts.py _b64encode$s rc Csz|dd}t|dkrt|\}}}|dd}t|dkrT|\}}|d}n |d}d}tt|}||||fS)a Extract common elements of base64 keys from an entry in a hosts file. @param string: A known hosts file entry (a single line). @type string: L{bytes} @return: a 4-tuple of hostname data (L{bytes}), ssh key type (L{bytes}), key (L{Key}), and comment (L{bytes} or L{None}). The hostname data is simply the beginning of the line up to the first occurrence of whitespace. @rtype: L{tuple} N r)splitlenr rstripr fromStringr) stringelements hostnameskeyTypeZ keyAndCommentZsplitkeyZ keyStringcommentkeyrrr_extractCommon1s      r-c@s eZdZdZddZddZdS) _BaseEntrya Abstract base of both hashed and non-hashed entry objects, since they represent keys and key types the same way. @ivar keyType: The type of the key; either ssh-dss or ssh-rsa. @type keyType: L{bytes} @ivar publicKey: The server public key indicated by this line. @type publicKey: L{twisted.conch.ssh.keys.Key} @ivar comment: Trailing garbage after the key line. @type comment: L{bytes} cCs||_||_||_dSN)r* publicKeyr+)selfr*r0r+rrr__init__\sz_BaseEntry.__init__cCs |j|kS)a Check to see if this entry matches a given key object. @param keyObject: A public key object to check. @type keyObject: L{Key} @return: C{True} if this entry's key matches C{keyObject}, C{False} otherwise. @rtype: L{bool} )r0)r1Z keyObjectrrr matchesKeyas z_BaseEntry.matchesKeyN)__name__ __module__ __qualname____doc__r2r3rrrrr.Msr.cs^eZdZdZdddddfdd Zedddd d Zd d d ddZddddZZ S) PlainEntryz A L{PlainEntry} is a representation of a plain-text entry in a known_hosts file. @ivar _hostnames: the list of all host-names associated with this entry. z list[bytes]bytesr)r)r*r0r+cs||_t|||dSr/) _hostnamessuperr2)r1r)r*r0r+ __class__rrr2xszPlainEntry.__init__r'returncCs(t|\}}}}||d|||}|S)a Parse a plain-text entry in a known_hosts file, and return a corresponding L{PlainEntry}. @param string: a space-separated string formatted like "hostname key-type base64-key-data comment". @raise DecodeError: if the key is not valid encoded as valid base64. @raise InvalidEntry: if the entry does not have the right number of elements and is therefore invalid. @raise BadKeyError: if the key, once decoded from base64, is not actually an SSH key. @return: an IKnownHostEntry representing the hostname and key in the input line. @rtype: L{PlainEntry} ,)r-r#)clsr'r)r*r,r+r1rrrr&~szPlainEntry.fromStringz bytes | strbool)hostnamer?cCst|tr|d}||jkS)a Check to see if this entry matches a given hostname. @param hostname: A hostname or IP address literal to check against this entry. @return: C{True} if this entry is for the given hostname or IP address, C{False} otherwise. utf-8) isinstancestrencoder:r1rCrrr matchesHosts  zPlainEntry.matchesHostr?cCs>d|j|jt|jg}|jdk r4||jd|S)z Implement L{IKnownHostEntry.toString} by recording the comma-separated hostnames, key type, and base-64 encoded key. @return: The string representation of this entry, with unhashed hostname information. r@N )joinr:r*rr0blobr+appendr1fieldsrrrtoStrings    zPlainEntry.toString) r4r5r6r7r2 classmethodr&rIrQ __classcell__rrr<rr8os r8c@s0eZdZdZddZddZddZdd Zd S) UnparsedEntryz L{UnparsedEntry} is an entry in a L{KnownHostsFile} which can't actually be parsed; therefore it matches no keys and no hosts. cCs ||_dS)zv Create an unparsed entry from a line in a known_hosts file which cannot otherwise be parsed. N)_string)r1r'rrrr2szUnparsedEntry.__init__cCsdSz' Always returns False. FrrHrrrrIszUnparsedEntry.matchesHostcCsdSrVr)r1r,rrrr3szUnparsedEntry.matchesKeycCs |jdS)a Returns the input line, without its newline if one was given. @return: The string representation of this entry, almost exactly as was used to initialize this entry but without a trailing newline. @rtype: L{bytes} r")rUr%r1rrrrQszUnparsedEntry.toStringN)r4r5r6r7r2rIr3rQrrrrrTs rTcCs4tj|td}t|tr"|d}|||S)z Return the SHA-1 HMAC hash of the given key and string. @param key: The HMAC key. @type key: L{bytes} @param string: The string to be hashed. @type string: L{bytes} @return: The keyed hash value. @rtype: L{bytes} ) digestmodrD)hmacHMACrrErFrGupdatedigest)r,r'hashrrr _hmacedStrings    r^cs\eZdZdZdZdZdddddddfd d Zeddd d d ZddZ ddZ Z S) HashedEntrya A L{HashedEntry} is a representation of an entry in a known_hosts file where the hostname has been hashed and salted. @ivar _hostSalt: the salt to combine with a hostname for hashing. @ivar _hostHash: the hashed representation of the hostname. @cvar MAGIC: the 'hash magic' string used to identify a hashed line in a known_hosts file as opposed to a plaintext one. s|1|) _hostSalt _hostHashr*r0r+r9rz bytes | NoneNone)hostSalthostHashr*r0r+r?cs ||_||_t|||dSr/)r`rar;r2)r1rcrdr*r0r+r<rrr2szHashedEntry.__init__r>c Cs^t|\}}}}|t|jdd}t|dkr:t|\}}|t|t||||} | S)a Load a hashed entry from a string representing a line in a known_hosts file. @param string: A complete single line from a I{known_hosts} file, formatted as defined by OpenSSH. @raise DecodeError: if the key, the hostname, or the is not valid encoded as valid base64 @raise InvalidEntry: if the entry does not have the right number of elements and is therefore invalid, or the host/hash portion contains more items than just the host and hash. @raise BadKeyError: if the key, once decoded from base64, is not actually an SSH key. @return: The newly created L{HashedEntry} instance, initialized with the information from C{string}. N|r)r-r$MAGICr#r r) rAr'stuffr*r,r+Z saltAndHashrcrdr1rrrr&s zHashedEntry.fromStringcCstt|j||jS)a Implement L{IKnownHostEntry.matchesHost} to compare the hash of the input to the stored hash. @param hostname: A hostname or IP address literal to check against this entry. @type hostname: L{bytes} @return: C{True} if this entry is for the given hostname or IP address, C{False} otherwise. @rtype: L{bool} )rYcompare_digestr^r`rarHrrrrI-s  zHashedEntry.matchesHostcCsR|jdt|jt|jg|jt|jg}|jdk rH| |jd|S)z Implement L{IKnownHostEntry.toString} by base64-encoding the salt, host hash, and key. @return: The string representation of this entry, with the hostname part hashed. @rtype: L{bytes} reNrK) rfrLrr`rar*r0rMr+rNrOrrrrQ>s    zHashedEntry.toString) r4r5r6r7rfZcompareAttributesr2rRr&rIrQrSrrr<rr_s  r_c@seZdZdZdddddZedddd Zd d Zd d ZddddddddZ ddddddZ ddddZ e dddddZ dS)KnownHostsFileaz A structured representation of an OpenSSH-format ~/.ssh/known_hosts file. @ivar _added: A list of L{IKnownHostEntry} providers which have been added to this instance in memory but not yet saved. @ivar _clobber: A flag indicating whether the current contents of the save path will be disregarded and potentially overwritten or not. If C{True}, this will be done. If C{False}, entries in the save path will be read and new entries will be saved by appending rather than overwriting. @type _clobber: L{bool} @ivar _savePath: See C{savePath} parameter of L{__init__}. z FilePath[str]rb)savePathr?cCsg|_||_d|_dS)a$ Create a new, empty KnownHostsFile. Unless you want to erase the current contents of C{savePath}, you want to use L{KnownHostsFile.fromPath} instead. @param savePath: The L{FilePath} to which to save new entries. @type savePath: L{FilePath} TN)_added _savePath_clobber)r1rjrrrr2cs zKnownHostsFile.__init__rJcCs|jS)z< @see: C{savePath} parameter of L{__init__} )rlrWrrrrjqszKnownHostsFile.savePathc cs|jD] }|Vq|jrdSz|j}Wntk r@YdSX|`|D]T}z&|tjrjt|}n t |}Wn"t t t fk rt |}YnX|VqLW5QRXdS)aK Iterate over the host entries in this file. @return: An iterable the elements of which provide L{IKnownHostEntry}. There is an element for each entry in the file as well as an element for each added but not yet saved entry. @rtype: iterable of L{IKnownHostEntry} providers N)rkrmrlopenOSError startswithr_rfr&r8 DecodeErrorr rrT)r1entryfplinerrr iterentriesxs"   zKnownHostsFile.iterentriescCsxt|t|j D]\\}}||r|j|kr||rFdS|dkrXd}d}n|d}|j}t |||qdS)a Check for an entry with matching hostname and key. @param hostname: A hostname or IP address literal to check for. @type hostname: L{bytes} @param key: The public key to check for. @type key: L{Key} @return: C{True} if the given hostname and key are present in this file, C{False} if they are not. @rtype: L{bool} @raise HostKeyChanged: if the host key found for the given hostname does not match the given key. TrNr!F) enumeraterur$rkrIr*sshTyper3rlr )r1rCr,Zlineidxrrrtpathrrr hasHostKeys zKnownHostsFile.hasHostKey ConsoleUIr9rDeferred[bool])uirCipr,r?cs6tj}dddfdd }||S)a Verify the given host key for the given IP and host, asking for confirmation from, and notifying, the given UI about changes to this file. @param ui: The user interface to request an IP address from. @param hostname: The hostname that the user requested to connect to. @param ip: The string representation of the IP address that is actually being connected to. @param key: The public key of the server. @return: a L{Deferred} that fires with True when the key has been verified, or fires with an errback when the key either cannot be verified or has changed. @rtype: L{Deferred} rBzbool | Deferred[bool])resultr?cs|rRsNddd}|d|Sdddfdd }}|d krd }d tt|jt j d f} |t }||SdS) NzWarning: Permanently added the z host key for IP address 'z' to the list of known hosts. rDrB)responser?cs2|r(|StdSr/) addHostKeysaver)r)rCr}r,r1rrpromptResponses   zGKnownHostsFile.verifyHostKey..gotHasKey..promptResponseZECZECDSAzThe authenticity of host '%s (%s)' can't be established. %s key fingerprint is SHA256:%s. Are you sure you want to continue connecting (yes/no)? )format)rytypedecodewarnrGrrr fingerprintrZ SHA256_BASE64promptsysgetdefaultencoding addCallback)r~Z addMessagerZkeytyperproceedrCr}r,r1r|rr gotHasKeys,     z/KnownHostsFile.verifyHostKey..gotHasKey)rexecuteryr)r1r|rCr}r,Zhhkrrrr verifyHostKeys+zKnownHostsFile.verifyHostKeyr_)rCr,r?cCs6td}|}t|t||||d}|j||S)a Add a new L{HashedEntry} to the key database. Note that you still need to call L{KnownHostsFile.save} if you wish these changes to be persisted. @param hostname: A hostname or IP address literal to associate with the new entry. @type hostname: L{bytes} @param key: The public key to associate with the new entry. @type key: L{Key} @return: The L{HashedEntry} that was added. @rtype: L{HashedEntry} N)rrwr_r^rkrN)r1rCr,Zsaltr*rrrrrrs  zKnownHostsFile.addHostKeyc Csv|j}|s||jr$dnd}|j|2}|jrb|ddd|jDdg|_W5QRXd|_dS)zM Save this L{KnownHostsFile} to the path it was loaded from. war"cSsg|] }|qSr)rQ).0rrrrr sz'KnownHostsFile.save..FN) rlparentisdirmakedirsrmrnrkwriterL)r1pmodeZ hostsFileObjrrrrs zKnownHostsFile.save)rxr?cCs||}d|_|S)a Create a new L{KnownHostsFile}, potentially reading existing known hosts information from the given file. @param path: A path object to use for both reading contents from and later saving to. If no file exists at this path, it is not an error; a L{KnownHostsFile} with no entries is returned. @return: A L{KnownHostsFile} initialized with entries from C{path}. F)rm)rArxZ knownHostsrrrfromPath%s zKnownHostsFile.fromPathN)r4r5r6r7r2propertyrjruryrrrrRrrrrrriRs!Eric@s>eZdZdZddddZdddd d Zdd dd d ZdS)rzz A UI object that can ask true/false questions and post notifications on the console, to be used during key verification. zCallable[[], IO[bytes]]openercCs ||_dS)aA @param opener: A no-argument callable which should open a console binary-mode file-like object to be used for reading and writing. This initializes the C{opener} attribute. @type opener: callable taking no arguments and returning a read/write file-like object Nr)r1rrrrr2<szConsoleUI.__init__r9r{)textr?cs"td}fdd}||S)a Write the given text as a prompt to the console output, then read a result from the console input. @param text: Something to present to a user to solicit a yes or no response. @type text: L{bytes} @return: a L{Deferred} which fires with L{True} when the user answers 'yes' and L{False} when the user answers 'no'. It may errback if there were any I/O errors. Nc sntX}||}|dkr>W5QRdS|dkrTW5QRdS|dqW5QRXdS)NsyesT>noFsPlease type 'yes' or 'no': )rrrreadlinerlower)ZignoredfZanswerr1rrrbodyUs zConsoleUI.prompt..body)rZsucceedr)r1rdrrrrrFs  zConsoleUI.promptrbc CsJz&t|}||W5QRXWntk rDtdYnXdS)z Notify the user (non-interactively) of the provided text, by writing it to the console. @param text: Some information the user is to be made aware of. zFailed to write to consoleN)rrr ExceptionlogZfailure)r1rrrrrrcs zConsoleUI.warnN)r4r5r6r7r2rrrrrrrz6s rz)6r7 __future__rrYrbinasciirrqrr contextlibrhashlibrtypingrr r Zzope.interfacer Ztwisted.conch.errorr r rZtwisted.conch.interfacesrZtwisted.conch.ssh.keysrrrZtwisted.internetrZtwisted.internet.deferrZtwisted.loggerrZtwisted.python.compatrZtwisted.python.filepathrZtwisted.python.randbytesrZtwisted.python.utilrrrr-r.r8rTr^r_rirzrrrrs@             "H$`e