Various changes
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #ifndef SCDAEMON_H
23 #define SCDAEMON_H
24
25 #ifdef GPG_ERR_SOURCE_DEFAULT
26 #error GPG_ERR_SOURCE_DEFAULT already defined
27 #endif
28 #define GPG_ERR_SOURCE_DEFAULT  GPG_ERR_SOURCE_SCD
29 #include <gpg-error.h>
30
31 #include <time.h>
32 #include <gcrypt.h>
33 #include "../common/util.h"
34 #include "../common/errors.h"
35
36
37 #define MAX_DIGEST_LEN 24 
38
39 /* A large struct name "opt" to keep global flags. */
40 struct
41 {
42   unsigned int debug; /* Debug flags (DBG_foo_VALUE). */
43   int verbose;        /* Verbosity level. */
44   int quiet;          /* Be as quiet as possible. */
45   int dry_run;        /* Don't change any persistent data. */
46   int batch;          /* Batch mode. */
47   const char *homedir;      /* Configuration directory name. */
48   const char *ctapi_driver; /* Library to access the ctAPI. */
49   const char *pcsc_driver;  /* Library to access the PC/SC system. */
50   const char *reader_port;  /* NULL or reder port to use. */
51   int disable_ccid;    /* Disable the use of the internal CCID driver. */
52   int disable_keypad;  /* Do not use a keypad. */
53   int allow_admin;     /* Allow the use of admin commands for certain
54                           cards. */
55   strlist_t disabled_applications;  /* Card applications we do not
56                                        want to use. */
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 app_ctx_s;
80
81 struct server_control_s 
82 {
83   /* Local data of the server; used only in command.c. */
84   struct server_local_s *server_local;
85
86   /* Slot of the open reader or -1 if not open. */
87   int reader_slot; 
88
89   /* The application context used with this connection or NULL if none
90      associated.  Note that this is shared with the other connections:
91      All connections accessing the same reader are using the same
92      application context. */
93   struct app_ctx_s *app_ctx;
94
95   /* Helper to store the value we are going to sign */
96   struct 
97   {
98     unsigned char *value;  
99     int valuelen;
100   } in_data;  
101 };
102
103 typedef struct server_control_s *ctrl_t;
104 typedef struct app_ctx_s *app_t;
105
106 /*-- scdaemon.c --*/
107 void scd_exit (int rc);
108 void scd_init_default_ctrl (ctrl_t ctrl);
109 const char *scd_get_socket_name (void);
110
111 /*-- command.c --*/
112 void scd_command_handler (int);
113 void send_status_info (ctrl_t ctrl, const char *keyword, ...)
114      GNUPG_GCC_A_SENTINEL(1);
115 void scd_update_reader_status_file (void);
116
117
118 #endif /*SCDAEMON_H*/