2 * TLS v1.0/v1.1/v1.2 server (RFC 2246, RFC 4346, RFC 5246)
3 * Copyright (c) 2006-2011, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
12 #include "crypto/sha1.h"
13 #include "crypto/tls.h"
14 #include "tlsv1_common.h"
15 #include "tlsv1_record.h"
16 #include "tlsv1_server.h"
17 #include "tlsv1_server_i.h"
20 * Support for a message fragmented across several records (RFC 2246, 6.2.1)
24 void tlsv1_server_alert(struct tlsv1_server *conn, u8 level, u8 description)
26 conn->alert_level = level;
27 conn->alert_description = description;
31 int tlsv1_server_derive_keys(struct tlsv1_server *conn,
32 const u8 *pre_master_secret,
33 size_t pre_master_secret_len)
35 u8 seed[2 * TLS_RANDOM_LEN];
36 u8 key_block[TLS_MAX_KEY_BLOCK_LEN];
40 if (pre_master_secret) {
41 wpa_hexdump_key(MSG_MSGDUMP, "TLSv1: pre_master_secret",
42 pre_master_secret, pre_master_secret_len);
43 os_memcpy(seed, conn->client_random, TLS_RANDOM_LEN);
44 os_memcpy(seed + TLS_RANDOM_LEN, conn->server_random,
46 if (tls_prf(conn->rl.tls_version,
47 pre_master_secret, pre_master_secret_len,
48 "master secret", seed, 2 * TLS_RANDOM_LEN,
49 conn->master_secret, TLS_MASTER_SECRET_LEN)) {
50 wpa_printf(MSG_DEBUG, "TLSv1: Failed to derive "
54 wpa_hexdump_key(MSG_MSGDUMP, "TLSv1: master_secret",
55 conn->master_secret, TLS_MASTER_SECRET_LEN);
58 os_memcpy(seed, conn->server_random, TLS_RANDOM_LEN);
59 os_memcpy(seed + TLS_RANDOM_LEN, conn->client_random, TLS_RANDOM_LEN);
60 key_block_len = 2 * (conn->rl.hash_size + conn->rl.key_material_len +
62 if (tls_prf(conn->rl.tls_version,
63 conn->master_secret, TLS_MASTER_SECRET_LEN,
64 "key expansion", seed, 2 * TLS_RANDOM_LEN,
65 key_block, key_block_len)) {
66 wpa_printf(MSG_DEBUG, "TLSv1: Failed to derive key_block");
69 wpa_hexdump_key(MSG_MSGDUMP, "TLSv1: key_block",
70 key_block, key_block_len);
74 /* client_write_MAC_secret */
75 os_memcpy(conn->rl.read_mac_secret, pos, conn->rl.hash_size);
76 pos += conn->rl.hash_size;
77 /* server_write_MAC_secret */
78 os_memcpy(conn->rl.write_mac_secret, pos, conn->rl.hash_size);
79 pos += conn->rl.hash_size;
81 /* client_write_key */
82 os_memcpy(conn->rl.read_key, pos, conn->rl.key_material_len);
83 pos += conn->rl.key_material_len;
84 /* server_write_key */
85 os_memcpy(conn->rl.write_key, pos, conn->rl.key_material_len);
86 pos += conn->rl.key_material_len;
89 os_memcpy(conn->rl.read_iv, pos, conn->rl.iv_size);
90 pos += conn->rl.iv_size;
92 os_memcpy(conn->rl.write_iv, pos, conn->rl.iv_size);
93 pos += conn->rl.iv_size;
100 * tlsv1_server_handshake - Process TLS handshake
101 * @conn: TLSv1 server connection data from tlsv1_server_init()
102 * @in_data: Input data from TLS peer
103 * @in_len: Input data length
104 * @out_len: Length of the output buffer.
105 * Returns: Pointer to output data, %NULL on failure
107 u8 * tlsv1_server_handshake(struct tlsv1_server *conn,
108 const u8 *in_data, size_t in_len,
112 u8 *msg = NULL, *in_msg, *in_pos, *in_end, alert, ct;
116 if (in_data == NULL || in_len == 0) {
117 wpa_printf(MSG_DEBUG, "TLSv1: No input data to server");
122 end = in_data + in_len;
123 in_msg = os_malloc(in_len);
127 /* Each received packet may include multiple records */
130 used = tlsv1_record_receive(&conn->rl, pos, end - pos,
131 in_msg, &in_msg_len, &alert);
133 wpa_printf(MSG_DEBUG, "TLSv1: Processing received "
135 tlsv1_server_alert(conn, TLS_ALERT_LEVEL_FATAL, alert);
140 wpa_printf(MSG_DEBUG, "TLSv1: Partial processing not "
142 tlsv1_server_alert(conn, TLS_ALERT_LEVEL_FATAL, alert);
148 in_end = in_msg + in_msg_len;
150 /* Each received record may include multiple messages of the
151 * same ContentType. */
152 while (in_pos < in_end) {
153 in_msg_len = in_end - in_pos;
154 if (tlsv1_server_process_handshake(conn, ct, in_pos,
157 in_pos += in_msg_len;
166 msg = tlsv1_server_handshake_write(conn, out_len);
170 if (conn->alert_level) {
171 if (conn->state == FAILED) {
172 /* Avoid alert loops */
173 wpa_printf(MSG_DEBUG, "TLSv1: Drop alert loop");
177 conn->state = FAILED;
179 msg = tlsv1_server_send_alert(conn, conn->alert_level,
180 conn->alert_description,
189 * tlsv1_server_encrypt - Encrypt data into TLS tunnel
190 * @conn: TLSv1 server connection data from tlsv1_server_init()
191 * @in_data: Pointer to plaintext data to be encrypted
192 * @in_len: Input buffer length
193 * @out_data: Pointer to output buffer (encrypted TLS data)
194 * @out_len: Maximum out_data length
195 * Returns: Number of bytes written to out_data, -1 on failure
197 * This function is used after TLS handshake has been completed successfully to
198 * send data in the encrypted tunnel.
200 int tlsv1_server_encrypt(struct tlsv1_server *conn,
201 const u8 *in_data, size_t in_len,
202 u8 *out_data, size_t out_len)
206 wpa_hexdump_key(MSG_MSGDUMP, "TLSv1: Plaintext AppData",
209 if (tlsv1_record_send(&conn->rl, TLS_CONTENT_TYPE_APPLICATION_DATA,
210 out_data, out_len, in_data, in_len, &rlen) < 0) {
211 wpa_printf(MSG_DEBUG, "TLSv1: Failed to create a record");
212 tlsv1_server_alert(conn, TLS_ALERT_LEVEL_FATAL,
213 TLS_ALERT_INTERNAL_ERROR);
222 * tlsv1_server_decrypt - Decrypt data from TLS tunnel
223 * @conn: TLSv1 server connection data from tlsv1_server_init()
224 * @in_data: Pointer to input buffer (encrypted TLS data)
225 * @in_len: Input buffer length
226 * @out_data: Pointer to output buffer (decrypted data from TLS tunnel)
227 * @out_len: Maximum out_data length
228 * Returns: Number of bytes written to out_data, -1 on failure
230 * This function is used after TLS handshake has been completed successfully to
231 * receive data from the encrypted tunnel.
233 int tlsv1_server_decrypt(struct tlsv1_server *conn,
234 const u8 *in_data, size_t in_len,
235 u8 *out_data, size_t out_len)
237 const u8 *in_end, *pos;
239 u8 alert, *out_end, *out_pos, ct;
243 in_end = in_data + in_len;
245 out_end = out_data + out_len;
247 while (pos < in_end) {
249 olen = out_end - out_pos;
250 used = tlsv1_record_receive(&conn->rl, pos, in_end - pos,
251 out_pos, &olen, &alert);
253 wpa_printf(MSG_DEBUG, "TLSv1: Record layer processing "
255 tlsv1_server_alert(conn, TLS_ALERT_LEVEL_FATAL, alert);
260 wpa_printf(MSG_DEBUG, "TLSv1: Partial processing not "
262 tlsv1_server_alert(conn, TLS_ALERT_LEVEL_FATAL, alert);
266 if (ct == TLS_CONTENT_TYPE_ALERT) {
268 wpa_printf(MSG_DEBUG, "TLSv1: Alert "
270 tlsv1_server_alert(conn, TLS_ALERT_LEVEL_FATAL,
271 TLS_ALERT_DECODE_ERROR);
274 wpa_printf(MSG_DEBUG, "TLSv1: Received alert %d:%d",
275 out_pos[0], out_pos[1]);
276 if (out_pos[0] == TLS_ALERT_LEVEL_WARNING) {
277 /* Continue processing */
282 tlsv1_server_alert(conn, TLS_ALERT_LEVEL_FATAL,
287 if (ct != TLS_CONTENT_TYPE_APPLICATION_DATA) {
288 wpa_printf(MSG_DEBUG, "TLSv1: Unexpected content type "
290 tlsv1_server_alert(conn, TLS_ALERT_LEVEL_FATAL,
291 TLS_ALERT_UNEXPECTED_MESSAGE);
296 if (out_pos > out_end) {
297 wpa_printf(MSG_DEBUG, "TLSv1: Buffer not large enough "
298 "for processing the received record");
299 tlsv1_server_alert(conn, TLS_ALERT_LEVEL_FATAL,
300 TLS_ALERT_INTERNAL_ERROR);
307 return out_pos - out_data;
312 * tlsv1_server_global_init - Initialize TLSv1 server
313 * Returns: 0 on success, -1 on failure
315 * This function must be called before using any other TLSv1 server functions.
317 int tlsv1_server_global_init(void)
319 return crypto_global_init();
324 * tlsv1_server_global_deinit - Deinitialize TLSv1 server
326 * This function can be used to deinitialize the TLSv1 server that was
327 * initialized by calling tlsv1_server_global_init(). No TLSv1 server functions
328 * can be called after this before calling tlsv1_server_global_init() again.
330 void tlsv1_server_global_deinit(void)
332 crypto_global_deinit();
337 * tlsv1_server_init - Initialize TLSv1 server connection
338 * @cred: Pointer to server credentials from tlsv1_server_cred_alloc()
339 * Returns: Pointer to TLSv1 server connection data or %NULL on failure
341 struct tlsv1_server * tlsv1_server_init(struct tlsv1_credentials *cred)
343 struct tlsv1_server *conn;
347 conn = os_zalloc(sizeof(*conn));
353 conn->state = CLIENT_HELLO;
355 if (tls_verify_hash_init(&conn->verify) < 0) {
356 wpa_printf(MSG_DEBUG, "TLSv1: Failed to initialize verify "
363 suites = conn->cipher_suites;
364 #ifndef CONFIG_CRYPTO_INTERNAL
365 suites[count++] = TLS_RSA_WITH_AES_256_CBC_SHA;
366 #endif /* CONFIG_CRYPTO_INTERNAL */
367 suites[count++] = TLS_RSA_WITH_AES_128_CBC_SHA;
368 suites[count++] = TLS_RSA_WITH_3DES_EDE_CBC_SHA;
369 suites[count++] = TLS_RSA_WITH_RC4_128_SHA;
370 suites[count++] = TLS_RSA_WITH_RC4_128_MD5;
371 conn->num_cipher_suites = count;
377 static void tlsv1_server_clear_data(struct tlsv1_server *conn)
379 tlsv1_record_set_cipher_suite(&conn->rl, TLS_NULL_WITH_NULL_NULL);
380 tlsv1_record_change_write_cipher(&conn->rl);
381 tlsv1_record_change_read_cipher(&conn->rl);
382 tls_verify_hash_free(&conn->verify);
384 crypto_public_key_free(conn->client_rsa_key);
385 conn->client_rsa_key = NULL;
387 os_free(conn->session_ticket);
388 conn->session_ticket = NULL;
389 conn->session_ticket_len = 0;
390 conn->use_session_ticket = 0;
392 os_free(conn->dh_secret);
393 conn->dh_secret = NULL;
394 conn->dh_secret_len = 0;
399 * tlsv1_server_deinit - Deinitialize TLSv1 server connection
400 * @conn: TLSv1 server connection data from tlsv1_server_init()
402 void tlsv1_server_deinit(struct tlsv1_server *conn)
404 tlsv1_server_clear_data(conn);
410 * tlsv1_server_established - Check whether connection has been established
411 * @conn: TLSv1 server connection data from tlsv1_server_init()
412 * Returns: 1 if connection is established, 0 if not
414 int tlsv1_server_established(struct tlsv1_server *conn)
416 return conn->state == ESTABLISHED;
421 * tlsv1_server_prf - Use TLS-PRF to derive keying material
422 * @conn: TLSv1 server connection data from tlsv1_server_init()
423 * @label: Label (e.g., description of the key) for PRF
424 * @server_random_first: seed is 0 = client_random|server_random,
425 * 1 = server_random|client_random
426 * @out: Buffer for output data from TLS-PRF
427 * @out_len: Length of the output buffer
428 * Returns: 0 on success, -1 on failure
430 int tlsv1_server_prf(struct tlsv1_server *conn, const char *label,
431 int server_random_first, u8 *out, size_t out_len)
433 u8 seed[2 * TLS_RANDOM_LEN];
435 if (conn->state != ESTABLISHED)
438 if (server_random_first) {
439 os_memcpy(seed, conn->server_random, TLS_RANDOM_LEN);
440 os_memcpy(seed + TLS_RANDOM_LEN, conn->client_random,
443 os_memcpy(seed, conn->client_random, TLS_RANDOM_LEN);
444 os_memcpy(seed + TLS_RANDOM_LEN, conn->server_random,
448 return tls_prf(conn->rl.tls_version,
449 conn->master_secret, TLS_MASTER_SECRET_LEN,
450 label, seed, 2 * TLS_RANDOM_LEN, out, out_len);
455 * tlsv1_server_get_cipher - Get current cipher name
456 * @conn: TLSv1 server connection data from tlsv1_server_init()
457 * @buf: Buffer for the cipher name
459 * Returns: 0 on success, -1 on failure
461 * Get the name of the currently used cipher.
463 int tlsv1_server_get_cipher(struct tlsv1_server *conn, char *buf,
468 switch (conn->rl.cipher_suite) {
469 case TLS_RSA_WITH_RC4_128_MD5:
472 case TLS_RSA_WITH_RC4_128_SHA:
475 case TLS_RSA_WITH_DES_CBC_SHA:
476 cipher = "DES-CBC-SHA";
478 case TLS_RSA_WITH_3DES_EDE_CBC_SHA:
479 cipher = "DES-CBC3-SHA";
481 case TLS_DH_anon_WITH_AES_128_CBC_SHA:
482 cipher = "ADH-AES-128-SHA";
484 case TLS_RSA_WITH_AES_256_CBC_SHA:
485 cipher = "AES-256-SHA";
487 case TLS_RSA_WITH_AES_128_CBC_SHA:
488 cipher = "AES-128-SHA";
494 if (os_strlcpy(buf, cipher, buflen) >= buflen)
501 * tlsv1_server_shutdown - Shutdown TLS connection
502 * @conn: TLSv1 server connection data from tlsv1_server_init()
503 * Returns: 0 on success, -1 on failure
505 int tlsv1_server_shutdown(struct tlsv1_server *conn)
507 conn->state = CLIENT_HELLO;
509 if (tls_verify_hash_init(&conn->verify) < 0) {
510 wpa_printf(MSG_DEBUG, "TLSv1: Failed to re-initialize verify "
515 tlsv1_server_clear_data(conn);
522 * tlsv1_server_resumed - Was session resumption used
523 * @conn: TLSv1 server connection data from tlsv1_server_init()
524 * Returns: 1 if current session used session resumption, 0 if not
526 int tlsv1_server_resumed(struct tlsv1_server *conn)
533 * tlsv1_server_get_keys - Get master key and random data from TLS connection
534 * @conn: TLSv1 server connection data from tlsv1_server_init()
535 * @keys: Structure of key/random data (filled on success)
536 * Returns: 0 on success, -1 on failure
538 int tlsv1_server_get_keys(struct tlsv1_server *conn, struct tls_keys *keys)
540 os_memset(keys, 0, sizeof(*keys));
541 if (conn->state == CLIENT_HELLO)
544 keys->client_random = conn->client_random;
545 keys->client_random_len = TLS_RANDOM_LEN;
547 if (conn->state != SERVER_HELLO) {
548 keys->server_random = conn->server_random;
549 keys->server_random_len = TLS_RANDOM_LEN;
550 keys->master_key = conn->master_secret;
551 keys->master_key_len = TLS_MASTER_SECRET_LEN;
559 * tlsv1_server_get_keyblock_size - Get TLS key_block size
560 * @conn: TLSv1 server connection data from tlsv1_server_init()
561 * Returns: Size of the key_block for the negotiated cipher suite or -1 on
564 int tlsv1_server_get_keyblock_size(struct tlsv1_server *conn)
566 if (conn->state == CLIENT_HELLO || conn->state == SERVER_HELLO)
569 return 2 * (conn->rl.hash_size + conn->rl.key_material_len +
575 * tlsv1_server_set_cipher_list - Configure acceptable cipher suites
576 * @conn: TLSv1 server connection data from tlsv1_server_init()
577 * @ciphers: Zero (TLS_CIPHER_NONE) terminated list of allowed ciphers
579 * Returns: 0 on success, -1 on failure
581 int tlsv1_server_set_cipher_list(struct tlsv1_server *conn, u8 *ciphers)
586 /* TODO: implement proper configuration of cipher suites */
587 if (ciphers[0] == TLS_CIPHER_ANON_DH_AES128_SHA) {
589 suites = conn->cipher_suites;
590 #ifndef CONFIG_CRYPTO_INTERNAL
591 suites[count++] = TLS_RSA_WITH_AES_256_CBC_SHA;
592 #endif /* CONFIG_CRYPTO_INTERNAL */
593 suites[count++] = TLS_RSA_WITH_AES_128_CBC_SHA;
594 suites[count++] = TLS_RSA_WITH_3DES_EDE_CBC_SHA;
595 suites[count++] = TLS_RSA_WITH_RC4_128_SHA;
596 suites[count++] = TLS_RSA_WITH_RC4_128_MD5;
597 #ifndef CONFIG_CRYPTO_INTERNAL
598 suites[count++] = TLS_DH_anon_WITH_AES_256_CBC_SHA;
599 #endif /* CONFIG_CRYPTO_INTERNAL */
600 suites[count++] = TLS_DH_anon_WITH_AES_128_CBC_SHA;
601 suites[count++] = TLS_DH_anon_WITH_3DES_EDE_CBC_SHA;
602 suites[count++] = TLS_DH_anon_WITH_RC4_128_MD5;
603 suites[count++] = TLS_DH_anon_WITH_DES_CBC_SHA;
604 conn->num_cipher_suites = count;
611 int tlsv1_server_set_verify(struct tlsv1_server *conn, int verify_peer)
613 conn->verify_peer = verify_peer;
618 void tlsv1_server_set_session_ticket_cb(struct tlsv1_server *conn,
619 tlsv1_server_session_ticket_cb cb,
622 wpa_printf(MSG_DEBUG, "TLSv1: SessionTicket callback set %p (ctx %p)",
624 conn->session_ticket_cb = cb;
625 conn->session_ticket_cb_ctx = ctx;