1 /* ====================================================================
2 * Copyright (c) 2014 The OpenSSL Project. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
16 * 3. All advertising materials mentioning features or use of this
17 * software must display the following acknowledgment:
18 * "This product includes software developed by the OpenSSL Project
19 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22 * endorse or promote products derived from this software without
23 * prior written permission. For written permission, please contact
24 * openssl-core@openssl.org.
26 * 5. Products derived from this software may not be called "OpenSSL"
27 * nor may "OpenSSL" appear in their names without prior written
28 * permission of the OpenSSL Project.
30 * 6. Redistributions of any form whatsoever must retain the following
32 * "This product includes software developed by the OpenSSL Project
33 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46 * OF THE POSSIBILITY OF SUCH DAMAGE.
47 * ====================================================================
49 * This product includes cryptographic software written by Eric Young
50 * (eay@cryptsoft.com). This product includes software written by Tim
51 * Hudson (tjh@cryptsoft.com).
55 /* Custom extension utility functions */
60 /* Find a custom extension from the list. */
61 static custom_ext_method
*custom_ext_find(custom_ext_methods
*exts
,
62 unsigned int ext_type
)
65 custom_ext_method
*meth
= exts
->meths
;
66 for (i
= 0; i
< exts
->meths_count
; i
++, meth
++) {
67 if (ext_type
== meth
->ext_type
)
74 * Initialise custom extensions flags to indicate neither sent nor received.
76 void custom_ext_init(custom_ext_methods
*exts
)
79 custom_ext_method
*meth
= exts
->meths
;
80 for (i
= 0; i
< exts
->meths_count
; i
++, meth
++)
84 /* Pass received custom extension data to the application for parsing. */
85 int custom_ext_parse(SSL
*s
, int server
,
86 unsigned int ext_type
,
87 const unsigned char *ext_data
, size_t ext_size
, int *al
)
89 custom_ext_methods
*exts
= server
? &s
->cert
->srv_ext
: &s
->cert
->cli_ext
;
90 custom_ext_method
*meth
;
91 meth
= custom_ext_find(exts
, ext_type
);
92 /* If not found return success */
97 * If it's ServerHello we can't have any extensions not sent in
100 if (!(meth
->ext_flags
& SSL_EXT_FLAG_SENT
)) {
101 *al
= TLS1_AD_UNSUPPORTED_EXTENSION
;
105 /* If already present it's a duplicate */
106 if (meth
->ext_flags
& SSL_EXT_FLAG_RECEIVED
) {
107 *al
= TLS1_AD_DECODE_ERROR
;
110 meth
->ext_flags
|= SSL_EXT_FLAG_RECEIVED
;
111 /* If no parse function set return success */
115 return meth
->parse_cb(s
, ext_type
, ext_data
, ext_size
, al
,
120 * Request custom extension data from the application and add to the return
123 int custom_ext_add(SSL
*s
, int server
,
124 unsigned char **pret
, unsigned char *limit
, int *al
)
126 custom_ext_methods
*exts
= server
? &s
->cert
->srv_ext
: &s
->cert
->cli_ext
;
127 custom_ext_method
*meth
;
128 unsigned char *ret
= *pret
;
131 for (i
= 0; i
< exts
->meths_count
; i
++) {
132 const unsigned char *out
= NULL
;
134 meth
= exts
->meths
+ i
;
138 * For ServerHello only send extensions present in ClientHello.
140 if (!(meth
->ext_flags
& SSL_EXT_FLAG_RECEIVED
))
142 /* If callback absent for server skip it */
148 cb_retval
= meth
->add_cb(s
, meth
->ext_type
,
149 &out
, &outlen
, al
, meth
->add_arg
);
151 return 0; /* error */
153 continue; /* skip this extension */
155 if (4 > limit
- ret
|| outlen
> (size_t)(limit
- ret
- 4))
157 s2n(meth
->ext_type
, ret
);
160 memcpy(ret
, out
, outlen
);
164 * We can't send duplicates: code logic should prevent this.
166 OPENSSL_assert(!(meth
->ext_flags
& SSL_EXT_FLAG_SENT
));
168 * Indicate extension has been sent: this is both a sanity check to
169 * ensure we don't send duplicate extensions and indicates that it is
170 * not an error if the extension is present in ServerHello.
172 meth
->ext_flags
|= SSL_EXT_FLAG_SENT
;
174 meth
->free_cb(s
, meth
->ext_type
, out
, meth
->add_arg
);
180 /* Copy table of custom extensions */
181 int custom_exts_copy(custom_ext_methods
*dst
, const custom_ext_methods
*src
)
183 if (src
->meths_count
) {
185 OPENSSL_memdup(src
->meths
,
186 sizeof(custom_ext_method
) * src
->meths_count
);
187 if (dst
->meths
== NULL
)
189 dst
->meths_count
= src
->meths_count
;
194 void custom_exts_free(custom_ext_methods
*exts
)
196 OPENSSL_free(exts
->meths
);
199 /* Set callbacks for a custom extension. */
200 static int custom_ext_meth_add(custom_ext_methods
*exts
,
201 unsigned int ext_type
,
202 custom_ext_add_cb add_cb
,
203 custom_ext_free_cb free_cb
,
205 custom_ext_parse_cb parse_cb
, void *parse_arg
)
207 custom_ext_method
*meth
;
209 * Check application error: if add_cb is not set free_cb will never be
212 if (!add_cb
&& free_cb
)
214 /* Don't add if extension supported internally. */
215 if (SSL_extension_supported(ext_type
))
217 /* Extension type must fit in 16 bits */
218 if (ext_type
> 0xffff)
220 /* Search for duplicate */
221 if (custom_ext_find(exts
, ext_type
))
223 exts
->meths
= OPENSSL_realloc(exts
->meths
,
225 1) * sizeof(custom_ext_method
));
228 exts
->meths_count
= 0;
232 meth
= exts
->meths
+ exts
->meths_count
;
233 memset(meth
, 0, sizeof(*meth
));
234 meth
->parse_cb
= parse_cb
;
235 meth
->add_cb
= add_cb
;
236 meth
->free_cb
= free_cb
;
237 meth
->ext_type
= ext_type
;
238 meth
->add_arg
= add_arg
;
239 meth
->parse_arg
= parse_arg
;
244 /* Application level functions to add custom extension callbacks */
245 int SSL_CTX_add_client_custom_ext(SSL_CTX
*ctx
, unsigned int ext_type
,
246 custom_ext_add_cb add_cb
,
247 custom_ext_free_cb free_cb
,
249 custom_ext_parse_cb parse_cb
,
252 return custom_ext_meth_add(&ctx
->cert
->cli_ext
, ext_type
,
253 add_cb
, free_cb
, add_arg
, parse_cb
, parse_arg
);
256 int SSL_CTX_add_server_custom_ext(SSL_CTX
*ctx
, unsigned int ext_type
,
257 custom_ext_add_cb add_cb
,
258 custom_ext_free_cb free_cb
,
260 custom_ext_parse_cb parse_cb
,
263 return custom_ext_meth_add(&ctx
->cert
->srv_ext
, ext_type
,
264 add_cb
, free_cb
, add_arg
, parse_cb
, parse_arg
);
267 int SSL_extension_supported(unsigned int ext_type
)
270 /* Internally supported extensions. */
271 case TLSEXT_TYPE_application_layer_protocol_negotiation
:
272 case TLSEXT_TYPE_ec_point_formats
:
273 case TLSEXT_TYPE_elliptic_curves
:
274 case TLSEXT_TYPE_heartbeat
:
275 case TLSEXT_TYPE_next_proto_neg
:
276 case TLSEXT_TYPE_padding
:
277 case TLSEXT_TYPE_renegotiate
:
278 case TLSEXT_TYPE_server_name
:
279 case TLSEXT_TYPE_session_ticket
:
280 case TLSEXT_TYPE_signature_algorithms
:
281 case TLSEXT_TYPE_srp
:
282 case TLSEXT_TYPE_status_request
:
283 case TLSEXT_TYPE_use_srtp
:
284 #ifdef TLSEXT_TYPE_encrypt_then_mac
285 case TLSEXT_TYPE_encrypt_then_mac
: