HTTPClient-SSL - Fork of the working HTTPClient adaptation using C…

Users » ansond » Code » HTTPClient-SSL

Fork of the working HTTPClient adaptation using CyaSSL. This version adds a derivation of HTTPText called HTTPJson to emit JSON text properly. Additionally, the URL parser has defines that permit longer URLs to be utilized.

Dependencies: mbedTLSLibrary

Dependents: SalesforceInterface df-2014-heroku-thermostat-k64f SalesforceInterface

Fork of HTTPClient by wolf SSL

This is a fork of the working HTTPS/SSL library that contains two extensions:

- HTTPJson - a derivation of HTTPText for emitting JSON strings specifically. No JSON parsing/checking is accomplished - HTTPJson simply sets the right Content-Type for HTTP(S).

- Expanded internal buffers for longer URLs. This is set in HTTPClient.cpp and is tunable.

HTTPClient.h@26:bf979804b653, 2014-07-21 (annotated)

Committer:: wolfSSL
Date:: Mon Jul 21 11:30:29 2014 +0000
Revision:: 26:bf979804b653
Parent:: 22:4b9a4151cc73
Child:: 29:2d96cc752d19

Who changed what in which revision?

User	Revision	Line number	New 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"
donatien	0:2ccb9960a044	33
donatien	0:2ccb9960a044	34	///HTTP client results
wolfSSL	18:d89df40b4cf3	35	enum HTTPResult {
wolfSSL	18:d89df40b4cf3	36	HTTP_PROCESSING, ///<Processing
wolfSSL	18:d89df40b4cf3	37	HTTP_PARSE, ///<url Parse error
wolfSSL	18:d89df40b4cf3	38	HTTP_DNS, ///<Could not resolve name
wolfSSL	18:d89df40b4cf3	39	HTTP_PRTCL, ///<Protocol error
wolfSSL	18:d89df40b4cf3	40	HTTP_NOTFOUND, ///<HTTP 404 Error
wolfSSL	18:d89df40b4cf3	41	HTTP_REFUSED, ///<HTTP 403 Error
wolfSSL	18:d89df40b4cf3	42	HTTP_ERROR, ///<HTTP xxx error
wolfSSL	18:d89df40b4cf3	43	HTTP_TIMEOUT, ///<Connection timeout
wolfSSL	18:d89df40b4cf3	44	HTTP_CONN, ///<Connection error
wolfSSL	18:d89df40b4cf3	45	HTTP_CLOSED, ///<Connection was closed by remote host
wolfSSL	26:bf979804b653	46	HTTP_REDIRECT, ///<HTTP 300 - 303
wolfSSL	18:d89df40b4cf3	47	HTTP_OK = 0, ///<Success
donatien	0:2ccb9960a044	48	};
donatien	0:2ccb9960a044	49
donatien	0:2ccb9960a044	50	/**A simple HTTP Client
donatien	0:2ccb9960a044	51	The HTTPClient is composed of:
donatien	0:2ccb9960a044	52	- The actual client (HTTPClient)
donatien	0:2ccb9960a044	53	- 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	54	*/
donatien	0:2ccb9960a044	55	class HTTPClient
donatien	0:2ccb9960a044	56	{
donatien	0:2ccb9960a044	57	public:
wolfSSL	18:d89df40b4cf3	58	///Instantiate the HTTP client
wolfSSL	18:d89df40b4cf3	59	HTTPClient();
wolfSSL	18:d89df40b4cf3	60	~HTTPClient();
wolfSSL	18:d89df40b4cf3	61
wolfSSL	18:d89df40b4cf3	62	/**
wolfSSL	18:d89df40b4cf3	63	Provides a basic authentification feature (Base64 encoded username and password)
wolfSSL	18:d89df40b4cf3	64	Pass two NULL pointers to switch back to no authentication
wolfSSL	18:d89df40b4cf3	65	@param user username to use for authentication, must remain valid durlng the whole HTTP session
wolfSSL	18:d89df40b4cf3	66	@param user password to use for authentication, must remain valid durlng the whole HTTP session
wolfSSL	18:d89df40b4cf3	67	*/
wolfSSL	22:4b9a4151cc73	68	HTTPResult basicAuth(const char* user, const char* password); //Basic Authentification
wolfSSL	18:d89df40b4cf3	69
wolfSSL	18:d89df40b4cf3	70	//High Level setup functions
wolfSSL	18:d89df40b4cf3	71	/** Execute a GET request on the URL
wolfSSL	18:d89df40b4cf3	72	Blocks until completion
wolfSSL	18:d89df40b4cf3	73	@param url : url on which to execute the request
wolfSSL	18:d89df40b4cf3	74	@param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
wolfSSL	18:d89df40b4cf3	75	@param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
wolfSSL	18:d89df40b4cf3	76	@return 0 on success, HTTP error (<0) on failure
wolfSSL	18:d89df40b4cf3	77	*/
wolfSSL	18:d89df40b4cf3	78	HTTPResult get(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
wolfSSL	18:d89df40b4cf3	79
wolfSSL	18:d89df40b4cf3	80	/** Execute a GET request on the URL
wolfSSL	18:d89df40b4cf3	81	Blocks until completion
wolfSSL	18:d89df40b4cf3	82	This is a helper to directly get a piece of text from a HTTP result
wolfSSL	18:d89df40b4cf3	83	@param url : url on which to execute the request
wolfSSL	18:d89df40b4cf3	84	@param result : pointer to a char array in which the result will be stored
wolfSSL	18:d89df40b4cf3	85	@param maxResultLen : length of the char array (including space for the NULL-terminating char)
wolfSSL	18:d89df40b4cf3	86	@param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
wolfSSL	18:d89df40b4cf3	87	@return 0 on success, HTTP error (<0) on failure
wolfSSL	18:d89df40b4cf3	88	*/
wolfSSL	18:d89df40b4cf3	89	HTTPResult get(const char* url, char* result, size_t maxResultLen, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
wolfSSL	18:d89df40b4cf3	90
wolfSSL	18:d89df40b4cf3	91	/** Execute a POST request on the URL
wolfSSL	18:d89df40b4cf3	92	Blocks until completion
wolfSSL	18:d89df40b4cf3	93	@param url : url on which to execute the request
wolfSSL	18:d89df40b4cf3	94	@param dataOut : a IHTTPDataOut instance that contains the data that will be posted
wolfSSL	18:d89df40b4cf3	95	@param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
wolfSSL	18:d89df40b4cf3	96	@param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
wolfSSL	18:d89df40b4cf3	97	@return 0 on success, HTTP error (<0) on failure
wolfSSL	18:d89df40b4cf3	98	*/
wolfSSL	18:d89df40b4cf3	99	HTTPResult post(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
donatien	0:2ccb9960a044	100
wolfSSL	18:d89df40b4cf3	101	/** Execute a PUT request on the URL
wolfSSL	18:d89df40b4cf3	102	Blocks until completion
wolfSSL	18:d89df40b4cf3	103	@param url : url on which to execute the request
wolfSSL	18:d89df40b4cf3	104	@param dataOut : a IHTTPDataOut instance that contains the data that will be put
wolfSSL	18:d89df40b4cf3	105	@param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
wolfSSL	18:d89df40b4cf3	106	@param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
wolfSSL	18:d89df40b4cf3	107	@return 0 on success, HTTP error (<0) on failure
wolfSSL	18:d89df40b4cf3	108	*/
wolfSSL	18:d89df40b4cf3	109	HTTPResult put(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
wolfSSL	18:d89df40b4cf3	110
wolfSSL	18:d89df40b4cf3	111	/** Execute a DELETE request on the URL
wolfSSL	18:d89df40b4cf3	112	Blocks until completion
wolfSSL	18:d89df40b4cf3	113	@param url : url on which to execute the request
wolfSSL	18:d89df40b4cf3	114	@param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
wolfSSL	18:d89df40b4cf3	115	@param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
wolfSSL	18:d89df40b4cf3	116	@return 0 on success, HTTP error (<0) on failure
wolfSSL	18:d89df40b4cf3	117	*/
wolfSSL	18:d89df40b4cf3	118	HTTPResult del(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
wolfSSL	18:d89df40b4cf3	119
wolfSSL	18:d89df40b4cf3	120	/** Get last request's HTTP response code
wolfSSL	18:d89df40b4cf3	121	@return The HTTP response code of the last request
wolfSSL	18:d89df40b4cf3	122	*/
wolfSSL	18:d89df40b4cf3	123	int getHTTPResponseCode();
wolfSSL	22:4b9a4151cc73	124
wolfSSL	26:bf979804b653	125	void setHeader(const char header) ; / set http headers */
wolfSSL	22:4b9a4151cc73	126	HTTPResult setSSLversion(int minorV) ; /* set SSL/TLS version. 0: SSL3, 1: TLS1.0, 2: TLS1.1, 3: TLS1.2 */
wolfSSL	26:bf979804b653	127	void setLocationBuf(char url, int size) ; / set URL buffer for redirection */
wolfSSL	18:d89df40b4cf3	128
donatien	0:2ccb9960a044	129	private:
wolfSSL	18:d89df40b4cf3	130	enum HTTP_METH {
wolfSSL	18:d89df40b4cf3	131	HTTP_GET,
wolfSSL	18:d89df40b4cf3	132	HTTP_POST,
wolfSSL	18:d89df40b4cf3	133	HTTP_PUT,
wolfSSL	18:d89df40b4cf3	134	HTTP_DELETE,
wolfSSL	18:d89df40b4cf3	135	HTTP_HEAD
wolfSSL	18:d89df40b4cf3	136	};
wolfSSL	18:d89df40b4cf3	137
wolfSSL	18:d89df40b4cf3	138	HTTPResult connect(const char* url, HTTP_METH method, IHTTPDataOut* pDataOut, IHTTPDataIn* pDataIn, int timeout); //Execute request
wolfSSL	18:d89df40b4cf3	139	HTTPResult recv(char* buf, size_t minLen, size_t maxLen, size_t* pReadLen); //0 on success, err code on failure
wolfSSL	18:d89df40b4cf3	140	HTTPResult send(char* buf, size_t len = 0); //0 on success, err code on failure
wolfSSL	18:d89df40b4cf3	141	HTTPResult flush(void); //0 on success, err code on failure
wolfSSL	18:d89df40b4cf3	142	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	143	void cyassl_free(void) ;
wolfSSL	22:4b9a4151cc73	144	HTTPResult bAuth(void) ;
wolfSSL	26:bf979804b653	145	HTTPResult readHeader(void) ;
wolfSSL	22:4b9a4151cc73	146
wolfSSL	18:d89df40b4cf3	147	//Parameters
wolfSSL	18:d89df40b4cf3	148
wolfSSL	18:d89df40b4cf3	149	int m_timeout;
donatien	0:2ccb9960a044	150
wolfSSL	18:d89df40b4cf3	151	const char* m_basicAuthUser;
wolfSSL	18:d89df40b4cf3	152	const char* m_basicAuthPassword;
wolfSSL	18:d89df40b4cf3	153	int m_httpResponseCode;
donatien	0:2ccb9960a044	154
wolfSSL	26:bf979804b653	155	const char * header ;
wolfSSL	26:bf979804b653	156	char * redirect_url ;
wolfSSL	26:bf979804b653	157	int redirect_url_size ;
wolfSSL	26:bf979804b653	158	int redirect ;
wolfSSL	26:bf979804b653	159
wolfSSL	18:d89df40b4cf3	160	/* for CyaSSL */
wolfSSL	22:4b9a4151cc73	161	int SSLver ;
wolfSSL	18:d89df40b4cf3	162	uint16_t port;
wolfSSL	18:d89df40b4cf3	163	struct CYASSL_CTX* ctx ;
wolfSSL	18:d89df40b4cf3	164	struct CYASSL * ssl ;
donatien	0:2ccb9960a044	165	};
donatien	0:2ccb9960a044	166
donatien	0:2ccb9960a044	167	//Including data containers here for more convenience
donatien	0:2ccb9960a044	168	#include "data/HTTPText.h"
donatien	0:2ccb9960a044	169	#include "data/HTTPMap.h"
donatien	0:2ccb9960a044	170
donatien	0:2ccb9960a044	171	#endif

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	27 Aug 2014
Imports:	54
Forks:	2
Commits:	54
Dependents:	3
Dependencies:	1
Followers:	7

Developers

Doug Anson

Sam Grove

The code in this repository is Apache licensed.

HTTPClient.h@26:bf979804b653, 2014-07-21 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Developers

Important Information for this Arm website

Access Warning