Add gpgtar backport
[gnupg.git] / common / audit.h
1 /* audit.h - Definitions for the audit subsystem
2  *      Copyright (C) 2007 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 3 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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef GNUPG_COMMON_AUDIT_H
21 #define GNUPG_COMMON_AUDIT_H
22
23 #include <ksba.h>
24
25 #include "estream.h"
26
27 struct audit_ctx_s;
28 typedef struct audit_ctx_s *audit_ctx_t;
29
30 /* Constants for the audit type.  */
31 typedef enum
32   {
33     AUDIT_TYPE_NONE  = 0,  /* No type set.  */
34     AUDIT_TYPE_ENCRYPT,    /* Data encryption.  */
35     AUDIT_TYPE_SIGN,       /* Signature creation.  */
36     AUDIT_TYPE_DECRYPT,    /* Data decryption.  */
37     AUDIT_TYPE_VERIFY      /* Signature verification.  */
38   }
39 audit_type_t;
40
41 /* The events we support.  */
42 typedef enum
43   {
44     AUDIT_NULL_EVENT = 0,
45     /* No such event.  Its value shall be 0 and no other values shall
46        be assigned to the other enum symbols.  This is required so
47        that the exaudit.awk script comes up with correct values
48        without running cc.  */
49
50     AUDIT_SETUP_READY,
51     /* All preparations done so that the actual processing can start
52        now.  This indicates that all parameters are okay and we can
53        start to process the actual data.  */
54
55     AUDIT_AGENT_READY,   /* err */
56     /* Indicates whether the gpg-agent is available.  For some
57        operations the agent is not required and thus no such event
58        will be logged.  */
59     
60     AUDIT_DIRMNGR_READY,   /* err */
61     /* Indicates whether the Dirmngr is available.  For some
62        operations the Dirmngr is not required and thus no such event
63        will be logged.  */
64
65     AUDIT_GPG_READY,   /* err */
66     /* Indicates whether the Gpg engine is available. */
67
68     AUDIT_GPGSM_READY, /* err */
69     /* Indicates whether the Gpgsm engine is available. */
70
71     AUDIT_GOT_DATA,
72     /* Data to be processed has been seen.  */
73
74     AUDIT_DETACHED_SIGNATURE,
75     /* The signature is a detached one. */
76
77     AUDIT_CERT_ONLY_SIG,
78     /* A certifciate only signature has been detected.  */
79
80     AUDIT_DATA_HASH_ALGO,  /* int */
81     /* The hash algo given as argument is used for the data.  This
82        event will be repeated for all hash algorithms used with the
83        data.  */
84
85     AUDIT_ATTR_HASH_ALGO,  /* int */
86     /* The hash algo given as argument is used to hash the message
87        digest and other signed attributes of this signature. */
88
89     AUDIT_DATA_CIPHER_ALGO,  /* int */
90     /* The cipher algo given as argument is used for this data.  */
91
92     AUDIT_BAD_DATA_HASH_ALGO,  /* string */
93     /* The hash algo as specified by the signature can't be used.
94        STRING is the description of this algorithm which usually is an
95        OID string.  STRING may be NULL. */
96
97     AUDIT_BAD_DATA_CIPHER_ALGO,  /* string */
98     /* The symmetric cipher algorithm is not supported.  STRING is the
99        description of this algorithm which usually is an OID string.
100        STRING may be NULL. */
101
102     AUDIT_DATA_HASHING,    /* ok_err */
103     /* Logs the result of the data hashing. */
104
105     AUDIT_READ_ERROR,     /* ok_err */
106     /* A generic read error occurred.  */
107
108     AUDIT_WRITE_ERROR,     /* ok_err */
109     /* A generic write error occurred.  */
110
111     AUDIT_USAGE_ERROR,
112     /* The program was used in an inappropriate way; For example by
113        passing a data object while the signature does not expect one
114        or vice versa.  */
115     
116     AUDIT_SAVE_CERT,       /* cert, ok_err */
117     /* Save the certificate received in a message. */
118
119     AUDIT_NEW_SIG,         /* int */
120     /* Start the verification of a new signature for the last data
121        object.  The argument is the signature number as used
122        internally by the program.  */
123     
124     AUDIT_SIG_NAME,        /* string */
125     /* The name of a signer.  This is the name or other identification
126        data as known from the signature and not the name from the
127        certificate used for verification.  An example for STRING when
128        using CMS is: "#1234/CN=Prostetnic Vogon Jeltz".  */
129
130     AUDIT_SIG_STATUS,      /* string */
131     /* The signature status of the current signer.  This is the last
132        audit information for one signature.  STRING gives the status:
133
134          "error"       - there was a problem checking this or any signature.
135          "unsupported" - the signature type is not supported. 
136          "no-cert"     - The certificate of the signer was not found (the
137                          S/N+issuer of the signer is already in the log).
138          "bad"         - bad signature
139          "good"        - good signature
140     */
141
142     AUDIT_NEW_RECP,        /* int */
143     /* A new recipient has been seen during decryption.  The argument
144        is the recipient number as used internally by the program.  */
145     
146     AUDIT_RECP_NAME,       /* string */
147     /* The name of a recipient.  This is the name or other identification
148        data as known from the decryption and not the name from the
149        certificate used for decryption.  An example for STRING when
150        using CMS is: "#1234/CN=Prostetnic Vogon Jeltz".  */
151
152     AUDIT_RECP_RESULT,    /* ok_err */
153     /* The status of the session key decryption.  This is only written
154        for recipients tried. */
155
156     AUDIT_DECRYPTION_RESULT,    /* ok_err */
157     /* The status of the entire decryption.  The decryption was
158        successful if the error code is 0. */
159
160     AUDIT_VALIDATE_CHAIN,
161     /* Start the validation of a certificate chain. */
162
163     AUDIT_CHAIN_BEGIN,
164     AUDIT_CHAIN_CERT,    /* cert */
165     AUDIT_CHAIN_ROOTCERT,/* cert */
166     AUDIT_CHAIN_END,
167     /* These 4 events are used to log the certificates making up a
168        certificate chain.  ROOTCERT is used for the trustanchor and
169        CERT for all other certificates.  */ 
170
171     AUDIT_CHAIN_STATUS,  /* err */
172     /* Tells the final status of the chain validation.  */
173
174     AUDIT_ROOT_TRUSTED,  /* cert, err */
175     /* Tells whether the root certificate is trusted.  This event is
176        emmited durcing chain validation.  */
177
178     AUDIT_CRL_CHECK, /* err */
179     /* Tells the status of a CRL or OCSP check.  */
180
181     AUDIT_GOT_RECIPIENTS,  /* int */
182     /* Records the number of recipients to be used for encryption.
183        This includes the recipients set by --encrypt-to but records 0
184        if no real recipient has been given.  */
185
186     AUDIT_SESSION_KEY,     /* string */
187     /* Mark the creation or availibility of the session key.  The
188        parameter is the algorithm ID.  */
189
190     AUDIT_ENCRYPTED_TO,   /* cert, err */
191     /* Records the certificate used for encryption and whether the
192        session key could be encrypted to it (err==0).  */
193
194     AUDIT_ENCRYPTION_DONE,
195     /* Encryption succeeded.  */
196
197     AUDIT_SIGNED_BY,   /* cert, err */
198     /* Records the certificate used for signed and whether the signure
199        could be created (if err==0).  */
200
201     AUDIT_SIGNING_DONE,
202     /* Signing succeeded.  */
203
204
205     AUDIT_LAST_EVENT  /* Marker for parsing this list.  */
206   }
207 audit_event_t;
208
209
210 audit_ctx_t audit_new (void);
211 void audit_release (audit_ctx_t ctx);
212 void audit_set_type (audit_ctx_t ctx, audit_type_t type);
213 void audit_log (audit_ctx_t ctx, audit_event_t event);
214 void audit_log_ok (audit_ctx_t ctx, audit_event_t event, gpg_error_t err);
215 void audit_log_i (audit_ctx_t ctx, audit_event_t event, int value);
216 void audit_log_s (audit_ctx_t ctx, audit_event_t event, const char *value);
217 void audit_log_cert (audit_ctx_t ctx, audit_event_t event, 
218                      ksba_cert_t cert, gpg_error_t err);
219
220 void audit_print_result (audit_ctx_t ctx, estream_t stream, int use_html);
221
222
223
224 #endif /*GNUPG_COMMON_AUDIT_H*/