Fix incorrect BIO_*_ctrl() macros (Shay Harding <sharding@ccbill.com>).
[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                 {
234                 CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
235                 return;
236                 }
237         pointer = sk_CRYPTO_dynlock_value(dyn_locks, i);
238         if (pointer != NULL)
239                 {
240                 --pointer->references;
241 #ifdef REF_CHECK
242                 if (pointer->references < 0)
243                         {
244                         fprintf(stderr,"CRYPTO_destroy_dynlockid, bad reference count\n");
245                         abort();
246                         }
247                 else
248 #endif
249                         if (pointer->references <= 0)
250                                 {
251                                 sk_CRYPTO_dynlock_set(dyn_locks, i, NULL);
252                                 }
253                         else
254                                 pointer = NULL;
255                 }
256         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
257
258         if (pointer)
259                 {
260                 dynlock_destroy_callback(pointer->data,__FILE__,__LINE__);
261                 OPENSSL_free(pointer);
262                 }
263         }
264
265 struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i)
266         {
267         CRYPTO_dynlock *pointer = NULL;
268         if (i)
269                 i = -i-1;
270
271         CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
272
273         if (dyn_locks != NULL && i < sk_CRYPTO_dynlock_num(dyn_locks))
274                 pointer = sk_CRYPTO_dynlock_value(dyn_locks, i);
275         if (pointer)
276                 pointer->references++;
277
278         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
279
280         if (pointer)
281                 return pointer->data;
282         return NULL;
283         }
284
285 struct CRYPTO_dynlock_value *(*CRYPTO_get_dynlock_create_callback(void))
286         (const char *file,int line)
287         {
288         return(dynlock_create_callback);
289         }
290
291 void (*CRYPTO_get_dynlock_lock_callback(void))(int mode,
292         struct CRYPTO_dynlock_value *l, const char *file,int line)
293         {
294         return(dynlock_lock_callback);
295         }
296
297 void (*CRYPTO_get_dynlock_destroy_callback(void))
298         (struct CRYPTO_dynlock_value *l, const char *file,int line)
299         {
300         return(dynlock_destroy_callback);
301         }
302
303 void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *(*func)
304         (const char *file, int line))
305         {
306         dynlock_create_callback=func;
307         }
308
309 void CRYPTO_set_dynlock_lock_callback(void (*func)(int mode,
310         struct CRYPTO_dynlock_value *l, const char *file, int line))
311         {
312         dynlock_lock_callback=func;
313         }
314
315 void CRYPTO_set_dynlock_destroy_callback(void (*func)
316         (struct CRYPTO_dynlock_value *l, const char *file, int line))
317         {
318         dynlock_destroy_callback=func;
319         }
320
321
322 void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
323                 int line)
324         {
325         return(locking_callback);
326         }
327
328 int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
329                                           const char *file,int line)
330         {
331         return(add_lock_callback);
332         }
333
334 void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
335                                               const char *file,int line))
336         {
337         locking_callback=func;
338         }
339
340 void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
341                                               const char *file,int line))
342         {
343         add_lock_callback=func;
344         }
345
346 unsigned long (*CRYPTO_get_id_callback(void))(void)
347         {
348         return(id_callback);
349         }
350
351 void CRYPTO_set_id_callback(unsigned long (*func)(void))
352         {
353         id_callback=func;
354         }
355
356 unsigned long CRYPTO_thread_id(void)
357         {
358         unsigned long ret=0;
359
360         if (id_callback == NULL)
361                 {
362 #ifdef OPENSSL_SYS_WIN16
363                 ret=(unsigned long)GetCurrentTask();
364 #elif defined(OPENSSL_SYS_WIN32)
365                 ret=(unsigned long)GetCurrentThreadId();
366 #elif defined(GETPID_IS_MEANINGLESS)
367                 ret=1L;
368 #else
369                 ret=(unsigned long)getpid();
370 #endif
371                 }
372         else
373                 ret=id_callback();
374         return(ret);
375         }
376
377 void CRYPTO_lock(int mode, int type, const char *file, int line)
378         {
379 #ifdef LOCK_DEBUG
380                 {
381                 char *rw_text,*operation_text;
382
383                 if (mode & CRYPTO_LOCK)
384                         operation_text="lock  ";
385                 else if (mode & CRYPTO_UNLOCK)
386                         operation_text="unlock";
387                 else
388                         operation_text="ERROR ";
389
390                 if (mode & CRYPTO_READ)
391                         rw_text="r";
392                 else if (mode & CRYPTO_WRITE)
393                         rw_text="w";
394                 else
395                         rw_text="ERROR";
396
397                 fprintf(stderr,"lock:%08lx:(%s)%s %-18s %s:%d\n",
398                         CRYPTO_thread_id(), rw_text, operation_text,
399                         CRYPTO_get_lock_name(type), file, line);
400                 }
401 #endif
402         if (type < 0)
403                 {
404                 struct CRYPTO_dynlock_value *pointer
405                         = CRYPTO_get_dynlock_value(type);
406
407                 if (pointer && dynlock_lock_callback)
408                         {
409                         dynlock_lock_callback(mode, pointer, file, line);
410                         }
411
412                 CRYPTO_destroy_dynlockid(type);
413                 }
414         else
415                 if (locking_callback != NULL)
416                         locking_callback(mode,type,file,line);
417         }
418
419 int CRYPTO_add_lock(int *pointer, int amount, int type, const char *file,
420              int line)
421         {
422         int ret = 0;
423
424         if (add_lock_callback != NULL)
425                 {
426 #ifdef LOCK_DEBUG
427                 int before= *pointer;
428 #endif
429
430                 ret=add_lock_callback(pointer,amount,type,file,line);
431 #ifdef LOCK_DEBUG
432                 fprintf(stderr,"ladd:%08lx:%2d+%2d->%2d %-18s %s:%d\n",
433                         CRYPTO_thread_id(),
434                         before,amount,ret,
435                         CRYPTO_get_lock_name(type),
436                         file,line);
437 #endif
438                 }
439         else
440                 {
441                 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,file,line);
442
443                 ret= *pointer+amount;
444 #ifdef LOCK_DEBUG
445                 fprintf(stderr,"ladd:%08lx:%2d+%2d->%2d %-18s %s:%d\n",
446                         CRYPTO_thread_id(),
447                         *pointer,amount,ret,
448                         CRYPTO_get_lock_name(type),
449                         file,line);
450 #endif
451                 *pointer=ret;
452                 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,file,line);
453                 }
454         return(ret);
455         }
456
457 const char *CRYPTO_get_lock_name(int type)
458         {
459         if (type < 0)
460                 return("dynamic");
461         else if (type < CRYPTO_NUM_LOCKS)
462                 return(lock_names[type]);
463         else if (type-CRYPTO_NUM_LOCKS >= sk_num(app_locks))
464                 return("ERROR");
465         else
466                 return(sk_value(app_locks,type-CRYPTO_NUM_LOCKS));
467         }
468
469 #ifdef _DLL
470 #ifdef OPENSSL_SYS_WIN32
471
472 /* All we really need to do is remove the 'error' state when a thread
473  * detaches */
474
475 BOOL WINAPI DLLEntryPoint(HINSTANCE hinstDLL, DWORD fdwReason,
476              LPVOID lpvReserved)
477         {
478         switch(fdwReason)
479                 {
480         case DLL_PROCESS_ATTACH:
481                 break;
482         case DLL_THREAD_ATTACH:
483                 break;
484         case DLL_THREAD_DETACH:
485                 ERR_remove_state(0);
486                 break;
487         case DLL_PROCESS_DETACH:
488                 break;
489                 }
490         return(TRUE);
491         }
492 #endif
493
494 #endif