X-Git-Url: https://the.earth.li/gitweb/?a=blobdiff_plain;f=cleankey.h;h=350e75df329bebc585ec1fc3468683f0804dffa0;hb=3512fa56e404e5dc2e3a6a3ca6fa23eb25760493;hp=3277e882279b6b859b242ed8f3e7c068b4cd6b7d;hpb=5e1b22d763640c4d7a09d07920403d8d491b4410;p=onak.git

diff --git a/cleankey.h b/cleankey.h
index 3277e88..350e75d 100644
--- a/cleankey.h
+++ b/cleankey.h
@@ -13,8 +13,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 __CLEANKEY_H__
@@ -22,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