trust.h (1848B)
1 #ifndef LIBQAEDA_TRUST_H_ 2 #define LIBQAEDA_TRUST_H_ 3 4 #ifndef LQ_TRUST_FLAG_BITS 5 #define LQ_TRUST_FLAG_BITS 13 6 #endif 7 8 #include "lq/crypto.h" 9 #include "lq/store.h" 10 11 /// Controls the way trust flags are tested against a public key's trust flags 12 enum trust_mode_e { 13 TRUST_MATCH_NONE, ///< Ignore flags. 14 TRUST_MATCH_ONE, ///< Success on first matched flag. 15 TRUST_MATCH_BEST, ///< Match as many flags as possible. 16 TRUST_MATCH_ALL, ///< Strictly match all flags. 17 }; 18 19 /** 20 * @brief Check whether a public key is known (exists in public key store) and optionally perform match its trust flags. 21 * 22 * The value of the "mode" parameter controls the behavior of this routine, as well as which return value to expect. In 23 * every case, a public key entry has to exist in the store for the routine not to fail. 24 * 25 * * TRUST_MATCH_NONE: Flags are ignored, if the public key exists 1000000 will be returned. 26 * * TRUST_MATCH_ONE: If the public key exists and at least one flag matches, return 1000000 27 * * TRUST_MATCH_BEST: If the public key exists, return a value in the range 1000000 >= v > 0 depending on the ratio of actually tested and matched flags. For example, if 3 out of 5 flags match, 600000 will be returned. 28 * * TRUST_MATCH_ALL: Return 1000000 if the public key exists and all flags match. 29 * 30 * @param[in] Public key to match 31 * @param[in] Store to search for public key record in 32 * @param[in] Match mode 33 * @param[in] Flags to match. Must have room for LQ_TRUST_FLAG_BITS bits, rounded up to the byte boundary. 34 * @return If public key is not found, returns -1. If not, a value between 0 and 1000000 depending on the amount of relevant flag matches (see description above). 35 * @see enum trust_mode_e 36 */ 37 int lq_trust_check(LQPubKey *pubkey, LQStore *store, enum trust_mode_e mode, const unsigned char *flags); 38 39 #endif // LIBQAEDA_TRUST_H_ 40