d-bis/app-ethereum
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Extracted the encodeType and typeHash functions from the main file

Browse Source
This commit is contained in:
Alexandre Paillier
2022-05-02 15:28:35 +02:00
parent e3dfd787b5
commit 5889da054e
6 changed files with 393 additions and 306 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
src_features/signMessageEIP712/eip712.h
View File

@@ -1,6 +1,7 @@
#ifndef EIP712_H_
#define EIP712_H_
#include <stdbool.h>
#include <stdint.h>
enum {
@@ -66,6 +67,8 @@ typedef enum
// Solidity typenames array mask
#define TYPENAME_MORE_TYPE (1 << 7) // For custom typename
#define KECCAK256_HASH_LENGTH 32
typedef struct
{
uint16_t length;
@@ -86,4 +89,31 @@ typedef struct
t_array array_levels;
} t_struct_field;
// TODO: Move these into a new file
const char *get_struct_name(const uint8_t *ptr, uint8_t *const length);
const uint8_t *get_struct_fields_array(const uint8_t *ptr,
uint8_t *const length);
const char *get_struct_field_typename(const uint8_t *ptr,
uint8_t *const length);
bool struct_field_has_typesize(const uint8_t *ptr);
uint8_t get_struct_field_typesize(const uint8_t *ptr);
bool struct_field_is_array(const uint8_t *ptr);
e_type struct_field_type(const uint8_t *ptr);
const uint8_t *get_struct_field_array_lvls_array(const uint8_t *ptr,
uint8_t *const length);
e_array_type struct_field_array_depth(const uint8_t *ptr,
uint8_t *const array_size);
const uint8_t *get_next_struct_field_array_lvl(const uint8_t *ptr);
const char *get_struct_field_typename(const uint8_t *ptr,
uint8_t *const length);
const char *get_struct_field_keyname(const uint8_t *ptr,
uint8_t *const length);
const uint8_t *get_next_struct_field_array_lvl(const uint8_t *ptr);
const uint8_t *get_next_struct_field(const void *ptr);
const uint8_t *get_structn(const uint8_t *const ptr,
const char *const name_ptr,
const uint8_t name_length);
#endif // EIP712_H_

304
src_features/signMessageEIP712/encode_type.c Normal file
View File

@@ -0,0 +1,304 @@
#include <stdlib.h>
#include <string.h>
#include <stdbool.h>
#include <stdio.h>
#include "mem.h"
#include "eip712.h"
#include "encode_type.h"
/**
* Format an unsigned number up to 32-bit into memory into an ASCII string.
*
* @param[in] value Value to write in memory
* @param[in] max_chars Maximum number of characters that could be written
*
* @return how many characters have been written in memory, 0 in case of an allocation error
*/
static uint8_t format_uint_into_mem(uint32_t value, const uint8_t max_chars)
{
char *ptr;
uint8_t written_chars;
if ((ptr = mem_alloc(sizeof(char) * max_chars)) == NULL)
{
return 0;
}
written_chars = sprintf(ptr, "%u", value);
mem_dealloc(max_chars - written_chars); // in case it ended up being less
return written_chars;
}
/**
*
*
* @param[in] struct_ptr pointer to the structure we want the typestring of
* @param[in] str_length length of the formatted string in memory
* @return pointer of the string in memory, \ref NULL in case of an error
*/
static const char *get_struct_type_string(const uint8_t *const struct_ptr, uint16_t *const str_length)
{
const char *str_start;
const char *struct_name;
uint8_t struct_name_length;
const uint8_t *field_ptr;
uint8_t fields_count;
const char *name;
uint8_t length;
uint16_t field_size;
uint8_t lvls_count;
const uint8_t *lvl_ptr;
uint8_t array_size;
char *char_ptr;
char *name_ptr;
// add name
struct_name = get_struct_name(struct_ptr, &struct_name_length);
if ((name_ptr = mem_alloc(sizeof(char) * struct_name_length)) == NULL)
{
return NULL;
}
str_start = memmove(name_ptr, struct_name, struct_name_length);
if ((char_ptr = mem_alloc(sizeof(char))) == NULL)
{
return NULL;
}
*char_ptr = '(';
field_ptr = get_struct_fields_array(struct_ptr, &fields_count);
for (uint8_t idx = 0; idx < fields_count; ++idx)
{
if (idx > 0)
{
if ((char_ptr = mem_alloc(sizeof(char))) == NULL)
{
return NULL;
}
*char_ptr = ',';
}
name = get_struct_field_typename(field_ptr, &length);
if ((name_ptr = mem_alloc(sizeof(char) * length)) == NULL)
{
return NULL;
}
memmove(name_ptr, name, length);
if (struct_field_has_typesize(field_ptr))
{
field_size = get_struct_field_typesize(field_ptr);
switch (struct_field_type(field_ptr))
{
case TYPE_SOL_INT:
case TYPE_SOL_UINT:
field_size *= 8; // bytes -> bits
break;
case TYPE_SOL_BYTES_FIX:
break;
default:
// should not be in here :^)
break;
}
// max value = 256, 3 characters max
format_uint_into_mem(field_size, 3);
}
if (struct_field_is_array(field_ptr))
{
lvl_ptr = get_struct_field_array_lvls_array(field_ptr, &lvls_count);
while (lvls_count-- > 0)
{
if ((char_ptr = mem_alloc(sizeof(char))) == NULL)
{
return NULL;
}
*char_ptr = '[';
switch (struct_field_array_depth(lvl_ptr, &array_size))
{
case ARRAY_DYNAMIC:
break;
case ARRAY_FIXED_SIZE:
// max value = 255, 3 characters max
format_uint_into_mem(array_size, 3);
break;
default:
// should not be in here :^)
break;
}
if ((char_ptr = mem_alloc(sizeof(char))) == NULL)
{
return NULL;
}
*char_ptr = ']';
lvl_ptr = get_next_struct_field_array_lvl(lvl_ptr);
}
}
if ((char_ptr = mem_alloc(sizeof(char))) == NULL)
{
return NULL;
}
*char_ptr = ' ';
name = get_struct_field_keyname(field_ptr, &length);
if ((name_ptr = mem_alloc(sizeof(char) * length)) == NULL)
{
return NULL;
}
memmove(name_ptr, name, length);
field_ptr = get_next_struct_field(field_ptr);
}
if ((char_ptr = mem_alloc(sizeof(char))) == NULL)
{
return NULL;
}
*char_ptr = ')';
*str_length = ((char*)mem_alloc(0) - str_start);
return str_start;
}
/**
*
*
* @param[in] structs_array pointer to structs array
* @param[in] deps_count count of how many struct dependencies pointers
* @param[in,out] dep pointer to the first dependency pointer
*/
static void sort_dependencies(const uint8_t *const deps_count,
void **dep)
{
bool changed = false;
void *tmp_ptr;
const char *name1, *name2;
uint8_t namelen1, namelen2;
int str_cmp_result;
for (size_t idx = 0; (idx + 1) < *deps_count; ++idx)
{
name1 = get_struct_name(*(dep + idx), &namelen1);
name2 = get_struct_name(*(dep + idx + 1), &namelen2);
str_cmp_result = strncmp(name1, name2, MIN(namelen1, namelen2));
if ((str_cmp_result > 0) || ((str_cmp_result == 0) && (namelen1 > namelen2)))
{
tmp_ptr = *(dep + idx);
*(dep + idx) = *(dep + idx + 1);
*(dep + idx + 1) = tmp_ptr;
changed = true;
}
}
// recurse until it is sorted
if (changed)
{
sort_dependencies(deps_count, dep);
}
}
/**
*
*
* @param[in] structs_array pointer to structs array
* @param[out] deps_count count of how many struct dependencie pointers
* @param[in] dep pointer to the first dependency pointer
* @param[in] struct_ptr pointer to the struct we are getting the dependencies of
* @return \ref false in case of a memory allocation error, \ref true otherwise
*/
static bool get_struct_dependencies(const void *const structs_array,
uint8_t *const deps_count,
void **dep,
const void *const struct_ptr)
{
uint8_t fields_count;
const void *field_ptr;
const char *arg_structname;
uint8_t arg_structname_length;
const void *arg_struct_ptr;
size_t dep_idx;
const void **new_dep;
field_ptr = get_struct_fields_array(struct_ptr, &fields_count);
for (uint8_t idx = 0; idx < fields_count; ++idx)
{
if (struct_field_type(field_ptr) == TYPE_CUSTOM)
{
// get struct name
arg_structname = get_struct_field_typename(field_ptr, &arg_structname_length);
// from its name, get the pointer to its definition
arg_struct_ptr = get_structn(structs_array, arg_structname, arg_structname_length);
// check if it is not already present in the dependencies array
for (dep_idx = 0; dep_idx < *deps_count; ++dep_idx)
{
// it's a match!
if (*(dep + dep_idx) == arg_struct_ptr)
{
break;
}
}
// if it's not present in the array, add it and recurse into it
if (dep_idx == *deps_count)
{
if ((new_dep = mem_alloc(sizeof(void*))) == NULL)
{
return false;
}
*new_dep = arg_struct_ptr;
*deps_count += 1;
get_struct_dependencies(structs_array, deps_count, dep, arg_struct_ptr);
}
}
field_ptr = get_next_struct_field(field_ptr);
}
return true;
}
/**
*
*
* @param[in] structs_array pointer to structs array
* @param[in] struct_name name of the given struct
* @param[in] struct_name_length length of the name of the given struct
* @param[out] encoded_length length of the returned string
* @return pointer to encoded string or \ref NULL in case of a memory allocation error
*/
const char *encode_type(const void *const structs_array,
const char *const struct_name,
const uint8_t struct_name_length,
uint16_t *const encoded_length)
{
const void *const struct_ptr = get_structn(structs_array,
struct_name,
struct_name_length);
uint8_t *deps_count;
void **dep;
uint16_t length;
const char *typestr;
*encoded_length = 0;
if ((deps_count = mem_alloc(sizeof(uint8_t))) == NULL)
{
return NULL;//false;
}
*deps_count = 0;
// get list of structs (own + dependencies), properly ordered
dep = (void**)(deps_count + 1); // get first elem
if (get_struct_dependencies(structs_array, deps_count, dep, struct_ptr) == false)
{
return NULL;//false;
}
sort_dependencies(deps_count, dep);
typestr = get_struct_type_string(struct_ptr, &length);
*encoded_length += length;
// loop over each struct and generate string
for (int idx = 0; idx < *deps_count; ++idx)
{
get_struct_type_string(*dep, &length);
*encoded_length += length;
dep += 1;
}
return typestr;//true;
}

11
src_features/signMessageEIP712/encode_type.h Normal file
View File

@@ -0,0 +1,11 @@
#ifndef ENCODE_TYPE_H_
#define ENCODE_TYPE_H_
#include <stdint.h>
const char *encode_type(const void *const structs_array,
const char *const struct_name,
const uint8_t struct_name_length,
uint16_t *const encoded_length);
#endif // ENCODE_TYPE_H_

313
src_features/signMessageEIP712/entrypoint.c
View File

@@ -6,6 +6,7 @@
#include "eip712.h"
#include "mem.h"
#include "type_hash.h"
static uint8_t *typenames_array;
@@ -31,19 +32,19 @@ static inline uint8_t get_struct_field_typedesc(const uint8_t *ptr)
}
// ptr must point to the beginning of a struct field
static inline bool struct_field_is_array(const uint8_t *ptr)
bool struct_field_is_array(const uint8_t *ptr)
{
return (get_struct_field_typedesc(ptr) & ARRAY_MASK);
}
// ptr must point to the beginning of a struct field
static inline bool struct_field_has_typesize(const uint8_t *ptr)
bool struct_field_has_typesize(const uint8_t *ptr)
{
return (get_struct_field_typedesc(ptr) & TYPESIZE_MASK);
}
// ptr must point to the beginning of a struct field
static inline e_type struct_field_type(const uint8_t *ptr)
e_type struct_field_type(const uint8_t *ptr)
{
return (get_struct_field_typedesc(ptr) & TYPE_MASK);
}
@@ -98,7 +99,7 @@ const char *get_struct_field_sol_typename(const uint8_t *ptr,
// ptr must point to the beginning of a struct field
const char *get_struct_field_typename(const uint8_t *ptr,
uint8_t *const length)
uint8_t *const length)
{
if (struct_field_type(ptr) == TYPE_CUSTOM)
{
@@ -167,7 +168,7 @@ const uint8_t *get_struct_field_array_lvls_array(const uint8_t *ptr,
// ptr must point to the beginning of a struct field
const char *get_struct_field_keyname(const uint8_t *ptr,
uint8_t *const length)
uint8_t *const length)
{
const uint8_t *field_ptr;
uint8_t size;
@@ -389,306 +390,6 @@ bool set_struct_field(const uint8_t *const data)
return true;
}
/**
* Format an unsigned number up to 32-bit into memory into an ASCII string.
*
* @param[in] value Value to write in memory
* @param[in] max_chars Maximum number of characters that could be written
*
* @return how many characters have been written in memory, 0 in case of an allocation error
*/
uint8_t format_uint_into_mem(uint32_t value, const uint8_t max_chars)
{
char *ptr;
uint8_t written_chars;
if ((ptr = mem_alloc(sizeof(char) * max_chars)) == NULL)
{
return 0;
}
written_chars = sprintf(ptr, "%u", value);
mem_dealloc(max_chars - written_chars); // in case it ended up being less
return written_chars;
}
/**
*
*
* @param[in] struct_ptr pointer to the structure we want the typestring of
* @param[in] str_length length of the formatted string in memory
* @return pointer of the string in memory, \ref NULL in case of an error
*/
const char *get_struct_type_string(const uint8_t *const struct_ptr, uint16_t *const str_length)
{
const char *str_start;
const char *struct_name;
uint8_t struct_name_length;
const uint8_t *field_ptr;
uint8_t fields_count;
const char *name;
uint8_t length;
uint16_t field_size;
uint8_t lvls_count;
const uint8_t *lvl_ptr;
uint8_t array_size;
char *char_ptr;
char *name_ptr;
// add name
struct_name = get_struct_name(struct_ptr, &struct_name_length);
if ((name_ptr = mem_alloc(sizeof(char) * struct_name_length)) == NULL)
{
return NULL;
}
str_start = memmove(name_ptr, struct_name, struct_name_length);
if ((char_ptr = mem_alloc(sizeof(char))) == NULL)
{
return NULL;
}
*char_ptr = '(';
field_ptr = get_struct_fields_array(struct_ptr, &fields_count);
for (uint8_t idx = 0; idx < fields_count; ++idx)
{
if (idx > 0)
{
if ((char_ptr = mem_alloc(sizeof(char))) == NULL)
{
return NULL;
}
*char_ptr = ',';
}
name = get_struct_field_typename(field_ptr, &length);
if ((name_ptr = mem_alloc(sizeof(char) * length)) == NULL)
{
return NULL;
}
memmove(name_ptr, name, length);
if (struct_field_has_typesize(field_ptr))
{
field_size = get_struct_field_typesize(field_ptr);
switch (struct_field_type(field_ptr))
{
case TYPE_SOL_INT:
case TYPE_SOL_UINT:
field_size *= 8; // bytes -> bits
break;
case TYPE_SOL_BYTES_FIX:
break;
default:
// should not be in here :^)
break;
}
// max value = 256, 3 characters max
format_uint_into_mem(field_size, 3);
}
if (struct_field_is_array(field_ptr))
{
lvl_ptr = get_struct_field_array_lvls_array(field_ptr, &lvls_count);
while (lvls_count-- > 0)
{
if ((char_ptr = mem_alloc(sizeof(char))) == NULL)
{
return NULL;
}
*char_ptr = '[';
switch (struct_field_array_depth(lvl_ptr, &array_size))
{
case ARRAY_DYNAMIC:
break;
case ARRAY_FIXED_SIZE:
// max value = 255, 3 characters max
format_uint_into_mem(array_size, 3);
break;
default:
// should not be in here :^)
break;
}
if ((char_ptr = mem_alloc(sizeof(char))) == NULL)
{
return NULL;
}
*char_ptr = ']';
lvl_ptr = get_next_struct_field_array_lvl(lvl_ptr);
}
}
if ((char_ptr = mem_alloc(sizeof(char))) == NULL)
{
return NULL;
}
*char_ptr = ' ';
name = get_struct_field_keyname(field_ptr, &length);
if ((name_ptr = mem_alloc(sizeof(char) * length)) == NULL)
{
return NULL;
}
memmove(name_ptr, name, length);
field_ptr = get_next_struct_field(field_ptr);
}
if ((char_ptr = mem_alloc(sizeof(char))) == NULL)
{
return NULL;
}
*char_ptr = ')';
*str_length = ((char*)mem_alloc(0) - str_start);
return str_start;
}
/**
*
*
* @param[in] structs_array pointer to structs array
* @param[in] deps_count count of how many struct dependencies pointers
* @param[in,out] dep pointer to the first dependency pointer
*/
void sort_dependencies(const uint8_t *const deps_count,
void **dep)
{
bool changed = false;
void *tmp_ptr;
const char *name1, *name2;
uint8_t namelen1, namelen2;
int str_cmp_result;
for (size_t idx = 0; (idx + 1) < *deps_count; ++idx)
{
name1 = get_struct_name(*(dep + idx), &namelen1);
name2 = get_struct_name(*(dep + idx + 1), &namelen2);
str_cmp_result = strncmp(name1, name2, MIN(namelen1, namelen2));
if ((str_cmp_result > 0) || ((str_cmp_result == 0) && (namelen1 > namelen2)))
{
tmp_ptr = *(dep + idx);
*(dep + idx) = *(dep + idx + 1);
*(dep + idx + 1) = tmp_ptr;
changed = true;
}
}
// recurse until it is sorted
if (changed)
{
sort_dependencies(deps_count, dep);
}
}
/**
*
*
* @param[in] structs_array pointer to structs array
* @param[out] deps_count count of how many struct dependencie pointers
* @param[in] dep pointer to the first dependency pointer
* @param[in] struct_ptr pointer to the struct we are getting the dependencies of
* @return \ref false in case of a memory allocation error, \ref true otherwise
*/
bool get_struct_dependencies(const void *const structs_array,
uint8_t *const deps_count,
void **dep,
const void *const struct_ptr)
{
uint8_t fields_count;
const void *field_ptr;
const char *arg_structname;
uint8_t arg_structname_length;
const void *arg_struct_ptr;
size_t dep_idx;
const void **new_dep;
field_ptr = get_struct_fields_array(struct_ptr, &fields_count);
for (uint8_t idx = 0; idx < fields_count; ++idx)
{
if (struct_field_type(field_ptr) == TYPE_CUSTOM)
{
// get struct name
arg_structname = get_struct_field_typename(field_ptr, &arg_structname_length);
// from its name, get the pointer to its definition
arg_struct_ptr = get_structn(structs_array, arg_structname, arg_structname_length);
// check if it is not already present in the dependencies array
for (dep_idx = 0; dep_idx < *deps_count; ++dep_idx)
{
// it's a match!
if (*(dep + dep_idx) == arg_struct_ptr)
{
break;
}
}
// if it's not present in the array, add it and recurse into it
if (dep_idx == *deps_count)
{
if ((new_dep = mem_alloc(sizeof(void*))) == NULL)
{
return false;
}
*new_dep = arg_struct_ptr;
*deps_count += 1;
get_struct_dependencies(structs_array, deps_count, dep, arg_struct_ptr);
}
}
field_ptr = get_next_struct_field(field_ptr);
}
return true;
}
/**
*
*
* @param[in] structs_array pointer to structs array
* @param[in] struct_name name of the given struct
* @param[in] struct_name_length length of the name of the given struct
* @return \ref false in case of a memory allocation error, \ref true otherwise
*/
bool get_type_hash(const void *const structs_array,
const char *const struct_name,
const uint8_t struct_name_length)
{
const void *const struct_ptr = get_structn(structs_array,
struct_name,
struct_name_length);
const void *const mem_loc_bak = mem_alloc(0); // backup the memory location
uint8_t *deps_count;
void **dep;
uint16_t total_length = 0;
uint16_t length;
const char *typestr;
if ((deps_count = mem_alloc(sizeof(uint8_t))) == NULL)
{
return false;
}
*deps_count = 0;
// get list of structs (own + dependencies), properly ordered
dep = (void**)(deps_count + 1); // get first elem
if (get_struct_dependencies(structs_array, deps_count, dep, struct_ptr) == false)
{
return false;
}
sort_dependencies(deps_count, dep);
typestr = get_struct_type_string(struct_ptr, &length);
total_length += length;
// loop over each struct and generate string
for (int idx = 0; idx < *deps_count; ++idx)
{
get_struct_type_string(*dep, &length);
total_length += length;
dep += 1;
}
fwrite(typestr, sizeof(char), total_length, stdout);
printf("\n");
// restore the memory location
mem_dealloc(mem_alloc(0) - mem_loc_bak);
return true;
}
bool handle_apdu(const uint8_t *const data)
{
@@ -712,7 +413,7 @@ bool handle_apdu(const uint8_t *const data)
switch (data[OFFSET_P2])
{
case P2_NAME:
get_type_hash(structs_array, (char*)&data[OFFSET_DATA], data[OFFSET_LC]);
type_hash(structs_array, (char*)&data[OFFSET_DATA], data[OFFSET_LC]);
break;
case P2_FIELD:
break;

31
src_features/signMessageEIP712/type_hash.c Normal file
View File

@@ -0,0 +1,31 @@
#include <stdlib.h>
#include <stdio.h>
#include "eip712.h"
#include "mem.h"
#include "encode_type.h"
#include "type_hash.h"
const uint8_t *type_hash(const void *const structs_array,
const char *const struct_name,
const uint8_t struct_name_length)
{
const void *const mem_loc_bak = mem_alloc(0); // backup the memory location
const char *typestr;
uint16_t length;
typestr = encode_type(structs_array, struct_name, struct_name_length, &length);
if (typestr == NULL)
{
return NULL;
}
#ifdef DEBUG
fwrite(typestr, sizeof(char), length, stdout);
printf("\n");
#endif
// restore the memory location
mem_dealloc(mem_alloc(0) - mem_loc_bak);
return NULL;
}

10
src_features/signMessageEIP712/type_hash.h Normal file
View File

@@ -0,0 +1,10 @@
#ifndef TYPE_HASH_H_
#define TYPE_HASH_H_
#include <stdint.h>
const uint8_t *type_hash(const void *const structs_array,
const char *const struct_name,
const uint8_t struct_name_length);
#endif // TYPE_HASH_H_