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 * @file os_port.h
feb11 0:85fceccc1a7c 33 *
feb11 0:85fceccc1a7c 34 * Some stuff to minimise the differences between windows and linux/unix
feb11 0:85fceccc1a7c 35 */
feb11 0:85fceccc1a7c 36
feb11 0:85fceccc1a7c 37 #ifndef HEADER_OS_PORT_H
feb11 0:85fceccc1a7c 38 #define HEADER_OS_PORT_H
feb11 0:85fceccc1a7c 39
feb11 0:85fceccc1a7c 40 #ifdef __cplusplus
feb11 0:85fceccc1a7c 41 extern "C" {
feb11 0:85fceccc1a7c 42 #endif
feb11 0:85fceccc1a7c 43
feb11 0:85fceccc1a7c 44 #include "os_int.h"
feb11 0:85fceccc1a7c 45 #include <stdio.h>
feb11 0:85fceccc1a7c 46
feb11 0:85fceccc1a7c 47 #if defined(WIN32)
feb11 0:85fceccc1a7c 48 #define STDCALL __stdcall
feb11 0:85fceccc1a7c 49 #define EXP_FUNC __declspec(dllexport)
feb11 0:85fceccc1a7c 50 #else
feb11 0:85fceccc1a7c 51 #define STDCALL
feb11 0:85fceccc1a7c 52 #define EXP_FUNC
feb11 0:85fceccc1a7c 53 #endif
feb11 0:85fceccc1a7c 54
feb11 0:85fceccc1a7c 55 #if defined(_WIN32_WCE)
feb11 0:85fceccc1a7c 56 #undef WIN32
feb11 0:85fceccc1a7c 57 #define WIN32
feb11 0:85fceccc1a7c 58 #endif
feb11 0:85fceccc1a7c 59
feb11 0:85fceccc1a7c 60 #ifdef WIN32
feb11 0:85fceccc1a7c 61
feb11 0:85fceccc1a7c 62 /* Windows CE stuff */
feb11 0:85fceccc1a7c 63 #if defined(_WIN32_WCE)
feb11 0:85fceccc1a7c 64 #include <basetsd.h>
feb11 0:85fceccc1a7c 65 #define abort() exit(1)
feb11 0:85fceccc1a7c 66 #else
feb11 0:85fceccc1a7c 67 #include <io.h>
feb11 0:85fceccc1a7c 68 #include <process.h>
feb11 0:85fceccc1a7c 69 #include <sys/timeb.h>
feb11 0:85fceccc1a7c 70 #include <fcntl.h>
feb11 0:85fceccc1a7c 71 #endif /* _WIN32_WCE */
feb11 0:85fceccc1a7c 72
feb11 0:85fceccc1a7c 73 #include <winsock.h>
feb11 0:85fceccc1a7c 74 #include <direct.h>
feb11 0:85fceccc1a7c 75 #undef getpid
feb11 0:85fceccc1a7c 76 #undef open
feb11 0:85fceccc1a7c 77 #undef close
feb11 0:85fceccc1a7c 78 #undef sleep
feb11 0:85fceccc1a7c 79 #undef gettimeofday
feb11 0:85fceccc1a7c 80 #undef dup2
feb11 0:85fceccc1a7c 81 #undef unlink
feb11 0:85fceccc1a7c 82
feb11 0:85fceccc1a7c 83 #define SOCKET_READ(A,B,C) recv(A,B,C,0)
feb11 0:85fceccc1a7c 84 #define SOCKET_WRITE(A,B,C) send(A,B,C,0)
feb11 0:85fceccc1a7c 85 #define SOCKET_CLOSE(A) closesocket(A)
feb11 0:85fceccc1a7c 86 #define srandom(A) srand(A)
feb11 0:85fceccc1a7c 87 #define random() rand()
feb11 0:85fceccc1a7c 88 #define getpid() _getpid()
feb11 0:85fceccc1a7c 89 #define snprintf _snprintf
feb11 0:85fceccc1a7c 90 #define open(A,B) _open(A,B)
feb11 0:85fceccc1a7c 91 #define dup2(A,B) _dup2(A,B)
feb11 0:85fceccc1a7c 92 #define unlink(A) _unlink(A)
feb11 0:85fceccc1a7c 93 #define close(A) _close(A)
feb11 0:85fceccc1a7c 94 #define read(A,B,C) _read(A,B,C)
feb11 0:85fceccc1a7c 95 #define write(A,B,C) _write(A,B,C)
feb11 0:85fceccc1a7c 96 #define sleep(A) Sleep(A*1000)
feb11 0:85fceccc1a7c 97 #define usleep(A) Sleep(A/1000)
feb11 0:85fceccc1a7c 98 #define strdup(A) _strdup(A)
feb11 0:85fceccc1a7c 99 #define chroot(A) _chdir(A)
feb11 0:85fceccc1a7c 100 #define chdir(A) _chdir(A)
feb11 0:85fceccc1a7c 101 #define alloca(A) _alloca(A)
feb11 0:85fceccc1a7c 102
feb11 0:85fceccc1a7c 103
feb11 0:85fceccc1a7c 104 #ifndef lseek
feb11 0:85fceccc1a7c 105 #define lseek(A,B,C) _lseek(A,B,C)
feb11 0:85fceccc1a7c 106
feb11 0:85fceccc1a7c 107 #endif
feb11 0:85fceccc1a7c 108
feb11 0:85fceccc1a7c 109 /* This fix gets around a problem where a win32 application on a cygwin xterm
feb11 0:85fceccc1a7c 110 doesn't display regular output (until a certain buffer limit) - but it works
feb11 0:85fceccc1a7c 111 fine under a normal DOS window. This is a hack to get around the issue -
feb11 0:85fceccc1a7c 112 see http://www.khngai.com/emacs/tty.php */
feb11 0:85fceccc1a7c 113 #define TTY_FLUSH() if (!_isatty(_fileno(stdout))) fflush(stdout);
feb11 0:85fceccc1a7c 114
feb11 0:85fceccc1a7c 115 /*
feb11 0:85fceccc1a7c 116 * automatically build some library dependencies.
feb11 0:85fceccc1a7c 117 */
feb11 0:85fceccc1a7c 118 #pragma comment(lib, "WS2_32.lib")
feb11 0:85fceccc1a7c 119 #pragma comment(lib, "AdvAPI32.lib")
feb11 0:85fceccc1a7c 120
feb11 0:85fceccc1a7c 121 typedef int socklen_t;
feb11 0:85fceccc1a7c 122
feb11 0:85fceccc1a7c 123 EXP_FUNC void STDCALL gettimeofday(struct timeval* t,void* timezone);
feb11 0:85fceccc1a7c 124 EXP_FUNC int STDCALL strcasecmp(const char *s1, const char *s2);
feb11 0:85fceccc1a7c 125 EXP_FUNC int STDCALL getdomainname(char *buf, int buf_size);
feb11 0:85fceccc1a7c 126
feb11 0:85fceccc1a7c 127 #else /* Not Win32 */
feb11 0:85fceccc1a7c 128
feb11 0:85fceccc1a7c 129 //#include <unistd.h>
feb11 0:85fceccc1a7c 130 //#include <pwd.h>
feb11 0:85fceccc1a7c 131 //#include <netdb.h>
feb11 0:85fceccc1a7c 132 //#include <dirent.h>
feb11 0:85fceccc1a7c 133 //#include <fcntl.h>
feb11 0:85fceccc1a7c 134 #include <errno.h>
feb11 0:85fceccc1a7c 135 //#include <sys/stat.h>
feb11 0:85fceccc1a7c 136 #include <time.h>
feb11 0:85fceccc1a7c 137 #include <socket.h>
feb11 0:85fceccc1a7c 138 //#include <sys/wait.h>
feb11 0:85fceccc1a7c 139 #include <netinet/in.h>
feb11 0:85fceccc1a7c 140 #include <inet.h>
feb11 0:85fceccc1a7c 141
feb11 0:85fceccc1a7c 142 #define SOCKET_READ(A,B,C) read(A,B,C)
feb11 0:85fceccc1a7c 143 #define SOCKET_WRITE(A,B,C) write(A,B,C)
feb11 0:85fceccc1a7c 144 #define SOCKET_CLOSE(A) if (A >= 0) close(A)
feb11 0:85fceccc1a7c 145 #define TTY_FLUSH()
feb11 0:85fceccc1a7c 146
feb11 0:85fceccc1a7c 147 #endif /* Not Win32 */
feb11 0:85fceccc1a7c 148
feb11 0:85fceccc1a7c 149 /* some functions to mutate the way these work */
feb11 0:85fceccc1a7c 150 #define malloc(A) ax_malloc(A)
feb11 0:85fceccc1a7c 151 #ifndef realloc
feb11 0:85fceccc1a7c 152 #define realloc(A,B) ax_realloc(A,B)
feb11 0:85fceccc1a7c 153 #endif
feb11 0:85fceccc1a7c 154 #define calloc(A,B) ax_calloc(A,B)
feb11 0:85fceccc1a7c 155
feb11 0:85fceccc1a7c 156 EXP_FUNC void * STDCALL ax_malloc(size_t s);
feb11 0:85fceccc1a7c 157 EXP_FUNC void * STDCALL ax_realloc(void *y, size_t s);
feb11 0:85fceccc1a7c 158 EXP_FUNC void * STDCALL ax_calloc(size_t n, size_t s);
feb11 0:85fceccc1a7c 159 EXP_FUNC int STDCALL ax_open(const char *pathname, int flags);
feb11 0:85fceccc1a7c 160
feb11 0:85fceccc1a7c 161 #ifdef CONFIG_PLATFORM_LINUX
feb11 0:85fceccc1a7c 162 void exit_now(const char *format, ...) __attribute((noreturn));
feb11 0:85fceccc1a7c 163 #else
feb11 0:85fceccc1a7c 164 void exit_now(const char *format, ...);
feb11 0:85fceccc1a7c 165 #endif
feb11 0:85fceccc1a7c 166
feb11 0:85fceccc1a7c 167 /* Mutexing definitions */
feb11 0:85fceccc1a7c 168 #if defined(CONFIG_SSL_CTX_MUTEXING)
feb11 0:85fceccc1a7c 169 #if defined(WIN32)
feb11 0:85fceccc1a7c 170 #define SSL_CTX_MUTEX_TYPE HANDLE
feb11 0:85fceccc1a7c 171 #define SSL_CTX_MUTEX_INIT(A) A=CreateMutex(0, FALSE, 0)
feb11 0:85fceccc1a7c 172 #define SSL_CTX_MUTEX_DESTROY(A) CloseHandle(A)
feb11 0:85fceccc1a7c 173 #define SSL_CTX_LOCK(A) WaitForSingleObject(A, INFINITE)
feb11 0:85fceccc1a7c 174 #define SSL_CTX_UNLOCK(A) ReleaseMutex(A)
feb11 0:85fceccc1a7c 175 #else
feb11 0:85fceccc1a7c 176 #include <pthread.h>
feb11 0:85fceccc1a7c 177 #define SSL_CTX_MUTEX_TYPE pthread_mutex_t
feb11 0:85fceccc1a7c 178 #define SSL_CTX_MUTEX_INIT(A) pthread_mutex_init(&A, NULL)
feb11 0:85fceccc1a7c 179 #define SSL_CTX_MUTEX_DESTROY(A) pthread_mutex_destroy(&A)
feb11 0:85fceccc1a7c 180 #define SSL_CTX_LOCK(A) pthread_mutex_lock(&A)
feb11 0:85fceccc1a7c 181 #define SSL_CTX_UNLOCK(A) pthread_mutex_unlock(&A)
feb11 0:85fceccc1a7c 182 #endif
feb11 0:85fceccc1a7c 183 #else /* no mutexing */
feb11 0:85fceccc1a7c 184 #define SSL_CTX_MUTEX_INIT(A)
feb11 0:85fceccc1a7c 185 #define SSL_CTX_MUTEX_DESTROY(A)
feb11 0:85fceccc1a7c 186 #define SSL_CTX_LOCK(A)
feb11 0:85fceccc1a7c 187 #define SSL_CTX_UNLOCK(A)
feb11 0:85fceccc1a7c 188 #endif
feb11 0:85fceccc1a7c 189
feb11 0:85fceccc1a7c 190 #ifdef __cplusplus
feb11 0:85fceccc1a7c 191 }
feb11 0:85fceccc1a7c 192 #endif
feb11 0:85fceccc1a7c 193
feb11 0:85fceccc1a7c 194 #endif
feb11 0:85fceccc1a7c 195
feb11 0:85fceccc1a7c 196