pEpCOMServerAdapter.idl
author Volker Birk <vb@pep-project.org>
Fri, 11 Mar 2016 16:07:00 +0100
changeset 65 4736900394cb
parent 62 e01f81c9c881
child 67 6e53205493ef
permissions -rw-r--r--
adding blacklist
vb@0
     1
// pEpCOMServerAdapter.idl : IDL source for pEpCOMServerAdapter
vb@0
     2
//
vb@0
     3
vb@0
     4
// This file will be processed by the MIDL tool to
vb@0
     5
// produce the type library (pEpCOMServerAdapter.tlb) and marshalling code.
vb@0
     6
vb@0
     7
import "oaidl.idl";
vb@0
     8
import "ocidl.idl";
vb@0
     9
vb@0
    10
[
vb@0
    11
    object,
vb@0
    12
    uuid(9A9F4422-CF0A-45D7-90CD-1D1B7B2A4540),
vb@0
    13
    oleautomation,
vb@0
    14
    nonextensible,
vb@0
    15
    pointer_default(unique)
vb@0
    16
]
vb@0
    17
interface IpEpEngine : IUnknown {
vb@60
    18
    // runtime config of the adapter
vb@60
    19
vb@61
    20
    HRESULT verbose_logging([in] VARIANT_BOOL enable);
vb@51
    21
vb@60
    22
    // runtime config of the engine
vb@60
    23
vb@61
    24
    HRESULT passive_mode([in] VARIANT_BOOL enable);
vb@61
    25
    HRESULT unencrypted_subject([in] VARIANT_BOOL enable);
vb@60
    26
vb@60
    27
    // basic API
vb@60
    28
vb@60
    29
    typedef enum _pEp_STATUS {
vb@0
    30
        pEp_STATUS_OK = 0,
vb@0
    31
vb@62
    32
        pEp_INIT_CANNOT_LOAD_GPGME = 0x0110,
vb@62
    33
        pEp_INIT_GPGME_INIT_FAILED = 0x0111,
vb@62
    34
        pEp_INIT_NO_GPG_HOME = 0x0112,
vb@62
    35
        pEp_INIT_NETPGP_INIT_FAILED = 0x0113,
vb@62
    36
vb@62
    37
        pEp_INIT_SQLITE3_WITHOUT_MUTEX = 0x0120,
vb@62
    38
        pEp_INIT_CANNOT_OPEN_DB = 0x0121,
vb@62
    39
        pEp_INIT_CANNOT_OPEN_SYSTEM_DB = 0x0122,
vb@62
    40
vb@0
    41
        pEp_KEY_NOT_FOUND = 0x0201,
vb@0
    42
        pEp_KEY_HAS_AMBIG_NAME = 0x0202,
vb@0
    43
        pEp_GET_KEY_FAILED = 0x0203,
vb@0
    44
vb@62
    45
        pEp_CANNOT_FIND_IDENTITY = 0x0301,
vb@62
    46
        pEp_CANNOT_SET_PERSON = 0x0381,
vb@62
    47
        pEp_CANNOT_SET_PGP_KEYPAIR = 0x0382,
vb@62
    48
        pEp_CANNOT_SET_IDENTITY = 0x0383,
vb@62
    49
        pEp_CANNOT_SET_TRUST = 0x0384,
vb@62
    50
vb@0
    51
        pEp_UNENCRYPTED = 0x0400,
vb@0
    52
        pEp_VERIFIED = 0x0401,
vb@0
    53
        pEp_DECRYPTED = 0x0402,
vb@0
    54
        pEp_DECRYPTED_AND_VERIFIED = 0x0403,
vb@0
    55
        pEp_DECRYPT_WRONG_FORMAT = 0x0404,
vb@0
    56
        pEp_DECRYPT_NO_KEY = 0x0405,
vb@0
    57
        pEp_DECRYPT_SIGNATURE_DOES_NOT_MATCH = 0x0406,
vb@0
    58
        pEp_VERIFY_NO_KEY = 0x0407,
vb@0
    59
        pEp_VERIFIED_AND_TRUSTED = 0x0408,
vb@62
    60
        pEp_CANNOT_DECRYPT_UNKNOWN = 0x04ff,
vb@0
    61
vb@62
    62
        pEp_TRUSTWORD_NOT_FOUND = 0x0501,
vb@62
    63
vb@62
    64
        pEp_CANNOT_CREATE_KEY = 0x0601,
vb@62
    65
        pEp_CANNOT_SEND_KEY = 0x0602,
vb@62
    66
vb@62
    67
        pEp_PHRASE_NOT_FOUND = 0x0701,
vb@62
    68
vb@62
    69
        pEp_COMMIT_FAILED = 0xff01,
vb@62
    70
vb@62
    71
        pEp_CANNOT_CREATE_TEMP_FILE = -5,
vb@0
    72
        pEp_ILLEGAL_VALUE = -4,
vb@0
    73
        pEp_BUFFER_TOO_SMALL = -3,
vb@0
    74
        pEp_OUT_OF_MEMORY = -2,
vb@0
    75
        pEp_UNKNOWN_ERROR = -1
vb@0
    76
    } pEp_STATUS;
vb@0
    77
vb@4
    78
    HRESULT log([in] BSTR title, [in] BSTR entity, [in, defaultvalue("")] BSTR description, [in, defaultvalue("")] BSTR comment);
vb@4
    79
    HRESULT decrypt([in] BSTR ctext, [out] BSTR * ptext, [out] SAFEARRAY(BSTR) * key_list, [out, retval] pEp_STATUS * decrypt_status);
vb@4
    80
    HRESULT decrypt_b([in] BSTR ctext, [out] SAFEARRAY(BYTE) * ptext, [out] SAFEARRAY(BSTR) * key_list, [out, retval] pEp_STATUS * decrypt_status);
vb@4
    81
    HRESULT encrypt([in] SAFEARRAY(BSTR) key_list, [in] BSTR ptext, [out] BSTR * ctext, [out, retval] pEp_STATUS * status);
vb@4
    82
    HRESULT encrypt_b([in] SAFEARRAY(BSTR) key_list, [in] SAFEARRAY(BYTE) ptext, [out] BSTR * ctext, [out, retval] pEp_STATUS * status);
vb@4
    83
    HRESULT verify([in] BSTR text, [in] BSTR signature, [out] SAFEARRAY(BSTR) * key_list, [out, retval] pEp_STATUS * verify_status);
vb@17
    84
    HRESULT trustword([in] LONG value, [in, defaultvalue("en")] BSTR lang, [out, retval] BSTR * word);
vb@17
    85
    HRESULT trustwords([in] BSTR fpr, [in, defaultvalue("en")] BSTR lang, [in, defaultvalue(0)] LONG max_words, [out, retval] BSTR * words);
vb@58
    86
    HRESULT get_crashdump_log([in, defaultvalue(0)] LONG maxlines, [out, retval] BSTR * log);
vb@59
    87
    HRESULT get_languagelist([out, retval] BSTR * languages);
vb@59
    88
    HRESULT get_phrase([in] BSTR lang, [in] LONG phrase_id, [out, retval] BSTR * phrase);
vb@0
    89
vb@0
    90
    typedef enum _pEp_comm_type {
vb@0
    91
        pEp_ct_unknown = 0,
vb@0
    92
vb@0
    93
        // range 0x01 to 0x09: no encryption, 0x0a to 0x0e: nothing reasonable
vb@0
    94
vb@0
    95
        pEp_ct_no_encryption = 0x01,                // generic
vb@0
    96
        pEp_ct_no_encrypted_channel = 0x02,
vb@0
    97
        pEp_ct_key_not_found = 0x03,
vb@0
    98
        pEp_ct_key_expired = 0x04,
vb@0
    99
        pEp_ct_key_revoked = 0x05,
vb@0
   100
        pEp_ct_key_b0rken = 0x06,
vb@0
   101
        pEp_ct_my_key_not_included = 0x09,
vb@0
   102
vb@0
   103
        pEp_ct_security_by_obscurity = 0x0a,
vb@0
   104
        pEp_ct_b0rken_crypto = 0x0b,
vb@62
   105
        pEp_ct_key_too_short = 0x0c,
vb@0
   106
vb@62
   107
        pEp_ct_compromized = 0x0e,                  // known compromized connection
vb@62
   108
        pEp_ct_mistrusted = 0x0f,                   // known mistrusted key
vb@0
   109
vb@0
   110
        // range 0x10 to 0x3f: unconfirmed encryption
vb@0
   111
vb@0
   112
        pEp_ct_unconfirmed_encryption = 0x10,       // generic
vb@62
   113
        pEp_ct_OpenPGP_weak_unconfirmed = 0x11,     // RSA 1024 is weak
vb@62
   114
vb@62
   115
        pEp_ct_to_be_checked = 0x20,                // generic
vb@62
   116
        pEp_ct_SMIME_unconfirmed = 0x21,
vb@62
   117
        pEp_ct_CMS_unconfirmed = 0x22,
vb@62
   118
vb@62
   119
        pEp_ct_strong_but_unconfirmed = 0x30,       // generic
vb@62
   120
        pEp_ct_OpenPGP_unconfirmed = 0x38,          // key at least 2048 bit RSA or EC
vb@62
   121
        pEp_ct_OTR_unconfirmed = 0x3a,
vb@0
   122
vb@0
   123
        // range 0x40 to 0x7f: unconfirmed encryption and anonymization
vb@0
   124
vb@0
   125
        pEp_ct_unconfirmed_enc_anon = 0x40,         // generic
vb@0
   126
        pEp_ct_pEp_unconfirmed = 0x7f,
vb@0
   127
vb@0
   128
        pEp_ct_confirmed = 0x80,                    // this bit decides if trust is confirmed
vb@0
   129
vb@0
   130
        // range 0x81 to 0x8f: reserved
vb@0
   131
        // range 0x90 to 0xbf: confirmed encryption
vb@0
   132
vb@0
   133
        pEp_ct_confirmed_encryption = 0x90,         // generic
vb@62
   134
        pEp_ct_OpenPGP_weak = 0x91,                 // RSA 1024 is weak
vb@62
   135
vb@62
   136
        pEp_ct_to_be_checked_confirmed = 0xa0,      //generic
vb@62
   137
        pEp_ct_SMIME = 0xa1,
vb@62
   138
        pEp_ct_CMS = 0xa2,
vb@62
   139
vb@62
   140
        pEp_ct_strong_encryption = 0xb0,            // generic
vb@62
   141
        pEp_ct_OpenPGP = 0xb8,                      // key at least 2048 bit RSA or EC
vb@62
   142
        pEp_ct_OTR = 0xba,
vb@0
   143
vb@0
   144
        // range 0xc0 to 0xff: confirmed encryption and anonymization
vb@0
   145
vb@0
   146
        pEp_ct_confirmed_enc_anon = 0xc0,           // generic
vb@0
   147
        pEp_ct_pEp = 0xff
vb@0
   148
    } pEp_comm_type;
vb@0
   149
vb@22
   150
    [uuid(0CB90E62-8A6A-4CA0-99D7-481704051FF0)] struct pEp_identity_s {
vb@0
   151
        BSTR address;
vb@0
   152
        BSTR fpr;
vb@0
   153
        BSTR user_id;
vb@0
   154
        BSTR username;
vb@0
   155
        pEp_comm_type comm_type;
vb@0
   156
        BSTR lang;
vb@0
   157
    };
vb@0
   158
vb@4
   159
    HRESULT get_identity([in] BSTR address, [out, retval] struct pEp_identity_s * ident);
vb@4
   160
    HRESULT set_identity([in] struct pEp_identity_s * ident);
vb@4
   161
    HRESULT generate_keypair([in] struct pEp_identity_s * ident, [out, retval] BSTR * fpr);
vb@4
   162
    HRESULT delete_keypair([in] BSTR fpr);
vb@4
   163
    HRESULT import_key([in] BSTR key_data);
vb@4
   164
    HRESULT import_key_b([in] SAFEARRAY(BYTE) key_data);
vb@4
   165
    HRESULT export_key([in] BSTR fpr, [out, retval] BSTR * key_data);
vb@4
   166
    HRESULT recv_key([in] BSTR pattern);
vb@4
   167
    HRESULT find_keys([in] BSTR pattern, [out, retval] SAFEARRAY(BSTR) * key_list);
vb@4
   168
    HRESULT send_key([in] BSTR pattern);
vb@0
   169
vb@24
   170
    HRESULT start_keyserver_lookup();
vb@24
   171
    HRESULT stop_keyserver_lookup();
vb@24
   172
vb@4
   173
    HRESULT examine_identity([in] struct pEp_identity_s * ident);
vb@4
   174
    HRESULT myself([in] struct pEp_identity_s *ident, [out, retval] struct pEp_identity_s *result);
vb@4
   175
    HRESULT update_identity([in] struct pEp_identity_s *ident, [out, retval] struct pEp_identity_s *result);
vb@49
   176
    HRESULT key_compromized([in] struct pEp_identity_s *ident);
Edouard@55
   177
    HRESULT key_reset_trust([in] struct pEp_identity_s *ident);
vb@50
   178
    HRESULT trust_personal_key([in] struct pEp_identity_s *ident, [out, retval] struct pEp_identity_s *result);
vb@4
   179
vb@65
   180
    // Blacklist API
vb@65
   181
vb@65
   182
    HRESULT blacklist_add([in] BSTR fpr);
vb@65
   183
    HRESULT blacklist_delete([in] BSTR fpr);
vb@65
   184
    HRESULT blacklist_is_listed([in] BSTR fpr, [out, retval] VARIANT_BOOL *listed);
vb@65
   185
    HRESULT blacklist_retrieve([out, retval] SAFEARRAY(BSTR) *blacklist);
vb@65
   186
vb@15
   187
    // Message API
vb@12
   188
vb@15
   189
    typedef enum _pEp_color {
vb@18
   190
        pEp_rating_undefined = 0,
vb@20
   191
        pEp_rating_cannot_decrypt,
vb@20
   192
        pEp_rating_have_no_key,
vb@18
   193
        pEp_rating_unencrypted,
vb@62
   194
        pEp_rating_unencrypted_for_some,
vb@18
   195
        pEp_rating_unreliable,
vb@18
   196
        pEp_rating_reliable,
vb@18
   197
        pEp_rating_yellow = pEp_rating_reliable,
vb@18
   198
        pEp_rating_trusted,
vb@18
   199
        pEp_rating_green = pEp_rating_trusted,
vb@18
   200
        pEp_rating_trusted_and_anonymized,
vb@18
   201
        pEp_rating_fully_anonymous,
vb@12
   202
vb@56
   203
        pEp_rating_mistrust = -1,
vb@56
   204
        pEp_rating_red = pEp_rating_mistrust,
vb@56
   205
        pEp_rating_b0rken = -2,
vb@56
   206
        pEp_rating_under_attack = -3
vb@15
   207
    } pEp_color;
vb@13
   208
vb@33
   209
    typedef enum _pEp_text_format {
vb@33
   210
        pEp_text_format_plain = 0,
vb@33
   211
        pEp_text_format_html,
vb@33
   212
        pEp_text_format_other = 0xff
vb@33
   213
    } pEp_text_format;
vb@33
   214
vb@41
   215
    typedef  enum _pEp_msg_direction {
vb@33
   216
        pEp_dir_incoming = 0,
vb@33
   217
        pEp_dir_outgoing
vb@33
   218
    } pEp_msg_direction;
vb@33
   219
vb@41
   220
    typedef  enum _pEp_enc_format {
vb@33
   221
        pEp_enc_none = 0,                       // message is not encrypted
vb@33
   222
        pEp_enc_pieces,                         // inline PGP + PGP extensions
vb@33
   223
        pEp_enc_S_MIME,                         // RFC5751
vb@33
   224
        pEp_enc_PGP_MIME,                       // RFC3156
vb@33
   225
        pEp_enc_pEp                             // pEp encryption format
vb@33
   226
    } pEp_enc_format;
vb@33
   227
vb@33
   228
    [uuid(3A8A4F13-3402-4C4C-94AB-598D87869380)] struct opt_field {
vb@33
   229
        BSTR name;
vb@33
   230
        BSTR value;
vb@33
   231
    };
vb@33
   232
vb@33
   233
    [uuid(61DA7AD4-192E-4616-8678-B19AEFB45B45)] struct blob {
vb@33
   234
        SAFEARRAY(BYTE) value;
vb@33
   235
        BSTR mime_type;
vb@33
   236
        BSTR filename;
vb@33
   237
    };
vb@33
   238
vb@33
   239
    [uuid(D763A8F3-BA23-4229-A037-1BB7BDC3E0C8)] struct text_message {
vb@33
   240
        pEp_msg_direction dir;
vb@33
   241
        BSTR id;
vb@33
   242
        BSTR shortmsg;
vb@33
   243
        BSTR longmsg;
vb@33
   244
        BSTR longmsg_formatted;
vb@33
   245
        SAFEARRAY(struct blob) attachments;
vb@33
   246
        hyper sent;
vb@33
   247
        hyper recv;
vb@33
   248
        struct pEp_identity_s from;
vb@33
   249
        SAFEARRAY(struct pEp_identity_s) to;
vb@33
   250
        struct pEp_identity_s recv_by;
vb@33
   251
        SAFEARRAY(struct pEp_identity_s) cc;
vb@33
   252
        SAFEARRAY(struct pEp_identity_s) bcc;
vb@33
   253
        SAFEARRAY(struct pEp_identity_s) reply_to;
vb@33
   254
        SAFEARRAY(BSTR) references;
vb@33
   255
        SAFEARRAY(BSTR) keywords;
vb@33
   256
        BSTR comments;
vb@33
   257
        SAFEARRAY(struct opt_field) opt_fields;
vb@33
   258
    };
vb@33
   259
vb@37
   260
    HRESULT encrypt_message([in] struct text_message *src, [out] struct text_message * dst, [in] SAFEARRAY(BSTR) extra);
vb@37
   261
    HRESULT decrypt_message([in] struct text_message *src, [out] struct text_message * dst, [out] SAFEARRAY(BSTR) *keylist, [out, retval] pEp_color *rating);
vb@33
   262
    HRESULT outgoing_message_color([in] struct text_message *msg, [out, retval] pEp_color * pVal);
vb@18
   263
    HRESULT identity_color([in] struct pEp_identity_s * ident, [out, retval] pEp_color * pVal);
vb@8
   264
};
vb@4
   265
vb@8
   266
[
vb@0
   267
    uuid(3EC2E1A4-40E8-48E4-A7B0-1876D34F9462),
vb@0
   268
    version(1.0),
vb@0
   269
]
vb@0
   270
library pEpCOMServerAdapterLib
vb@0
   271
{
vb@0
   272
    importlib("stdole2.tlb");
vb@0
   273
    [
vb@0
   274
        uuid(B6BC9B8E-D9E2-4419-A3A4-7B4B58175549)
vb@0
   275
    ]
vb@0
   276
    dispinterface _IpEpEngineEvents
vb@0
   277
    {
vb@0
   278
    properties:
vb@0
   279
    methods:
vb@0
   280
    };
vb@0
   281
    [
vb@0
   282
        uuid(EF1B073D-5058-4E0E-829E-B4D22CA21EA2)
vb@0
   283
    ]
vb@0
   284
    coclass pEpEngine {
vb@0
   285
        [default] interface IpEpEngine;
vb@0
   286
        [default, source] dispinterface _IpEpEngineEvents;
vb@0
   287
    };
vb@0
   288
};