ۥ
Œdocutils.nodes”Œdocument”“”)”}”(Œ	rawsource”Œ”Œchildren”]”hŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒ
SSH agents”h]”hŒText”“”Œ
SSH agents”…””}”(Œparent”hŒ	_document”hŒsource”NŒline”NubaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”uŒtagname”hhhhhhŒ9/home/jforcier/Code/oss/paramiko/sites/docs/api/agent.rst”hKubŒsphinx.addnodes”Œindex”“”)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(Œsingle”Œparamiko.agent (module)”Œmodule-paramiko.agent”hNt”auh*h-hhhhhŒN/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent”hK
ubhŒ	paragraph”“”)”}”(hŒSSH Agent interface”h]”hŒSSH Agent interface”…””}”(hhAhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒN/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent”hK
hhhhubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:ŒAgent (class in paramiko.agent)”Œparamiko.agent.Agent”hNt”auh*h-hhhhhNhNubh,Œdesc”“”)”}”(hhh]”(h,Œdesc_signature”“”)”}”(hŒAgent()”h]”(h,Œdesc_annotation”“”)”}”(hŒclass ”h]”hŒclass ”…””}”(hhkhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”Œ	xml:space”Œpreserve”uh*hihhehhhŒT/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.Agent”hNubh,Œdesc_addname”“”)”}”(hŒparamiko.agent.”h]”hŒparamiko.agent.”…””}”(hh~hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*h|hhehhhh{hNubh,Œ	desc_name”“”)”}”(hŒAgent”h]”hŒAgent”…””}”(hhŽhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhhehhhh{hNubeh}”(h ]”h\ah"]”h$]”h\ah&]”h(]”Œfirst”‰Œmodule”Œparamiko.agent”Œclass”hŒfullname”huh*hchh`hhhh{hNubh,Œdesc_content”“”)”}”(hhh]”(h@)”}”(hX
Client interface for using private keys from an SSH agent running on the
local machine.  If an SSH agent is running, this class can be used to
connect to it and retrieve `.PKey` objects which can be used when
attempting to authenticate to remote SSH servers.”h]”(hŒªClient interface for using private keys from an SSH agent running on the
local machine.  If an SSH agent is running, this class can be used to
connect to it and retrieve ”…””}”(hh¬hhhNhNubh,Œpending_xref”“”)”}”(hŒ`.PKey`”h]”hŒliteral”“”)”}”(hh¸h]”hŒPKey”…””}”(hh¼hhhNhNubah}”(h ]”h"]”(Œxref”Œpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhh¶ubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”hnjrefexplicit”‰Œ	py:module”h¤Œpy:class”hŒrefspecific”ˆŒ	reftarget”ŒPKey”Œrefdoc”Œ	api/agent”Œrefwarn”‰uh*h´hNhNhh¬ubhŒQ objects which can be used when
attempting to authenticate to remote SSH servers.”…””}”(hh¬hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒT/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.Agent”hK
hh©hhubh@)”}”(hŒ¿Upon initialization, a session with the local machine's SSH agent is
opened, if one is running. If no agent is running, initialization will
succeed, but `get_keys` will return an empty tuple.”h]”(hŒ›Upon initialization, a session with the local machine’s SSH agent is
opened, if one is running. If no agent is running, initialization will
succeed, but ”…””}”(hhéhhhNhNubhµ)”}”(hŒ
`get_keys`”h]”h»)”}”(hhóh]”hŒget_keys”…””}”(hhõhhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhhñubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”hÿŒrefexplicit”‰hÖh¤h×hhٌget_keys”hÛhÜh݉uh*h´hNhNhhéubhŒ will return an empty tuple.”…””}”(hhéhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hhèhKhh©hhubhŒ
field_list”“”)”}”(hhh]”hŒfield”“”)”}”(hhh]”(hŒ
field_name”“”)”}”(hŒraises”h]”hŒRaises”…””}”(hj%
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hj 
hhèhKubhŒ
field_body”“”)”}”(hŒQ`.SSHException` --
if an SSH agent is found, but speaks an incompatible protocol
”h]”h@)”}”(hŒP`.SSHException` --
if an SSH agent is found, but speaks an incompatible protocol”h]”(hµ)”}”(hŒ`.SSHException`”h]”h»)”}”(hj?
h]”hŒSSHException”…””}”(hjA
hhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhj=
ubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”jK
Œrefexplicit”‰hÖh¤h×hh؈hٌSSHException”hÛhÜh݉uh*h´hNhNhj9
ubhŒB –
if an SSH agent is found, but speaks an incompatible protocol”…””}”(hj9
hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hhèhK
hj5
ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hj 
ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hhèhK
hj
hhubah}”(h ]”h"]”h$]”h&]”h(]”uh*j
hh©hhhNhNubh,Œversionmodified”“”)”}”(hŒuChanged in version 2.10: Added support for native openssh agent on windows (extending previous
putty pageant support)”h]”h@)”}”(hŒuChanged in version 2.10: Added support for native openssh agent on windows (extending previous
putty pageant support)”h]”(hŒinline”“”)”}”(hŒChanged in version 2.10: ”h]”hŒChanged in version 2.10: ”…””}”(hjƒ
hhhNhNubah}”(h ]”h"]”jw
ah$]”h&]”h(]”uh*j
hj}
hhhŒZ/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.Agent.close”hK
ubhŒ\Added support for native openssh agent on windows (extending previous
putty pageant support)”…””}”(hj}
hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”Œtranslatable”‰uh*h?hjy
hhhj‘
hK
ubah}”(h ]”h"]”h$]”h&]”h(]”Œtype”Œversionchanged”Œversion”Œ2.10”uh*jw
hhhhèhK
hh©ubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ%close() (paramiko.agent.Agent method)”Œparamiko.agent.Agent.close”hNt”auh*h-hh©hhhŒZ/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.Agent.close”hNubh_)”}”(hhh]”(hd)”}”(hŒ
Agent.close()”h]”(h)”}”(hŒclose”h]”hŒclose”…””}”(hj½
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj¹
hhhŒZ/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.Agent.close”hNubh,Œdesc_parameterlist”“”)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj¹
hhhjË
hNubeh}”(h ]”j³
ah"]”h$]”j³
ah&]”h(]”h¢‰h£Œparamiko.agent”h¥hh¦ŒAgent.close”uh*hchj¶
hhhjË
hNubh¨)”}”(hhh]”h@)”}”(hŒClose the SSH agent connection.”h]”hŒClose the SSH agent connection.”…””}”(hjâ
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjµ
hK
hjß
hhubah}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj¶
hhhjË
hNubeh}”(h ]”h"]”h$]”h&]”h(]”Œdomain”Œpy”Œobjtype”Œmethod”Œdesctype”jÿ
Œnoindex”‰uh*h^hhhh©hjµ
hNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ(get_keys() (paramiko.agent.Agent method)”Œparamiko.agent.Agent.get_keys”hNt”auh*h-hh©hhhNhNubh_)”}”(hhh]”(hd)”}”(hŒAgent.get_keys()”h]”(h)”}”(hŒget_keys”h]”hŒget_keys”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjhhhŒ]/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.Agent.get_keys”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjhhhj%hNubeh}”(h ]”jah"]”h$]”jah&]”h(]”h¢‰h£Œparamiko.agent”h¥hh¦ŒAgent.get_keys”uh*hchjhhhj%hNubh¨)”}”(hhh]”(h@)”}”(hŒœReturn the list of keys available through the SSH agent, if any.  If
no SSH agent was running (or it couldn't be contacted), an empty list
will be returned.”h]”hŒžReturn the list of keys available through the SSH agent, if any.  If
no SSH agent was running (or it couldn’t be contacted), an empty list
will be returned.”…””}”(hj:hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒ]/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.Agent.get_keys”hK
hj7hhubj
)”}”(hhh]”j
)”}”(hhh]”(j$
)”}”(hŒReturns”h]”hŒReturns”…””}”(hjOhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjLhj%hKubj4
)”}”(hhh]”h@)”}”(hŒHa tuple of AgentKey objects representing keys available on the
SSH agent”h]”(hŒa tuple of ”…””}”(hj`hhhNhNubhµ)”}”(hŒ`.AgentKey`”h]”h»)”}”(hjjh]”hŒAgentKey”…””}”(hjlhhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhjhubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”jvŒrefexplicit”‰hÖj5h×hh؈hٌAgentKey”hÛhÜh݉uh*h´hNhNhj`hhubhŒ5 objects representing keys available on the
SSH agent”…””}”(hj`hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj]ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjLubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjIubah}”(h ]”h"]”h$]”h&]”h(]”uh*j
hj7hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjhhhj%hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jj¯j
‰uh*h^hhhh©hNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hh`hhhh{hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œclass”jj½j
‰uh*h^hhhhhNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ*AgentClientProxy (class in paramiko.agent)”Œparamiko.agent.AgentClientProxy”hNt”auh*h-hhhhhNhNubh_)”}”(hhh]”(hd)”}”(hŒAgentClientProxy(chanRemote)”h]”(hj)”}”(hŒclass ”h]”hŒclass ”…””}”(hjÓhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hihjÏhhhŒ_/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentClientProxy”hNubh})”}”(hŒparamiko.agent.”h]”hŒparamiko.agent.”…””}”(hjâhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*h|hjÏhhhjáhNubh)”}”(hŒAgentClientProxy”h]”hŒAgentClientProxy”…””}”(hjðhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjÏhhhjáhNubjÍ
)”}”(hŒ
chanRemote”h]”h,Œdesc_parameter”“”)”}”(hŒ
chanRemote”h]”hŒ
chanRemote”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhjþubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjÏhhhjáhNubeh}”(h ]”jÊah"]”h$]”jÊah&]”h(]”h¢‰h£Œparamiko.agent”h¥hh¦jòuh*hchjÌhhhjáhNubh¨)”}”(hhh]”(h@)”}”(hŒ#Class proxying request as a client:”h]”hŒ#Class proxying request as a client:”…””}”(hj"hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒ_/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentClientProxy”hK
hjhhubhŒenumerated_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒ(client ask for a request_forward_agent()”h]”h@)”}”(hj:h]”hŒ(client ask for a request_forward_agent()”…””}”(hj<hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj0hKhj8ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j6hj3hhhj0hNubj7)”}”(hŒ+server creates a proxy and a fake SSH Agent”h]”h@)”}”(hjQh]”hŒ+server creates a proxy and a fake SSH Agent”…””}”(hjShhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj0hKhjOubah}”(h ]”h"]”h$]”h&]”h(]”uh*j6hj3hhhj0hNubj7)”}”(hŒgserver ask for establishing a connection when needed,
calling the forward_agent_handler at client side.”h]”h@)”}”(hŒgserver ask for establishing a connection when needed,
calling the forward_agent_handler at client side.”h]”hŒgserver ask for establishing a connection when needed,
calling the forward_agent_handler at client side.”…””}”(hjjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj0hKhjfubah}”(h ]”h"]”h$]”h&]”h(]”uh*j6hj3hhhj0hNubj7)”}”(hŒbthe forward_agent_handler launch a thread for connecting
the remote fake agent and the local agent”h]”h@)”}”(hŒbthe forward_agent_handler launch a thread for connecting
the remote fake agent and the local agent”h]”hŒbthe forward_agent_handler launch a thread for connecting
the remote fake agent and the local agent”…””}”(hj‚hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj0hKhj~ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j6hj3hhhj0hNubj7)”}”(hŒCommunication occurs ...

”h]”h@)”}”(hŒCommunication occurs ...”h]”hŒCommunication occurs …”…””}”(hjšhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj0hK	hj–ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j6hj3hhhŒe/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentClientProxy.close”hNubeh}”(h ]”h"]”h$]”h&]”h(]”Œenumtype”Œarabic”Œprefix”hŒsuffix”Œ
.”uh*j1hjhhhj0hKubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ0close() (paramiko.agent.AgentClientProxy method)”Œ%paramiko.agent.AgentClientProxy.close”hNt”auh*h-hjhhhŒe/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentClientProxy.close”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentClientProxy.close()”h]”(h)”}”(hŒclose”h]”hŒclose”…””}”(hjÐhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjÌhhhŒe/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentClientProxy.close”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjÌhhhjÞhNubeh}”(h ]”jÆah"]”h$]”jÆah&]”h(]”h¢‰h£Œparamiko.agent”h¥jòh¦ŒAgentClientProxy.close”uh*hchjÉhhhjÞhNubh¨)”}”(hhh]”h@)”}”(hŒNClose the current connection and terminate the agent
Should be called manually”h]”hŒNClose the current connection and terminate the agent
Should be called manually”…””}”(hjóhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjÈhK
hjðhhubah}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjÉhhhjÞhNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jjj
‰uh*h^hhhjhjÈhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ2connect() (paramiko.agent.AgentClientProxy method)”Œ'paramiko.agent.AgentClientProxy.connect”hNt”auh*h-hjhhhŒg/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentClientProxy.connect”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentClientProxy.connect()”h]”(h)”}”(hŒconnect”h]”hŒconnect”…””}”(hj%hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj!hhhŒg/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentClientProxy.connect”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj!hhhj3hNubeh}”(h ]”jah"]”h$]”jah&]”h(]”h¢‰h£Œparamiko.agent”h¥jòh¦ŒAgentClientProxy.connect”uh*hchjhhhj3hNubh¨)”}”(hhh]”h@)”}”(hŒ8Method automatically called by ``AgentProxyThread.run``.”h]”(hŒMethod automatically called by ”…””}”(hjHhhhNhNubh»)”}”(hŒ``AgentProxyThread.run``”h]”hŒAgentProxyThread.run”…””}”(hjPhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhjHubhŒ
.”…””}”(hjHhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhK
hjEhhubah}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjhhhj3hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jjuj
‰uh*h^hhhjhjhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjÌhhhjáhNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œclass”jjƒj
‰uh*h^hhhhhNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ"AgentKey (class in paramiko.agent)”Œparamiko.agent.AgentKey”hNt”auh*h-hhhhhNhNubh_)”}”(hhh]”(hd)”}”(hŒAgentKey(agent, blob)”h]”(hj)”}”(hŒclass ”h]”hŒclass ”…””}”(hj™hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hihj•hhhŒW/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey”hNubh})”}”(hŒparamiko.agent.”h]”hŒparamiko.agent.”…””}”(hj¨hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*h|hj•hhhj§hNubh)”}”(hŒAgentKey”h]”hŒAgentKey”…””}”(hj¶hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj•hhhj§hNubjÍ
)”}”(hŒagent, blob”h]”(j)”}”(hŒagent”h]”hŒagent”…””}”(hjÈhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhjÄubj)”}”(hŒblob”h]”hŒblob”…””}”(hjÖhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhjÄubeh}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj•hhhj§hNubeh}”(h ]”jah"]”h$]”jah&]”h(]”h¢‰h£Œparamiko.agent”h¥hh¦j¸uh*hchj’hhhj§hNubh¨)”}”(hhh]”(h@)”}”(hŒ¢Private key held in a local SSH agent.  This type of key can be used for
authenticating to a remote server (signing).  Most other key operations
work as expected.”h]”hŒ¢Private key held in a local SSH agent.  This type of key can be used for
authenticating to a remote server (signing).  Most other key operations
work as expected.”…””}”(hjôhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒW/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey”hK
hjñhhubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ+can_sign() (paramiko.agent.AgentKey method)”Œ paramiko.agent.AgentKey.can_sign”hNt”auh*h-hjñhhhŒ`/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.can_sign”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentKey.can_sign()”h]”(h)”}”(hŒcan_sign”h]”hŒcan_sign”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjhhhŒ`/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.can_sign”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjhhhj'hNubeh}”(h ]”jah"]”h$]”jah&]”h(]”h¢‰h£Œparamiko.agent”h¥j¸h¦ŒAgentKey.can_sign”uh*hchjhhhj'hNubh¨)”}”(hhh]”h@)”}”(hŒLReturn ``True`` if this key has the private part necessary for signing
data.”h]”(hŒReturn ”…””}”(hj<hhhNhNubh»)”}”(hŒ``True``”h]”hŒTrue”…””}”(hjDhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhj<ubhŒ= if this key has the private part necessary for signing
data.”…””}”(hj<hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhK
hj9hhubah}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjhhhj'hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jjij
‰uh*h^hhhjñhjhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ3from_private_key() (paramiko.agent.AgentKey method)”Œ(paramiko.agent.AgentKey.from_private_key”hNt”auh*h-hjñhhhNhNubh_)”}”(hhh]”(hd)”}”(hŒ2AgentKey.from_private_key(file_obj, password=None)”h]”(h)”}”(hŒfrom_private_key”h]”hŒfrom_private_key”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj{hhhŒh/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.from_private_key”hNubjÍ
)”}”(hŒfile_obj, password=None”h]”(j)”}”(hŒfile_obj”h]”hŒfile_obj”…””}”(hj’hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhjŽubj)”}”(hŒ
password=None”h]”hŒ
password=None”…””}”(hj hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhjŽubeh}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj{hhhjhNubeh}”(h ]”jvah"]”h$]”jvah&]”h(]”h¢‰h£Œparamiko.agent”h¥j¸h¦ŒAgentKey.from_private_key”uh*hchjxhhhjhNubh¨)”}”(hhh]”(h@)”}”(hŒùCreate a key object by reading a private key from a file (or file-like)
object.  If the private key is encrypted and ``password`` is not
``None``, the given password will be used to decrypt the key (otherwise
`.PasswordRequiredException` is thrown).”h]”(hŒuCreate a key object by reading a private key from a file (or file-like)
object.  If the private key is encrypted and ”…””}”(hj¿hhhNhNubh»)”}”(hŒ``password``”h]”hŒpassword”…””}”(hjÇhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhj¿ubhŒ is not
”…””}”(hj¿hhhNhNubh»)”}”(hŒ``None``”h]”hŒNone”…””}”(hjÙhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhj¿ubhŒ@, the given password will be used to decrypt the key (otherwise
”…””}”(hj¿hhhNhNubhµ)”}”(hŒ`.PasswordRequiredException`”h]”h»)”}”(hjíh]”hŒPasswordRequiredException”…””}”(hjïhhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhjëubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”jùŒrefexplicit”‰hÖjºh×j¸h؈hٌPasswordRequiredException”hÛhÜh݉uh*h´hNhNhj¿ubhŒ is thrown).”…””}”(hj¿hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒh/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.from_private_key”hK
hj¼hhubj
)”}”(hhh]”(j
)”}”(hhh]”(j$
)”}”(hŒ
Parameters”h]”hŒ
Parameters”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjhjhKubj4
)”}”(hhh]”hŒbullet_list”“”)”}”(hhh]”(j7)”}”(hhh]”h@)”}”(hŒ-file_obj -- the file-like object to read from”h]”(h,Œliteral_strong”“”)”}”(hŒfile_obj”h]”hŒfile_obj”…””}”(hj9hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”h؈uh*j7hj3ubhŒ – ”…””}”(hj3hhhNhNubhŒ!the file-like object to read from”…””}”(hj3hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj0ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j6hj-ubj7)”}”(hhh]”h@)”}”(hŒSpassword (str) -- an optional password to use to decrypt the key, if it's encrypted”h]”(j8)”}”(hŒpassword”h]”hŒpassword”…””}”(hjbhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”h؈uh*j7hj^ubhŒ (”…””}”(hj^hhhNhNubhµ)”}”(hhh]”h,Œliteral_emphasis”“”)”}”(hŒstr”h]”hŒstr”…””}”(hjyhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*jwhjtubah}”(h ]”h"]”h$]”h&]”h(]”Œ	refdomain”Œpy”Œrefexplicit”‰Œreftype”Œobj”Œ	reftarget”j{h؈uh*h´hj^ubhŒ
)”…””}”(hj^hhhNhNubhŒ – ”…””}”(hj^hhhNhNubhŒCan optional password to use to decrypt the key, if it’s encrypted”…””}”(hj^hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj[ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j6hj-ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j+hj(ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjubj
)”}”(hhh]”(j$
)”}”(hŒReturns”h]”hŒReturns”…””}”(hjÀhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hj½hjhKubj4
)”}”(hhh]”h@)”}”(hŒ)a new PKey based on the given private key”h]”(hŒa new ”…””}”(hjÑhhhNhNubhµ)”}”(hŒ`.PKey`”h]”h»)”}”(hjÛh]”hŒPKey”…””}”(hjÝhhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhjÙubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”jçŒrefexplicit”‰hÖjºh×j¸h؈hٌPKey”hÛhÜh݉uh*h´hNhNhjÑhhubhŒ based on the given private key”…””}”(hjÑhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjÎubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hj½ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjubj
)”}”(hhh]”(j$
)”}”(hŒraises”h]”hŒRaises”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hj
hjhKubj4
)”}”(hŒ4``IOError`` -- if there was an error reading the key”h]”h@)”}”(hj h]”(h»)”}”(hŒ``IOError``”h]”hŒIOError”…””}”(hj%hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhj"ubhŒ* – if there was an error reading the key”…””}”(hj"hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhjubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hj
ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjhKhjhhubj
)”}”(hhh]”(j$
)”}”(hŒraises”h]”hŒRaises”…””}”(hjLhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjIhjhKubj4
)”}”(hŒb`.PasswordRequiredException` --
if the private key file is encrypted, and ``password`` is ``None``”h]”h@)”}”(hŒb`.PasswordRequiredException` --
if the private key file is encrypted, and ``password`` is ``None``”h]”(hµ)”}”(hŒ`.PasswordRequiredException`”h]”h»)”}”(hjdh]”hŒPasswordRequiredException”…””}”(hjfhhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhjbubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”jpŒrefexplicit”‰hÖjºh×j¸h؈hٌPasswordRequiredException”hÛhÜh݉uh*h´hNhNhj^ubhŒ/ –
if the private key file is encrypted, and ”…””}”(hj^hhhNhNubh»)”}”(hŒ``password``”h]”hŒpassword”…””}”(hj„hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhj^ubhŒ is ”…””}”(hj^hhhNhNubh»)”}”(hŒ``None``”h]”hŒNone”…””}”(hj–hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhj^ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhjZubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjIubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjhKhjhhubj
)”}”(hhh]”(j$
)”}”(hŒraises”h]”hŒRaises”…””}”(hj¹hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hj¶hjhKubj4
)”}”(hŒ-`.SSHException` -- if the key file is invalid”h]”h@)”}”(hjÉh]”(hµ)”}”(hŒ`.SSHException`”h]”h»)”}”(hjÐh]”hŒSSHException”…””}”(hjÒhhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhjÎubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”jÜŒrefexplicit”‰hÖjºh×j¸h؈hٌSSHException”hÛhÜh݉uh*h´hNhNhjËubhŒ – if the key file is invalid”…””}”(hjËhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhjÇubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hj¶ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjhKhjhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hj¼hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjxhhhjhNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
jŽjþ
Œmethod”jjj
‰uh*h^hhhjñhNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ8from_private_key_file() (paramiko.agent.AgentKey method)”Œ-paramiko.agent.AgentKey.from_private_key_file”hNt”auh*h-hjñhhhNhNubh_)”}”(hhh]”(hd)”}”(hŒ7AgentKey.from_private_key_file(filename, password=None)”h]”(h)”}”(hŒfrom_private_key_file”h]”hŒfrom_private_key_file”…””}”(hj*hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj&hhhŒm/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.from_private_key_file”hNubjÍ
)”}”(hŒfilename, password=None”h]”(j)”}”(hŒfilename”h]”hŒfilename”…””}”(hj=hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhj9ubj)”}”(hŒ
password=None”h]”hŒ
password=None”…””}”(hjKhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhj9ubeh}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj&hhhj8hNubeh}”(h ]”j!ah"]”h$]”j!ah&]”h(]”h¢‰h£Œparamiko.agent”h¥j¸h¦ŒAgentKey.from_private_key_file”uh*hchj#hhhj8hNubh¨)”}”(hhh]”(h@)”}”(hX€
Create a key object by reading a private key file.  If the private
key is encrypted and ``password`` is not ``None``, the given password
will be used to decrypt the key (otherwise `.PasswordRequiredException`
is thrown).  Through the magic of Python, this factory method will
exist in all subclasses of PKey (such as `.RSAKey` or `.DSSKey`), but
is useless on the abstract PKey class.”h]”(hŒXCreate a key object by reading a private key file.  If the private
key is encrypted and ”…””}”(hjjhhhNhNubh»)”}”(hŒ``password``”h]”hŒpassword”…””}”(hjrhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhjjubhŒ is not ”…””}”(hjjhhhNhNubh»)”}”(hŒ``None``”h]”hŒNone”…””}”(hj„hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhjjubhŒ@, the given password
will be used to decrypt the key (otherwise ”…””}”(hjjhhhNhNubhµ)”}”(hŒ`.PasswordRequiredException`”h]”h»)”}”(hj˜h]”hŒPasswordRequiredException”…””}”(hjšhhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhj–ubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”j¤Œrefexplicit”‰hÖjeh×j¸h؈hٌPasswordRequiredException”hÛhÜh݉uh*h´hNhNhjjubhŒm
is thrown).  Through the magic of Python, this factory method will
exist in all subclasses of PKey (such as ”…””}”(hjjhhhNhNubhµ)”}”(hŒ	`.RSAKey`”h]”h»)”}”(hjºh]”hŒRSAKey”…””}”(hj¼hhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhj¸ubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”jÆŒrefexplicit”‰hÖjeh×j¸h؈hٌRSAKey”hÛhÜh݉uh*h´hNhNhjjubhŒ or ”…””}”(hjjhhhNhNubhµ)”}”(hŒ	`.DSSKey`”h]”h»)”}”(hjÜh]”hŒDSSKey”…””}”(hjÞhhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhjÚubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”jèŒrefexplicit”‰hÖjeh×j¸h؈hٌDSSKey”hÛhÜh݉uh*h´hNhNhjjubhŒ-), but
is useless on the abstract PKey class.”…””}”(hjjhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒm/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.from_private_key_file”hK
hjghhubj
)”}”(hhh]”(j
)”}”(hhh]”(j$
)”}”(hŒ
Parameters”h]”hŒ
Parameters”…””}”(hj		hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hj	hj8hKubj4
)”}”(hhh]”j,)”}”(hhh]”(j7)”}”(hhh]”h@)”}”(hŒ*filename (str) -- name of the file to read”h]”(j8)”}”(hŒfilename”h]”hŒfilename”…””}”(hj$	hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”h؈uh*j7hj 	ubhŒ (”…””}”(hj 	hhhNhNubhµ)”}”(hhh]”jx)”}”(hŒstr”h]”hŒstr”…””}”(hj9	hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*jwhj6	ubah}”(h ]”h"]”h$]”h&]”h(]”Œ	refdomain”Œpy”Œrefexplicit”‰Œreftype”j‘Œ	reftarget”j;	h؈uh*h´hj 	ubhŒ
)”…””}”(hj 	hhhNhNubhŒ – ”…””}”(hj 	hhhNhNubhŒname of the file to read”…””}”(hj 	hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj	ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j6hj	ubj7)”}”(hhh]”h@)”}”(hŒXpassword (str) -- an optional password to use to decrypt the key file, if it's
encrypted”h]”(j8)”}”(hŒpassword”h]”hŒpassword”…””}”(hjq	hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”h؈uh*j7hjm	ubhŒ (”…””}”(hjm	hhhNhNubhµ)”}”(hhh]”jx)”}”(hŒstr”h]”hŒstr”…””}”(hj†	hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*jwhjƒ	ubah}”(h ]”h"]”h$]”h&]”h(]”Œ	refdomain”jN	Œrefexplicit”‰Œreftype”j‘Œ	reftarget”jˆ	h؈uh*h´hjm	ubhŒ
)”…””}”(hjm	hhhNhNubhŒ – ”…””}”(hjm	hhhNhNubhŒHan optional password to use to decrypt the key file, if it’s
encrypted”…””}”(hjm	hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjj	ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j6hj	ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j+hj	ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hj	ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hj	ubj
)”}”(hhh]”(j$
)”}”(hŒReturns”h]”hŒReturns”…””}”(hjË	hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjÈ	hj8hKubj4
)”}”(hhh]”h@)”}”(hŒ)a new PKey based on the given private key”h]”(hŒa new ”…””}”(hjÜ	hhhNhNubhµ)”}”(hŒ`.PKey`”h]”h»)”}”(hjæ	h]”hŒPKey”…””}”(hjè	hhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhjä	ubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”jò	Œrefexplicit”‰hÖjeh×j¸h؈hٌPKey”hÛhÜh݉uh*h´hNhNhjÜ	hhubhŒ based on the given private key”…””}”(hjÜ	hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjÙ	ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjÈ	ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hj	ubj
)”}”(hhh]”(j$
)”}”(hŒraises”h]”hŒRaises”…””}”(hj
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hj
hj	hKubj4
)”}”(hŒ5``IOError`` -- if there was an error reading the file”h]”h@)”}”(hj+
h]”(h»)”}”(hŒ``IOError``”h]”hŒIOError”…””}”(hj0
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhj-
ubhŒ+ – if there was an error reading the file”…””}”(hj-
hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj	hKhj)
ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hj
ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hj	hKhj	hhubj
)”}”(hhh]”(j$
)”}”(hŒraises”h]”hŒRaises”…””}”(hjW
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjT
hj	hKubj4
)”}”(hŒb`.PasswordRequiredException` -- if the private key file is
encrypted, and ``password`` is ``None``”h]”h@)”}”(hŒb`.PasswordRequiredException` -- if the private key file is
encrypted, and ``password`` is ``None``”h]”(hµ)”}”(hŒ`.PasswordRequiredException`”h]”h»)”}”(hjo
h]”hŒPasswordRequiredException”…””}”(hjq
hhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhjm
ubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”j{
Œrefexplicit”‰hÖjeh×j¸h؈hٌPasswordRequiredException”hÛhÜh݉uh*h´hNhNhji
ubhŒ/ – if the private key file is
encrypted, and ”…””}”(hji
hhhNhNubh»)”}”(hŒ``password``”h]”hŒpassword”…””}”(hj
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhji
ubhŒ is ”…””}”(hji
hhhNhNubh»)”}”(hŒ``None``”h]”hŒNone”…””}”(hj¡
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhji
ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj	hKhje
ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjT
ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hj	hKhj	hhubj
)”}”(hhh]”(j$
)”}”(hŒraises”h]”hŒRaises”…””}”(hjÄ
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjÁ
hj	hKubj4
)”}”(hŒ-`.SSHException` -- if the key file is invalid”h]”h@)”}”(hjÔ
h]”(hµ)”}”(hŒ`.SSHException`”h]”h»)”}”(hjÛ
h]”hŒSSHException”…””}”(hjÝ
hhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhjÙ
ubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”jç
Œrefexplicit”‰hÖjeh×j¸h؈hٌSSHException”hÛhÜh݉uh*h´hNhNhjÖ
ubhŒ – if the key file is invalid”…””}”(hjÖ
hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj	hKhjÒ
ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjÁ
ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hj	hKhj	hhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjghhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj#hhhj8hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
jN	jþ
Œmethod”jjj
‰uh*h^hhhjñhNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ-get_base64() (paramiko.agent.AgentKey method)”Œ"paramiko.agent.AgentKey.get_base64”hNt”auh*h-hjñhhhNhNubh_)”}”(hhh]”(hd)”}”(hŒAgentKey.get_base64()”h]”(h)”}”(hŒ
get_base64”h]”hŒ
get_base64”…””}”(hj5hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj1hhhŒb/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.get_base64”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj1hhhjChNubeh}”(h ]”j,ah"]”h$]”j,ah&]”h(]”h¢‰h£Œparamiko.agent”h¥j¸h¦ŒAgentKey.get_base64”uh*hchj.hhhjChNubh¨)”}”(hhh]”(h@)”}”(hŒ¸Return a base64 string containing the public part of this key.  Nothing
secret is revealed.  This format is compatible with that used to store
public key files or recognized host keys.”h]”hŒ¸Return a base64 string containing the public part of this key.  Nothing
secret is revealed.  This format is compatible with that used to store
public key files or recognized host keys.”…””}”(hjXhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒb/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.get_base64”hK
hjUhhubj
)”}”(hhh]”j
)”}”(hhh]”(j$
)”}”(hŒReturns”h]”hŒReturns”…””}”(hjmhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjjhjChKubj4
)”}”(hhh]”h@)”}”(hŒ6a base64 string containing the public part of the key.”h]”(hŒ	a base64 ”…””}”(hj~hhhNhNubhµ)”}”(hŒ`string <str>`”h]”h»)”}”(hjˆh]”hŒstring”…””}”(hjŠhhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhj†ubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”j”Œrefexplicit”ˆhÖjSh×j¸hٌstr”hÛhÜh݉uh*h´hNhNhj~hhubhŒ' containing the public part of the key.”…””}”(hj~hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj{ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjjubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjgubah}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjUhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj.hhhjChNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jjÍj
‰uh*h^hhhjñhNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ+get_bits() (paramiko.agent.AgentKey method)”Œ paramiko.agent.AgentKey.get_bits”hNt”auh*h-hjñhhhNhNubh_)”}”(hhh]”(hd)”}”(hŒAgentKey.get_bits()”h]”(h)”}”(hŒget_bits”h]”hŒget_bits”…””}”(hjãhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjßhhhŒ`/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.get_bits”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjßhhhjñhNubeh}”(h ]”jÚah"]”h$]”jÚah&]”h(]”h¢‰h£Œparamiko.agent”h¥j¸h¦ŒAgentKey.get_bits”uh*hchjÜhhhjñhNubh¨)”}”(hhh]”(h@)”}”(hŒnReturn the number of significant bits in this key.  This is useful
for judging the relative security of a key.”h]”hŒnReturn the number of significant bits in this key.  This is useful
for judging the relative security of a key.”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒ`/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.get_bits”hK
hjhhubj
)”}”(hhh]”j
)”}”(hhh]”(j$
)”}”(hŒReturns”h]”hŒReturns”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjhjñhKubj4
)”}”(hhh]”h@)”}”(hŒbits in the key (as an int)”h]”(hŒbits in the key (as an ”…””}”(hj,hhhNhNubhµ)”}”(hŒ`int`”h]”h»)”}”(hj6h]”hŒint”…””}”(hj8hhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhj4ubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”jBŒrefexplicit”‰hÖj
h×j¸hٌint”hÛhÜh݉uh*h´hNhNhj,hhubhŒ
)”…””}”(hj,hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj)ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjubah}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjÜhhhjñhNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jj{j
‰uh*h^hhhjñhNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ2get_fingerprint() (paramiko.agent.AgentKey method)”Œ'paramiko.agent.AgentKey.get_fingerprint”hNt”auh*h-hjñhhhNhNubh_)”}”(hhh]”(hd)”}”(hŒAgentKey.get_fingerprint()”h]”(h)”}”(hŒget_fingerprint”h]”hŒget_fingerprint”…””}”(hj‘hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjhhhŒg/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.get_fingerprint”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjhhhjŸhNubeh}”(h ]”jˆah"]”h$]”jˆah&]”h(]”h¢‰h£Œparamiko.agent”h¥j¸h¦ŒAgentKey.get_fingerprint”uh*hchjŠhhhjŸhNubh¨)”}”(hhh]”(h@)”}”(hŒVReturn an MD5 fingerprint of the public part of this key.  Nothing
secret is revealed.”h]”hŒVReturn an MD5 fingerprint of the public part of this key.  Nothing
secret is revealed.”…””}”(hj´hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒg/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.get_fingerprint”hK
hj±hhubj
)”}”(hhh]”j
)”}”(hhh]”(j$
)”}”(hŒReturns”h]”hŒReturns”…””}”(hjÉhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjÆhjŸhKubj4
)”}”(hhh]”h@)”}”(hŒ@a 16-byte string (binary) of the MD5 fingerprint, in SSH
format.”h]”(hŒ
a 16-byte ”…””}”(hjÚhhhNhNubhµ)”}”(hŒ`string <str>`”h]”h»)”}”(hjäh]”hŒstring”…””}”(hjæhhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhjâubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”jðŒrefexplicit”ˆhÖj¯h×j¸hٌstr”hÛhÜh݉uh*h´hNhNhjÚhhubhŒ0 (binary) of the MD5 fingerprint, in SSH
format.”…””}”(hjÚhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj×ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjÆubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjÃubah}”(h ]”h"]”h$]”h&]”h(]”uh*j
hj±hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjŠhhhjŸhNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jj)
j
‰uh*h^hhhjñhNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ3load_certificate() (paramiko.agent.AgentKey method)”Œ(paramiko.agent.AgentKey.load_certificate”hNt”auh*h-hjñhhhŒh/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.load_certificate”hNubh_)”}”(hhh]”(hd)”}”(hŒ AgentKey.load_certificate(value)”h]”(h)”}”(hŒload_certificate”h]”hŒload_certificate”…””}”(hj@
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj<
hhhŒh/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.load_certificate”hNubjÍ
)”}”(hŒvalue”h]”j)”}”(hŒvalue”h]”hŒvalue”…””}”(hjS
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhjO
ubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj<
hhhjN
hNubeh}”(h ]”j6
ah"]”h$]”j6
ah&]”h(]”h¢‰h£Œparamiko.agent”h¥j¸h¦ŒAgentKey.load_certificate”uh*hchj9
hhhjN
hNubh¨)”}”(hhh]”(h@)”}”(hŒ¸Supplement the private key contents with data loaded from an OpenSSH
public key (``.pub``) or certificate (``-cert.pub``) file, a string
containing such a file, or a `.Message` object.”h]”(hŒQSupplement the private key contents with data loaded from an OpenSSH
public key (”…””}”(hjr
hhhNhNubh»)”}”(hŒ``.pub``”h]”hŒ.pub”…””}”(hjz
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhjr
ubhŒ) or certificate (”…””}”(hjr
hhhNhNubh»)”}”(hŒ
``-cert.pub``”h]”hŒ	-cert.pub”…””}”(hjŒ
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhjr
ubhŒ.) file, a string
containing such a file, or a ”…””}”(hjr
hhhNhNubhµ)”}”(hŒ
`.Message`”h]”h»)”}”(hj 
h]”hŒMessage”…””}”(hj¢
hhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhjž
ubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”j¬
Œrefexplicit”‰hÖjm
h×j¸h؈hٌMessage”hÛhÜh݉uh*h´hNhNhjr
ubhŒ object.”…””}”(hjr
hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj8
hK
hjo
hhubh@)”}”(hX
The .pub contents adds no real value, since the private key
file includes sufficient information to derive the public
key info. For certificates, however, this can be used on
the client side to offer authentication requests to the server
based on certificate instead of raw public key.”h]”hX
The .pub contents adds no real value, since the private key
file includes sufficient information to derive the public
key info. For certificates, however, this can be used on
the client side to offer authentication requests to the server
based on certificate instead of raw public key.”…””}”(hjÆ
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj8
hKhjo
hhubh@)”}”(hŒNSee:
https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys”h]”(hŒSee:
”…””}”(hjÔ
hhhNhNubhŒ	reference”“”)”}”(hŒIhttps://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys”h]”hŒIhttps://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys”…””}”(hjÞ
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”Œrefuri”jà
uh*jÜ
hjÔ
ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj8
hKhjo
hhubh@)”}”(hŒšNote: very little effort is made to validate the certificate contents,
that is for the server to decide if it is good enough to authenticate
successfully.”h]”hŒšNote: very little effort is made to validate the certificate contents,
that is for the server to decide if it is good enough to authenticate
successfully.”…””}”(hjó
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj8
hKhjo
hhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj9
hhhjN
hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jjj
‰uh*h^hhhjñhj8
hNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ1verify_ssh_sig() (paramiko.agent.AgentKey method)”Œ&paramiko.agent.AgentKey.verify_ssh_sig”hNt”auh*h-hjñhhhNhNubh_)”}”(hhh]”(hd)”}”(hŒ"AgentKey.verify_ssh_sig(data, msg)”h]”(h)”}”(hŒverify_ssh_sig”h]”hŒverify_ssh_sig”…””}”(hj$hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj hhhŒf/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.verify_ssh_sig”hNubjÍ
)”}”(hŒ	data, msg”h]”(j)”}”(hŒdata”h]”hŒdata”…””}”(hj7hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhj3ubj)”}”(hŒmsg”h]”hŒmsg”…””}”(hjEhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhj3ubeh}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj hhhj2hNubeh}”(h ]”jah"]”h$]”jah&]”h(]”h¢‰h£Œparamiko.agent”h¥j¸h¦ŒAgentKey.verify_ssh_sig”uh*hchjhhhj2hNubh¨)”}”(hhh]”(h@)”}”(hŒxGiven a blob of data, and an SSH message representing a signature of
that data, verify that it was signed with this key.”h]”hŒxGiven a blob of data, and an SSH message representing a signature of
that data, verify that it was signed with this key.”…””}”(hjdhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒf/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.verify_ssh_sig”hK
hjahhubj
)”}”(hhh]”(j
)”}”(hhh]”(j$
)”}”(hŒ
Parameters”h]”hŒ
Parameters”…””}”(hjyhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjvhj2hKubj4
)”}”(hhh]”j,)”}”(hhh]”(j7)”}”(hhh]”h@)”}”(hŒ'data (str) -- the data that was signed.”h]”(j8)”}”(hŒdata”h]”hŒdata”…””}”(hj”hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”h؈uh*j7hjubhŒ (”…””}”(hjhhhNhNubhµ)”}”(hhh]”jx)”}”(hŒstr”h]”hŒstr”…””}”(hj©hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*jwhj¦ubah}”(h ]”h"]”h$]”h&]”h(]”Œ	refdomain”Œpy”Œrefexplicit”‰Œreftype”j‘Œ	reftarget”j«h؈uh*h´hjubhŒ
)”…””}”(hjhhhNhNubhŒ – ”…””}”(hjhhhNhNubhŒthe data that was signed.”…””}”(hjhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjubah}”(h ]”h"]”h$]”h&]”h(]”uh*j6hjŠubj7)”}”(hhh]”h@)”}”(hŒ)msg (Message) -- an SSH signature message”h]”(j8)”}”(hŒmsg”h]”hŒmsg”…””}”(hjáhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”h؈uh*j7hjÝubhŒ (”…””}”(hjÝhhhNhNubhµ)”}”(hhh]”jx)”}”(hŒ.Message”h]”hŒMessage”…””}”(hjöhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*jwhjóubah}”(h ]”h"]”h$]”h&]”h(]”Œ	refdomain”j¾Œrefexplicit”‰Œreftype”j‘Œ	reftarget”ŒMessage”h؈uh*h´hjÝubhŒ
)”…””}”(hjÝhhhNhNubhŒ – ”…””}”(hjÝhhhNhNubhŒan SSH signature message”…””}”(hjÝhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjÚubah}”(h ]”h"]”h$]”h&]”h(]”uh*j6hjŠubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j+hj‡ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjvubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjsubj
)”}”(hhh]”(j$
)”}”(hŒReturns”h]”hŒReturns”…””}”(hj<hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hj9hj2hKubj4
)”}”(hhh]”h@)”}”(hŒ:True if the signature verifies correctly; False otherwise.”h]”(h»)”}”(hŒ``True``”h]”hŒTrue”…””}”(hjQhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhjMhhhNhNubhŒ& if the signature verifies correctly; ”…””}”(hjMhhhNhNubh»)”}”(hŒ	``False``”h]”hŒFalse”…””}”(hjchhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhjMhhhNhNubhŒ otherwise.”…””}”(hjMhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjJubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hj9ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjsubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjahhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjhhhj2hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
j¾jþ
Œmethod”jj™j
‰uh*h^hhhjñhNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ4write_private_key() (paramiko.agent.AgentKey method)”Œ)paramiko.agent.AgentKey.write_private_key”hNt”auh*h-hjñhhhNhNubh_)”}”(hhh]”(hd)”}”(hŒ3AgentKey.write_private_key(file_obj, password=None)”h]”(h)”}”(hŒwrite_private_key”h]”hŒwrite_private_key”…””}”(hj¯hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj«hhhŒi/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.write_private_key”hNubjÍ
)”}”(hŒfile_obj, password=None”h]”(j)”}”(hŒfile_obj”h]”hŒfile_obj”…””}”(hjÂhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhj¾ubj)”}”(hŒ
password=None”h]”hŒ
password=None”…””}”(hjÐhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhj¾ubeh}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj«hhhj½hNubeh}”(h ]”j¦ah"]”h$]”j¦ah&]”h(]”h¢‰h£Œparamiko.agent”h¥j¸h¦ŒAgentKey.write_private_key”uh*hchj¨hhhj½hNubh¨)”}”(hhh]”(h@)”}”(hŒ„Write private key contents into a file (or file-like) object.  If the
password is not ``None``, the key is encrypted before writing.”h]”(hŒVWrite private key contents into a file (or file-like) object.  If the
password is not ”…””}”(hjïhhhNhNubh»)”}”(hŒ``None``”h]”hŒNone”…””}”(hj÷hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhjïubhŒ&, the key is encrypted before writing.”…””}”(hjïhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒi/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.write_private_key”hK
hjìhhubj
)”}”(hhh]”(j
)”}”(hhh]”(j$
)”}”(hŒ
Parameters”h]”hŒ
Parameters”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjhj½hKubj4
)”}”(hhh]”j,)”}”(hhh]”(j7)”}”(hhh]”h@)”}”(hŒ.file_obj -- the file-like object to write into”h]”(j8)”}”(hŒfile_obj”h]”hŒfile_obj”…””}”(hj1hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”h؈uh*j7hj-ubhŒ – ”…””}”(hj-hhhNhNubhŒ"the file-like object to write into”…””}”(hj-hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj*ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j6hj'ubj7)”}”(hhh]”h@)”}”(hŒ@password (str) -- an optional password to use to encrypt the key”h]”(j8)”}”(hŒpassword”h]”hŒpassword”…””}”(hjZhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”h؈uh*j7hjVubhŒ (”…””}”(hjVhhhNhNubhµ)”}”(hhh]”jx)”}”(hŒstr”h]”hŒstr”…””}”(hjohhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*jwhjlubah}”(h ]”h"]”h$]”h&]”h(]”Œ	refdomain”Œpy”Œrefexplicit”‰Œreftype”j‘Œ	reftarget”jqh؈uh*h´hjVubhŒ
)”…””}”(hjVhhhNhNubhŒ – ”…””}”(hjVhhhNhNubhŒ.an optional password to use to encrypt the key”…””}”(hjVhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjSubah}”(h ]”h"]”h$]”h&]”h(]”uh*j6hj'ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j+hj$ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjubj
)”}”(hhh]”(j$
)”}”(hŒraises”h]”hŒRaises”…””}”(hjµhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hj²hjhKubj4
)”}”(hŒ8``IOError`` -- if there was an error writing to the file”h]”h@)”}”(hjÅh]”(h»)”}”(hŒ``IOError``”h]”hŒIOError”…””}”(hjÊhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhjÇubhŒ. – if there was an error writing to the file”…””}”(hjÇhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhjÃubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hj²ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjhKhjhhubj
)”}”(hhh]”(j$
)”}”(hŒraises”h]”hŒRaises”…””}”(hjñhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjîhjhKubj4
)”}”(hŒ(`.SSHException` -- if the key is invalid”h]”h@)”}”(hj
h]”(hµ)”}”(hŒ`.SSHException`”h]”h»)”}”(hjh]”hŒSSHException”…””}”(hj
hhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhjubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”jŒrefexplicit”‰hÖjêh×j¸h؈hٌSSHException”hÛhÜh݉uh*h´hNhNhjubhŒ – if the key is invalid”…””}”(hjhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhjÿubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjîubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjhKhjhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjìhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj¨hhhj½hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
j„jþ
Œmethod”jjLj
‰uh*h^hhhjñhNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ9write_private_key_file() (paramiko.agent.AgentKey method)”Œ.paramiko.agent.AgentKey.write_private_key_file”hNt”auh*h-hjñhhhNhNubh_)”}”(hhh]”(hd)”}”(hŒ8AgentKey.write_private_key_file(filename, password=None)”h]”(h)”}”(hŒwrite_private_key_file”h]”hŒwrite_private_key_file”…””}”(hjbhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj^hhhŒn/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.write_private_key_file”hNubjÍ
)”}”(hŒfilename, password=None”h]”(j)”}”(hŒfilename”h]”hŒfilename”…””}”(hjuhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhjqubj)”}”(hŒ
password=None”h]”hŒ
password=None”…””}”(hjƒhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhjqubeh}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj^hhhjphNubeh}”(h ]”jYah"]”h$]”jYah&]”h(]”h¢‰h£Œparamiko.agent”h¥j¸h¦ŒAgentKey.write_private_key_file”uh*hchj[hhhjphNubh¨)”}”(hhh]”(h@)”}”(hŒnWrite private key contents into a file.  If the password is not
``None``, the key is encrypted before writing.”h]”(hŒ@Write private key contents into a file.  If the password is not
”…””}”(hj¢hhhNhNubh»)”}”(hŒ``None``”h]”hŒNone”…””}”(hjªhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhj¢ubhŒ&, the key is encrypted before writing.”…””}”(hj¢hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒn/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentKey.write_private_key_file”hK
hjŸhhubj
)”}”(hhh]”(j
)”}”(hhh]”(j$
)”}”(hŒ
Parameters”h]”hŒ
Parameters”…””}”(hjÉhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjÆhjphKubj4
)”}”(hhh]”j,)”}”(hhh]”(j7)”}”(hhh]”h@)”}”(hŒ+filename (str) -- name of the file to write”h]”(j8)”}”(hŒfilename”h]”hŒfilename”…””}”(hjähhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”h؈uh*j7hjàubhŒ (”…””}”(hjàhhhNhNubhµ)”}”(hhh]”jx)”}”(hŒstr”h]”hŒstr”…””}”(hjùhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*jwhjöubah}”(h ]”h"]”h$]”h&]”h(]”Œ	refdomain”Œpy”Œrefexplicit”‰Œreftype”j‘Œ	reftarget”jûh؈uh*h´hjàubhŒ
)”…””}”(hjàhhhNhNubhŒ – ”…””}”(hjàhhhNhNubhŒname of the file to write”…””}”(hjàhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjÝubah}”(h ]”h"]”h$]”h&]”h(]”uh*j6hjÚubj7)”}”(hhh]”h@)”}”(hŒEpassword (str) -- an optional password to use to encrypt the key file”h]”(j8)”}”(hŒpassword”h]”hŒpassword”…””}”(hj1hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”h؈uh*j7hj-ubhŒ (”…””}”(hj-hhhNhNubhµ)”}”(hhh]”jx)”}”(hŒstr”h]”hŒstr”…””}”(hjFhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*jwhjCubah}”(h ]”h"]”h$]”h&]”h(]”Œ	refdomain”jŒrefexplicit”‰Œreftype”j‘Œ	reftarget”jHh؈uh*h´hj-ubhŒ
)”…””}”(hj-hhhNhNubhŒ – ”…””}”(hj-hhhNhNubhŒ3an optional password to use to encrypt the key file”…””}”(hj-hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj*ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j6hjÚubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j+hj×ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjÆubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjÃubj
)”}”(hhh]”(j$
)”}”(hŒraises”h]”hŒRaises”…””}”(hj‹hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjˆhjÂhKubj4
)”}”(hŒ5``IOError`` -- if there was an error writing the file”h]”h@)”}”(hj›h]”(h»)”}”(hŒ``IOError``”h]”hŒIOError”…””}”(hj hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhjubhŒ+ – if there was an error writing the file”…””}”(hjhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjÂhKhj™ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjˆubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjÂhKhjÃhhubj
)”}”(hhh]”(j$
)”}”(hŒraises”h]”hŒRaises”…””}”(hjÇhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjÄhjÂhKubj4
)”}”(hŒ(`.SSHException` -- if the key is invalid”h]”h@)”}”(hj×h]”(hµ)”}”(hŒ`.SSHException`”h]”h»)”}”(hjÞh]”hŒSSHException”…””}”(hjàhhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhjÜubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”jêŒrefexplicit”‰hÖjh×j¸h؈hٌSSHException”hÛhÜh݉uh*h´hNhNhjÙubhŒ – if the key is invalid”…””}”(hjÙhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjÂhK	hjÕubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjÄubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjÂhK	hjÃhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjŸhhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj[hhhjphNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
jjþ
Œmethod”jj"j
‰uh*h^hhhjñhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj’hhhj§hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œclass”jj0j
‰uh*h^hhhhhNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ)AgentLocalProxy (class in paramiko.agent)”Œparamiko.agent.AgentLocalProxy”hNt”auh*h-hhhhhNhNubh_)”}”(hhh]”(hd)”}”(hŒAgentLocalProxy(agent)”h]”(hj)”}”(hŒclass ”h]”hŒclass ”…””}”(hjFhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hihjBhhhŒ^/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy”hNubh})”}”(hŒparamiko.agent.”h]”hŒparamiko.agent.”…””}”(hjUhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*h|hjBhhhjThNubh)”}”(hŒAgentLocalProxy”h]”hŒAgentLocalProxy”…””}”(hjchhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjBhhhjThNubjÍ
)”}”(hŒagent”h]”j)”}”(hŒagent”h]”hŒagent”…””}”(hjuhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhjqubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjBhhhjThNubeh}”(h ]”j=ah"]”h$]”j=ah&]”h(]”h¢‰h£Œparamiko.agent”h¥hh¦jeuh*hchj?hhhjThNubh¨)”}”(hhh]”(h@)”}”(hŒzClass to be used when wanting to ask a local SSH Agent being
asked from a remote fake agent (so use a unix socket for ex.)”h]”hŒzClass to be used when wanting to ask a local SSH Agent being
asked from a remote fake agent (so use a unix socket for ex.)”…””}”(hj“hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒ^/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy”hK
hjhhubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ1daemon (paramiko.agent.AgentLocalProxy attribute)”Œ%paramiko.agent.AgentLocalProxy.daemon”hNt”auh*h-hjhhhŒe/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.daemon”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentLocalProxy.daemon”h]”h)”}”(hŒdaemon”h]”hŒdaemon”…””}”(hj¸hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj´hhhŒe/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.daemon”hNubah}”(h ]”j®ah"]”h$]”j®ah&]”h(]”h¢‰h£Œparamiko.agent”h¥jeh¦ŒAgentLocalProxy.daemon”uh*hchj±hhhjÆhNubh¨)”}”(hhh]”(h@)”}”(hŒBA boolean value indicating whether this thread is a daemon thread.”h]”hŒBA boolean value indicating whether this thread is a daemon thread.”…””}”(hjÒhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj°hK
hjÏhhubh@)”}”(hŒüThis must be set before start() is called, otherwise RuntimeError is
raised. Its initial value is inherited from the creating thread; the
main thread is not a daemon thread and therefore all threads created in
the main thread default to daemon = False.”h]”hŒüThis must be set before start() is called, otherwise RuntimeError is
raised. Its initial value is inherited from the creating thread; the
main thread is not a daemon thread and therefore all threads created in
the main thread default to daemon = False.”…””}”(hjàhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj°hKhjÏhhubh@)”}”(hŒJThe entire Python program exits when no alive non-daemon threads are
left.”h]”hŒJThe entire Python program exits when no alive non-daemon threads are
left.”…””}”(hjîhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj°hKhjÏhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj±hhhjÆhNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œ	attribute”jj	j
‰uh*h^hhhjhj°hNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ8get_connection() (paramiko.agent.AgentLocalProxy method)”Œ-paramiko.agent.AgentLocalProxy.get_connection”hNt”auh*h-hjhhhŒm/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.get_connection”hNubh_)”}”(hhh]”(hd)”}”(hŒ AgentLocalProxy.get_connection()”h]”(h)”}”(hŒget_connection”h]”hŒget_connection”…””}”(hj hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjhhhŒm/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.get_connection”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjhhhj.hNubeh}”(h ]”jah"]”h$]”jah&]”h(]”h¢‰h£Œparamiko.agent”h¥jeh¦ŒAgentLocalProxy.get_connection”uh*hchjhhhj.hNubh¨)”}”(hhh]”(h@)”}”(hŒ2Return a pair of socket object and string address.”h]”hŒ2Return a pair of socket object and string address.”…””}”(hjChhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhK
hj@hhubh@)”}”(hŒ
May block!”h]”hŒ
May block!”…””}”(hjQhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhj@hhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjhhhj.hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jjlj
‰uh*h^hhhjhjhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ0ident (paramiko.agent.AgentLocalProxy attribute)”Œ$paramiko.agent.AgentLocalProxy.ident”hNt”auh*h-hjhhhŒd/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.ident”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentLocalProxy.ident”h]”h)”}”(hŒident”h]”hŒident”…””}”(hjƒhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjhhhŒd/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.ident”hNubah}”(h ]”jyah"]”h$]”jyah&]”h(]”h¢‰h£Œparamiko.agent”h¥jeh¦ŒAgentLocalProxy.ident”uh*hchj|hhhj‘hNubh¨)”}”(hhh]”(h@)”}”(hŒDThread identifier of this thread or None if it has not been started.”h]”hŒDThread identifier of this thread or None if it has not been started.”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj{hK
hjšhhubh@)”}”(hŒÌThis is a nonzero integer. See the get_ident() function. Thread
identifiers may be recycled when a thread exits and another thread is
created. The identifier is available even after the thread has exited.”h]”hŒÌThis is a nonzero integer. See the get_ident() function. Thread
identifiers may be recycled when a thread exits and another thread is
created. The identifier is available even after the thread has exited.”…””}”(hj«hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj{hKhjšhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj|hhhj‘hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œ	attribute”jjÆj
‰uh*h^hhhjhj{hNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ1isAlive() (paramiko.agent.AgentLocalProxy method)”Œ&paramiko.agent.AgentLocalProxy.isAlive”hNt”auh*h-hjhhhŒf/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.isAlive”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentLocalProxy.isAlive()”h]”(h)”}”(hŒisAlive”h]”hŒisAlive”…””}”(hjÝhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjÙhhhŒf/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.isAlive”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjÙhhhjëhNubeh}”(h ]”jÓah"]”h$]”jÓah&]”h(]”h¢‰h£Œparamiko.agent”h¥jeh¦ŒAgentLocalProxy.isAlive”uh*hchjÖhhhjëhNubh¨)”}”(hhh]”(h@)”}”(hŒ#Return whether the thread is alive.”h]”hŒ#Return whether the thread is alive.”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjÕhK
hjýhhubh@)”}”(hŒ¯This method returns True just before the run() method starts until just
after the run() method terminates. The module function enumerate()
returns a list of all alive threads.”h]”hŒ¯This method returns True just before the run() method starts until just
after the run() method terminates. The module function enumerate()
returns a list of all alive threads.”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjÕhKhjýhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjÖhhhjëhNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jj)j
‰uh*h^hhhjhjÕhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ2is_alive() (paramiko.agent.AgentLocalProxy method)”Œ'paramiko.agent.AgentLocalProxy.is_alive”hNt”auh*h-hjhhhŒg/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.is_alive”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentLocalProxy.is_alive()”h]”(h)”}”(hŒis_alive”h]”hŒis_alive”…””}”(hj@hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj<hhhŒg/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.is_alive”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj<hhhjNhNubeh}”(h ]”j6ah"]”h$]”j6ah&]”h(]”h¢‰h£Œparamiko.agent”h¥jeh¦ŒAgentLocalProxy.is_alive”uh*hchj9hhhjNhNubh¨)”}”(hhh]”(h@)”}”(hŒ#Return whether the thread is alive.”h]”hŒ#Return whether the thread is alive.”…””}”(hjchhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj8hK
hj`hhubh@)”}”(hŒ¯This method returns True just before the run() method starts until just
after the run() method terminates. The module function enumerate()
returns a list of all alive threads.”h]”hŒ¯This method returns True just before the run() method starts until just
after the run() method terminates. The module function enumerate()
returns a list of all alive threads.”…””}”(hjqhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj8hKhj`hhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj9hhhjNhNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jjŒj
‰uh*h^hhhjhj8hNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ.join() (paramiko.agent.AgentLocalProxy method)”Œ#paramiko.agent.AgentLocalProxy.join”hNt”auh*h-hjhhhŒc/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.join”•ùÊhNubh_)”}”(hhh]”(hd)”}”(hŒ"AgentLocalProxy.join(timeout=None)”h]”(h)”}”(hŒjoin”h]”hŒjoin”…””}”(hj£hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjŸhhhŒc/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.join”hNubjÍ
)”}”(hŒtimeout=None”h]”j)”}”(hŒtimeout=None”h]”hŒtimeout=None”…””}”(hj¶hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhj²ubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjŸhhhj±hNubeh}”(h ]”j™ah"]”h$]”j™ah&]”h(]”h¢‰h£Œparamiko.agent”h¥jeh¦ŒAgentLocalProxy.join”uh*hchjœhhhj±hNubh¨)”}”(hhh]”(h@)”}”(hŒ!Wait until the thread terminates.”h]”hŒ!Wait until the thread terminates.”…””}”(hjÕhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj›hK
hjÒhhubh@)”}”(hŒ³This blocks the calling thread until the thread whose join() method is
called terminates -- either normally or through an unhandled exception
or until the optional timeout occurs.”h]”hŒ´This blocks the calling thread until the thread whose join() method is
called terminates – either normally or through an unhandled exception
or until the optional timeout occurs.”…””}”(hjãhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj›hKhjÒhhubh@)”}”(hXF
When the timeout argument is present and not None, it should be a
floating point number specifying a timeout for the operation in seconds
(or fractions thereof). As join() always returns None, you must call
isAlive() after join() to decide whether a timeout happened -- if the
thread is still alive, the join() call timed out.”h]”hXG
When the timeout argument is present and not None, it should be a
floating point number specifying a timeout for the operation in seconds
(or fractions thereof). As join() always returns None, you must call
isAlive() after join() to decide whether a timeout happened – if the
thread is still alive, the join() call timed out.”…””}”(hjñhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj›hKhjÒhhubh@)”}”(hŒgWhen the timeout argument is not present or None, the operation will
block until the thread terminates.”h]”hŒgWhen the timeout argument is not present or None, the operation will
block until the thread terminates.”…””}”(hjÿhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj›hK
hjÒhhubh@)”}”(hŒ$A thread can be join()ed many times.”h]”hŒ$A thread can be join()ed many times.”…””}”(hj
hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj›hKhjÒhhubh@)”}”(hŒàjoin() raises a RuntimeError if an attempt is made to join the current
thread as that would cause a deadlock. It is also an error to join() a
thread before it has been started and attempts to do so raises the same
exception.”h]”hŒàjoin() raises a RuntimeError if an attempt is made to join the current
thread as that would cause a deadlock. It is also an error to join() a
thread before it has been started and attempts to do so raises the same
exception.”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj›hKhjÒhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjœhhhj±hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jj6j
‰uh*h^hhhjhj›hNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ/name (paramiko.agent.AgentLocalProxy attribute)”Œ#paramiko.agent.AgentLocalProxy.name”hNt”auh*h-hjhhhŒc/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.name”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentLocalProxy.name”h]”h)”}”(hŒname”h]”hŒname”…””}”(hjMhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjIhhhŒc/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.name”hNubah}”(h ]”jCah"]”h$]”jCah&]”h(]”h¢‰h£Œparamiko.agent”h¥jeh¦ŒAgentLocalProxy.name”uh*hchjFhhhj[hNubh¨)”}”(hhh]”(h@)”}”(hŒ/A string used for identification purposes only.”h]”hŒ/A string used for identification purposes only.”…””}”(hjghhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjEhK
hjdhhubh@)”}”(hŒmIt has no semantics. Multiple threads may be given the same name. The
initial name is set by the constructor.”h]”hŒmIt has no semantics. Multiple threads may be given the same name. The
initial name is set by the constructor.”…””}”(hjuhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjEhKhjdhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjFhhhj[hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œ	attribute”jjj
‰uh*h^hhhjhjEhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ/start() (paramiko.agent.AgentLocalProxy method)”Œ$paramiko.agent.AgentLocalProxy.start”hNt”auh*h-hjhhhŒd/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.start”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentLocalProxy.start()”h]”(h)”}”(hŒstart”h]”hŒstart”…””}”(hj§hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj£hhhŒd/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentLocalProxy.start”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj£hhhjµhNubeh}”(h ]”jah"]”h$]”jah&]”h(]”h¢‰h£Œparamiko.agent”h¥jeh¦ŒAgentLocalProxy.start”uh*hchj hhhjµhNubh¨)”}”(hhh]”(h@)”}”(hŒStart the thread's activity.”h]”hŒStart the thread’s activity.”…””}”(hjÊhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjŸhK
hjÇhhubh@)”}”(hŒŠIt must be called at most once per thread object. It arranges for the
object's run() method to be invoked in a separate thread of control.”h]”hŒŒIt must be called at most once per thread object. It arranges for the
object’s run() method to be invoked in a separate thread of control.”…””}”(hjØhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjŸhKhjÇhhubh@)”}”(hŒYThis method will raise a RuntimeError if called more than once on the
same thread object.”h]”hŒYThis method will raise a RuntimeError if called more than once on the
same thread object.”…””}”(hjæhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjŸhKhjÇhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj hhhjµhNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jj
j
‰uh*h^hhhjhjŸhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj?hhhjThNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œclass”jjj
‰uh*h^hhhhhNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ*AgentProxyThread (class in paramiko.agent)”Œparamiko.agent.AgentProxyThread”hNt”auh*h-hhhhhNhNubh_)”}”(hhh]”(hd)”}”(hŒAgentProxyThread(agent)”h]”(hj)”}”(hŒclass ”h]”hŒclass ”…””}”(hj%hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hihj!hhhŒ_/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread”hNubh})”}”(hŒparamiko.agent.”h]”hŒparamiko.agent.”…””}”(hj4hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*h|hj!hhhj3hNubh)”}”(hŒAgentProxyThread”h]”hŒAgentProxyThread”…””}”(hjBhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj!hhhj3hNubjÍ
)”}”(hŒagent”h]”j)”}”(hŒagent”h]”hŒagent”…””}”(hjThhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhjPubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj!hhhj3hNubeh}”(h ]”jah"]”h$]”jah&]”h(]”h¢‰h£Œparamiko.agent”h¥hh¦jDuh*hchjhhhj3hNubh¨)”}”(hhh]”(h@)”}”(hŒ6Class in charge of communication between two channels.”h]”hŒ6Class in charge of communication between two channels.”…””}”(hjrhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒ_/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread”hK
hjohhubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ2daemon (paramiko.agent.AgentProxyThread attribute)”Œ&paramiko.agent.AgentProxyThread.daemon”hNt”auh*h-hjohhhŒf/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread.daemon”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentProxyThread.daemon”h]”h)”}”(hŒdaemon”h]”hŒdaemon”…””}”(hj—hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj“hhhŒf/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread.daemon”hNubah}”(h ]”jah"]”h$]”jah&]”h(]”h¢‰h£Œparamiko.agent”h¥jDh¦ŒAgentProxyThread.daemon”uh*hchjhhhj¥hNubh¨)”}”(hhh]”(h@)”}”(hŒBA boolean value indicating whether this thread is a daemon thread.”h]”hŒBA boolean value indicating whether this thread is a daemon thread.”…””}”(hj±hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhK
hj®hhubh@)”}”(hŒüThis must be set before start() is called, otherwise RuntimeError is
raised. Its initial value is inherited from the creating thread; the
main thread is not a daemon thread and therefore all threads created in
the main thread default to daemon = False.”h]”hŒüThis must be set before start() is called, otherwise RuntimeError is
raised. Its initial value is inherited from the creating thread; the
main thread is not a daemon thread and therefore all threads created in
the main thread default to daemon = False.”…””}”(hj¿hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhj®hhubh@)”}”(hŒJThe entire Python program exits when no alive non-daemon threads are
left.”h]”hŒJThe entire Python program exits when no alive non-daemon threads are
left.”…””}”(hjÍhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhj®hhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjhhhj¥hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œ	attribute”jjèj
‰uh*h^hhhjohjhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ1ident (paramiko.agent.AgentProxyThread attribute)”Œ%paramiko.agent.AgentProxyThread.ident”hNt”auh*h-hjohhhŒe/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread.ident”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentProxyThread.ident”h]”h)”}”(hŒident”h]”hŒident”…””}”(hjÿhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjûhhhŒe/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread.ident”hNubah}”(h ]”jõah"]”h$]”jõah&]”h(]”h¢‰h£Œparamiko.agent”h¥jDh¦ŒAgentProxyThread.ident”uh*hchjøhhhj
hNubh¨)”}”(hhh]”(h@)”}”(hŒDThread identifier of this thread or None if it has not been started.”h]”hŒDThread identifier of this thread or None if it has not been started.”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj÷hK
hjhhubh@)”}”(hŒÌThis is a nonzero integer. See the get_ident() function. Thread
identifiers may be recycled when a thread exits and another thread is
created. The identifier is available even after the thread has exited.”h]”hŒÌThis is a nonzero integer. See the get_ident() function. Thread
identifiers may be recycled when a thread exits and another thread is
created. The identifier is available even after the thread has exited.”…””}”(hj'hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj÷hKhjhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjøhhhj
hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œ	attribute”jjBj
‰uh*h^hhhjohj÷hNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ2isAlive() (paramiko.agent.AgentProxyThread method)”Œ'paramiko.agent.AgentProxyThread.isAlive”hNt”auh*h-hjohhhŒg/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread.isAlive”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentProxyThread.isAlive()”h]”(h)”}”(hŒisAlive”h]”hŒisAlive”…””}”(hjYhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjUhhhŒg/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread.isAlive”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjUhhhjghNubeh}”(h ]”jOah"]”h$]”jOah&]”h(]”h¢‰h£Œparamiko.agent”h¥jDh¦ŒAgentProxyThread.isAlive”uh*hchjRhhhjghNubh¨)”}”(hhh]”(h@)”}”(hŒ#Return whether the thread is alive.”h]”hŒ#Return whether the thread is alive.”…””}”(hj|hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjQhK
hjyhhubh@)”}”(hŒ¯This method returns True just before the run() method starts until just
after the run() method terminates. The module function enumerate()
returns a list of all alive threads.”h]”hŒ¯This method returns True just before the run() method starts until just
after the run() method terminates. The module function enumerate()
returns a list of all alive threads.”…””}”(hjŠhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjQhKhjyhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjRhhhjghNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jj¥j
‰uh*h^hhhjohjQhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ3is_alive() (paramiko.agent.AgentProxyThread method)”Œ(paramiko.agent.AgentProxyThread.is_alive”hNt”auh*h-hjohhhŒh/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread.is_alive”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentProxyThread.is_alive()”h]”(h)”}”(hŒis_alive”h]”hŒis_alive”…””}”(hj¼hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj¸hhhŒh/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread.is_alive”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj¸hhhjÊhNubeh}”(h ]”j²ah"]”h$]”j²ah&]”h(]”h¢‰h£Œparamiko.agent”h¥jDh¦ŒAgentProxyThread.is_alive”uh*hchjµhhhjÊhNubh¨)”}”(hhh]”(h@)”}”(hŒ#Return whether the thread is alive.”h]”hŒ#Return whether the thread is alive.”…””}”(hjßhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj´hK
hjÜhhubh@)”}”(hŒ¯This method returns True just before the run() method starts until just
after the run() method terminates. The module function enumerate()
returns a list of all alive threads.”h]”hŒ¯This method returns True just before the run() method starts until just
after the run() method terminates. The module function enumerate()
returns a list of all alive threads.”…””}”(hjíhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj´hKhjÜhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjµhhhjÊhNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jjj
‰uh*h^hhhjohj´hNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ/join() (paramiko.agent.AgentProxyThread method)”Œ$paramiko.agent.AgentProxyThread.join”hNt”auh*h-hjohhhŒd/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread.join”hNubh_)”}”(hhh]”(hd)”}”(hŒ#AgentProxyThread.join(timeout=None)”h]”(h)”}”(hŒjoin”h]”hŒjoin”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjhhhŒd/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread.join”hNubjÍ
)”}”(hŒtimeout=None”h]”j)”}”(hŒtimeout=None”h]”hŒtimeout=None”…””}”(hj2hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhj.ubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjhhhj-hNubeh}”(h ]”jah"]”h$]”jah&]”h(]”h¢‰h£Œparamiko.agent”h¥jDh¦ŒAgentProxyThread.join”uh*hchjhhhj-hNubh¨)”}”(hhh]”(h@)”}”(hŒ!Wait until the thread terminates.”h]”hŒ!Wait until the thread terminates.”…””}”(hjQhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhK
hjNhhubh@)”}”(hŒ³This blocks the calling thread until the thread whose join() method is
called terminates -- either normally or through an unhandled exception
or until the optional timeout occurs.”h]”hŒ´This blocks the calling thread until the thread whose join() method is
called terminates – either normally or through an unhandled exception
or until the optional timeout occurs.”…””}”(hj_hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhjNhhubh@)”}”(hXF
When the timeout argument is present and not None, it should be a
floating point number specifying a timeout for the operation in seconds
(or fractions thereof). As join() always returns None, you must call
isAlive() after join() to decide whether a timeout happened -- if the
thread is still alive, the join() call timed out.”h]”hXG
When the timeout argument is present and not None, it should be a
floating point number specifying a timeout for the operation in seconds
(or fractions thereof). As join() always returns None, you must call
isAlive() after join() to decide whether a timeout happened – if the
thread is still alive, the join() call timed out.”…””}”(hjmhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhjNhhubh@)”}”(hŒgWhen the timeout argument is not present or None, the operation will
block until the thread terminates.”h]”hŒgWhen the timeout argument is not present or None, the operation will
block until the thread terminates.”…””}”(hj{hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhK
hjNhhubh@)”}”(hŒ$A thread can be join()ed many times.”h]”hŒ$A thread can be join()ed many times.”…””}”(hj‰hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhjNhhubh@)”}”(hŒàjoin() raises a RuntimeError if an attempt is made to join the current
thread as that would cause a deadlock. It is also an error to join() a
thread before it has been started and attempts to do so raises the same
exception.”h]”hŒàjoin() raises a RuntimeError if an attempt is made to join the current
thread as that would cause a deadlock. It is also an error to join() a
thread before it has been started and attempts to do so raises the same
exception.”…””}”(hj—hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhjNhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjhhhj-hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jj²j
‰uh*h^hhhjohjhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ0name (paramiko.agent.AgentProxyThread attribute)”Œ$paramiko.agent.AgentProxyThread.name”hNt”auh*h-hjohhhŒd/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread.name”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentProxyThread.name”h]”h)”}”(hŒname”h]”hŒname”…””}”(hjÉhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjÅhhhŒd/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread.name”hNubah}”(h ]”j¿ah"]”h$]”j¿ah&]”h(]”h¢‰h£Œparamiko.agent”h¥jDh¦ŒAgentProxyThread.name”uh*hchjÂhhhj×hNubh¨)”}”(hhh]”(h@)”}”(hŒ/A string used for identification purposes only.”h]”hŒ/A string used for identification purposes only.”…””}”(hjãhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjÁhK
hjàhhubh@)”}”(hŒmIt has no semantics. Multiple threads may be given the same name. The
initial name is set by the constructor.”h]”hŒmIt has no semantics. Multiple threads may be given the same name. The
initial name is set by the constructor.”…””}”(hjñhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjÁhKhjàhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjÂhhhj×hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œ	attribute”jjj
‰uh*h^hhhjohjÁhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ0start() (paramiko.agent.AgentProxyThread method)”Œ%paramiko.agent.AgentProxyThread.start”hNt”auh*h-hjohhhŒe/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread.start”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentProxyThread.start()”h]”(h)”}”(hŒstart”h]”hŒstart”…””}”(hj#hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjhhhŒe/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentProxyThread.start”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjhhhj1hNubeh}”(h ]”jah"]”h$]”jah&]”h(]”h¢‰h£Œparamiko.agent”h¥jDh¦ŒAgentProxyThread.start”uh*hchjhhhj1hNubh¨)”}”(hhh]”(h@)”}”(hŒStart the thread's activity.”h]”hŒStart the thread’s activity.”…””}”(hjFhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhK
hjChhubh@)”}”(hŒŠIt must be called at most once per thread object. It arranges for the
object's run() method to be invoked in a separate thread of control.”h]”hŒŒIt must be called at most once per thread object. It arranges for the
object’s run() method to be invoked in a separate thread of control.”…””}”(hjThhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhjChhubh@)”}”(hŒYThis method will raise a RuntimeError if called more than once on the
same thread object.”h]”hŒYThis method will raise a RuntimeError if called more than once on the
same thread object.”…””}”(hjbhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhjChhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjhhhj1hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jj}j
‰uh*h^hhhjohjhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjhhhj3hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œclass”jj‹j
‰uh*h^hhhhhNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ*AgentRemoteProxy (class in paramiko.agent)”Œparamiko.agent.AgentRemoteProxy”hNt”auh*h-hhhhhNhNubh_)”}”(hhh]”(hd)”}”(hŒAgentRemoteProxy(agent, chan)”h]”(hj)”}”(hŒclass ”h]”hŒclass ”…””}”(hj¡hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hihjhhhŒ_/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy”hNubh})”}”(hŒparamiko.agent.”h]”hŒparamiko.agent.”…””}”(hj°hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*h|hjhhhj¯hNubh)”}”(hŒAgentRemoteProxy”h]”hŒAgentRemoteProxy”…””}”(hj¾hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjhhhj¯hNubjÍ
)”}”(hŒagent, chan”h]”(j)”}”(hŒagent”h]”hŒagent”…””}”(hjÐhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhjÌubj)”}”(hŒchan”h]”hŒchan”…””}”(hjÞhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhjÌubeh}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjhhhj¯hNubeh}”(h ]”j˜ah"]”h$]”j˜ah&]”h(]”h¢‰h£Œparamiko.agent”h¥hh¦jÀuh*hchjšhhhj¯hNubh¨)”}”(hhh]”(h@)”}”(hŒ7Class to be used when wanting to ask a remote SSH Agent”h]”hŒ7Class to be used when wanting to ask a remote SSH Agent”…””}”(hjühhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒ_/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy”hK
hjùhhubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ2daemon (paramiko.agent.AgentRemoteProxy attribute)”Œ&paramiko.agent.AgentRemoteProxy.daemon”hNt”auh*h-hjùhhhŒf/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy.daemon”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentRemoteProxy.daemon”h]”h)”}”(hŒdaemon”h]”hŒdaemon”…””}”(hj!hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjhhhŒf/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy.daemon”hNubah}”(h ]”jah"]”h$]”jah&]”h(]”h¢‰h£Œparamiko.agent”h¥jÀh¦ŒAgentRemoteProxy.daemon”uh*hchjhhhj/hNubh¨)”}”(hhh]”(h@)”}”(hŒBA boolean value indicating whether this thread is a daemon thread.”h]”hŒBA boolean value indicating whether this thread is a daemon thread.”…””}”(hj;hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhK
hj8hhubh@)”}”(hŒüThis must be set before start() is called, otherwise RuntimeError is
raised. Its initial value is inherited from the creating thread; the
main thread is not a daemon thread and therefore all threads created in
the main thread default to daemon = False.”h]”hŒüThis must be set before start() is called, otherwise RuntimeError is
raised. Its initial value is inherited from the creating thread; the
main thread is not a daemon thread and therefore all threads created in
the main thread default to daemon = False.”…””}”(hjIhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhj8hhubh@)”}”(hŒJThe entire Python program exits when no alive non-daemon threads are
left.”h]”hŒJThe entire Python program exits when no alive non-daemon threads are
left.”…””}”(hjWhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhj8hhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjhhhj/hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œ	attribute”jjrj
‰uh*h^hhhjùhjhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ1ident (paramiko.agent.AgentRemoteProxy attribute)”Œ%paramiko.agent.AgentRemoteProxy.ident”hNt”auh*h-hjùhhhŒe/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy.ident”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentRemoteProxy.ident”h]”h)”}”(hŒident”h]”hŒident”…””}”(hj‰hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj…hhhŒe/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy.ident”hNubah}”(h ]”jah"]”h$]”jah&]”h(]”h¢‰h£Œparamiko.agent”h¥jÀh¦ŒAgentRemoteProxy.ident”uh*hchj‚hhhj—hNubh¨)”}”(hhh]”(h@)”}”(hŒDThread identifier of this thread or None if it has not been started.”h]”hŒDThread identifier of this thread or None if it has not been started.”…””}”(hj£hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhK
hj hhubh@)”}”(hŒÌThis is a nonzero integer. See the get_ident() function. Thread
identifiers may be recycled when a thread exits and another thread is
created. The identifier is available even after the thread has exited.”h]”hŒÌThis is a nonzero integer. See the get_ident() function. Thread
identifiers may be recycled when a thread exits and another thread is
created. The identifier is available even after the thread has exited.”…””}”(hj±hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjhKhj hhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj‚hhhj—hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œ	attribute”jjÌj
‰uh*h^hhhjùhjhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ2isAlive() (paramiko.agent.AgentRemoteProxy method)”Œ'paramiko.agent.AgentRemoteProxy.isAlive”hNt”auh*h-hjùhhhŒg/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy.isAlive”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentRemoteProxy.isAlive()”h]”(h)”}”(hŒisAlive”h]”hŒisAlive”…””}”(hjãhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjßhhhŒg/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy.isAlive”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjßhhhjñhNubeh}”(h ]”jÙah"]”h$]”jÙah&]”h(]”h¢‰h£Œparamiko.agent”h¥jÀh¦ŒAgentRemoteProxy.isAlive”uh*hchjÜhhhjñhNubh¨)”}”(hhh]”(h@)”}”(hŒ#Return whether the thread is alive.”h]”hŒ#Return whether the thread is alive.”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjÛhK
hjhhubh@)”}”(hŒ¯This method returns True just before the run() method starts until just
after the run() method terminates. The module function enumerate()
returns a list of all alive threads.”h]”hŒ¯This method returns True just before the run() method starts until just
after the run() method terminates. The module function enumerate()
returns a list of all alive threads.”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjÛhKhjhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjÜhhhjñhNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jj/j
‰uh*h^hhhjùhjÛhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ3is_alive() (paramiko.agent.AgentRemoteProxy method)”Œ(paramiko.agent.AgentRemoteProxy.is_alive”hNt”auh*h-hjùhhhŒh/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy.is_alive”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentRemoteProxy.is_alive()”h]”(h)”}”(hŒis_alive”h]”hŒis_alive”…””}”(hjFhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjBhhhŒh/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy.is_alive”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjBhhhjThNubeh}”(h ]”j<ah"]”h$]”j<ah&]”h(]”h¢‰h£Œparamiko.agent”h¥jÀh¦ŒAgentRemoteProxy.is_alive”uh*hchj?hhhjThNubh¨)”}”(hhh]”(h@)”}”(hŒ#Return whether the thread is alive.”h]”hŒ#Return whether the thread is alive.”…””}”(hjihhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj>hK
hjfhhubh@)”}”(hŒ¯This method returns True just before the run() method starts until just
after the run() method terminates. The module function enumerate()
returns a list of all alive threads.”h]”hŒ¯This method returns True just before the run() method starts until just
after the run() method terminates. The module function enumerate()
returns a list of all alive threads.”…””}”(hjwhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj>hKhjfhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj?hhhjThNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jj’j
‰uh*h^hhhjùhj>hNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ/join() (paramiko.agent.AgentRemoteProxy method)”Œ$paramiko.agent.AgentRemoteProxy.join”hNt”auh*h-hjùhhhŒd/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy.join”hNubh_)”}”(hhh]”(hd)”}”(hŒ#AgentRemoteProxy.join(timeout=None)”h]”(h)”}”(hŒjoin”h]”hŒjoin”…””}”(hj©hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj¥hhhŒd/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy.join”hNubjÍ
)”}”(hŒtimeout=None”h]”j)”}”(hŒtimeout=None”h]”hŒtimeout=None”…””}”(hj¼hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhj¸ubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj¥hhhj·hNubeh}”(h ]”jŸah"]”h$]”jŸah&]”h(]”h¢‰h£Œparamiko.agent”h¥jÀh¦ŒAgentRemoteProxy.join”uh*hchj¢hhhj·hNubh¨)”}”(hhh]”(h@)”}”(hŒ!Wait until the thread terminates.”h]”hŒ!Wait until the thread terminates.”…””}”(hjÛhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj¡hK
hjØhhubh@)”}”(hŒ³This blocks the calling thread until the thread whose join() method is
called terminates -- either normally or through an unhandled exception
or until the optional timeout occurs.”h]”hŒ´This blocks the calling thread until the thread whose join() method is
called terminates – either normally or through an unhandled exception
or until the optional timeout occurs.”…””}”(hjéhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj¡hKhjØhhubh@)”}”(hXF
When the timeout argument is present and not None, it should be a
floating point number specifying a timeout for the operation in seconds
(or fractions thereof). As join() always returns None, you must call
isAlive() after join() to decide whether a timeout happened -- if the
thread is still alive, the join() call timed out.”h]”hXG
When the timeout argument is present and not None, it should be a
floating point number specifying a timeout for the operation in seconds
(or fractions thereof). As join() always returns None, you must call
isAlive() after join() to decide whether a timeout happened – if the
thread is still alive, the join() call timed out.”…””}”(hj÷hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj¡hKhjØhhubh@)”}”(hŒgWhen the timeout argument is not present or None, the operation will
block until the thread terminates.”h]”hŒgWhen the timeout argument is not present or None, the operation will
block until the thread terminates.”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj¡hK
hjØhhubh@)”}”(hŒ$A thread can be join()ed many times.”h]”hŒ$A thread can be join()ed many times.”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj¡hKhjØhhubh@)”}”(hŒàjoin() raises a RuntimeError if an attempt is made to join the current
thread as that would cause a deadlock. It is also an error to join() a
thread before it has been started and attempts to do so raises the same
exception.”h]”hŒàjoin() raises a RuntimeError if an attempt is made to join the current
thread as that would cause a deadlock. It is also an error to join() a
thread before it has been started and attempts to do so raises the same
exception.”…””}”(hj!hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj¡hKhjØhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj¢hhhj·hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jj<j
‰uh*h^hhhjùhj¡hNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ0name (paramiko.agent.AgentRemoteProxy attribute)”Œ$paramiko.agent.AgentRemoteProxy.name”hNt”auh*h-hjùhhhŒd/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy.name”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentRemoteProxy.name”h]”h)”}”(hŒname”h]”hŒname”…””}”(hjShhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjOhhhŒd/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy.name”hNubah}”(h ]”jIah"]”h$]”jIah&]”h(]”h¢‰h£Œparamiko.agent”h¥jÀh¦ŒAgentRemoteProxy.name”uh*hchjLhhhjahNubh¨)”}”(hhh]”(h@)”}”(hŒ/A string used for identification purposes only.”h]”hŒ/A string used for identification purposes only.”…””}”(hjmhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjKhK
hjjhhubh@)”}”(hŒmIt has no semantics. Multiple threads may be given the same name. The
initial name is set by the constructor.”h]”hŒmIt has no semantics. Multiple threads may be given the same name. The
initial name is set by the constructor.”…””}”(hj{hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjKhKhjjhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjLhhhjahNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œ	attribute”jj–j
‰uh*h^hhhjùhjKhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ0start() (paramiko.agent.AgentRemoteProxy method)”Œ%paramiko.agent.AgentRemoteProxy.start”hNt”auh*h-hjùhhhŒe/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy.start”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentRemoteProxy.start()”h]”(h)”}”(hŒstart”h]”hŒstart”…””}”(hj­hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj©hhhŒe/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRemoteProxy.start”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj©hhhj»hNubeh}”(h ]”j£ah"]”h$]”j£ah&]”h(]”h¢‰h£Œparamiko.agent”h¥jÀh¦ŒAgentRemoteProxy.start”uh*hchj¦hhhj»hNubh¨)”}”(hhh]”(h@)”}”(hŒStart the thread's activity.”h]”hŒStart the thread’s activity.”…””}”(hjÐhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj¥hK
hjÍhhubh@)”}”(hŒŠIt must be called at most once per thread object. It arranges for the
object's run() method to be invoked in a separate thread of control.”h]”hŒŒIt must be called at most once per thread object. It arranges for the
object’s run() method to be invoked in a separate thread of control.”…””}”(hjÞhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj¥hKhjÍhhubh@)”}”(hŒYThis method will raise a RuntimeError if called more than once on the
same thread object.”h]”hŒYThis method will raise a RuntimeError if called more than once on the
same thread object.”…””}”(hjìhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj¥hKhjÍhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj¦hhhj»hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jjj
‰uh*h^hhhjùhj¥hNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjšhhhj¯hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œclass”jjj
‰uh*h^hhhhhNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ-AgentRequestHandler (class in paramiko.agent)”Œ"paramiko.agent.AgentRequestHandler”hNt”auh*h-hhhhhŒb/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRequestHandler”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentRequestHandler(chanClient)”h]”(hj)”}”(hŒclass ”h]”hŒclass ”…””}”(hj,hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hihj(hhhŒb/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentRequestHandler”hNubh})”}”(hŒparamiko.agent.”h]”hŒparamiko.agent.”…””}”(hj;hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*h|hj(hhhj:hNubh)”}”(hŒAgentRequestHandler”h]”hŒAgentRequestHandler”…””}”(hjIhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj(hhhj:hNubjÍ
)”}”(hŒ
chanClient”h]”j)”}”(hŒ
chanClient”h]”hŒ
chanClient”…””}”(hj[hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhjWubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj(hhhj:hNubeh}”(h ]”j"ah"]”h$]”j"ah&]”h(]”h¢‰h£Œparamiko.agent”h¥hh¦jKuh*hchj%hhhj:hNubh¨)”}”(hhh]”(h@)”}”(hŒEPrimary/default implementation of SSH agent forwarding functionality.”h]”hŒEPrimary/default implementation of SSH agent forwarding functionality.”…””}”(hjyhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj$hK
hjvhhubh@)”}”(hŒ˜Simply instantiate this class, handing it a live command-executing session
object, and it will handle forwarding any local SSH agent processes it
finds.”h]”hŒ˜Simply instantiate this class, handing it a live command-executing session
object, and it will handle forwarding any local SSH agent processes it
finds.”…””}”(hj‡hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj$hKhjvhhubh@)”}”(hŒ
For example::”h]”hŒFor example:”…””}”(hj•hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj$hKhjvhhubhŒ
literal_block”“”)”}”(hXK
# Connect
client = SSHClient()
client.connect(host, port, username)
# Obtain session
session = client.get_transport().open_session()
# Forward local agent
AgentRequestHandler(session)
# Commands executed after this point will see the forwarded agent on
# the remote end.
session.exec_command("git clone https://my.git.repository/")”h]”hXK
# Connect
client = SSHClient()
client.connect(host, port, username)
# Obtain session
session = client.get_transport().open_session()
# Forward local agent
AgentRequestHandler(session)
# Commands executed after this point will see the forwarded agent on
# the remote end.
session.exec_command("git clone https://my.git.repository/")”…””}”hj¥sbah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*j£hj$hK	hjvhhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hj%hhhj:hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œclass”jjÀj
‰uh*h^hhhhhj$hNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ*AgentServerProxy (class in paramiko.agent)”Œparamiko.agent.AgentServerProxy”hNt”auh*h-hhhhhNhNubh_)”}”(hhh]”(hd)”}”(hŒAgentServerProxy(t)”h]”(hj)”}”(hŒclass ”h]”hŒclass ”…””}”(hjÖhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hihjÒhhhŒ_/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentServerProxy”hNubh})”}”(hŒparamiko.agent.”h]”hŒparamiko.agent.”…””}”(hjåhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*h|hjÒhhhjähNubh)”}”(hŒAgentServerProxy”h]”hŒAgentServerProxy”…””}”(hjóhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjÒhhhjähNubjÍ
)”}”(hŒ
t”h]”j)”}”(hŒ
t”h]”hŒ
t”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jhj
ubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjÒhhhjähNubeh}”(h ]”jÍah"]”h$]”jÍah&]”h(]”h¢‰h£Œparamiko.agent”h¥hh¦jõuh*hchjÏhhhjähNubh¨)”}”(hhh]”(j
)”}”(hhh]”(j
)”}”(hhh]”(j$
)”}”(hŒ
Parameters”h]”hŒ
Parameters”…””}”(hj)hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hj&hjähKubj4
)”}”(hhh]”h@)”}”(hŒFt (Transport) -- Transport used for SSH Agent communication forwarding”h]”(j8)”}”(hjh]”hŒ
t”…””}”(hj>hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”h؈uh*j7hj:ubhŒ (”…””}”(hj:hhhNhNubhµ)”}”(hhh]”jx)”}”(hŒ
.Transport”h]”hŒ	Transport”…””}”(hjRhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*jwhjOubah}”(h ]”h"]”h$]”h&]”h(]”Œ	refdomain”Œpy”Œrefexplicit”‰Œreftype”j‘Œ	reftarget”Œ	Transport”h؈uh*h´hj:ubhŒ
)”…””}”(hj:hhhNhNubhŒ – ”…””}”(hj:hhhNhNubhŒ5Transport used for SSH Agent communication forwarding”…””}”(hj:hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj7ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hj&ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hj#ubj
)”}”(hhh]”(j$
)”}”(hŒraises”h]”hŒRaises”…””}”(hjhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hjŠhŒ_/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentServerProxy”hKubj4
)”}”(hŒ0`.SSHException` -- mostly if we lost the agent

”h]”h@)”}”(hŒ.`.SSHException` -- mostly if we lost the agent”h]”(hµ)”}”(hŒ`.SSHException`”h]”h»)”}”(hj¦h]”hŒSSHException”…””}”(hj¨hhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhj¤ubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”j²Œrefexplicit”‰hÖjh×jõh؈hٌSSHException”hÛhÜh݉uh*h´hNhNhj ubhŒ  – mostly if we lost the agent”…””}”(hj hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj›hKhjœubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hjŠubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hj›hKhj#hhubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hj hhhNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ0close() (paramiko.agent.AgentServerProxy method)”Œ%paramiko.agent.AgentServerProxy.close”hNt”auh*h-hj hhhŒe/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentServerProxy.close”hNubh_)”}”(hhh]”(hd)”}”(hŒAgentServerProxy.close()”h]”(h)”}”(hŒclose”h]”hŒclose”…””}”(hjôhhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjðhhhŒe/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentServerProxy.close”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjðhhhj hNubeh}”(h ]”jêah"]”h$]”jêah&]”h(]”h¢‰h£Œparamiko.agent”h¥jõh¦ŒAgentServerProxy.close”uh*hchjíhhhj hNubh¨)”}”(hhh]”h@)”}”(hŒQTerminate the agent, clean the files, close connections
Should be called manually”h]”hŒQTerminate the agent, clean the files, close connections
Should be called manually”…””}”(hj hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjìhK
hj hhubah}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjíhhhj hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jj2 j
‰uh*h^hhhj hjìhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ2get_env() (paramiko.agent.AgentServerProxy method)”Œ'paramiko.agent.AgentServerProxy.get_env”hNt”auh*h-hj hhhNhNubh_)”}”(hhh]”(hd)”}”(hŒAgentServerProxy.get_env()”h]”(h)”}”(hŒget_env”h]”hŒget_env”…””}”(hjH hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjD hhhŒg/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentServerProxy.get_env”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjD hhhjV hNubeh}”(h ]”j? ah"]”h$]”j? ah&]”h(]”h¢‰h£Œparamiko.agent”h¥jõh¦ŒAgentServerProxy.get_env”uh*hchjA hhhjV hNubh¨)”}”(hhh]”(h@)”}”(hŒ'Helper for the environnement under unix”h]”hŒ'Helper for the environnement under unix”…””}”(hjk hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒg/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentServerProxy.get_env”hK
hjh hhubj
)”}”(hhh]”j
)”}”(hhh]”(j$
)”}”(hŒReturns”h]”hŒReturns”…””}”(hj€ hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hj} hjV hKubj4
)”}”(hhh]”h@)”}”(hŒ;a dict containing the SSH_AUTH_SOCK environnement variables”h]”(hŒa dict containing the ”…””}”(hj‘ hhhNhNubh»)”}”(hŒ``SSH_AUTH_SOCK``”h]”hŒ
SSH_AUTH_SOCK”…””}”(hj™ hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*hºhj‘ hhhNhNubhŒ environnement variables”…””}”(hj‘ hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hjŽ ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hj} ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjz ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j
hjh hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjA hhhjV hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jjÐ j
‰uh*h^hhhj hNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ3get_keys() (paramiko.agent.AgentServerProxy method)”Œ(paramiko.agent.AgentServerProxy.get_keys”hNt”auh*h-hj hhhNhNubh_)”}”(hhh]”(hd)”}”(hŒAgentServerProxy.get_keys()”h]”(h)”}”(hŒget_keys”h]”hŒget_keys”…””}”(hjæ hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhjâ hhhŒh/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentServerProxy.get_keys”hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hjâ hhhjô hNubeh}”(h ]”jÝ ah"]”h$]”jÝ ah&]”h(]”h¢‰h£Œparamiko.agent”h¥jõh¦ŒAgentServerProxy.get_keys”uh*hchjß hhhjô hNubh¨)”}”(hhh]”(h@)”}”(hŒœReturn the list of keys available through the SSH agent, if any.  If
no SSH agent was running (or it couldn't be contacted), an empty list
will be returned.”h]”hŒžReturn the list of keys available through the SSH agent, if any.  If
no SSH agent was running (or it couldn’t be contacted), an empty list
will be returned.”…””}”(hj	!hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒh/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.AgentServerProxy.get_keys”hK
hj!hhubj
)”}”(hhh]”j
)”}”(hhh]”(j$
)”}”(hŒReturns”h]”hŒReturns”…””}”(hj!hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*j#
hj!hjô hKubj4
)”}”(hhh]”h@)”}”(hŒHa tuple of AgentKey objects representing keys available on the
SSH agent”h]”(hŒa tuple of ”…””}”(hj/!hhhNhNubhµ)”}”(hŒ`.AgentKey`”h]”h»)”}”(hj9!h]”hŒAgentKey”…””}”(hj;!hhhNhNubah}”(h ]”h"]”(hƌpy”Œpy-obj”eh$]”h&]”h(]”uh*hºhj7!ubah}”(h ]”h"]”h$]”h&]”h(]”Œreftype”Œobj”Œ	refdomain”jE!Œrefexplicit”‰hÖj!h×jõh؈hٌAgentKey”hÛhÜh݉uh*h´hNhNhj/!hhubhŒ5 objects representing keys available on the
SSH agent”…””}”(hj/!hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h?hj,!ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j3
hj!ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*j
hj!ubah}”(h ]”h"]”h$]”h&]”h(]”uh*j
hj!hhhNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjß hhhjô hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œmethod”jj~!j
‰uh*h^hhhj hNhNubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjÏhhhjähNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
jgjþ
Œclass”jj‹!j
‰uh*h^hhhhhNhNubh.)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”Œentries”]”(h:Œ1get_agent_connection() (in module paramiko.agent)”Œ#paramiko.agent.get_agent_connection”hNt”auh*h-hhhhhNhNubh_)”}”(hhh]”(hd)”}”(hŒget_agent_connection()”h]”(h})”}”(hŒparamiko.agent.”h]”hŒparamiko.agent.”…””}”(hj¡!hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*h|hj!hhhŒc/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.get_agent_connection”hNubh)”}”(hŒget_agent_connection”h]”hŒget_agent_connection”…””}”(hj°!hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*hŒhj!hhhj¯!hNubjÍ
)”}”(hhh]”h}”(h ]”h"]”h$]”h&]”h(]”hyhzuh*jÌ
hj!hhhj¯!hNubeh}”(h ]”j˜!ah"]”h$]”j˜!ah&]”h(]”h¢‰h£Œparamiko.agent”h¥hh¦j²!uh*hchjš!hhhj¯!hNubh¨)”}”(hhh]”(h@)”}”(hŒDReturns some SSH agent object, or None if none were found/supported.”h]”hŒDReturns some SSH agent object, or None if none were found/supported.”…””}”(hjÑ!hhhNhNubah}”(h ]”h"]”h$]”h&]”h(]”uh*h?hŒc/home/jforcier/Code/oss/paramiko/paramiko/agent.py:docstring of paramiko.agent.get_agent_connection”hK
hjÎ!hhubjx
)”}”(hŒNew in version 2.10.”h]”h@)”}”(hŒNew in version 2.10.”h]”j‚
)”}”(hŒNew in version 2.10.”h]”hŒNew in version 2.10.”…””}”(hjè!hhhNhNubah}”(h ]”h"]”jw
ah$]”h&]”h(]”uh*j
hjä!ubah}”(h ]”h"]”h$]”h&]”h(]”Œtranslatable”‰uh*h?hjà!hhhjß!hKubah}”(h ]”h"]”h$]”h&]”h(]”j£
Œversionadded”j¥
Œ2.10”uh*jw
hhhjß!hKhjÎ!ubeh}”(h ]”h"]”h$]”h&]”h(]”uh*h§hjš!hhhj¯!hNubeh}”(h ]”h"]”h$]”h&]”h(]”jü
Œpy”jþ
Œfunction”jj"j
‰uh*h^hhhhhNhNubeh}”(h ]”(Œmodule-paramiko.agent”Œ
ssh-agents”eh"]”h$]”Œ
ssh agents”ah&]”h(]”uh*h	hhhhhh+hKubah}”(h ]”h"]”h$]”h&]”h(]”Œsource”h+uh*h
Œcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(hNŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒ
toc_backlinks”Œentry”Œfootnote_backlinks”K
Œ
sectnum_xform”K
Œstrip_comments”NŒstrip_elements_with_classes”NŒ
strip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”j?"Œerror_encoding”ŒUTF-8”Œerror_encoding_error_handler”Œbackslashreplace”Œ
language_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œ
%”Œ
dump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h+Œ_destination”NŒ
_config_files”]”Œfile_insertion_enabled”ˆŒraw_enabled”K
Œline_length_limit”M'Œpep_references”NŒpep_base_url”Œ https://www.python.org/dev/peps/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œhttps://tools.ietf.org/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”NŒcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œ
docinfo_xform”K
Œsectsubtitle_xform”‰Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒenv”NŒgettext_compact”ˆubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(j"j"h\h\j³
j³
jjjÊjÊjÆjÆjjjjjjjvjvj!j!j,j,jÚjÚjˆjˆj6
j6
jjj¦j¦jYjYj=j=j®j®jjjyjyjÓjÓj6j6j™j™jCjCjjjjjjjõjõjOjOj²j²jjj¿j¿jjj˜j˜jjjjjÙjÙj<j<jŸjŸjIjIj£j£j"j"jÍjÍjêjêj? j? jÝ jÝ j˜!j˜!uŒ	nametypes”}”(j"‰h\ˆj³
ˆjˆjʈjƈjˆjˆjˆjvˆj!ˆj,ˆjÚˆjˆˆj6
ˆjˆj¦ˆjYˆj=ˆj®ˆjˆjyˆjÓˆj6ˆj™ˆjCˆjˆjˆjˆjõˆjOˆj²ˆjˆj¿ˆjˆj˜ˆjˆjˆjÙˆj<ˆjŸˆjIˆj£ˆj"ˆj͈jêˆj? ˆjÝ ˆj˜!ˆuh }”(j"hj"hŒtarget”“”)”}”(hhh]”h}”(h ]”j"ah"]”h$]”h&]”h(]”Œismod”ˆuh*j‚"hhhhhh>hK
ubh\hej³
j¹
jjjÊjÏjÆjÌjj!jj•jjjvj{j!j&j,j1jÚjßjˆjj6
j<
jj j¦j«jYj^j=jBj®j´jjjyjjÓjÙj6j<j™jŸjCjIjj£jj!jj“jõjûjOjUj²j¸jjj¿jÅjjj˜jjjjj…jÙjßj<jBjŸj¥jIjOj£j©j"j(jÍjÒjêjðj? jD jÝ jâ j˜!j!uŒ
footnote_refs”}”Œ
citation_refs”}”Œ
autofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”K
Œsymbol_footnote_start”KŒ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhhub.