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.c
feb11 0:85fceccc1a7c 33 *
feb11 0:85fceccc1a7c 34 * OS specific functions.
feb11 0:85fceccc1a7c 35 */
feb11 0:85fceccc1a7c 36 #include <time.h>
feb11 0:85fceccc1a7c 37 #include <stdlib.h>
feb11 0:85fceccc1a7c 38 #include <errno.h>
feb11 0:85fceccc1a7c 39 #include <stdarg.h>
feb11 0:85fceccc1a7c 40 #include "os_port.h"
feb11 0:85fceccc1a7c 41 #include <stdio.h>
feb11 0:85fceccc1a7c 42 #include "sockets.h"
feb11 0:85fceccc1a7c 43
feb11 0:85fceccc1a7c 44 static int memory_buf[400];
feb11 0:85fceccc1a7c 45 static char enable = 0;
feb11 0:85fceccc1a7c 46 static int nb_entries = 0;
feb11 0:85fceccc1a7c 47
feb11 0:85fceccc1a7c 48 void disable_memory_buf(void)
feb11 0:85fceccc1a7c 49 {
feb11 0:85fceccc1a7c 50 enable = 0;
feb11 0:85fceccc1a7c 51 }
feb11 0:85fceccc1a7c 52 void enable_memory_buf(void)
feb11 0:85fceccc1a7c 53 {
feb11 0:85fceccc1a7c 54 enable = 1;
feb11 0:85fceccc1a7c 55 }
feb11 0:85fceccc1a7c 56 void init_memory_buf(void)
feb11 0:85fceccc1a7c 57 {
feb11 0:85fceccc1a7c 58 for(int i = 0; i < 400; i += 2)
feb11 0:85fceccc1a7c 59 {
feb11 0:85fceccc1a7c 60 memory_buf[i] = -1;
feb11 0:85fceccc1a7c 61 memory_buf[i+1] = 0;
feb11 0:85fceccc1a7c 62 }
feb11 0:85fceccc1a7c 63 }
feb11 0:85fceccc1a7c 64 void print_buf_stats(void)
feb11 0:85fceccc1a7c 65 {
feb11 0:85fceccc1a7c 66 if(enable)
feb11 0:85fceccc1a7c 67 {
feb11 0:85fceccc1a7c 68 int used = 0;
feb11 0:85fceccc1a7c 69 for(int i = 1; i < 400; i += 2)
feb11 0:85fceccc1a7c 70 used += memory_buf[i];
feb11 0:85fceccc1a7c 71 printf("%d\n", used);
feb11 0:85fceccc1a7c 72 }
feb11 0:85fceccc1a7c 73 }
feb11 0:85fceccc1a7c 74
feb11 0:85fceccc1a7c 75 void print_all_buf_stats(void)
feb11 0:85fceccc1a7c 76 {
feb11 0:85fceccc1a7c 77 int used = 0;
feb11 0:85fceccc1a7c 78 for(int i = 1; i < 400; i += 2)
feb11 0:85fceccc1a7c 79 used += memory_buf[i];
feb11 0:85fceccc1a7c 80 printf("used: %d bytes\n", used);
feb11 0:85fceccc1a7c 81
feb11 0:85fceccc1a7c 82 for(int i = 0; i < 400; i += 2)
feb11 0:85fceccc1a7c 83 if(memory_buf[i] != -1)
feb11 0:85fceccc1a7c 84 printf("ptr:%X, size:%d\n", memory_buf[i], memory_buf[i+1]);
feb11 0:85fceccc1a7c 85 }
feb11 0:85fceccc1a7c 86
feb11 0:85fceccc1a7c 87 static void add_entry(void *x, size_t s, const char* f, const int l)
feb11 0:85fceccc1a7c 88 {
feb11 0:85fceccc1a7c 89 nb_entries++;
feb11 0:85fceccc1a7c 90 for(int i = 0; i < 400; i += 2)
feb11 0:85fceccc1a7c 91 {
feb11 0:85fceccc1a7c 92 if(memory_buf[i] == -1)
feb11 0:85fceccc1a7c 93 {
feb11 0:85fceccc1a7c 94 if(enable)
feb11 0:85fceccc1a7c 95 printf("new ptr:%X, size:%d at %s:%d\n", x, s, f, l);
feb11 0:85fceccc1a7c 96 memory_buf[i] = (int)(x);
feb11 0:85fceccc1a7c 97 memory_buf[i+1] = s;
feb11 0:85fceccc1a7c 98 return;
feb11 0:85fceccc1a7c 99 }
feb11 0:85fceccc1a7c 100 }
feb11 0:85fceccc1a7c 101 if(enable)
feb11 0:85fceccc1a7c 102 printf("No space left in buffer\n");
feb11 0:85fceccc1a7c 103 }
feb11 0:85fceccc1a7c 104
feb11 0:85fceccc1a7c 105 static void remove_entry(void *x, const char* f, const int l)
feb11 0:85fceccc1a7c 106 {
feb11 0:85fceccc1a7c 107 nb_entries--;
feb11 0:85fceccc1a7c 108 for(int i = 0; i < 400; i += 2)
feb11 0:85fceccc1a7c 109 {
feb11 0:85fceccc1a7c 110 if(memory_buf[i] == (int)(x))
feb11 0:85fceccc1a7c 111 {
feb11 0:85fceccc1a7c 112 if(enable)
feb11 0:85fceccc1a7c 113 printf("free ptr:%X, size:%d at %s:%d\n", memory_buf[i], memory_buf[i+1], f, l);
feb11 0:85fceccc1a7c 114 memory_buf[i] = -1;
feb11 0:85fceccc1a7c 115 memory_buf[i+1] = 0;
feb11 0:85fceccc1a7c 116 return;
feb11 0:85fceccc1a7c 117 }
feb11 0:85fceccc1a7c 118 }
feb11 0:85fceccc1a7c 119 if(enable)
feb11 0:85fceccc1a7c 120 printf("not found\n");
feb11 0:85fceccc1a7c 121 }
feb11 0:85fceccc1a7c 122
feb11 0:85fceccc1a7c 123 #ifdef MBED
feb11 0:85fceccc1a7c 124 /**
feb11 0:85fceccc1a7c 125 * gettimeofday() not in mbed
feb11 0:85fceccc1a7c 126 */
feb11 0:85fceccc1a7c 127 EXP_FUNC void STDCALL gettimeofday(struct timeval* t, void* timezone)
feb11 0:85fceccc1a7c 128 {
feb11 0:85fceccc1a7c 129 t->tv_sec = time(NULL);
feb11 0:85fceccc1a7c 130 t->tv_usec = 0; /* 1sec precision only */
feb11 0:85fceccc1a7c 131 }
feb11 0:85fceccc1a7c 132
feb11 0:85fceccc1a7c 133 #endif
feb11 0:85fceccc1a7c 134
feb11 0:85fceccc1a7c 135 #ifdef WIN32
feb11 0:85fceccc1a7c 136 /**
feb11 0:85fceccc1a7c 137 * gettimeofday() not in Win32
feb11 0:85fceccc1a7c 138 */
feb11 0:85fceccc1a7c 139 EXP_FUNC void STDCALL gettimeofday(struct timeval* t, void* timezone)
feb11 0:85fceccc1a7c 140 {
feb11 0:85fceccc1a7c 141 #if defined(_WIN32_WCE)
feb11 0:85fceccc1a7c 142 t->tv_sec = time(NULL);
feb11 0:85fceccc1a7c 143 t->tv_usec = 0; /* 1sec precision only */
feb11 0:85fceccc1a7c 144 #else
feb11 0:85fceccc1a7c 145 struct _timeb timebuffer;
feb11 0:85fceccc1a7c 146 _ftime(&timebuffer);
feb11 0:85fceccc1a7c 147 t->tv_sec = (long)timebuffer.time;
feb11 0:85fceccc1a7c 148 t->tv_usec = 1000 * timebuffer.millitm; /* 1ms precision */
feb11 0:85fceccc1a7c 149 #endif
feb11 0:85fceccc1a7c 150 }
feb11 0:85fceccc1a7c 151
feb11 0:85fceccc1a7c 152
feb11 0:85fceccc1a7c 153 /**
feb11 0:85fceccc1a7c 154 * strcasecmp() not in Win32
feb11 0:85fceccc1a7c 155 */
feb11 0:85fceccc1a7c 156 EXP_FUNC int STDCALL strcasecmp(const char *s1, const char *s2)
feb11 0:85fceccc1a7c 157 {
feb11 0:85fceccc1a7c 158 while (tolower(*s1) == tolower(*s2++))
feb11 0:85fceccc1a7c 159 {
feb11 0:85fceccc1a7c 160 if (*s1++ == '\0')
feb11 0:85fceccc1a7c 161 {
feb11 0:85fceccc1a7c 162 return 0;
feb11 0:85fceccc1a7c 163 }
feb11 0:85fceccc1a7c 164 }
feb11 0:85fceccc1a7c 165
feb11 0:85fceccc1a7c 166 return *(unsigned char *)s1 - *(unsigned char *)(s2 - 1);
feb11 0:85fceccc1a7c 167 }
feb11 0:85fceccc1a7c 168
feb11 0:85fceccc1a7c 169
feb11 0:85fceccc1a7c 170 EXP_FUNC int STDCALL getdomainname(char *buf, int buf_size)
feb11 0:85fceccc1a7c 171 {
feb11 0:85fceccc1a7c 172 HKEY hKey;
feb11 0:85fceccc1a7c 173 unsigned long datatype;
feb11 0:85fceccc1a7c 174 unsigned long bufferlength = buf_size;
feb11 0:85fceccc1a7c 175
feb11 0:85fceccc1a7c 176 if (RegOpenKeyEx(HKEY_LOCAL_MACHINE,
feb11 0:85fceccc1a7c 177 TEXT("SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters"),
feb11 0:85fceccc1a7c 178 0, KEY_QUERY_VALUE, &hKey) != ERROR_SUCCESS)
feb11 0:85fceccc1a7c 179 return -1;
feb11 0:85fceccc1a7c 180
feb11 0:85fceccc1a7c 181 RegQueryValueEx(hKey, "Domain", NULL, &datatype, buf, &bufferlength);
feb11 0:85fceccc1a7c 182 RegCloseKey(hKey);
feb11 0:85fceccc1a7c 183 return 0;
feb11 0:85fceccc1a7c 184 }
feb11 0:85fceccc1a7c 185 #endif
feb11 0:85fceccc1a7c 186
feb11 0:85fceccc1a7c 187 #undef malloc
feb11 0:85fceccc1a7c 188 #undef realloc
feb11 0:85fceccc1a7c 189 #undef calloc
feb11 0:85fceccc1a7c 190 #undef free
feb11 0:85fceccc1a7c 191
feb11 0:85fceccc1a7c 192 static const char * out_of_mem_str = "out of memory";
feb11 0:85fceccc1a7c 193 //static const char * file_open_str = "Could not open file \"%s\"";
feb11 0:85fceccc1a7c 194
feb11 0:85fceccc1a7c 195 /*
feb11 0:85fceccc1a7c 196 * Some functions that call display some error trace and then call abort().
feb11 0:85fceccc1a7c 197 * This just makes life much easier on embedded systems, since we're
feb11 0:85fceccc1a7c 198 * suffering major trauma...
feb11 0:85fceccc1a7c 199 */
feb11 0:85fceccc1a7c 200 EXP_FUNC void * STDCALL ax_malloc(size_t s, const char* f, const int l)
feb11 0:85fceccc1a7c 201 {
feb11 0:85fceccc1a7c 202 if(enable)
feb11 0:85fceccc1a7c 203 printf("malloc\t");
feb11 0:85fceccc1a7c 204
feb11 0:85fceccc1a7c 205 void *x;
feb11 0:85fceccc1a7c 206
feb11 0:85fceccc1a7c 207 if ((x = malloc(s)) == NULL)
feb11 0:85fceccc1a7c 208 exit_now(out_of_mem_str);
feb11 0:85fceccc1a7c 209 add_entry(x,s, f, l);
feb11 0:85fceccc1a7c 210 print_buf_stats();
feb11 0:85fceccc1a7c 211
feb11 0:85fceccc1a7c 212 return x;
feb11 0:85fceccc1a7c 213 }
feb11 0:85fceccc1a7c 214
feb11 0:85fceccc1a7c 215 EXP_FUNC void * STDCALL ax_realloc(void *y, size_t s, const char* f, const int l)
feb11 0:85fceccc1a7c 216 {
feb11 0:85fceccc1a7c 217 if(enable)
feb11 0:85fceccc1a7c 218 printf("realloc\t");
feb11 0:85fceccc1a7c 219
feb11 0:85fceccc1a7c 220 void *x;
feb11 0:85fceccc1a7c 221
feb11 0:85fceccc1a7c 222 if ((x = realloc(y, s)) == NULL)
feb11 0:85fceccc1a7c 223 exit_now(out_of_mem_str);
feb11 0:85fceccc1a7c 224 remove_entry(y, f, l);
feb11 0:85fceccc1a7c 225 add_entry(x,s, f, l);
feb11 0:85fceccc1a7c 226 print_buf_stats();
feb11 0:85fceccc1a7c 227 return x;
feb11 0:85fceccc1a7c 228 }
feb11 0:85fceccc1a7c 229
feb11 0:85fceccc1a7c 230 EXP_FUNC void * STDCALL ax_calloc(size_t n, size_t s, const char* f, const int l)
feb11 0:85fceccc1a7c 231 {
feb11 0:85fceccc1a7c 232 if(enable)
feb11 0:85fceccc1a7c 233 printf("calloc\t");
feb11 0:85fceccc1a7c 234 void *x;
feb11 0:85fceccc1a7c 235
feb11 0:85fceccc1a7c 236 if ((x = calloc(n, s)) == NULL) {
feb11 0:85fceccc1a7c 237 exit_now(out_of_mem_str);
feb11 0:85fceccc1a7c 238 }
feb11 0:85fceccc1a7c 239
feb11 0:85fceccc1a7c 240 add_entry(x,n*s, f, l);
feb11 0:85fceccc1a7c 241 print_buf_stats();
feb11 0:85fceccc1a7c 242 return x;
feb11 0:85fceccc1a7c 243 }
feb11 0:85fceccc1a7c 244
feb11 0:85fceccc1a7c 245 EXP_FUNC void STDCALL ax_free(void *y, const char* f, const int l)
feb11 0:85fceccc1a7c 246 {
feb11 0:85fceccc1a7c 247 if(enable)
feb11 0:85fceccc1a7c 248 printf("free\t");
feb11 0:85fceccc1a7c 249
feb11 0:85fceccc1a7c 250 remove_entry(y, f, l);
feb11 0:85fceccc1a7c 251 print_buf_stats();
feb11 0:85fceccc1a7c 252 free(y);
feb11 0:85fceccc1a7c 253 }
feb11 0:85fceccc1a7c 254 /*
feb11 0:85fceccc1a7c 255 EXP_FUNC int STDCALL ax_open(const char *pathname, int flags)
feb11 0:85fceccc1a7c 256 {
feb11 0:85fceccc1a7c 257 int x;
feb11 0:85fceccc1a7c 258
feb11 0:85fceccc1a7c 259 if ((x = open(pathname, flags)) < 0)
feb11 0:85fceccc1a7c 260 exit_now(file_open_str, pathname);
feb11 0:85fceccc1a7c 261
feb11 0:85fceccc1a7c 262 return x;
feb11 0:85fceccc1a7c 263 }
feb11 0:85fceccc1a7c 264 */
feb11 0:85fceccc1a7c 265
feb11 0:85fceccc1a7c 266 /**
feb11 0:85fceccc1a7c 267 * This is a call which will deliberately exit an application, but will
feb11 0:85fceccc1a7c 268 * display some information before dying.
feb11 0:85fceccc1a7c 269 */
feb11 0:85fceccc1a7c 270 void exit_now(const char *format, ...)
feb11 0:85fceccc1a7c 271 {
feb11 0:85fceccc1a7c 272 va_list argp;
feb11 0:85fceccc1a7c 273
feb11 0:85fceccc1a7c 274 va_start(argp, format);
feb11 0:85fceccc1a7c 275 vfprintf(stderr, format, argp);
feb11 0:85fceccc1a7c 276 va_end(argp);
feb11 0:85fceccc1a7c 277 abort();
feb11 0:85fceccc1a7c 278 }
feb11 0:85fceccc1a7c 279
feb11 0:85fceccc1a7c 280
feb11 0:85fceccc1a7c 281