Started to implement the audit log feature.
[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
26 struct audit_ctx_s;
27 typedef struct audit_ctx_s *audit_ctx_t;
28
29 /* Constants for the audit type.  */
30 typedef enum
31   {
32     AUDIT_TYPE_NONE  = 0,  /* No type set.  */
33     AUDIT_TYPE_VERIFY      /* Signature verification.  */
34   }
35 audit_type_t;
36
37 /* The events we support.  */
38 typedef enum
39   {
40     AUDIT_NULL_EVENT = 0,
41     /* No such event.  Its value shall be 0 and no other values shall
42        be assigned to the other enum symbols.  This is required so
43        that the exaudit.awk script comes up with correct values
44        without running cc.  */
45
46     AUDIT_SETUP_READY,
47     /* All preparations done so that the actual processing can start
48        now.  This indicates that all parameters are okay and we can
49        start to process the actual data.  */
50
51     AUDIT_DETACHED_SIGNATURE,
52     /* The signature is a detached one. */
53
54     AUDIT_CERT_ONLY_SIG,
55     /* A certifciate only signature has been detected.  */
56
57     AUDIT_DATA_HASH_ALGO,  /* int */
58     /* The hash algo given as argument is used for this signature.
59        This event will be repeated for all hash algorithms used with
60        the data.  */
61
62     AUDIT_BAD_DATA_HASH_ALGO,  /* string */
63     /* The hash algo as specified by the signature can't be used.
64        STRING is the description of this algorithm which usually is an
65        OID string.  STRING may be NULL. */
66
67     AUDIT_DATA_HASHING,    /* ok_err */
68     /* Logs the result of the data hashing. */
69
70     AUDIT_READ_ERROR,     /* ok_err */
71     /* A generic read error occurred.  */
72
73     AUDIT_WRITE_ERROR,     /* ok_err */
74     /* A generic write error occurred.  */
75
76     AUDIT_USAGE_ERROR,
77     /* The program was used in an inappropriate way; For example by
78        passing a data object while the signature does not expect one
79        or vice versa.  */
80     
81     AUDIT_SAVE_CERT,       /* cert, ok_err */
82     /* Save the certificate received in a message. */
83
84     AUDIT_NEW_SIG,         /* int */
85     /* Start the verification of a new signature for the last data
86        object.  The argument is the signature number as used
87        internally by the program.  */
88     
89     AUDIT_SIG_NAME,        /* string */
90     /* The name of a signer.  This is the name or other identification
91        data as known from the signature and not the name from the
92        certificate used for verification.  An example for STRING when
93        using CMS is:b "#1234/CN=Prostetnic Vogon Jeltz".  */
94
95     AUDIT_SIG_STATUS,     /* string */
96     /* The signature status of the current signer.  This is the last
97        audit information for one signature.  STRING gives the status:
98
99          "error"       - there was a problem checking this or any signature.
100          "unsupported" - the signature type is not supported. 
101          "no-cert"     - The certificate of the signer was not found (the
102                          S/N+issuer of the signer is already in the log).
103          "bad"         - bad signature
104          "good"        - good signature
105     */
106
107     AUDIT_VALIDATE_CHAIN,
108     /* Start the validation of a certificate chain. */
109
110     AUDIT_CHAIN_BEGIN,
111     AUDIT_CHAIN_CERT,    /* cert */
112     AUDIT_CHAIN_ROOTCERT,/* cert */
113     AUDIT_CHAIN_END,
114     /* These 4 events are used to log the certificates making up a
115        certificate chain.  ROOTCERT is used for the trustanchor and
116        CERT for all other certificates.  */ 
117
118
119
120     AUDIT_LAST_EVENT  /* Marker for parsing this list.  */
121   }
122 audit_event_t;
123
124
125 audit_ctx_t audit_new (void);
126 void audit_release (audit_ctx_t ctx);
127 void audit_set_type (audit_ctx_t ctx, audit_type_t type);
128 void audit_log (audit_ctx_t ctx, audit_event_t event);
129 void audit_log_ok (audit_ctx_t ctx, audit_event_t event, gpg_error_t err);
130 void audit_log_i (audit_ctx_t ctx, audit_event_t event, int value);
131 void audit_log_s (audit_ctx_t ctx, audit_event_t event, const char *value);
132 void audit_log_cert (audit_ctx_t ctx, audit_event_t event, 
133                      ksba_cert_t cert, gpg_error_t err);
134
135 void audit_print_result (audit_ctx_t ctx, FILE *fp);
136
137
138
139 #endif /*GNUPG_COMMON_AUDIT_H*/