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