Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/netsocket/TLSSocket.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 /** @file TLSSocket.h TLSSocket */
kenjiArai 0:5b88d5760320 2 /*
kenjiArai 0:5b88d5760320 3 * Copyright (c) 2018 ARM Limited
kenjiArai 0:5b88d5760320 4 * SPDX-License-Identifier: Apache-2.0
kenjiArai 0:5b88d5760320 5 *
kenjiArai 0:5b88d5760320 6 * Licensed under the Apache License, Version 2.0 (the "License");
kenjiArai 0:5b88d5760320 7 * you may not use this file except in compliance with the License.
kenjiArai 0:5b88d5760320 8 * You may obtain a copy of the License at
kenjiArai 0:5b88d5760320 9 *
kenjiArai 0:5b88d5760320 10 * http://www.apache.org/licenses/LICENSE-2.0
kenjiArai 0:5b88d5760320 11 *
kenjiArai 0:5b88d5760320 12 * Unless required by applicable law or agreed to in writing, software
kenjiArai 0:5b88d5760320 13 * distributed under the License is distributed on an "AS IS" BASIS,
kenjiArai 0:5b88d5760320 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kenjiArai 0:5b88d5760320 15 * See the License for the specific language governing permissions and
kenjiArai 0:5b88d5760320 16 * limitations under the License.
kenjiArai 0:5b88d5760320 17 */
kenjiArai 0:5b88d5760320 18 /** @addtogroup netsocket
kenjiArai 0:5b88d5760320 19 * @{
kenjiArai 0:5b88d5760320 20 */
kenjiArai 0:5b88d5760320 21
kenjiArai 0:5b88d5760320 22 #ifndef _MBED_HTTPS_TLS_TCP_SOCKET_H_
kenjiArai 0:5b88d5760320 23 #define _MBED_HTTPS_TLS_TCP_SOCKET_H_
kenjiArai 0:5b88d5760320 24
kenjiArai 0:5b88d5760320 25 #include "netsocket/TCPSocket.h"
kenjiArai 0:5b88d5760320 26
kenjiArai 0:5b88d5760320 27 #include "mbedtls/platform.h"
kenjiArai 0:5b88d5760320 28 #include "mbedtls/ssl.h"
kenjiArai 0:5b88d5760320 29 #include "mbedtls/entropy.h"
kenjiArai 0:5b88d5760320 30 #include "mbedtls/ctr_drbg.h"
kenjiArai 0:5b88d5760320 31 #include "mbedtls/error.h"
kenjiArai 0:5b88d5760320 32
kenjiArai 1:9db0e321a9f4 33 #if !defined(MBED_CONF_NSAPI_OFFLOAD_TLSSOCKET) || !(MBED_CONF_NSAPI_OFFLOAD_TLSSOCKET)
kenjiArai 1:9db0e321a9f4 34
kenjiArai 0:5b88d5760320 35 // This class requires Mbed TLS SSL/TLS client code
kenjiArai 0:5b88d5760320 36 #if defined(MBEDTLS_SSL_CLI_C) || defined(DOXYGEN_ONLY)
kenjiArai 0:5b88d5760320 37
kenjiArai 1:9db0e321a9f4 38 #include "TLSSocketWrapper.h"
kenjiArai 1:9db0e321a9f4 39
kenjiArai 0:5b88d5760320 40 /**
kenjiArai 0:5b88d5760320 41 * \brief TLSSocket is a wrapper around TCPSocket for interacting with TLS servers.
kenjiArai 0:5b88d5760320 42 *
kenjiArai 0:5b88d5760320 43 * TLSSocket uses the TLSSocketWrapper with internal TCP socket.
kenjiArai 0:5b88d5760320 44 * This is a helper for creating commonly used TLS connections over TCP.
kenjiArai 0:5b88d5760320 45 *
kenjiArai 0:5b88d5760320 46 */
kenjiArai 0:5b88d5760320 47 class TLSSocket : public TLSSocketWrapper {
kenjiArai 0:5b88d5760320 48 public:
kenjiArai 0:5b88d5760320 49 /** Create an uninitialized socket.
kenjiArai 0:5b88d5760320 50 *
kenjiArai 0:5b88d5760320 51 * Must call open to initialize the socket on a network stack.
kenjiArai 0:5b88d5760320 52 */
kenjiArai 0:5b88d5760320 53 TLSSocket() : TLSSocketWrapper(&tcp_socket) {}
kenjiArai 0:5b88d5760320 54
kenjiArai 0:5b88d5760320 55 /** Destroy the TLSSocket and closes the transport.
kenjiArai 0:5b88d5760320 56 */
kenjiArai 0:5b88d5760320 57 virtual ~TLSSocket();
kenjiArai 0:5b88d5760320 58
kenjiArai 0:5b88d5760320 59 /** Opens a socket.
kenjiArai 0:5b88d5760320 60 *
kenjiArai 0:5b88d5760320 61 * Creates a network socket on the network stack of the given
kenjiArai 0:5b88d5760320 62 * network interface.
kenjiArai 0:5b88d5760320 63 *
kenjiArai 0:5b88d5760320 64 * @note TLSSocket cannot be reopened after closing. It should be destructed to
kenjiArai 0:5b88d5760320 65 * clear internal TLS memory structures.
kenjiArai 0:5b88d5760320 66 *
kenjiArai 0:5b88d5760320 67 * @param stack Network stack as target for socket.
kenjiArai 1:9db0e321a9f4 68 * @return NSAPI_ERROR_OK on success. See @ref TCPSocket::open
kenjiArai 0:5b88d5760320 69 */
kenjiArai 0:5b88d5760320 70 virtual nsapi_error_t open(NetworkStack *stack)
kenjiArai 0:5b88d5760320 71 {
kenjiArai 0:5b88d5760320 72 return tcp_socket.open(stack);
kenjiArai 0:5b88d5760320 73 }
kenjiArai 0:5b88d5760320 74
kenjiArai 0:5b88d5760320 75 template <typename S>
kenjiArai 0:5b88d5760320 76 nsapi_error_t open(S *stack)
kenjiArai 0:5b88d5760320 77 {
kenjiArai 0:5b88d5760320 78 return open(nsapi_create_stack(stack));
kenjiArai 0:5b88d5760320 79 }
kenjiArai 0:5b88d5760320 80
kenjiArai 0:5b88d5760320 81 using TLSSocketWrapper::connect;
kenjiArai 0:5b88d5760320 82
kenjiArai 0:5b88d5760320 83 /** Connects TCP socket to a remote host.
kenjiArai 0:5b88d5760320 84 *
kenjiArai 0:5b88d5760320 85 * Initiates a connection to a remote server specified by either
kenjiArai 0:5b88d5760320 86 * a domain name or an IP address and port.
kenjiArai 0:5b88d5760320 87 *
kenjiArai 0:5b88d5760320 88 * @note: In case connect() returns NSAPI_ERROR_AUTH_FAILURE,
kenjiArai 0:5b88d5760320 89 * the socket must be freed either by calling close() or destroying it.
kenjiArai 0:5b88d5760320 90 *
kenjiArai 0:5b88d5760320 91 * @param host Hostname of the remote host.
kenjiArai 0:5b88d5760320 92 * @param port Port of the remote host.
kenjiArai 1:9db0e321a9f4 93 * @return NSAPI_ERROR_OK on success, negative error code on failure.
kenjiArai 1:9db0e321a9f4 94 * See @ref TLSSocketWrapper::connect.
kenjiArai 0:5b88d5760320 95 */
kenjiArai 1:9db0e321a9f4 96 MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
kenjiArai 0:5b88d5760320 97 nsapi_error_t connect(const char *host, uint16_t port);
kenjiArai 0:5b88d5760320 98
kenjiArai 0:5b88d5760320 99 private:
kenjiArai 0:5b88d5760320 100 TCPSocket tcp_socket;
kenjiArai 0:5b88d5760320 101 };
kenjiArai 1:9db0e321a9f4 102 #endif // MBEDTLS_SSL_CLI_C
kenjiArai 0:5b88d5760320 103
kenjiArai 1:9db0e321a9f4 104 #else // MBED_CONF_NSAPI_OFFLOAD_TLSSOCKET
kenjiArai 1:9db0e321a9f4 105
kenjiArai 1:9db0e321a9f4 106 class TLSSocket : public TCPSocket {
kenjiArai 1:9db0e321a9f4 107 public:
kenjiArai 1:9db0e321a9f4 108 TLSSocket();
kenjiArai 1:9db0e321a9f4 109 virtual ~TLSSocket();
kenjiArai 1:9db0e321a9f4 110
kenjiArai 1:9db0e321a9f4 111 /** Set hostname.
kenjiArai 1:9db0e321a9f4 112 *
kenjiArai 1:9db0e321a9f4 113 * TLSSocket requires hostname used to verify the certificate.
kenjiArai 1:9db0e321a9f4 114 * If hostname is not given in constructor, this function must be used before
kenjiArai 1:9db0e321a9f4 115 * starting the TLS handshake.
kenjiArai 1:9db0e321a9f4 116 *
kenjiArai 1:9db0e321a9f4 117 * @param hostname Hostname of the remote host, used for certificate checking.
kenjiArai 1:9db0e321a9f4 118 */
kenjiArai 1:9db0e321a9f4 119 nsapi_error_t set_hostname(const char *hostname);
kenjiArai 1:9db0e321a9f4 120
kenjiArai 1:9db0e321a9f4 121 /** Sets the certification of Root CA.
kenjiArai 1:9db0e321a9f4 122 *
kenjiArai 1:9db0e321a9f4 123 * @note Must be called after open() before calling connect()
kenjiArai 1:9db0e321a9f4 124 *
kenjiArai 1:9db0e321a9f4 125 * @param root_ca Root CA Certificate in any Mbed TLS-supported format.
kenjiArai 1:9db0e321a9f4 126 * @param len Length of certificate (including terminating 0 for PEM).
kenjiArai 1:9db0e321a9f4 127 * @return NSAPI_ERROR_OK on success, negative error code on failure.
kenjiArai 1:9db0e321a9f4 128 */
kenjiArai 1:9db0e321a9f4 129 virtual nsapi_error_t set_root_ca_cert(const void *root_ca, size_t len);
kenjiArai 1:9db0e321a9f4 130
kenjiArai 1:9db0e321a9f4 131 /** Sets the certification of Root CA.
kenjiArai 1:9db0e321a9f4 132 *
kenjiArai 1:9db0e321a9f4 133 * @note Must be called after open() before calling connect()
kenjiArai 1:9db0e321a9f4 134 *
kenjiArai 1:9db0e321a9f4 135 * @param root_ca_pem Root CA Certificate in PEM format.
kenjiArai 1:9db0e321a9f4 136 */
kenjiArai 1:9db0e321a9f4 137 virtual nsapi_error_t set_root_ca_cert(const char *root_ca_pem);
kenjiArai 1:9db0e321a9f4 138
kenjiArai 1:9db0e321a9f4 139
kenjiArai 1:9db0e321a9f4 140 /** Sets client certificate, and client private key.
kenjiArai 1:9db0e321a9f4 141 *
kenjiArai 1:9db0e321a9f4 142 * @param client_cert Client certification in PEM or DER format.
kenjiArai 1:9db0e321a9f4 143 * @param client_cert_len Certificate size including the terminating null byte for PEM data.
kenjiArai 1:9db0e321a9f4 144 * @param client_private_key_pem Client private key in PEM or DER format.
kenjiArai 1:9db0e321a9f4 145 * @param client_private_key_len Key size including the terminating null byte for PEM data
kenjiArai 1:9db0e321a9f4 146 * @return NSAPI_ERROR_OK on success, negative error code on failure.
kenjiArai 1:9db0e321a9f4 147 */
kenjiArai 1:9db0e321a9f4 148 virtual nsapi_error_t set_client_cert_key(const void *client_cert, size_t client_cert_len,
kenjiArai 1:9db0e321a9f4 149 const void *client_private_key_pem, size_t client_private_key_len);
kenjiArai 1:9db0e321a9f4 150
kenjiArai 1:9db0e321a9f4 151 /** Sets client certificate, and client private key.
kenjiArai 1:9db0e321a9f4 152 *
kenjiArai 1:9db0e321a9f4 153 * @param client_cert_pem Client certification in PEM format.
kenjiArai 1:9db0e321a9f4 154 * @param client_private_key_pem Client private key in PEM format.
kenjiArai 1:9db0e321a9f4 155 * @return NSAPI_ERROR_OK on success, negative error code on failure.
kenjiArai 1:9db0e321a9f4 156 */
kenjiArai 1:9db0e321a9f4 157 virtual nsapi_error_t set_client_cert_key(const char *client_cert_pem, const char *client_private_key_pem);
kenjiArai 1:9db0e321a9f4 158
kenjiArai 1:9db0e321a9f4 159 // From TCPSocket
kenjiArai 1:9db0e321a9f4 160 virtual nsapi_error_t connect(const char *host, uint16_t port);
kenjiArai 1:9db0e321a9f4 161 virtual nsapi_error_t connect(const SocketAddress &address);
kenjiArai 1:9db0e321a9f4 162
kenjiArai 1:9db0e321a9f4 163 protected:
kenjiArai 1:9db0e321a9f4 164 virtual nsapi_error_t enable_tlssocket();
kenjiArai 1:9db0e321a9f4 165 };
kenjiArai 1:9db0e321a9f4 166
kenjiArai 1:9db0e321a9f4 167 #endif // MBED_CONF_NSAPI_OFFLOAD_TLSSOCKET
kenjiArai 1:9db0e321a9f4 168
kenjiArai 0:5b88d5760320 169 #endif // _MBED_HTTPS_TLS_TCP_SOCKET_H_
kenjiArai 0:5b88d5760320 170
kenjiArai 0:5b88d5760320 171 /** @} */