a9349c2f6f745f7c086369b2c5ca326cd18902d3
[gnupg.git] / include / cipher.h
1 /* cipher.h
2  *      Copyright (c) 1997 by Werner Koch (dd9jn)
3  *
4  * ATTENTION: This code should not be exported from the United States
5  * nor should it be used their without a license agreement with PKP.
6  * The RSA alorithm is protected by U.S. Patent #4,405,829 which
7  * expires on September 20, 2000!
8  *
9  * This file is part of G10.
10  *
11  * G10 is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * G10 is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
24  */
25 #ifndef G10_CIPHER_H
26 #define G10_CIPHER_H
27
28 #define DBG_CIPHER cipher_debug_mode
29
30 #include "mpi.h"
31 #include "../cipher/md.h"
32 #ifdef HAVE_RSA_CIPHER
33   #include "../cipher/rsa.h"
34 #endif
35 #include "../cipher/elgamal.h"
36 #include "../cipher/dsa.h"
37 #include "../cipher/random.h"
38
39
40 #define CIPHER_ALGO_NONE         0
41 #define CIPHER_ALGO_IDEA         1
42 #define CIPHER_ALGO_3DES         2
43 #define CIPHER_ALGO_CAST         3
44 #define CIPHER_ALGO_BLOWFISH     4  /* blowfish 128 bit key */
45 #define CIPHER_ALGO_SAFER_SK128  5
46 #define CIPHER_ALGO_DES_SK       6
47 #define CIPHER_ALGO_BLOWFISH160 42  /* blowfish 160 bit key (not in OpenPGP)*/
48 #define CIPHER_ALGO_DUMMY      110  /* no encryption at all */
49
50 #define PUBKEY_ALGO_RSA        1
51 #define PUBKEY_ALGO_RSA_E      2     /* RSA encrypt only */
52 #define PUBKEY_ALGO_RSA_S      3     /* RSA sign only */
53 #define PUBKEY_ALGO_ELGAMAL_E 16     /* encrypt only ElGamal (but not vor v3)*/
54 #define PUBKEY_ALGO_DSA       17
55 #define PUBKEY_ALGO_ELGAMAL   20     /* sign and encrypt elgamal */
56
57 #define DIGEST_ALGO_MD5       1
58 #define DIGEST_ALGO_SHA1      2
59 #define DIGEST_ALGO_RMD160    3
60 #ifdef WITH_TIGER_HASH
61 #define DIGEST_ALGO_TIGER     6
62 #endif
63
64 #define is_RSA(a)     ((a)==PUBKEY_ALGO_RSA || (a)==PUBKEY_ALGO_RSA_E \
65                        || (a)==PUBKEY_ALGO_RSA_S )
66 #define is_ELGAMAL(a) ((a)==PUBKEY_ALGO_ELGAMAL || (a)==PUBKEY_ALGO_ELGAMAL_E)
67
68 typedef struct {
69     int algo;
70     int keylen;
71     byte key[20]; /* this is the largest used keylen */
72 } DEK;
73
74 typedef struct cipher_handle_s *CIPHER_HANDLE;
75
76 #ifndef DEFINES_CIPHER_HANDLE
77 struct cipher_handle_s { char does_not_matter[1]; };
78 #endif
79
80 #define CIPHER_MODE_ECB       1
81 #define CIPHER_MODE_CFB       2
82 #define CIPHER_MODE_PHILS_CFB 3
83 #define CIPHER_MODE_AUTO_CFB  4
84 #define CIPHER_MODE_DUMMY     5  /* used with algo DUMMY for no encryption */
85
86
87 int cipher_debug_mode;
88
89 /*-- cipher.c --*/
90 int string_to_cipher_algo( const char *string );
91 const char * cipher_algo_to_string( int algo );
92 int check_cipher_algo( int algo );
93 unsigned cipher_get_keylen( int algo );
94 CIPHER_HANDLE cipher_open( int algo, int mode, int secure );
95 void cipher_close( CIPHER_HANDLE c );
96 void cipher_setkey( CIPHER_HANDLE c, byte *key, unsigned keylen );
97 void cipher_setiv( CIPHER_HANDLE c, const byte *iv );
98 void cipher_encrypt( CIPHER_HANDLE c, byte *out, byte *in, unsigned nbytes );
99 void cipher_decrypt( CIPHER_HANDLE c, byte *out, byte *in, unsigned nbytes );
100 void cipher_sync( CIPHER_HANDLE c );
101
102
103 /*-- misc.c --*/
104 int string_to_pubkey_algo( const char *string );
105 int string_to_digest_algo( const char *string );
106 const char * pubkey_algo_to_string( int algo );
107 const char * digest_algo_to_string( int algo );
108 int check_pubkey_algo( int algo );
109 int check_pubkey_algo2( int algo, unsigned usage );
110 int check_digest_algo( int algo );
111
112 /*-- smallprime.c --*/
113 extern ushort small_prime_numbers[];
114
115 /*-- primegen.c --*/
116 MPI generate_secret_prime( unsigned nbits );
117 MPI generate_public_prime( unsigned nbits );
118 MPI generate_elg_prime( int mode, unsigned pbits, unsigned qbits,
119                                            MPI g, MPI **factors );
120
121
122 #endif /*G10_CIPHER_H*/