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 crypto_misc.h
feb11 0:85fceccc1a7c 33 */
feb11 0:85fceccc1a7c 34
feb11 0:85fceccc1a7c 35 #ifndef HEADER_CRYPTO_MISC_H
feb11 0:85fceccc1a7c 36 #define HEADER_CRYPTO_MISC_H
feb11 0:85fceccc1a7c 37
feb11 0:85fceccc1a7c 38 #ifdef __cplusplus
feb11 0:85fceccc1a7c 39 extern "C" {
feb11 0:85fceccc1a7c 40 #endif
feb11 0:85fceccc1a7c 41
feb11 0:85fceccc1a7c 42 #include "config.h"
feb11 0:85fceccc1a7c 43 #include "crypto.h"
feb11 0:85fceccc1a7c 44 #include "bigint.h"
feb11 0:85fceccc1a7c 45
feb11 0:85fceccc1a7c 46 /**************************************************************************
feb11 0:85fceccc1a7c 47 * X509 declarations
feb11 0:85fceccc1a7c 48 **************************************************************************/
feb11 0:85fceccc1a7c 49 #define X509_OK 0
feb11 0:85fceccc1a7c 50 #define X509_NOT_OK -1
feb11 0:85fceccc1a7c 51 #define X509_VFY_ERROR_NO_TRUSTED_CERT -2
feb11 0:85fceccc1a7c 52 #define X509_VFY_ERROR_BAD_SIGNATURE -3
feb11 0:85fceccc1a7c 53 #define X509_VFY_ERROR_NOT_YET_VALID -4
feb11 0:85fceccc1a7c 54 #define X509_VFY_ERROR_EXPIRED -5
feb11 0:85fceccc1a7c 55 #define X509_VFY_ERROR_SELF_SIGNED -6
feb11 0:85fceccc1a7c 56 #define X509_VFY_ERROR_INVALID_CHAIN -7
feb11 0:85fceccc1a7c 57 #define X509_VFY_ERROR_UNSUPPORTED_DIGEST -8
feb11 0:85fceccc1a7c 58 #define X509_INVALID_PRIV_KEY -9
feb11 0:85fceccc1a7c 59 #define X509_KEY_SIZE_TOO_BIG -10
feb11 0:85fceccc1a7c 60
feb11 0:85fceccc1a7c 61 /*
feb11 0:85fceccc1a7c 62 * The Distinguished Name
feb11 0:85fceccc1a7c 63 */
feb11 0:85fceccc1a7c 64 #define X509_NUM_DN_TYPES 3
feb11 0:85fceccc1a7c 65 #define X509_COMMON_NAME 0
feb11 0:85fceccc1a7c 66 #define X509_ORGANIZATION 1
feb11 0:85fceccc1a7c 67 #define X509_ORGANIZATIONAL_UNIT 2
feb11 0:85fceccc1a7c 68
feb11 0:85fceccc1a7c 69 #include <time.h>
feb11 0:85fceccc1a7c 70
feb11 0:85fceccc1a7c 71 struct PrecomputedCertificate;
feb11 0:85fceccc1a7c 72 typedef struct PrecomputedCertificate PrecomputedCertificate;
feb11 0:85fceccc1a7c 73
feb11 0:85fceccc1a7c 74
feb11 0:85fceccc1a7c 75 struct _x509_ctx
feb11 0:85fceccc1a7c 76 {
feb11 0:85fceccc1a7c 77 char *ca_cert_dn[X509_NUM_DN_TYPES];
feb11 0:85fceccc1a7c 78 char *cert_dn[X509_NUM_DN_TYPES];
feb11 0:85fceccc1a7c 79 char **subject_alt_dnsnames;
feb11 0:85fceccc1a7c 80 time_t not_before;
feb11 0:85fceccc1a7c 81 time_t not_after;
feb11 0:85fceccc1a7c 82 uint8_t *signature;
feb11 0:85fceccc1a7c 83 uint16_t sig_len;
feb11 0:85fceccc1a7c 84 uint8_t sig_type;
feb11 0:85fceccc1a7c 85 RSA_CTX *rsa_ctx;
feb11 0:85fceccc1a7c 86 bigint *digest;
feb11 0:85fceccc1a7c 87 struct _x509_ctx *next;
feb11 0:85fceccc1a7c 88 };
feb11 0:85fceccc1a7c 89
feb11 0:85fceccc1a7c 90 typedef struct _x509_ctx X509_CTX;
feb11 0:85fceccc1a7c 91 typedef struct
feb11 0:85fceccc1a7c 92 {
feb11 0:85fceccc1a7c 93 X509_CTX *cert[CONFIG_X509_MAX_CA_CERTS];
feb11 0:85fceccc1a7c 94 } CA_CERT_CTX;
feb11 0:85fceccc1a7c 95
feb11 0:85fceccc1a7c 96
feb11 0:85fceccc1a7c 97 int x509_new(const uint8_t *cert, int *len, X509_CTX **ctx);
feb11 0:85fceccc1a7c 98 void x509_free(X509_CTX *x509_ctx);
feb11 0:85fceccc1a7c 99 int x509_verify(PrecomputedCertificate *cert);
feb11 0:85fceccc1a7c 100 bigint *sig_verify(BI_CTX *ctx, const uint8_t *sig, int sig_len,
feb11 0:85fceccc1a7c 101 bigint *modulus, bigint *pub_exp);
feb11 0:85fceccc1a7c 102
feb11 0:85fceccc1a7c 103 #ifdef CONFIG_SSL_FULL_MODE
feb11 0:85fceccc1a7c 104 void x509_print(const X509_CTX *cert, CA_CERT_CTX *ca_cert_ctx);
feb11 0:85fceccc1a7c 105 const char * x509_display_error(int error);
feb11 0:85fceccc1a7c 106 #endif
feb11 0:85fceccc1a7c 107
feb11 0:85fceccc1a7c 108 /**************************************************************************
feb11 0:85fceccc1a7c 109 * ASN1 declarations
feb11 0:85fceccc1a7c 110 **************************************************************************/
feb11 0:85fceccc1a7c 111 #define ASN1_INTEGER 0x02
feb11 0:85fceccc1a7c 112 #define ASN1_BIT_STRING 0x03
feb11 0:85fceccc1a7c 113 #define ASN1_OCTET_STRING 0x04
feb11 0:85fceccc1a7c 114 #define ASN1_NULL 0x05
feb11 0:85fceccc1a7c 115 #define ASN1_PRINTABLE_STR2 0x0C
feb11 0:85fceccc1a7c 116 #define ASN1_OID 0x06
feb11 0:85fceccc1a7c 117 #define ASN1_PRINTABLE_STR2 0x0C
feb11 0:85fceccc1a7c 118 #define ASN1_PRINTABLE_STR 0x13
feb11 0:85fceccc1a7c 119 #define ASN1_TELETEX_STR 0x14
feb11 0:85fceccc1a7c 120 #define ASN1_IA5_STR 0x16
feb11 0:85fceccc1a7c 121 #define ASN1_UTC_TIME 0x17
feb11 0:85fceccc1a7c 122 #define ASN1_UNICODE_STR 0x1e
feb11 0:85fceccc1a7c 123 #define ASN1_SEQUENCE 0x30
feb11 0:85fceccc1a7c 124 #define ASN1_CONTEXT_DNSNAME 0x82
feb11 0:85fceccc1a7c 125 #define ASN1_SET 0x31
feb11 0:85fceccc1a7c 126 #define ASN1_V3_DATA 0xa3
feb11 0:85fceccc1a7c 127 #define ASN1_IMPLICIT_TAG 0x80
feb11 0:85fceccc1a7c 128 #define ASN1_CONTEXT_DNSNAME 0x82
feb11 0:85fceccc1a7c 129 #define ASN1_EXPLICIT_TAG 0xa0
feb11 0:85fceccc1a7c 130 #define ASN1_V3_DATA 0xa3
feb11 0:85fceccc1a7c 131
feb11 0:85fceccc1a7c 132 #define SIG_TYPE_MD2 0x02
feb11 0:85fceccc1a7c 133 #define SIG_TYPE_MD5 0x04
feb11 0:85fceccc1a7c 134 #define SIG_TYPE_SHA1 0x05
feb11 0:85fceccc1a7c 135
feb11 0:85fceccc1a7c 136 int get_asn1_length(const uint8_t *buf, int *offset);
feb11 0:85fceccc1a7c 137 int asn1_get_private_key(const uint8_t *buf, int len, RSA_CTX **rsa_ctx);
feb11 0:85fceccc1a7c 138 int asn1_next_obj(const uint8_t *buf, int *offset, int obj_type);
feb11 0:85fceccc1a7c 139 int asn1_skip_obj(const uint8_t *buf, int *offset, int obj_type);
feb11 0:85fceccc1a7c 140 int asn1_get_int(const uint8_t *buf, int *offset, uint8_t **object);
feb11 0:85fceccc1a7c 141 int asn1_version(const uint8_t *cert, int *offset, X509_CTX *x509_ctx);
feb11 0:85fceccc1a7c 142 int asn1_validity(const uint8_t *cert, int *offset, X509_CTX *x509_ctx);
feb11 0:85fceccc1a7c 143 int asn1_name(const uint8_t *cert, int *offset, char *dn[]);
feb11 0:85fceccc1a7c 144 int asn1_public_key(const uint8_t *cert, int *offset, X509_CTX *x509_ctx);
feb11 0:85fceccc1a7c 145 #ifdef CONFIG_SSL_CERT_VERIFICATION
feb11 0:85fceccc1a7c 146 int asn1_signature(const uint8_t *cert, int *offset, X509_CTX *x509_ctx);
feb11 0:85fceccc1a7c 147 int asn1_find_subjectaltname(const uint8_t* cert, int offset);
feb11 0:85fceccc1a7c 148 int asn1_compare_dn(char * const dn1[], char * const dn2[]);
feb11 0:85fceccc1a7c 149 #endif /* CONFIG_SSL_CERT_VERIFICATION */
feb11 0:85fceccc1a7c 150 int asn1_signature_type(const uint8_t *cert,
feb11 0:85fceccc1a7c 151 int *offset, X509_CTX *x509_ctx);
feb11 0:85fceccc1a7c 152
feb11 0:85fceccc1a7c 153 /**************************************************************************
feb11 0:85fceccc1a7c 154 * MISC declarations
feb11 0:85fceccc1a7c 155 **************************************************************************/
feb11 0:85fceccc1a7c 156 #define SALT_SIZE 8
feb11 0:85fceccc1a7c 157
feb11 0:85fceccc1a7c 158 extern const char * const unsupported_str;
feb11 0:85fceccc1a7c 159
feb11 0:85fceccc1a7c 160 typedef void (*crypt_func)(void *, const uint8_t *, uint8_t *, int);
feb11 0:85fceccc1a7c 161 typedef void (*hmac_func)(const uint8_t *msg, int length, const uint8_t *key,
feb11 0:85fceccc1a7c 162 int key_len, uint8_t *digest);
feb11 0:85fceccc1a7c 163
feb11 0:85fceccc1a7c 164 int get_file(const char *filename, uint8_t **buf);
feb11 0:85fceccc1a7c 165
feb11 0:85fceccc1a7c 166 #if defined(CONFIG_SSL_FULL_MODE) || defined(WIN32) || defined(CONFIG_DEBUG)
feb11 0:85fceccc1a7c 167 EXP_FUNC void STDCALL print_blob(const char *format, const uint8_t *data, int size, ...);
feb11 0:85fceccc1a7c 168 #else
feb11 0:85fceccc1a7c 169 #define print_blob(...)
feb11 0:85fceccc1a7c 170 #endif
feb11 0:85fceccc1a7c 171
feb11 0:85fceccc1a7c 172 EXP_FUNC int STDCALL base64_decode(const char *in, int len,
feb11 0:85fceccc1a7c 173 uint8_t *out, int *outlen);
feb11 0:85fceccc1a7c 174
feb11 0:85fceccc1a7c 175 #ifdef __cplusplus
feb11 0:85fceccc1a7c 176 }
feb11 0:85fceccc1a7c 177 #endif
feb11 0:85fceccc1a7c 178
feb11 0:85fceccc1a7c 179 #endif
feb11 0:85fceccc1a7c 180
feb11 0:85fceccc1a7c 181