See ChangeLog: Tue Aug 31 17:20:44 CEST 1999 Werner Koch
[gnupg.git] / g10 / packet.h
index f7dbf97..50ea65b 100644 (file)
@@ -1,14 +1,14 @@
 /* packet.h - packet read/write stuff
- *     Copyright (c) 1997 by Werner Koch (dd9jn)
+ *     Copyright (C) 1998 Free Software Foundation, Inc.
  *
- * This file is part of G10.
+ * This file is part of GnuPG.
  *
- * G10 is free software; you can redistribute it and/or modify
+ * GnuPG is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  *
- * G10 is distributed in the hope that it will be useful,
+ * GnuPG is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
 #include "cipher.h"
 #include "filter.h"
 
+#define DEBUG_PARSE_PACKET 1
+
 typedef enum {
        PKT_NONE           =0,
        PKT_PUBKEY_ENC     =1, /* public key encrypted packet */
        PKT_SIGNATURE      =2, /* secret key encrypted packet */
-       PKT_SESSION_KEY    =3, /* session key packet (OpenPGP)*/
+       PKT_SYMKEY_ENC     =3, /* session key packet (OpenPGP)*/
        PKT_ONEPASS_SIG    =4, /* one pass sig packet (OpenPGP)*/
-       PKT_SECRET_CERT    =5, /* secret key certificate */
-       PKT_PUBLIC_CERT    =6, /* public key certificate */
-       PKT_SECKEY_SUBCERT =7, /* secret subkey certificate (OpenPGP) */
+       PKT_SECRET_KEY     =5, /* secret key */
+       PKT_PUBLIC_KEY     =6, /* public key */
+       PKT_SECRET_SUBKEY  =7, /* secret subkey (OpenPGP) */
        PKT_COMPRESSED     =8, /* compressed data packet */
        PKT_ENCRYPTED      =9, /* conventional encrypted data */
        PKT_MARKER        =10, /* marker packet (OpenPGP) */
        PKT_PLAINTEXT     =11, /* plaintext data with filename and mode */
        PKT_RING_TRUST    =12, /* keyring trust packet */
        PKT_USER_ID       =13, /* user id packet */
-       PKT_COMMENT       =14, /* comment packet */
-       PKT_PUBKEY_SUBCERT=14, /* subkey certificate (OpenPGP) */
-       PKT_NEW_COMMENT   =16  /* new comment packet (OpenPGP) */
+       PKT_PUBLIC_SUBKEY =14, /* public subkey (OpenPGP) */
+       PKT_OLD_COMMENT   =16, /* comment packet from an OpenPGP draft */
+       PKT_COMMENT       =61, /* new comment packet (private) */
+       PKT_ENCRYPTED_MDC =62, /* test: encrypted data with MDC */
 } pkttype_t;
 
 typedef struct packet_struct PACKET;
 
 typedef struct {
+    byte mode;
+    byte hash_algo;
+    byte salt[8];
+    u32  count;
+} STRING2KEY;
+
+typedef struct {
+    byte version;
+    byte cipher_algo;   /* cipher algorithm used */
+    STRING2KEY s2k;
+    byte seskeylen;   /* keylength in byte or 0 for no seskey */
+    byte seskey[1];
+} PKT_symkey_enc;
+
+typedef struct {
     u32     keyid[2];      /* 64 bit keyid */
+    byte    version;
     byte    pubkey_algo;    /* algorithm used for public key scheme */
-    union {
-      struct {
-       MPI  a, b;          /* integers with the encrypteded DEK */
-      } elg;
-      struct {
-       MPI  rsa_integer;   /* integer containing the DEK */
-      } rsa;
-    } d;
+    byte    throw_keyid;
+    MPI     data[PUBKEY_MAX_NENC];
 } PKT_pubkey_enc;
 
 
@@ -73,87 +86,66 @@ typedef struct {
 
 
 typedef struct {
+    ulong   local_id;      /* internal use, valid if > 0 */
+    struct {
+       unsigned checked:1; /* signature has been checked */
+       unsigned valid:1;   /* signature is good (if checked is set) */
+       unsigned unknown_critical:1;
+    } flags;
     u32     keyid[2];      /* 64 bit keyid */
     u32     timestamp;     /* signature made */
+    byte    version;
     byte    sig_class;     /* sig classification, append for MD calculation*/
     byte    pubkey_algo;    /* algorithm used for public key scheme */
                            /* (PUBKEY_ALGO_xxx) */
-    union {
-      struct {
-       byte digest_algo;     /* algorithm used for digest (DIGEST_ALGO_xxxx) */
-       byte digest_start[2]; /* first 2 byte of the digest */
-       MPI  a, b;            /* integers with the digest */
-      } elg;
-      struct {
-       byte digest_algo;     /* algorithm used for digest (DIGEST_ALGO_xxxx) */
-       byte digest_start[2]; /* first 2 byte of the digest */
-       MPI  rsa_integer;     /* the encrypted digest */
-      } rsa;
-    } d;
+    byte digest_algo;      /* algorithm used for digest (DIGEST_ALGO_xxxx) */
+    byte *hashed_data;     /* all subpackets with hashed  data (v4 only) */
+    byte *unhashed_data;    /* ditto for unhashed data */
+    byte digest_start[2];   /* first 2 bytes of the digest */
+    MPI  data[PUBKEY_MAX_NSIG];
 } PKT_signature;
 
 
+/****************
+ * Note about the pkey/skey elements:  We assume that the secret keys
+ * has the same elemts as the public key at the begin of the array, so
+ * that npkey < nskey and it is possible to compare the secret and
+ * public keys by comparing the first npkey elements of pkey againts skey.
+ */
 typedef struct {
-    u32     timestamp;     /* certificate made */
-    u16     valid_days;     /* valid for this number of days */
+    u32     timestamp;     /* key made */
+    u32     expiredate;     /* expires at this date or 0 if not at all */
+    byte    hdrbytes;      /* number of header bytes */
+    byte    version;
     byte    pubkey_algo;    /* algorithm used for public key scheme */
-    md_filter_context_t mfx;
-    union {
-      struct {
-       MPI p;              /* prime */
-       MPI g;              /* group generator */
-       MPI y;              /* g^x mod p */
-      } elg;
-      struct {
-       MPI rsa_n;          /* public modulus */
-       MPI rsa_e;          /* public exponent */
-      } rsa;
-    } d;
-} PKT_public_cert;
+    byte    pubkey_usage;   /* for now only used to pass it to getkey() */
+    ulong   local_id;      /* internal use, valid if > 0 */
+    u32     keyid[2];      /* calculated by keyid_from_pk() */
+    byte    *namehash;     /* if != NULL: found by this name */
+    MPI     pkey[PUBKEY_MAX_NPKEY];
+} PKT_public_key;
 
 typedef struct {
-    u32     timestamp;     /* certificate made */
-    u16     valid_days;     /* valid for this number of days */
+    u32     timestamp;     /* key made */
+    u32     expiredate;     /* expires at this date or 0 if not at all */
+    byte    hdrbytes;      /* number of header bytes */
+    byte    version;
     byte    pubkey_algo;    /* algorithm used for public key scheme */
-    union {
-      struct {
-       MPI p;              /* prime */
-       MPI g;              /* group generator */
-       MPI y;              /* g^x mod p */
-       MPI x;              /* secret exponent */
-       u16 csum;           /* checksum */
-       byte is_protected;  /* The above infos are protected and must */
-                           /* be decrypteded before use */
-       byte protect_algo;  /* cipher used to protect the secret informations*/
-       union {             /* information for the protection */
-         struct {
-           byte iv[8];     /* initialization vector for CFB mode */
-                           /* when protected, the MPIs above are pointers
-                            * to plain storage */
-         } blowfish;
-       } protect;
-      } elg;
-      struct {
-       MPI rsa_n;          /* public modulus */
-       MPI rsa_e;          /* public exponent */
-       MPI rsa_d;          /* secret descryption exponent */
-       MPI rsa_p;          /* secret first prime number */
-       MPI rsa_q;          /* secret second prime number */
-       MPI rsa_u;          /* secret multiplicative inverse */
-       u16 csum;           /* checksum */
-       byte is_protected;  /* The above infos are protected and must */
-                           /* be decrypteded before use */
-       byte protect_algo;  /* cipher used to protect the secret informations*/
-       union {             /* information for the protection */
-         struct {
-           byte iv[8];     /* initialization vector for CFB mode */
-                           /* when protected, the MPIs above are pointers
-                            * to plain storage */
-         } blowfish;
-       } protect;
-      } rsa;
-    } d;
-} PKT_secret_cert;
+    byte    pubkey_usage;
+    byte is_primary;
+    byte is_protected; /* The secret info is protected and must */
+                       /* be decrypted before use, the protected */
+                       /* MPIs are simply (void*) pointers to memory */
+                       /* and should never be passed to a mpi_xxx() */
+    struct {
+       byte algo;  /* cipher used to protect the secret information*/
+       STRING2KEY s2k;
+       byte ivlen;  /* used length of the iv */
+       byte iv[16]; /* initialization vector for CFB mode */
+    } protect;
+    MPI skey[PUBKEY_MAX_NSKEY];
+    u16 csum;          /* checksum */
+} PKT_secret_key;
 
 
 typedef struct {
@@ -168,38 +160,49 @@ typedef struct {
 
 typedef struct {
     u32  len;            /* reserved */
+    byte  new_ctb;
     byte  algorithm;
     IOBUF buf;           /* IOBUF reference */
 } PKT_compressed;
 
 typedef struct {
     u32  len;            /* length of encrypted data */
+    byte new_ctb;        /* uses a new CTB */
+    byte mdc_method;     /* test: > 0: this is is an encrypted_mdc packet */
     IOBUF buf;           /* IOBUF reference */
 } PKT_encrypted;
 
 typedef struct {
+    unsigned int trustval;
+} PKT_ring_trust;
+
+typedef struct {
     u32  len;            /* length of encrypted data */
     IOBUF buf;           /* IOBUF reference */
+    byte new_ctb;
     int mode;
     u32 timestamp;
     int  namelen;
     char name[1];
 } PKT_plaintext;
 
+
 /* combine all packets into a union */
 struct packet_struct {
     pkttype_t pkttype;
     union {
        void *generic;
+       PKT_symkey_enc  *symkey_enc;    /* PKT_SYMKEY_ENC */
        PKT_pubkey_enc  *pubkey_enc;    /* PKT_PUBKEY_ENC */
        PKT_onepass_sig *onepass_sig;   /* PKT_ONEPASS_SIG */
        PKT_signature   *signature;     /* PKT_SIGNATURE */
-       PKT_public_cert *public_cert;   /* PKT_PUBLIC_CERT */
-       PKT_secret_cert *secret_cert;   /* PKT_SECRET_CERT */
+       PKT_public_key  *public_key;    /* PKT_PUBLIC_[SUB)KEY */
+       PKT_secret_key  *secret_key;    /* PKT_SECRET_[SUB]KEY */
        PKT_comment     *comment;       /* PKT_COMMENT */
        PKT_user_id     *user_id;       /* PKT_USER_ID */
        PKT_compressed  *compressed;    /* PKT_COMPRESSED */
-       PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED */
+       PKT_encrypted   *encrypted;     /* PKT_ENCRYPTED[_MDC] */
+       PKT_ring_trust  *ring_trust;    /* PKT_RING_TRUST */
        PKT_plaintext   *plaintext;     /* PKT_PLAINTEXT */
     } pkt;
 };
@@ -208,58 +211,144 @@ struct packet_struct {
                            (a)->pkt.generic = NULL;    \
                       } while(0)
 
+typedef enum {
+    SIGSUBPKT_TEST_CRITICAL=-3,
+    SIGSUBPKT_LIST_UNHASHED=-2,
+    SIGSUBPKT_LIST_HASHED  =-1,
+    SIGSUBPKT_NONE        = 0,
+    SIGSUBPKT_SIG_CREATED  = 2, /* signature creation time */
+    SIGSUBPKT_SIG_EXPIRE   = 3, /* signature expiration time */
+    SIGSUBPKT_EXPORTABLE   = 4, /* exportable */
+    SIGSUBPKT_TRUST       = 5, /* trust signature */
+    SIGSUBPKT_REGEXP      = 6, /* regular expression */
+    SIGSUBPKT_REVOCABLE    = 7, /* revocable */
+    SIGSUBPKT_KEY_EXPIRE   = 9, /* key expiration time */
+    SIGSUBPKT_ARR         =10, /* additional recipient request */
+    SIGSUBPKT_PREF_SYM    =11, /* preferred symmetric algorithms */
+    SIGSUBPKT_REV_KEY     =12, /* revocation key */
+    SIGSUBPKT_ISSUER      =16, /* issuer key ID */
+    SIGSUBPKT_NOTATION    =20, /* notation data */
+    SIGSUBPKT_PREF_HASH    =21, /* preferred hash algorithms */
+    SIGSUBPKT_PREF_COMPR   =22, /* preferred compression algorithms */
+    SIGSUBPKT_KS_FLAGS    =23, /* key server preferences */
+    SIGSUBPKT_PREF_KS     =24, /* preferred key server */
+    SIGSUBPKT_PRIMARY_UID  =25, /* primary user id */
+    SIGSUBPKT_POLICY      =26, /* policy URL */
+    SIGSUBPKT_KEY_FLAGS    =27, /* key flags */
+    SIGSUBPKT_SIGNERS_UID  =28, /* signer's user id */
+    SIGSUBPKT_PRIV_ADD_SIG =101,/* signatur is also valid for this uid */
+
+    SIGSUBPKT_FLAG_CRITICAL=128
+} sigsubpkttype_t;
+
+
 /*-- mainproc.c --*/
-int proc_packets( IOBUF a );
+int proc_packets( void *ctx, IOBUF a );
+int proc_signature_packets( void *ctx, IOBUF a,
+                           STRLIST signedfiles, const char *sigfile );
+int proc_encryption_packets( void *ctx, IOBUF a );
+int list_packets( IOBUF a );
 
 /*-- parse-packet.c --*/
 int set_packet_list_mode( int mode );
+
+#if DEBUG_PARSE_PACKET
+int dbg_search_packet( IOBUF inp, PACKET *pkt, int pkttype, ulong *retpos, const char* file, int lineno  );
+int dbg_parse_packet( IOBUF inp, PACKET *ret_pkt, const char* file, int lineno );
+int dbg_copy_all_packets( IOBUF inp, IOBUF out, const char* file, int lineno  );
+int dbg_copy_some_packets( IOBUF inp, IOBUF out, ulong stopoff, const char* file, int lineno  );
+int dbg_skip_some_packets( IOBUF inp, unsigned n, const char* file, int lineno );
+#define search_packet( a,b,c,d )   dbg_search_packet( (a), (b), (c), (d), __FILE__, __LINE__ )
+#define parse_packet( a, b )      dbg_parse_packet( (a), (b), __FILE__, __LINE__ )
+#define copy_all_packets( a,b )    dbg_copy_all_packets((a),(b), __FILE__, __LINE__ )
+#define copy_some_packets( a,b,c ) dbg_copy_some_packets((a),(b),(c), __FILE__, __LINE__ )
+#define skip_some_packets( a,b )   dbg_skip_some_packets((a),(b), __FILE__, __LINE__ )
+#else
 int search_packet( IOBUF inp, PACKET *pkt, int pkttype, ulong *retpos );
 int parse_packet( IOBUF inp, PACKET *ret_pkt);
+int copy_all_packets( IOBUF inp, IOBUF out );
+int copy_some_packets( IOBUF inp, IOBUF out, ulong stopoff );
+int skip_some_packets( IOBUF inp, unsigned n );
+#endif
+
+const byte *enum_sig_subpkt( const byte *buffer, sigsubpkttype_t reqtype,
+                                             size_t *ret_n, int *start );
+const byte *parse_sig_subpkt( const byte *buffer, sigsubpkttype_t reqtype,
+                                      size_t *ret_n );
+const byte *parse_sig_subpkt2( PKT_signature *sig,
+                              sigsubpkttype_t reqtype, size_t *ret_n );
 
 /*-- build-packet.c --*/
 int build_packet( IOBUF inp, PACKET *pkt );
 u32 calc_packet_length( PACKET *pkt );
-void hash_public_cert( MD_HANDLE *md, PKT_public_cert *pkc );
+void hash_public_key( MD_HANDLE md, PKT_public_key *pk );
+void build_sig_subpkt( PKT_signature *sig, sigsubpkttype_t type,
+                       const byte *buffer, size_t buflen );
+void build_sig_subpkt_from_sig( PKT_signature *sig );
 
 /*-- free-packet.c --*/
+void free_symkey_enc( PKT_symkey_enc *enc );
 void free_pubkey_enc( PKT_pubkey_enc *enc );
 void free_seckey_enc( PKT_signature *enc );
-void free_public_cert( PKT_public_cert *cert );
-void free_secret_cert( PKT_secret_cert *cert );
+int  digest_algo_from_sig( PKT_signature *sig );
+void release_public_key_parts( PKT_public_key *pk );
+void free_public_key( PKT_public_key *key );
+void release_secret_key_parts( PKT_secret_key *sk );
+void free_secret_key( PKT_secret_key *sk );
 void free_user_id( PKT_user_id *uid );
 void free_comment( PKT_comment *rem );
 void free_packet( PACKET *pkt );
-PKT_public_cert *copy_public_cert( PKT_public_cert *d, PKT_public_cert *s );
-PKT_secret_cert *copy_secret_cert( PKT_secret_cert *d, PKT_secret_cert *s );
+PKT_public_key *copy_public_key( PKT_public_key *d, PKT_public_key *s );
+PKT_public_key *copy_public_key_new_namehash( PKT_public_key *d,
+                                             PKT_public_key *s,
+                                             const byte *namehash );
+PKT_secret_key *copy_secret_key( PKT_secret_key *d, PKT_secret_key *s );
+PKT_signature *copy_signature( PKT_signature *d, PKT_signature *s );
+PKT_user_id *copy_user_id( PKT_user_id *d, PKT_user_id *s );
+int cmp_public_keys( PKT_public_key *a, PKT_public_key *b );
+int cmp_secret_keys( PKT_secret_key *a, PKT_secret_key *b );
+int cmp_signatures( PKT_signature *a, PKT_signature *b );
+int cmp_public_secret_key( PKT_public_key *pk, PKT_secret_key *sk );
+int cmp_user_ids( PKT_user_id *a, PKT_user_id *b );
 
 
 /*-- sig-check.c --*/
-int signature_check( PKT_signature *sig, MD_HANDLE *digest );
+int signature_check( PKT_signature *sig, MD_HANDLE digest );
 
 /*-- seckey-cert.c --*/
-int check_secret_key( PKT_secret_cert *cert );
-int protect_secret_key( PKT_secret_cert *cert, DEK *dek );
+int is_secret_key_protected( PKT_secret_key *sk );
+int check_secret_key( PKT_secret_key *sk, int retries );
+int protect_secret_key( PKT_secret_key *sk, DEK *dek );
 
 /*-- pubkey-enc.c --*/
 int get_session_key( PKT_pubkey_enc *k, DEK *dek );
 
 /*-- compress.c --*/
-int handle_compressed( PKT_compressed *zd );
+int handle_compressed( void *ctx, PKT_compressed *cd,
+                      int (*callback)(IOBUF, void *), void *passthru );
 
 /*-- encr-data.c --*/
-int decrypt_data( PKT_encrypted *ed, DEK *dek );
+int decrypt_data( void *ctx, PKT_encrypted *ed, DEK *dek );
 int encrypt_data( PKT_encrypted *ed, DEK *dek );
 
 /*-- plaintext.c --*/
-int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx );
-int ask_for_detached_datafile( md_filter_context_t *mfx, const char *inname );
+int handle_plaintext( PKT_plaintext *pt, md_filter_context_t *mfx,
+                                       int nooutput, int clearsig );
+int ask_for_detached_datafile( MD_HANDLE md, MD_HANDLE md2,
+                              const char *inname, int textmode );
 
 /*-- comment.c --*/
 int write_comment( IOBUF out, const char *s );
 
 /*-- sign.c --*/
-int make_keysig_packet( PKT_signature **ret_sig, PKT_public_cert *pkc,
-                       PKT_user_id *uid, PKT_secret_cert *skc,
-                       int sigclass, int digest_algo );
+int make_keysig_packet( PKT_signature **ret_sig, PKT_public_key *pk,
+                       PKT_user_id *uid, PKT_public_key *subpk,
+                       PKT_secret_key *sk,
+                       int sigclass, int digest_algo,
+                       int (*mksubpkt)(PKT_signature *, void *),
+                       void *opaque  );
+
+/*-- keygen.c --*/
+PKT_user_id *generate_user_id(void);
 
 #endif /*G10_PACKET_H*/