copyright
[openssl.git] / crypto / cryptlib.c
1 /* crypto/cryptlib.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #include <stdio.h>
60 #include <string.h>
61 #include "cryptlib.h"
62 #include <openssl/crypto.h>
63 #include <openssl/safestack.h>
64
65 #if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WIN16)
66 static double SSLeay_MSVC5_hack=0.0; /* and for VC1.5 */
67 #endif
68
69 DECLARE_STACK_OF(CRYPTO_dynlock)
70 IMPLEMENT_STACK_OF(CRYPTO_dynlock)
71
72 /* real #defines in crypto.h, keep these upto date */
73 static const char* lock_names[CRYPTO_NUM_LOCKS] =
74         {
75         "<<ERROR>>",
76         "err",
77         "ex_data",
78         "x509",
79         "x509_info",
80         "x509_pkey",
81         "x509_crl",
82         "x509_req",
83         "dsa",
84         "rsa",
85         "evp_pkey",
86         "x509_store",
87         "ssl_ctx",
88         "ssl_cert",
89         "ssl_session",
90         "ssl_sess_cert",
91         "ssl",
92         "rand",
93         "rand2",
94         "debug_malloc",
95         "BIO",
96         "gethostbyname",
97         "getservbyname",
98         "readdir",
99         "RSA_blinding",
100         "dh",
101         "debug_malloc2",
102         "dso",
103         "dynlock",
104         "engine",
105         "ui",
106 #if CRYPTO_NUM_LOCKS != 31
107 # error "Inconsistency between crypto.h and cryptlib.c"
108 #endif
109         };
110
111 /* This is for applications to allocate new type names in the non-dynamic
112    array of lock names.  These are numbered with positive numbers.  */
113 static STACK *app_locks=NULL;
114
115 /* For applications that want a more dynamic way of handling threads, the
116    following stack is used.  These are externally numbered with negative
117    numbers.  */
118 static STACK_OF(CRYPTO_dynlock) *dyn_locks=NULL;
119
120
121 static void (MS_FAR *locking_callback)(int mode,int type,
122         const char *file,int line)=NULL;
123 static int (MS_FAR *add_lock_callback)(int *pointer,int amount,
124         int type,const char *file,int line)=NULL;
125 static unsigned long (MS_FAR *id_callback)(void)=NULL;
126 static struct CRYPTO_dynlock_value *(MS_FAR *dynlock_create_callback)
127         (const char *file,int line)=NULL;
128 static void (MS_FAR *dynlock_lock_callback)(int mode,
129         struct CRYPTO_dynlock_value *l, const char *file,int line)=NULL;
130 static void (MS_FAR *dynlock_destroy_callback)(struct CRYPTO_dynlock_value *l,
131         const char *file,int line)=NULL;
132
133 int CRYPTO_get_new_lockid(char *name)
134         {
135         char *str;
136         int i;
137
138 #if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WIN16)
139         /* A hack to make Visual C++ 5.0 work correctly when linking as
140          * a DLL using /MT. Without this, the application cannot use
141          * and floating point printf's.
142          * It also seems to be needed for Visual C 1.5 (win16) */
143         SSLeay_MSVC5_hack=(double)name[0]*(double)name[1];
144 #endif
145
146         if ((app_locks == NULL) && ((app_locks=sk_new_null()) == NULL))
147                 {
148                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_LOCKID,ERR_R_MALLOC_FAILURE);
149                 return(0);
150                 }
151         if ((str=BUF_strdup(name)) == NULL)
152                 {
153                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_LOCKID,ERR_R_MALLOC_FAILURE);
154                 return(0);
155                 }
156         i=sk_push(app_locks,str);
157         if (!i)
158                 OPENSSL_free(str);
159         else
160                 i+=CRYPTO_NUM_LOCKS; /* gap of one :-) */
161         return(i);
162         }
163
164 int CRYPTO_num_locks(void)
165         {
166         return CRYPTO_NUM_LOCKS;
167         }
168
169 int CRYPTO_get_new_dynlockid(void)
170         {
171         int i = 0;
172         CRYPTO_dynlock *pointer = NULL;
173
174         if (dynlock_create_callback == NULL)
175                 {
176                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID,CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK);
177                 return(0);
178                 }
179         CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
180         if ((dyn_locks == NULL)
181                 && ((dyn_locks=sk_CRYPTO_dynlock_new_null()) == NULL))
182                 {
183                 CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
184                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID,ERR_R_MALLOC_FAILURE);
185                 return(0);
186                 }
187         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
188
189         pointer = (CRYPTO_dynlock *)OPENSSL_malloc(sizeof(CRYPTO_dynlock));
190         if (pointer == NULL)
191                 {
192                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID,ERR_R_MALLOC_FAILURE);
193                 return(0);
194                 }
195         pointer->references = 1;
196         pointer->data = dynlock_create_callback(__FILE__,__LINE__);
197         if (pointer->data == NULL)
198                 {
199                 OPENSSL_free(pointer);
200                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID,ERR_R_MALLOC_FAILURE);
201                 return(0);
202                 }
203
204         CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
205         /* First, try to find an existing empty slot */
206         i=sk_CRYPTO_dynlock_find(dyn_locks,NULL);
207         /* If there was none, push, thereby creating a new one */
208         if (i == -1)
209                 i=sk_CRYPTO_dynlock_push(dyn_locks,pointer);
210         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
211
212         if (!i)
213                 {
214                 dynlock_destroy_callback(pointer->data,__FILE__,__LINE__);
215                 OPENSSL_free(pointer);
216                 }
217         else
218                 i += 1; /* to avoid 0 */
219         return -i;
220         }
221
222 void CRYPTO_destroy_dynlockid(int i)
223         {
224         CRYPTO_dynlock *pointer = NULL;
225         if (i)
226                 i = -i-1;
227         if (dynlock_destroy_callback == NULL)
228                 return;
229
230         CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
231
232         if (dyn_locks == NULL || i >= sk_CRYPTO_dynlock_num(dyn_locks))
233                 return;
234         pointer = sk_CRYPTO_dynlock_value(dyn_locks, i);
235         if (pointer != NULL)
236                 {
237                 --pointer->references;
238 #ifdef REF_CHECK
239                 if (pointer->references < 0)
240                         {
241                         fprintf(stderr,"CRYPTO_destroy_dynlockid, bad reference count\n");
242                         abort();
243                         }
244                 else
245 #endif
246                         if (pointer->references <= 0)
247                                 {
248                                 sk_CRYPTO_dynlock_set(dyn_locks, i, NULL);
249                                 }
250                         else
251                                 pointer = NULL;
252                 }
253         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
254
255         if (pointer)
256                 {
257                 dynlock_destroy_callback(pointer->data,__FILE__,__LINE__);
258                 OPENSSL_free(pointer);
259                 }
260         }
261
262 struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i)
263         {
264         CRYPTO_dynlock *pointer = NULL;
265         if (i)
266                 i = -i-1;
267
268         CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
269
270         if (dyn_locks != NULL && i < sk_CRYPTO_dynlock_num(dyn_locks))
271                 pointer = sk_CRYPTO_dynlock_value(dyn_locks, i);
272         if (pointer)
273                 pointer->references++;
274
275         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
276
277         if (pointer)
278                 return pointer->data;
279         return NULL;
280         }
281
282 struct CRYPTO_dynlock_value *(*CRYPTO_get_dynlock_create_callback(void))
283         (const char *file,int line)
284         {
285         return(dynlock_create_callback);
286         }
287
288 void (*CRYPTO_get_dynlock_lock_callback(void))(int mode,
289         struct CRYPTO_dynlock_value *l, const char *file,int line)
290         {
291         return(dynlock_lock_callback);
292         }
293
294 void (*CRYPTO_get_dynlock_destroy_callback(void))
295         (struct CRYPTO_dynlock_value *l, const char *file,int line)
296         {
297         return(dynlock_destroy_callback);
298         }
299
300 void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *(*func)
301         (const char *file, int line))
302         {
303         dynlock_create_callback=func;
304         }
305
306 void CRYPTO_set_dynlock_lock_callback(void (*func)(int mode,
307         struct CRYPTO_dynlock_value *l, const char *file, int line))
308         {
309         dynlock_lock_callback=func;
310         }
311
312 void CRYPTO_set_dynlock_destroy_callback(void (*func)
313         (struct CRYPTO_dynlock_value *l, const char *file, int line))
314         {
315         dynlock_destroy_callback=func;
316         }
317
318
319 void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
320                 int line)
321         {
322         return(locking_callback);
323         }
324
325 int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
326                                           const char *file,int line)
327         {
328         return(add_lock_callback);
329         }
330
331 void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
332                                               const char *file,int line))
333         {
334         locking_callback=func;
335         }
336
337 void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
338                                               const char *file,int line))
339         {
340         add_lock_callback=func;
341         }
342
343 unsigned long (*CRYPTO_get_id_callback(void))(void)
344         {
345         return(id_callback);
346         }
347
348 void CRYPTO_set_id_callback(unsigned long (*func)(void))
349         {
350         id_callback=func;
351         }
352
353 unsigned long CRYPTO_thread_id(void)
354         {
355         unsigned long ret=0;
356
357         if (id_callback == NULL)
358                 {
359 #ifdef OPENSSL_SYS_WIN16
360                 ret=(unsigned long)GetCurrentTask();
361 #elif defined(OPENSSL_SYS_WIN32)
362                 ret=(unsigned long)GetCurrentThreadId();
363 #elif defined(GETPID_IS_MEANINGLESS)
364                 ret=1L;
365 #else
366                 ret=(unsigned long)getpid();
367 #endif
368                 }
369         else
370                 ret=id_callback();
371         return(ret);
372         }
373
374 void CRYPTO_lock(int mode, int type, const char *file, int line)
375         {
376 #ifdef LOCK_DEBUG
377                 {
378                 char *rw_text,*operation_text;
379
380                 if (mode & CRYPTO_LOCK)
381                         operation_text="lock  ";
382                 else if (mode & CRYPTO_UNLOCK)
383                         operation_text="unlock";
384                 else
385                         operation_text="ERROR ";
386
387                 if (mode & CRYPTO_READ)
388                         rw_text="r";
389                 else if (mode & CRYPTO_WRITE)
390                         rw_text="w";
391                 else
392                         rw_text="ERROR";
393
394                 fprintf(stderr,"lock:%08lx:(%s)%s %-18s %s:%d\n",
395                         CRYPTO_thread_id(), rw_text, operation_text,
396                         CRYPTO_get_lock_name(type), file, line);
397                 }
398 #endif
399         if (type < 0)
400                 {
401                 struct CRYPTO_dynlock_value *pointer
402                         = CRYPTO_get_dynlock_value(type);
403
404                 if (pointer && dynlock_lock_callback)
405                         {
406                         dynlock_lock_callback(mode, pointer, file, line);
407                         }
408
409                 CRYPTO_destroy_dynlockid(type);
410                 }
411         else
412                 if (locking_callback != NULL)
413                         locking_callback(mode,type,file,line);
414         }
415
416 int CRYPTO_add_lock(int *pointer, int amount, int type, const char *file,
417              int line)
418         {
419         int ret = 0;
420
421         if (add_lock_callback != NULL)
422                 {
423 #ifdef LOCK_DEBUG
424                 int before= *pointer;
425 #endif
426
427                 ret=add_lock_callback(pointer,amount,type,file,line);
428 #ifdef LOCK_DEBUG
429                 fprintf(stderr,"ladd:%08lx:%2d+%2d->%2d %-18s %s:%d\n",
430                         CRYPTO_thread_id(),
431                         before,amount,ret,
432                         CRYPTO_get_lock_name(type),
433                         file,line);
434 #endif
435                 }
436         else
437                 {
438                 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,file,line);
439
440                 ret= *pointer+amount;
441 #ifdef LOCK_DEBUG
442                 fprintf(stderr,"ladd:%08lx:%2d+%2d->%2d %-18s %s:%d\n",
443                         CRYPTO_thread_id(),
444                         *pointer,amount,ret,
445                         CRYPTO_get_lock_name(type),
446                         file,line);
447 #endif
448                 *pointer=ret;
449                 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,file,line);
450                 }
451         return(ret);
452         }
453
454 const char *CRYPTO_get_lock_name(int type)
455         {
456         if (type < 0)
457                 return("dynamic");
458         else if (type < CRYPTO_NUM_LOCKS)
459                 return(lock_names[type]);
460         else if (type-CRYPTO_NUM_LOCKS >= sk_num(app_locks))
461                 return("ERROR");
462         else
463                 return(sk_value(app_locks,type-CRYPTO_NUM_LOCKS));
464         }
465
466 #ifdef _DLL
467 #ifdef OPENSSL_SYS_WIN32
468
469 /* All we really need to do is remove the 'error' state when a thread
470  * detaches */
471
472 BOOL WINAPI DLLEntryPoint(HINSTANCE hinstDLL, DWORD fdwReason,
473              LPVOID lpvReserved)
474         {
475         switch(fdwReason)
476                 {
477         case DLL_PROCESS_ATTACH:
478                 break;
479         case DLL_THREAD_ATTACH:
480                 break;
481         case DLL_THREAD_DETACH:
482                 ERR_remove_state(0);
483                 break;
484         case DLL_PROCESS_DETACH:
485                 break;
486                 }
487         return(TRUE);
488         }
489 #endif
490
491 #endif