X-Git-Url: https://the.earth.li/gitweb/?p=onak.git;a=blobdiff_plain;f=cleankey.h;h=350e75df329bebc585ec1fc3468683f0804dffa0;hp=454dd4cd6c13ade22bc97a0c36c258e99a78d585;hb=adc800dbc424a1e246dd4a82a0c2e88eeda25531;hpb=6df51fef2960f533a741fb7290867387ed3fbba5

diff --git a/cleankey.h b/cleankey.h
index 454dd4c..350e75d 100644
--- a/cleankey.h
+++ b/cleankey.h
@@ -21,14 +21,21 @@
 
 #include "keystructs.h"
 
+#define ONAK_CLEAN_CHECK_SIGHASH	(1 << 0)
+#define ONAK_CLEAN_LARGE_PACKETS	(1 << 1)
+#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