doc/
[gpgme.git] / gpgme / engine-backend.h
1 /* engine-backend.h -  A crypto backend for the engine interface.
2    Copyright (C) 2002, 2003 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 General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (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    General Public License for more details.
15  
16    You should have received a copy of the GNU General Public License
17    along with GPGME; if not, write to the Free Software Foundation,
18    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
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   const char *(*get_file_name) (void);
34   const char *(*get_version) (void);
35   const char *(*get_req_version) (void);
36   gpgme_error_t (*new) (void **r_engine);
37
38   /* Member functions.  */
39   void (*release) (void *engine);
40   void (*set_status_handler) (void *engine, engine_status_handler_t fnc,
41                               void *fnc_value);
42   gpgme_error_t (*set_command_handler) (void *engine,
43                                         engine_command_handler_t fnc,
44                                         void *fnc_value, gpgme_data_t data);
45   gpgme_error_t (*set_colon_line_handler) (void *engine,
46                                            engine_colon_line_handler_t fnc,
47                                            void *fnc_value);
48   gpgme_error_t (*decrypt) (void *engine, gpgme_data_t ciph,
49                             gpgme_data_t plain);
50   gpgme_error_t (*delete) (void *engine, gpgme_key_t key, int allow_secret);
51   gpgme_error_t (*edit) (void *engine, gpgme_key_t key, gpgme_data_t out,
52                          gpgme_ctx_t ctx /* FIXME */);
53   gpgme_error_t (*encrypt) (void *engine, gpgme_key_t recp[],
54                             gpgme_encrypt_flags_t flags,
55                             gpgme_data_t plain, gpgme_data_t ciph,
56                             int use_armor);
57   gpgme_error_t (*encrypt_sign) (void *engine, gpgme_key_t recp[],
58                                  gpgme_encrypt_flags_t flags,
59                                  gpgme_data_t plain, gpgme_data_t ciph,
60                                  int use_armor, gpgme_ctx_t ctx /* FIXME */);
61   gpgme_error_t (*export) (void *engine, const char *pattern,
62                            unsigned int reserved, gpgme_data_t keydata,
63                            int use_armor);
64   gpgme_error_t (*export_ext) (void *engine, const char *pattern[],
65                                unsigned int reserved, gpgme_data_t keydata,
66                                int use_armor);
67   gpgme_error_t (*genkey) (void *engine, gpgme_data_t help_data, int use_armor,
68                            gpgme_data_t pubkey, gpgme_data_t seckey);
69   gpgme_error_t (*import) (void *engine, gpgme_data_t keydata);
70   gpgme_error_t (*keylist) (void *engine, const char *pattern,
71                             int secret_only, gpgme_keylist_mode_t mode);
72   gpgme_error_t (*keylist_ext) (void *engine, const char *pattern[],
73                                 int secret_only, int reserved,
74                                 gpgme_keylist_mode_t mode);
75   gpgme_error_t (*sign) (void *engine, gpgme_data_t in, gpgme_data_t out,
76                          gpgme_sig_mode_t mode, int use_armor,
77                          int use_textmode,
78                          int include_certs, gpgme_ctx_t ctx /* FIXME */);
79   gpgme_error_t (*trustlist) (void *engine, const char *pattern);
80   gpgme_error_t (*verify) (void *engine, gpgme_data_t sig,
81                            gpgme_data_t signed_text,
82                            gpgme_data_t plaintext);
83   
84   void (*set_io_cbs) (void *engine, gpgme_io_cbs_t io_cbs);
85   void (*io_event) (void *engine, gpgme_event_io_t type, void *type_data);
86 };
87
88
89 extern struct engine_ops _gpgme_engine_ops_gpg;         /* OpenPGP.  */
90 #ifdef ENABLE_GPGSM
91 extern struct engine_ops _gpgme_engine_ops_gpgsm;       /* CMS.  */
92 #endif
93
94 #endif /* ENGINE_BACKEND_H */