First take on the low-level assuan interface.
[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 /* FIXME: Correct check?  */
26 #ifdef GPGSM_PATH
27 #define ENABLE_GPGSM 1
28 #endif
29
30 struct engine_ops
31 {
32   /* Static functions.  */
33
34   /* Return the default file name for the binary of this engine.  */
35   const char *(*get_file_name) (void);
36
37   /* Return the default home dir for the binary of this engine.  If
38      this function pointer is not set, the standard default home dir
39      of the engine is used. */
40   const char *(*get_home_dir) (void);
41
42   /* Returns a malloced string containing the version of the engine
43      with the given binary file name (or the default if FILE_NAME is
44      NULL.  */
45   char *(*get_version) (const char *file_name);
46
47   /* Returns a statically allocated string containing the required
48      version.  */
49   const char *(*get_req_version) (void);
50
51   gpgme_error_t (*new) (void **r_engine,
52                         const char *file_name, const char *home_dir);
53
54   /* Member functions.  */
55   void (*release) (void *engine);
56   gpgme_error_t (*reset) (void *engine);
57   void (*set_status_handler) (void *engine, engine_status_handler_t fnc,
58                               void *fnc_value);
59   gpgme_error_t (*set_command_handler) (void *engine,
60                                         engine_command_handler_t fnc,
61                                         void *fnc_value, gpgme_data_t data);
62   gpgme_error_t (*set_colon_line_handler) (void *engine,
63                                            engine_colon_line_handler_t fnc,
64                                            void *fnc_value);
65   gpgme_error_t (*set_locale) (void *engine, int category, const char *value);
66   gpgme_error_t (*decrypt) (void *engine, gpgme_data_t ciph,
67                             gpgme_data_t plain);
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                            unsigned int reserved, gpgme_data_t keydata,
81                            int use_armor);
82   gpgme_error_t (*export_ext) (void *engine, const char *pattern[],
83                                unsigned int reserved, gpgme_data_t keydata,
84                                int use_armor);
85   gpgme_error_t (*genkey) (void *engine, gpgme_data_t help_data, int use_armor,
86                            gpgme_data_t pubkey, gpgme_data_t seckey);
87   gpgme_error_t (*import) (void *engine, gpgme_data_t keydata);
88   gpgme_error_t (*keylist) (void *engine, const char *pattern,
89                             int secret_only, gpgme_keylist_mode_t mode);
90   gpgme_error_t (*keylist_ext) (void *engine, const char *pattern[],
91                                 int secret_only, int reserved,
92                                 gpgme_keylist_mode_t mode);
93   gpgme_error_t (*sign) (void *engine, gpgme_data_t in, gpgme_data_t out,
94                          gpgme_sig_mode_t mode, int use_armor,
95                          int use_textmode,
96                          int include_certs, gpgme_ctx_t ctx /* FIXME */);
97   gpgme_error_t (*trustlist) (void *engine, const char *pattern);
98   gpgme_error_t (*verify) (void *engine, gpgme_data_t sig,
99                            gpgme_data_t signed_text,
100                            gpgme_data_t plaintext);
101   gpgme_error_t  (*getauditlog) (void *engine, gpgme_data_t output,
102                                  unsigned int flags);
103   gpgme_error_t  (*opassuan_transact) (void *engine, 
104                                        const char *command,
105                                        engine_assuan_result_cb_t result_cb,
106                                        void *result_cb_value,
107                                        gpgme_assuan_data_cb_t data_cb,
108                                        void *data_cb_value,
109                                        gpgme_assuan_inquire_cb_t inq_cb,
110                                        void *inq_cb_value,
111                                        gpgme_assuan_status_cb_t status_cb,
112                                        void *status_cb_value);
113
114   gpgme_error_t  (*conf_load) (void *engine, gpgme_conf_comp_t *conf_p);
115   gpgme_error_t  (*conf_save) (void *engine, gpgme_conf_comp_t conf);
116
117   void (*set_io_cbs) (void *engine, gpgme_io_cbs_t io_cbs);
118   void (*io_event) (void *engine, gpgme_event_io_t type, void *type_data);
119
120   gpgme_error_t (*cancel) (void *engine);
121 };
122
123
124 extern struct engine_ops _gpgme_engine_ops_gpg;         /* OpenPGP.  */
125 #ifdef ENABLE_GPGSM
126 extern struct engine_ops _gpgme_engine_ops_gpgsm;       /* CMS.  */
127 #endif
128 #ifdef ENABLE_GPGCONF
129 extern struct engine_ops _gpgme_engine_ops_gpgconf;     /* gpg-conf.  */
130 #endif
131 #ifdef ENABLE_GPGSM  /* If this is enabled we also have assuan support.  */
132 extern struct engine_ops _gpgme_engine_ops_assuan;      /* Low-level Assuan. */
133 #endif
134
135 #endif /* ENGINE_BACKEND_H */