Keith Ruenheck / HTTPClient-SSL

Got modem to work with MedSentry website. Includes minor change to a library file.

Dependencies:   CyaSSL

Dependents:   MTS-Socket

Fork of HTTPClient-SSL by MultiTech

HTTPClient.h@39:d7c5541a9124, 2015-01-19 (annotated)

Committer:
Vanger
Date:
Mon Jan 19 21:55:15 2015 +0000
Revision:
39:d7c5541a9124
Parent:
38:a4ccad70be9d
Child:
42:2f464f96c204
Pulling in the newest CyaSSL lib (3.3.0).; Tweaked code to be more robust.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:2ccb9960a044 1 /* HTTPClient.h */
donatien 10:e1351de84c16 2 /* Copyright (C) 2012 mbed.org, MIT License
donatien 10:e1351de84c16 3 *
donatien 10:e1351de84c16 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
donatien 10:e1351de84c16 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
donatien 10:e1351de84c16 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
donatien 10:e1351de84c16 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
donatien 10:e1351de84c16 8 * furnished to do so, subject to the following conditions:
donatien 10:e1351de84c16 9 *
donatien 10:e1351de84c16 10 * The above copyright notice and this permission notice shall be included in all copies or
donatien 10:e1351de84c16 11 * substantial portions of the Software.
donatien 10:e1351de84c16 12 *
donatien 10:e1351de84c16 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
donatien 10:e1351de84c16 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
donatien 10:e1351de84c16 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
donatien 10:e1351de84c16 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 10:e1351de84c16 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
donatien 10:e1351de84c16 18 */
donatien 0:2ccb9960a044 19
donatien 0:2ccb9960a044 20 /** \file
donatien 0:2ccb9960a044 21 HTTP Client header file
donatien 0:2ccb9960a044 22 */
donatien 0:2ccb9960a044 23
donatien 0:2ccb9960a044 24 #ifndef HTTP_CLIENT_H
donatien 0:2ccb9960a044 25 #define HTTP_CLIENT_H
donatien 0:2ccb9960a044 26
donatien 12:89d09a6db00a 27 #define HTTP_CLIENT_DEFAULT_TIMEOUT 15000
donatien 0:2ccb9960a044 28
donatien 0:2ccb9960a044 29 class HTTPData;
donatien 0:2ccb9960a044 30
donatien 0:2ccb9960a044 31 #include "IHTTPData.h"
donatien 0:2ccb9960a044 32 #include "mbed.h"
Vanger 33:3b2809748a9e 33 #include "TCPSocketConnection.h"
donatien 0:2ccb9960a044 34
Vanger 38:a4ccad70be9d 35 ///SSL peer verification setting
Vanger 38:a4ccad70be9d 36 enum SSLMethod {
Vanger 38:a4ccad70be9d 37 VERIFY_NONE = 0, ///Don't check peer certificate
Vanger 38:a4ccad70be9d 38 VERIFY_PEER = 1, ///Check peer certificate and skip if none available (insecure)
Vanger 38:a4ccad70be9d 39 };
Vanger 38:a4ccad70be9d 40
donatien 0:2ccb9960a044 41 ///HTTP client results
wolfSSL 18:d89df40b4cf3 42 enum HTTPResult {
Vanger 33:3b2809748a9e 43 HTTP_OK = 0, ///<Success
wolfSSL 18:d89df40b4cf3 44 HTTP_PROCESSING, ///<Processing
wolfSSL 18:d89df40b4cf3 45 HTTP_PARSE, ///<url Parse error
wolfSSL 18:d89df40b4cf3 46 HTTP_DNS, ///<Could not resolve name
wolfSSL 18:d89df40b4cf3 47 HTTP_PRTCL, ///<Protocol error
wolfSSL 18:d89df40b4cf3 48 HTTP_NOTFOUND, ///<HTTP 404 Error
wolfSSL 18:d89df40b4cf3 49 HTTP_REFUSED, ///<HTTP 403 Error
wolfSSL 18:d89df40b4cf3 50 HTTP_ERROR, ///<HTTP xxx error
wolfSSL 18:d89df40b4cf3 51 HTTP_TIMEOUT, ///<Connection timeout
wolfSSL 18:d89df40b4cf3 52 HTTP_CONN, ///<Connection error
wolfSSL 18:d89df40b4cf3 53 HTTP_CLOSED, ///<Connection was closed by remote host
wolfSSL 27:5d4739eae63e 54 HTTP_REDIRECT, ///<HTTP 300 - 303
donatien 0:2ccb9960a044 55 };
donatien 0:2ccb9960a044 56
donatien 0:2ccb9960a044 57 /**A simple HTTP Client
donatien 0:2ccb9960a044 58 The HTTPClient is composed of:
donatien 0:2ccb9960a044 59 - The actual client (HTTPClient)
donatien 0:2ccb9960a044 60 - Classes that act as a data repository, each of which deriving from the HTTPData class (HTTPText for short text content, HTTPFile for file I/O, HTTPMap for key/value pairs, and HTTPStream for streaming purposes)
donatien 0:2ccb9960a044 61 */
donatien 0:2ccb9960a044 62 class HTTPClient
donatien 0:2ccb9960a044 63 {
donatien 0:2ccb9960a044 64 public:
wolfSSL 18:d89df40b4cf3 65 ///Instantiate the HTTP client
wolfSSL 18:d89df40b4cf3 66 HTTPClient();
wolfSSL 18:d89df40b4cf3 67 ~HTTPClient();
wolfSSL 18:d89df40b4cf3 68
wolfSSL 18:d89df40b4cf3 69 /**
wolfSSL 18:d89df40b4cf3 70 Provides a basic authentification feature (Base64 encoded username and password)
wolfSSL 18:d89df40b4cf3 71 Pass two NULL pointers to switch back to no authentication
wolfSSL 18:d89df40b4cf3 72 @param user username to use for authentication, must remain valid durlng the whole HTTP session
wolfSSL 18:d89df40b4cf3 73 @param user password to use for authentication, must remain valid durlng the whole HTTP session
wolfSSL 18:d89df40b4cf3 74 */
wolfSSL 22:4b9a4151cc73 75 HTTPResult basicAuth(const char* user, const char* password); //Basic Authentification
wolfSSL 18:d89df40b4cf3 76
wolfSSL 18:d89df40b4cf3 77 //High Level setup functions
wolfSSL 18:d89df40b4cf3 78 /** Execute a GET request on the URL
wolfSSL 18:d89df40b4cf3 79 Blocks until completion
wolfSSL 18:d89df40b4cf3 80 @param url : url on which to execute the request
wolfSSL 18:d89df40b4cf3 81 @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
wolfSSL 18:d89df40b4cf3 82 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
wolfSSL 18:d89df40b4cf3 83 @return 0 on success, HTTP error (<0) on failure
wolfSSL 18:d89df40b4cf3 84 */
wolfSSL 18:d89df40b4cf3 85 HTTPResult get(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
wolfSSL 18:d89df40b4cf3 86
wolfSSL 18:d89df40b4cf3 87 /** Execute a GET request on the URL
wolfSSL 18:d89df40b4cf3 88 Blocks until completion
wolfSSL 18:d89df40b4cf3 89 This is a helper to directly get a piece of text from a HTTP result
wolfSSL 18:d89df40b4cf3 90 @param url : url on which to execute the request
wolfSSL 18:d89df40b4cf3 91 @param result : pointer to a char array in which the result will be stored
wolfSSL 18:d89df40b4cf3 92 @param maxResultLen : length of the char array (including space for the NULL-terminating char)
wolfSSL 18:d89df40b4cf3 93 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
wolfSSL 18:d89df40b4cf3 94 @return 0 on success, HTTP error (<0) on failure
wolfSSL 18:d89df40b4cf3 95 */
wolfSSL 18:d89df40b4cf3 96 HTTPResult get(const char* url, char* result, size_t maxResultLen, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
wolfSSL 18:d89df40b4cf3 97
wolfSSL 18:d89df40b4cf3 98 /** Execute a POST request on the URL
wolfSSL 18:d89df40b4cf3 99 Blocks until completion
wolfSSL 18:d89df40b4cf3 100 @param url : url on which to execute the request
wolfSSL 18:d89df40b4cf3 101 @param dataOut : a IHTTPDataOut instance that contains the data that will be posted
wolfSSL 18:d89df40b4cf3 102 @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
wolfSSL 18:d89df40b4cf3 103 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
wolfSSL 18:d89df40b4cf3 104 @return 0 on success, HTTP error (<0) on failure
wolfSSL 18:d89df40b4cf3 105 */
wolfSSL 18:d89df40b4cf3 106 HTTPResult post(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
donatien 0:2ccb9960a044 107
wolfSSL 18:d89df40b4cf3 108 /** Execute a PUT request on the URL
wolfSSL 18:d89df40b4cf3 109 Blocks until completion
wolfSSL 18:d89df40b4cf3 110 @param url : url on which to execute the request
wolfSSL 18:d89df40b4cf3 111 @param dataOut : a IHTTPDataOut instance that contains the data that will be put
wolfSSL 18:d89df40b4cf3 112 @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
wolfSSL 18:d89df40b4cf3 113 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
wolfSSL 18:d89df40b4cf3 114 @return 0 on success, HTTP error (<0) on failure
wolfSSL 18:d89df40b4cf3 115 */
wolfSSL 18:d89df40b4cf3 116 HTTPResult put(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
wolfSSL 18:d89df40b4cf3 117
wolfSSL 18:d89df40b4cf3 118 /** Execute a DELETE request on the URL
wolfSSL 18:d89df40b4cf3 119 Blocks until completion
wolfSSL 18:d89df40b4cf3 120 @param url : url on which to execute the request
wolfSSL 18:d89df40b4cf3 121 @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
wolfSSL 18:d89df40b4cf3 122 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
wolfSSL 18:d89df40b4cf3 123 @return 0 on success, HTTP error (<0) on failure
wolfSSL 18:d89df40b4cf3 124 */
wolfSSL 18:d89df40b4cf3 125 HTTPResult del(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
wolfSSL 18:d89df40b4cf3 126
wolfSSL 18:d89df40b4cf3 127 /** Get last request's HTTP response code
wolfSSL 18:d89df40b4cf3 128 @return The HTTP response code of the last request
wolfSSL 18:d89df40b4cf3 129 */
wolfSSL 18:d89df40b4cf3 130 int getHTTPResponseCode();
wolfSSL 22:4b9a4151cc73 131
Vanger 38:a4ccad70be9d 132 /** Set headers to be included in the following HTTP requests. Pass a NULL pointer to reset the headers stored.
Vanger 38:a4ccad70be9d 133 * Make sure the headers are formatted with a "\r\n" after each header.
Vanger 38:a4ccad70be9d 134 * @param header pointer to array containing the headers to be added*/
Vanger 38:a4ccad70be9d 135 void setHeader(const char *header) ;
Vanger 38:a4ccad70be9d 136
Vanger 38:a4ccad70be9d 137 /** Set SSL/TLS version.
Vanger 38:a4ccad70be9d 138 * @param minorV integer witha a value between 0 and 3
Vanger 38:a4ccad70be9d 139 * 0: SSL3, 1: TLS1.0, 2: TLS1.1, 3: TLS1.2
Vanger 38:a4ccad70be9d 140 * @returns HTTPResult based on success*/
Vanger 38:a4ccad70be9d 141 HTTPResult setSSLversion(int minorV) ;
Vanger 38:a4ccad70be9d 142
Vanger 38:a4ccad70be9d 143 /* set URL buffer for redirection */
Vanger 38:a4ccad70be9d 144 void setLocationBuf(char *url, int size) ;
Vanger 38:a4ccad70be9d 145
Vanger 38:a4ccad70be9d 146 /** Stores a root CA certificate for host authentication of a website.
Vanger 38:a4ccad70be9d 147 * Each new line should end with "\r\n" including the last line of each certificate.
Vanger 38:a4ccad70be9d 148 * Pass a pointer to the char array containing the certificate stored as a c-string.
Vanger 38:a4ccad70be9d 149 * Pass a NULL pointer to reset all certificates stored.
Vanger 38:a4ccad70be9d 150 * (Can pass in multiple certificates with one function call if the array contains concatenated certificates) */
Vanger 38:a4ccad70be9d 151 HTTPResult addRootCACertificate(const char* cert) ;
Vanger 38:a4ccad70be9d 152
Vanger 38:a4ccad70be9d 153 /** Sets the verification for peer authenticity when connecting with SSL
Vanger 38:a4ccad70be9d 154 * @param method specifies the method to use for peer verification
Vanger 38:a4ccad70be9d 155 * @VERIFY_NONE Sets the client to not verify the peer's certificates
Vanger 38:a4ccad70be9d 156 * @VERIFY_PEER Sets the client to verify the peer's certificates but skips if certificates unavailable
Vanger 38:a4ccad70be9d 157 * @VERIFY_FAIL_IF_NO_PEER_CERT Sets the client to verify the peer's certificates and throw an error if the
Vanger 38:a4ccad70be9d 158 * certificates are unavailable.
Vanger 38:a4ccad70be9d 159 * */
Vanger 38:a4ccad70be9d 160 void setPeerVerification(SSLMethod method);
wolfSSL 18:d89df40b4cf3 161
donatien 0:2ccb9960a044 162 private:
wolfSSL 18:d89df40b4cf3 163 enum HTTP_METH {
wolfSSL 18:d89df40b4cf3 164 HTTP_GET,
wolfSSL 18:d89df40b4cf3 165 HTTP_POST,
wolfSSL 18:d89df40b4cf3 166 HTTP_PUT,
wolfSSL 18:d89df40b4cf3 167 HTTP_DELETE,
wolfSSL 18:d89df40b4cf3 168 HTTP_HEAD
wolfSSL 18:d89df40b4cf3 169 };
wolfSSL 18:d89df40b4cf3 170
wolfSSL 18:d89df40b4cf3 171 HTTPResult connect(const char* url, HTTP_METH method, IHTTPDataOut* pDataOut, IHTTPDataIn* pDataIn, int timeout); //Execute request
wolfSSL 18:d89df40b4cf3 172 HTTPResult recv(char* buf, size_t minLen, size_t maxLen, size_t* pReadLen); //0 on success, err code on failure
wolfSSL 18:d89df40b4cf3 173 HTTPResult send(char* buf, size_t len = 0); //0 on success, err code on failure
wolfSSL 18:d89df40b4cf3 174 HTTPResult flush(void); //0 on success, err code on failure
wolfSSL 18:d89df40b4cf3 175 HTTPResult parseURL(const char* url, char* scheme, size_t maxSchemeLen, char* host, size_t maxHostLen, uint16_t* port, char* path, size_t maxPathLen); //Parse URL
wolfSSL 18:d89df40b4cf3 176 void cyassl_free(void) ;
wolfSSL 22:4b9a4151cc73 177 HTTPResult bAuth(void) ;
wolfSSL 27:5d4739eae63e 178 HTTPResult readHeader(void) ;
wolfSSL 22:4b9a4151cc73 179
wolfSSL 18:d89df40b4cf3 180 //Parameters
Vanger 33:3b2809748a9e 181 TCPSocketConnection _m_sock;
wolfSSL 18:d89df40b4cf3 182
wolfSSL 18:d89df40b4cf3 183 int m_timeout;
Vanger 38:a4ccad70be9d 184
wolfSSL 18:d89df40b4cf3 185 const char* m_basicAuthUser;
wolfSSL 18:d89df40b4cf3 186 const char* m_basicAuthPassword;
wolfSSL 18:d89df40b4cf3 187 int m_httpResponseCode;
donatien 0:2ccb9960a044 188
wolfSSL 27:5d4739eae63e 189 const char * header ;
wolfSSL 27:5d4739eae63e 190 char * redirect_url ;
wolfSSL 27:5d4739eae63e 191 int redirect_url_size ;
wolfSSL 27:5d4739eae63e 192 int redirect ;
wolfSSL 27:5d4739eae63e 193
wolfSSL 18:d89df40b4cf3 194 /* for CyaSSL */
Vanger 38:a4ccad70be9d 195 const char* certificates; //CA certificates
Vanger 38:a4ccad70be9d 196 SSLMethod peerMethod;
wolfSSL 22:4b9a4151cc73 197 int SSLver ;
wolfSSL 18:d89df40b4cf3 198 uint16_t port;
wolfSSL 18:d89df40b4cf3 199 struct CYASSL_CTX* ctx ;
wolfSSL 18:d89df40b4cf3 200 struct CYASSL * ssl ;
donatien 0:2ccb9960a044 201 };
donatien 0:2ccb9960a044 202
donatien 0:2ccb9960a044 203 //Including data containers here for more convenience
ansond 29:2d96cc752d19 204 #include "data/HTTPJson.h"
donatien 0:2ccb9960a044 205 #include "data/HTTPMap.h"
donatien 0:2ccb9960a044 206
donatien 0:2ccb9960a044 207 #endif