New release
[gnupg.git] / include / cipher.h
1 /* cipher.h
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 #ifndef G10_CIPHER_H
21 #define G10_CIPHER_H
22
23 #define DBG_CIPHER g10c_debug_mode
24
25 #include "mpi.h"
26 #include "../cipher/random.h"
27
28
29 #define CIPHER_ALGO_NONE         0
30 #define CIPHER_ALGO_IDEA         1
31 #define CIPHER_ALGO_3DES         2
32 #define CIPHER_ALGO_CAST5        3
33 #define CIPHER_ALGO_BLOWFISH     4  /* blowfish 128 bit key */
34 #define CIPHER_ALGO_SAFER_SK128  5
35 #define CIPHER_ALGO_DES_SK       6
36 #define CIPHER_ALGO_BLOWFISH160 42  /* blowfish 160 bit key (not in OpenPGP)*/
37 #define CIPHER_ALGO_SKIPJACK   101  /* experimental: skipjack */
38 #define CIPHER_ALGO_TWOFISH    102  /* experimental: twofish 128 bit */
39 #define CIPHER_ALGO_DUMMY      110  /* no encryption at all */
40
41 #define PUBKEY_ALGO_RSA        1
42 #define PUBKEY_ALGO_RSA_E      2     /* RSA encrypt only */
43 #define PUBKEY_ALGO_RSA_S      3     /* RSA sign only */
44 #define PUBKEY_ALGO_ELGAMAL_E 16     /* encrypt only ElGamal (but not vor v3)*/
45 #define PUBKEY_ALGO_DSA       17
46 #define PUBKEY_ALGO_ELGAMAL   20     /* sign and encrypt elgamal */
47
48 #define PUBKEY_USAGE_SIG     1      /* key is good for signatures */
49 #define PUBKEY_USAGE_ENC     2      /* key is good for encryption */
50
51 #define DIGEST_ALGO_MD5       1
52 #define DIGEST_ALGO_SHA1      2
53 #define DIGEST_ALGO_RMD160    3
54 #define DIGEST_ALGO_TIGER     6
55
56 #define is_RSA(a)     ((a)==PUBKEY_ALGO_RSA || (a)==PUBKEY_ALGO_RSA_E \
57                        || (a)==PUBKEY_ALGO_RSA_S )
58 #define is_ELGAMAL(a) ((a)==PUBKEY_ALGO_ELGAMAL || (a)==PUBKEY_ALGO_ELGAMAL_E)
59
60 typedef struct {
61     int algo;
62     int keylen;
63     byte key[20]; /* this is the largest used keylen */
64 } DEK;
65
66 typedef struct cipher_handle_s *CIPHER_HANDLE;
67
68 #ifndef DEFINES_CIPHER_HANDLE
69 struct cipher_handle_s { char does_not_matter[1]; };
70 #endif
71
72 #define CIPHER_MODE_ECB       1
73 #define CIPHER_MODE_CFB       2
74 #define CIPHER_MODE_PHILS_CFB 3
75 #define CIPHER_MODE_AUTO_CFB  4
76 #define CIPHER_MODE_DUMMY     5  /* used with algo DUMMY for no encryption */
77
78
79 #define MD_BUFFER_SIZE 512
80
81 typedef struct {
82     byte buffer[MD_BUFFER_SIZE];
83     int  bufcount;
84     int  secure;
85     FILE  *debug;
86     struct md_digest_list_s *list;
87 } *MD_HANDLE;
88
89
90 #ifndef DEFINES_MD_HANDLE /* not really the handle but the algorithm list */
91 struct md_digest_list_s { char does_not_matter[1]; };
92 #endif
93
94
95
96 int g10c_debug_mode;
97 int g10_opt_verbose;
98
99 /*-- dynload.c --*/
100 void register_cipher_extension( const char *fname );
101
102 /*-- md.c --*/
103 int string_to_digest_algo( const char *string );
104 const char * digest_algo_to_string( int algo );
105 int check_digest_algo( int algo );
106 MD_HANDLE md_open( int algo, int secure );
107 void md_enable( MD_HANDLE hd, int algo );
108 MD_HANDLE md_copy( MD_HANDLE a );
109 void md_close(MD_HANDLE a);
110 void md_write( MD_HANDLE a, byte *inbuf, size_t inlen);
111 void md_final(MD_HANDLE a);
112 byte *md_read( MD_HANDLE a, int algo );
113 int md_get_algo( MD_HANDLE a );
114 int md_digest_length( int algo );
115 const byte *md_asn_oid( int algo, size_t *asnlen, size_t *mdlen );
116 void md_start_debug( MD_HANDLE a, const char *suffix );
117 void md_stop_debug( MD_HANDLE a );
118 #define md_is_secure(a) ((a)->secure)
119 #define md_putc(h,c)                                        \
120             do {                                            \
121                 if( (h)->bufcount == MD_BUFFER_SIZE )       \
122                     md_write( (h), NULL, 0 );               \
123                 (h)->buffer[(h)->bufcount++] = (c) & 0xff;  \
124             } while(0)
125 /*-- rmd160.c --*/
126 void rmd160_hash_buffer( char *outbuf, const char *buffer, size_t length );
127
128
129 /*-- cipher.c --*/
130 int string_to_cipher_algo( const char *string );
131 const char * cipher_algo_to_string( int algo );
132 int check_cipher_algo( int algo );
133 unsigned cipher_get_keylen( int algo );
134 unsigned cipher_get_blocksize( int algo );
135 CIPHER_HANDLE cipher_open( int algo, int mode, int secure );
136 void cipher_close( CIPHER_HANDLE c );
137 int  cipher_setkey( CIPHER_HANDLE c, byte *key, unsigned keylen );
138 void cipher_setiv( CIPHER_HANDLE c, const byte *iv );
139 void cipher_encrypt( CIPHER_HANDLE c, byte *out, byte *in, unsigned nbytes );
140 void cipher_decrypt( CIPHER_HANDLE c, byte *out, byte *in, unsigned nbytes );
141 void cipher_sync( CIPHER_HANDLE c );
142
143 /*-- pubkey.c --*/
144 #define PUBKEY_MAX_NPKEY  4
145 #define PUBKEY_MAX_NSKEY  6
146 #define PUBKEY_MAX_NSIG   2
147 #define PUBKEY_MAX_NENC   2
148
149 int string_to_pubkey_algo( const char *string );
150 const char * pubkey_algo_to_string( int algo );
151 int check_pubkey_algo( int algo );
152 int check_pubkey_algo2( int algo, unsigned usage );
153 int pubkey_get_npkey( int algo );
154 int pubkey_get_nskey( int algo );
155 int pubkey_get_nsig( int algo );
156 int pubkey_get_nenc( int algo );
157 unsigned pubkey_nbits( int algo, MPI *pkey );
158 int pubkey_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors );
159 int pubkey_check_secret_key( int algo, MPI *skey );
160 int pubkey_encrypt( int algo, MPI *resarr, MPI data, MPI *pkey );
161 int pubkey_decrypt( int algo, MPI *result, MPI *data, MPI *skey );
162 int pubkey_sign( int algo, MPI *resarr, MPI hash, MPI *skey );
163 int pubkey_verify( int algo, MPI hash, MPI *data, MPI *pkey,
164                       int (*cmp)(void *, MPI), void *opaque );
165
166 /*-- smallprime.c --*/
167 extern ushort small_prime_numbers[];
168
169 /*-- primegen.c --*/
170 MPI generate_secret_prime( unsigned nbits );
171 MPI generate_public_prime( unsigned nbits );
172 MPI generate_elg_prime( int mode, unsigned pbits, unsigned qbits,
173                                            MPI g, MPI **factors );
174
175
176 #endif /*G10_CIPHER_H*/