lib/gnutls.h.in.in

   1 /*
   2  *      Copyright (C) 2000,2001,2002 Nikos Mavroyanopoulos
   3  *
   4  * This file is part of GNUTLS.
   5  *
   6  *  The GNUTLS library is free software; you can redistribute it and/or
   7  *  modify it under the terms of the GNU Lesser General Public
   8  *  License as published by the Free Software Foundation; either
   9  *  version 2.1 of the License, or (at your option) any later version.
  10  *
  11  *  This library 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 GNU
  14  *  Lesser General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU Lesser General Public
  17  *  License along with this library; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
  19  *
  20  */
  21
  22 #ifndef GNUTLS_H
  23 # define GNUTLS_H
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 #define LIBGNUTLS_VERSION "@VERSION@"
  30
  31 @DEFINE_SIZE_T@
  32 @DEFINE_TIME_T@
  33
  34 #define GNUTLS_CIPHER_AES_128_CBC GNUTLS_CIPHER_RIJNDAEL_128_CBC
  35 #define GNUTLS_CIPHER_AES_256_CBC GNUTLS_CIPHER_RIJNDAEL_256_CBC
  36 #define GNUTLS_CIPHER_RIJNDAEL_CBC GNUTLS_CIPHER_RIJNDAEL_128_CBC
  37
  38 typedef enum GNUTLS_BulkCipherAlgorithm { GNUTLS_CIPHER_NULL=1, GNUTLS_CIPHER_ARCFOUR, GNUTLS_CIPHER_3DES_CBC, GNUTLS_CIPHER_RIJNDAEL_128_CBC, GNUTLS_CIPHER_TWOFISH_128_CBC, GNUTLS_CIPHER_RIJNDAEL_256_CBC } GNUTLS_BulkCipherAlgorithm;
  39
  40 typedef enum GNUTLS_KXAlgorithm { GNUTLS_KX_RSA=1, GNUTLS_KX_DHE_DSS, GNUTLS_KX_DHE_RSA, GNUTLS_KX_ANON_DH, GNUTLS_KX_SRP } GNUTLS_KXAlgorithm;
  41
  42 typedef enum GNUTLS_CredType { GNUTLS_CRD_CERTIFICATE=1, GNUTLS_CRD_ANON, GNUTLS_CRD_SRP } GNUTLS_CredType;
  43
  44 typedef enum GNUTLS_MACAlgorithm { GNUTLS_MAC_NULL=1, GNUTLS_MAC_MD5, GNUTLS_MAC_SHA } GNUTLS_MACAlgorithm;
  45 typedef enum GNUTLS_DigestAlgorithm { GNUTLS_DIG_NULL=1, GNUTLS_DIG_MD5, GNUTLS_DIG_SHA } GNUTLS_DigestAlgorithm;
  46 typedef enum GNUTLS_CompressionMethod { GNUTLS_COMP_NULL=1, GNUTLS_COMP_ZLIB } GNUTLS_CompressionMethod;
  47 typedef enum GNUTLS_ConnectionEnd { GNUTLS_SERVER=1, GNUTLS_CLIENT } GNUTLS_ConnectionEnd;
  48 typedef enum GNUTLS_AlertLevel { GNUTLS_AL_WARNING=1, GNUTLS_AL_FATAL } GNUTLS_AlertLevel;
  49 typedef enum GNUTLS_AlertDescription { GNUTLS_A_CLOSE_NOTIFY, GNUTLS_A_UNEXPECTED_MESSAGE=10, GNUTLS_A_BAD_RECORD_MAC=20,
  50                         GNUTLS_A_DECRYPTION_FAILED, GNUTLS_A_RECORD_OVERFLOW,  GNUTLS_A_DECOMPRESSION_FAILURE=30,
  51                         GNUTLS_A_HANDSHAKE_FAILURE=40, GNUTLS_A_SSL3_NO_CERTIFICATE=41,
  52                         GNUTLS_A_BAD_CERTIFICATE=42, GNUTLS_A_UNSUPPORTED_CERTIFICATE,
  53                         GNUTLS_A_CERTIFICATE_REVOKED, GNUTLS_A_CERTIFICATE_EXPIRED, GNUTLS_A_CERTIFICATE_UNKNOWN,
  54                         GNUTLS_A_ILLEGAL_PARAMETER, GNUTLS_A_UNKNOWN_CA, GNUTLS_A_ACCESS_DENIED, GNUTLS_A_DECODE_ERROR=50,
  55                         GNUTLS_A_DECRYPT_ERROR, GNUTLS_A_EXPORT_RESTRICTION=60, GNUTLS_A_PROTOCOL_VERSION=70,
  56                         GNUTLS_A_INSUFFICIENT_SECURITY, GNUTLS_A_INTERNAL_ERROR=80, GNUTLS_A_USER_CANCELED=90,
  57                         GNUTLS_A_NO_RENEGOTIATION=100
  58 } GNUTLS_AlertDescription;
  59
  60 typedef enum GNUTLS_CertificateStatus {
  61         GNUTLS_CERT_NOT_TRUSTED=2,
  62         GNUTLS_CERT_INVALID=4,
  63         GNUTLS_CERT_CORRUPTED=16,
  64         GNUTLS_CERT_REVOKED=32
  65 } GNUTLS_CertificateStatus;
  66
  67 typedef enum GNUTLS_CertificateRequest { GNUTLS_CERT_IGNORE, GNUTLS_CERT_REQUEST=1, GNUTLS_CERT_REQUIRE } GNUTLS_CertificateRequest;
  68
  69 typedef enum GNUTLS_OpenPGPKeyStatus { GNUTLS_OPENPGP_KEY,
  70         GNUTLS_OPENPGP_KEY_FINGERPRINT
  71 } GNUTLS_OpenPGPKeyStatus;
  72
  73 typedef enum GNUTLS_CloseRequest { GNUTLS_SHUT_RDWR=0, GNUTLS_SHUT_WR=1 } GNUTLS_CloseRequest;
  74
  75 typedef enum GNUTLS_Version { GNUTLS_SSL3=1, GNUTLS_TLS1 } GNUTLS_Version;
  76
  77 typedef enum GNUTLS_CertificateType { GNUTLS_CRT_X509=1, GNUTLS_CRT_OPENPGP
  78 } GNUTLS_CertificateType;
  79
  80 typedef enum GNUTLS_X509_CertificateFmt { GNUTLS_X509_FMT_DER,
  81         GNUTLS_X509_FMT_PEM } GNUTLS_X509_CertificateFmt;
  82
  83 typedef enum GNUTLS_PKAlgorithm { GNUTLS_PK_RSA = 1, GNUTLS_PK_DSA
  84 } GNUTLS_PKAlgorithm;
  85
  86 /* If you want to change this, then also change the
  87  * define in gnutls_int.h, and recompile.
  88  */
  89 #define GNUTLS_TRANSPORT_PTR int
  90
  91 typedef const int* GNUTLS_LIST;
  92
  93 struct GNUTLS_STATE_INT;
  94 typedef struct GNUTLS_STATE_INT* GNUTLS_STATE;
  95
  96 struct GNUTLS_DH_PARAMS_INT;
  97 typedef struct GNUTLS_DH_PARAMS_INT* GNUTLS_DH_PARAMS;
  98
  99 typedef struct {
 100         unsigned char * data;
 101         int size;
 102 } gnutls_datum;
 103
 104 /* internal functions */
 105
 106 int gnutls_init(GNUTLS_STATE * state, GNUTLS_ConnectionEnd con_end);
 107 void gnutls_deinit(GNUTLS_STATE state);
 108 int gnutls_bye( GNUTLS_STATE state, GNUTLS_CloseRequest how);
 109 #define gnutls_close gnutls_bye
 110
 111 int gnutls_handshake( GNUTLS_STATE state);
 112 int gnutls_rehandshake( GNUTLS_STATE state);
 113
 114
 115 GNUTLS_AlertDescription gnutls_alert_get( GNUTLS_STATE state);
 116 int              gnutls_alert_send( GNUTLS_STATE, GNUTLS_AlertLevel, GNUTLS_AlertDescription);
 117 int              gnutls_alert_send_appropriate(  GNUTLS_STATE state, int err);
 118 const char*      gnutls_alert_get_name( int alert);
 119
 120 /* get information on the current state */
 121 GNUTLS_BulkCipherAlgorithm      gnutls_cipher_get( GNUTLS_STATE state);
 122 GNUTLS_KXAlgorithm              gnutls_kx_get( GNUTLS_STATE state);
 123 GNUTLS_MACAlgorithm             gnutls_mac_get( GNUTLS_STATE state);
 124 GNUTLS_CompressionMethod        gnutls_compression_get( GNUTLS_STATE state);
 125 GNUTLS_CertificateType          gnutls_cert_type_get( GNUTLS_STATE state);
 126
 127 /* the name of the specified algorithms */
 128 const char *gnutls_cipher_get_name( GNUTLS_BulkCipherAlgorithm);
 129 const char *gnutls_mac_get_name( GNUTLS_MACAlgorithm);
 130 const char *gnutls_compression_get_name( GNUTLS_CompressionMethod);
 131 const char *gnutls_kx_get_name( GNUTLS_KXAlgorithm algorithm);
 132 const char *gnutls_cert_type_get_name( GNUTLS_CertificateType type);
 133
 134
 135 /* error functions */
 136 int gnutls_error_is_fatal( int error);
 137
 138 void gnutls_perror( int error);
 139 const char* gnutls_strerror( int error);
 140
 141 void gnutls_record_set_cbc_protection(GNUTLS_STATE state, int prot);
 142 void gnutls_handshake_set_rsa_pms_check(GNUTLS_STATE state, int check);
 143 ssize_t gnutls_record_send( GNUTLS_STATE state, const void *data, size_t sizeofdata);
 144 ssize_t gnutls_record_recv( GNUTLS_STATE state, void *data, size_t sizeofdata);
 145 #define gnutls_read gnutls_record_recv
 146 #define gnutls_write gnutls_record_send
 147
 148 /* functions to set priority of cipher suites */
 149 int gnutls_cipher_set_priority( GNUTLS_STATE state, GNUTLS_LIST);
 150 int gnutls_mac_set_priority( GNUTLS_STATE state, GNUTLS_LIST);
 151 int gnutls_compression_set_priority( GNUTLS_STATE state, GNUTLS_LIST);
 152 int gnutls_kx_set_priority( GNUTLS_STATE state, GNUTLS_LIST);
 153 int gnutls_protocol_set_priority( GNUTLS_STATE state, GNUTLS_LIST);
 154 int gnutls_cert_type_set_priority( GNUTLS_STATE state, GNUTLS_LIST);
 155
 156 /* set our version - 0 for TLS 1.0 and 1 for SSL3 */
 157 GNUTLS_Version gnutls_protocol_get_version(GNUTLS_STATE state);
 158
 159 const char *gnutls_protocol_get_name(GNUTLS_Version version);
 160
 161
 162 /* get/set session
 163  */
 164 int gnutls_session_set_data( GNUTLS_STATE state, void* session, int session_size);
 165 int gnutls_session_get_data( GNUTLS_STATE state, void* session, int *session_size);
 166 /* returns the session ID */
 167 int gnutls_session_get_id( GNUTLS_STATE state, void* session, int *session_size);
 168
 169 /* checks if this session is a resumed one
 170  */
 171 int gnutls_session_is_resumed(GNUTLS_STATE state);
 172
 173 typedef int (*GNUTLS_DB_STORE_FUNC)(void*, gnutls_datum key, gnutls_datum data);
 174 typedef int (*GNUTLS_DB_REMOVE_FUNC)(void*, gnutls_datum key);
 175 typedef gnutls_datum (*GNUTLS_DB_RETR_FUNC)(void*, gnutls_datum key);
 176
 177 void gnutls_db_set_cache_expiration( GNUTLS_STATE state, int seconds);
 178
 179 int  gnutls_db_set_name( GNUTLS_STATE state, const char* filename);
 180 int  gnutls_db_clean( GNUTLS_STATE state);
 181 void  gnutls_db_remove_session( GNUTLS_STATE state);
 182 void gnutls_db_set_retrieve_func( GNUTLS_STATE, GNUTLS_DB_RETR_FUNC);
 183 void gnutls_db_set_remove_func( GNUTLS_STATE, GNUTLS_DB_REMOVE_FUNC);
 184 void gnutls_db_set_store_func( GNUTLS_STATE, GNUTLS_DB_STORE_FUNC);
 185 void gnutls_db_set_ptr( GNUTLS_STATE, void* db_ptr);
 186 void* gnutls_db_get_ptr( GNUTLS_STATE);
 187 int  gnutls_db_check_entry( GNUTLS_STATE state, gnutls_datum session_entry);
 188
 189 void gnutls_handshake_set_max_length( GNUTLS_STATE state, int max);
 190
 191 /* returns libgnutls version */
 192 const char* gnutls_check_version( const char*);
 193
 194 /* Functions for setting/clearing credentials */
 195 int gnutls_clear_creds( GNUTLS_STATE state);
 196 /* cred is a structure defined by the kx algorithm */
 197 int gnutls_cred_set( GNUTLS_STATE, GNUTLS_CredType type, void* cred);
 198
 199 /* Credential structures for SRP - used in gnutls_set_cred(); */
 200
 201 struct DSTRUCT;
 202 typedef struct DSTRUCT* GNUTLS_CERTIFICATE_CREDENTIALS;
 203 typedef GNUTLS_CERTIFICATE_CREDENTIALS GNUTLS_CERTIFICATE_CLIENT_CREDENTIALS;
 204 typedef GNUTLS_CERTIFICATE_CREDENTIALS GNUTLS_CERTIFICATE_SERVER_CREDENTIALS;
 205
 206 typedef struct DSTRUCT* GNUTLS_ANON_SERVER_CREDENTIALS;
 207 typedef struct DSTRUCT* GNUTLS_ANON_CLIENT_CREDENTIALS;
 208
 209 void gnutls_anon_free_server_sc( GNUTLS_ANON_SERVER_CREDENTIALS sc);
 210 int gnutls_anon_allocate_server_sc( GNUTLS_ANON_SERVER_CREDENTIALS *sc);
 211 int gnutls_anon_set_server_cred( GNUTLS_ANON_SERVER_CREDENTIALS res);
 212 void gnutls_anon_set_server_dh_params( GNUTLS_ANON_SERVER_CREDENTIALS res, GNUTLS_DH_PARAMS);
 213
 214 void gnutls_anon_free_client_sc( GNUTLS_ANON_SERVER_CREDENTIALS sc);
 215 int gnutls_anon_allocate_client_sc( GNUTLS_ANON_SERVER_CREDENTIALS *sc);
 216 int gnutls_anon_set_client_cred( GNUTLS_ANON_SERVER_CREDENTIALS res);
 217
 218
 219 /* CERTFILE is an x509 certificate in PEM form.
 220  * KEYFILE is a pkcs-1 private key in PEM form (for RSA keys).
 221  */
 222 void gnutls_certificate_free_sc( GNUTLS_CERTIFICATE_CREDENTIALS sc);
 223 int gnutls_certificate_allocate_sc( GNUTLS_CERTIFICATE_CREDENTIALS *sc);
 224
 225 int gnutls_certificate_set_dh_params(GNUTLS_CERTIFICATE_CREDENTIALS res, GNUTLS_DH_PARAMS);
 226
 227 int gnutls_certificate_set_x509_trust_file( GNUTLS_CERTIFICATE_CREDENTIALS res, char* CAFILE,
 228         GNUTLS_X509_CertificateFmt);
 229 int gnutls_certificate_set_x509_trust_mem(GNUTLS_CERTIFICATE_CREDENTIALS res,
 230         const gnutls_datum *CA, GNUTLS_X509_CertificateFmt);
 231
 232 int gnutls_certificate_set_x509_key_file( GNUTLS_CERTIFICATE_CREDENTIALS res,
 233         char *CERTFILE, char* KEYFILE, GNUTLS_X509_CertificateFmt);
 234 int gnutls_certificate_set_x509_key_mem(GNUTLS_CERTIFICATE_CREDENTIALS res,
 235         const gnutls_datum* CERT, const gnutls_datum* KEY,
 236         GNUTLS_X509_CertificateFmt);
 237
 238 /* global state functions
 239  */
 240 /* In this version global_init accepts two files (pkix.asn, pkcs1.asn).
 241  * This will not be the case in the final version. These files
 242  * are located in the src/ directory of gnutls distribution.
 243  */
 244 int gnutls_global_init(void);
 245 void gnutls_global_deinit(void);
 246
 247 void gnutls_global_set_mem_func(
 248         void *(*gnutls_alloc_func)(size_t), void* (*gnutls_secure_alloc_func)(size_t),
 249         int (*gnutls_is_secure_func)(const void*), void *(*gnutls_realloc_func)(void *, size_t),
 250         void (*gnutls_free_func)(void*));
 251
 252 typedef void (*GNUTLS_LOG_FUNC)( const char*);
 253 void gnutls_global_set_log_func( GNUTLS_LOG_FUNC log_func);
 254
 255 int gnutls_dh_params_set( GNUTLS_DH_PARAMS, gnutls_datum prime, gnutls_datum generator, int bits);
 256 int gnutls_dh_params_init( GNUTLS_DH_PARAMS*);
 257 void gnutls_dh_params_deinit( GNUTLS_DH_PARAMS);
 258 int gnutls_dh_params_generate( gnutls_datum* prime, gnutls_datum* generator, int bits);
 259
 260 typedef ssize_t (*GNUTLS_PULL_FUNC)(GNUTLS_TRANSPORT_PTR, void*, size_t);
 261 typedef ssize_t (*GNUTLS_PUSH_FUNC)(GNUTLS_TRANSPORT_PTR, const void*, size_t);
 262 void gnutls_transport_set_ptr(GNUTLS_STATE state, GNUTLS_TRANSPORT_PTR ptr);
 263 GNUTLS_TRANSPORT_PTR gnutls_transport_get_ptr(GNUTLS_STATE state);
 264
 265 void gnutls_transport_set_lowat( GNUTLS_STATE state, int num);
 266
 267
 268 void gnutls_transport_set_push_func( GNUTLS_STATE, GNUTLS_PUSH_FUNC push_func);
 269 void gnutls_transport_set_pull_func( GNUTLS_STATE, GNUTLS_PULL_FUNC pull_func);
 270
 271 /* state specific */
 272 void gnutls_state_set_ptr(GNUTLS_STATE state, void* ptr);
 273 void* gnutls_state_get_ptr(GNUTLS_STATE state);
 274
 275 /* record layer */
 276 size_t gnutls_record_get_max_size( GNUTLS_STATE state);
 277 ssize_t gnutls_record_set_max_size( GNUTLS_STATE state, size_t size);
 278
 279 size_t gnutls_record_check_pending(GNUTLS_STATE state);
 280
 281 void gnutls_openpgp_send_key(GNUTLS_STATE state, GNUTLS_OpenPGPKeyStatus status);
 282
 283 int gnutls_x509_fingerprint(GNUTLS_DigestAlgorithm algo, const gnutls_datum* data, char* result, size_t* result_size);