Catalyst voting support

Makefile

@@ -28,8 +28,8 @@ PIN = 5555
 
 APPNAME      = "Cardano ADA"
 APPVERSION_M = 2
-APPVERSION_N = 2
-APPVERSION_P = 1
+APPVERSION_N = 3
+APPVERSION_P = 0
 APPVERSION   = "$(APPVERSION_M).$(APPVERSION_N).$(APPVERSION_P)"
 
 APP_LOAD_PARAMS =--appFlags 0x240 --curve ed25519 --path "44'/1815'" --path "1852'/1815'"
@@ -122,10 +122,12 @@ ifeq ($(GCCPATH),)
 $(info GCCPATH is not set: arm-none-eabi-* will be used from PATH)
 endif
 
+WERROR   := -Werror=incompatible-pointer-types -Werror=return-type
+
 CC       := $(CLANGPATH)clang
-CFLAGS   += -O3 -Os -Wall -Wextra -Wuninitialized
+CFLAGS   += -std=gnu11 -O3 -Os -Wall -Wextra -Wuninitialized $(WERROR)
 
-AS     := $(GCCPATH)arm-none-eabi-gcc
+AS       := $(GCCPATH)arm-none-eabi-gcc
 LD       := $(GCCPATH)arm-none-eabi-gcc
 
 LDFLAGS  += -O3 -Os -Wall

src/addressUtilsByron.h

@@ -35,6 +35,6 @@ uint32_t extractProtocolMagic(
 
 #ifdef DEVEL
 void run_addressUtilsByron_test();
-#endif
+#endif // DEVEL
 
 #endif // H_CARDANO_APP_ADDRESS_UTILS_BYRON

src/addressUtilsByron_test.c

@@ -3,7 +3,7 @@
 #include "addressUtilsByron.h"
 #include "cardano.h"
 #include "hexUtils.h"
-#include "test_utils.h"
+#include "testUtils.h"
 
 #define HD HARDENED_BIP32
 
@@ -171,4 +171,4 @@ void run_addressUtilsByron_test()
 	testProtocolMagicExtractionThrows();
 }
 
-#endif
+#endif // DEVEL

src/addressUtilsShelley.c

@@ -33,6 +33,19 @@ bool isSupportedAddressType(uint8_t addressType)
 	}
 }
 
+bool isShelleyAddressType(uint8_t addressType)
+{
+	switch (addressType) {
+	case BASE:
+	case POINTER:
+	case ENTERPRISE:
+	case REWARD:
+		return true;
+	default:
+		return false;
+	}
+}
+
 uint8_t constructShelleyAddressHeader(address_type_t type, uint8_t networkId)
 {
 	ASSERT(isSupportedAddressType(type));
@@ -97,10 +110,13 @@ bool isStakingInfoConsistentWithAddressType(const addressParams_t* addressParams
 
 size_t view_appendPublicKeyHash(write_view_t* view, const bip44_path_t* keyDerivationPath)
 {
+	TRACE_STACK_USAGE();
+
 	extendedPublicKey_t extPubKey;
 	deriveExtendedPublicKey(keyDerivationPath, &extPubKey);
 
 	uint8_t hashedPubKey[ADDRESS_KEY_HASH_LENGTH];
+	STATIC_ASSERT(ADDRESS_KEY_HASH_LENGTH * 8 == 224, "wrong address key hash length");
 	blake2b_224_hash(
 	        extPubKey.pubKey, SIZEOF(extPubKey.pubKey),
 	        hashedPubKey, SIZEOF(hashedPubKey)
@@ -286,6 +302,8 @@ static size_t deriveAddress_reward(
         uint8_t* outBuffer, size_t outSize
 )
 {
+	TRACE_STACK_USAGE();
+
 	ASSERT(getAddressType(addressHeader) == REWARD);
 	ASSERT(outSize < BUFFER_SIZE_PARANOIA);
 
@@ -295,20 +313,37 @@ static size_t deriveAddress_reward(
 	}
 	{
 		// staking key path expected (corresponds to reward account)
-		ASSERT(bip44_isValidStakingKeyPath(spendingKeyPath)); // TODO check for unusual account?
+		ASSERT(bip44_isValidStakingKeyPath(spendingKeyPath));
+
 		view_appendPublicKeyHash(&out, spendingKeyPath);
 	}
 	{
 		// no staking data
 	}
 
-	const int ADDRESS_LENGTH = 1 + ADDRESS_KEY_HASH_LENGTH;
+	const int ADDRESS_LENGTH = REWARD_ACCOUNT_SIZE;
 	ASSERT(view_processedSize(&out) == ADDRESS_LENGTH);
 
 	return ADDRESS_LENGTH;
 }
 
-size_t constructRewardAddress(
+size_t constructRewardAddressFromKeyPath(
+        const bip44_path_t* path, uint8_t networkId, uint8_t* outBuffer, size_t outSize
+)
+{
+	ASSERT(outSize == REWARD_ACCOUNT_SIZE);
+	ASSERT(bip44_isValidStakingKeyPath(path));
+
+	TRACE_STACK_USAGE();
+
+	const uint8_t header = constructShelleyAddressHeader(REWARD, networkId);
+	return deriveAddress_reward(
+	               header, path,
+	               outBuffer, outSize
+	       );
+}
+
+size_t constructRewardAddressFromKeyHash(
         uint8_t networkId,
         const uint8_t* stakingKeyHashBuffer, size_t stakingKeyHashSize,
         uint8_t* outBuffer, size_t outSize
@@ -327,7 +362,7 @@ size_t constructRewardAddress(
 		view_appendData(&out, stakingKeyHashBuffer, stakingKeyHashSize);
 	}
 
-	const int ADDRESS_LENGTH = 1 + ADDRESS_KEY_HASH_LENGTH;
+	const int ADDRESS_LENGTH = REWARD_ACCOUNT_SIZE;
 	ASSERT(view_processedSize(&out) == ADDRESS_LENGTH);
 
 	return ADDRESS_LENGTH;
@@ -503,3 +538,41 @@ void view_parseAddressParams(read_view_t* view, addressParams_t* params)
 		ASSERT(false);
 	}
 }
+
+static inline bool isSpendingPathConsistentWithAddressType(const address_type_t addressType, const bip44_path_t* spendingPath)
+{
+#define CHECK(cond) if (!(cond)) return false
+	// Byron derivation path is only valid for a Byron address
+	// the rest should be Shelley derivation scheme
+	if (addressType == BYRON) {
+		CHECK(bip44_hasByronPrefix(spendingPath));
+	} else {
+		CHECK(bip44_hasShelleyPrefix(spendingPath));
+	}
+
+	if (addressType == REWARD) {
+		CHECK(bip44_isValidStakingKeyPath(spendingPath));
+	} else {
+		CHECK(bip44_isValidAddressPath(spendingPath));
+	}
+
+	return true;
+#undef CHECK
+}
+
+static inline bool isValidStakingInfo(const addressParams_t* addressParams)
+{
+#define CHECK(cond) if (!(cond)) return false
+	CHECK(isStakingInfoConsistentWithAddressType(addressParams));
+	if (addressParams->stakingChoice == STAKING_KEY_PATH) {
+		CHECK(bip44_isValidStakingKeyPath(&addressParams->stakingKeyPath));
+	}
+	return true;
+#undef CHECK
+}
+
+bool isValidAddressParams(const addressParams_t* addressParams)
+{
+	return isSpendingPathConsistentWithAddressType(addressParams->type, &addressParams->spendingKeyPath) &&
+	       isValidStakingInfo(addressParams);
+}

src/addressUtilsShelley.h

@@ -20,11 +20,13 @@ uint8_t getAddressHeader(uint8_t* addressBuffer, size_t addressSize);
 
 address_type_t getAddressType(uint8_t addressHeader);
 bool isSupportedAddressType(uint8_t addressHeader);
+bool isShelleyAddressType(uint8_t addressType);
 uint8_t constructShelleyAddressHeader(address_type_t type, uint8_t networkId);
 
 uint8_t getNetworkId(uint8_t addressHeader);
 bool isValidNetworkId(uint8_t networkId);
 
+
 // describes which staking info should be incorporated into address
 // (see stakingChoice in addressParams_t)
 typedef enum {
@@ -62,11 +64,17 @@ typedef struct {
 
 bool isStakingInfoConsistentWithAddressType(const addressParams_t* addressParams);
 
+__noinline_due_to_stack__
 size_t view_appendPublicKeyHash(write_view_t* view, const bip44_path_t* keyDerivationPath);
 
 size_t deriveAddress(const addressParams_t* addressParams, uint8_t* outBuffer, size_t outSize);
 
-size_t constructRewardAddress(
+__noinline_due_to_stack__
+size_t constructRewardAddressFromKeyPath(
+        const bip44_path_t* path, uint8_t networkId, uint8_t* outBuffer, size_t outSize
+);
+__noinline_due_to_stack__
+size_t constructRewardAddressFromKeyHash(
         uint8_t networkId,
         const uint8_t* stakingKeyHashBuffer, size_t stakingKeyHashSize,
         uint8_t* outBuffer, size_t outSize
@@ -78,9 +86,10 @@ size_t humanReadableAddress(const uint8_t* address, size_t addressSize, char* ou
 
 void view_parseAddressParams(read_view_t* view, addressParams_t* params);
 
+bool isValidAddressParams(const addressParams_t* addressParams);
 
 #ifdef DEVEL
 void run_addressUtilsShelley_test();
-#endif
+#endif // DEVEL
 
 #endif // H_CARDANO_APP_ADDRESS_UTILS_SHELLEY

src/addressUtilsShelley_test.c

@@ -4,7 +4,7 @@
 #include "cardano.h"
 #include "bip44.h"
 #include "hexUtils.h"
-#include "test_utils.h"
+#include "testUtils.h"
 
 #define HD HARDENED_BIP32
 #define MAX_ADDRESS_LENGTH 128
@@ -200,4 +200,4 @@ void run_addressUtilsShelley_test()
 	testAddressDerivation();
 }
 
-#endif
+#endif // DEVEL

src/assert.c

@@ -26,7 +26,7 @@ void assert(
 		}
 		#else
 #			error "RESET_ON_CRASH should be enabled in non-devel mode!"
-		#endif
+		#endif // DEVEL
 	}
 	#endif
 }

src/assert.h

@@ -1,5 +1,5 @@
-#ifndef H_CARDANO_APP_UTIL
-#define H_CARDANO_APP_UTIL
+#ifndef H_CARDANO_APP_ASSERT
+#define H_CARDANO_APP_ASSERT
 
 #include "common.h"
 
@@ -28,4 +28,4 @@ extern void assert(int cond, const char* msgStr);
 
 #define ASSERT(cond) assert((cond), _SHORTEN_( _FILE_LINE_, _MAX_ASSERT_LENGTH_))
 
-#endif
+#endif // H_CARDANO_APP_ASSERT