Introduced the keygrip
[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 GNUPG_H
22 #define GNUPG_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   char *outfile;    /* name of output file */
42
43   int with_key_data;/* include raw key in the column delimted output */
44
45   int fingerprint;  /* list fingerprints in all key listings */
46
47   int armor;        /* force base64 armoring */
48   int no_armor;     /* don't try to figure out whether data is base64 armored*/
49
50   int def_cipher_algo;    /* cipher algorithm to use if nothing else is know */
51   int def_digest_algo;    /* Ditto for hash algorithm */
52   int def_compress_algo;  /* Ditto for compress algorithm */
53
54   char *def_recipient;    /* userID of the default recipient */
55   int def_recipient_self; /* The default recipient is the default key */
56
57   int always_trust;       /* Trust the given keys even if there is no
58                              valid certification path */
59   int skip_verify;        /* do not check signatures on data */
60
61   int lock_once;          /* Keep lock once they are set */
62
63   int ignore_time_conflict; /* Ignore certain time conflicts */
64
65 } opt;
66
67
68 #define DBG_X509_VALUE    1     /* debug x.509 data reading/writing */
69 #define DBG_MPI_VALUE     2     /* debug mpi details */
70 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
71 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
72 #define DBG_CACHE_VALUE   64    /* debug the caching */
73 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
74 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
75
76 #define DBG_X509    (opt.debug & DBG_X509_VALUE)
77 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
78 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
79 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
80 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
81
82 struct server_local_s;
83
84 struct server_control_s {
85   int no_server;     /* we are not running under server control */
86   int  status_fd;    /* only for non-server mode */
87   struct server_local_s *server_local;
88   int with_colons;  /* use column delimited output format */
89 };
90 typedef struct server_control_s *CTRL;
91
92
93 /*-- gpgsm.c --*/
94 void gpgsm_exit (int rc);
95
96 /*-- server.c --*/
97 void gpgsm_server (void);
98 void gpgsm_status (CTRL ctrl, int no, const char *text);
99
100 /*-- fingerprint --*/
101 char *gpgsm_get_fingerprint (KsbaCert cert, int algo, char *array, int *r_len);
102 char *gpgsm_get_fingerprint_string (KsbaCert cert, int algo);
103 char *gpgsm_get_fingerprint_hexstring (KsbaCert cert, int algo);
104 char *gpgsm_get_keygrip (KsbaCert cert, char *array);
105 char *gpgsm_get_keygrip_hexstring (KsbaCert cert);
106
107
108 /*-- certdump.c --*/
109 void gpgsm_dump_cert (const char *text, KsbaCert cert);
110
111 /*-- certcheck.c --*/
112 int gpgsm_check_cert_sig (KsbaCert issuer_cert, KsbaCert cert);
113 int gpgsm_check_cms_signature (KsbaCert cert, const char *sigval,
114                                GCRY_MD_HD md, int hash_algo);
115 /* fixme: move create functions to another file */
116 int gpgsm_create_cms_signature (KsbaCert cert, GCRY_MD_HD md, int mdalgo,
117                                 char **r_sigval);
118
119
120 /*-- certpath.c --*/
121 int gpgsm_validate_path (KsbaCert cert);
122
123 /*-- keylist.c --*/
124 void gpgsm_list_keys (CTRL ctrl, STRLIST names, FILE *fp);
125
126
127 /*-- import.c --*/
128 int gpgsm_import (CTRL ctrl, int in_fd);
129
130 /*-- verify.c --*/
131 int gpgsm_verify (CTRL ctrl, int in_fd, int data_fd);
132
133 /*-- sign.c --*/
134 int gpgsm_sign (CTRL ctrl, int data_fd, int detached, FILE *out_fp);
135
136
137
138 /*-- errors.c (built) --*/
139 const char *gnupg_strerror (int err);
140
141
142 #endif /*GNUPG_H*/