Cleanups, fixes and PC/SC support
[gnupg.git] / scd / scdaemon.h
1 /* scdaemon.h - Global definitions for the SCdaemon
2  *      Copyright (C) 2001, 2002, 2003 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it 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  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #ifndef SCDAEMON_H
22 #define SCDAEMON_H
23
24 #ifdef GPG_ERR_SOURCE_DEFAULT
25 #error GPG_ERR_SOURCE_DEFAULT already defined
26 #endif
27 #define GPG_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_SCD
28 #include <gpg-error.h>
29 #include <errno.h>
30
31 #include <time.h>
32 #include <gcrypt.h>
33 #include "../common/util.h"
34 #include "../common/errors.h"
35
36 /* Convenience funcion to be used instead of returning the old
37    GNUPG_Out_Of_Core. */
38 static __inline__ gpg_error_t
39 out_of_core (void)
40 {
41   return gpg_error (gpg_err_code_from_errno (errno));
42 }
43
44
45 #define MAX_DIGEST_LEN 24 
46
47 /* A large struct name "opt" to keep global flags */
48 struct {
49   unsigned int debug; /* debug flags (DBG_foo_VALUE) */
50   int debug_sc;     /* OpenSC debug level */
51   int verbose;      /* verbosity level */
52   int quiet;        /* be as quiet as possible */
53   int dry_run;      /* don't change any persistent data */
54   int batch;        /* batch mode */
55   const char *homedir; /* configuration directory name */
56   const char *ctapi_driver; /* Library to access the ctAPI. */
57 } opt;
58
59
60 #define DBG_COMMAND_VALUE 1     /* debug commands i/o */
61 #define DBG_MPI_VALUE     2     /* debug mpi details */
62 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
63 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
64 #define DBG_CACHE_VALUE   64    /* debug the caching */
65 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
66 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
67 #define DBG_ASSUAN_VALUE 1024   
68 #define DBG_CARD_IO_VALUE 2048
69
70 #define DBG_COMMAND (opt.debug & DBG_COMMAND_VALUE)
71 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
72 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
73 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
74 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
75 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
76 #define DBG_CARD_IO (opt.debug & DBG_CARD_IO_VALUE)
77
78 struct server_local_s;
79 struct card_ctx_s;
80 struct app_ctx_s;
81
82 struct server_control_s {
83   struct server_local_s *server_local;
84   struct card_ctx_s *card_ctx;
85   struct app_ctx_s *app_ctx;
86   struct {
87     unsigned char *value;  
88     int valuelen;
89   } in_data;  /* helper to store the value we are going to sign */
90
91 };
92
93 typedef struct server_control_s *CTRL;
94 typedef struct card_ctx_s *CARD;
95 typedef struct app_ctx_s *APP;
96
97 /*-- scdaemon.c --*/
98 void scd_exit (int rc);
99 void scd_init_default_ctrl (CTRL ctrl);
100
101 /*-- command.c --*/
102 void scd_command_handler (int);
103 void send_status_info (CTRL ctrl, const char *keyword, ...);
104
105 /*-- card.c --*/
106 int card_open (CARD *rcard);
107 void card_close (CARD card);
108 int card_get_serial_and_stamp (CARD card, char **serial, time_t *stamp);
109 int card_enum_keypairs (CARD card, int idx,
110                         unsigned char *keygrip,
111                         char **keyid);
112 int card_enum_certs (CARD card, int idx, char **certid, int *certtype);
113 int card_read_cert (CARD card, const char *certidstr,
114                     unsigned char **cert, size_t *ncert);
115 int card_sign (CARD card,
116                const char *keyidstr, int hashalgo,
117                int (pincb)(void*, const char *, char **),
118                void *pincb_arg,
119                const void *indata, size_t indatalen,
120                unsigned char **outdata, size_t *outdatalen );
121 int card_decipher (CARD card, const char *keyidstr,
122                    int (pincb)(void*, const char *, char **),
123                    void *pincb_arg,
124                    const void *indata, size_t indatalen,
125                    unsigned char **outdata, size_t *outdatalen);
126
127
128 #endif /*SCDAEMON_H*/