* 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__
#include "keystructs.h"
+#define ONAK_CLEAN_CHECK_SIGHASH (1 << 0)
+#define ONAK_CLEAN_LARGE_PACKETS (1 << 1)
+#define ONAK_CLEAN_DROP_V3_KEYS (1 << 2)
+#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