* base64.c: New. Changed all other functions to use this instead
[gnupg.git] / sm / gpgsm.h
1 /* gpgsm.h - Global definitions for GpgSM
2  *      Copyright (C) 2001 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 GPGSM_H
22 #define GPGSM_H
23
24 #include <ksba.h>
25 #include "../common/util.h"
26 #include "../common/errors.h"
27
28 #define MAX_DIGEST_LEN 24 
29
30 /* A large struct name "opt" to keep global flags */
31 struct {
32   unsigned int debug; /* debug flags (DBG_foo_VALUE) */
33   int verbose;      /* verbosity level */
34   int quiet;        /* be as quiet as possible */
35   int batch;        /* run in batch mode, i.e w/o any user interaction */
36   int answer_yes;   /* assume yes on most questions */
37   int answer_no;    /* assume no on most questions */
38   int dry_run;      /* don't change any persistent data */
39
40   const char *homedir; /* configuration directory name */
41   const char *agent_program; 
42   char *outfile;    /* name of output file */
43
44   int with_key_data;/* include raw key in the column delimted output */
45
46   int fingerprint;  /* list fingerprints in all key listings */
47
48   int armor;        /* force base64 armoring (see also ctrl.with_base64) */
49   int no_armor;     /* don't try to figure out whether data is base64 armored*/
50
51   int def_cipher_algo;    /* cipher algorithm to use if nothing else is know */
52   int def_digest_algo;    /* Ditto for hash algorithm */
53   int def_compress_algo;  /* Ditto for compress algorithm */
54
55   char *def_recipient;    /* userID of the default recipient */
56   int def_recipient_self; /* The default recipient is the default key */
57
58   int always_trust;       /* Trust the given keys even if there is no
59                              valid certification path */
60   int skip_verify;        /* do not check signatures on data */
61
62   int lock_once;          /* Keep lock once they are set */
63
64   int ignore_time_conflict; /* Ignore certain time conflicts */
65
66 } opt;
67
68
69 #define DBG_X509_VALUE    1     /* debug x.509 data reading/writing */
70 #define DBG_MPI_VALUE     2     /* debug mpi details */
71 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
72 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
73 #define DBG_CACHE_VALUE   64    /* debug the caching */
74 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
75 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
76 #define DBG_AGENT_VALUE  1024   /* debug communication with the agent */
77
78 #define DBG_X509    (opt.debug & DBG_X509_VALUE)
79 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
80 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
81 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
82 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
83 #define DBG_AGENT   (opt.debug & DBG_AGENT_VALUE)
84
85 struct server_local_s;
86
87 struct server_control_s {
88   int no_server;     /* we are not running under server control */
89   int  status_fd;    /* only for non-server mode */
90   struct server_local_s *server_local;
91   int with_colons;  /* use column delimited output format */
92
93   int autodetect_encoding; /* try to detect the input encoding */
94   int is_pem;         /* Is in PEM format */
95   int is_base64;      /* is in plain base-64 format */
96
97   int create_base64;  /* Create base64 encoded output */
98   int create_pem;     /* create PEM output */
99  
100 };
101 typedef struct server_control_s *CTRL;
102
103 /* data structure osed in base64.c */
104 typedef struct base64_context_s *Base64Context;
105
106
107 /*-- gpgsm.c --*/
108 void gpgsm_exit (int rc);
109
110 /*-- server.c --*/
111 void gpgsm_server (void);
112 void gpgsm_status (CTRL ctrl, int no, const char *text);
113
114 /*-- fingerprint --*/
115 char *gpgsm_get_fingerprint (KsbaCert cert, int algo, char *array, int *r_len);
116 char *gpgsm_get_fingerprint_string (KsbaCert cert, int algo);
117 char *gpgsm_get_fingerprint_hexstring (KsbaCert cert, int algo);
118 char *gpgsm_get_keygrip (KsbaCert cert, char *array);
119 char *gpgsm_get_keygrip_hexstring (KsbaCert cert);
120
121 /*-- base64.c --*/
122 int  gpgsm_create_reader (Base64Context *ctx,
123                           CTRL ctrl, FILE *fp, KsbaReader *r_reader);
124 void gpgsm_destroy_reader (Base64Context ctx);
125 int  gpgsm_create_writer (Base64Context *ctx,
126                           CTRL ctrl, FILE *fp, KsbaWriter *r_writer);
127 void gpgsm_destroy_writer (Base64Context ctx);
128
129
130 /*-- certdump.c --*/
131 void gpgsm_dump_cert (const char *text, KsbaCert cert);
132
133 /*-- certcheck.c --*/
134 int gpgsm_check_cert_sig (KsbaCert issuer_cert, KsbaCert cert);
135 int gpgsm_check_cms_signature (KsbaCert cert, const char *sigval,
136                                GCRY_MD_HD md, int hash_algo);
137 /* fixme: move create functions to another file */
138 int gpgsm_create_cms_signature (KsbaCert cert, GCRY_MD_HD md, int mdalgo,
139                                 char **r_sigval);
140
141
142 /*-- certpath.c --*/
143 int gpgsm_validate_path (KsbaCert cert);
144
145 /*-- keylist.c --*/
146 void gpgsm_list_keys (CTRL ctrl, STRLIST names, FILE *fp);
147
148
149 /*-- import.c --*/
150 int gpgsm_import (CTRL ctrl, int in_fd);
151
152 /*-- verify.c --*/
153 int gpgsm_verify (CTRL ctrl, int in_fd, int data_fd);
154
155 /*-- sign.c --*/
156 int gpgsm_sign (CTRL ctrl, int data_fd, int detached, FILE *out_fp);
157
158
159 /*-- call-agent.c --*/
160 int gpgsm_agent_pksign (const char *keygrip,
161                         unsigned char *digest,
162                         size_t digestlen,
163                         int digestalgo,
164                         char **r_buf, size_t *r_buflen);
165
166 #endif /*GPGSM_H*/