#!/usr/bin/env python
#
# Copyright (c) 2016, NORDUnet A/S 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 the NORDUnet 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
# HOLDER 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.
"""
Utility to probe USB serial port(s) trying to figure out which one(s)
we have plugged in today. stdout is environment variable settings,
suitable for use in bash with "eval `cryptech_probe`"; all other output
goes to stderr.
"""
import sys
import time
import argparse
import serial.tools.list_ports_posix
class positive_integer(int):
def __init__(self, value):
if self <= 0:
raise ValueError
parser = argparse.ArgumentParser(formatter_class = argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument("-v", "--verbose", action = "store_true", help = "produce human-readable output")
parser.add_argument("-d", "--debug", action = "store_true", help = "blather about what we're doing")
parser.add_argument("--no-cleanup", action = "store_true", help = "don't send cleanup sequences after probing")
parser.add_argument("--read-buffer-size", type = positive_integer, help = "size of read buffer", default = 1024)
args = parser.parse_args()
SLIP_END = chr(0300) # Indicates end of SLIP packet
SLIP_ESC = chr(0333) # Indicates byte stuffing
SLIP_ESC_END = chr(0334) # ESC ESC_END means END data byte
SLIP_ESC_ESC = chr(0335) # ESC ESC_ESC means ESC data byte
Control_U = chr(0025) # Console: clear line
Control_M = chr(0015) # Console: end of line
RPC_query = chr(0) * 8 # client_handle = 0, function code = RPC_FUNC_GET_VERSION
RPC_reply = chr(0) * 12 # opcode = RPC_FUNC_GET_VERSION, client_handle = 0, valret = HAL_OK
# This is the query string we send to each USB port we find. It's
# intended to be relatively harmless, at least for either of the HSM
# ports: the final Control-U should prevent the console from trying to
# interpret the RPC command, and the SLIP_END markers should cause
# the RPC server to treat the ASCII control characters as noise.
#
# Yes, this is a total kludge. Useful identifiers for the USB ports
# are are on the wish list for a future revision of the hardware, but
# for the moment, we do what we can with what we have.
probe_string = SLIP_END + Control_U + SLIP_END + RPC_query + SLIP_END + Control_U + Control_M
ports = [port for port, desc, hwid in serial.tools.list_ports_posix.comports()
if "VID:PID=0403:6014" in hwid]
if not ports:
sys.exit("Couldn't find any likely USB ports")
if args.debug:
sys.stderr.write("Candidate USB ports: {}\n".format(", ".join(ports)))
env = {}
for port in ports:
while True:
try:
tty = serial.Serial(port, 921600, timeout=0.1)
break
except serial.SerialException:
time.sleep(0.2)
for c in probe_string:
tty.write(c)
time.sleep(0.1)
response = tty.read(args.read_buffer_size)
if args.debug:
sys.stderr.write("Received from {}: {!r} ({})\n".format(port, response, ":".join("{:02x}".format(ord(c)) for c in response)))
# Check whether we got a known console prompt.
is_cty = any(prompt in response for prompt in ("Username:", "Password:", "cryptech>"))
# Check whether we got something that looks like the response to an RPC version query.
# We skip over the version value itself, as it might change, but we check that it's
# terminated properly. This is fragile, and will need to handle SLIP decoding if
# we ever bump one of the version fields up into the range where the SLIP control
# characters live, but it will do for the moment.
try:
is_hsm = response[response.index(SLIP_END + RPC_reply) + len(SLIP_END + RPC_reply) + 4] == SLIP_END
except ValueError:
is_hsm = False
except IndexError:
is_hsm = False
if is_cty and args.verbose:
sys.stderr.write("{} looks like the Cryptech HSM console port\n".format(port))
if is_hsm and args.verbose:
sys.stderr.write("{} looks like the Cryptech HSM RPC port\n".format(port))
if is_cty:
env.update(CRYPTECH_CTY_CLIENT_SERIAL_DEVICE = port)
if is_hsm:
env.update(CRYPTECH_RPC_CLIENT_SERIAL_DEVICE = port)
if (is_cty or is_hsm) and not args.no_cleanup:
if is_cty:
tty.write(Control_U)
if is_hsm:
tty.write(SLIP_END)
while tty.read(args.read_buffer_size):
pass
tty.close()
if env:
sys.stdout.write("export {}\n".format(
" ".join("{}='{}'".format(var, env[var]) for var in sorted(env))))
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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
#!/usr/bin/env python
#
# Copyright (c) 2016, NORDUnet A/S 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 the NORDUnet 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
# HOLDER 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.
"""
Utility to upload a new firmware image or FPGA bitstream.
"""
import os
import sys
import time
import struct
import serial
import getpass
import os.path
import tarfile
import argparse
import platform
from binascii import crc32
FIRMWARE_CHUNK_SIZE = 4096
FPGA_CHUNK_SIZE = 4096
def parse_args():
"""
Parse the command line arguments
"""
share_directory = "/usr/share" if platform.system() == "Linux" else "/usr/local/share"
default_tarball = os.path.join(share_directory, "cryptech-alpha-firmware.tar.gz")
if not os.path.exists(default_tarball):
default_tarball = None
parser = argparse.ArgumentParser(description = __doc__,
formatter_class = argparse.ArgumentDefaultsHelpFormatter,
)
parser.add_argument("-d", "--device",
default = os.getenv("CRYPTECH_CTY_CLIENT_SERIAL_DEVICE", "/dev/ttyUSB0"),
help = "Name of management port USB serial device",
)
parser.add_argument("--firmware-tarball",
type = argparse.FileType("rb"),
default = default_tarball,
help = "Location of firmware tarball",
)
actions = parser.add_mutually_exclusive_group(required = True)
actions.add_argument("--fpga",
action = "store_true",
help = "Upload FPGA bitstream",
)
actions.add_argument("--firmware", "--hsm",
action = "store_true",
help = "Upload HSM firmware image",
)
actions.add_argument("--bootloader",
action = "store_true",
help = "Upload bootloader image (dangerous!)",
)
parser.add_argument("--simon-says-whack-my-bootloader",
action = "store_true",
help = "Confirm that you really want to risk bricking the HSM",
)
parser.add_argument("-i", "--explicit-image",
type = argparse.FileType("rb"),
help = "Explicit source image file for upload, overrides firmware tarball")
return parser.parse_args()
def _write(dst, data):
dst.write(data)
#if len(data) == 4:
# print("Wrote 0x{!s}".format(data.encode("hex")))
#else:
# print("Wrote {!r}".format(data))
def _read(dst):
res = ""
x = dst.read(1)
while not x:
x = dst.read(1)
while x:
res += x
x = dst.read(1)
#print ("Read {!r}".format(res))
return res
pin = None
def _execute(dst, cmd):
global pin
_write(dst, "\r")
prompt = _read(dst)
if prompt.endswith("Username: "):
_write(dst, "so\r")
prompt = _read(dst)
if prompt.endswith("Password: "):
if not pin:
pin = getpass.getpass("SO PIN: ")
_write(dst, pin + "\r")
prompt = _read(dst)
if not prompt.endswith(("> ", "# ")):
print("Device does not seem to be ready for a file transfer (got {!r})".format(prompt))
return prompt
_write(dst, cmd + "\r")
response = _read(dst)
return response
def send_file(src, size, args, dst):
if args.fpga:
chunk_size = FPGA_CHUNK_SIZE
response = _execute(dst, "fpga bitstream upload")
elif args.firmware:
chunk_size = FIRMWARE_CHUNK_SIZE
response = _execute(dst, "firmware upload")
if "Rebooting" in response:
response = _execute(dst, "firmware upload")
elif args.bootloader:
chunk_size = FIRMWARE_CHUNK_SIZE
response = _execute(dst, "bootloader upload")
if "Access denied" in response:
print "Access denied"
return False
if not "OK" in response:
print("Device did not accept the upload command (got {!r})".format(response))
return False
crc = 0
counter = 0
# 1. Write size of file (4 bytes)
_write(dst, struct.pack("<I", size))
response = _read(dst)
if not response.startswith("Send "):
print response
return False
# 2. Write file contents while calculating CRC-32
while True:
data = src.read(chunk_size)
if not data:
break
dst.write(data)
print("Wrote {!s} bytes (chunk {!s}/{!s})".format(len(data), counter, int(size / chunk_size)))
# read ACK (a counter of number of 4k chunks received)
while True:
ack_bytes = dst.read(4)
if len(ack_bytes) == 4:
break
print("ERROR: Did not receive an ACK, got {!r}".format(ack_bytes))
dst.write("\r") # eventually get back to the CLI prompt
ack = struct.unpack("<I", ack_bytes)[0]
if ack != counter + 1:
print("ERROR: Did not receive the expected counter as ACK (got {!r}/{!r}, not {!r})".format(ack, ack_bytes, counter))
flush = dst.read(100)
print("FLUSH data: {!r}".format(flush))
return False
counter += 1
crc = crc32(data, crc) & 0xffffffff
_read(dst)
# 3. Write CRC-32 (4 bytes)
_write(dst, struct.pack("<I", crc))
response = _read(dst)
print response
src.close()
if args.fpga:
# tell the fpga to read its new configuration
_execute(dst, "fpga reset")
if args.fpga or args.bootloader:
# log out of the CLI
# firmware upgrade reboots, doesn't need an exit
_execute(dst, "exit")
return True
dire_bootloader_warning = '''
WARNING
Updating the bootloader risks bricking your HSM! If something goes
badly wrong here, or you upload a bad bootloader image, you will not
be able to recover without an ST-LINK programmer.
In most cases a normal "--firmware" upgrade should be all that is
necessary to bring your HSM up to date, there is seldom any real need
to update the bootloader.
Do not proceed with this unless you REALLY know what you are doing.
If you got here by accident, ^C now, without answering the PIN prompt.
'''
def main():
args = parse_args()
if args.bootloader and not args.simon_says_whack_my_bootloader:
sys.exit("You didn't say \"Simon says\"")
if args.bootloader:
print dire_bootloader_warning
if args.explicit_image is None and args.firmware_tarball is None:
sys.exit("No source file specified for upload and firmware tarball not found")
if args.explicit_image:
src = args.explicit_image # file-like object, thanks to argparse
size = os.fstat(src.fileno()).st_size
if size == 0: # Flashing from stdin won't work, sorry
sys.exit("Can't flash from a pipe or zero-length file")
print "Uploading from explicitly-specified file {}".format(args.explicit_image.name)
else:
tar = tarfile.open(fileobj = args.firmware_tarball)
print "Firmware tarball {} content:".format(args.firmware_tarball.name)
tar.list(True)
if args.fpga:
name = "alpha_fmc.bit"
elif args.firmware:
name = "hsm.bin"
elif args.bootloader:
name = "bootloader.bin"
else:
# Somebody updated other part of this script without updating this part :(
sys.exit("Don't know which component to select from firmware tarball, sorry")
try:
size = tar.getmember(name).size
except KeyError:
sys.exit("Expected component {} missing from firmware tarball {}".format(name, args.firmware_tarball.name))
src = tar.extractfile(name)
print "Uploading {} from {}".format(name, args.firmware_tarball.name)
print "Initializing serial port and synchronizing with HSM, this may take a few seconds"
dst = serial.Serial(args.device, 921600, timeout = 2)
send_file(src, size, args, dst)
dst.close()
if __name__ == "__main__":
try:
main()
except KeyboardInterrupt:
pass
|