radare2/libr/include/r_sign.h
2023-12-22 01:51:42 +01:00

178 lines
6.0 KiB
C

#ifndef R2_SIGN_H
#define R2_SIGN_H
#include <r_types.h>
#include <r_anal.h>
#include <r_search.h>
#ifdef __cplusplus
extern "C" {
#endif
R_LIB_VERSION_HEADER(r_sign);
#define ZIGN_HASH "sha256"
#define R_ZIGN_HASH R_HASH_SHA256
#define R_SIGN_COL_DELEM ':'
typedef enum {
R_SIGN_BYTES = 'b', // bytes pattern
R_SIGN_ANAL = 'a', // bytes pattern, input only, creates mask from byte analysis
R_SIGN_COMMENT = 'c', // comment
R_SIGN_GRAPH = 'g', // graph metrics
R_SIGN_OFFSET = 'o', // addr
R_SIGN_NAME = 'n', // real name
R_SIGN_REFS = 'r', // references
R_SIGN_XREFS = 'x', // xrefs
R_SIGN_VARS = 'v', // variables
R_SIGN_TYPES = 't', // types
R_SIGN_COLLISIONS = 'C', // collisions
R_SIGN_NEXT = 'N', // next
R_SIGN_BBHASH = 'h', // basic block hash
R_SIGN_END = '\x00', // used for sentenal value
} RSignType;
#define R_SIGN_TYPEMAX 16
typedef struct r_sign_graph_t {
int cc;
int nbbs;
int edges;
int ebbs;
int bbsum;
} RSignGraph;
typedef struct r_sign_bytes_t {
int size;
ut8 *bytes;
ut8 *mask;
} RSignBytes;
typedef struct r_sign_hash_t {
char *bbhash;
} RSignHash;
typedef struct r_sign_item_t {
// use RBinName maybe?
char *name;
char *realname;
char *next;
char *comment;
char *types;
const RSpace *space;
RSignBytes *bytes;
RSignGraph *graph;
ut64 addr;
RList /*<char>*/ *refs;
RList /*<char>*/ *xrefs;
RList /*<char>*/ *collisions;
RList /*<RAnalVarProt>*/ *vars;
RSignHash *hash;
} RSignItem;
typedef bool (*RSignForeachCallback) (RSignItem *it, void *user);
typedef int (*RSignSearchCallback) (RSignItem *it, RSearchKeyword *kw, ut64 addr, void *user);
typedef int (*RSignMatchCallback) (RSignItem *it, RAnalFunction *fcn, RSignType *stypes, void *user, RList *col);
typedef struct r_sign_search_met {
/* stypes (sign types) is an R_SIGN_END terminated array of RSignTypes that
* are going to be searched for. Valid stypes are: graph, offset, refs,
* bbhash, stypes, vars
*/
RSignType stypes[R_SIGN_TYPEMAX];
int mincc; // min complexity for graph search
int minsz;
RAnal *anal;
void *user; // user data for callback function
RSignMatchCallback cb;
} RSignSearchMetrics;
typedef struct r_sign_search_t {
RSearch *search;
RList *items;
RSignSearchCallback cb;
void *user;
} RSignSearch;
typedef struct r_sign_options_t {
double bytes_diff_threshold;
double graph_diff_threshold;
} RSignOptions;
typedef struct {
double score;
double bscore;
double gscore;
RSignItem *item;
} RSignCloseMatch;
#ifdef R_API
R_API bool r_sign_add_bytes(RAnal *a, const char *name, const char *val);
R_API bool r_sign_add_anal(RAnal *a, const char *name, const char *val);
R_API bool r_sign_add_graph(RAnal *a, const char *name, RSignGraph graph);
R_API int r_sign_all_functions(RAnal *a, bool merge);
R_API bool r_sign_add_func(RAnal *a, RAnalFunction *fcn, const char *name);
R_API bool r_sign_addto_item(RAnal *a, RSignItem *it, RAnalFunction *fcn, RSignType type);
R_API bool r_sign_add_addr(RAnal *a, const char *name, ut64 addr);
R_API bool r_sign_add_name(RAnal *a, const char *name, const char *realname);
R_API bool r_sign_add_comment(RAnal *a, const char *name, const char *comment);
R_API bool r_sign_add_types(RAnal *a, const char *name, const char *types);
R_API bool r_sign_add_refs(RAnal *a, const char *name, RList *refs);
R_API bool r_sign_add_xrefs(RAnal *a, const char *name, RList *xrefs);
R_API bool r_sign_add_vars(RAnal *a, const char *name, const char *vars);
R_API bool r_sign_delete(RAnal *a, const char *name);
R_API void r_sign_list(RAnal *a, int format);
R_API RList *r_sign_get_list(RAnal *a);
R_API bool r_sign_add_hash(RAnal *a, const char *name, int type, const char *val, int len);
R_API bool r_sign_add_bb_hash(RAnal *a, RAnalFunction *fcn, const char *name);
R_API char *r_sign_calc_bbhash(RAnal *a, RAnalFunction *fcn);
R_API bool r_sign_deserialize(RAnal *a, RSignItem *it, const char *k, const char *v);
R_API RSignItem *r_sign_get_item(RAnal *a, const char *name);
R_API bool r_sign_add_item(RAnal *a, RSignItem *it);
R_API bool r_sign_foreach(RAnal *a, RSignForeachCallback cb, void *user);
R_API const char *r_sign_type_to_name(int type);
R_API RSignSearch *r_sign_search_new(void);
R_API void r_sign_search_free(RSignSearch *ss);
R_API void r_sign_search_init(RAnal *a, RSignSearch *ss, int minsz, RSignSearchCallback cb, void *user);
R_API int r_sign_search_update(RAnal *a, RSignSearch *ss, ut64 *at, const ut8 *buf, int len);
R_API bool r_sign_resolve_collisions(RAnal *a);
R_API int r_sign_metric_search(RAnal *a, RSignSearchMetrics *sm);
R_API int r_sign_fcn_match_metrics(RSignSearchMetrics *sm, RAnalFunction *fcn);
R_API bool r_sign_load(RAnal *a, const char *file, bool merge);
R_API bool r_sign_load_gz(RAnal *a, const char *filename, bool merge);
R_API char *r_sign_path(RAnal *a, const char *file);
R_API bool r_sign_save(RAnal *a, const char *file);
R_API RSignItem *r_sign_item_new(void);
R_API void r_sign_item_free(RSignItem *item);
R_API void r_sign_graph_free(RSignGraph *graph);
R_API void r_sign_bytes_free(RSignBytes *bytes);
R_API void r_sign_hash_free(RSignHash *hash);
R_API RList *r_sign_fcn_refs(RAnal *a, RAnalFunction *fcn);
R_API RList *r_sign_fcn_xrefs(RAnal *a, RAnalFunction *fcn);
R_API RList *r_sign_fcn_vars(RAnal *a, RAnalFunction *fcn);
R_API int r_sign_is_flirt(RBuffer *buf);
R_API void r_sign_flirt_dump(const RAnal *anal, const char *flirt_file);
R_API void r_sign_flirt_scan(RAnal *anal, const char *flirt_file);
R_API RList *r_sign_find_closest_sig(RAnal *a, RSignItem *it, int count, double score_threshold);
R_API RList *r_sign_find_closest_fcn(RAnal *a, RSignItem *it, int count, double score_threshold);
R_API void r_sign_close_match_free(RSignCloseMatch *match);
R_API bool r_sign_diff(RAnal *a, RSignOptions *options, const char *other_space_name);
R_API bool r_sign_diff_by_name(RAnal *a, RSignOptions *options, const char *other_space_name, bool not_matching);
R_API RSignOptions *r_sign_options_new(const char *bytes_thresh, const char *graph_thresh);
R_API void r_sign_options_free(RSignOptions *options);
#endif
#ifdef __cplusplus
}
#endif
#endif