Bump debhelper compat level to 13

[onak.git] / keyarray.h

diff --git a/keyarray.h b/keyarray.h
index 5be7b781dbef26ef9f02c2149848358be311d0a9..1ac13ba571c68d0190a5aa92bdf44d5e3ea9bbf8 100644 (file)
--- a/keyarray.h
+++ b/keyarray.h
@@ -14,8 +14,7 @@
  * more details.
  *
  * You should have received a copy of the GNU General Public License along with
- * this program; if not, write to the Free Software Foundation, Inc., 51
- * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
 #ifndef __KEYARRAY_H__
@@ -24,16 +23,18 @@
 #include <stdbool.h>
 #include <stdint.h>
 
+#include "keystructs.h"
+
 /**
- * @brief A sorted array of keyids
+ * @brief A sorted array of fingerprints
  *
- * Holds a sorted list of keyids, with room for growth - has details of both
- * the total size of the array as well as the current number of elements.
+ * Holds a sorted list of fingerprints, with room for growth - has details of
+ * both the total size of the array as well as the current number of elements.
  */
 struct keyarray {
-       /** The array of key ids */
-       uint64_t *keys;
-       /** Number of key ids in the array */
+       /** The array of key fingerprints */
+       struct openpgp_fingerprint *keys;
+       /** Number of fingerprints in the array */
        size_t count;
        /** Total size of the array */
        size_t size;
@@ -44,7 +45,7 @@ struct keyarray {
  * @param array Pointer to the key array
  * @param key The keyid to look for
  */
-bool array_find(struct keyarray *array, uint64_t key);
+bool array_find(struct keyarray *array, struct openpgp_fingerprint *fp);
 
 /**
  * @brief Free a key array
@@ -61,6 +62,34 @@ void array_free(struct keyarray *array);
  * Returns true if the key was added, false if it was found to be already
  * present.
  */
-bool array_add(struct keyarray *array, uint64_t key);
+bool array_add(struct keyarray *array, struct openpgp_fingerprint *fp);
+
+/**
+ * @brief Load a file into a keyarray
+ * @param array Pointer to the key array
+ * @param file The full path to the file to load
+ *
+ * Loads fingerprints from the supplied file into the provided keyarray. Does
+ * not re-initialise the array so can be called repeatedly to add multiple
+ * files. The file does not need to be sorted; array_add() is called for each
+ * key to ensure the array is suitable for binary searching with array_find()
+ */
+bool array_load(struct keyarray *array, const char *file);
+
+/**
+ * @brief Compare two OpenPGP fingerprints
+ * @param a Fingerprint 1
+ * @param b Fingerprint 2
+ *
+ * Compares 2 OpenPGP fingerprints, returning an integer less than, equal to,
+ * or greater than zero depending on whether a is less than, matches, or is
+ * greater than b.
+ *
+ * For the purposes of comparison shorter fingerprints sort earlier than
+ * longer fingerprints (i.e. v3 < v4 < v5) and comparison of same-length
+ * fingerprints treats them as a numberical value.
+ */
+int fingerprint_cmp(struct openpgp_fingerprint *a,
+               struct openpgp_fingerprint *b);
 
 #endif /* __KEYARRAY_H__ */