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