c97297d7b6dabfda735647a21871deeac17ea926
[gpgme.git] / gpgme / engine-backend.h
1 /* engine-backend.h -  A crypto backend for the engine interface.
2    Copyright (C) 2002, 2003 g10 Code GmbH
3  
4    This file is part of GPGME.
5  
6    GPGME is free software; you can redistribute it and/or modify it
7    under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10  
11    GPGME is distributed in the hope that it will be useful, but
12    WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    General Public License for more details.
15  
16    You should have received a copy of the GNU General Public License
17    along with GPGME; if not, write to the Free Software Foundation,
18    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
19
20 #ifndef ENGINE_BACKEND_H
21 #define ENGINE_BACKEND_H
22
23 #include "types.h"
24
25
26 /* FIXME: Correct check?  */
27 #ifdef GPGSM_PATH
28 #define ENABLE_GPGSM 1
29 #endif
30
31
32 struct engine_ops
33 {
34   /* Static functions.  */
35   const char *(*get_file_name) (void);
36   const char *(*get_version) (void);
37   const char *(*get_req_version) (void);
38   GpgmeError (*new) (void **r_engine);
39
40   /* Member functions.  */
41   void (*release) (void *engine);
42   void (*set_status_handler) (void *engine, GpgmeStatusHandler fnc,
43                               void *fnc_value);
44   GpgmeError (*set_command_handler) (void *engine, GpgmeCommandHandler fnc,
45                                      void *fnc_value, GpgmeData data);
46   GpgmeError (*set_colon_line_handler) (void *engine,
47                                         GpgmeColonLineHandler fnc,
48                                         void *fnc_value);
49   GpgmeError (*set_verbosity) (void *engine, int verbosity);
50   GpgmeError (*decrypt) (void *engine, GpgmeData ciph, GpgmeData plain);
51   GpgmeError (*delete) (void *engine, GpgmeKey key, int allow_secret);
52   GpgmeError (*edit) (void *engine, GpgmeKey key, GpgmeData out,
53                          GpgmeCtx ctx /* FIXME */);
54   GpgmeError (*encrypt) (void *engine, GpgmeRecipients recp,
55                             GpgmeData plain, GpgmeData ciph, int use_armor);
56   GpgmeError (*encrypt_sign) (void *engine, GpgmeRecipients recp,
57                                   GpgmeData plain, GpgmeData ciph,
58                                   int use_armor, GpgmeCtx ctx /* FIXME */);
59   GpgmeError (*export) (void *engine, GpgmeRecipients recp,
60                            GpgmeData keydata, int use_armor);
61   GpgmeError (*genkey) (void *engine, GpgmeData help_data, int use_armor,
62                            GpgmeData pubkey, GpgmeData seckey);
63   GpgmeError (*import) (void *engine, GpgmeData keydata);
64   GpgmeError (*keylist) (void *engine, const char *pattern,
65                             int secret_only, int keylist_mode);
66   GpgmeError (*keylist_ext) (void *engine, const char *pattern[],
67                                  int secret_only, int reserved,
68                                 int keylist_mode);
69   GpgmeError (*sign) (void *engine, GpgmeData in, GpgmeData out,
70                          GpgmeSigMode mode, int use_armor, int use_textmode,
71                          int include_certs, GpgmeCtx ctx /* FIXME */);
72   GpgmeError (*trustlist) (void *engine, const char *pattern);
73   GpgmeError (*verify) (void *engine, GpgmeData sig, GpgmeData signed_text,
74                            GpgmeData plaintext);
75   
76   void (*set_io_cbs) (void *engine, struct GpgmeIOCbs *io_cbs);
77   void (*io_event) (void *engine, GpgmeEventIO type, void *type_data);
78 };
79
80
81 extern struct engine_ops _gpgme_engine_ops_gpg;         /* OpenPGP.  */
82 #ifdef ENABLE_GPGSM
83 extern struct engine_ops _gpgme_engine_ops_gpgsm;       /* CMS.  */
84 #endif
85
86 #endif /* ENGINE_BACKEND_H */
87