Add question "What are DH/DSS keys?"
[gnupg.git] / include / cipher.h
1 /* cipher.h - Definitions for OpenPGP
2  * Copyright (C) 1998, 1999, 2000, 2001, 2006,
3  *               2007, 2010  Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20 #ifndef G10_CIPHER_H
21 #define G10_CIPHER_H
22
23 #include <gcrypt.h>
24
25 /* Constants for OpenPGP. */
26
27 #define CIPHER_ALGO_NONE         /*  0 */  GCRY_CIPHER_NONE
28 #define CIPHER_ALGO_IDEA         /*  1 */  GCRY_CIPHER_IDEA
29 #define CIPHER_ALGO_3DES         /*  2 */  GCRY_CIPHER_3DES
30 #define CIPHER_ALGO_CAST5        /*  3 */  GCRY_CIPHER_CAST5
31 #define CIPHER_ALGO_BLOWFISH     /*  4 */  GCRY_CIPHER_BLOWFISH /* 128 bit */
32 /* 5 & 6 are reserved */
33 #define CIPHER_ALGO_AES          /*  7 */  GCRY_CIPHER_AES
34 #define CIPHER_ALGO_AES192       /*  8 */  GCRY_CIPHER_AES192
35 #define CIPHER_ALGO_AES256       /*  9 */  GCRY_CIPHER_AES256
36 #define CIPHER_ALGO_RIJNDAEL     CIPHER_ALGO_AES
37 #define CIPHER_ALGO_RIJNDAEL192  CIPHER_ALGO_AES192
38 #define CIPHER_ALGO_RIJNDAEL256  CIPHER_ALGO_AES256
39 #define CIPHER_ALGO_TWOFISH      /* 10 */  GCRY_CIPHER_TWOFISH  /* 256 bit */
40 /* Note: Camellia ids don't match those used by libgcrypt. */
41 #define CIPHER_ALGO_CAMELLIA128     11
42 #define CIPHER_ALGO_CAMELLIA192     12
43 #define CIPHER_ALGO_CAMELLIA256     13
44 #define CIPHER_ALGO_DUMMY          110    /* No encryption at all. */
45
46 #define PUBKEY_ALGO_RSA          /*  1 */ GCRY_PK_RSA
47 #define PUBKEY_ALGO_RSA_E        /*  2 */ GCRY_PK_RSA_E /* RSA encrypt only. */
48 #define PUBKEY_ALGO_RSA_S        /*  3 */ GCRY_PK_RSA_S /* RSA sign only.    */
49 #define PUBKEY_ALGO_ELGAMAL_E    /* 16 */ GCRY_PK_ELG_E /* Elgamal encr only */
50 #define PUBKEY_ALGO_DSA          /* 17 */ GCRY_PK_DSA
51 #define PUBKEY_ALGO_ECDH            18
52 #define PUBKEY_ALGO_ECDSA           19
53 #define PUBKEY_ALGO_ELGAMAL      /* 20 */ GCRY_PK_ELG   /* Elgamal encr+sign */
54
55 #define PUBKEY_USAGE_SIG     GCRY_PK_USAGE_SIGN  /* Good for signatures. */
56 #define PUBKEY_USAGE_ENC     GCRY_PK_USAGE_ENCR  /* Good for encryption. */
57 #define PUBKEY_USAGE_CERT    GCRY_PK_USAGE_CERT  /* Also good to certify keys. */
58 #define PUBKEY_USAGE_AUTH    GCRY_PK_USAGE_AUTH  /* Good for authentication. */
59 #define PUBKEY_USAGE_UNKNOWN GCRY_PK_USAGE_UNKN  /* Unknown usage flag. */
60
61 #define DIGEST_ALGO_MD5       /*  1 */ GCRY_MD_MD5
62 #define DIGEST_ALGO_SHA1      /*  2 */ GCRY_MD_SHA1
63 #define DIGEST_ALGO_RMD160    /*  3 */ GCRY_MD_RMD160
64 /* 4, 5, 6, and 7 are reserved */
65 #define DIGEST_ALGO_SHA256    /*  8 */ GCRY_MD_SHA256
66 #define DIGEST_ALGO_SHA384    /*  9 */ GCRY_MD_SHA384
67 #define DIGEST_ALGO_SHA512    /* 10 */ GCRY_MD_SHA512
68 /* SHA224 is only available in libgcrypt 1.4.0; thus we
69    can't use the GCRY macro here.  */
70 #define DIGEST_ALGO_SHA224    /* 11 */ 11 /* GCRY_MD_SHA224 */
71
72 #define COMPRESS_ALGO_NONE 0
73 #define COMPRESS_ALGO_ZIP  1
74 #define COMPRESS_ALGO_ZLIB 2
75 #define COMPRESS_ALGO_BZIP2  3
76
77 #define is_RSA(a)     ((a)==PUBKEY_ALGO_RSA || (a)==PUBKEY_ALGO_RSA_E \
78                        || (a)==PUBKEY_ALGO_RSA_S )
79 #define is_ELGAMAL(a) ((a)==PUBKEY_ALGO_ELGAMAL_E)
80 #define is_DSA(a)     ((a)==PUBKEY_ALGO_DSA)
81
82 /* The data encryption key object. */
83 typedef struct
84 {
85   int algo;
86   int keylen;
87   int algo_info_printed;
88   int use_mdc;
89   int symmetric;
90   byte key[32]; /* This is the largest used keylen (256 bit). */
91   char s2k_cacheid[1+16+1];
92 } DEK;
93
94
95
96 /* Constants to allocate static MPI arrays. */
97 #define PUBKEY_MAX_NPKEY  5
98 #define PUBKEY_MAX_NSKEY  7
99 #define PUBKEY_MAX_NSIG   2
100 #define PUBKEY_MAX_NENC   2
101
102 #endif /*G10_CIPHER_H*/