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
222
223
224
225
226
227
228
|
# Copyright (c) 2012, Calxeda Inc.
#
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of Calxeda Inc. nor the names of its contributors
# may be used to endorse or promote products derived from this software
# without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
# OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
# TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
# THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
# DAMAGE.
"""Helper objects for various SOL-related commands"""
from sys import stderr
import pexpect
from pexpect import TIMEOUT, EOF
from pyipmi import IpmiError
ESCAPE_SEQUENCES = {
"IpmiTool" : {
"terminate" : "~.",
"list_escapes" : "~?",
"escape_char" : "~~"
}
}
TOOL_RESPONSES = {
"IpmiTool" : {
"open" : "[SOL Session operational. Use ~? for help]",
"close" : "[terminated ipmitool]",
"send_error": "Error sending SOL data: FAIL",
"bmc_closed": "SOL session closed by BMC",
"activation_error": "Error: No response activating SOL payload",
"session_error": "Error: Unable to establish IPMI v2 / RMCP+ session",
"deactivation_error": "Error: No response de-activating SOL payload",
}
}
class SOLError(IpmiError):
"""SOL error"""
class SOLConsole(object):
"""Create and control an SOL session"""
def __init__(self, bmc, hostname, username, password):
self.isopen = False
self._bmc = bmc
self._toolname = bmc.handle._tool.__class__.__name__
self.escapes = ESCAPE_SEQUENCES[self._toolname]
self.responses = TOOL_RESPONSES[self._toolname]
# save authenication info
self._auth_info = {
'hostname' : hostname,
'username' : username,
'password' : password
}
# activate SOL session
self._proc = self._bmc.activate_payload()
self._proc.timeout = 5
self.expect_exact(self.responses['open'])
# set up log files
self._proc.logfile_read = file('sol_read.log', 'w')
self._proc.logfile_send = file('sol_write.log', 'w')
try:
self._login()
except IpmiError:
self.close()
raise
self.isopen = True
def __del__(self):
if self.isopen:
self.close()
self._bmc = None
def close(self):
self._logout()
self.send(self.escapes['terminate'])
try:
self.expect_exact(self.responses['close'], timeout=2)
except TIMEOUT, EOF:
try:
self._bmc.deactivate_payload()
except IpmiError as e:
assert e.message.find(self.responses['deactivation_error']) > -1
stderr.write(e.message)
if self._proc.isalive():
self._proc.close()
self.isopen = False
def _login(self):
hostname = self._auth_info['hostname']
username = self._auth_info['username']
password = self._auth_info['password']
self.prompt = '%s@%s.*[$#] ' % (username, hostname)
self.login_prompt = hostname + ' login: '
# once we've activated a session, either we're logged in,
# we need to log in, or we're not getting any data back
login_patterns = [self.login_prompt, self.prompt, TIMEOUT, EOF]
self.sendline()
index = self.expect(login_patterns)
# if we haven't found a prompt (index > 1),
# try sending various control characters
# control characters to send
controls = ['\\', 'c', 'd']
while index > 1:
try:
self.sendcontrol(controls.pop())
index = self.expect(login_patterns)
except IndexError:
raise IpmiError('SOL session unresponsive')
if index == 0:
# need to log in
try:
self.sendline(username)
self.expect_exact('Password: ')
self.sendline(password)
self.expect(self.prompt)
except TIMEOUT:
raise #IpmiError('%s@%s: failed login' % (username, hostname))
elif index == 1:
# we're already logged in
pass
# make the prompt more predictable
self.sendline('export PS1="\u@\h:~\$ "')
self.expect(self.prompt)
def _logout(self):
self.sendcontrol('c')
self.sendline('logout')
return self.expect([self.login_prompt, TIMEOUT, EOF]) == 0
######################################
# #
# Wrappers for pexpect functionality #
# #
######################################
def expect(self, pattern, timeout=-1, searchwindowsize=None):
return self._proc.expect(pattern, timeout, searchwindowsize)
def expect_exact(self, pattern, timeout=-1, searchwindowsize=None):
return self._proc.expect_exact(pattern, timeout, searchwindowsize)
def read(self, size=-1):
# pexpect implements this function by expecting the delimiter
# the default delimiter is EOF, which for our purposes, is
# unlikely to be reached. So instead, use TIMEOUT
# as the delimiter for now
prev_delimiter = self._proc.delimiter
self._proc.delimiter = TIMEOUT
data = self._proc.read(size)
self._proc.delimiter = prev_delimiter
return data
def readline(self, size=-1):
return self._proc.readline(size)
def send(self, s):
return self._proc.send(s)
def sendline(self, s=""):
return self.send(s + "\n")
def sendcontrol(self, char):
return self._proc.sendcontrol(char)
@property
def match(self):
return self._proc.match
# map config params to range of possible values
SOL_CONFIGURATION_PARAMETERS = {
"set_in_progress" : ["set_in_progress", "set_complete", "commit_write"],
"enable" : [True, False],
"force_encryption" : [True, False],
"force_authentication" : [True, False],
"privilege_level" : ["USER", "OPERATOR", "ADMINISTRATOR", "OEM"],
"character_accumulate_interval" : range(1, 256),
"character_send_threshold" : range(256),
"retry_count" : range(8),
"retry_interval" : range(256),
"volatile_bit_rate" : [9.6, 19.2, 38.4, 57.6, 115.2], #TODO: "serial"
"non_volatile_bit_rate" : [9.6, 19.2, 38.4, 57.6, 115.2], #TODO: "serial"
"payload_channel" : [], # implementation specific
"payload_port_number" : [], # implementation specific
# TODO: support OEM parameters
}
# map tools to a list of unsettable params for that tool
TOOL_RESTRICTIONS = {
"IpmiTool": ["payload_channel", "payload_port_number"],
}
|
