core: Enable extraction of session keys.
[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                         const char *version);
49
50   /* Member functions.  */
51   void (*release) (void *engine);
52   gpgme_error_t (*reset) (void *engine);
53   void (*set_status_cb) (void *engine, gpgme_status_cb_t cb, void *cb_value);
54   void (*set_status_handler) (void *engine, engine_status_handler_t fnc,
55                               void *fnc_value);
56   gpgme_error_t (*set_command_handler) (void *engine,
57                                         engine_command_handler_t fnc,
58                                         void *fnc_value, gpgme_data_t data);
59   gpgme_error_t (*set_colon_line_handler) (void *engine,
60                                            engine_colon_line_handler_t fnc,
61                                            void *fnc_value);
62   gpgme_error_t (*set_locale) (void *engine, int category, const char *value);
63   gpgme_error_t (*set_protocol) (void *engine, gpgme_protocol_t protocol);
64   gpgme_error_t (*decrypt) (void *engine, gpgme_data_t ciph,
65                             gpgme_data_t plain, int export_session_key);
66   gpgme_error_t (*decrypt_verify) (void *engine, gpgme_data_t ciph,
67                                    gpgme_data_t plain, int export_session_key);
68   gpgme_error_t (*delete) (void *engine, gpgme_key_t key, int allow_secret);
69   gpgme_error_t (*edit) (void *engine, int type, gpgme_key_t key,
70                          gpgme_data_t out, gpgme_ctx_t ctx /* FIXME */);
71   gpgme_error_t (*encrypt) (void *engine, gpgme_key_t recp[],
72                             gpgme_encrypt_flags_t flags,
73                             gpgme_data_t plain, gpgme_data_t ciph,
74                             int use_armor);
75   gpgme_error_t (*encrypt_sign) (void *engine, gpgme_key_t recp[],
76                                  gpgme_encrypt_flags_t flags,
77                                  gpgme_data_t plain, gpgme_data_t ciph,
78                                  int use_armor, gpgme_ctx_t ctx /* FIXME */);
79   gpgme_error_t (*export) (void *engine, const char *pattern,
80                            gpgme_export_mode_t mode, gpgme_data_t keydata,
81                            int use_armor);
82   gpgme_error_t (*export_ext) (void *engine, const char *pattern[],
83                                gpgme_export_mode_t mode, gpgme_data_t keydata,
84                                int use_armor);
85   gpgme_error_t (*genkey) (void *engine,
86                            const char *userid, const char *algo,
87                            unsigned long reserved, unsigned long expires,
88                            gpgme_key_t key, unsigned int flags,
89                            gpgme_data_t help_data,
90                            unsigned int extraflags,
91                            gpgme_data_t pubkey, gpgme_data_t seckey);
92   gpgme_error_t (*import) (void *engine, gpgme_data_t keydata,
93                            gpgme_key_t *keyarray);
94   gpgme_error_t (*keylist) (void *engine, const char *pattern,
95                             int secret_only, gpgme_keylist_mode_t mode,
96                             int engine_flags);
97   gpgme_error_t (*keylist_ext) (void *engine, const char *pattern[],
98                                 int secret_only, int reserved,
99                                 gpgme_keylist_mode_t mode,
100                                 int engine_flags);
101   gpgme_error_t (*keysign) (void *engine,
102                             gpgme_key_t key, const char *userid,
103                             unsigned long expires, unsigned int flags,
104                             gpgme_ctx_t ctx);
105   gpgme_error_t (*tofu_policy) (void *engine,
106                                 gpgme_key_t key,
107                                 gpgme_tofu_policy_t policy);
108   gpgme_error_t (*sign) (void *engine, gpgme_data_t in, gpgme_data_t out,
109                          gpgme_sig_mode_t mode, int use_armor,
110                          int use_textmode, int include_certs,
111                          gpgme_ctx_t ctx /* FIXME */);
112   gpgme_error_t (*trustlist) (void *engine, const char *pattern);
113   gpgme_error_t (*verify) (void *engine, gpgme_data_t sig,
114                            gpgme_data_t signed_text, gpgme_data_t plaintext,
115                            gpgme_ctx_t ctx);
116   gpgme_error_t  (*getauditlog) (void *engine, gpgme_data_t output,
117                                  unsigned int flags);
118   gpgme_error_t  (*opassuan_transact) (void *engine,
119                                        const char *command,
120                                        gpgme_assuan_data_cb_t data_cb,
121                                        void *data_cb_value,
122                                        gpgme_assuan_inquire_cb_t inq_cb,
123                                        void *inq_cb_value,
124                                        gpgme_assuan_status_cb_t status_cb,
125                                        void *status_cb_value);
126
127   gpgme_error_t  (*conf_load) (void *engine, gpgme_conf_comp_t *conf_p);
128   gpgme_error_t  (*conf_save) (void *engine, gpgme_conf_comp_t conf);
129
130   gpgme_error_t  (*query_swdb) (void *engine,
131                                 const char *name, const char *iversion,
132                                 gpgme_query_swdb_result_t result);
133
134   void (*set_io_cbs) (void *engine, gpgme_io_cbs_t io_cbs);
135   void (*io_event) (void *engine, gpgme_event_io_t type, void *type_data);
136
137   /* Cancel the whole engine session.  */
138   gpgme_error_t (*cancel) (void *engine);
139
140   /* Cancel only the current operation, not the whole session.  */
141   gpgme_error_t (*cancel_op) (void *engine);
142
143   /* Change the passphrase for KEY. */
144   gpgme_error_t (*passwd) (void *engine, gpgme_key_t key, unsigned int flags);
145
146   /* Set the pinentry mode.  */
147   gpgme_error_t (*set_pinentry_mode) (void *engine, gpgme_pinentry_mode_t mode);
148
149   /* The spawn command.  */
150   gpgme_error_t (*opspawn) (void * engine,
151                             const char *file, const char *argv[],
152                             gpgme_data_t datain,
153                             gpgme_data_t dataout,
154                             gpgme_data_t dataerr, unsigned int flags);
155
156 };
157
158
159 extern struct engine_ops _gpgme_engine_ops_gpg;         /* OpenPGP.  */
160 extern struct engine_ops _gpgme_engine_ops_gpgsm;       /* CMS.  */
161 extern struct engine_ops _gpgme_engine_ops_gpgconf;     /* gpg-conf.  */
162 extern struct engine_ops _gpgme_engine_ops_assuan;      /* Low-level Assuan. */
163 extern struct engine_ops _gpgme_engine_ops_g13;         /* Crypto VFS. */
164 #ifdef ENABLE_UISERVER
165 extern struct engine_ops _gpgme_engine_ops_uiserver;
166 #endif
167 extern struct engine_ops _gpgme_engine_ops_spawn;       /* Spawn engine. */
168
169
170 /* Prototypes for extra functions in engine-gpgconf.c  */
171 gpgme_error_t _gpgme_conf_arg_new (gpgme_conf_arg_t *arg_p,
172                                    gpgme_conf_type_t type, const void *value);
173 void _gpgme_conf_arg_release (gpgme_conf_arg_t arg, gpgme_conf_type_t type);
174 gpgme_error_t _gpgme_conf_opt_change (gpgme_conf_opt_t opt, int reset,
175                                       gpgme_conf_arg_t arg);
176 void _gpgme_conf_release (gpgme_conf_comp_t conf);
177 gpgme_error_t _gpgme_conf_load (void *engine, gpgme_conf_comp_t *conf_p);
178
179
180
181 #endif /* ENGINE_BACKEND_H */