src/blacklist.h
author Roker <roker@pep-project.org>
Fri, 15 Sep 2017 17:22:37 +0200
changeset 2061 578476d90c0f
parent 1513 e7f7e42385b5
child 2415 7410f7666976
permissions -rw-r--r--
fix documentation comments
vb@1513
     1
// This file is under GNU General Public License 3.0
vb@1513
     2
// see LICENSE.txt
vb@1513
     3
fdik@494
     4
#pragma once
fdik@494
     5
fdik@494
     6
#include "pEpEngine.h"
fdik@494
     7
fdik@494
     8
#ifdef __cplusplus
fdik@494
     9
extern "C" {
fdik@494
    10
#endif
fdik@494
    11
fdik@494
    12
// blacklist_add() - add to blacklist
fdik@494
    13
//
fdik@494
    14
//  parameters:
fdik@494
    15
//      session (in)        session to use
fdik@494
    16
//      fpr (in)            fingerprint of key to blacklist
fdik@494
    17
fdik@494
    18
DYNAMIC_API PEP_STATUS blacklist_add(PEP_SESSION session, const char *fpr);
fdik@494
    19
fdik@494
    20
fdik@494
    21
// blacklist_delete() - delete from blacklist
fdik@494
    22
//
fdik@494
    23
//  parameters:
fdik@494
    24
//      session (in)        session to use
roker@2061
    25
//      fpr (in)            fingerprint of key to be removed from blacklist
fdik@494
    26
fdik@494
    27
DYNAMIC_API PEP_STATUS blacklist_delete(PEP_SESSION session, const char *fpr);
fdik@494
    28
fdik@494
    29
roker@2061
    30
// blacklist_is_listed() - is_listed in blacklist
fdik@494
    31
//
fdik@494
    32
//  parameters:
fdik@494
    33
//      session (in)        session to use
fdik@494
    34
//      fpr (in)            fingerprint of key to blacklist
vb@506
    35
//      bool (out)          flags if key is blacklisted
fdik@494
    36
fdik@494
    37
DYNAMIC_API PEP_STATUS blacklist_is_listed(
fdik@494
    38
        PEP_SESSION session,
fdik@494
    39
        const char *fpr,
fdik@494
    40
        bool *listed
fdik@494
    41
    );
fdik@494
    42
fdik@494
    43
fdik@494
    44
// blacklist_retrieve() - retrieve full blacklist of key fingerprints
fdik@494
    45
//
fdik@494
    46
//  parameters:
fdik@494
    47
//      session (in)        session to use
fdik@494
    48
//      blacklist (out)     copy of blacklist
fdik@494
    49
//
fdik@494
    50
//  caveat:
fdik@494
    51
//      the ownership of the copy of blacklist goes to the caller
fdik@494
    52
fdik@494
    53
DYNAMIC_API PEP_STATUS blacklist_retrieve(
fdik@494
    54
        PEP_SESSION session,
fdik@494
    55
        stringlist_t **blacklist
fdik@494
    56
    );
fdik@494
    57
fdik@494
    58
fdik@494
    59
#ifdef __cplusplus
fdik@494
    60
}
fdik@494
    61
#endif
fdik@494
    62