2e2ef5ecb8016c87b701aa39d42ca5e62d0f85ef
[gpgme.git] / src / engine-backend.h
1 /* engine-backend.h - A crypto backend for the engine interface.
2    Copyright (C) 2002, 2003, 2004 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, write to the Free Software
18    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
19    02111-1307, USA.  */
20
21 #ifndef ENGINE_BACKEND_H
22 #define ENGINE_BACKEND_H
23
24 #include "engine.h"
25
26 /* FIXME: Correct check?  */
27 #ifdef GPGSM_PATH
28 #define ENABLE_GPGSM 1
29 #endif
30
31 struct engine_ops
32 {
33   /* Static functions.  */
34
35   /* Return the default file name for the binary of this engine.  */
36   const char *(*get_file_name) (void);
37
38   /* Returns a malloced string containing the version of the engine
39      with the given binary file name (or the default if FILE_NAME is
40      NULL.  */
41   char *(*get_version) (const char *file_name);
42
43   /* Returns a statically allocated string containing the required
44      version.  */
45   const char *(*get_req_version) (void);
46
47   gpgme_error_t (*new) (void **r_engine,
48                         const char *file_name, const char *home_dir);
49
50   /* Member functions.  */
51   void (*release) (void *engine);
52   gpgme_error_t (*reset) (void *engine);
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 (*decrypt) (void *engine, gpgme_data_t ciph,
63                             gpgme_data_t plain);
64   gpgme_error_t (*delete) (void *engine, gpgme_key_t key, int allow_secret);
65   gpgme_error_t (*edit) (void *engine, int type, gpgme_key_t key,
66                          gpgme_data_t out, gpgme_ctx_t ctx /* FIXME */);
67   gpgme_error_t (*encrypt) (void *engine, gpgme_key_t recp[],
68                             gpgme_encrypt_flags_t flags,
69                             gpgme_data_t plain, gpgme_data_t ciph,
70                             int use_armor);
71   gpgme_error_t (*encrypt_sign) (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, gpgme_ctx_t ctx /* FIXME */);
75   gpgme_error_t (*export) (void *engine, const char *pattern,
76                            unsigned int reserved, gpgme_data_t keydata,
77                            int use_armor);
78   gpgme_error_t (*export_ext) (void *engine, const char *pattern[],
79                                unsigned int reserved, gpgme_data_t keydata,
80                                int use_armor);
81   gpgme_error_t (*genkey) (void *engine, gpgme_data_t help_data, int use_armor,
82                            gpgme_data_t pubkey, gpgme_data_t seckey);
83   gpgme_error_t (*import) (void *engine, gpgme_data_t keydata);
84   gpgme_error_t (*keylist) (void *engine, const char *pattern,
85                             int secret_only, gpgme_keylist_mode_t mode);
86   gpgme_error_t (*keylist_ext) (void *engine, const char *pattern[],
87                                 int secret_only, int reserved,
88                                 gpgme_keylist_mode_t mode);
89   gpgme_error_t (*sign) (void *engine, gpgme_data_t in, gpgme_data_t out,
90                          gpgme_sig_mode_t mode, int use_armor,
91                          int use_textmode,
92                          int include_certs, gpgme_ctx_t ctx /* FIXME */);
93   gpgme_error_t (*trustlist) (void *engine, const char *pattern);
94   gpgme_error_t (*verify) (void *engine, gpgme_data_t sig,
95                            gpgme_data_t signed_text,
96                            gpgme_data_t plaintext);
97   gpgme_error_t  (*getauditlog) (void *engine, gpgme_data_t output,
98                                  unsigned int flags);
99
100   gpgme_error_t  (*conf_load) (void *engine, gpgme_conf_comp_t *conf_p);
101   gpgme_error_t  (*conf_save) (void *engine, gpgme_conf_comp_t conf);
102
103   void (*set_io_cbs) (void *engine, gpgme_io_cbs_t io_cbs);
104   void (*io_event) (void *engine, gpgme_event_io_t type, void *type_data);
105
106   gpgme_error_t (*cancel) (void *engine);
107 };
108
109
110 extern struct engine_ops _gpgme_engine_ops_gpg;         /* OpenPGP.  */
111 #ifdef ENABLE_GPGSM
112 extern struct engine_ops _gpgme_engine_ops_gpgsm;       /* CMS.  */
113 #endif
114 #ifdef ENABLE_GPGCONF
115 extern struct engine_ops _gpgme_engine_ops_gpgconf;     /* gpg-conf.  */
116 #endif
117
118 #endif /* ENGINE_BACKEND_H */