Move bitmap and next_bitmap from s->d1 to s->rlayer.d.
[openssl.git] / ssl / record / dtls1_bitmap.c
1 /* ssl/record/dtls1_bitmap.c */
2 /*
3  * DTLS implementation written by Nagendra Modadugu
4  * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.
5  */
6 /* ====================================================================
7  * Copyright (c) 1998-2015 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in
18  *    the documentation and/or other materials provided with the
19  *    distribution.
20  *
21  * 3. All advertising materials mentioning features or use of this
22  *    software must display the following acknowledgment:
23  *    "This product includes software developed by the OpenSSL Project
24  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
25  *
26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27  *    endorse or promote products derived from this software without
28  *    prior written permission. For written permission, please contact
29  *    openssl-core@openssl.org.
30  *
31  * 5. Products derived from this software may not be called "OpenSSL"
32  *    nor may "OpenSSL" appear in their names without prior written
33  *    permission of the OpenSSL Project.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This product includes cryptographic software written by Eric Young
55  * (eay@cryptsoft.com).  This product includes software written by Tim
56  * Hudson (tjh@cryptsoft.com).
57  *
58  */
59 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
60  * All rights reserved.
61  *
62  * This package is an SSL implementation written
63  * by Eric Young (eay@cryptsoft.com).
64  * The implementation was written so as to conform with Netscapes SSL.
65  *
66  * This library is free for commercial and non-commercial use as long as
67  * the following conditions are aheared to.  The following conditions
68  * apply to all code found in this distribution, be it the RC4, RSA,
69  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
70  * included with this distribution is covered by the same copyright terms
71  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
72  *
73  * Copyright remains Eric Young's, and as such any Copyright notices in
74  * the code are not to be removed.
75  * If this package is used in a product, Eric Young should be given attribution
76  * as the author of the parts of the library used.
77  * This can be in the form of a textual message at program startup or
78  * in documentation (online or textual) provided with the package.
79  *
80  * Redistribution and use in source and binary forms, with or without
81  * modification, are permitted provided that the following conditions
82  * are met:
83  * 1. Redistributions of source code must retain the copyright
84  *    notice, this list of conditions and the following disclaimer.
85  * 2. Redistributions in binary form must reproduce the above copyright
86  *    notice, this list of conditions and the following disclaimer in the
87  *    documentation and/or other materials provided with the distribution.
88  * 3. All advertising materials mentioning features or use of this software
89  *    must display the following acknowledgement:
90  *    "This product includes cryptographic software written by
91  *     Eric Young (eay@cryptsoft.com)"
92  *    The word 'cryptographic' can be left out if the rouines from the library
93  *    being used are not cryptographic related :-).
94  * 4. If you include any Windows specific code (or a derivative thereof) from
95  *    the apps directory (application code) you must include an acknowledgement:
96  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
97  *
98  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
99  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
100  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
101  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
102  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
103  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
104  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
105  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
106  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
107  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
108  * SUCH DAMAGE.
109  *
110  * The licence and distribution terms for any publically available version or
111  * derivative of this code cannot be changed.  i.e. this code cannot simply be
112  * copied and put under another distribution licence
113  * [including the GNU Public Licence.]
114  */
115
116 #include "../ssl_locl.h"
117
118 /* mod 128 saturating subtract of two 64-bit values in big-endian order */
119 static int satsub64be(const unsigned char *v1, const unsigned char *v2)
120 {
121     int ret, sat, brw, i;
122
123     if (sizeof(long) == 8)
124         do {
125             const union {
126                 long one;
127                 char little;
128             } is_endian = {
129                 1
130             };
131             long l;
132
133             if (is_endian.little)
134                 break;
135             /* not reached on little-endians */
136             /*
137              * following test is redundant, because input is always aligned,
138              * but I take no chances...
139              */
140             if (((size_t)v1 | (size_t)v2) & 0x7)
141                 break;
142
143             l = *((long *)v1);
144             l -= *((long *)v2);
145             if (l > 128)
146                 return 128;
147             else if (l < -128)
148                 return -128;
149             else
150                 return (int)l;
151         } while (0);
152
153     ret = (int)v1[7] - (int)v2[7];
154     sat = 0;
155     brw = ret >> 8;             /* brw is either 0 or -1 */
156     if (ret & 0x80) {
157         for (i = 6; i >= 0; i--) {
158             brw += (int)v1[i] - (int)v2[i];
159             sat |= ~brw;
160             brw >>= 8;
161         }
162     } else {
163         for (i = 6; i >= 0; i--) {
164             brw += (int)v1[i] - (int)v2[i];
165             sat |= brw;
166             brw >>= 8;
167         }
168     }
169     brw <<= 8;                  /* brw is either 0 or -256 */
170
171     if (sat & 0xff)
172         return brw | 0x80;
173     else
174         return brw + (ret & 0xFF);
175 }
176
177 int dtls1_record_replay_check(SSL *s, DTLS1_BITMAP *bitmap)
178 {
179     int cmp;
180     unsigned int shift;
181     const unsigned char *seq = s->rlayer.read_sequence;
182
183     cmp = satsub64be(seq, bitmap->max_seq_num);
184     if (cmp > 0) {
185         SSL3_RECORD_set_seq_num(RECORD_LAYER_get_rrec(&s->rlayer), seq);
186         return 1;               /* this record in new */
187     }
188     shift = -cmp;
189     if (shift >= sizeof(bitmap->map) * 8)
190         return 0;               /* stale, outside the window */
191     else if (bitmap->map & (1UL << shift))
192         return 0;               /* record previously received */
193
194     SSL3_RECORD_set_seq_num(RECORD_LAYER_get_rrec(&s->rlayer), seq);
195     return 1;
196 }
197
198 void dtls1_record_bitmap_update(SSL *s, DTLS1_BITMAP *bitmap)
199 {
200     int cmp;
201     unsigned int shift;
202     const unsigned char *seq = RECORD_LAYER_get_read_sequence(&s->rlayer);
203
204     cmp = satsub64be(seq, bitmap->max_seq_num);
205     if (cmp > 0) {
206         shift = cmp;
207         if (shift < sizeof(bitmap->map) * 8)
208             bitmap->map <<= shift, bitmap->map |= 1UL;
209         else
210             bitmap->map = 1UL;
211         memcpy(bitmap->max_seq_num, seq, 8);
212     } else {
213         shift = -cmp;
214         if (shift < sizeof(bitmap->map) * 8)
215             bitmap->map |= 1UL << shift;
216     }
217 }