We have reached a state where we are able to import certs and
[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 "util.h"
26
27 /* Error numbers */
28 enum {
29   GPGSM_EOF = -1,
30   GPGSM_No_Error = 0,
31   GPGSM_General_Error = 1, 
32   GPGSM_Out_Of_Core = 2,
33   GPGSM_Invalid_Value = 3,
34   GPGSM_IO_Error = 4,
35   GPGSM_Resource_Limit = 5,
36   GPGSM_Internal_Error = 6,
37   GPGSM_Bad_Certificate = 7,
38   GPGSM_Bad_Certificate_Path = 8,
39   GPGSM_Missing_Certificate = 9,
40
41 };
42
43 #define MAX_DIGEST_LEN 24 
44
45 /* A large struct name "opt" to keep global flags */
46 struct {
47   unsigned int debug; /* debug flags (DBG_foo_VALUE) */
48   int verbose;      /* verbosity level */
49   int quiet;        /* be as quiet as possible */
50   int batch;        /* run in batch mode, i.e w/o any user interaction */
51   int answer_yes;   /* assume yes on most questions */
52   int answer_no;    /* assume no on most questions */
53   int dry_run;      /* don't change any persistent data */
54
55   const char *homedir; /* configuration directory name */
56   char *outfile;    /* name of output file */
57
58   int with_colons;  /* use column delimited output format */
59   int with_key_data;/* include raw key in the column delimted output */
60
61   int fingerprint;  /* list fingerprints in all key listings */
62
63   int armor;        /* force base64 armoring */
64   int no_armor;     /* don't try to figure out whether data is base64 armored*/
65
66   int def_cipher_algo;    /* cipher algorithm to use if nothing else is know */
67   int def_digest_algo;    /* Ditto for hash algorithm */
68   int def_compress_algo;  /* Ditto for compress algorithm */
69
70   char *def_recipient;    /* userID of the default recipient */
71   int def_recipient_self; /* The default recipient is the default key */
72
73   int always_trust;       /* Trust the given keys even if there is no
74                              valid certification path */
75   int skip_verify;        /* do not check signatures on data */
76
77   int lock_once;          /* Keep lock once they are set */
78
79   int ignore_time_conflict; /* Ignore certain time conflicts */
80
81 } opt;
82
83
84 #define DBG_X509_VALUE    1     /* debug x.509 data reading/writing */
85 #define DBG_MPI_VALUE     2     /* debug mpi details */
86 #define DBG_CRYPTO_VALUE  4     /* debug low level crypto */
87 #define DBG_MEMORY_VALUE  32    /* debug memory allocation stuff */
88 #define DBG_CACHE_VALUE   64    /* debug the caching */
89 #define DBG_MEMSTAT_VALUE 128   /* show memory statistics */
90 #define DBG_HASHING_VALUE 512   /* debug hashing operations */
91
92 #define DBG_X509    (opt.debug & DBG_X509_VALUE)
93 #define DBG_CRYPTO  (opt.debug & DBG_CRYPTO_VALUE)
94 #define DBG_MEMORY  (opt.debug & DBG_MEMORY_VALUE)
95 #define DBG_CACHE   (opt.debug & DBG_CACHE_VALUE)
96 #define DBG_HASHING (opt.debug & DBG_HASHING_VALUE)
97
98 /*-- gpgsm.c --*/
99 void gpgsm_exit (int rc);
100
101 /*-- server.c --*/
102 void gpgsm_server (void);
103
104 /*-- fingerprint --*/
105 char *gpgsm_get_fingerprint (KsbaCert cert, int algo, char *array, int *r_len);
106 char *gpgsm_get_fingerprint_string (KsbaCert cert, int algo);
107
108 /*-- certdump.c --*/
109 void gpgsm_dump_cert (KsbaCert cert);
110
111 /*-- certcheck.c --*/
112 int gpgsm_check_cert_sig (KsbaCert issuer_cert, KsbaCert cert);
113
114
115 /*-- certpath.c --*/
116 int gpgsm_validate_path (KsbaCert cert);
117
118
119
120
121 /*-- import.c --*/
122 int gpgsm_import (int in_fd);
123
124
125
126
127 /*-- errors.c (built) --*/
128 const char *gpgsm_strerror (int err);
129
130
131 #endif /*GPGSM_H*/