b3a9d7507da0c590e3ccb74f0b93785add3072a8
[gnupg.git] / g10 / packet.h
1 /* packet.h - packet read/write stuff
2  *      Copyright (C) 1998 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 G10_PACKET_H
22 #define G10_PACKET_H
23
24 #include "types.h"
25 #include "iobuf.h"
26 #include "mpi.h"
27 #include "cipher.h"
28 #include "filter.h"
29
30 typedef enum {
31         PKT_NONE           =0,
32         PKT_PUBKEY_ENC     =1, /* public key encrypted packet */
33         PKT_SIGNATURE      =2, /* secret key encrypted packet */
34         PKT_SYMKEY_ENC     =3, /* session key packet (OpenPGP)*/
35         PKT_ONEPASS_SIG    =4, /* one pass sig packet (OpenPGP)*/
36         PKT_SECRET_KEY     =5, /* secret key */
37         PKT_PUBLIC_KEY     =6, /* public key */
38         PKT_SECRET_SUBKEY  =7, /* secret subkey (OpenPGP) */
39         PKT_COMPRESSED     =8, /* compressed data packet */
40         PKT_ENCRYPTED      =9, /* conventional encrypted data */
41         PKT_MARKER        =10, /* marker packet (OpenPGP) */
42         PKT_PLAINTEXT     =11, /* plaintext data with filename and mode */
43         PKT_RING_TRUST    =12, /* keyring trust packet */
44         PKT_USER_ID       =13, /* user id packet */
45         PKT_PUBLIC_SUBKEY =14, /* public subkey (OpenPGP) */
46         PKT_OLD_COMMENT   =16, /* comment packet from an OpenPGP draft */
47         PKT_COMMENT       =61  /* new comment packet (private) */
48 } pkttype_t;
49
50 typedef struct packet_struct PACKET;
51
52 typedef struct {
53     byte mode;
54     byte hash_algo;
55     byte salt[8];
56     u32  count;
57 } STRING2KEY;
58
59 typedef struct {
60     byte version;
61     byte cipher_algo;    /* cipher algorithm used */
62     STRING2KEY s2k;
63     byte seskeylen;   /* keylength in byte or 0 for no seskey */
64     byte seskey[1];
65 } PKT_symkey_enc;
66
67 typedef struct {
68     u32     keyid[2];       /* 64 bit keyid */
69     byte    version;
70     byte    pubkey_algo;    /* algorithm used for public key scheme */
71     MPI     data[PUBKEY_MAX_NENC];
72 } PKT_pubkey_enc;
73
74
75 typedef struct {
76     u32     keyid[2];       /* 64 bit keyid */
77     byte    sig_class;      /* sig classification */
78     byte    digest_algo;    /* algorithm used for digest */
79     byte    pubkey_algo;    /* algorithm used for public key scheme */
80     byte    last;           /* a stupid flag */
81 } PKT_onepass_sig;
82
83
84 typedef struct {
85     u32     keyid[2];       /* 64 bit keyid */
86     ulong   local_id;       /* internal use, valid if > 0 */
87     u32     timestamp;      /* signature made */
88     byte    version;
89     byte    sig_class;      /* sig classification, append for MD calculation*/
90     byte    pubkey_algo;    /* algorithm used for public key scheme */
91                             /* (PUBKEY_ALGO_xxx) */
92     byte digest_algo;       /* algorithm used for digest (DIGEST_ALGO_xxxx) */
93     byte *hashed_data;      /* all subpackets with hashed  data (v4 only) */
94     byte *unhashed_data;    /* ditto for unhashed data */
95     byte digest_start[2];   /* first 2 bytes of the digest */
96     MPI  data[PUBKEY_MAX_NSIG];
97 } PKT_signature;
98
99
100 /****************
101  * Note about the pkey/skey elements:  We assume that the secret keys
102  * has the same elemts as the public key at the begin of the array, so
103  * that npkey < nskey and it is possible to compare the secret and
104  * public keys by comparing the first npkey elements of pkey againts skey.
105  */
106 typedef struct {
107     u32     timestamp;      /* key made */
108     u16     valid_days;     /* valid for this number of days */
109     byte    hdrbytes;       /* number of header bytes */
110     byte    version;
111     byte    pubkey_algo;    /* algorithm used for public key scheme */
112     ulong   local_id;       /* internal use, valid if > 0 */
113     MPI     pkey[PUBKEY_MAX_NPKEY];
114 } PKT_public_key;
115
116 typedef struct {
117     u32     timestamp;      /* key made */
118     u16     valid_days;     /* valid for this number of days */
119     byte    hdrbytes;       /* number of header bytes */
120     byte    version;
121     byte    pubkey_algo;    /* algorithm used for public key scheme */
122     byte is_protected;  /* The secret info is protected and must */
123                         /* be decrypted before use, the protected */
124                         /* MPIs are simply (void*) pointers to memory */
125                         /* and should never be passed to a mpi_xxx() */
126     struct {
127         byte algo;  /* cipher used to protect the secret information*/
128         STRING2KEY s2k;
129         byte iv[8]; /* initialization vector for CFB mode */
130     } protect;
131     MPI skey[PUBKEY_MAX_NSKEY];
132     u16 csum;           /* checksum */
133 } PKT_secret_key;
134
135
136 typedef struct {
137     int  len;             /* length of data */
138     char data[1];
139 } PKT_comment;
140
141 typedef struct {
142     int  len;             /* length of the name */
143     char name[1];
144 } PKT_user_id;
145
146 typedef struct {
147     u32  len;             /* reserved */
148     byte  algorithm;
149     IOBUF buf;            /* IOBUF reference */
150 } PKT_compressed;
151
152 typedef struct {
153     u32  len;             /* length of encrypted data */
154     IOBUF buf;            /* IOBUF reference */
155 } PKT_encrypted;
156
157 typedef struct {
158     u32  len;             /* length of encrypted data */
159     IOBUF buf;            /* IOBUF reference */
160     int mode;
161     u32 timestamp;
162     int  namelen;
163     char name[1];
164 } PKT_plaintext;
165
166 /* combine all packets into a union */
167 struct packet_struct {
168     pkttype_t pkttype;
169     union {
170         void *generic;
171         PKT_symkey_enc  *symkey_enc;    /* PKT_SYMKEY_ENC */
172         PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
173         PKT_onepass_sig *onepass_sig;   /* PKT_ONEPASS_SIG */
174         PKT_signature   *signature;     /* PKT_SIGNATURE */
175         PKT_public_key  *public_key;    /* PKT_PUBLIC_[SUB)KEY */
176         PKT_secret_key  *secret_key;    /* PKT_SECRET_[SUB]KEY */
177         PKT_comment     *comment;       /* PKT_COMMENT */
178         PKT_user_id     *user_id;       /* PKT_USER_ID */
179         PKT_compressed  *compressed;    /* PKT_COMPRESSED */
180         PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED */
181         PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
182     } pkt;
183 };
184
185 #define init_packet(a) do { (a)->pkttype = 0;           \
186                             (a)->pkt.generic = NULL;    \
187                        } while(0)
188
189 typedef enum {
190     SIGSUBPKT_LIST_UNHASHED=-2,
191     SIGSUBPKT_LIST_HASHED  =-1,
192     SIGSUBPKT_NONE         = 0,
193     SIGSUBPKT_SIG_CREATED  = 2, /* signature creation time */
194     SIGSUBPKT_SIG_EXPIRE   = 3, /* signature expiration time */
195     SIGSUBPKT_EXPORTABLE   = 4, /* exportable */
196     SIGSUBPKT_TRUST        = 5, /* trust signature */
197     SIGSUBPKT_REGEXP       = 6, /* regular expression */
198     SIGSUBPKT_REVOCABLE    = 7, /* revocable */
199     SIGSUBPKT_KEY_EXPIRE   = 9, /* key expiration time */
200     SIGSUBPKT_ARR          =10, /* additional recipient request */
201     SIGSUBPKT_PREF_SYM     =11, /* preferred symmetric algorithms */
202     SIGSUBPKT_REV_KEY      =12, /* revocation key */
203     SIGSUBPKT_ISSUER       =16, /* issuer key ID */
204     SIGSUBPKT_NOTATION     =20, /* notation data */
205     SIGSUBPKT_PREF_HASH    =21, /* preferred hash algorithms */
206     SIGSUBPKT_PREF_COMPR   =22, /* preferred compression algorithms */
207     SIGSUBPKT_KS_FLAGS     =23, /* key server preferences */
208     SIGSUBPKT_PREF_KS      =24, /* preferred key server */
209     SIGSUBPKT_PRIMARY_UID  =25, /* primary user id */
210     SIGSUBPKT_POLICY       =26, /* policy URL */
211     SIGSUBPKT_KEY_FLAGS    =27, /* key flags */
212     SIGSUBPKT_SIGNERS_UID  =28, /* signer's user id */
213     SIGSUBPKT_PRIV_ADD_SIG =101 /* signatur is also valid for this uid */
214 } sigsubpkttype_t;
215
216
217 /*-- mainproc.c --*/
218 int proc_packets( IOBUF a );
219 int proc_signature_packets( IOBUF a, STRLIST signedfiles );
220 int proc_encryption_packets( IOBUF a );
221 int list_packets( IOBUF a );
222
223 /*-- parse-packet.c --*/
224 int set_packet_list_mode( int mode );
225 int search_packet( IOBUF inp, PACKET *pkt, int pkttype, ulong *retpos );
226 int parse_packet( IOBUF inp, PACKET *ret_pkt);
227 void parse_pubkey_warning( PACKET *pkt );
228 int copy_all_packets( IOBUF inp, IOBUF out );
229 int copy_some_packets( IOBUF inp, IOBUF out, ulong stopoff );
230 int skip_some_packets( IOBUF inp, unsigned n );
231 const byte *parse_sig_subpkt( const byte *buffer,
232                               sigsubpkttype_t reqtype, size_t *ret_n );
233
234 /*-- build-packet.c --*/
235 int build_packet( IOBUF inp, PACKET *pkt );
236 u32 calc_packet_length( PACKET *pkt );
237 void hash_public_key( MD_HANDLE md, PKT_public_key *pk );
238 void build_sig_subpkt( PKT_signature *sig, sigsubpkttype_t type,
239                         const byte *buffer, size_t buflen );
240 void build_sig_subpkt_from_sig( PKT_signature *sig );
241
242 /*-- free-packet.c --*/
243 void free_symkey_enc( PKT_symkey_enc *enc );
244 void free_pubkey_enc( PKT_pubkey_enc *enc );
245 void free_seckey_enc( PKT_signature *enc );
246 int  digest_algo_from_sig( PKT_signature *sig );
247 void release_public_key_parts( PKT_public_key *pk );
248 void free_public_key( PKT_public_key *key );
249 void release_secret_key_parts( PKT_secret_key *sk );
250 void free_secret_key( PKT_secret_key *sk );
251 void free_user_id( PKT_user_id *uid );
252 void free_comment( PKT_comment *rem );
253 void free_packet( PACKET *pkt );
254 PKT_public_key *copy_public_key( PKT_public_key *d, PKT_public_key *s );
255 PKT_secret_key *copy_secret_key( PKT_secret_key *d, PKT_secret_key *s );
256 int cmp_public_keys( PKT_public_key *a, PKT_public_key *b );
257 int cmp_public_secret_key( PKT_public_key *pk, PKT_secret_key *sk );
258 int cmp_user_ids( PKT_user_id *a, PKT_user_id *b );
259
260
261 /*-- sig-check.c --*/
262 int signature_check( PKT_signature *sig, MD_HANDLE digest );
263
264 /*-- seckey-cert.c --*/
265 int is_secret_key_protected( PKT_secret_key *sk );
266 int check_secret_key( PKT_secret_key *sk );
267 int protect_secret_key( PKT_secret_key *sk, DEK *dek );
268
269 /*-- pubkey-enc.c --*/
270 int get_session_key( PKT_pubkey_enc *k, DEK *dek );
271
272 /*-- compress.c --*/
273 int handle_compressed( PKT_compressed *cd,
274                        int (*callback)(IOBUF, void *), void *passthru );
275
276 /*-- encr-data.c --*/
277 int decrypt_data( PKT_encrypted *ed, DEK *dek );
278 int encrypt_data( PKT_encrypted *ed, DEK *dek );
279
280 /*-- plaintext.c --*/
281 int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx,int nooutput);
282 int ask_for_detached_datafile( md_filter_context_t *mfx, const char *inname );
283
284 /*-- comment.c --*/
285 int write_comment( IOBUF out, const char *s );
286
287 /*-- sign.c --*/
288 int make_keysig_packet( PKT_signature **ret_sig, PKT_public_key *pk,
289                         PKT_user_id *uid, PKT_public_key *subpk,
290                         PKT_secret_key *sk,
291                         int sigclass, int digest_algo,
292                         int (*mksubpkt)(PKT_signature *, void *),
293                         void *opaque  );
294
295 #endif /*G10_PACKET_H*/