File content as of revision 55:be7aecd7d2ec:

/* HTTPClient.h */
/* Copyright (C) 2012 mbed.org, MIT License
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 * and associated documentation files (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or
 * substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

/** \file
HTTP Client header file
*/

#ifndef HTTP_CLIENT_H
#define HTTP_CLIENT_H

#define HTTP_CLIENT_DEFAULT_TIMEOUT 15000

class HTTPData;

#include "IHTTPData.h"
#include "mbed.h"
#include "TCPSocketConnection.h"

///SSL peer verification setting    
enum SSLMethod {
    VERIFY_NONE                 = 0, ///Don't check peer certificate
    VERIFY_PEER                 = 1, ///Client:Check peer certificate, Server:Check peer certificate and skip if no certificate received
    VERIFY_FAIL_IF_NO_PEER_CERT = 2, ///Client:Check peer certificate, Server:Check peer certificate and fail if none found
};

///HTTP client results
enum HTTPResult {
    HTTP_OK = 0, ///<Success
    HTTP_PROCESSING, ///<Processing
    HTTP_PARSE, ///<url Parse error
    HTTP_DNS, ///<Could not resolve name
    HTTP_PRTCL, ///<Protocol error
    HTTP_NOTFOUND, ///<HTTP 404 Error
    HTTP_REFUSED, ///<HTTP 403 Error
    HTTP_ERROR, ///<HTTP xxx error
    HTTP_TIMEOUT, ///<Connection timeout
    HTTP_CONN, ///<Connection error
    HTTP_CLOSED, ///<Connection was closed by remote host
    HTTP_REDIRECT, ///<HTTP 300 - 303
};

/**A simple HTTP Client
The HTTPClient is composed of:
- The actual client (HTTPClient)
- 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)
*/
class HTTPClient
{
public:
    ///Instantiate the HTTP client
    HTTPClient();
    ~HTTPClient();

    /**
    Provides a basic authentification feature (Base64 encoded username and password)
    Pass two NULL pointers to switch back to no authentication
    @param user username to use for authentication, must remain valid durlng the whole HTTP session
    @param user password to use for authentication, must remain valid durlng the whole HTTP session
    */
    HTTPResult basicAuth(const char* user, const char* password); //Basic Authentification

    //High Level setup functions
    /** Execute a GET request on the URL
    Blocks until completion
    @param url : url on which to execute the request. Format of: http[s]://<host>/[<path>][#fragment_id]
    @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
    @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
    @return 0 on success, HTTP error (<0) on failure
    */
    HTTPResult get(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking

    /** Execute a GET request on the URL
    Blocks until completion
    This is a helper to directly get a piece of text from a HTTP result
    @param url : url on which to execute the request. Format of: http[s]://<host>/[<path>][#fragment_id]
    @param result : pointer to a char array in which the result will be stored
    @param maxResultLen : length of the char array (including space for the NULL-terminating char)
    @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
    @return 0 on success, HTTP error (<0) on failure
    */
    HTTPResult get(const char* url, char* result, size_t maxResultLen, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking

    /** Execute a POST request on the URL
    Blocks until completion
    @param url : url on which to execute the request. Format of: http[s]://<host>/[<path>][#fragment_id]
    @param dataOut : a IHTTPDataOut instance that contains the data that will be posted
    @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
    @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
    @return 0 on success, HTTP error (<0) on failure
    */
    HTTPResult post(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking

    /** Execute a PUT request on the URL
    Blocks until completion
    @param url : url on which to execute the request. Format of: http[s]://<host>/[<path>][#fragment_id]
    @param dataOut : a IHTTPDataOut instance that contains the data that will be put
    @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
    @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
    @return 0 on success, HTTP error (<0) on failure
    */
    HTTPResult put(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking

    /** Execute a DELETE request on the URL
    Blocks until completion
    @param url : url on which to execute the request. Format of: http[s]://<host>/[<path>][#fragment_id]
    @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
    @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
    @return 0 on success, HTTP error (<0) on failure
    */
    HTTPResult del(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking

    /** Get last request's HTTP response code
    @return The HTTP response code of the last request
    */
    int getHTTPResponseCode();
    
    /** Set headers to be included in the following HTTP requests. Pass a NULL pointer to reset the headers stored. 
    * Make sure the headers are formatted with a "\r\n" after each header.
    * @param header pointer to array containing the headers to be added*/
    void setHeader(const char *header) ;
    
    /** Set SSL/TLS version. 
    * @param minorV integer witha a value between 0 and 3
    * 0: SSL3, 1: TLS1.0, 2: TLS1.1, 3: TLS1.2 
    * @returns HTTPResult based on success*/
    HTTPResult setSSLversion(int minorV) ; 
    
    /* set URL buffer for redirection */
    void setLocationBuf(char *url, int size) ; 
    
    /** Stores a root CA certificate for host authentication of a website.
    * Each new line should end with "\r\n" including the last line of each certificate.
    * Pass a pointer to the char array containing the certificate stored as a c-string.
    * Pass a NULL pointer to reset all certificates stored. 
    * (Can pass in multiple certificates with one function call if the array contains concatenated certificates) */
    HTTPResult addRootCACertificate(const char* cert) ;
    
    /** Sets the verification for peer authenticity when connecting with SSL
    * @param method specifies the method to use for peer verification
    * @VERIFY_NONE Sets the client to not verify the peer's certificates
    * @VERIFY_PEER Sets the client to verify the peer's certificates but skips if certificates unavailable
    * @VERIFY_FAIL_IF_NO_PEER_CERT Sets the client to verify the peer's certificates and throw an error if the 
    * certificates are unavailable.
    * */
    void setPeerVerification(SSLMethod method);

private:
    enum HTTP_METH {
        HTTP_GET,
        HTTP_POST,
        HTTP_PUT,
        HTTP_DELETE,
        HTTP_HEAD
    };

    HTTPResult connect(const char* url, HTTP_METH method, IHTTPDataOut* pDataOut, IHTTPDataIn* pDataIn, int timeout); //Execute request
    HTTPResult recv(char* buf, size_t minLen, size_t maxLen, size_t* pReadLen); //0 on success, err code on failure
    HTTPResult send(char* buf, size_t len = 0); //0 on success, err code on failure
    HTTPResult flush(void); //0 on success, err code on failure
    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
    void cyassl_free(void) ;
    HTTPResult bAuth(void) ;
    HTTPResult readHeader(void) ;
    
    //Parameters
    TCPSocketConnection _m_sock;

    int m_timeout;
    
    const char* m_basicAuthUser;
    const char* m_basicAuthPassword;
    int m_httpResponseCode;

    const char * header ;
    char * redirect_url ;
    int    redirect_url_size ;
    int    redirect ;
    
    /* for CyaSSL */
    const char* certificates; //CA certificates
    SSLMethod peerMethod;
    int    SSLver ;
    uint16_t port;
    struct CYASSL_CTX* ctx ;
    struct CYASSL    * ssl ;
};

//Including data containers here for more convenience
#include "data/HTTPJson.h"
#include "data/HTTPMap.h"

#endif