path: root/lib/gnutls.h.in.in

/* -*- c -*-
 * Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation
 *
 * Author: Nikos Mavroyanopoulos
 *
 * This file is part of GNUTLS.
 *
 * The GNUTLS library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 *
 */

/* This file contains the types and prototypes for all the
 * high level functionality of gnutls main library. For the
 * extra functionality (which is under the GNU GPL license) check
 * the gnutls/extra.h header. The openssl compatibility layer is
 * in gnutls/openssl.h.
 *
 * The low level cipher functionality is in libgcrypt. Check
 * gcrypt.h
 */


#ifndef GNUTLS_H
# define GNUTLS_H

#ifdef __cplusplus
extern "C" {
#endif

#define LIBGNUTLS_VERSION "@VERSION@"

/* Get size_t. */
#include <stddef.h>

/* Get ssize_t. */
#ifndef HAVE_SSIZE_T
# define HAVE_SSIZE_T
@DEFINE_SSIZE_T@
#endif

/* Get time_t. */
#include <time.h>

#include <gnutls/compat.h>

#define GNUTLS_CIPHER_RIJNDAEL_128_CBC GNUTLS_CIPHER_AES_128_CBC
#define GNUTLS_CIPHER_RIJNDAEL_256_CBC GNUTLS_CIPHER_AES_256_CBC
#define GNUTLS_CIPHER_RIJNDAEL_CBC GNUTLS_CIPHER_AES_128_CBC
#define GNUTLS_CIPHER_ARCFOUR GNUTLS_CIPHER_ARCFOUR_128

typedef enum gnutls_cipher_algorithm { GNUTLS_CIPHER_NULL = 1,
    GNUTLS_CIPHER_ARCFOUR_128, GNUTLS_CIPHER_3DES_CBC,
    GNUTLS_CIPHER_AES_128_CBC, GNUTLS_CIPHER_AES_256_CBC,
    GNUTLS_CIPHER_ARCFOUR_40,
    GNUTLS_CIPHER_RC2_40_CBC = 90, GNUTLS_CIPHER_DES_CBC
} gnutls_cipher_algorithm_t;

typedef enum { GNUTLS_KX_RSA=1, GNUTLS_KX_DHE_DSS, 
    GNUTLS_KX_DHE_RSA, GNUTLS_KX_ANON_DH, GNUTLS_KX_SRP,
    GNUTLS_KX_RSA_EXPORT, GNUTLS_KX_SRP_RSA, GNUTLS_KX_SRP_DSS
} gnutls_kx_algorithm_t;

typedef enum { GNUTLS_PARAMS_RSA_EXPORT=1,
    GNUTLS_PARAMS_DH 
} gnutls_params_type_t;

typedef enum { GNUTLS_CRD_CERTIFICATE=1, GNUTLS_CRD_ANON, GNUTLS_CRD_SRP } gnutls_credentials_type_t;

#define GNUTLS_MAC_SHA GNUTLS_MAC_SHA1
#define GNUTLS_DIG_SHA GNUTLS_DIG_SHA1
typedef enum {
  GNUTLS_MAC_UNKNOWN = 0,
  GNUTLS_MAC_NULL = 1,
  GNUTLS_MAC_MD5,
  GNUTLS_MAC_SHA1,
  GNUTLS_MAC_RMD160
} gnutls_mac_algorithm_t;

/* The enumerations here should have the same value with gnutls_mac_algorithm_t.
 */
typedef enum { GNUTLS_DIG_NULL=1, GNUTLS_DIG_MD5, 
    GNUTLS_DIG_SHA1, GNUTLS_DIG_RMD160 
} gnutls_digest_algorithm_t;

/* exported for other gnutls headers. This is the maximum number
 * of algorithms (ciphers, kx or macs). 
 */
#define GNUTLS_MAX_ALGORITHM_NUM 16

#define GNUTLS_COMP_ZLIB GNUTLS_COMP_DEFLATE
typedef enum { GNUTLS_COMP_NULL=1, 
    GNUTLS_COMP_DEFLATE, 
    GNUTLS_COMP_LZO /* only available if gnutls-extra has been initialized 
                         */
} gnutls_compression_method_t;

typedef enum { GNUTLS_SERVER=1, GNUTLS_CLIENT } gnutls_connection_end_t;

typedef enum { GNUTLS_AL_WARNING=1, GNUTLS_AL_FATAL } gnutls_alert_level_t;

typedef enum { GNUTLS_A_CLOSE_NOTIFY, 
    GNUTLS_A_UNEXPECTED_MESSAGE=10, GNUTLS_A_BAD_RECORD_MAC=20,
    GNUTLS_A_DECRYPTION_FAILED, GNUTLS_A_RECORD_OVERFLOW, GNUTLS_A_DECOMPRESSION_FAILURE=30,
    GNUTLS_A_HANDSHAKE_FAILURE=40, GNUTLS_A_SSL3_NO_CERTIFICATE=41,
    GNUTLS_A_BAD_CERTIFICATE=42, GNUTLS_A_UNSUPPORTED_CERTIFICATE,
    GNUTLS_A_CERTIFICATE_REVOKED, GNUTLS_A_CERTIFICATE_EXPIRED, GNUTLS_A_CERTIFICATE_UNKNOWN,
    GNUTLS_A_ILLEGAL_PARAMETER, GNUTLS_A_UNKNOWN_CA, GNUTLS_A_ACCESS_DENIED, GNUTLS_A_DECODE_ERROR=50,
    GNUTLS_A_DECRYPT_ERROR, GNUTLS_A_EXPORT_RESTRICTION=60, GNUTLS_A_PROTOCOL_VERSION=70,
    GNUTLS_A_INSUFFICIENT_SECURITY, GNUTLS_A_INTERNAL_ERROR=80, GNUTLS_A_USER_CANCELED=90,
    GNUTLS_A_NO_RENEGOTIATION=100, GNUTLS_A_UNSUPPORTED_EXTENSION=110,
    GNUTLS_A_CERTIFICATE_UNOBTAINABLE=111, GNUTLS_A_UNRECOGNIZED_NAME=112,
    GNUTLS_A_UNKNOWN_SRP_USERNAME=120, GNUTLS_A_MISSING_SRP_USERNAME=121
} gnutls_alert_description_t;

typedef enum { GNUTLS_HANDSHAKE_HELLO_REQUEST, 
    GNUTLS_HANDSHAKE_CLIENT_HELLO, GNUTLS_HANDSHAKE_SERVER_HELLO,
    GNUTLS_HANDSHAKE_CERTIFICATE_PKT=11, GNUTLS_HANDSHAKE_SERVER_KEY_EXCHANGE,
    GNUTLS_HANDSHAKE_CERTIFICATE_REQUEST, GNUTLS_HANDSHAKE_SERVER_HELLO_DONE,
    GNUTLS_HANDSHAKE_CERTIFICATE_VERIFY, GNUTLS_HANDSHAKE_CLIENT_KEY_EXCHANGE,
    GNUTLS_HANDSHAKE_FINISHED=20 
} gnutls_handshake_description_t;

/* Note that the status bits have different meanings
 * in openpgp keys and x.509 certificate verification.
 */
typedef enum { 
    GNUTLS_CERT_INVALID=2, /* will be set if the certificate
                * was not verified.
                */
    GNUTLS_CERT_REVOKED=32, /* in X.509 this will be set only if CRLs are checked
                 */

    /* Those are extra information about the verification
     * process. Will be set only if the certificate was 
     * not verified.
     */
    GNUTLS_CERT_SIGNER_NOT_FOUND=64,
    GNUTLS_CERT_SIGNER_NOT_CA=128
} gnutls_certificate_status_t;

typedef enum { GNUTLS_CERT_IGNORE, GNUTLS_CERT_REQUEST=1, GNUTLS_CERT_REQUIRE } gnutls_certificate_request_t;

typedef enum { GNUTLS_OPENPGP_KEY, 
    GNUTLS_OPENPGP_KEY_FINGERPRINT
} gnutls_openpgp_key_status_t;

typedef enum { GNUTLS_SHUT_RDWR=0, GNUTLS_SHUT_WR=1 } gnutls_close_request_t;

#define GNUTLS_TLS1 GNUTLS_TLS1_0
typedef enum  {
  GNUTLS_SSL3 = 1,
  GNUTLS_TLS1_0,
  GNUTLS_TLS1_1,
  GNUTLS_VERSION_UNKNOWN = 0xff
} gnutls_protocol_t;

typedef enum { GNUTLS_CRT_X509=1, GNUTLS_CRT_OPENPGP 
} gnutls_certificate_type_t;

typedef enum { GNUTLS_X509_FMT_DER, 
    GNUTLS_X509_FMT_PEM } gnutls_x509_crt_fmt_t;

typedef enum { GNUTLS_PK_UNKNOWN=0, GNUTLS_PK_RSA = 1, GNUTLS_PK_DSA
} gnutls_pk_algorithm_t;

const char *gnutls_pk_algorithm_get_name( gnutls_pk_algorithm_t algorithm);

#define GNUTLS_SIGN_RSA_SHA GNUTLS_SIGN_RSA_SHA1
#define GNUTLS_SIGN_DSA_SHA GNUTLS_SIGN_DSA_SHA1
typedef enum { GNUTLS_SIGN_UNKNOWN=0, GNUTLS_SIGN_RSA_SHA1 = 1, GNUTLS_SIGN_DSA_SHA1,
    GNUTLS_SIGN_RSA_MD5, GNUTLS_SIGN_RSA_MD2, GNUTLS_SIGN_RSA_RMD160
} gnutls_sign_algorithm_t;

const char *gnutls_sign_algorithm_get_name( gnutls_sign_algorithm_t algorithm);

/* If you want to change this, then also change the 
 * define in gnutls_int.h, and recompile.
 */
typedef void * gnutls_transport_ptr_t;

struct gnutls_session_int;
typedef struct gnutls_session_int* gnutls_session_t;

struct gnutls_dh_params_int;
typedef struct gnutls_dh_params_int* gnutls_dh_params_t;

struct gnutls_x509_privkey_int; /* XXX ugly. */
typedef struct gnutls_x509_privkey_int* gnutls_rsa_params_t; /* XXX ugly. */

typedef struct {
    unsigned char * data;
    unsigned int size;
} gnutls_datum_t;


/* internal functions */

int gnutls_init(gnutls_session_t * session, gnutls_connection_end_t con_end);
void gnutls_deinit(gnutls_session_t session);
#define _gnutls_deinit(x) gnutls_deinit(x)

int gnutls_bye( gnutls_session_t session, gnutls_close_request_t how);

int gnutls_handshake( gnutls_session_t session);
int gnutls_rehandshake( gnutls_session_t session);

gnutls_alert_description_t gnutls_alert_get( gnutls_session_t session);
int gnutls_alert_send( gnutls_session_t session,
		       gnutls_alert_level_t level,
		       gnutls_alert_description_t desc);
int gnutls_alert_send_appropriate(  gnutls_session_t session, int err);
const char*  gnutls_alert_get_name( gnutls_alert_description_t alert);

/* get information on the current session */
gnutls_cipher_algorithm_t     gnutls_cipher_get( gnutls_session_t session);
gnutls_kx_algorithm_t         gnutls_kx_get( gnutls_session_t session);
gnutls_mac_algorithm_t        gnutls_mac_get( gnutls_session_t session);
gnutls_compression_method_t   gnutls_compression_get( gnutls_session_t session);
gnutls_certificate_type_t     gnutls_certificate_type_get( gnutls_session_t session);

size_t gnutls_cipher_get_key_size( gnutls_cipher_algorithm_t algorithm);

/* the name of the specified algorithms */
const char *gnutls_cipher_get_name( gnutls_cipher_algorithm_t algorithm);
const char *gnutls_mac_get_name( gnutls_mac_algorithm_t algorithm);
const char *gnutls_compression_get_name( gnutls_compression_method_t algorithm);
const char *gnutls_kx_get_name( gnutls_kx_algorithm_t algorithm);
const char *gnutls_certificate_type_get_name( gnutls_certificate_type_t type);


/* error functions */
int gnutls_error_is_fatal( int error);
int gnutls_error_to_alert( int err, int* level);

void gnutls_perror( int error);
const char* gnutls_strerror( int error);

/* Semi-internal functions.
 */
void gnutls_handshake_set_private_extensions(gnutls_session_t session, int allow);
gnutls_handshake_description_t gnutls_handshake_get_last_out( gnutls_session_t session);
gnutls_handshake_description_t gnutls_handshake_get_last_in( gnutls_session_t session);

/* Record layer functions.
 */
ssize_t gnutls_record_send( gnutls_session_t session, const void *data, size_t sizeofdata);
ssize_t gnutls_record_recv( gnutls_session_t session, void *data, size_t sizeofdata);
#define gnutls_read gnutls_record_recv
#define gnutls_write gnutls_record_send

int gnutls_record_get_direction(gnutls_session_t session);

size_t gnutls_record_get_max_size( gnutls_session_t session);
ssize_t gnutls_record_set_max_size( gnutls_session_t session, size_t size);

size_t gnutls_record_check_pending(gnutls_session_t session);

/* TLS Extensions */

typedef enum { GNUTLS_NAME_DNS=1 
} gnutls_server_name_type_t;

int gnutls_server_name_set(gnutls_session_t session,
    gnutls_server_name_type_t type,
    const void *name, size_t name_length);

int gnutls_server_name_get(gnutls_session_t session, 
    void *data, size_t *data_length,
    unsigned int * type, unsigned int indx);

/* functions to set priority of cipher suites 
 */
int gnutls_cipher_set_priority( gnutls_session_t session, const int *list);
int gnutls_mac_set_priority( gnutls_session_t session, const int *list);
int gnutls_compression_set_priority( gnutls_session_t session, const int *list);
int gnutls_kx_set_priority( gnutls_session_t session, const int *list);
int gnutls_protocol_set_priority( gnutls_session_t session, const int*list);
int gnutls_certificate_type_set_priority( gnutls_session_t session,
					  const int *list);

/* if you just want some defaults, use the following.
 */
int gnutls_set_default_priority(gnutls_session_t session);
int gnutls_set_default_export_priority(gnutls_session_t session);

/* Returns the name of a cipher suite */
const char *gnutls_cipher_suite_get_name(gnutls_kx_algorithm_t kx_algorithm,
    gnutls_cipher_algorithm_t cipher_algorithm, gnutls_mac_algorithm_t mac_algorithm);

/* get the currently used protocol version */
gnutls_protocol_t gnutls_protocol_get_version(gnutls_session_t session);

const char *gnutls_protocol_get_name(gnutls_protocol_t version);


/* get/set session 
 */
int gnutls_session_set_data( gnutls_session_t session, const void* session_data, size_t session_data_size);
int gnutls_session_get_data( gnutls_session_t session, void* session_data, size_t *session_data_size);
/* returns the session ID */
#define GNUTLS_MAX_SESSION_ID 32
int gnutls_session_get_id( gnutls_session_t session, void* session_id, size_t *session_id_size);

/* checks if this session is a resumed one 
 */
int gnutls_session_is_resumed(gnutls_session_t session);

typedef int (*gnutls_db_store_func)(void*, gnutls_datum_t key, gnutls_datum_t data);
typedef int (*gnutls_db_remove_func)(void*, gnutls_datum_t key);
typedef gnutls_datum_t (*gnutls_db_retr_func)(void*, gnutls_datum_t key);

void gnutls_db_set_cache_expiration( gnutls_session_t session, int seconds);

void gnutls_db_remove_session( gnutls_session_t session);
void gnutls_db_set_retrieve_function( gnutls_session_t session, gnutls_db_retr_func retr_func);
void gnutls_db_set_remove_function( gnutls_session_t session, gnutls_db_remove_func rem_func);
void gnutls_db_set_store_function( gnutls_session_t session, gnutls_db_store_func store_func);
void gnutls_db_set_ptr( gnutls_session_t session, void* ptr);
void* gnutls_db_get_ptr( gnutls_session_t session);
int  gnutls_db_check_entry( gnutls_session_t session, gnutls_datum_t session_entry);

void gnutls_handshake_set_max_packet_length( gnutls_session_t session, int max);

/* returns libgnutls version (call it with a NULL argument)
 */
const char* gnutls_check_version( const char *req_version);

/* Functions for setting/clearing credentials
 */
void gnutls_credentials_clear( gnutls_session_t session);

/* cred is a structure defined by the kx algorithm
 */
int gnutls_credentials_set( gnutls_session_t session,
			    gnutls_credentials_type_t type,
			    void* cred);
#define gnutls_cred_set	gnutls_credentials_set

/* Credential structures for SRP - used in gnutls_credentials_set(); */

struct gnutls_certificate_credentials_st;
typedef struct gnutls_certificate_credentials_st *gnutls_certificate_credentials_t;
typedef gnutls_certificate_credentials_t gnutls_certificate_server_credentials;
typedef gnutls_certificate_credentials_t gnutls_certificate_client_credentials;

typedef struct gnutls_anon_server_credentials_st* gnutls_anon_server_credentials_t;
typedef struct gnutls_anon_client_credentials_st* gnutls_anon_client_credentials_t;

void gnutls_anon_free_server_credentials( gnutls_anon_server_credentials_t sc);
int gnutls_anon_allocate_server_credentials( gnutls_anon_server_credentials_t *sc);

void gnutls_anon_set_server_dh_params( gnutls_anon_server_credentials_t res, gnutls_dh_params_t dh_params);

void gnutls_anon_free_client_credentials( gnutls_anon_client_credentials_t sc);
int gnutls_anon_allocate_client_credentials( gnutls_anon_client_credentials_t *sc);

/* CERTFILE is an x509 certificate in PEM form.
 * KEYFILE is a pkcs-1 private key in PEM form (for RSA keys).
 */
void gnutls_certificate_free_credentials( gnutls_certificate_credentials_t sc);
int gnutls_certificate_allocate_credentials( gnutls_certificate_credentials_t *res);

void gnutls_certificate_free_keys(gnutls_certificate_credentials_t sc);
void gnutls_certificate_free_cas(gnutls_certificate_credentials_t sc);
void gnutls_certificate_free_ca_names(gnutls_certificate_credentials_t sc);
void gnutls_certificate_free_crls(gnutls_certificate_credentials_t sc);

void gnutls_certificate_set_dh_params(gnutls_certificate_credentials_t res,
				      gnutls_dh_params_t dh_params);
void gnutls_certificate_set_rsa_export_params(gnutls_certificate_credentials_t res, gnutls_rsa_params_t rsa_params);
void gnutls_certificate_set_verify_flags(gnutls_certificate_credentials_t res, unsigned int flags);
void gnutls_certificate_set_verify_limits(gnutls_certificate_credentials_t res, unsigned int max_bits,
    unsigned int max_depth);

int gnutls_certificate_set_x509_trust_file( gnutls_certificate_credentials_t res, const char* CAFILE, 
    gnutls_x509_crt_fmt_t type);
int gnutls_certificate_set_x509_trust_mem(gnutls_certificate_credentials_t res, 
    const gnutls_datum_t *CA, gnutls_x509_crt_fmt_t type);

int gnutls_certificate_set_x509_crl_file(gnutls_certificate_credentials_t res, 
    const char *crlfile, gnutls_x509_crt_fmt_t type);
int gnutls_certificate_set_x509_crl_mem(gnutls_certificate_credentials_t res, 
    const gnutls_datum_t *CRL, gnutls_x509_crt_fmt_t type);

int gnutls_certificate_set_x509_key_file( gnutls_certificate_credentials_t res, 
    const char *CERTFILE, const char* KEYFILE, gnutls_x509_crt_fmt_t type);
int gnutls_certificate_set_x509_key_mem(gnutls_certificate_credentials_t res, 
    const gnutls_datum_t* CERT, const gnutls_datum_t* KEY,
    gnutls_x509_crt_fmt_t type);


/* New functions to allow setting already parsed X.509 stuff.
 */
struct gnutls_x509_privkey_int;
typedef struct gnutls_x509_privkey_int* gnutls_x509_privkey_t;

struct gnutls_x509_crl_int;
typedef struct gnutls_x509_crl_int* gnutls_x509_crl_t;

struct gnutls_x509_crt_int;
typedef struct gnutls_x509_crt_int* gnutls_x509_crt_t;

int gnutls_certificate_set_x509_key(gnutls_certificate_credentials_t res, 
    gnutls_x509_crt_t *cert_list, int cert_list_size,
    gnutls_x509_privkey_t key);
int gnutls_certificate_set_x509_trust(gnutls_certificate_credentials_t res, 
    gnutls_x509_crt_t * ca_list, int ca_list_size);
int gnutls_certificate_set_x509_crl(gnutls_certificate_credentials_t res, 
    gnutls_x509_crl_t* crl_list, int crl_list_size);


/* global state functions
 */
int gnutls_global_init(void);
void gnutls_global_deinit(void);

typedef void* (*gnutls_alloc_function)(size_t);
typedef void* (*gnutls_calloc_function)(size_t, size_t);
typedef int (*gnutls_is_secure_function)(const void*);
typedef void (*gnutls_free_function)(void*);
typedef void* (*gnutls_realloc_function)(void*, size_t);

extern void
gnutls_global_set_mem_functions(gnutls_alloc_function alloc_func,
				gnutls_alloc_function secure_alloc_func,
				gnutls_is_secure_function is_secure_func,
				gnutls_realloc_function realloc_func,
				gnutls_free_function free_func);

/* For use in callbacks */
extern gnutls_alloc_function gnutls_malloc;
extern gnutls_alloc_function gnutls_secure_malloc;
extern gnutls_realloc_function gnutls_realloc;
extern gnutls_calloc_function gnutls_calloc;
extern gnutls_free_function gnutls_free;

extern void *(*gnutls_calloc) (size_t, size_t);
extern char* (*gnutls_strdup)( const char*);

typedef void (*gnutls_log_func)( int, const char*);
void gnutls_global_set_log_function( gnutls_log_func log_func);
void gnutls_global_set_log_level( int level);

/* Diffie Hellman parameter handling.
 */
int gnutls_dh_params_init( gnutls_dh_params_t *dh_params);
void gnutls_dh_params_deinit( gnutls_dh_params_t dh_params);
int gnutls_dh_params_import_raw(gnutls_dh_params_t dh_params,
				const gnutls_datum_t *prime,
				const gnutls_datum_t* generator);
int gnutls_dh_params_import_pkcs3(gnutls_dh_params_t params,
    const gnutls_datum_t * pkcs3_params, gnutls_x509_crt_fmt_t format);
int gnutls_dh_params_generate2(gnutls_dh_params_t params, unsigned int bits);
int gnutls_dh_params_export_pkcs3( gnutls_dh_params_t params,
    gnutls_x509_crt_fmt_t format, unsigned char* params_data, size_t* params_data_size);
int gnutls_dh_params_export_raw(gnutls_dh_params_t params,
    gnutls_datum_t * prime, gnutls_datum_t * generator, unsigned int *bits);
int gnutls_dh_params_cpy(gnutls_dh_params_t dst, gnutls_dh_params_t src);


/* RSA params 
 */
int gnutls_rsa_params_init(gnutls_rsa_params_t * rsa_params);
void gnutls_rsa_params_deinit(gnutls_rsa_params_t rsa_params);
int gnutls_rsa_params_cpy(gnutls_rsa_params_t dst, gnutls_rsa_params_t src);
int gnutls_rsa_params_import_raw(gnutls_rsa_params_t rsa_params, 
    const gnutls_datum_t *m, const gnutls_datum_t *e,
    const gnutls_datum_t *d, const gnutls_datum_t *p, 
    const gnutls_datum_t *q, const gnutls_datum_t *u);
int gnutls_rsa_params_generate2(gnutls_rsa_params_t params, unsigned int bits);
int gnutls_rsa_params_export_raw(gnutls_rsa_params_t params,
    gnutls_datum_t * m, gnutls_datum_t *e,
    gnutls_datum_t *d, gnutls_datum_t *p, gnutls_datum_t* q, 
    gnutls_datum_t* u, unsigned int *bits);
int gnutls_rsa_params_export_pkcs1( gnutls_rsa_params_t params,
    gnutls_x509_crt_fmt_t format, unsigned char* params_data,
    size_t* params_data_size);
int gnutls_rsa_params_import_pkcs1(gnutls_rsa_params_t params,
    const gnutls_datum_t * pkcs1_params, gnutls_x509_crt_fmt_t format);

/* Session stuff
 */
typedef ssize_t (*gnutls_pull_func)(gnutls_transport_ptr_t, void*, size_t);
typedef ssize_t (*gnutls_push_func)(gnutls_transport_ptr_t, const void*, size_t);
void gnutls_transport_set_ptr(gnutls_session_t session, gnutls_transport_ptr_t ptr);
void gnutls_transport_set_ptr2(gnutls_session_t session, gnutls_transport_ptr_t recv_ptr,
    gnutls_transport_ptr_t send_ptr);

gnutls_transport_ptr_t gnutls_transport_get_ptr(gnutls_session_t session);
void gnutls_transport_get_ptr2(gnutls_session_t session,
    gnutls_transport_ptr_t *recv_ptr,
    gnutls_transport_ptr_t *send_ptr);

void gnutls_transport_set_lowat( gnutls_session_t session, int num);


void gnutls_transport_set_push_function( gnutls_session_t session, gnutls_push_func push_func);
void gnutls_transport_set_pull_function( gnutls_session_t session, gnutls_pull_func pull_func);

/* session specific 
 */
void gnutls_session_set_ptr(gnutls_session_t session, void* ptr);
void* gnutls_session_get_ptr(gnutls_session_t session);

void gnutls_openpgp_send_key(gnutls_session_t session, gnutls_openpgp_key_status_t status);

/* fingerprint 
 * Actually this function returns the hash of the given data.
 */
int gnutls_fingerprint(gnutls_digest_algorithm_t algo, const gnutls_datum_t* data, 
    void* result, size_t* result_size);


/* SRP 
 */

typedef struct gnutls_srp_server_credentials_st* gnutls_srp_server_credentials_t;
typedef struct gnutls_srp_client_credentials_st* gnutls_srp_client_credentials_t;

void gnutls_srp_free_client_credentials( gnutls_srp_client_credentials_t sc);
int gnutls_srp_allocate_client_credentials( gnutls_srp_client_credentials_t *sc);
int gnutls_srp_set_client_credentials( gnutls_srp_client_credentials_t res, char *username, char* password);

void gnutls_srp_free_server_credentials( gnutls_srp_server_credentials_t sc);
int gnutls_srp_allocate_server_credentials( gnutls_srp_server_credentials_t *sc);
int gnutls_srp_set_server_credentials_file( gnutls_srp_server_credentials_t res, 
    const char *password_file, const char* password_conf_file);

const char* gnutls_srp_server_get_username( gnutls_session_t session);

extern int gnutls_srp_verifier (const char* username,
				const char* password,
				const gnutls_datum_t *salt,
				const gnutls_datum_t* generator,
				const gnutls_datum_t* prime,
				gnutls_datum_t * res);

/* The static parameters defined in draft-ietf-tls-srp-05
 * Those should be used as input to gnutls_srp_verifier().
 */
extern const gnutls_datum_t gnutls_srp_2048_group_prime;
extern const gnutls_datum_t gnutls_srp_2048_group_generator;

extern const gnutls_datum_t gnutls_srp_1536_group_prime;
extern const gnutls_datum_t gnutls_srp_1536_group_generator;

extern const gnutls_datum_t gnutls_srp_1024_group_prime;
extern const gnutls_datum_t gnutls_srp_1024_group_generator;

typedef int gnutls_srp_server_credentials_function(
    gnutls_session_t, 
    const char* username, gnutls_datum_t* salt, 
    gnutls_datum_t* verifier, gnutls_datum_t* generator,
    gnutls_datum_t* prime
);
void gnutls_srp_set_server_credentials_function(
    gnutls_srp_server_credentials_t cred,
    gnutls_srp_server_credentials_function *func);

typedef int gnutls_srp_client_credentials_function(gnutls_session_t, unsigned int,
    char **, char**);
void gnutls_srp_set_client_credentials_function( gnutls_srp_client_credentials_t cred,
    gnutls_srp_client_credentials_function *func);

int gnutls_srp_base64_encode( const gnutls_datum_t *data, char* result, int* result_size);
int gnutls_srp_base64_encode_alloc( const gnutls_datum_t *data, gnutls_datum_t* result);

int gnutls_srp_base64_decode( const gnutls_datum_t *b64_data, char* result, int* result_size);
int gnutls_srp_base64_decode_alloc( const gnutls_datum_t *b64_data,
				      gnutls_datum_t* result);

#ifndef GNUTLS_UI_H
# define GNUTLS_UI_H

  typedef enum gnutls_x509_subject_alt_name_t {
    GNUTLS_SAN_DNSNAME = 1, GNUTLS_SAN_RFC822NAME,
    GNUTLS_SAN_URI, GNUTLS_SAN_IPADDRESS
  } gnutls_x509_subject_alt_name_t;

# ifdef LIBGNUTLS_VERSION	/* These are defined only in gnutls.h */

  struct gnutls_openpgp_key_int;
  typedef struct gnutls_openpgp_key_int *gnutls_openpgp_key_t;

  struct gnutls_openpgp_privkey_int;
  typedef struct gnutls_openpgp_privkey_int *gnutls_openpgp_privkey_t;

  typedef struct gnutls_retr_st {
    gnutls_certificate_type_t type;
    union cert {
      gnutls_x509_crt_t *x509;
      gnutls_openpgp_key_t pgp;
    } cert;
    unsigned int ncerts;	/* one for pgp keys */

    union key {
      gnutls_x509_privkey_t x509;
      gnutls_openpgp_privkey_t pgp;
    } key;

    unsigned int deinit_all;	/* if non zero all keys will be deinited */
  } gnutls_retr_st;

  typedef int gnutls_certificate_client_retrieve_function(gnutls_session_t,
							  const
							  gnutls_datum_t *
							  req_ca_rdn,
							  int nreqs,
							  const
							  gnutls_pk_algorithm_t
							  * pk_algos,
							  int
							  pk_algos_length,
							  gnutls_retr_st *);
  typedef int gnutls_certificate_server_retrieve_function(gnutls_session_t,
							  gnutls_retr_st *);


  /* Functions that allow auth_info_t structures handling
   */

  gnutls_credentials_type_t gnutls_auth_get_type(gnutls_session_t session);
  gnutls_credentials_type_t gnutls_auth_server_get_type(gnutls_session_t
							session);
  gnutls_credentials_type_t gnutls_auth_client_get_type(gnutls_session_t
							session);

  /* DH */

  void gnutls_dh_set_prime_bits(gnutls_session_t session, unsigned int bits);
  int gnutls_dh_get_secret_bits(gnutls_session_t session);
  int gnutls_dh_get_peers_public_bits(gnutls_session_t session);
  int gnutls_dh_get_prime_bits(gnutls_session_t session);

  int gnutls_dh_get_group(gnutls_session_t session, gnutls_datum_t * raw_gen,
			  gnutls_datum_t * raw_prime);
  int gnutls_dh_get_pubkey(gnutls_session_t session,
			   gnutls_datum_t * raw_key);

  /* RSA */
  int gnutls_rsa_export_get_pubkey(gnutls_session_t session,
				   gnutls_datum_t * exponent,
				   gnutls_datum_t * modulus);
  int gnutls_rsa_export_get_modulus_bits(gnutls_session_t session);

  /* X509PKI */

  /* These are set on the credentials structure.
   */
  void gnutls_certificate_client_set_retrieve_function
  (gnutls_certificate_credentials_t cred,
   gnutls_certificate_client_retrieve_function * func);
  void gnutls_certificate_server_set_retrieve_function
  (gnutls_certificate_credentials_t cred,
   gnutls_certificate_server_retrieve_function * func);

  void gnutls_certificate_server_set_request(gnutls_session_t session,
					     gnutls_certificate_request_t
					     req);

  /* get data from the session
   */
  const gnutls_datum_t *gnutls_certificate_get_peers(gnutls_session_t
						     session, unsigned int
						     *list_size);
  const gnutls_datum_t *gnutls_certificate_get_ours(gnutls_session_t
						    session);

  time_t gnutls_certificate_activation_time_peers(gnutls_session_t session);
  time_t gnutls_certificate_expiration_time_peers(gnutls_session_t session);

  int gnutls_certificate_client_get_request_status(gnutls_session_t session);
  int gnutls_certificate_verify_peers2(gnutls_session_t session,
				       unsigned int *status);

  /* this is obsolete (?). */
  int gnutls_certificate_verify_peers(gnutls_session_t session);

  int gnutls_pem_base64_encode(const char *msg, const gnutls_datum_t * data,
			       char *result, size_t * result_size);
  int gnutls_pem_base64_decode(const char *header,
			       const gnutls_datum_t * b64_data,
			       unsigned char *result, size_t * result_size);

  int gnutls_pem_base64_encode_alloc(const char *msg,
				     const gnutls_datum_t * data,
				     gnutls_datum_t * result);
  int gnutls_pem_base64_decode_alloc(const char *header,
				     const gnutls_datum_t * b64_data,
				     gnutls_datum_t * result);

  /* key_usage will be an OR of the following values:
   */
#define GNUTLS_KEY_DIGITAL_SIGNATURE            128	/* when the key is to be
							 * used for signing.
							 */
#define GNUTLS_KEY_NON_REPUDIATION              64
#define GNUTLS_KEY_KEY_ENCIPHERMENT             32	/* when the key is to be
							 * used for encryption.
							 */
#define GNUTLS_KEY_DATA_ENCIPHERMENT            16
#define GNUTLS_KEY_KEY_AGREEMENT                8
#define GNUTLS_KEY_KEY_CERT_SIGN                4
#define GNUTLS_KEY_CRL_SIGN                     2
#define GNUTLS_KEY_ENCIPHER_ONLY                1
#define GNUTLS_KEY_DECIPHER_ONLY                32768

  typedef struct gnutls_params_st {
    gnutls_params_type_t type;
    union params {
      gnutls_dh_params_t dh;
      gnutls_rsa_params_t rsa_export;
    } params;
    int deinit;
  } gnutls_params_st;

  typedef int gnutls_params_function(gnutls_session_t, gnutls_params_type_t,
				     gnutls_params_st *);

  void
  gnutls_certificate_set_params_function(gnutls_certificate_credentials_t
					 res, gnutls_params_function * func);
  void gnutls_anon_set_params_function(gnutls_anon_server_credentials_t res,
				       gnutls_params_function * func);


# endif				/* LIBGNUTLS_VERSION */

#endif				/* GNUTLS_UI_H */

  /* Gnutls error codes. The mapping to a TLS alert is also shown in
   * comments.
   */

#define GNUTLS_E_SUCCESS 0
#define	GNUTLS_E_UNKNOWN_COMPRESSION_ALGORITHM -3
#define	GNUTLS_E_UNKNOWN_CIPHER_TYPE -6
#define	GNUTLS_E_LARGE_PACKET -7
#define GNUTLS_E_UNSUPPORTED_VERSION_PACKET -8	/* GNUTLS_A_PROTOCOL_VERSION */
#define GNUTLS_E_UNEXPECTED_PACKET_LENGTH -9	/* GNUTLS_A_RECORD_OVERFLOW */
#define GNUTLS_E_INVALID_SESSION -10
#define GNUTLS_E_FATAL_ALERT_RECEIVED -12
#define GNUTLS_E_UNEXPECTED_PACKET -15	/* GNUTLS_A_UNEXPECTED_MESSAGE */
#define GNUTLS_E_WARNING_ALERT_RECEIVED -16
#define GNUTLS_E_ERROR_IN_FINISHED_PACKET -18
#define GNUTLS_E_UNEXPECTED_HANDSHAKE_PACKET -19
#define	GNUTLS_E_UNKNOWN_CIPHER_SUITE -21	/* GNUTLS_A_HANDSHAKE_FAILURE */
#define	GNUTLS_E_UNWANTED_ALGORITHM -22
#define	GNUTLS_E_MPI_SCAN_FAILED -23
#define GNUTLS_E_DECRYPTION_FAILED -24	/* GNUTLS_A_DECRYPTION_FAILED, GNUTLS_A_BAD_RECORD_MAC */
#define GNUTLS_E_MEMORY_ERROR -25
#define GNUTLS_E_DECOMPRESSION_FAILED -26	/* GNUTLS_A_DECOMPRESSION_FAILURE */
#define GNUTLS_E_COMPRESSION_FAILED -27
#define GNUTLS_E_AGAIN -28
#define GNUTLS_E_EXPIRED -29
#define GNUTLS_E_DB_ERROR -30
#define GNUTLS_E_SRP_PWD_ERROR -31
#define GNUTLS_E_INSUFFICIENT_CREDENTIALS -32
#define GNUTLS_E_INSUFICIENT_CREDENTIALS GNUTLS_E_INSUFFICIENT_CREDENTIALS	/* for backwards compatibility only */
#define GNUTLS_E_INSUFFICIENT_CRED GNUTLS_E_INSUFFICIENT_CREDENTIALS
#define GNUTLS_E_INSUFICIENT_CRED GNUTLS_E_INSUFFICIENT_CREDENTIALS	/* for backwards compatibility only */

#define GNUTLS_E_HASH_FAILED -33
#define GNUTLS_E_BASE64_DECODING_ERROR -34

#define	GNUTLS_E_MPI_PRINT_FAILED -35
#define GNUTLS_E_REHANDSHAKE -37	/* GNUTLS_A_NO_RENEGOTIATION */
#define GNUTLS_E_GOT_APPLICATION_DATA -38
#define GNUTLS_E_RECORD_LIMIT_REACHED -39
#define GNUTLS_E_ENCRYPTION_FAILED -40

#define GNUTLS_E_PK_ENCRYPTION_FAILED -44
#define GNUTLS_E_PK_DECRYPTION_FAILED -45
#define GNUTLS_E_PK_SIGN_FAILED -46
#define GNUTLS_E_X509_UNSUPPORTED_CRITICAL_EXTENSION -47
#define GNUTLS_E_KEY_USAGE_VIOLATION -48
#define GNUTLS_E_NO_CERTIFICATE_FOUND -49	/* GNUTLS_A_BAD_CERTIFICATE */
#define GNUTLS_E_INVALID_REQUEST -50
#define GNUTLS_E_SHORT_MEMORY_BUFFER -51
#define GNUTLS_E_INTERRUPTED -52
#define GNUTLS_E_PUSH_ERROR -53
#define GNUTLS_E_PULL_ERROR -54
#define GNUTLS_E_RECEIVED_ILLEGAL_PARAMETER -55	/* GNUTLS_A_ILLEGAL_PARAMETER */
#define GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE -56
#define GNUTLS_E_PKCS1_WRONG_PAD -57
#define GNUTLS_E_RECEIVED_ILLEGAL_EXTENSION -58
#define GNUTLS_E_INTERNAL_ERROR -59
#define GNUTLS_E_DH_PRIME_UNACCEPTABLE -63
#define GNUTLS_E_FILE_ERROR -64
#define GNUTLS_E_TOO_MANY_EMPTY_PACKETS -78
#define GNUTLS_E_UNKNOWN_PK_ALGORITHM -80


  /* returned if libextra functionality was requested but
   * gnutls_global_init_extra() was not called.
   */
#define GNUTLS_E_INIT_LIBEXTRA -82
#define GNUTLS_E_LIBRARY_VERSION_MISMATCH -83


  /* returned if you need to generate temporary RSA
   * parameters. These are needed for export cipher suites.
   */
#define GNUTLS_E_NO_TEMPORARY_RSA_PARAMS -84

#define GNUTLS_E_LZO_INIT_FAILED -85
#define GNUTLS_E_NO_COMPRESSION_ALGORITHMS -86
#define GNUTLS_E_NO_CIPHER_SUITES -87

#define GNUTLS_E_OPENPGP_GETKEY_FAILED -88
#define GNUTLS_E_PK_SIG_VERIFY_FAILED -89

#define GNUTLS_E_ILLEGAL_SRP_USERNAME -90
#define GNUTLS_E_SRP_PWD_PARSING_ERROR -91
#define GNUTLS_E_NO_TEMPORARY_DH_PARAMS -93

  /* For certificate and key stuff
   */
#define GNUTLS_E_ASN1_ELEMENT_NOT_FOUND -67
#define GNUTLS_E_ASN1_IDENTIFIER_NOT_FOUND -68
#define GNUTLS_E_ASN1_DER_ERROR -69
#define GNUTLS_E_ASN1_VALUE_NOT_FOUND -70
#define GNUTLS_E_ASN1_GENERIC_ERROR -71
#define GNUTLS_E_ASN1_VALUE_NOT_VALID -72
#define GNUTLS_E_ASN1_TAG_ERROR -73
#define GNUTLS_E_ASN1_TAG_IMPLICIT -74
#define GNUTLS_E_ASN1_TYPE_ANY_ERROR -75
#define GNUTLS_E_ASN1_SYNTAX_ERROR -76
#define GNUTLS_E_ASN1_DER_OVERFLOW -77
#define GNUTLS_E_OPENPGP_TRUSTDB_VERSION_UNSUPPORTED -81
#define GNUTLS_E_OPENPGP_UID_REVOKED -79
#define GNUTLS_E_CERTIFICATE_ERROR -43
#define GNUTLS_E_X509_CERTIFICATE_ERROR GNUTLS_E_CERTIFICATE_ERROR
#define GNUTLS_E_CERTIFICATE_KEY_MISMATCH -60
#define GNUTLS_E_UNSUPPORTED_CERTIFICATE_TYPE -61	/* GNUTLS_A_UNSUPPORTED_CERTIFICATE */
#define GNUTLS_E_X509_UNKNOWN_SAN -62
#define GNUTLS_E_OPENPGP_FINGERPRINT_UNSUPPORTED -94
#define GNUTLS_E_X509_UNSUPPORTED_ATTRIBUTE -95
#define GNUTLS_E_UNKNOWN_HASH_ALGORITHM -96
#define GNUTLS_E_UNKNOWN_PKCS_CONTENT_TYPE -97
#define GNUTLS_E_UNKNOWN_PKCS_BAG_TYPE -98
#define GNUTLS_E_INVALID_PASSWORD -99
#define GNUTLS_E_MAC_VERIFY_FAILED -100	/* for PKCS #12 MAC */
#define GNUTLS_E_CONSTRAINT_ERROR -101

#define GNUTLS_E_BASE64_ENCODING_ERROR -201
#define GNUTLS_E_INCOMPATIBLE_GCRYPT_LIBRARY -202	/* obsolete */
#define GNUTLS_E_INCOMPATIBLE_CRYPTO_LIBRARY -202
#define GNUTLS_E_INCOMPATIBLE_LIBTASN1_LIBRARY -203

#define GNUTLS_E_OPENPGP_KEYRING_ERROR -204
#define GNUTLS_E_X509_UNSUPPORTED_OID -205

#define GNUTLS_E_RANDOM_FAILED -206

#define GNUTLS_E_UNIMPLEMENTED_FEATURE -1250