common.h

#pragma once
// General libraries
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
#include <string.h>

#ifdef FUZZING
#define explicit_bzero(addr, size) memset((addr), 0, (size))
#endif

// ours
#include "assert.h"
#include "utils.h"

#define CLA 0xD7
// 0x0* -  app status calls
// 0x1* -  public-key/address related
// 0x2* -  signing related
// 0xF* -  debug_mode related
#define INS_GET_VERSION               0x00
#define INS_GET_SERIAL                0x01
#define INS_GET_PUBLIC_KEY            0x10
#define INS_DERIVE_ADDRESS            0x11
#define INS_DERIVE_NATIVE_SCRIPT_HASH 0x12
#define INS_SIGN_TX                   0x21
#define INS_SIGN_OP_CERT              0x22
#define INS_SIGN_CVOTE                0x23
#define INS_SIGN_MSG                  0x24
#define INS_RUN_TESTS                 0xF0

enum { P1_UNUSED = 0, P2_UNUSED = 0 };

enum { ITEM_INCLUDED_NO = 1, ITEM_INCLUDED_YES = 2 };

enum {
    // Successful responses
    SUCCESS = 0x9000,

    // Invalid INS in swap mode
    ERR_SWAP_FAIL = 0x6001,

    // Start of error which trigger automatic response
    // Note that any such error will reset
    // multi-APDU exchange
    _ERR_AUTORESPOND_START = 0x6E00,

    // Bad request header
    ERR_MALFORMED_REQUEST_HEADER = 0x6E01,
    // Unknown CLA
    ERR_BAD_CLA = 0x6E02,
    // Unknown INS
    ERR_UNKNOWN_INS = 0x6E03,
    // attempt to change INS while the current call was not finished
    ERR_STILL_IN_CALL = 0x6E04,
    // P1 or P2 is invalid
    ERR_INVALID_REQUEST_PARAMETERS = 0x6E05,
    // Request is not valid in the context of previous calls
    ERR_INVALID_STATE = 0x6E06,
    // Some part of request data is invalid (or unknown to this app)
    // (includes not enough data and too much data)
    ERR_INVALID_DATA = 0x6E07,

    // User rejected the action
    ERR_REJECTED_BY_USER = 0x6E09,
    // Ledger security policy rejected the action
    ERR_REJECTED_BY_POLICY = 0x6E10,

    // Pin screen
    ERR_DEVICE_LOCKED = 0x6E11,

    // end of errors which trigger automatic response
    _ERR_AUTORESPOND_END = 0x6E13,

    // Errors below SHOULD NOT be returned to the client
    // Instead, leaking these to the main() scope
    // means unexpected programming error
    // and we should stop further processing
    // to avoid exploits

    // Internal errors
    ERR_ASSERT = 0x4700,
    ERR_NOT_IMPLEMENTED = 0x4701,

    // stream
    ERR_NOT_ENOUGH_INPUT = 0x4710,
    ERR_DATA_TOO_LARGE = 0x4711,

    // cbor
    ERR_UNEXPECTED_TOKEN = 0x4720,

    // Explicit return value to not send any response from main loop
    ERR_NO_RESPONSE = 0x0000,
};

bool device_is_unlocked();

// Normal code should use just this helper function
void io_send_buf(uint16_t code, uint8_t* buffer, size_t tx);