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 #ifndef TLSCONNECTION_H
feb11 0:85fceccc1a7c 2 #define TLSCONNECTION_H
feb11 0:85fceccc1a7c 3
feb11 0:85fceccc1a7c 4 #include "Socket/Socket.h"
feb11 0:85fceccc1a7c 5 #include "Socket/Endpoint.h"
feb11 0:85fceccc1a7c 6 #include "axTLS/ssl/ssl.h"
feb11 0:85fceccc1a7c 7
feb11 0:85fceccc1a7c 8 /** This class provides a user-friendly interface for the
feb11 0:85fceccc1a7c 9 axTLS library.
feb11 0:85fceccc1a7c 10 */
feb11 0:85fceccc1a7c 11 class TLSConnection : public Socket, public Endpoint
feb11 0:85fceccc1a7c 12 {
feb11 0:85fceccc1a7c 13 public :
feb11 0:85fceccc1a7c 14
feb11 0:85fceccc1a7c 15 TLSConnection();
feb11 0:85fceccc1a7c 16
feb11 0:85fceccc1a7c 17 /** This function tries to establish a TLS connection
feb11 0:85fceccc1a7c 18 with the given host.
feb11 0:85fceccc1a7c 19 It will first try to establish a TCP connection on
feb11 0:85fceccc1a7c 20 port 443 with the host. Then, it runs the TLS
feb11 0:85fceccc1a7c 21 handshake protocol.
feb11 0:85fceccc1a7c 22
feb11 0:85fceccc1a7c 23 \param host A valid hostname (e.g. "mbed.org")
feb11 0:85fceccc1a7c 24 \return True if it managed to establish a connection
feb11 0:85fceccc1a7c 25 with the host. False otherwise.
feb11 0:85fceccc1a7c 26 */
feb11 0:85fceccc1a7c 27 bool connect(const char *host);
feb11 0:85fceccc1a7c 28
feb11 0:85fceccc1a7c 29 /** Indicates whether a connection is established or not.
feb11 0:85fceccc1a7c 30
feb11 0:85fceccc1a7c 31 \return true if a connection is established, otherwise
feb11 0:85fceccc1a7c 32 returns false.
feb11 0:85fceccc1a7c 33 */
feb11 0:85fceccc1a7c 34 bool is_connected(void);
feb11 0:85fceccc1a7c 35
feb11 0:85fceccc1a7c 36 /** Sends some data to the host. This method does not return
feb11 0:85fceccc1a7c 37 until length bytes have been sent.
feb11 0:85fceccc1a7c 38
feb11 0:85fceccc1a7c 39 \param data A pointer to some data
feb11 0:85fceccc1a7c 40 \param length Number of bytes to send
feb11 0:85fceccc1a7c 41 \return Number of bytes sent, or -1 if an error occured.
feb11 0:85fceccc1a7c 42 */
feb11 0:85fceccc1a7c 43 int send_all(char *data, int length);
feb11 0:85fceccc1a7c 44
feb11 0:85fceccc1a7c 45 /** Receive some data from the host.
feb11 0:85fceccc1a7c 46
feb11 0:85fceccc1a7c 47 \param data
feb11 0:85fceccc1a7c 48 \param length Maximum number of bytes to receive
feb11 0:85fceccc1a7c 49 \return Number of bytes read in range 0..length, or -1
feb11 0:85fceccc1a7c 50 if an error occured.
feb11 0:85fceccc1a7c 51 */
feb11 0:85fceccc1a7c 52 int receive(char *data, int length);
feb11 0:85fceccc1a7c 53
feb11 0:85fceccc1a7c 54 /** Close the connection.
feb11 0:85fceccc1a7c 55
feb11 0:85fceccc1a7c 56 \param shutdown
feb11 0:85fceccc1a7c 57 \return True if the connection was closed with success,
feb11 0:85fceccc1a7c 58 false otherwise. If no connection was established,
feb11 0:85fceccc1a7c 59 returns true immediately.
feb11 0:85fceccc1a7c 60 */
feb11 0:85fceccc1a7c 61 bool close(bool shutdown = true);
feb11 0:85fceccc1a7c 62
feb11 0:85fceccc1a7c 63 private :
feb11 0:85fceccc1a7c 64
feb11 0:85fceccc1a7c 65 bool _is_connected;
feb11 0:85fceccc1a7c 66
feb11 0:85fceccc1a7c 67 SSL_CTX _ssl_ctx;
feb11 0:85fceccc1a7c 68 SSL _ssl;
feb11 0:85fceccc1a7c 69 };
feb11 0:85fceccc1a7c 70
feb11 0:85fceccc1a7c 71 #endif
feb11 0:85fceccc1a7c 72
feb11 0:85fceccc1a7c 73