pEpCOMServerAdapter.idl
author Volker Birk <vb@pep-project.org>
Thu, 23 Apr 2015 22:26:12 +0200
changeset 4 fdd8cf02d2cc
parent 0 0aa9866d751c
child 5 d959f594e4f7
permissions -rw-r--r--
key_compromized() added into IMessageAPI_Outlook
     1 // pEpCOMServerAdapter.idl : IDL source for pEpCOMServerAdapter
     2 //
     3 
     4 // This file will be processed by the MIDL tool to
     5 // produce the type library (pEpCOMServerAdapter.tlb) and marshalling code.
     6 
     7 import "oaidl.idl";
     8 import "ocidl.idl";
     9 
    10 [
    11     object,
    12     uuid(9A9F4422-CF0A-45D7-90CD-1D1B7B2A4540),
    13     oleautomation,
    14     nonextensible,
    15     pointer_default(unique)
    16 ]
    17 interface IpEpEngine : IUnknown {
    18     typedef enum _pEp_STATUS {
    19         pEp_STATUS_OK = 0,
    20 
    21         pEp_KEY_NOT_FOUND = 0x0201,
    22         pEp_KEY_HAS_AMBIG_NAME = 0x0202,
    23         pEp_GET_KEY_FAILED = 0x0203,
    24 
    25         pEp_UNENCRYPTED = 0x0400,
    26         pEp_VERIFIED = 0x0401,
    27         pEp_DECRYPTED = 0x0402,
    28         pEp_DECRYPTED_AND_VERIFIED = 0x0403,
    29         pEp_DECRYPT_WRONG_FORMAT = 0x0404,
    30         pEp_DECRYPT_NO_KEY = 0x0405,
    31         pEp_DECRYPT_SIGNATURE_DOES_NOT_MATCH = 0x0406,
    32         pEp_VERIFY_NO_KEY = 0x0407,
    33         pEp_VERIFIED_AND_TRUSTED = 0x0408,
    34 
    35         pEp_ILLEGAL_VALUE = -4,
    36         pEp_BUFFER_TOO_SMALL = -3,
    37         pEp_OUT_OF_MEMORY = -2,
    38         pEp_UNKNOWN_ERROR = -1
    39     } pEp_STATUS;
    40 
    41     HRESULT log([in] BSTR title, [in] BSTR entity, [in, defaultvalue("")] BSTR description, [in, defaultvalue("")] BSTR comment);
    42     HRESULT decrypt([in] BSTR ctext, [out] BSTR * ptext, [out] SAFEARRAY(BSTR) * key_list, [out, retval] pEp_STATUS * decrypt_status);
    43     HRESULT decrypt_b([in] BSTR ctext, [out] SAFEARRAY(BYTE) * ptext, [out] SAFEARRAY(BSTR) * key_list, [out, retval] pEp_STATUS * decrypt_status);
    44     HRESULT encrypt([in] SAFEARRAY(BSTR) key_list, [in] BSTR ptext, [out] BSTR * ctext, [out, retval] pEp_STATUS * status);
    45     HRESULT encrypt_b([in] SAFEARRAY(BSTR) key_list, [in] SAFEARRAY(BYTE) ptext, [out] BSTR * ctext, [out, retval] pEp_STATUS * status);
    46     HRESULT verify([in] BSTR text, [in] BSTR signature, [out] SAFEARRAY(BSTR) * key_list, [out, retval] pEp_STATUS * verify_status);
    47     HRESULT safeword([in] LONG value, [in, defaultvalue("en")] BSTR lang, [out, retval] BSTR * word);
    48     HRESULT safewords([in] BSTR fpr, [in, defaultvalue("en")] BSTR lang, [in, defaultvalue(0)] LONG max_words, [out, retval] BSTR * words);
    49 
    50     typedef enum _pEp_comm_type {
    51         pEp_ct_unknown = 0,
    52 
    53         // range 0x01 to 0x09: no encryption, 0x0a to 0x0e: nothing reasonable
    54 
    55         pEp_ct_no_encryption = 0x01,                // generic
    56         pEp_ct_no_encrypted_channel = 0x02,
    57         pEp_ct_key_not_found = 0x03,
    58         pEp_ct_key_expired = 0x04,
    59         pEp_ct_key_revoked = 0x05,
    60         pEp_ct_key_b0rken = 0x06,
    61         pEp_ct_my_key_not_included = 0x09,
    62 
    63         pEp_ct_security_by_obscurity = 0x0a,
    64         pEp_ct_b0rken_crypto = 0x0b,
    65         pEp_ct_key_too_short = 0x0e,
    66 
    67         pEp_ct_compromized = 0x0f,                  // known compromized connection
    68 
    69         // range 0x10 to 0x3f: unconfirmed encryption
    70 
    71         pEp_ct_unconfirmed_encryption = 0x10,       // generic
    72         pEp_ct_OpenPGP_1024_RSA_unconfirmed = 0x11,	// RSA 1024 is weak
    73         pEp_ct_OpenPGP_unconfirmed = 0x3f,          // key at least 2048 bit RSA
    74         // or 1024 bit DSA
    75 
    76         // range 0x40 to 0x7f: unconfirmed encryption and anonymization
    77 
    78         pEp_ct_unconfirmed_enc_anon = 0x40,         // generic
    79         pEp_ct_pEp_unconfirmed = 0x7f,
    80 
    81         pEp_ct_confirmed = 0x80,                    // this bit decides if trust is confirmed
    82 
    83         // range 0x81 to 0x8f: reserved
    84         // range 0x90 to 0xbf: confirmed encryption
    85 
    86         pEp_ct_confirmed_encryption = 0x90,         // generic
    87         pEp_ct_OpenPGP_1024_RSA = 0x91, // RSA 1024 is weak
    88         pEp_ct_OpenPGP = 0xbf, // key at least 2048 bit RSA or 1024 bit DSA
    89 
    90         // range 0xc0 to 0xff: confirmed encryption and anonymization
    91 
    92         pEp_ct_confirmed_enc_anon = 0xc0,           // generic
    93         pEp_ct_pEp = 0xff
    94     } pEp_comm_type;
    95 
    96     struct pEp_identity_s {
    97         BSTR address;
    98         BSTR fpr;
    99         BSTR user_id;
   100         BSTR username;
   101         pEp_comm_type comm_type;
   102         BSTR lang;
   103     };
   104 
   105     HRESULT get_identity([in] BSTR address, [out, retval] struct pEp_identity_s * ident);
   106     HRESULT set_identity([in] struct pEp_identity_s * ident);
   107     HRESULT generate_keypair([in] struct pEp_identity_s * ident, [out, retval] BSTR * fpr);
   108     HRESULT delete_keypair([in] BSTR fpr);
   109     HRESULT import_key([in] BSTR key_data);
   110     HRESULT import_key_b([in] SAFEARRAY(BYTE) key_data);
   111     HRESULT export_key([in] BSTR fpr, [out, retval] BSTR * key_data);
   112     HRESULT recv_key([in] BSTR pattern);
   113     HRESULT find_keys([in] BSTR pattern, [out, retval] SAFEARRAY(BSTR) * key_list);
   114     HRESULT send_key([in] BSTR pattern);
   115 
   116     HRESULT examine_identity([in] struct pEp_identity_s * ident);
   117     HRESULT examine_myself([in] struct pEp_identity_s * myself);
   118     HRESULT myself([in] struct pEp_identity_s *ident, [out, retval] struct pEp_identity_s *result);
   119     HRESULT update_identity([in] struct pEp_identity_s *ident, [out, retval] struct pEp_identity_s *result);
   120 };
   121 
   122 [
   123     object,
   124     uuid(BC9AB54D-2CDA-47A5-AB40-64857B9E9555),
   125     oleautomation,
   126     nonextensible,
   127     pointer_default(unique)
   128 ]
   129 interface IMessageAPI_Outlook : IUnknown {
   130     typedef enum _pEp_text_format {
   131         pEp_text_format_plain = 0,
   132         pEp_text_format_html,
   133         pEp_text_format_other = 0xff
   134     } pEp_text_format;
   135 
   136     typedef enum _pEp_msg_direction {
   137         pEp_dir_incoming = 0,
   138         pEp_dir_outgoing
   139     } pEp_msg_direction;
   140 
   141     typedef enum _pEp_MIME_format {
   142         pEp_MIME_none = 0,                      // message is not MIME encoded
   143         pEp_MIME_fields_omitted,                // message content but no fields
   144         pEp_MIME                                // message is fully MIME encoded
   145     } pEp_MIME_format;
   146 
   147     typedef enum _pEp_enc_format {
   148         pEp_enc_none = 0,                       // message is not encrypted
   149         pEp_enc_pieces,                         // inline PGP + PGP extensions
   150         pEp_enc_S_MIME,                         // RFC5751
   151         pEp_enc_PGP_MIME,                       // RFC3156
   152         pEp_enc_pEp                             // pEp encryption format
   153     } pEp_enc_format;
   154 
   155     HRESULT key_compromized([in] BSTR fpr);
   156 };
   157 
   158 [
   159     uuid(3EC2E1A4-40E8-48E4-A7B0-1876D34F9462),
   160     version(1.0),
   161 ]
   162 library pEpCOMServerAdapterLib
   163 {
   164     importlib("stdole2.tlb");
   165     [
   166         uuid(B6BC9B8E-D9E2-4419-A3A4-7B4B58175549)
   167     ]
   168     dispinterface _IpEpEngineEvents
   169     {
   170     properties:
   171     methods:
   172     };
   173     [
   174         uuid(EF1B073D-5058-4E0E-829E-B4D22CA21EA2)
   175     ]
   176     coclass pEpEngine {
   177         [default] interface IpEpEngine;
   178         [default, source] dispinterface _IpEpEngineEvents;
   179         interface IMessageAPI_Outlook;
   180     };
   181 };
   182