#!/usr/bin/env python # # Copyright (c) 2016-2017, 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 socket 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("--socket", default = os.getenv("CRYPTECH_CTY_CLIENT_SOCKET_NAME", "/tmp/.cryptech_muxd.cty"), help = "Name of cryptech_muxd management port socket", ) parser.add_argument("--firmware-tarball", type = argparse.FileType("rb"), default = default_tarball, help = "Location of firmware tarball", ) parser.add_argument("--username", choices = ("so", "wheel"), default = "so", help = "Username to use when logging into the HSM", ) parser.add_argument("--pin", help = "PIN to use when logging into the HSM", ) parser.add_argument("--separate-pins", action = "store_true", help = "Prompt separately for each PIN required during firmware upload") 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") parser.add_argument("--debug", action = "store_true", help = "Enable debugging of upload protocol", ) parser.add_argument("-q", "--quiet", action = "store_true", help = "Only report errors", ) return parser.parse_args() class ManagementPortAbstract(object): """ Abstract class encapsulating actions on the HSM management port. """ def __init__(self, args): self.args = args def write(self, data): numeric = isinstance(data, (int, long)) if numeric: data = struct.pack(" ", "# ")): print("Device does not seem to be ready for a file transfer (got {!r})".format(prompt)) return prompt self.write(cmd + "\r") response = self.read() return response class ManagementPortSerial(ManagementPortAbstract): """ Implmentation of HSM management port abstraction over a direct serial connection. """ def __init__(self, args, timeout = 1): super(ManagementPortSerial, self).__init__(args) self.serial = serial.Serial(args.device, 921600, timeout = timeout) def send(self, data): self.serial.write(data) self.serial.flush() def recv(self): return self.serial.read(1) def set_timeout(self, timeout): self.serial.timeout = timeout def close(self): self.serial.close() class ManagementPortSocket(ManagementPortAbstract): """ Implmentation of HSM management port abstraction over a PF_UNIX socket connection to the cryptech_muxd management socket. """ def __init__(self, args, timeout = 1): super(ManagementPortSocket, self).__init__(args) self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) self.socket.connect(args.socket) self.socket.settimeout(timeout) def send(self, data): self.socket.sendall(data) def recv(self): try: return self.socket.recv(1) except socket.timeout: return "" def set_timeout(self, timeout): self.socket.settimeout(timeout) def close(self): self.socket.close() def send_file(src, size, args, dst): """ Upload an image from some file-like source to the management port. Details depend on what kind of image it is. """ if args.fpga: chunk_size = FPGA_CHUNK_SIZE response = dst.execute("fpga bitstream upload") elif args.firmware: chunk_size = FIRMWARE_CHUNK_SIZE response = dst.execute("firmware upload") if "Rebooting" in response: response = dst.execute("firmware upload") elif args.bootloader: chunk_size = FIRMWARE_CHUNK_SIZE response = dst.execute("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 dst.set_timeout(0.001) crc = 0 counter = 0 # 1. Write size of file (4 bytes) dst.write(struct.pack("f50805b 
64e5fe8

ab7d78b


64e5fe8

ab7d78b

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