scripts/imgtool/keys/general.py

"""General key class."""

# SPDX-License-Identifier: Apache-2.0

import sys

AUTOGEN_MESSAGE = "/* Autogenerated by imgtool.py, do not edit. */"


class KeyClass(object):
    def _emit(self, header, trailer, encoded_bytes, indent, file=sys.stdout,
              len_format=None):
        if file and file is not sys.stdout:
            with open(file, 'w') as file:
                self._emit_to_output(header, trailer, encoded_bytes, indent,
                                     file, len_format)
        else:
            self._emit_to_output(header, trailer, encoded_bytes, indent,
                                 sys.stdout, len_format)

    def _emit_to_output(self, header, trailer, encoded_bytes, indent, file,
                        len_format):
        print(AUTOGEN_MESSAGE, file=file)
        print(header, end='', file=file)
        for count, b in enumerate(encoded_bytes):
            if count % 8 == 0:
                print("\n" + indent, end='', file=file)
            else:
                print(" ", end='', file=file)
            print("0x{:02x},".format(b), end='', file=file)
        print("\n" + trailer, file=file)
        if len_format is not None:
            print(len_format.format(len(encoded_bytes)), file=file)

    def emit_c_public(self, file=sys.stdout):
        self._emit(
                header="const unsigned char {}_pub_key[] = {{".format(self.shortname()),
                trailer="};",
                encoded_bytes=self.get_public_bytes(),
                indent="    ",
                len_format="const unsigned int {}_pub_key_len = {{}};".format(self.shortname()),
                file=file)

    def emit_raw_public(self, file=sys.stdout):
        if file and file is not sys.stdout:
            with open(file, 'wb') as file:
                file.write(self.get_public_bytes())
        else:
            sys.stdout.buffer.write(self.get_public_bytes())

    def emit_rust_public(self, file=sys.stdout):
        self._emit(
                header="static {}_PUB_KEY: &[u8] = &[".format(self.shortname().upper()),
                trailer="];",
                encoded_bytes=self.get_public_bytes(),
                indent="    ",
                file=file)

    def emit_public_pem(self, file=sys.stdout):
        if file and file is not sys.stdout:
            with open(file, 'w') as file:
                print(str(self.get_public_pem(), 'utf-8'), file=file, end='')
        else:
            print(str(self.get_public_pem(), 'utf-8'), file=sys.stdout, end='')

    def emit_private(self, minimal, format, file=sys.stdout):
        self._emit(
                header="const unsigned char enc_priv_key[] = {",
                trailer="};",
                encoded_bytes=self.get_private_bytes(minimal, format),
                indent="    ",
                len_format="const unsigned int enc_priv_key_len = {};",
                file=file)