Intention is to partition the demo into multiple files, so that the main program is quite easy to follow. 1. connectlib.c: For any URL parsing and TCP connection related stuff 2. sh2lib.c: Convenience functions for HTTP2+TLS. The goal here is to expose a simpler API than nghttp2. If most usecases end up being served with this library, it could potentially be moved into a separate component
418 lines
14 KiB
C
418 lines
14 KiB
C
// Copyright 2017 Espressif Systems (Shanghai) PTE LTD
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
#include <stdlib.h>
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
#include <unistd.h>
|
|
#include <fcntl.h>
|
|
#include <ctype.h>
|
|
#include <netdb.h>
|
|
#include <esp_log.h>
|
|
|
|
#include "connectlib.h"
|
|
#include "sh2lib.h"
|
|
|
|
static const char *TAG = "sh2lib";
|
|
|
|
#define DBG_FRAME_SEND 1
|
|
|
|
/* SSL connection on the TCP socket that is already connected */
|
|
static int do_ssl_connect(struct sh2lib_handle *hd, int sockfd, const char *hostname)
|
|
{
|
|
SSL_CTX *ssl_ctx = SSL_CTX_new(TLSv1_2_client_method());
|
|
if (!ssl_ctx) {
|
|
return -1;
|
|
}
|
|
|
|
unsigned char vector[] = "\x02h2";
|
|
SSL_CTX_set_alpn_protos(ssl_ctx, vector, strlen((char *)vector));
|
|
SSL *ssl = SSL_new(ssl_ctx);
|
|
if (!ssl) {
|
|
SSL_CTX_free(ssl_ctx);
|
|
return -1;
|
|
}
|
|
|
|
SSL_set_tlsext_host_name(ssl, hostname);
|
|
SSL_set_fd(ssl, sockfd);
|
|
int ret = SSL_connect(ssl);
|
|
if (ret < 1) {
|
|
int err = SSL_get_error(ssl, ret);
|
|
ESP_LOGE(TAG, "[ssl-connect] Failed SSL handshake ret=%d error=%d", ret, err);
|
|
SSL_CTX_free(ssl_ctx);
|
|
SSL_free(ssl);
|
|
return -1;
|
|
}
|
|
hd->ssl_ctx = ssl_ctx;
|
|
hd->ssl = ssl;
|
|
hd->sockfd = sockfd;
|
|
|
|
int flags = fcntl(hd->sockfd, F_GETFL, 0);
|
|
fcntl(hd->sockfd, F_SETFL, flags | O_NONBLOCK);
|
|
|
|
return 0;
|
|
}
|
|
|
|
/*
|
|
* The implementation of nghttp2_send_callback type. Here we write
|
|
* |data| with size |length| to the network and return the number of
|
|
* bytes actually written. See the documentation of
|
|
* nghttp2_send_callback for the details.
|
|
*/
|
|
static ssize_t callback_send_inner(struct sh2lib_handle *hd, const uint8_t *data,
|
|
size_t length)
|
|
{
|
|
int rv = SSL_write(hd->ssl, data, (int)length);
|
|
if (rv <= 0) {
|
|
int err = SSL_get_error(hd->ssl, rv);
|
|
if (err == SSL_ERROR_WANT_WRITE || err == SSL_ERROR_WANT_READ) {
|
|
rv = NGHTTP2_ERR_WOULDBLOCK;
|
|
} else {
|
|
rv = NGHTTP2_ERR_CALLBACK_FAILURE;
|
|
}
|
|
}
|
|
return rv;
|
|
}
|
|
|
|
static ssize_t callback_send(nghttp2_session *session, const uint8_t *data,
|
|
size_t length, int flags, void *user_data)
|
|
{
|
|
int rv = 0;
|
|
struct sh2lib_handle *hd = user_data;
|
|
|
|
int copy_offset = 0;
|
|
int pending_data = length;
|
|
|
|
/* Send data in 1000 byte chunks */
|
|
while (copy_offset != (length - 1)) {
|
|
int chunk_len = pending_data > 1000 ? 1000 : pending_data;
|
|
int subrv = callback_send_inner(hd, data + copy_offset, chunk_len);
|
|
if (subrv <= 0) {
|
|
if (copy_offset) {
|
|
/* If some data was xferred, send the number of bytes
|
|
* xferred */
|
|
rv = copy_offset;
|
|
} else {
|
|
/* If not, send the error code */
|
|
rv = subrv;
|
|
}
|
|
break;
|
|
}
|
|
copy_offset += chunk_len;
|
|
pending_data -= chunk_len;
|
|
}
|
|
return rv;
|
|
}
|
|
|
|
/*
|
|
* The implementation of nghttp2_recv_callback type. Here we read data
|
|
* from the network and write them in |buf|. The capacity of |buf| is
|
|
* |length| bytes. Returns the number of bytes stored in |buf|. See
|
|
* the documentation of nghttp2_recv_callback for the details.
|
|
*/
|
|
static ssize_t callback_recv(nghttp2_session *session, uint8_t *buf,
|
|
size_t length, int flags, void *user_data)
|
|
{
|
|
struct sh2lib_handle *hd = user_data;
|
|
int rv;
|
|
rv = SSL_read(hd->ssl, buf, (int)length);
|
|
if (rv < 0) {
|
|
int err = SSL_get_error(hd->ssl, rv);
|
|
if (err == SSL_ERROR_WANT_WRITE || err == SSL_ERROR_WANT_READ) {
|
|
rv = NGHTTP2_ERR_WOULDBLOCK;
|
|
} else {
|
|
rv = NGHTTP2_ERR_CALLBACK_FAILURE;
|
|
}
|
|
} else if (rv == 0) {
|
|
rv = NGHTTP2_ERR_EOF;
|
|
}
|
|
return rv;
|
|
}
|
|
|
|
char *sh2lib_frame_type_str(int type)
|
|
{
|
|
switch (type) {
|
|
case NGHTTP2_HEADERS:
|
|
return "HEADERS";
|
|
break;
|
|
case NGHTTP2_RST_STREAM:
|
|
return "RST_STREAM";
|
|
break;
|
|
case NGHTTP2_GOAWAY:
|
|
return "GOAWAY";
|
|
break;
|
|
case NGHTTP2_DATA:
|
|
return "DATA";
|
|
break;
|
|
case NGHTTP2_SETTINGS:
|
|
return "SETTINGS";
|
|
break;
|
|
case NGHTTP2_PUSH_PROMISE:
|
|
return "PUSH_PROMISE";
|
|
break;
|
|
case NGHTTP2_PING:
|
|
return "PING";
|
|
break;
|
|
default:
|
|
return "other";
|
|
break;
|
|
}
|
|
}
|
|
|
|
static int callback_on_frame_send(nghttp2_session *session,
|
|
const nghttp2_frame *frame, void *user_data)
|
|
{
|
|
ESP_LOGD(TAG, "[frame-send] frame type %s", sh2lib_frame_type_str(frame->hd.type));
|
|
switch (frame->hd.type) {
|
|
case NGHTTP2_HEADERS:
|
|
if (nghttp2_session_get_stream_user_data(session, frame->hd.stream_id)) {
|
|
ESP_LOGD(TAG, "[frame-send] C ----------------------------> S (HEADERS)");
|
|
#if DBG_FRAME_SEND
|
|
ESP_LOGD(TAG, "[frame-send] headers nv-len = %d", frame->headers.nvlen);
|
|
const nghttp2_nv *nva = frame->headers.nva;
|
|
size_t i;
|
|
for (i = 0; i < frame->headers.nvlen; ++i) {
|
|
ESP_LOGD(TAG, "[frame-send] %s : %s", nva[i].name, nva[i].value);
|
|
}
|
|
#endif
|
|
}
|
|
break;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
static int callback_on_frame_recv(nghttp2_session *session,
|
|
const nghttp2_frame *frame, void *user_data)
|
|
{
|
|
ESP_LOGD(TAG, "[frame-recv][sid: %d] frame type %s", frame->hd.stream_id, sh2lib_frame_type_str(frame->hd.type));
|
|
if (frame->hd.type != NGHTTP2_DATA) {
|
|
return 0;
|
|
}
|
|
/* Subsequent processing only for data frame */
|
|
sh2lib_frame_data_recv_cb_t data_recv_cb = nghttp2_session_get_stream_user_data(session, frame->hd.stream_id);
|
|
if (data_recv_cb) {
|
|
struct sh2lib_handle *h2 = user_data;
|
|
(*data_recv_cb)(h2, NULL, 0, DATA_RECV_FRAME_COMPLETE);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
static int callback_on_stream_close(nghttp2_session *session, int32_t stream_id,
|
|
uint32_t error_code, void *user_data)
|
|
{
|
|
|
|
ESP_LOGD(TAG, "[stream-close][sid %d]", stream_id);
|
|
sh2lib_frame_data_recv_cb_t data_recv_cb = nghttp2_session_get_stream_user_data(session, stream_id);
|
|
if (data_recv_cb) {
|
|
struct sh2lib_handle *h2 = user_data;
|
|
(*data_recv_cb)(h2, NULL, 0, DATA_RECV_RST_STREAM);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
static int callback_on_data_chunk_recv(nghttp2_session *session, uint8_t flags,
|
|
int32_t stream_id, const uint8_t *data,
|
|
size_t len, void *user_data)
|
|
{
|
|
sh2lib_frame_data_recv_cb_t data_recv_cb;
|
|
ESP_LOGD(TAG, "[data-chunk][sid:%d]", stream_id);
|
|
data_recv_cb = nghttp2_session_get_stream_user_data(session, stream_id);
|
|
if (data_recv_cb) {
|
|
ESP_LOGD(TAG, "[data-chunk] C <---------------------------- S (DATA chunk)"
|
|
"%lu bytes",
|
|
(unsigned long int)len);
|
|
struct sh2lib_handle *h2 = user_data;
|
|
(*data_recv_cb)(h2, (char *)data, len, 0);
|
|
/* TODO: What to do with the return value: look for pause/abort */
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
static int callback_on_header(nghttp2_session *session, const nghttp2_frame *frame,
|
|
const uint8_t *name, size_t namelen, const uint8_t *value,
|
|
size_t valuelen, uint8_t flags, void *user_data)
|
|
{
|
|
ESP_LOGD(TAG, "[hdr-recv][sid:%d] %s : %s", frame->hd.stream_id, name, value);
|
|
return 0;
|
|
}
|
|
|
|
static int do_http2_connect(struct sh2lib_handle *hd)
|
|
{
|
|
int ret;
|
|
nghttp2_session_callbacks *callbacks;
|
|
nghttp2_session_callbacks_new(&callbacks);
|
|
nghttp2_session_callbacks_set_send_callback(callbacks, callback_send);
|
|
nghttp2_session_callbacks_set_recv_callback(callbacks, callback_recv);
|
|
nghttp2_session_callbacks_set_on_frame_send_callback(callbacks, callback_on_frame_send);
|
|
nghttp2_session_callbacks_set_on_frame_recv_callback(callbacks, callback_on_frame_recv);
|
|
nghttp2_session_callbacks_set_on_stream_close_callback(callbacks, callback_on_stream_close);
|
|
nghttp2_session_callbacks_set_on_data_chunk_recv_callback(callbacks, callback_on_data_chunk_recv);
|
|
nghttp2_session_callbacks_set_on_header_callback(callbacks, callback_on_header);
|
|
ret = nghttp2_session_client_new(&hd->http2_sess, callbacks, hd);
|
|
if (ret != 0) {
|
|
ESP_LOGE(TAG, "[sh2-connect] New http2 session failed");
|
|
nghttp2_session_callbacks_del(callbacks);
|
|
return -1;
|
|
}
|
|
nghttp2_session_callbacks_del(callbacks);
|
|
|
|
/* Create the SETTINGS frame */
|
|
ret = nghttp2_submit_settings(hd->http2_sess, NGHTTP2_FLAG_NONE, NULL, 0);
|
|
if (ret != 0) {
|
|
ESP_LOGE(TAG, "[sh2-connect] Submit settings failed");
|
|
return -1;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
int sh2lib_connect(struct sh2lib_handle *hd, const char *uri)
|
|
{
|
|
memset(hd, 0, sizeof(*hd));
|
|
|
|
struct uri res;
|
|
/* Parse the URI */
|
|
if (parse_uri(&res, uri) != 0) {
|
|
ESP_LOGE(TAG, "[sh2-connect] Failed to parse URI");
|
|
return -1;
|
|
}
|
|
|
|
/* TCP connection with the server */
|
|
int sockfd = connect_to_host(res.host, res.hostlen, res.port);
|
|
if (sockfd < 0) {
|
|
ESP_LOGE(TAG, "[sh2-connect] Failed to connect to %s", uri);
|
|
return -1;
|
|
}
|
|
|
|
/* SSL Connection on the socket */
|
|
if (do_ssl_connect(hd, sockfd, res.host) != 0) {
|
|
ESP_LOGE(TAG, "[sh2-connect] SSL Handshake failed with %s", uri);
|
|
goto error;
|
|
}
|
|
|
|
/* HTTP/2 Connection */
|
|
if (do_http2_connect(hd) != 0) {
|
|
ESP_LOGE(TAG, "[sh2-connect] HTTP2 Connection failed with %s", uri);
|
|
goto error;
|
|
}
|
|
|
|
return 0;
|
|
error:
|
|
sh2lib_free(hd);
|
|
return -1;
|
|
}
|
|
|
|
void sh2lib_free(struct sh2lib_handle *hd)
|
|
{
|
|
if (hd->http2_sess) {
|
|
nghttp2_session_del(hd->http2_sess);
|
|
hd->http2_sess = NULL;
|
|
}
|
|
if (hd->ssl) {
|
|
SSL_free(hd->ssl);
|
|
hd->ssl = NULL;
|
|
}
|
|
if (hd->ssl_ctx) {
|
|
SSL_CTX_free(hd->ssl_ctx);
|
|
hd->ssl_ctx = NULL;
|
|
}
|
|
if (hd->sockfd) {
|
|
close(hd->sockfd);
|
|
hd->ssl_ctx = 0;
|
|
}
|
|
}
|
|
|
|
int sh2lib_execute(struct sh2lib_handle *hd)
|
|
{
|
|
int ret;
|
|
ret = nghttp2_session_send(hd->http2_sess);
|
|
if (ret != 0) {
|
|
ESP_LOGE(TAG, "[sh2-execute] HTTP2 session send failed %d", ret);
|
|
return -1;
|
|
}
|
|
ret = nghttp2_session_recv(hd->http2_sess);
|
|
if (ret != 0) {
|
|
ESP_LOGE(TAG, "[sh2-execute] HTTP2 session recv failed %d", ret);
|
|
return -1;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
int sh2lib_do_get_with_nv(struct sh2lib_handle *hd, const nghttp2_nv *nva, size_t nvlen, sh2lib_frame_data_recv_cb_t recv_cb)
|
|
{
|
|
int ret = nghttp2_submit_request(hd->http2_sess, NULL, nva, nvlen, NULL, recv_cb);
|
|
if (ret < 0) {
|
|
ESP_LOGE(TAG, "[sh2-do-get] HEADERS call failed");
|
|
return -1;
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
int sh2lib_do_get(struct sh2lib_handle *hd, const char *path, sh2lib_frame_data_recv_cb_t recv_cb)
|
|
{
|
|
#define HTTP2_PATH_NV ":path"
|
|
const nghttp2_nv nva[] = { SH2LIB_MAKE_NV(":method", "GET"),
|
|
SH2LIB_MAKE_NV(":scheme", "https"),
|
|
{(uint8_t *)HTTP2_PATH_NV, (uint8_t *)path, strlen(HTTP2_PATH_NV), strlen(path), NGHTTP2_NV_FLAG_NONE},
|
|
};
|
|
return sh2lib_do_get_with_nv(hd, nva, sizeof(nva) / sizeof(nva[0]), recv_cb);
|
|
}
|
|
|
|
ssize_t sh2lib_data_provider_cb(nghttp2_session *session, int32_t stream_id, uint8_t *buf,
|
|
size_t length, uint32_t *data_flags,
|
|
nghttp2_data_source *source, void *user_data)
|
|
{
|
|
struct sh2lib_handle *h2 = user_data;
|
|
sh2lib_putpost_data_cb_t data_cb = source->ptr;
|
|
return (*data_cb)(h2, (char *)buf, length, data_flags);
|
|
}
|
|
|
|
int sh2lib_do_putpost_with_nv(struct sh2lib_handle *hd, const nghttp2_nv *nva, size_t nvlen,
|
|
sh2lib_putpost_data_cb_t send_cb,
|
|
sh2lib_frame_data_recv_cb_t recv_cb)
|
|
{
|
|
|
|
nghttp2_data_provider sh2lib_data_provider;
|
|
sh2lib_data_provider.read_callback = sh2lib_data_provider_cb;
|
|
sh2lib_data_provider.source.ptr = send_cb;
|
|
int ret = nghttp2_submit_request(hd->http2_sess, NULL, nva, nvlen, &sh2lib_data_provider, recv_cb);
|
|
if (ret < 0) {
|
|
ESP_LOGE(TAG, "[sh2-do-putpost] HEADERS call failed");
|
|
return -1;
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
int sh2lib_do_post(struct sh2lib_handle *hd, const char *path,
|
|
sh2lib_putpost_data_cb_t send_cb,
|
|
sh2lib_frame_data_recv_cb_t recv_cb)
|
|
{
|
|
const nghttp2_nv nva[] = { SH2LIB_MAKE_NV(":method", "POST"),
|
|
SH2LIB_MAKE_NV(":scheme", "https"),
|
|
SH2LIB_MAKE_NV(":path", path),
|
|
};
|
|
return sh2lib_do_putpost_with_nv(hd, nva, sizeof(nva) / sizeof(nva[0]), send_cb, recv_cb);
|
|
}
|
|
|
|
int sh2lib_do_put(struct sh2lib_handle *hd, const char *path,
|
|
sh2lib_putpost_data_cb_t send_cb,
|
|
sh2lib_frame_data_recv_cb_t recv_cb)
|
|
{
|
|
const nghttp2_nv nva[] = { SH2LIB_MAKE_NV(":method", "PUT"),
|
|
SH2LIB_MAKE_NV(":scheme", "https"),
|
|
SH2LIB_MAKE_NV(":path", path),
|
|
};
|
|
return sh2lib_do_putpost_with_nv(hd, nva, sizeof(nva) / sizeof(nva[0]), send_cb, recv_cb);
|
|
}
|
|
|