2 * Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2009, 2010
3 * Free Software Foundation, Inc.
5 * Author: Nikos Mavrogiannopoulos
7 * This file is part of GnuTLS.
9 * The GnuTLS is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; either version 2.1 of
12 * the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
26 #include <gnutls_int.h>
27 #include <gnutls_errors.h>
29 #include <gnutls_dh.h>
31 #include <gnutls/pkcs11.h>
33 #include <gnutls_extensions.h> /* for _gnutls_ext_init */
34 #include <gnutls_cryptodev.h>
41 /* Minimum library versions we accept. */
42 #define GNUTLS_MIN_LIBTASN1_VERSION "0.3.4"
44 /* created by asn1c */
45 extern const ASN1_ARRAY_TYPE gnutls_asn1_tab
[];
46 extern const ASN1_ARRAY_TYPE pkix_asn1_tab
[];
48 ASN1_TYPE _gnutls_pkix1_asn
;
49 ASN1_TYPE _gnutls_gnutls_asn
;
51 gnutls_log_func _gnutls_log_func
;
52 int _gnutls_log_level
= 0; /* default log level */
55 * gnutls_global_set_log_function:
56 * @log_func: it's a log function
58 * This is the function where you set the logging function gnutls is
59 * going to use. This function only accepts a character array.
60 * Normally you may not use this function since it is only used for
63 * gnutls_log_func is of the form,
64 * void (*gnutls_log_func)( int level, const char*);
67 gnutls_global_set_log_function (gnutls_log_func log_func
)
69 _gnutls_log_func
= log_func
;
73 * gnutls_global_set_time_function:
74 * @time_func: it's the system time function
76 * This is the function where you can override the default system
79 * gnutls_time_func is of the form,
80 * time_t (*gnutls_time_func)( time*);
83 gnutls_global_set_time_function (gnutls_time_func time_func
)
85 gnutls_time
= time_func
;
89 * gnutls_global_set_log_level:
90 * @level: it's an integer from 0 to 9.
92 * This is the function that allows you to set the log level. The
93 * level is an integer between 0 and 9. Higher values mean more
94 * verbosity. The default value is 0. Larger values should only be
95 * used with care, since they may reveal sensitive information.
97 * Use a log level over 10 to enable all debugging options.
100 gnutls_global_set_log_level (int level
)
102 _gnutls_log_level
= level
;
106 * gnutls_global_set_mem_functions:
107 * @alloc_func: it's the default memory allocation function. Like malloc().
108 * @secure_alloc_func: This is the memory allocation function that will be used for sensitive data.
109 * @is_secure_func: a function that returns 0 if the memory given is not secure. May be NULL.
110 * @realloc_func: A realloc function
111 * @free_func: The function that frees allocated data. Must accept a NULL pointer.
113 * This is the function were you set the memory allocation functions
114 * gnutls is going to use. By default the libc's allocation functions
115 * (malloc(), free()), are used by gnutls, to allocate both sensitive
116 * and not sensitive data. This function is provided to set the
117 * memory allocation functions to something other than the defaults
119 * This function must be called before gnutls_global_init() is called.
120 * This function is not thread safe.
123 gnutls_global_set_mem_functions (gnutls_alloc_function alloc_func
,
124 gnutls_alloc_function secure_alloc_func
,
125 gnutls_is_secure_function is_secure_func
,
126 gnutls_realloc_function realloc_func
,
127 gnutls_free_function free_func
)
129 gnutls_secure_malloc
= secure_alloc_func
;
130 gnutls_malloc
= alloc_func
;
131 gnutls_realloc
= realloc_func
;
132 gnutls_free
= free_func
;
134 if (is_secure_func
!= NULL
)
135 _gnutls_is_secure_memory
= is_secure_func
;
137 _gnutls_is_secure_memory
= _gnutls_is_secure_mem_null
;
139 /* if using the libc's default malloc
140 * use libc's calloc as well.
142 if (gnutls_malloc
== malloc
)
144 gnutls_calloc
= calloc
;
147 { /* use the included ones */
148 gnutls_calloc
= _gnutls_calloc
;
150 gnutls_strdup
= _gnutls_strdup
;
154 static int _gnutls_init
= 0;
158 * gnutls_global_init:
160 * This function initializes the global data to defaults. Every
161 * gnutls application has a global data which holds common parameters
162 * shared by gnutls session structures. You should call
163 * gnutls_global_deinit() when gnutls usage is no longer needed
165 * Note that this function will also initialize the underlying crypto
166 * backend, if it has not been initialized before.
168 * This function increment a global counter, so that
169 * gnutls_global_deinit() only releases resources when it has been
170 * called as many times as gnutls_global_init(). This is useful when
171 * GnuTLS is used by more than one library in an application. This
172 * function can be called many times, but will only do something the
175 * Note! This function is not thread safe. If two threads call this
176 * function simultaneously, they can cause a race between checking
177 * the global counter and incrementing it, causing both threads to
178 * execute the library initialization code. That would lead to a
179 * memory leak. To handle this, your application could invoke this
180 * function after aquiring a thread mutex. To ignore the potential
181 * memory leak is also an option.
183 * Returns: On success, %GNUTLS_E_SUCCESS (zero) is returned,
184 * otherwise an error code is returned.
187 gnutls_global_init (void)
195 if (gl_sockets_startup (SOCKETS_1_1
))
196 return GNUTLS_E_LIBRARY_VERSION_MISMATCH
;
198 bindtextdomain (PACKAGE
, LOCALEDIR
);
200 res
= gnutls_crypto_init ();
204 return GNUTLS_E_CRYPTO_INIT_FAILED
;
207 /* initialize ASN.1 parser
208 * This should not deal with files in the final
211 if (asn1_check_version (GNUTLS_MIN_LIBTASN1_VERSION
) == NULL
)
214 _gnutls_debug_log ("Checking for libtasn1 failed: %s < %s\n",
215 asn1_check_version (NULL
),
216 GNUTLS_MIN_LIBTASN1_VERSION
);
217 return GNUTLS_E_INCOMPATIBLE_LIBTASN1_LIBRARY
;
220 res
= asn1_array2tree (pkix_asn1_tab
, &_gnutls_pkix1_asn
, NULL
);
221 if (res
!= ASN1_SUCCESS
)
223 result
= _gnutls_asn2err (res
);
227 res
= asn1_array2tree (gnutls_asn1_tab
, &_gnutls_gnutls_asn
, NULL
);
228 if (res
!= ASN1_SUCCESS
)
230 asn1_delete_structure (&_gnutls_pkix1_asn
);
231 result
= _gnutls_asn2err (res
);
235 /* Initialize the random generator */
236 result
= _gnutls_rnd_init ();
243 /* Initialize the default TLS extensions */
244 result
= _gnutls_ext_init ();
251 gnutls_pkcs11_init (GNUTLS_PKCS11_FLAG_AUTO
, NULL
);
253 _gnutls_cryptodev_init ();
260 * gnutls_global_deinit:
262 * This function deinitializes the global data, that were initialized
263 * using gnutls_global_init().
265 * Note! This function is not thread safe. See the discussion for
266 * gnutls_global_init() for more information.
269 gnutls_global_deinit (void)
271 if (_gnutls_init
== 1)
273 gl_sockets_cleanup ();
274 _gnutls_rnd_deinit ();
275 _gnutls_ext_deinit ();
276 asn1_delete_structure (&_gnutls_gnutls_asn
);
277 asn1_delete_structure (&_gnutls_pkix1_asn
);
278 _gnutls_crypto_deregister ();
279 _gnutls_cryptodev_deinit ();
280 gnutls_pkcs11_deinit ();
285 /* These functions should be elsewere. Kept here for
286 * historical reasons.
291 * gnutls_check_version:
292 * @req_version: version string to compare with, or %NULL.
294 * Check GnuTLS Library version.
296 * See %GNUTLS_VERSION for a suitable @req_version string.
298 * Return value: Check that the version of the library is at
299 * minimum the one given as a string in @req_version and return the
300 * actual version string of the library; return %NULL if the
301 * condition is not met. If %NULL is passed to this function no
302 * check is done and only the version string is returned.
305 gnutls_check_version (const char *req_version
)
307 if (!req_version
|| strverscmp (req_version
, VERSION
) <= 0)