# (c) 2012, Michael DeHaan # # This file is part of Ansible # # Ansible is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # Ansible is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with Ansible. If not, see . import json import os import base64 import socket import struct from ansible.callbacks import vvv from ansible.runner.connection_plugins.ssh import Connection as SSHConnection from ansible import utils from ansible import errors from ansible import constants class Connection(object): ''' raw socket accelerated connection ''' def __init__(self, runner, host, port, user, password, private_key_file, *args, **kwargs): self.ssh = SSHConnection( runner=runner, host=host, port=port, user=user, password=password, private_key_file=private_key_file ) self.runner = runner self.host = host self.context = None self.conn = None self.key = utils.key_for_hostname(host) self.fbport = constants.FIREBALL2_PORT self.is_connected = False # attempt to work around shared-memory funness if getattr(self.runner, 'aes_keys', None): utils.AES_KEYS = self.runner.aes_keys def _execute_fb_module(self): args = "password=%s" % base64.b64encode(self.key.__str__()) self.ssh.connect() tmp_path = self.runner._make_tmp_path(self.ssh) return self.runner._execute_module(self.ssh, tmp_path, 'fireball2', args, inject={"password":self.key}) def connect(self, allow_ssh=True): ''' activates the connection object ''' try: if not self.is_connected: # TODO: make the timeout and retries configurable? tries = 10 self.conn = socket.socket() self.conn.settimeout(30.0) while tries > 0: try: self.conn.connect((self.host,self.fbport)) break except: time.sleep(0.1) tries -= 1 if tries == 0: vvv("Could not connect via the fireball2 connection, exceeded # of tries") raise errors.AnsibleError("Failed to connect") except: if allow_ssh: vvv("Falling back to ssh to startup accelerated mode") res = self._execute_fb_module() return self.connect(allow_ssh=False) else: raise errors.AnsibleError("Failed to connect to %s:%s" % (self.host,self.fbport)) self.is_connected = True return self def send_data(self, data): packed_len = struct.pack('Q',len(data)) return self.conn.sendall(packed_len + data) def recv_data(self): header_len = 8 # size of a packed unsigned long long data = b"" try: while len(data) < header_len: d = self.conn.recv(1024) if not d: return None data += d data_len = struct.unpack('Q',data[:header_len])[0] data = data[header_len:] while len(data) < data_len: d = self.conn.recv(1024) if not d: return None data += d return data except socket.timeout: raise errors.AnsibleError("timed out while waiting to receive data") def exec_command(self, cmd, tmp_path, sudo_user, sudoable=False, executable='/bin/sh'): ''' run a command on the remote host ''' if self.runner.sudo or sudoable and sudo_user: cmd, prompt = utils.make_sudo_cmd(sudo_user, executable, cmd) vvv("EXEC COMMAND %s" % cmd) data = dict( mode='command', cmd=cmd, tmp_path=tmp_path, executable=executable, ) data = utils.jsonify(data) data = utils.encrypt(self.key, data) if self.send_data(data): raise errors.AnisbleError("Failed to send command to %s" % self.host) response = self.recv_data() if not response: raise errors.AnsibleError("Failed to get a response from %s" % self.host) response = utils.decrypt(self.key, response) response = utils.parse_json(response) vvv("COMMAND DONE: rc=%s" % str(response.get('rc',""))) return (response.get('rc',None), '', response.get('stdout',''), response.get('stderr','')) def put_file(self, in_path, out_path): ''' transfer a file from local to remote ''' vvv("PUT %s TO %s" % (in_path, out_path), host=self.host) if not os.path.exists(in_path): raise errors.AnsibleFileNotFound("file or module does not exist: %s" % in_path) data = file(in_path).read() data = base64.b64encode(data) data = dict(mode='put', data=data, out_path=out_path) if self.runner.sudo: data['user'] = self.runner.sudo_user # TODO: support chunked file transfer data = utils.jsonify(data) data = utils.encrypt(self.key, data) if self.send_data(data): raise errors.AnsibleError("failed to send the file to %s" % self.host) response = self.recv_data() if not response: raise errors.AnsibleError("Failed to get a response from %s" % self.host) response = utils.decrypt(self.key, response) response = utils.parse_json(response) if response.get('failed',False): raise errors.AnsibleError("failed to put the file in the requested location") def fetch_file(self, in_path, out_path): ''' save a remote file to the specified path ''' vvv("FETCH %s TO %s" % (in_path, out_path), host=self.host) data = dict(mode='fetch', in_path=in_path) data = utils.jsonify(data) data = utils.encrypt(self.key, data) if self.send_data(data): raise errors.AnsibleError("failed to initiate the file fetch with %s" % self.host) response = self.recv_data() if not response: raise errors.AnsibleError("Failed to get a response from %s" % self.host) response = utils.decrypt(self.key, response) response = utils.parse_json(response) response = response['data'] response = base64.b64decode(response) fh = open(out_path, "w") fh.write(response) fh.close() def close(self): ''' terminate the connection ''' # Be a good citizen try: self.conn.close() except: pass