Qt: Add testTofuSignCount
[gpgme.git] / src / engine-backend.h
1 /* engine-backend.h - A crypto backend for the engine interface.
2    Copyright (C) 2002, 2003, 2004, 2009 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 Lesser General Public License as
8    published by the Free Software Foundation; either version 2.1 of
9    the License, or (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    Lesser General Public License for more details.
15
16    You should have received a copy of the GNU Lesser General Public
17    License along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef ENGINE_BACKEND_H
21 #define ENGINE_BACKEND_H
22
23 #include "engine.h"
24
25 struct engine_ops
26 {
27   /* Static functions.  */
28
29   /* Return the default file name for the binary of this engine.  */
30   const char *(*get_file_name) (void);
31
32   /* Return the default home dir for the binary of this engine.  If
33      this function pointer is not set, the standard default home dir
34      of the engine is used. */
35   const char *(*get_home_dir) (void);
36
37   /* Returns a malloced string containing the version of the engine
38      with the given binary file name (or the default if FILE_NAME is
39      NULL.  */
40   char *(*get_version) (const char *file_name);
41
42   /* Returns a statically allocated string containing the required
43      version.  */
44   const char *(*get_req_version) (void);
45
46   gpgme_error_t (*new) (void **r_engine,
47                         const char *file_name, const char *home_dir);
48
49   /* Member functions.  */
50   void (*release) (void *engine);
51   gpgme_error_t (*reset) (void *engine);
52   void (*set_status_cb) (void *engine, gpgme_status_cb_t cb, void *cb_value);
53   void (*set_status_handler) (void *engine, engine_status_handler_t fnc,
54                               void *fnc_value);
55   gpgme_error_t (*set_command_handler) (void *engine,
56                                         engine_command_handler_t fnc,
57                                         void *fnc_value, gpgme_data_t data);
58   gpgme_error_t (*set_colon_line_handler) (void *engine,
59                                            engine_colon_line_handler_t fnc,
60                                            void *fnc_value);
61   gpgme_error_t (*set_locale) (void *engine, int category, const char *value);
62   gpgme_error_t (*set_protocol) (void *engine, gpgme_protocol_t protocol);
63   gpgme_error_t (*decrypt) (void *engine, gpgme_data_t ciph,
64                             gpgme_data_t plain);
65   gpgme_error_t (*decrypt_verify) (void *engine, gpgme_data_t ciph,
66                                    gpgme_data_t plain);
67   gpgme_error_t (*delete) (void *engine, gpgme_key_t key, int allow_secret);
68   gpgme_error_t (*edit) (void *engine, int type, gpgme_key_t key,
69                          gpgme_data_t out, gpgme_ctx_t ctx /* FIXME */);
70   gpgme_error_t (*encrypt) (void *engine, gpgme_key_t recp[],
71                             gpgme_encrypt_flags_t flags,
72                             gpgme_data_t plain, gpgme_data_t ciph,
73                             int use_armor);
74   gpgme_error_t (*encrypt_sign) (void *engine, gpgme_key_t recp[],
75                                  gpgme_encrypt_flags_t flags,
76                                  gpgme_data_t plain, gpgme_data_t ciph,
77                                  int use_armor, gpgme_ctx_t ctx /* FIXME */);
78   gpgme_error_t (*export) (void *engine, const char *pattern,
79                            gpgme_export_mode_t mode, gpgme_data_t keydata,
80                            int use_armor);
81   gpgme_error_t (*export_ext) (void *engine, const char *pattern[],
82                                gpgme_export_mode_t mode, gpgme_data_t keydata,
83                                int use_armor);
84   gpgme_error_t (*genkey) (void *engine, gpgme_data_t help_data, int use_armor,
85                            gpgme_data_t pubkey, gpgme_data_t seckey);
86   gpgme_error_t (*import) (void *engine, gpgme_data_t keydata,
87                            gpgme_key_t *keyarray);
88   gpgme_error_t (*keylist) (void *engine, const char *pattern,
89                             int secret_only, gpgme_keylist_mode_t mode,
90                             int engine_flags);
91   gpgme_error_t (*keylist_ext) (void *engine, const char *pattern[],
92                                 int secret_only, int reserved,
93                                 gpgme_keylist_mode_t mode,
94                                 int engine_flags);
95   gpgme_error_t (*sign) (void *engine, gpgme_data_t in, gpgme_data_t out,
96                          gpgme_sig_mode_t mode, int use_armor,
97                          int use_textmode, int include_certs,
98                          gpgme_ctx_t ctx /* FIXME */);
99   gpgme_error_t (*trustlist) (void *engine, const char *pattern);
100   gpgme_error_t (*verify) (void *engine, gpgme_data_t sig,
101                            gpgme_data_t signed_text, gpgme_data_t plaintext);
102   gpgme_error_t  (*getauditlog) (void *engine, gpgme_data_t output,
103                                  unsigned int flags);
104   gpgme_error_t  (*opassuan_transact) (void *engine,
105                                        const char *command,
106                                        gpgme_assuan_data_cb_t data_cb,
107                                        void *data_cb_value,
108                                        gpgme_assuan_inquire_cb_t inq_cb,
109                                        void *inq_cb_value,
110                                        gpgme_assuan_status_cb_t status_cb,
111                                        void *status_cb_value);
112
113   gpgme_error_t  (*conf_load) (void *engine, gpgme_conf_comp_t *conf_p);
114   gpgme_error_t  (*conf_save) (void *engine, gpgme_conf_comp_t conf);
115
116   void (*set_io_cbs) (void *engine, gpgme_io_cbs_t io_cbs);
117   void (*io_event) (void *engine, gpgme_event_io_t type, void *type_data);
118
119   /* Cancel the whole engine session.  */
120   gpgme_error_t (*cancel) (void *engine);
121
122   /* Cancel only the current operation, not the whole session.  */
123   gpgme_error_t (*cancel_op) (void *engine);
124
125   /* Change the passphrase for KEY. */
126   gpgme_error_t (*passwd) (void *engine, gpgme_key_t key, unsigned int flags);
127
128   /* Set the pinentry mode.  */
129   gpgme_error_t (*set_pinentry_mode) (void *engine, gpgme_pinentry_mode_t mode);
130
131   /* The spawn command.  */
132   gpgme_error_t (*opspawn) (void * engine,
133                             const char *file, const char *argv[],
134                             gpgme_data_t datain,
135                             gpgme_data_t dataout,
136                             gpgme_data_t dataerr, unsigned int flags);
137
138 };
139
140
141 extern struct engine_ops _gpgme_engine_ops_gpg;         /* OpenPGP.  */
142 extern struct engine_ops _gpgme_engine_ops_gpgsm;       /* CMS.  */
143 extern struct engine_ops _gpgme_engine_ops_gpgconf;     /* gpg-conf.  */
144 extern struct engine_ops _gpgme_engine_ops_assuan;      /* Low-level Assuan. */
145 extern struct engine_ops _gpgme_engine_ops_g13;         /* Crypto VFS. */
146 #ifdef ENABLE_UISERVER
147 extern struct engine_ops _gpgme_engine_ops_uiserver;
148 #endif
149 extern struct engine_ops _gpgme_engine_ops_spawn;       /* Spawn engine. */
150
151
152 /* Prototypes for extra functions in engine-gpgconf.c  */
153 gpgme_error_t _gpgme_conf_arg_new (gpgme_conf_arg_t *arg_p,
154                                    gpgme_conf_type_t type, const void *value);
155 void _gpgme_conf_arg_release (gpgme_conf_arg_t arg, gpgme_conf_type_t type);
156 gpgme_error_t _gpgme_conf_opt_change (gpgme_conf_opt_t opt, int reset,
157                                       gpgme_conf_arg_t arg);
158 void _gpgme_conf_release (gpgme_conf_comp_t conf);
159 gpgme_error_t _gpgme_conf_load (void *engine, gpgme_conf_comp_t *conf_p);
160
161
162
163 #endif /* ENGINE_BACKEND_H */