// This file is under GNU General Public License 3.0

// see LICENSE.txt

#pragma once

#include "pEpEngine.h"

#ifdef __cplusplus

extern "C" {

#endif

// blacklist_add() - add to blacklist

//

//  parameters:

//      session (in)        session to use

//      fpr (in)            fingerprint of key to blacklist

//

//  caveat:

//      there is no point in blacklisting an own key; for any own

//      identity, this will be ignored. The correct function to use

//      for own keys in this event is "key_reset_trust".

//      Also, this is only effective for OpenPGP-level trust. If

//      this key is for a pEp user, the blacklist is ignored.

DYNAMIC_API PEP_STATUS blacklist_add(PEP_SESSION session, const char *fpr);

// blacklist_delete() - delete from blacklist

//

//  parameters:

//      session (in)        session to use

//      fpr (in)            fingerprint of key to be removed from blacklist

DYNAMIC_API PEP_STATUS blacklist_delete(PEP_SESSION session, const char *fpr);

// blacklist_is_listed() - is_listed in blacklist

//

//  parameters:

//      session (in)        session to use

//      fpr (in)            fingerprint of key to blacklist

//      bool (out)          flags if key is blacklisted

DYNAMIC_API PEP_STATUS blacklist_is_listed(

        PEP_SESSION session,

        const char *fpr,

        bool *listed

    );

// blacklist_retrieve() - retrieve full blacklist of key fingerprints

//

//  parameters:

//      session (in)        session to use

//      blacklist (out)     copy of blacklist

//

//  caveat:

//      the ownership of the copy of blacklist goes to the caller

DYNAMIC_API PEP_STATUS blacklist_retrieve(

        PEP_SESSION session,

        stringlist_t **blacklist

    );

#ifdef __cplusplus

}

#endif