Kentaro Sekimoto / mbed-http

mbed-http

Fork of mbed-http by sandbox

source/https_request.h@22:fb5e4bc49534, 2018-01-02 (annotated)

Committer:
ksekimoto
Date:
Tue Jan 02 16:00:05 2018 +0000
Revision:
22:fb5e4bc49534
Parent:
20:0e63d6a93c02 
Change http-buffer-size for GR-PEACH

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jan Jongboom 0:910f5949759f 1 /*
Jan Jongboom 0:910f5949759f 2 * PackageLicenseDeclared: Apache-2.0
Jan Jongboom 0:910f5949759f 3 * Copyright (c) 2017 ARM Limited
Jan Jongboom 0:910f5949759f 4 *
Jan Jongboom 0:910f5949759f 5 * Licensed under the Apache License, Version 2.0 (the "License");
Jan Jongboom 0:910f5949759f 6 * you may not use this file except in compliance with the License.
Jan Jongboom 0:910f5949759f 7 * You may obtain a copy of the License at
Jan Jongboom 0:910f5949759f 8 *
Jan Jongboom 0:910f5949759f 9 * http://www.apache.org/licenses/LICENSE-2.0
Jan Jongboom 0:910f5949759f 10 *
Jan Jongboom 0:910f5949759f 11 * Unless required by applicable law or agreed to in writing, software
Jan Jongboom 0:910f5949759f 12 * distributed under the License is distributed on an "AS IS" BASIS,
Jan Jongboom 0:910f5949759f 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Jan Jongboom 0:910f5949759f 14 * See the License for the specific language governing permissions and
Jan Jongboom 0:910f5949759f 15 * limitations under the License.
Jan Jongboom 0:910f5949759f 16 */
Jan Jongboom 0:910f5949759f 17
Jan Jongboom 0:910f5949759f 18 #ifndef _MBED_HTTPS_REQUEST_H_
Jan Jongboom 0:910f5949759f 19 #define _MBED_HTTPS_REQUEST_H_
Jan Jongboom 0:910f5949759f 20
Jan Jongboom 0:910f5949759f 21 #include <string>
Jan Jongboom 0:910f5949759f 22 #include <vector>
Jan Jongboom 0:910f5949759f 23 #include <map>
Jan Jongboom 0:910f5949759f 24 #include "http_parser.h"
Jan Jongboom 0:910f5949759f 25 #include "http_response.h"
Jan Jongboom 0:910f5949759f 26 #include "http_request_builder.h"
Jan Jongboom 15:ffc77f212382 27 #include "http_request_parser.h"
Jan Jongboom 0:910f5949759f 28 #include "http_parsed_url.h"
Jan Jongboom 11:96e4dcb9c0c2 29 #include "tls_socket.h"
Jan Jongboom 0:910f5949759f 30
Jan Jongboom 20:0e63d6a93c02 31 #ifndef HTTP_RECEIVE_BUFFER_SIZE
Jan Jongboom 20:0e63d6a93c02 32 #define HTTP_RECEIVE_BUFFER_SIZE 8 * 1024
Jan Jongboom 20:0e63d6a93c02 33 #endif
Jan Jongboom 20:0e63d6a93c02 34
Jan Jongboom 0:910f5949759f 35 /**
Jan Jongboom 0:910f5949759f 36 * \brief HttpsRequest implements the logic for interacting with HTTPS servers.
Jan Jongboom 0:910f5949759f 37 */
Jan Jongboom 0:910f5949759f 38 class HttpsRequest {
Jan Jongboom 0:910f5949759f 39 public:
Jan Jongboom 0:910f5949759f 40 /**
Jan Jongboom 0:910f5949759f 41 * HttpsRequest Constructor
Jan Jongboom 0:910f5949759f 42 * Initializes the TCP socket, sets up event handlers and flags.
Jan Jongboom 0:910f5949759f 43 *
Jan Jongboom 0:910f5949759f 44 * @param[in] net_iface The network interface
Jan Jongboom 0:910f5949759f 45 * @param[in] ssl_ca_pem String containing the trusted CAs
Jan Jongboom 0:910f5949759f 46 * @param[in] method HTTP method to use
Jan Jongboom 0:910f5949759f 47 * @param[in] url URL to the resource
Jan Jongboom 0:910f5949759f 48 * @param[in] body_callback Callback on which to retrieve chunks of the response body.
Jan Jongboom 0:910f5949759f 49 If not set, the complete body will be allocated on the HttpResponse object,
Jan Jongboom 0:910f5949759f 50 which might use lots of memory.
Jan Jongboom 0:910f5949759f 51 */
Jan Jongboom 0:910f5949759f 52 HttpsRequest(NetworkInterface* net_iface,
Jan Jongboom 0:910f5949759f 53 const char* ssl_ca_pem,
Jan Jongboom 0:910f5949759f 54 http_method method,
Jan Jongboom 0:910f5949759f 55 const char* url,
Jan Jongboom 0:910f5949759f 56 Callback<void(const char *at, size_t length)> body_callback = 0)
Jan Jongboom 0:910f5949759f 57 {
Jan Jongboom 0:910f5949759f 58 _parsed_url = new ParsedUrl(url);
Jan Jongboom 0:910f5949759f 59 _body_callback = body_callback;
Jan Jongboom 0:910f5949759f 60 _request_builder = new HttpRequestBuilder(method, _parsed_url);
Jan Jongboom 0:910f5949759f 61 _response = NULL;
Jan Jongboom 0:910f5949759f 62 _debug = false;
Jan Jongboom 0:910f5949759f 63
Jan Jongboom 11:96e4dcb9c0c2 64 _tlssocket = new TLSSocket(net_iface, _parsed_url->host(), _parsed_url->port(), ssl_ca_pem);
Jan Jongboom 11:96e4dcb9c0c2 65 _we_created_the_socket = true;
Jan Jongboom 11:96e4dcb9c0c2 66 }
Jan Jongboom 0:910f5949759f 67
Jan Jongboom 11:96e4dcb9c0c2 68 /**
Jan Jongboom 11:96e4dcb9c0c2 69 * HttpsRequest Constructor
Jan Jongboom 11:96e4dcb9c0c2 70 * Sets up event handlers and flags.
Jan Jongboom 11:96e4dcb9c0c2 71 *
Jan Jongboom 11:96e4dcb9c0c2 72 * @param[in] socket A connected TLSSocket
Jan Jongboom 11:96e4dcb9c0c2 73 * @param[in] method HTTP method to use
Jan Jongboom 11:96e4dcb9c0c2 74 * @param[in] url URL to the resource
Jan Jongboom 11:96e4dcb9c0c2 75 * @param[in] body_callback Callback on which to retrieve chunks of the response body.
Jan Jongboom 11:96e4dcb9c0c2 76 If not set, the complete body will be allocated on the HttpResponse object,
Jan Jongboom 11:96e4dcb9c0c2 77 which might use lots of memory.
Jan Jongboom 11:96e4dcb9c0c2 78 */
Jan Jongboom 11:96e4dcb9c0c2 79 HttpsRequest(TLSSocket* socket,
Jan Jongboom 11:96e4dcb9c0c2 80 http_method method,
Jan Jongboom 11:96e4dcb9c0c2 81 const char* url,
Jan Jongboom 11:96e4dcb9c0c2 82 Callback<void(const char *at, size_t length)> body_callback = 0)
Jan Jongboom 11:96e4dcb9c0c2 83 {
Jan Jongboom 11:96e4dcb9c0c2 84 _parsed_url = new ParsedUrl(url);
Jan Jongboom 11:96e4dcb9c0c2 85 _body_callback = body_callback;
Jan Jongboom 11:96e4dcb9c0c2 86 _request_builder = new HttpRequestBuilder(method, _parsed_url);
Jan Jongboom 11:96e4dcb9c0c2 87 _response = NULL;
Jan Jongboom 11:96e4dcb9c0c2 88 _debug = false;
Jan Jongboom 11:96e4dcb9c0c2 89
Jan Jongboom 11:96e4dcb9c0c2 90 _tlssocket = socket;
Jan Jongboom 11:96e4dcb9c0c2 91 _we_created_the_socket = false;
Jan Jongboom 0:910f5949759f 92 }
Jan Jongboom 0:910f5949759f 93
Jan Jongboom 0:910f5949759f 94 /**
Jan Jongboom 0:910f5949759f 95 * HttpsRequest Destructor
Jan Jongboom 0:910f5949759f 96 */
Jan Jongboom 0:910f5949759f 97 ~HttpsRequest() {
Jan Jongboom 0:910f5949759f 98 if (_request_builder) {
Jan Jongboom 0:910f5949759f 99 delete _request_builder;
Jan Jongboom 0:910f5949759f 100 }
Jan Jongboom 0:910f5949759f 101
Jan Jongboom 11:96e4dcb9c0c2 102 if (_tlssocket && _we_created_the_socket) {
Jan Jongboom 11:96e4dcb9c0c2 103 delete _tlssocket;
Jan Jongboom 0:910f5949759f 104 }
Jan Jongboom 0:910f5949759f 105
Jan Jongboom 0:910f5949759f 106 if (_parsed_url) {
Jan Jongboom 0:910f5949759f 107 delete _parsed_url;
Jan Jongboom 0:910f5949759f 108 }
Jan Jongboom 0:910f5949759f 109
Jan Jongboom 0:910f5949759f 110 if (_response) {
Jan Jongboom 0:910f5949759f 111 delete _response;
Jan Jongboom 0:910f5949759f 112 }
Jan Jongboom 0:910f5949759f 113 }
Jan Jongboom 0:910f5949759f 114
Jan Jongboom 0:910f5949759f 115 /**
Jan Jongboom 0:910f5949759f 116 * Execute the HTTPS request.
Jan Jongboom 0:910f5949759f 117 *
Jan Jongboom 0:910f5949759f 118 * @param[in] body Pointer to the request body
Jan Jongboom 0:910f5949759f 119 * @param[in] body_size Size of the request body
Jan Jongboom 0:910f5949759f 120 * @return An HttpResponse pointer on success, or NULL on failure.
Jan Jongboom 0:910f5949759f 121 * See get_error() for the error code.
Jan Jongboom 0:910f5949759f 122 */
Jan Jongboom 0:910f5949759f 123 HttpResponse* send(const void* body = NULL, nsapi_size_t body_size = 0) {
Jan Jongboom 11:96e4dcb9c0c2 124 // not tried to connect before?
Jan Jongboom 11:96e4dcb9c0c2 125 if (_tlssocket->error() != 0) {
Jan Jongboom 11:96e4dcb9c0c2 126 _error = _tlssocket->error();
Jan Jongboom 0:910f5949759f 127 return NULL;
Jan Jongboom 0:910f5949759f 128 }
Jan Jongboom 0:910f5949759f 129
Jan Jongboom 11:96e4dcb9c0c2 130 bool socket_was_open = _tlssocket->connected();
Jan Jongboom 0:910f5949759f 131
Jan Jongboom 11:96e4dcb9c0c2 132 if (!socket_was_open) {
Jan Jongboom 11:96e4dcb9c0c2 133 nsapi_error_t r = _tlssocket->connect();
Jan Jongboom 11:96e4dcb9c0c2 134 if (r != 0) {
Jan Jongboom 11:96e4dcb9c0c2 135 _error = r;
Jan Jongboom 11:96e4dcb9c0c2 136 return NULL;
Jan Jongboom 11:96e4dcb9c0c2 137 }
Jan Jongboom 0:910f5949759f 138 }
Jan Jongboom 0:910f5949759f 139
Jan Jongboom 11:96e4dcb9c0c2 140 int ret;
Jan Jongboom 0:910f5949759f 141
Jan Jongboom 10:b017c7d2cf23 142 size_t request_size = 0;
Jan Jongboom 10:b017c7d2cf23 143 char* request = _request_builder->build(body, body_size, request_size);
Jan Jongboom 0:910f5949759f 144
Jan Jongboom 11:96e4dcb9c0c2 145 ret = mbedtls_ssl_write(_tlssocket->get_ssl_context(), (const unsigned char *) request, request_size);
Jan Jongboom 0:910f5949759f 146
Jan Jongboom 0:910f5949759f 147 free(request);
Jan Jongboom 0:910f5949759f 148
Jan Jongboom 0:910f5949759f 149 if (ret < 0) {
Jan Jongboom 0:910f5949759f 150 if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
Jan Jongboom 0:910f5949759f 151 ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jan Jongboom 0:910f5949759f 152 print_mbedtls_error("mbedtls_ssl_write", ret);
Jan Jongboom 11:96e4dcb9c0c2 153 onError(_tlssocket->get_tcp_socket(), -1 );
Jan Jongboom 0:910f5949759f 154 }
Jan Jongboom 0:910f5949759f 155 else {
Jan Jongboom 0:910f5949759f 156 _error = ret;
Jan Jongboom 0:910f5949759f 157 }
Jan Jongboom 0:910f5949759f 158 return NULL;
Jan Jongboom 0:910f5949759f 159 }
Jan Jongboom 0:910f5949759f 160
Jan Jongboom 0:910f5949759f 161 // Create a response object
Jan Jongboom 0:910f5949759f 162 _response = new HttpResponse();
Jan Jongboom 0:910f5949759f 163 // And a response parser
Jan Jongboom 15:ffc77f212382 164 HttpParser parser(_response, HTTP_RESPONSE, _body_callback);
Jan Jongboom 0:910f5949759f 165
Jan Jongboom 0:910f5949759f 166 // Set up a receive buffer (on the heap)
Jan Jongboom 0:910f5949759f 167 uint8_t* recv_buffer = (uint8_t*)malloc(HTTP_RECEIVE_BUFFER_SIZE);
Jan Jongboom 0:910f5949759f 168
Jan Jongboom 0:910f5949759f 169 /* Read data out of the socket */
Jan Jongboom 11:96e4dcb9c0c2 170 while ((ret = mbedtls_ssl_read(_tlssocket->get_ssl_context(), (unsigned char *) recv_buffer, HTTP_RECEIVE_BUFFER_SIZE)) > 0) {
Jan Jongboom 0:910f5949759f 171 // Don't know if this is actually needed, but OK
Jan Jongboom 0:910f5949759f 172 size_t _bpos = static_cast<size_t>(ret);
Jan Jongboom 0:910f5949759f 173 recv_buffer[_bpos] = 0;
Jan Jongboom 0:910f5949759f 174
Jan Jongboom 0:910f5949759f 175 size_t nparsed = parser.execute((const char*)recv_buffer, _bpos);
Jan Jongboom 0:910f5949759f 176 if (nparsed != _bpos) {
Jan Jongboom 0:910f5949759f 177 print_mbedtls_error("parser_error", nparsed);
Jan Jongboom 0:910f5949759f 178 // parser error...
Jan Jongboom 0:910f5949759f 179 _error = -2101;
Jan Jongboom 0:910f5949759f 180 free(recv_buffer);
Jan Jongboom 0:910f5949759f 181 return NULL;
Jan Jongboom 0:910f5949759f 182 }
Jan Jongboom 6:112d72c60e07 183
Jan Jongboom 7:2e3eedb9ca5c 184 if (_response->is_message_complete()) {
Jan Jongboom 0:910f5949759f 185 break;
Jan Jongboom 0:910f5949759f 186 }
Jan Jongboom 0:910f5949759f 187 }
Jan Jongboom 0:910f5949759f 188 if (ret < 0) {
Jan Jongboom 0:910f5949759f 189 if (ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jan Jongboom 0:910f5949759f 190 print_mbedtls_error("mbedtls_ssl_read", ret);
Jan Jongboom 11:96e4dcb9c0c2 191 onError(_tlssocket->get_tcp_socket(), -1 );
Jan Jongboom 0:910f5949759f 192 }
Jan Jongboom 0:910f5949759f 193 else {
Jan Jongboom 0:910f5949759f 194 _error = ret;
Jan Jongboom 0:910f5949759f 195 }
Jan Jongboom 0:910f5949759f 196 free(recv_buffer);
Jan Jongboom 0:910f5949759f 197 return NULL;
Jan Jongboom 0:910f5949759f 198 }
Jan Jongboom 0:910f5949759f 199
Jan Jongboom 0:910f5949759f 200 parser.finish();
Jan Jongboom 0:910f5949759f 201
Jan Jongboom 11:96e4dcb9c0c2 202 if (!socket_was_open) {
Jan Jongboom 11:96e4dcb9c0c2 203 _tlssocket->get_tcp_socket()->close();
Jan Jongboom 11:96e4dcb9c0c2 204 }
Jan Jongboom 11:96e4dcb9c0c2 205
Jan Jongboom 0:910f5949759f 206 free(recv_buffer);
Jan Jongboom 0:910f5949759f 207
Jan Jongboom 0:910f5949759f 208 return _response;
Jan Jongboom 0:910f5949759f 209 }
Jan Jongboom 0:910f5949759f 210
Jan Jongboom 0:910f5949759f 211 /**
Jan Jongboom 11:96e4dcb9c0c2 212 * Closes the underlying TCP socket
Jan Jongboom 0:910f5949759f 213 */
Jan Jongboom 0:910f5949759f 214 void close() {
Jan Jongboom 11:96e4dcb9c0c2 215 _tlssocket->get_tcp_socket()->close();
Jan Jongboom 0:910f5949759f 216 }
Jan Jongboom 0:910f5949759f 217
Jan Jongboom 0:910f5949759f 218 /**
Jan Jongboom 0:910f5949759f 219 * Set a header for the request.
Jan Jongboom 0:910f5949759f 220 *
Jan Jongboom 0:910f5949759f 221 * The 'Host' and 'Content-Length' headers are set automatically.
Jan Jongboom 0:910f5949759f 222 * Setting the same header twice will overwrite the previous entry.
Jan Jongboom 0:910f5949759f 223 *
Jan Jongboom 0:910f5949759f 224 * @param[in] key Header key
Jan Jongboom 0:910f5949759f 225 * @param[in] value Header value
Jan Jongboom 0:910f5949759f 226 */
Jan Jongboom 0:910f5949759f 227 void set_header(string key, string value) {
Jan Jongboom 0:910f5949759f 228 _request_builder->set_header(key, value);
Jan Jongboom 0:910f5949759f 229 }
Jan Jongboom 0:910f5949759f 230
Jan Jongboom 0:910f5949759f 231 /**
Jan Jongboom 0:910f5949759f 232 * Get the error code.
Jan Jongboom 0:910f5949759f 233 *
Jan Jongboom 0:910f5949759f 234 * When send() fails, this error is set.
Jan Jongboom 0:910f5949759f 235 */
Jan Jongboom 0:910f5949759f 236 nsapi_error_t get_error() {
Jan Jongboom 0:910f5949759f 237 return _error;
Jan Jongboom 0:910f5949759f 238 }
Jan Jongboom 0:910f5949759f 239
Jan Jongboom 0:910f5949759f 240 /**
Jan Jongboom 0:910f5949759f 241 * Set the debug flag.
Jan Jongboom 0:910f5949759f 242 *
Jan Jongboom 0:910f5949759f 243 * If this flag is set, debug information from mbed TLS will be logged to stdout.
Jan Jongboom 0:910f5949759f 244 */
Jan Jongboom 0:910f5949759f 245 void set_debug(bool debug) {
Jan Jongboom 0:910f5949759f 246 _debug = debug;
Jan Jongboom 11:96e4dcb9c0c2 247
Jan Jongboom 11:96e4dcb9c0c2 248 _tlssocket->set_debug(debug);
Jan Jongboom 0:910f5949759f 249 }
Jan Jongboom 0:910f5949759f 250
Jan Jongboom 11:96e4dcb9c0c2 251
Jan Jongboom 0:910f5949759f 252 protected:
Jan Jongboom 0:910f5949759f 253 /**
Jan Jongboom 0:910f5949759f 254 * Helper for pretty-printing mbed TLS error codes
Jan Jongboom 0:910f5949759f 255 */
Jan Jongboom 0:910f5949759f 256 static void print_mbedtls_error(const char *name, int err) {
Jan Jongboom 0:910f5949759f 257 char buf[128];
Jan Jongboom 0:910f5949759f 258 mbedtls_strerror(err, buf, sizeof (buf));
Jan Jongboom 0:910f5949759f 259 mbedtls_printf("%s() failed: -0x%04x (%d): %s\r\n", name, -err, err, buf);
Jan Jongboom 0:910f5949759f 260 }
Jan Jongboom 0:910f5949759f 261
Jan Jongboom 0:910f5949759f 262 void onError(TCPSocket *s, int error) {
Jan Jongboom 0:910f5949759f 263 s->close();
Jan Jongboom 0:910f5949759f 264 _error = error;
Jan Jongboom 0:910f5949759f 265 }
Jan Jongboom 0:910f5949759f 266
Jan Jongboom 0:910f5949759f 267 protected:
Jan Jongboom 11:96e4dcb9c0c2 268 TLSSocket* _tlssocket;
Jan Jongboom 11:96e4dcb9c0c2 269 bool _we_created_the_socket;
Jan Jongboom 0:910f5949759f 270
Jan Jongboom 0:910f5949759f 271 Callback<void(const char *at, size_t length)> _body_callback;
Jan Jongboom 0:910f5949759f 272 ParsedUrl* _parsed_url;
Jan Jongboom 0:910f5949759f 273 HttpRequestBuilder* _request_builder;
Jan Jongboom 0:910f5949759f 274 HttpResponse* _response;
Jan Jongboom 0:910f5949759f 275
Jan Jongboom 0:910f5949759f 276 nsapi_error_t _error;
Jan Jongboom 0:910f5949759f 277 bool _debug;
Jan Jongboom 0:910f5949759f 278
Jan Jongboom 0:910f5949759f 279 };
Jan Jongboom 0:910f5949759f 280
Jan Jongboom 0:910f5949759f 281 #endif // _MBED_HTTPS_REQUEST_H_