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 #include "TLSConnection.h"
feb11 0:85fceccc1a7c 2 #include <stdlib.h>
feb11 0:85fceccc1a7c 3 #include <stdio.h>
feb11 0:85fceccc1a7c 4 const static int HTTPS_PORT = 443;
feb11 0:85fceccc1a7c 5
feb11 0:85fceccc1a7c 6 TLSConnection::TLSConnection():
feb11 0:85fceccc1a7c 7 Socket(),
feb11 0:85fceccc1a7c 8 Endpoint(),
feb11 0:85fceccc1a7c 9 _is_connected(false),
feb11 0:85fceccc1a7c 10 _ssl_ctx(),
feb11 0:85fceccc1a7c 11 _ssl()
feb11 0:85fceccc1a7c 12 {
feb11 0:85fceccc1a7c 13 }
feb11 0:85fceccc1a7c 14
feb11 0:85fceccc1a7c 15 bool TLSConnection::connect(const char *host)
feb11 0:85fceccc1a7c 16 {
feb11 0:85fceccc1a7c 17 if (init_socket(SOCK_STREAM) < 0)
feb11 0:85fceccc1a7c 18 return false;
feb11 0:85fceccc1a7c 19
feb11 0:85fceccc1a7c 20 if (set_address(host, HTTPS_PORT) != 0)
feb11 0:85fceccc1a7c 21 return false;
feb11 0:85fceccc1a7c 22
feb11 0:85fceccc1a7c 23 if (lwip_connect(_sock_fd, (const struct sockaddr *) &_remoteHost, sizeof(_remoteHost)) < 0) {
feb11 0:85fceccc1a7c 24 close();
feb11 0:85fceccc1a7c 25 return false;
feb11 0:85fceccc1a7c 26 }
feb11 0:85fceccc1a7c 27
feb11 0:85fceccc1a7c 28 if(ssl_ctx_new(&_ssl_ctx, 0, SSL_DEFAULT_CLNT_SESS) != &_ssl_ctx)
feb11 0:85fceccc1a7c 29 return false;
feb11 0:85fceccc1a7c 30
feb11 0:85fceccc1a7c 31 _ssl.ssl_ctx = &_ssl_ctx;
feb11 0:85fceccc1a7c 32
feb11 0:85fceccc1a7c 33 if(ssl_client_new(&_ssl, _sock_fd, NULL, 0) == NULL) {
feb11 0:85fceccc1a7c 34 close();
feb11 0:85fceccc1a7c 35 return false;
feb11 0:85fceccc1a7c 36 }
feb11 0:85fceccc1a7c 37 if(_ssl.hs_status != SSL_OK) {
feb11 0:85fceccc1a7c 38 close();
feb11 0:85fceccc1a7c 39 return false;
feb11 0:85fceccc1a7c 40 }
feb11 0:85fceccc1a7c 41
feb11 0:85fceccc1a7c 42 _is_connected = true;
feb11 0:85fceccc1a7c 43
feb11 0:85fceccc1a7c 44 return true;
feb11 0:85fceccc1a7c 45 }
feb11 0:85fceccc1a7c 46
feb11 0:85fceccc1a7c 47 bool TLSConnection::is_connected(void)
feb11 0:85fceccc1a7c 48 {
feb11 0:85fceccc1a7c 49 return _is_connected;
feb11 0:85fceccc1a7c 50 }
feb11 0:85fceccc1a7c 51
feb11 0:85fceccc1a7c 52 int TLSConnection::send_all(char *data, int length)
feb11 0:85fceccc1a7c 53 {
feb11 0:85fceccc1a7c 54 if ((_sock_fd < 0) || !_is_connected)
feb11 0:85fceccc1a7c 55 return -1;
feb11 0:85fceccc1a7c 56
feb11 0:85fceccc1a7c 57 return ssl_write(&_ssl, (uint8_t*)data, length);
feb11 0:85fceccc1a7c 58 }
feb11 0:85fceccc1a7c 59
feb11 0:85fceccc1a7c 60 int TLSConnection::receive(char *data, int length)
feb11 0:85fceccc1a7c 61 {
feb11 0:85fceccc1a7c 62 return ssl_read(&_ssl, (uint8_t*)data, length);
feb11 0:85fceccc1a7c 63 }
feb11 0:85fceccc1a7c 64
feb11 0:85fceccc1a7c 65 bool TLSConnection::close(bool shutdown)
feb11 0:85fceccc1a7c 66 {
feb11 0:85fceccc1a7c 67 if(!_is_connected)
feb11 0:85fceccc1a7c 68 return true;
feb11 0:85fceccc1a7c 69
feb11 0:85fceccc1a7c 70 _is_connected = false;
feb11 0:85fceccc1a7c 71 ssl_ctx_free(_ssl.ssl_ctx);
feb11 0:85fceccc1a7c 72
feb11 0:85fceccc1a7c 73 return Socket::close(shutdown) == 0;
feb11 0:85fceccc1a7c 74 }
feb11 0:85fceccc1a7c 75