a  i; @sdZddlZddlZddlZddlZddlZddlZddlmZddl m Z d\Z Z z ddl Z Wn(e yZzeZ WYdZ[n dZ[00ddlmZmZdZGd d d eZd d ZGd ddeZGdddeZdS)z2 Configuration file (aka ``ssh_config``) support. N)partial)StringIO)NN)CouldNotCanonicalizeConfigParseErrorc@seZdZdZedZgddggdgdgddZd d Ze d d Z e d dZ e ddZ ddZ ddZd/ddZddZddZddZdd Zd!d"Zd#d$Zd%d&Zd'd(Zd)d*Zd+d,Zd-d.ZdS)0 SSHConfiga Representation of config information as stored in the format used by OpenSSH. Queries can be made via `lookup`. The format is described in OpenSSH's ``ssh_config`` man page. This class is provided primarily as a convenience to posix users (since the OpenSSH format is a de-facto standard on posix) but should work fine on Windows too. .. versionadded:: 1.6 z(\w+)(?:\s*=\s*|\s+)(.+))%h%l%L%n%p%r%ur )~%dr r rr)rr r r)rr r r r r rr)Z controlpathhostname identityfile proxycommand match-execcCs g|_dS)a Create a new OpenSSH config object. Note: the newer alternate constructors `from_path`, `from_file` and `from_text` are simpler to use, as they parse on instantiation. For example, instead of:: config = SSHConfig() config.parse(open("some-path.config") you could:: config = SSHConfig.from_file(open("some-path.config")) # Or more directly: config = SSHConfig.from_path("some-path.config") # Or if you have arbitrary ssh_config text from some other source: config = SSHConfig.from_text("Host foo\n\tUser bar") N)_config)selfr3/usr/lib/python3.9/site-packages/paramiko/config.py__init__GszSSHConfig.__init__cCs|t|S)zg Create a new, parsed `SSHConfig` from ``text`` string. .. versionadded:: 2.7 ) from_filer)clstextrrr from_text\szSSHConfig.from_textcCs6t|}||WdS1s(0YdS)zr Create a new, parsed `SSHConfig` from the file found at ``path``. .. versionadded:: 2.7 N)openr)rpathflorrr from_pathes zSSHConfig.from_pathcCs|}|||S)zp Create a new, parsed `SSHConfig` from file-like object ``flo``. .. versionadded:: 2.7 )parse)rr!objrrrros zSSHConfig.from_filecCsRdgid}|D].}|}|r|dr.qt|j|}|sNtd||d}|d}|dvr|j |dii}|d kr| ||d <n| ||d <q|d kr|d krd |d|<q|dr| dr|dd}|dvr(||dvr|d| |n|g|d|<q||dvr||d|<q|j |d S)z Read an OpenSSH config from the given file object. :param file_obj: a file-like object to read the config file from *)hostconfig#zUnparsable line {}r)r&matchr'r&matchesrZnoneN")rZ localforwardZ remoteforward)strip startswithrer*SETTINGS_REGEXrformatgrouplowerrappend _get_hosts _get_matchesendswith)rZfile_objcontextliner*keyvaluerrrr#zs6       zSSHConfig.parsecCs|j|d}d|vr||d<|dddv}t|dd}|r|d|kr|d }||||}||d<|j||d d }|S) a Return a dict (`SSHConfigDict`) of config options for a given hostname. The host-matching rules of OpenSSH's ``ssh_config`` man page are used: For each parameter, the first obtained value will be used. The configuration files contain sections separated by ``Host`` and/or ``Match`` specifications, and that section is only applied for hosts which match the given patterns or keywords Since the first obtained value for each parameter is used, more host- specific declarations should be given near the beginning of the file, and general defaults at the end. The keys in the returned dict are all normalized to lowercase (look for ``"port"``, not ``"Port"``. The values are processed according to the rules for substitution variable expansion in ``ssh_config``. Finally, please see the docs for `SSHConfigDict` for deeper info on features such as optional type conversion methods, e.g.:: conf = my_config.lookup('myhost') assert conf['passwordauthentication'] == 'yes' assert conf.as_bool('passwordauthentication') is True .. note:: If there is no explicitly configured ``HostName`` value, it will be set to the being-looked-up hostname, which is as close as we can get to OpenSSH's behavior around that particular option. :param str hostname: the hostname to lookup .. versionchanged:: 2.5 Returns `SSHConfigDict` objects instead of dict literals. .. versionchanged:: 2.7 Added canonicalization support. .. versionchanged:: 2.7 Added ``Match`` support. )rrZcanonicalizehostnameN)yesalwaysZcanonicalizemaxdotsr.ZcanonicaldomainsT) canonical)_lookupgetintcountsplit canonicalize)rroptionsZcanonZmaxdotsdomainsrrrlookups(  zSSHConfig.lookupNFcsdurt|jD]}||dg|sF||dg||sFq|dD]T\}vr|durv|ddn|<qRdkrRfdd|DqRq||dvrЈddurЈd=S)Nr&r+r'rc3s|]}|vr|VqdSNr.0xr;rGrr sz$SSHConfig._lookup..r) SSHConfigDictr_pattern_matchesrB _does_matchitemsextend_expand_variables)rrrGr@r9r<rrNrrAs*   zSSHConfig._lookupc Csd}|D]\}d||}t||}|dur4|d}n$zt|}WntjyVYn0|r|Sq|dddkrz|St|dS)ag Return canonicalized version of ``hostname``. :param str hostname: Target hostname. :param options: An `SSHConfigDict` from a previous lookup pass. :param domains: List of domains (e.g. ``["paramiko.org"]``). :returns: A canonicalized hostname if one was found, else ``None``. .. versionadded:: 2.7 Fz{}.{}NrZcanonicalizefallbacklocalr=)r2_addressfamily_host_lookupsocketZ gethostbynamegaierrorrBr)rrrGrHfounddomain candidateZfamily_specificrrrrFs     zSSHConfig.canonicalizecCs$t}|jD]}||dq |S)z Return the set of literal hostnames defined in the SSH config (both explicit hostnames and wildcard entries). r&)setrupdate)rhostsentryrrr get_hostnames;s zSSHConfig.get_hostnamescCsZt|dr|d}d}|D]8}|drDt||ddrDdSt||rd}q|S)NrE,F!rT)hasattrrEr/fnmatch)rpatternstargetr*patternrrrrQEs    zSSHConfig._pattern_matchescCs |||SrJ)rQ)rr^rrrr_allowedWszSSHConfig._allowedcCsJg}|dd}t}|rF|d}d} |dd} |dd} |d|d} } | dkrp|||rndSn| dkr|d S| d kr| p|}|| |} n| d kr|| |} nn| dkr| p|}|| |} nP| d kr|| |} n:| d kr|||d| }tdur ttj |dd dj } | dur:|| |r:dS| |q|S)Nrrusertypeparamr@FallTr&Z originalhostZ localuserexecrstdout)hidewarn) getpassgetuserpoprB _should_failrQ _tokenizeinvokeinvoke_import_errorrunokr5)rZ match_listtarget_hostnamer@rGZmatchedZ candidatesZlocal_usernamer[ZpassedZconfigured_hostZconfigured_usertype_rkZhostvalriZexec_cmdrrrrRZsF        zSSHConfig._does_matchcCs|dr |S| S)Nnegater)rZ would_passr[rrrrtszSSHConfig._should_failc Cs||}|s|S|}|dkr*|d|}d|vr<|d}nt}t}d|vrZ|d} n|} tdd} t|| } t j d} | || | ||| || d } |}| D]"\}}||vrq| |t|}q|S)a Tokenize a string based on current config/hostname data. :param config: Current config data. :param target_hostname: Original target connection hostname. :param key: Config key being tokenized (used to filter token list). :param value: Config value being tokenized. :returns: The tokenized version of the input ``value`` string. rportrir?rr) rr r r r r rrr)_allowed_tokensrBSSH_PORTrqrrrWZ gethostnamerELazyFqdnosr expanduserrSreplacestr)rr'rzr;r<Zallowed_tokensZconfigured_hostnamer}riZ remoteuserZlocal_hostnameZ local_fqdnhomedirZ replacementsZ tokenizedfindrrrrrus@      zSSHConfig._tokenizecCs|j|gS)aJ Given config ``key``, return list of token strings to tokenize. .. note:: This feels like it wants to eventually go away, but is used to preserve as-strict-as-possible compatibility with OpenSSH, which for whatever reason only applies some tokens to some config keys. )TOKENS_BY_CONFIG_KEYrBrr;rrrr~s zSSHConfig._allowed_tokenscCsr|D]h}||durqt|j|||}t||tr\t||D]\}}|||||<q@q|||||<q|S)aA Return a dict of config options with expanded substitutions for a given original & current target hostname. Please refer to :doc:`/api/config` for details. :param dict config: the currently parsed config :param str hostname: the hostname whose config is being looked up N)rru isinstancelist enumerate)rr'rzkZ tokenizerir<rrrrUs  zSSHConfig._expand_variablescCs2z t|WSty,td|Yn0dS)z> Return a list of host_names from host value. zUnparsable host {}N)shlexrE ValueErrorrr2)rr&rrrr6s  zSSHConfig._get_hostsc s$g}t|}|rdddd}|d}|drFd|d<|dd}||d <|d vrb||q|sttd ||d|d <||qd d|D}d|vr d ttfdd|ttfdd|}}d}t |rd}n$d|vr| d| dkrd}|dur t||S)z Parse a specific Match config line into a list-of-dicts for its values. Performs some parse-time validation as well. NF)rjrkr|rrbTr|rrj)rlr@z'Missing parameter to Match '{}' keywordrkcSsg|] }|dqS)rjrrKrrr z*SSHConfig._get_matches..rlcs|vSrJrrMZ allowablerrrz(SSHConfig._get_matches..cs|vSrJrrrrrrrz>Match does not allow 'all' mixed with anything but 'canonical'r@z-Match does not allow 'all' before 'canonical') rrErsr/r5rr2rfilteranyindex) rr*r+tokensr{keywordsryZbaderrrrrr7s@          zSSHConfig._get_matches)NF)__name__ __module__ __qualname____doc__r0compiler1rr classmethodrr"rr#rIrArFr`rQrhrRrtrur~rUr6r7rrrrr.s:     =: !) 4=  rcCsf|dd}|dkrdSz0tj}|dkr2tj}t|d|tjtjtjWStj y`Yn0dS)a Try looking up ``hostname`` in an IPv4 or IPv6 specific manner. This is an odd duck due to needing use in two divergent use cases. It looks up ``AddressFamily`` in ``options`` and if it is ``inet`` or ``inet6``, this function uses `socket.getaddrinfo` to perform a family-specific lookup, returning the result if successful. In any other situation -- lookup failure, or ``AddressFamily`` being unspecified or ``any`` -- ``None`` is returned instead and the caller is expected to do something situation-appropriate like calling `socket.gethostbyname`. :param str hostname: Hostname to look up. :param options: `SSHConfigDict` instance w/ parsed options. :returns: ``getaddrinfo``-style tuples, or ``None``, depending. Z addressfamilyrNZinet) rBr4rWZAF_INET6ZAF_INETZ getaddrinfoZ SOCK_DGRAMZ IPPROTO_IPZ AI_CANONNAMErX)rrGZaddress_familyZfamilyrrrrV$s"rVc@s"eZdZdZdddZddZdS)rz7 Returns the host's fqdn on request as string. NcCsd|_||_||_dSrJ)fqdnr'r&)rr'r&rrrrNszLazyFqdn.__init__c Csl|jdurfd}t|j|j}|durP|D]&}|\}}}}}|r(d|vr(|}qPq(|dur`t}||_|jS)Nr?)rrVr&r'rWZgetfqdn) rrresultsresafZsocktypeprotoZ canonnameZsarrr__str__Ss  zLazyFqdn.__str__)N)rrrrrrrrrrrIs rcs0eZdZdZfddZddZddZZS)rPa A dictionary wrapper/subclass for per-host configuration structures. This class introduces some usage niceties for consumers of `SSHConfig`, specifically around the issue of variable type conversions: normal value access yields strings, but there are now methods such as `as_bool` and `as_int` that yield casted values instead. For example, given the following ``ssh_config`` file snippet:: Host foo.example.com PasswordAuthentication no Compression yes ServerAliveInterval 60 the following code highlights how you can access the raw strings as well as usefully Python type-casted versions (recalling that keys are all normalized to lowercase first):: my_config = SSHConfig() my_config.parse(open('~/.ssh/config')) conf = my_config.lookup('foo.example.com') assert conf['passwordauthentication'] == 'no' assert conf.as_bool('passwordauthentication') is False assert conf['compression'] == 'yes' assert conf.as_bool('compression') is True assert conf['serveraliveinterval'] == '60' assert conf.as_int('serveraliveinterval') == 60 .. versionadded:: 2.5 cstt|j|i|dSrJ)superrPr)rargskwargs __class__rrrszSSHConfigDict.__init__cCs"||}t|tr|S|dkS)a Express given key's value as a boolean type. Typically, this is used for ``ssh_config``'s pseudo-boolean values which are either ``"yes"`` or ``"no"``. In such cases, ``"yes"`` yields ``True`` and any other value becomes ``False``. .. note:: If (for whatever reason) the stored value is already boolean in nature, it's simply returned. .. versionadded:: 2.5 r=)rboolr4)rr;valrrras_bools zSSHConfigDict.as_boolcCs t||S)z Express given key's value as an integer, if possible. This method will raise ``ValueError`` or similar if the value is not int-appropriate, same as the builtin `int` type. .. versionadded:: 2.5 )rCrrrras_ints zSSHConfigDict.as_int)rrrrrrr __classcell__rrrrrPos! rP)rrdrqrr0rrW functoolsrZ py3compatrrvrw ImportErroreZ ssh_exceptionrrrobjectrrVrdictrPrrrrs,   y%&