Avoid undefined results when the parameter is out of range.
[openssl.git] / crypto / stack / stack.c
1 /* crypto/stack/stack.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 /* Code for stacks
60  * Author - Eric Young v 1.0
61  * 1.2 eay 12-Mar-97 -  Modified sk_find so that it _DOES_ return the
62  *                      lowest index for the searched item.
63  *
64  * 1.1 eay - Take from netdb and added to SSLeay
65  *
66  * 1.0 eay - First version 29/07/92
67  */
68 #include <stdio.h>
69 #include "cryptlib.h"
70 #include <openssl/stack.h>
71 #include <openssl/objects.h>
72
73 #undef MIN_NODES
74 #define MIN_NODES       4
75
76 const char *STACK_version="Stack" OPENSSL_VERSION_PTEXT;
77
78 #include <errno.h>
79
80 int (*sk_set_cmp_func(STACK *sk, int (*c)(const char * const *,const char * const *)))
81                 (const char * const *, const char * const *)
82         {
83         int (*old)(const char * const *,const char * const *)=sk->comp;
84
85         if (sk->comp != c)
86                 sk->sorted=0;
87         sk->comp=c;
88
89         return old;
90         }
91
92 STACK *sk_dup(STACK *sk)
93         {
94         STACK *ret;
95         char **s;
96
97         if ((ret=sk_new(sk->comp)) == NULL) goto err;
98         s=(char **)OPENSSL_realloc((char *)ret->data,
99                 (unsigned int)sizeof(char *)*sk->num_alloc);
100         if (s == NULL) goto err;
101         ret->data=s;
102
103         ret->num=sk->num;
104         memcpy(ret->data,sk->data,sizeof(char *)*sk->num);
105         ret->sorted=sk->sorted;
106         ret->num_alloc=sk->num_alloc;
107         ret->comp=sk->comp;
108         return(ret);
109 err:
110         if(ret)
111                 sk_free(ret);
112         return(NULL);
113         }
114
115 STACK *sk_new_null(void)
116         {
117         return sk_new((int (*)(const char * const *, const char * const *))0);
118         }
119
120 STACK *sk_new(int (*c)(const char * const *, const char * const *))
121         {
122         STACK *ret;
123         int i;
124
125         if ((ret=(STACK *)OPENSSL_malloc(sizeof(STACK))) == NULL)
126                 goto err;
127         if ((ret->data=(char **)OPENSSL_malloc(sizeof(char *)*MIN_NODES)) == NULL)
128                 goto err;
129         for (i=0; i<MIN_NODES; i++)
130                 ret->data[i]=NULL;
131         ret->comp=c;
132         ret->num_alloc=MIN_NODES;
133         ret->num=0;
134         ret->sorted=0;
135         return(ret);
136 err:
137         if(ret)
138                 OPENSSL_free(ret);
139         return(NULL);
140         }
141
142 int sk_insert(STACK *st, char *data, int loc)
143         {
144         char **s;
145
146         if(st == NULL) return 0;
147         if (st->num_alloc <= st->num+1)
148                 {
149                 s=(char **)OPENSSL_realloc((char *)st->data,
150                         (unsigned int)sizeof(char *)*st->num_alloc*2);
151                 if (s == NULL)
152                         return(0);
153                 st->data=s;
154                 st->num_alloc*=2;
155                 }
156         if ((loc >= (int)st->num) || (loc < 0))
157                 st->data[st->num]=data;
158         else
159                 {
160                 int i;
161                 char **f,**t;
162
163                 f=(char **)st->data;
164                 t=(char **)&(st->data[1]);
165                 for (i=st->num; i>=loc; i--)
166                         t[i]=f[i];
167                         
168 #ifdef undef /* no memmove on sunos :-( */
169                 memmove( (char *)&(st->data[loc+1]),
170                         (char *)&(st->data[loc]),
171                         sizeof(char *)*(st->num-loc));
172 #endif
173                 st->data[loc]=data;
174                 }
175         st->num++;
176         st->sorted=0;
177         return(st->num);
178         }
179
180 char *sk_delete_ptr(STACK *st, char *p)
181         {
182         int i;
183
184         for (i=0; i<st->num; i++)
185                 if (st->data[i] == p)
186                         return(sk_delete(st,i));
187         return(NULL);
188         }
189
190 char *sk_delete(STACK *st, int loc)
191         {
192         char *ret;
193         int i,j;
194
195         if ((st == NULL) || (st->num == 0) || (loc < 0)
196                                          || (loc >= st->num)) return(NULL);
197
198         ret=st->data[loc];
199         if (loc != st->num-1)
200                 {
201                 j=st->num-1;
202                 for (i=loc; i<j; i++)
203                         st->data[i]=st->data[i+1];
204                 /* In theory memcpy is not safe for this
205                  * memcpy( &(st->data[loc]),
206                  *      &(st->data[loc+1]),
207                  *      sizeof(char *)*(st->num-loc-1));
208                  */
209                 }
210         st->num--;
211         return(ret);
212         }
213
214 static int internal_find(STACK *st, char *data, int ret_val_options)
215         {
216         char **r;
217         int i;
218         int (*comp_func)(const void *,const void *);
219         if(st == NULL) return -1;
220
221         if (st->comp == NULL)
222                 {
223                 for (i=0; i<st->num; i++)
224                         if (st->data[i] == data)
225                                 return(i);
226                 return(-1);
227                 }
228         sk_sort(st);
229         if (data == NULL) return(-1);
230         /* This (and the "qsort" below) are the two places in OpenSSL
231          * where we need to convert from our standard (type **,type **)
232          * compare callback type to the (void *,void *) type required by
233          * bsearch. However, the "data" it is being called(back) with are
234          * not (type *) pointers, but the *pointers* to (type *) pointers,
235          * so we get our extra level of pointer dereferencing that way. */
236         comp_func=(int (*)(const void *,const void *))(st->comp);
237         r=(char **)OBJ_bsearch_ex((char *)&data,(char *)st->data,
238                 st->num,sizeof(char *),comp_func,ret_val_options);
239         if (r == NULL) return(-1);
240         return((int)(r-st->data));
241         }
242
243 int sk_find(STACK *st, char *data)
244         {
245         return internal_find(st, data, OBJ_BSEARCH_FIRST_VALUE_ON_MATCH);
246         }
247 int sk_find_ex(STACK *st, char *data)
248         {
249         return internal_find(st, data, OBJ_BSEARCH_VALUE_ON_NOMATCH);
250         }
251
252 int sk_push(STACK *st, char *data)
253         {
254         return(sk_insert(st,data,st->num));
255         }
256
257 int sk_unshift(STACK *st, char *data)
258         {
259         return(sk_insert(st,data,0));
260         }
261
262 char *sk_shift(STACK *st)
263         {
264         if (st == NULL) return(NULL);
265         if (st->num <= 0) return(NULL);
266         return(sk_delete(st,0));
267         }
268
269 char *sk_pop(STACK *st)
270         {
271         if (st == NULL) return(NULL);
272         if (st->num <= 0) return(NULL);
273         return(sk_delete(st,st->num-1));
274         }
275
276 void sk_zero(STACK *st)
277         {
278         if (st == NULL) return;
279         if (st->num <= 0) return;
280         memset((char *)st->data,0,sizeof(st->data)*st->num);
281         st->num=0;
282         }
283
284 void sk_pop_free(STACK *st, void (*func)(void *))
285         {
286         int i;
287
288         if (st == NULL) return;
289         for (i=0; i<st->num; i++)
290                 if (st->data[i] != NULL)
291                         func(st->data[i]);
292         sk_free(st);
293         }
294
295 void sk_free(STACK *st)
296         {
297         if (st == NULL) return;
298         if (st->data != NULL) OPENSSL_free(st->data);
299         OPENSSL_free(st);
300         }
301
302 int sk_num(const STACK *st)
303 {
304         if(st == NULL) return -1;
305         return st->num;
306 }
307
308 char *sk_value(const STACK *st, int i)
309 {
310         if(!st || (i < 0) || (i >= st->num)) return NULL;
311         return st->data[i];
312 }
313
314 char *sk_set(STACK *st, int i, char *value)
315 {
316         if(st == NULL) return NULL;
317         return (st->data[i] = value);
318 }
319
320 void sk_sort(STACK *st)
321         {
322         if (st && !st->sorted)
323                 {
324                 int (*comp_func)(const void *,const void *);
325
326                 /* same comment as in sk_find ... previously st->comp was declared
327                  * as a (void*,void*) callback type, but this made the population
328                  * of the callback pointer illogical - our callbacks compare
329                  * type** with type**, so we leave the casting until absolutely
330                  * necessary (ie. "now"). */
331                 comp_func=(int (*)(const void *,const void *))(st->comp);
332                 qsort(st->data,st->num,sizeof(char *), comp_func);
333                 st->sorted=1;
334                 }
335         }