See ChangeLog: Sat May 22 22:47:26 CEST 1999 Werner Koch
[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_TWOFISH     10  /* twofish 256 bit */
37 #define CIPHER_ALGO_SKIPJACK   101  /* experimental: skipjack */
38 #define CIPHER_ALGO_TWOFISH_OLD 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 for 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[32]; /* this is the largest used keylen (256 bit) */
64 } DEK;
65
66 struct cipher_handle_s;
67 typedef struct cipher_handle_s *CIPHER_HANDLE;
68
69
70 #define CIPHER_MODE_ECB       1
71 #define CIPHER_MODE_CFB       2
72 #define CIPHER_MODE_PHILS_CFB 3
73 #define CIPHER_MODE_AUTO_CFB  4
74 #define CIPHER_MODE_DUMMY     5  /* used with algo DUMMY for no encryption */
75
76 struct md_digest_list_s;
77
78 typedef struct {
79     int  secure;
80     FILE  *debug;
81     struct md_digest_list_s *list;
82     int  bufcount;
83     int  bufsize;
84     byte buffer[1];
85 } *MD_HANDLE;
86
87
88 int g10c_debug_mode;
89 int g10_opt_verbose;
90 const char *g10_opt_homedir;
91
92 /*-- dynload.c --*/
93 void register_cipher_extension( const char *mainpgm, const char *fname );
94
95 /*-- md.c --*/
96 int string_to_digest_algo( const char *string );
97 const char * digest_algo_to_string( int algo );
98 int check_digest_algo( int algo );
99 MD_HANDLE md_open( int algo, int secure );
100 void md_enable( MD_HANDLE hd, int algo );
101 MD_HANDLE md_copy( MD_HANDLE a );
102 void md_reset( MD_HANDLE a );
103 void md_close(MD_HANDLE a);
104 void md_write( MD_HANDLE a, byte *inbuf, size_t inlen);
105 void md_final(MD_HANDLE a);
106 byte *md_read( MD_HANDLE a, int algo );
107 int md_digest( MD_HANDLE a, int algo, byte *buffer, int buflen );
108 int md_get_algo( MD_HANDLE a );
109 int md_digest_length( int algo );
110 const byte *md_asn_oid( int algo, size_t *asnlen, size_t *mdlen );
111 void md_start_debug( MD_HANDLE a, const char *suffix );
112 void md_stop_debug( MD_HANDLE a );
113 #define md_is_secure(a) ((a)->secure)
114 #define md_putc(h,c)  \
115             do {                                            \
116                 if( (h)->bufcount == (h)->bufsize )         \
117                     md_write( (h), NULL, 0 );               \
118                 (h)->buffer[(h)->bufcount++] = (c) & 0xff;  \
119             } while(0)
120 /*-- rmd160.c --*/
121 void rmd160_hash_buffer( char *outbuf, const char *buffer, size_t length );
122
123
124 /*-- cipher.c --*/
125 int string_to_cipher_algo( const char *string );
126 const char * cipher_algo_to_string( int algo );
127 int check_cipher_algo( int algo );
128 unsigned cipher_get_keylen( int algo );
129 unsigned cipher_get_blocksize( int algo );
130 CIPHER_HANDLE cipher_open( int algo, int mode, int secure );
131 void cipher_close( CIPHER_HANDLE c );
132 int  cipher_setkey( CIPHER_HANDLE c, byte *key, unsigned keylen );
133 void cipher_setiv( CIPHER_HANDLE c, const byte *iv, unsigned ivlen );
134 void cipher_encrypt( CIPHER_HANDLE c, byte *out, byte *in, unsigned nbytes );
135 void cipher_decrypt( CIPHER_HANDLE c, byte *out, byte *in, unsigned nbytes );
136 void cipher_sync( CIPHER_HANDLE c );
137
138 /*-- pubkey.c --*/
139 #define PUBKEY_MAX_NPKEY  4
140 #define PUBKEY_MAX_NSKEY  6
141 #define PUBKEY_MAX_NSIG   2
142 #define PUBKEY_MAX_NENC   2
143
144 int string_to_pubkey_algo( const char *string );
145 const char * pubkey_algo_to_string( int algo );
146 int check_pubkey_algo( int algo );
147 int check_pubkey_algo2( int algo, unsigned use );
148 int pubkey_get_npkey( int algo );
149 int pubkey_get_nskey( int algo );
150 int pubkey_get_nsig( int algo );
151 int pubkey_get_nenc( int algo );
152 unsigned pubkey_nbits( int algo, MPI *pkey );
153 int pubkey_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors );
154 int pubkey_check_secret_key( int algo, MPI *skey );
155 int pubkey_encrypt( int algo, MPI *resarr, MPI data, MPI *pkey );
156 int pubkey_decrypt( int algo, MPI *result, MPI *data, MPI *skey );
157 int pubkey_sign( int algo, MPI *resarr, MPI hash, MPI *skey );
158 int pubkey_verify( int algo, MPI hash, MPI *data, MPI *pkey,
159                       int (*cmp)(void *, MPI), void *opaque );
160
161 /*-- smallprime.c --*/
162 extern ushort small_prime_numbers[];
163
164 /*-- primegen.c --*/
165 MPI generate_secret_prime( unsigned nbits );
166 MPI generate_public_prime( unsigned nbits );
167 MPI generate_elg_prime( int mode, unsigned pbits, unsigned qbits,
168                                            MPI g, MPI **factors );
169
170
171 #endif /*G10_CIPHER_H*/