Use a set of policy flags to indicate what key cleaning to perform

[onak.git] / cleankey.h

diff --git a/cleankey.h b/cleankey.h
index 454dd4cd6c13ade22bc97a0c36c258e99a78d585..073ef666000af646d7d145296a51fda94f367fda 100644 (file)
--- a/cleankey.h
+++ b/cleankey.h
@@ -21,14 +21,20 @@
 
 #include "keystructs.h"
 
+#define ONAK_CLEAN_CHECK_SIGHASH       (1 << 0)
+#define ONAK_CLEAN_ALL                 (uint64_t) -1
+
 /**
  *     cleankeys - Apply all available cleaning options on a list of keys.
  *     @publickey: The list of keys to clean.
+ *     @policies: The cleaning policies to apply.
  *
- *     Applies all the cleaning options we can (eg duplicate key ids) to a
- *     list of keys. Returns 0 if no changes were made, otherwise the number
- *     of keys cleaned.
+ *     Applies the requested cleaning policies to a list of keys. These are
+ *     specified from the ONAK_CLEAN_* set of flags, or ONAK_CLEAN_ALL to
+ *     apply all available cleaning options. Returns 0 if no changes were
+ *     made, otherwise the number of keys cleaned. Note that some options
+ *     may result in keys being removed entirely from the list.
  */
-int cleankeys(struct openpgp_publickey *keys);
+int cleankeys(struct openpgp_publickey **keys, uint64_t policies);
 
 #endif