6a2e546fba99300f02ed570b81750067cfd498fb
[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         "err_hash",
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         "ex_data",
107 #if CRYPTO_NUM_LOCKS != 32
108 # error "Inconsistency between crypto.h and cryptlib.c"
109 #endif
110         };
111
112 /* This is for applications to allocate new type names in the non-dynamic
113    array of lock names.  These are numbered with positive numbers.  */
114 static STACK *app_locks=NULL;
115
116 /* For applications that want a more dynamic way of handling threads, the
117    following stack is used.  These are externally numbered with negative
118    numbers.  */
119 static STACK_OF(CRYPTO_dynlock) *dyn_locks=NULL;
120
121
122 static void (MS_FAR *locking_callback)(int mode,int type,
123         const char *file,int line)=NULL;
124 static int (MS_FAR *add_lock_callback)(int *pointer,int amount,
125         int type,const char *file,int line)=NULL;
126 static unsigned long (MS_FAR *id_callback)(void)=NULL;
127 static struct CRYPTO_dynlock_value *(MS_FAR *dynlock_create_callback)
128         (const char *file,int line)=NULL;
129 static void (MS_FAR *dynlock_lock_callback)(int mode,
130         struct CRYPTO_dynlock_value *l, const char *file,int line)=NULL;
131 static void (MS_FAR *dynlock_destroy_callback)(struct CRYPTO_dynlock_value *l,
132         const char *file,int line)=NULL;
133
134 int CRYPTO_get_new_lockid(char *name)
135         {
136         char *str;
137         int i;
138
139 #if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WIN16)
140         /* A hack to make Visual C++ 5.0 work correctly when linking as
141          * a DLL using /MT. Without this, the application cannot use
142          * and floating point printf's.
143          * It also seems to be needed for Visual C 1.5 (win16) */
144         SSLeay_MSVC5_hack=(double)name[0]*(double)name[1];
145 #endif
146
147         if ((app_locks == NULL) && ((app_locks=sk_new_null()) == NULL))
148                 {
149                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_LOCKID,ERR_R_MALLOC_FAILURE);
150                 return(0);
151                 }
152         if ((str=BUF_strdup(name)) == NULL)
153                 {
154                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_LOCKID,ERR_R_MALLOC_FAILURE);
155                 return(0);
156                 }
157         i=sk_push(app_locks,str);
158         if (!i)
159                 OPENSSL_free(str);
160         else
161                 i+=CRYPTO_NUM_LOCKS; /* gap of one :-) */
162         return(i);
163         }
164
165 int CRYPTO_num_locks(void)
166         {
167         return CRYPTO_NUM_LOCKS;
168         }
169
170 int CRYPTO_get_new_dynlockid(void)
171         {
172         int i = 0;
173         CRYPTO_dynlock *pointer = NULL;
174
175         if (dynlock_create_callback == NULL)
176                 {
177                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID,CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK);
178                 return(0);
179                 }
180         CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
181         if ((dyn_locks == NULL)
182                 && ((dyn_locks=sk_CRYPTO_dynlock_new_null()) == NULL))
183                 {
184                 CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
185                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID,ERR_R_MALLOC_FAILURE);
186                 return(0);
187                 }
188         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
189
190         pointer = (CRYPTO_dynlock *)OPENSSL_malloc(sizeof(CRYPTO_dynlock));
191         if (pointer == NULL)
192                 {
193                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID,ERR_R_MALLOC_FAILURE);
194                 return(0);
195                 }
196         pointer->references = 1;
197         pointer->data = dynlock_create_callback(__FILE__,__LINE__);
198         if (pointer->data == NULL)
199                 {
200                 OPENSSL_free(pointer);
201                 CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID,ERR_R_MALLOC_FAILURE);
202                 return(0);
203                 }
204
205         CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
206         /* First, try to find an existing empty slot */
207         i=sk_CRYPTO_dynlock_find(dyn_locks,NULL);
208         /* If there was none, push, thereby creating a new one */
209         if (i == -1)
210                 i=sk_CRYPTO_dynlock_push(dyn_locks,pointer);
211         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
212
213         if (!i)
214                 {
215                 dynlock_destroy_callback(pointer->data,__FILE__,__LINE__);
216                 OPENSSL_free(pointer);
217                 }
218         else
219                 i += 1; /* to avoid 0 */
220         return -i;
221         }
222
223 void CRYPTO_destroy_dynlockid(int i)
224         {
225         CRYPTO_dynlock *pointer = NULL;
226         if (i)
227                 i = -i-1;
228         if (dynlock_destroy_callback == NULL)
229                 return;
230
231         CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
232
233         if (dyn_locks == NULL || i >= sk_CRYPTO_dynlock_num(dyn_locks))
234                 return;
235         pointer = sk_CRYPTO_dynlock_value(dyn_locks, i);
236         if (pointer != NULL)
237                 {
238                 --pointer->references;
239 #ifdef REF_CHECK
240                 if (pointer->references < 0)
241                         {
242                         fprintf(stderr,"CRYPTO_destroy_dynlockid, bad reference count\n");
243                         abort();
244                         }
245                 else
246 #endif
247                         if (pointer->references <= 0)
248                                 {
249                                 sk_CRYPTO_dynlock_set(dyn_locks, i, NULL);
250                                 }
251                         else
252                                 pointer = NULL;
253                 }
254         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
255
256         if (pointer)
257                 {
258                 dynlock_destroy_callback(pointer->data,__FILE__,__LINE__);
259                 OPENSSL_free(pointer);
260                 }
261         }
262
263 struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i)
264         {
265         CRYPTO_dynlock *pointer = NULL;
266         if (i)
267                 i = -i-1;
268
269         CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
270
271         if (dyn_locks != NULL && i < sk_CRYPTO_dynlock_num(dyn_locks))
272                 pointer = sk_CRYPTO_dynlock_value(dyn_locks, i);
273         if (pointer)
274                 pointer->references++;
275
276         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
277
278         if (pointer)
279                 return pointer->data;
280         return NULL;
281         }
282
283 struct CRYPTO_dynlock_value *(*CRYPTO_get_dynlock_create_callback(void))
284         (const char *file,int line)
285         {
286         return(dynlock_create_callback);
287         }
288
289 void (*CRYPTO_get_dynlock_lock_callback(void))(int mode,
290         struct CRYPTO_dynlock_value *l, const char *file,int line)
291         {
292         return(dynlock_lock_callback);
293         }
294
295 void (*CRYPTO_get_dynlock_destroy_callback(void))
296         (struct CRYPTO_dynlock_value *l, const char *file,int line)
297         {
298         return(dynlock_destroy_callback);
299         }
300
301 void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *(*func)
302         (const char *file, int line))
303         {
304         dynlock_create_callback=func;
305         }
306
307 void CRYPTO_set_dynlock_lock_callback(void (*func)(int mode,
308         struct CRYPTO_dynlock_value *l, const char *file, int line))
309         {
310         dynlock_lock_callback=func;
311         }
312
313 void CRYPTO_set_dynlock_destroy_callback(void (*func)
314         (struct CRYPTO_dynlock_value *l, const char *file, int line))
315         {
316         dynlock_destroy_callback=func;
317         }
318
319
320 void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
321                 int line)
322         {
323         return(locking_callback);
324         }
325
326 int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
327                                           const char *file,int line)
328         {
329         return(add_lock_callback);
330         }
331
332 void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
333                                               const char *file,int line))
334         {
335         locking_callback=func;
336         }
337
338 void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
339                                               const char *file,int line))
340         {
341         add_lock_callback=func;
342         }
343
344 unsigned long (*CRYPTO_get_id_callback(void))(void)
345         {
346         return(id_callback);
347         }
348
349 void CRYPTO_set_id_callback(unsigned long (*func)(void))
350         {
351         id_callback=func;
352         }
353
354 unsigned long CRYPTO_thread_id(void)
355         {
356         unsigned long ret=0;
357
358         if (id_callback == NULL)
359                 {
360 #ifdef OPENSSL_SYS_WIN16
361                 ret=(unsigned long)GetCurrentTask();
362 #elif defined(OPENSSL_SYS_WIN32)
363                 ret=(unsigned long)GetCurrentThreadId();
364 #elif defined(GETPID_IS_MEANINGLESS)
365                 ret=1L;
366 #else
367                 ret=(unsigned long)getpid();
368 #endif
369                 }
370         else
371                 ret=id_callback();
372         return(ret);
373         }
374
375 void CRYPTO_lock(int mode, int type, const char *file, int line)
376         {
377 #ifdef LOCK_DEBUG
378                 {
379                 char *rw_text,*operation_text;
380
381                 if (mode & CRYPTO_LOCK)
382                         operation_text="lock  ";
383                 else if (mode & CRYPTO_UNLOCK)
384                         operation_text="unlock";
385                 else
386                         operation_text="ERROR ";
387
388                 if (mode & CRYPTO_READ)
389                         rw_text="r";
390                 else if (mode & CRYPTO_WRITE)
391                         rw_text="w";
392                 else
393                         rw_text="ERROR";
394
395                 fprintf(stderr,"lock:%08lx:(%s)%s %-18s %s:%d\n",
396                         CRYPTO_thread_id(), rw_text, operation_text,
397                         CRYPTO_get_lock_name(type), file, line);
398                 }
399 #endif
400         if (type < 0)
401                 {
402                 struct CRYPTO_dynlock_value *pointer
403                         = CRYPTO_get_dynlock_value(type);
404
405                 if (pointer && dynlock_lock_callback)
406                         {
407                         dynlock_lock_callback(mode, pointer, file, line);
408                         }
409
410                 CRYPTO_destroy_dynlockid(type);
411                 }
412         else
413                 if (locking_callback != NULL)
414                         locking_callback(mode,type,file,line);
415         }
416
417 int CRYPTO_add_lock(int *pointer, int amount, int type, const char *file,
418              int line)
419         {
420         int ret = 0;
421
422         if (add_lock_callback != NULL)
423                 {
424 #ifdef LOCK_DEBUG
425                 int before= *pointer;
426 #endif
427
428                 ret=add_lock_callback(pointer,amount,type,file,line);
429 #ifdef LOCK_DEBUG
430                 fprintf(stderr,"ladd:%08lx:%2d+%2d->%2d %-18s %s:%d\n",
431                         CRYPTO_thread_id(),
432                         before,amount,ret,
433                         CRYPTO_get_lock_name(type),
434                         file,line);
435 #endif
436                 }
437         else
438                 {
439                 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,file,line);
440
441                 ret= *pointer+amount;
442 #ifdef LOCK_DEBUG
443                 fprintf(stderr,"ladd:%08lx:%2d+%2d->%2d %-18s %s:%d\n",
444                         CRYPTO_thread_id(),
445                         *pointer,amount,ret,
446                         CRYPTO_get_lock_name(type),
447                         file,line);
448 #endif
449                 *pointer=ret;
450                 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,file,line);
451                 }
452         return(ret);
453         }
454
455 const char *CRYPTO_get_lock_name(int type)
456         {
457         if (type < 0)
458                 return("dynamic");
459         else if (type < CRYPTO_NUM_LOCKS)
460                 return(lock_names[type]);
461         else if (type-CRYPTO_NUM_LOCKS >= sk_num(app_locks))
462                 return("ERROR");
463         else
464                 return(sk_value(app_locks,type-CRYPTO_NUM_LOCKS));
465         }
466
467 #ifdef _DLL
468 #ifdef OPENSSL_SYS_WIN32
469
470 /* All we really need to do is remove the 'error' state when a thread
471  * detaches */
472
473 BOOL WINAPI DLLEntryPoint(HINSTANCE hinstDLL, DWORD fdwReason,
474              LPVOID lpvReserved)
475         {
476         switch(fdwReason)
477                 {
478         case DLL_PROCESS_ATTACH:
479                 break;
480         case DLL_THREAD_ATTACH:
481                 break;
482         case DLL_THREAD_DETACH:
483                 ERR_remove_state(0);
484                 break;
485         case DLL_PROCESS_DETACH:
486                 break;
487                 }
488         return(TRUE);
489         }
490 #endif
491
492 #endif