Doc fixes, moved some fizmes to TODO, fixed minor bugs.
[gnupg.git] / scd / scdaemon.h
1 /* scdaemon.h - Global definitions for the SCdaemon
2  *      Copyright (C) 2001, 2002 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 #include <time.h>
25 #include <gcrypt.h>
26 #include "../common/util.h"
27 #include "../common/errors.h"
28
29 #define MAX_DIGEST_LEN 24 
30
31 /* A large struct name "opt" to keep global flags */
32 struct {
33   unsigned int debug; /* debug flags (DBG_foo_VALUE) */
34   int verbose;      /* verbosity level */
35   int quiet;        /* be as quiet as possible */
36   int dry_run;      /* don't change any persistent data */
37   int batch;        /* batch mode */
38   const char *homedir; /* configuration directory name */
39 } opt;
40
41
42 #define DBG_COMMAND_VALUE 1     /* debug commands i/o */
43 #define DBG_MPI_VALUE     2     /* debug mpi details */
44 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
45 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
46 #define DBG_CACHE_VALUE   64    /* debug the caching */
47 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
48 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
49 #define DBG_ASSUAN_VALUE 1024   
50
51 #define DBG_COMMAND (opt.debug & DBG_COMMAND_VALUE)
52 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
53 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
54 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
55 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
56 #define DBG_ASSUAN  (opt.debug & DBG_ASSUAN_VALUE)
57
58 struct server_local_s;
59 struct card_ctx_s;
60
61 struct server_control_s {
62   struct server_local_s *server_local;
63   struct card_ctx_s *card_ctx;
64   struct {
65     unsigned char *value;  
66     int valuelen;
67   } in_data;  /* helper to store the value we are going to sign */
68
69 };
70 typedef struct server_control_s *CTRL;
71 typedef struct card_ctx_s *CARD;
72
73 /*-- scdaemon.c --*/
74 void scd_exit (int rc);
75 void scd_init_default_ctrl (CTRL ctrl);
76
77 /*-- command.c --*/
78 void scd_command_handler (int);
79
80 /*-- card.c --*/
81 int card_open (CARD *rcard);
82 void card_close (CARD card);
83 int card_get_serial_and_stamp (CARD card, char **serial, time_t *stamp);
84 int card_enum_keypairs (CARD card, int idx,
85                         unsigned char *keygrip,
86                         char **keyid);
87 int card_read_cert (CARD card, const char *certidstr,
88                     unsigned char **cert, size_t *ncert);
89 int card_sign (CARD card,
90                const char *keyidstr, int hashalgo,
91                int (pincb)(void*, const char *, char **),
92                void *pincb_arg,
93                const void *indata, size_t indatalen,
94                void **outdata, size_t *outdatalen );
95 int card_decipher (CARD card, const char *keyidstr,
96                    int (pincb)(void*, const char *, char **),
97                    void *pincb_arg,
98                    const void *indata, size_t indatalen,
99                    void **outdata, size_t *outdatalen);
100
101
102 #endif /*SCDAEMON_H*/