root / ncclient / transport / ssh.py @ 216bb34c
History | View | Annotate | Download (12.4 kB)
1 | d095a59e | Shikhar Bhushan | # Copyright 2009 Shikhar Bhushan
|
---|---|---|---|
2 | d095a59e | Shikhar Bhushan | #
|
3 | d095a59e | Shikhar Bhushan | # Licensed under the Apache License, Version 2.0 (the "License");
|
4 | d095a59e | Shikhar Bhushan | # you may not use this file except in compliance with the License.
|
5 | d095a59e | Shikhar Bhushan | # You may obtain a copy of the License at
|
6 | d095a59e | Shikhar Bhushan | #
|
7 | d095a59e | Shikhar Bhushan | # http://www.apache.org/licenses/LICENSE-2.0
|
8 | d095a59e | Shikhar Bhushan | #
|
9 | d095a59e | Shikhar Bhushan | # Unless required by applicable law or agreed to in writing, software
|
10 | d095a59e | Shikhar Bhushan | # distributed under the License is distributed on an "AS IS" BASIS,
|
11 | d095a59e | Shikhar Bhushan | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12 | d095a59e | Shikhar Bhushan | # See the License for the specific language governing permissions and
|
13 | d095a59e | Shikhar Bhushan | # limitations under the License.
|
14 | d095a59e | Shikhar Bhushan | |
15 | d095a59e | Shikhar Bhushan | import os |
16 | d095a59e | Shikhar Bhushan | import socket |
17 | d095a59e | Shikhar Bhushan | from binascii import hexlify |
18 | d095a59e | Shikhar Bhushan | from cStringIO import StringIO |
19 | d095a59e | Shikhar Bhushan | from select import select |
20 | d095a59e | Shikhar Bhushan | |
21 | d095a59e | Shikhar Bhushan | import paramiko |
22 | d095a59e | Shikhar Bhushan | |
23 | c35cebbf | Shikhar Bhushan | from errors import AuthenticationError, SessionCloseError, SSHError, SSHUnknownHostError |
24 | d095a59e | Shikhar Bhushan | from session import Session |
25 | d095a59e | Shikhar Bhushan | |
26 | 41e2ed46 | Shikhar Bhushan | import logging |
27 | 41e2ed46 | Shikhar Bhushan | logger = logging.getLogger('ncclient.transport.ssh')
|
28 | 41e2ed46 | Shikhar Bhushan | |
29 | d095a59e | Shikhar Bhushan | BUF_SIZE = 4096
|
30 | d095a59e | Shikhar Bhushan | MSG_DELIM = ']]>]]>'
|
31 | d095a59e | Shikhar Bhushan | TICK = 0.1
|
32 | d095a59e | Shikhar Bhushan | |
33 | 4f650d54 | Shikhar Bhushan | def default_unknown_host_cb(host, key): |
34 | 4f650d54 | Shikhar Bhushan | """An `unknown host callback` returns :const:`True` if it finds the key
|
35 | 4f650d54 | Shikhar Bhushan | acceptable, and :const:`False` if not.
|
36 | 4f650d54 | Shikhar Bhushan |
|
37 | 216bb34c | Shikhar Bhushan | This default callback always returns :const:`False`, which would lead to
|
38 | 216bb34c | Shikhar Bhushan | :meth:`connect` raising a :exc:`SSHUnknownHost` exception.
|
39 | 4f650d54 | Shikhar Bhushan |
|
40 | 216bb34c | Shikhar Bhushan | Supply another valid callback if you need to verify the host key
|
41 | 216bb34c | Shikhar Bhushan | programatically.
|
42 | 216bb34c | Shikhar Bhushan |
|
43 | 216bb34c | Shikhar Bhushan | :arg host: the host for whom key needs to be verified
|
44 | 216bb34c | Shikhar Bhushan | :type host: string
|
45 | 4f650d54 | Shikhar Bhushan |
|
46 | 216bb34c | Shikhar Bhushan | :arg key: a hex string representing the host key fingerprint
|
47 | 216bb34c | Shikhar Bhushan | :type key: string
|
48 | 4f650d54 | Shikhar Bhushan | """
|
49 | 4f650d54 | Shikhar Bhushan | return False |
50 | 4f650d54 | Shikhar Bhushan | |
51 | 4f650d54 | Shikhar Bhushan | |
52 | d095a59e | Shikhar Bhushan | class SSHSession(Session): |
53 | 4f650d54 | Shikhar Bhushan | |
54 | 4f650d54 | Shikhar Bhushan | "Implements a :rfc:`4742` NETCONF session over SSH."
|
55 | 4f650d54 | Shikhar Bhushan | |
56 | 583c11f6 | Shikhar Bhushan | def __init__(self, capabilities): |
57 | 583c11f6 | Shikhar Bhushan | Session.__init__(self, capabilities)
|
58 | d095a59e | Shikhar Bhushan | self._host_keys = paramiko.HostKeys()
|
59 | d095a59e | Shikhar Bhushan | self._transport = None |
60 | d095a59e | Shikhar Bhushan | self._connected = False |
61 | d095a59e | Shikhar Bhushan | self._channel = None |
62 | 1d540e60 | Shikhar Bhushan | self._expecting_close = False |
63 | d095a59e | Shikhar Bhushan | self._buffer = StringIO() # for incoming data |
64 | d095a59e | Shikhar Bhushan | # parsing-related, see _parse()
|
65 | 4f650d54 | Shikhar Bhushan | self._parsing_state = 0 |
66 | d095a59e | Shikhar Bhushan | self._parsing_pos = 0 |
67 | 4f650d54 | Shikhar Bhushan | |
68 | d095a59e | Shikhar Bhushan | def _parse(self): |
69 | d095a59e | Shikhar Bhushan | '''Messages ae delimited by MSG_DELIM. The buffer could have grown by a
|
70 | d095a59e | Shikhar Bhushan | maximum of BUF_SIZE bytes everytime this method is called. Retains state
|
71 | 4f650d54 | Shikhar Bhushan | across method calls and if a byte has been read it will not be
|
72 | 4f650d54 | Shikhar Bhushan | considered again. '''
|
73 | d095a59e | Shikhar Bhushan | delim = MSG_DELIM |
74 | d095a59e | Shikhar Bhushan | n = len(delim) - 1 |
75 | d095a59e | Shikhar Bhushan | expect = self._parsing_state
|
76 | d095a59e | Shikhar Bhushan | buf = self._buffer
|
77 | d095a59e | Shikhar Bhushan | buf.seek(self._parsing_pos)
|
78 | d095a59e | Shikhar Bhushan | while True: |
79 | d095a59e | Shikhar Bhushan | x = buf.read(1)
|
80 | d095a59e | Shikhar Bhushan | if not x: # done reading |
81 | d095a59e | Shikhar Bhushan | break
|
82 | d095a59e | Shikhar Bhushan | elif x == delim[expect]: # what we expected |
83 | d095a59e | Shikhar Bhushan | expect += 1 # expect the next delim char |
84 | d095a59e | Shikhar Bhushan | else:
|
85 | d095a59e | Shikhar Bhushan | continue
|
86 | d095a59e | Shikhar Bhushan | # loop till last delim char expected, break if other char encountered
|
87 | d095a59e | Shikhar Bhushan | for i in range(expect, n): |
88 | d095a59e | Shikhar Bhushan | x = buf.read(1)
|
89 | d095a59e | Shikhar Bhushan | if not x: # done reading |
90 | d095a59e | Shikhar Bhushan | break
|
91 | d095a59e | Shikhar Bhushan | if x == delim[expect]: # what we expected |
92 | d095a59e | Shikhar Bhushan | expect += 1 # expect the next delim char |
93 | d095a59e | Shikhar Bhushan | else:
|
94 | d095a59e | Shikhar Bhushan | expect = 0 # reset |
95 | d095a59e | Shikhar Bhushan | break
|
96 | d095a59e | Shikhar Bhushan | else: # if we didn't break out of the loop, full delim was parsed |
97 | d095a59e | Shikhar Bhushan | msg_till = buf.tell() - n |
98 | d095a59e | Shikhar Bhushan | buf.seek(0)
|
99 | 41e2ed46 | Shikhar Bhushan | logger.debug('parsed new message')
|
100 | 41e2ed46 | Shikhar Bhushan | self._dispatch_message(buf.read(msg_till).strip())
|
101 | d095a59e | Shikhar Bhushan | buf.seek(n+1, os.SEEK_CUR)
|
102 | d095a59e | Shikhar Bhushan | rest = buf.read() |
103 | d095a59e | Shikhar Bhushan | buf = StringIO() |
104 | d095a59e | Shikhar Bhushan | buf.write(rest) |
105 | d095a59e | Shikhar Bhushan | buf.seek(0)
|
106 | 4ba5e843 | Shikhar Bhushan | expect = 0
|
107 | d095a59e | Shikhar Bhushan | self._buffer = buf
|
108 | d095a59e | Shikhar Bhushan | self._parsing_state = expect
|
109 | d095a59e | Shikhar Bhushan | self._parsing_pos = self._buffer.tell() |
110 | 4f650d54 | Shikhar Bhushan | |
111 | 216bb34c | Shikhar Bhushan | def load_known_hosts(self, filename=None): |
112 | 216bb34c | Shikhar Bhushan | """Load host keys from a :file:`known_hosts`-style file. Can be called multiple
|
113 | 216bb34c | Shikhar Bhushan | times.
|
114 | 216bb34c | Shikhar Bhushan |
|
115 | 216bb34c | Shikhar Bhushan | If *filename* is not specified, looks in the default locations i.e.
|
116 | 216bb34c | Shikhar Bhushan | :file:`~/.ssh/known_hosts` and :file:`~/ssh/known_hosts` for Windows.
|
117 | 216bb34c | Shikhar Bhushan | """
|
118 | d095a59e | Shikhar Bhushan | if filename is None: |
119 | d095a59e | Shikhar Bhushan | filename = os.path.expanduser('~/.ssh/known_hosts')
|
120 | d095a59e | Shikhar Bhushan | try:
|
121 | 216bb34c | Shikhar Bhushan | self._host_keys.load(filename)
|
122 | d095a59e | Shikhar Bhushan | except IOError: |
123 | 4ba5e843 | Shikhar Bhushan | # for windows
|
124 | 4ba5e843 | Shikhar Bhushan | filename = os.path.expanduser('~/ssh/known_hosts')
|
125 | 4ba5e843 | Shikhar Bhushan | try:
|
126 | 216bb34c | Shikhar Bhushan | self._host_keys.load(filename)
|
127 | 4ba5e843 | Shikhar Bhushan | except IOError: |
128 | 4ba5e843 | Shikhar Bhushan | pass
|
129 | 216bb34c | Shikhar Bhushan | else:
|
130 | 216bb34c | Shikhar Bhushan | self._host_keys.load(filename)
|
131 | 4f650d54 | Shikhar Bhushan | |
132 | d095a59e | Shikhar Bhushan | def close(self): |
133 | 583c11f6 | Shikhar Bhushan | self._expecting_close = True |
134 | d095a59e | Shikhar Bhushan | if self._transport.is_active(): |
135 | d095a59e | Shikhar Bhushan | self._transport.close()
|
136 | d095a59e | Shikhar Bhushan | self._connected = False |
137 | 4f650d54 | Shikhar Bhushan | |
138 | 583c11f6 | Shikhar Bhushan | def connect(self, host, port=830, timeout=None, |
139 | 4f650d54 | Shikhar Bhushan | unknown_host_cb=default_unknown_host_cb, |
140 | 4f650d54 | Shikhar Bhushan | username=None, password=None, |
141 | d095a59e | Shikhar Bhushan | key_filename=None, allow_agent=True, look_for_keys=True): |
142 | 4f650d54 | Shikhar Bhushan | """Connect via SSH and initialize the NETCONF session. First attempts
|
143 | 4f650d54 | Shikhar Bhushan | the publickey authentication method and then password authentication.
|
144 | 4f650d54 | Shikhar Bhushan |
|
145 | 216bb34c | Shikhar Bhushan | To disable attemting publickey authentication altogether, call with
|
146 | 216bb34c | Shikhar Bhushan | *allow_agent* and *look_for_keys* as :const:`False`. This may be needed
|
147 | 216bb34c | Shikhar Bhushan | for Cisco devices which immediately disconnect on an incorrect
|
148 | 216bb34c | Shikhar Bhushan | authentication attempt.
|
149 | 4f650d54 | Shikhar Bhushan |
|
150 | 4f650d54 | Shikhar Bhushan | :arg host: the hostname or IP address to connect to
|
151 | 216bb34c | Shikhar Bhushan | :type host: `string`
|
152 | 4f650d54 | Shikhar Bhushan |
|
153 | 4f650d54 | Shikhar Bhushan | :arg port: by default 830, but some devices use the default SSH port of 22 so this may need to be specified
|
154 | 216bb34c | Shikhar Bhushan | :type port: `int`
|
155 | 4f650d54 | Shikhar Bhushan |
|
156 | 4f650d54 | Shikhar Bhushan | :arg timeout: an optional timeout for the TCP handshake
|
157 | 216bb34c | Shikhar Bhushan | :type timeout: `int`
|
158 | 4f650d54 | Shikhar Bhushan |
|
159 | 216bb34c | Shikhar Bhushan | :arg unknown_host_cb: called when a host key is not recognized
|
160 | 216bb34c | Shikhar Bhushan | :type unknown_host_cb: see :meth:`signature <ssh.default_unknown_host_cb>`
|
161 | 4f650d54 | Shikhar Bhushan |
|
162 | 4f650d54 | Shikhar Bhushan | :arg username: the username to use for SSH authentication
|
163 | 216bb34c | Shikhar Bhushan | :type username: `string`
|
164 | 4f650d54 | Shikhar Bhushan |
|
165 | 216bb34c | Shikhar Bhushan | :arg password: the password used if using password authentication, or the passphrase to use for unlocking keys that require it
|
166 | 216bb34c | Shikhar Bhushan | :type password: `string`
|
167 | 4f650d54 | Shikhar Bhushan |
|
168 | 4f650d54 | Shikhar Bhushan | :arg key_filename: a filename where a the private key to be used can be found
|
169 | 216bb34c | Shikhar Bhushan | :type key_filename: `string`
|
170 | 4f650d54 | Shikhar Bhushan |
|
171 | 4f650d54 | Shikhar Bhushan | :arg allow_agent: enables querying SSH agent (if found) for keys
|
172 | 216bb34c | Shikhar Bhushan | :type allow_agent: `bool`
|
173 | 4f650d54 | Shikhar Bhushan |
|
174 | 4f650d54 | Shikhar Bhushan | :arg look_for_keys: enables looking in the usual locations for ssh keys (e.g. :file:`~/.ssh/id_*`)
|
175 | 216bb34c | Shikhar Bhushan | :type look_for_keys: `bool`
|
176 | 4f650d54 | Shikhar Bhushan | """
|
177 | 4f650d54 | Shikhar Bhushan | |
178 | d095a59e | Shikhar Bhushan | assert(username is not None) |
179 | 4f650d54 | Shikhar Bhushan | |
180 | d095a59e | Shikhar Bhushan | for (family, socktype, proto, canonname, sockaddr) in \ |
181 | 583c11f6 | Shikhar Bhushan | socket.getaddrinfo(host, port): |
182 | 583c11f6 | Shikhar Bhushan | if socktype == socket.SOCK_STREAM:
|
183 | d095a59e | Shikhar Bhushan | af = family |
184 | d095a59e | Shikhar Bhushan | addr = sockaddr |
185 | d095a59e | Shikhar Bhushan | break
|
186 | d095a59e | Shikhar Bhushan | else:
|
187 | 583c11f6 | Shikhar Bhushan | raise SSHError('No suitable address family for %s' % host) |
188 | d095a59e | Shikhar Bhushan | sock = socket.socket(af, socket.SOCK_STREAM) |
189 | d095a59e | Shikhar Bhushan | sock.settimeout(timeout) |
190 | d095a59e | Shikhar Bhushan | sock.connect(addr) |
191 | d095a59e | Shikhar Bhushan | t = self._transport = paramiko.Transport(sock)
|
192 | d095a59e | Shikhar Bhushan | t.set_log_channel(logger.name) |
193 | 4f650d54 | Shikhar Bhushan | |
194 | d095a59e | Shikhar Bhushan | try:
|
195 | d095a59e | Shikhar Bhushan | t.start_client() |
196 | d095a59e | Shikhar Bhushan | except paramiko.SSHException:
|
197 | d095a59e | Shikhar Bhushan | raise SSHError('Negotiation failed') |
198 | 4f650d54 | Shikhar Bhushan | |
199 | d095a59e | Shikhar Bhushan | # host key verification
|
200 | d095a59e | Shikhar Bhushan | server_key = t.get_remote_server_key() |
201 | 216bb34c | Shikhar Bhushan | known_host = self._host_keys.check(host, server_key)
|
202 | 216bb34c | Shikhar Bhushan | |
203 | 216bb34c | Shikhar Bhushan | fingerprint = hexlify(server_key.get_fingerprint()) |
204 | 4f650d54 | Shikhar Bhushan | |
205 | 216bb34c | Shikhar Bhushan | if not known_host and not unknown_host_cb(host, fingerprint): |
206 | 216bb34c | Shikhar Bhushan | raise SSHUnknownHostError(host, fingerprint)
|
207 | 4f650d54 | Shikhar Bhushan | |
208 | d095a59e | Shikhar Bhushan | if key_filename is None: |
209 | d095a59e | Shikhar Bhushan | key_filenames = [] |
210 | d095a59e | Shikhar Bhushan | elif isinstance(key_filename, basestring): |
211 | d095a59e | Shikhar Bhushan | key_filenames = [ key_filename ] |
212 | d095a59e | Shikhar Bhushan | else:
|
213 | d095a59e | Shikhar Bhushan | key_filenames = key_filename |
214 | 4f650d54 | Shikhar Bhushan | |
215 | d095a59e | Shikhar Bhushan | self._auth(username, password, key_filenames, allow_agent, look_for_keys)
|
216 | 4f650d54 | Shikhar Bhushan | |
217 | d095a59e | Shikhar Bhushan | self._connected = True # there was no error authenticating |
218 | 4f650d54 | Shikhar Bhushan | |
219 | d095a59e | Shikhar Bhushan | c = self._channel = self._transport.open_session() |
220 | d095a59e | Shikhar Bhushan | c.set_name('netconf')
|
221 | 41e2ed46 | Shikhar Bhushan | c.invoke_subsystem('netconf')
|
222 | 4f650d54 | Shikhar Bhushan | |
223 | d095a59e | Shikhar Bhushan | self._post_connect()
|
224 | 4f650d54 | Shikhar Bhushan | |
225 | d095a59e | Shikhar Bhushan | # on the lines of paramiko.SSHClient._auth()
|
226 | d095a59e | Shikhar Bhushan | def _auth(self, username, password, key_filenames, allow_agent, |
227 | d095a59e | Shikhar Bhushan | look_for_keys): |
228 | d095a59e | Shikhar Bhushan | saved_exception = None
|
229 | 4f650d54 | Shikhar Bhushan | |
230 | d095a59e | Shikhar Bhushan | for key_filename in key_filenames: |
231 | d095a59e | Shikhar Bhushan | for cls in (paramiko.RSAKey, paramiko.DSSKey): |
232 | d095a59e | Shikhar Bhushan | try:
|
233 | d095a59e | Shikhar Bhushan | key = cls.from_private_key_file(key_filename, password) |
234 | d095a59e | Shikhar Bhushan | logger.debug('Trying key %s from %s' %
|
235 | d095a59e | Shikhar Bhushan | (hexlify(key.get_fingerprint()), key_filename)) |
236 | d095a59e | Shikhar Bhushan | self._transport.auth_publickey(username, key)
|
237 | d095a59e | Shikhar Bhushan | return
|
238 | d095a59e | Shikhar Bhushan | except Exception as e: |
239 | d095a59e | Shikhar Bhushan | saved_exception = e |
240 | d095a59e | Shikhar Bhushan | logger.debug(e) |
241 | 4f650d54 | Shikhar Bhushan | |
242 | d095a59e | Shikhar Bhushan | if allow_agent:
|
243 | d095a59e | Shikhar Bhushan | for key in paramiko.Agent().get_keys(): |
244 | d095a59e | Shikhar Bhushan | try:
|
245 | d095a59e | Shikhar Bhushan | logger.debug('Trying SSH agent key %s' %
|
246 | d095a59e | Shikhar Bhushan | hexlify(key.get_fingerprint())) |
247 | d095a59e | Shikhar Bhushan | self._transport.auth_publickey(username, key)
|
248 | d095a59e | Shikhar Bhushan | return
|
249 | d095a59e | Shikhar Bhushan | except Exception as e: |
250 | d095a59e | Shikhar Bhushan | saved_exception = e |
251 | d095a59e | Shikhar Bhushan | logger.debug(e) |
252 | 4f650d54 | Shikhar Bhushan | |
253 | d095a59e | Shikhar Bhushan | keyfiles = [] |
254 | d095a59e | Shikhar Bhushan | if look_for_keys:
|
255 | d095a59e | Shikhar Bhushan | rsa_key = os.path.expanduser('~/.ssh/id_rsa')
|
256 | d095a59e | Shikhar Bhushan | dsa_key = os.path.expanduser('~/.ssh/id_dsa')
|
257 | d095a59e | Shikhar Bhushan | if os.path.isfile(rsa_key):
|
258 | d095a59e | Shikhar Bhushan | keyfiles.append((paramiko.RSAKey, rsa_key)) |
259 | d095a59e | Shikhar Bhushan | if os.path.isfile(dsa_key):
|
260 | d095a59e | Shikhar Bhushan | keyfiles.append((paramiko.DSSKey, dsa_key)) |
261 | d095a59e | Shikhar Bhushan | # look in ~/ssh/ for windows users:
|
262 | d095a59e | Shikhar Bhushan | rsa_key = os.path.expanduser('~/ssh/id_rsa')
|
263 | d095a59e | Shikhar Bhushan | dsa_key = os.path.expanduser('~/ssh/id_dsa')
|
264 | d095a59e | Shikhar Bhushan | if os.path.isfile(rsa_key):
|
265 | d095a59e | Shikhar Bhushan | keyfiles.append((paramiko.RSAKey, rsa_key)) |
266 | d095a59e | Shikhar Bhushan | if os.path.isfile(dsa_key):
|
267 | d095a59e | Shikhar Bhushan | keyfiles.append((paramiko.DSSKey, dsa_key)) |
268 | 4f650d54 | Shikhar Bhushan | |
269 | d095a59e | Shikhar Bhushan | for cls, filename in keyfiles: |
270 | d095a59e | Shikhar Bhushan | try:
|
271 | d095a59e | Shikhar Bhushan | key = cls.from_private_key_file(filename, password) |
272 | d095a59e | Shikhar Bhushan | logger.debug('Trying discovered key %s in %s' %
|
273 | d095a59e | Shikhar Bhushan | (hexlify(key.get_fingerprint()), filename)) |
274 | d095a59e | Shikhar Bhushan | self._transport.auth_publickey(username, key)
|
275 | d095a59e | Shikhar Bhushan | return
|
276 | d095a59e | Shikhar Bhushan | except Exception as e: |
277 | d095a59e | Shikhar Bhushan | saved_exception = e |
278 | d095a59e | Shikhar Bhushan | logger.debug(e) |
279 | 4f650d54 | Shikhar Bhushan | |
280 | d095a59e | Shikhar Bhushan | if password is not None: |
281 | d095a59e | Shikhar Bhushan | try:
|
282 | d095a59e | Shikhar Bhushan | self._transport.auth_password(username, password)
|
283 | d095a59e | Shikhar Bhushan | return
|
284 | d095a59e | Shikhar Bhushan | except Exception as e: |
285 | d095a59e | Shikhar Bhushan | saved_exception = e |
286 | d095a59e | Shikhar Bhushan | logger.debug(e) |
287 | 4f650d54 | Shikhar Bhushan | |
288 | d095a59e | Shikhar Bhushan | if saved_exception is not None: |
289 | 541247ba | Shikhar Bhushan | # need pep-3134 to do this right
|
290 | a7cb58ce | Shikhar Bhushan | raise AuthenticationError(repr(saved_exception)) |
291 | 4f650d54 | Shikhar Bhushan | |
292 | a7cb58ce | Shikhar Bhushan | raise AuthenticationError('No authentication methods available') |
293 | 4f650d54 | Shikhar Bhushan | |
294 | d095a59e | Shikhar Bhushan | def run(self): |
295 | d095a59e | Shikhar Bhushan | chan = self._channel
|
296 | d095a59e | Shikhar Bhushan | chan.setblocking(0)
|
297 | d095a59e | Shikhar Bhushan | q = self._q
|
298 | d095a59e | Shikhar Bhushan | try:
|
299 | d095a59e | Shikhar Bhushan | while True: |
300 | d095a59e | Shikhar Bhushan | # select on a paramiko ssh channel object does not ever return
|
301 | 4f650d54 | Shikhar Bhushan | # it in the writable list, so it channel's don't exactly emulate
|
302 | d095a59e | Shikhar Bhushan | # the socket api
|
303 | d095a59e | Shikhar Bhushan | r, w, e = select([chan], [], [], TICK) |
304 | d095a59e | Shikhar Bhushan | # will wakeup evey TICK seconds to check if something
|
305 | d095a59e | Shikhar Bhushan | # to send, more if something to read (due to select returning
|
306 | d095a59e | Shikhar Bhushan | # chan in readable list)
|
307 | d095a59e | Shikhar Bhushan | if r:
|
308 | d095a59e | Shikhar Bhushan | data = chan.recv(BUF_SIZE) |
309 | d095a59e | Shikhar Bhushan | if data:
|
310 | d095a59e | Shikhar Bhushan | self._buffer.write(data)
|
311 | d095a59e | Shikhar Bhushan | self._parse()
|
312 | d095a59e | Shikhar Bhushan | else:
|
313 | 94265508 | Shikhar Bhushan | raise SessionCloseError(self._buffer.getvalue()) |
314 | d095a59e | Shikhar Bhushan | if not q.empty() and chan.send_ready(): |
315 | 41e2ed46 | Shikhar Bhushan | logger.debug('sending message')
|
316 | d095a59e | Shikhar Bhushan | data = q.get() + MSG_DELIM |
317 | d095a59e | Shikhar Bhushan | while data:
|
318 | d095a59e | Shikhar Bhushan | n = chan.send(data) |
319 | d095a59e | Shikhar Bhushan | if n <= 0: |
320 | 94265508 | Shikhar Bhushan | raise SessionCloseError(self._buffer.getvalue(), data) |
321 | d095a59e | Shikhar Bhushan | data = data[n:] |
322 | d095a59e | Shikhar Bhushan | except Exception as e: |
323 | 41e2ed46 | Shikhar Bhushan | logger.debug('broke out of main loop')
|
324 | 1d540e60 | Shikhar Bhushan | self.close()
|
325 | 1d540e60 | Shikhar Bhushan | if not (isinstance(e, SessionCloseError) and self._expecting_close): |
326 | 1d540e60 | Shikhar Bhushan | self._dispatch_error(e)
|
327 | 4f650d54 | Shikhar Bhushan | |
328 | d095a59e | Shikhar Bhushan | @property
|
329 | d095a59e | Shikhar Bhushan | def transport(self): |
330 | 216bb34c | Shikhar Bhushan | """Underlying `paramiko.Transport
|
331 | 4f650d54 | Shikhar Bhushan | <http://www.lag.net/paramiko/docs/paramiko.Transport-class.html>`_
|
332 | 4f650d54 | Shikhar Bhushan | object. This makes it possible to call methods like set_keepalive on it.
|
333 | 4f650d54 | Shikhar Bhushan | """
|
334 | d095a59e | Shikhar Bhushan | return self._transport |
335 | 4f650d54 | Shikhar Bhushan | |
336 | 541247ba | Shikhar Bhushan | @property
|
337 | 94803aaf | Shikhar Bhushan | def can_pipeline(self): |
338 | 94803aaf | Shikhar Bhushan | if 'Cisco' in self._transport.remote_version: |
339 | 94803aaf | Shikhar Bhushan | return False |
340 | 94803aaf | Shikhar Bhushan | # elif ..
|
341 | 94803aaf | Shikhar Bhushan | return True |