/usr/lib/python2.7/dist-packages/hp3parclient/ssh.py is in python-hp3parclient 3.0.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 | # Copyright 2014 Hewlett Packard Development Company, L.P.
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
"""
HP3Par SSH Client
.. module: ssh
:Author: Walter A. Boring IV
:Description: This is the SSH Client that is used to make calls to
the 3PAR where an existing REST API doesn't exist.
"""
import logging
import os
import paramiko
from random import randint
import re
from eventlet import greenthread
from hp3parclient import exceptions
class HP3PARSSHClient(object):
"""This class is used to execute SSH commands on a 3PAR."""
def __init__(self, ip, login, password,
port=22, conn_timeout=None, privatekey=None):
self.san_ip = ip
self.san_ssh_port = port
self.ssh_conn_timeout = conn_timeout
self.san_login = login
self.san_password = password
self.san_private_key = privatekey
self._logger = logging.getLogger(__name__)
self._create_ssh()
def _create_ssh(self):
try:
ssh = paramiko.SSHClient()
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
if self.san_password:
ssh.connect(self.san_ip,
port=self.san_ssh_port,
username=self.san_login,
password=self.san_password,
timeout=self.ssh_conn_timeout)
elif self.san_privatekey:
pkfile = os.path.expanduser(self.san_privatekey)
privatekey = paramiko.RSAKey.from_private_key_file(pkfile)
ssh.connect(self.san_ip,
port=self.san_ssh_port,
username=self.san_login,
pkey=privatekey,
timeout=self.ssh_conn_timeout)
else:
msg = "Specify a password or private_key"
raise exceptions.SSHException(msg)
# Paramiko by default sets the socket timeout to 0.1 seconds,
# ignoring what we set through the sshclient. This doesn't help for
# keeping long lived connections. Hence we have to bypass it, by
# overriding it after the transport is initialized. We are setting
# the sockettimeout to None and setting a keepalive packet so that,
# the server will keep the connection open. All that does is send
# a keepalive packet every ssh_conn_timeout seconds.
if self.ssh_conn_timeout:
transport = ssh.get_transport()
transport.sock.settimeout(None)
transport.set_keepalive(self.ssh_conn_timeout)
self.ssh = ssh
except Exception as e:
msg = "Error connecting via ssh: %s" % e
self._logger.error(msg)
raise paramiko.SSHException(msg)
def close(self):
if self.ssh:
print("closing ssh")
self.ssh.close()
def set_debug_flag(self, flag):
"""
This turns on/off http request/response debugging output to console
:param flag: Set to True to enable debugging output
:type flag: bool
"""
self.log_debug = flag
if self.log_debug:
ch = logging.StreamHandler()
self._logger.setLevel(logging.DEBUG)
self._logger.addHandler(ch)
def run(self, cmd):
"""Runs a CLI command over SSH, without doing any result parsing."""
self._logger.debug("SSH CMD = %s " % cmd)
(stdout, stderr) = self._run_ssh(cmd, False)
# we have to strip out the input and exit lines
tmp = stdout.split("\r\n")
out = tmp[5:len(tmp) - 2]
self._logger.debug("OUT = %s" % out)
return out
def _ssh_execute(self, cmd, check_exit_code=True):
"""We have to do this in order to get CSV output from the CLI command.
We first have to issue a command to tell the CLI that we want the
output to be formatted in CSV, then we issue the real command.
"""
self._logger.debug('Running cmd (SSH): %s', cmd)
channel = self.ssh.invoke_shell()
stdin_stream = channel.makefile('wb')
stdout_stream = channel.makefile('rb')
stderr_stream = channel.makefile('rb')
stdin_stream.write('''setclienv csvtable 1
%s
exit
''' % cmd)
# stdin.write('process_input would go here')
# stdin.flush()
# NOTE(justinsb): This seems suspicious...
# ...other SSH clients have buffering issues with this approach
stdout = stdout_stream.read()
stderr = stderr_stream.read()
stdin_stream.close()
stdout_stream.close()
stderr_stream.close()
exit_status = channel.recv_exit_status()
# exit_status == -1 if no exit code was returned
if exit_status != -1:
self._logger.debug('Result was %s' % exit_status)
if check_exit_code and exit_status != 0:
msg = "command %s failed" % cmd
self._logger.error(msg)
raise exceptions.ProcessExecutionError(exit_code=exit_status,
stdout=stdout,
stderr=stderr,
cmd=cmd)
channel.close()
return (stdout, stderr)
def _run_ssh(self, cmd_list, check_exit=True, attempts=1):
self.check_ssh_injection(cmd_list)
command = ' '. join(cmd_list)
try:
total_attempts = attempts
while attempts > 0:
attempts -= 1
try:
return self._ssh_execute(command,
check_exit_code=check_exit)
except Exception as e:
self._logger.error(e)
greenthread.sleep(randint(20, 500) / 100.0)
msg = ("SSH Command failed after '%(total_attempts)r' "
"attempts : '%(command)s'" %
{'total_attempts': total_attempts, 'command': command})
self._logger.error(msg)
raise exceptions.SSHException(message=msg)
except Exception:
self._logger.error("Error running ssh command: %s" % command)
def check_ssh_injection(self, cmd_list):
ssh_injection_pattern = ['`', '$', '|', '||', ';', '&', '&&',
'>', '>>', '<']
# Check whether injection attacks exist
for arg in cmd_list:
arg = arg.strip()
# Check for matching quotes on the ends
is_quoted = re.match('^(?P<quote>[\'"])(?P<quoted>.*)(?P=quote)$',
arg)
if is_quoted:
# Check for unescaped quotes within the quoted argument
quoted = is_quoted.group('quoted')
if quoted:
if (re.match('[\'"]', quoted) or
re.search('[^\\\\][\'"]', quoted)):
raise exceptions.SSHInjectionThreat(command=
str(cmd_list))
else:
# We only allow spaces within quoted arguments, and that
# is the only special character allowed within quotes
if len(arg.split()) > 1:
raise exceptions.SSHInjectionThreat(command=str(cmd_list))
# Second, check whether danger character in command. So the shell
# special operator must be a single argument.
for c in ssh_injection_pattern:
if arg == c:
continue
result = arg.find(c)
if not result == -1:
if result == 0 or not arg[result - 1] == '\\':
raise exceptions.SSHInjectionThreat(command=cmd_list)
|