This is a fork of the mbed port of axTLS

Dependents:   TLS_axTLS-Example HTTPSClientExample

Overview

This library is a fork from the mbed port of axTLS. It attempts to :

  • reduce the usage of dynamic memory
  • verify certificates with key size up to 2048 bits
  • provide a simple interface

Encryption

This library uses either RC4 or AES for encryption.

Memory usage

During the establishment of a connection, about 10KB of memory is allocated dynamically (it depends on certificates). Once the connection is established, the memory consumption is relatively low. This means that your program must not use too much static memory or allocate memory before you establish a TLS connection.

Certificates

Certificates are the major source of problem and will often be the reason why your program will crash. Due to memory constraint, there are some limitations on certificates :

  • Each certificate must not be bigger than 2KB
  • TLS client can only handle a chain of up to three certificates (excluding the root certificate). This means that the server must not send more than three certificates.

Also, this library can only load certificates following these specifications :

  • encoded in binary DER format (PKCS1)
  • The public key must use RSA only

Once the connection is established, you should free all loaded certificates by calling CertificateManager::clear(). This will free a few kilobytes (it depends on your certificates). In addition, to enable certificate verification during the connection, this library has a "precomputed mode". This mode uses much less memory than a normal certificate verification.

Normal mode

You need to copy the root certificate in binary-DER format on the mbed. Then in your code, let's say that your root certificate is saved on the mbed as "root.der", assuming that you include CertificateManager.h and that you created a LocalFileSystem, you can load this certificate as this ;

Load root certificate

CertificateManager::add("/local/root.der");
CertificateManager::load();

Do not forget that this mode takes quite a lot of memory ( the memory peak is high while verifying certificates) and will only work if the key size is not bigger than 1024 bits (otherwise it will crash while verifying certificates).

Precomputed mode

In this mode, you need to save the entire chain of certificates (in binary-DER format) including the root certificate on the mbed. In practice, this means that you must first retrieve all certificates that the server sends during a connection and then find the right root certificate. In your code, you must call CertificateManager::add for each certificate and in the right order : from the server certificate to the root certificate. Here is how you shoud load certificates in this mode :

Loadcertificates in precomputed mode

CertificateManager::add("/local/server1.der");
CertificateManager::add("/local/server2.der");
CertificateManager::add("/local/server3.der");
CertificateManager::add("/local/root.der");
CertificateManager::load(true);

Using this mode, you should be able to verify certificates with key size up to 2048 bits.

How do I find these certificates ?

I posted an entry in my notebook detailing how to get certificates from a server. You should be able to get all certificates you need except the root certificate. Here is a way how to get the root certificate on windows :

  1. Open (double-click) the last certificate sent by the server
  2. Go to details panel and click on the entry called Issuer. The first line gives you the name of this certificate and the second line indicates the company who created this certificate
  3. Open firefox
  4. Go to options, advanced panel and click on View Certificates
  5. Go to Authorities panel
  6. Choose the certificate whose name match the issuer of the last certificate sent by the server
  7. Export this certificate to binary-DER format.

Connect to mbed.org !

Import programTLS_axTLS-Example

Establishing a connection to mbed.org using TLS

Committer:
feb11
Date:
Thu Sep 12 15:18:04 2013 +0000
Revision:
0:85fceccc1a7c
intial import

Who changed what in which revision?

UserRevisionLine numberNew contents of line
feb11 0:85fceccc1a7c 1 /*
feb11 0:85fceccc1a7c 2 * Copyright (c) 2007, Cameron Rich
feb11 0:85fceccc1a7c 3 *
feb11 0:85fceccc1a7c 4 * All rights reserved.
feb11 0:85fceccc1a7c 5 *
feb11 0:85fceccc1a7c 6 * Redistribution and use in source and binary forms, with or without
feb11 0:85fceccc1a7c 7 * modification, are permitted provided that the following conditions are met:
feb11 0:85fceccc1a7c 8 *
feb11 0:85fceccc1a7c 9 * * Redistributions of source code must retain the above copyright notice,
feb11 0:85fceccc1a7c 10 * this list of conditions and the following disclaimer.
feb11 0:85fceccc1a7c 11 * * Redistributions in binary form must reproduce the above copyright notice,
feb11 0:85fceccc1a7c 12 * this list of conditions and the following disclaimer in the documentation
feb11 0:85fceccc1a7c 13 * and/or other materials provided with the distribution.
feb11 0:85fceccc1a7c 14 * * Neither the name of the axTLS project nor the names of its contributors
feb11 0:85fceccc1a7c 15 * may be used to endorse or promote products derived from this software
feb11 0:85fceccc1a7c 16 * without specific prior written permission.
feb11 0:85fceccc1a7c 17 *
feb11 0:85fceccc1a7c 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
feb11 0:85fceccc1a7c 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
feb11 0:85fceccc1a7c 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
feb11 0:85fceccc1a7c 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
feb11 0:85fceccc1a7c 22 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
feb11 0:85fceccc1a7c 23 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
feb11 0:85fceccc1a7c 24 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
feb11 0:85fceccc1a7c 25 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
feb11 0:85fceccc1a7c 26 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
feb11 0:85fceccc1a7c 27 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
feb11 0:85fceccc1a7c 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
feb11 0:85fceccc1a7c 29 */
feb11 0:85fceccc1a7c 30
feb11 0:85fceccc1a7c 31 /**
feb11 0:85fceccc1a7c 32 * HMAC implementation - This code was originally taken from RFC2104
feb11 0:85fceccc1a7c 33 * See http://www.ietf.org/rfc/rfc2104.txt and
feb11 0:85fceccc1a7c 34 * http://www.faqs.org/rfcs/rfc2202.html
feb11 0:85fceccc1a7c 35 */
feb11 0:85fceccc1a7c 36
feb11 0:85fceccc1a7c 37 #include <string.h>
feb11 0:85fceccc1a7c 38 #include "os_port.h"
feb11 0:85fceccc1a7c 39 #include "crypto.h"
feb11 0:85fceccc1a7c 40
feb11 0:85fceccc1a7c 41 /**
feb11 0:85fceccc1a7c 42 * Perform HMAC-MD5
feb11 0:85fceccc1a7c 43 * NOTE: does not handle keys larger than the block size.
feb11 0:85fceccc1a7c 44 */
feb11 0:85fceccc1a7c 45 void hmac_md5(const uint8_t *msg, int length, const uint8_t *key,
feb11 0:85fceccc1a7c 46 int key_len, uint8_t *digest)
feb11 0:85fceccc1a7c 47 {
feb11 0:85fceccc1a7c 48 MD5_CTX context;
feb11 0:85fceccc1a7c 49 uint8_t k_ipad[64];
feb11 0:85fceccc1a7c 50 uint8_t k_opad[64];
feb11 0:85fceccc1a7c 51 int i;
feb11 0:85fceccc1a7c 52
feb11 0:85fceccc1a7c 53 memset(k_ipad, 0, sizeof k_ipad);
feb11 0:85fceccc1a7c 54 memset(k_opad, 0, sizeof k_opad);
feb11 0:85fceccc1a7c 55 memcpy(k_ipad, key, key_len);
feb11 0:85fceccc1a7c 56 memcpy(k_opad, key, key_len);
feb11 0:85fceccc1a7c 57
feb11 0:85fceccc1a7c 58 for (i = 0; i < 64; i++)
feb11 0:85fceccc1a7c 59 {
feb11 0:85fceccc1a7c 60 k_ipad[i] ^= 0x36;
feb11 0:85fceccc1a7c 61 k_opad[i] ^= 0x5c;
feb11 0:85fceccc1a7c 62 }
feb11 0:85fceccc1a7c 63
feb11 0:85fceccc1a7c 64 MD5_Init(&context);
feb11 0:85fceccc1a7c 65 MD5_Update(&context, k_ipad, 64);
feb11 0:85fceccc1a7c 66 MD5_Update(&context, msg, length);
feb11 0:85fceccc1a7c 67 MD5_Final(digest, &context);
feb11 0:85fceccc1a7c 68 MD5_Init(&context);
feb11 0:85fceccc1a7c 69 MD5_Update(&context, k_opad, 64);
feb11 0:85fceccc1a7c 70 MD5_Update(&context, digest, MD5_SIZE);
feb11 0:85fceccc1a7c 71 MD5_Final(digest, &context);
feb11 0:85fceccc1a7c 72 }
feb11 0:85fceccc1a7c 73
feb11 0:85fceccc1a7c 74 /**
feb11 0:85fceccc1a7c 75 * Perform HMAC-SHA1
feb11 0:85fceccc1a7c 76 * NOTE: does not handle keys larger than the block size.
feb11 0:85fceccc1a7c 77 */
feb11 0:85fceccc1a7c 78 void hmac_sha1(const uint8_t *msg, int length, const uint8_t *key,
feb11 0:85fceccc1a7c 79 int key_len, uint8_t *digest)
feb11 0:85fceccc1a7c 80 {
feb11 0:85fceccc1a7c 81 SHA1_CTX context;
feb11 0:85fceccc1a7c 82 uint8_t k_ipad[64];
feb11 0:85fceccc1a7c 83 uint8_t k_opad[64];
feb11 0:85fceccc1a7c 84 int i;
feb11 0:85fceccc1a7c 85
feb11 0:85fceccc1a7c 86 memset(k_ipad, 0, sizeof k_ipad);
feb11 0:85fceccc1a7c 87 memset(k_opad, 0, sizeof k_opad);
feb11 0:85fceccc1a7c 88 memcpy(k_ipad, key, key_len);
feb11 0:85fceccc1a7c 89 memcpy(k_opad, key, key_len);
feb11 0:85fceccc1a7c 90
feb11 0:85fceccc1a7c 91 for (i = 0; i < 64; i++)
feb11 0:85fceccc1a7c 92 {
feb11 0:85fceccc1a7c 93 k_ipad[i] ^= 0x36;
feb11 0:85fceccc1a7c 94 k_opad[i] ^= 0x5c;
feb11 0:85fceccc1a7c 95 }
feb11 0:85fceccc1a7c 96
feb11 0:85fceccc1a7c 97 SHA1_Init(&context);
feb11 0:85fceccc1a7c 98 SHA1_Update(&context, k_ipad, 64);
feb11 0:85fceccc1a7c 99 SHA1_Update(&context, msg, length);
feb11 0:85fceccc1a7c 100 SHA1_Final(digest, &context);
feb11 0:85fceccc1a7c 101 SHA1_Init(&context);
feb11 0:85fceccc1a7c 102 SHA1_Update(&context, k_opad, 64);
feb11 0:85fceccc1a7c 103 SHA1_Update(&context, digest, SHA1_SIZE);
feb11 0:85fceccc1a7c 104 SHA1_Final(digest, &context);
feb11 0:85fceccc1a7c 105 }
feb11 0:85fceccc1a7c 106
feb11 0:85fceccc1a7c 107