From bcdbd892926c3a177d6ad61b0bce16886840e7f8 Mon Sep 17 00:00:00 2001 From: yellows8 Date: Fri, 1 May 2020 22:49:51 -0400 Subject: [PATCH] ssl: Updated docs. --- nx/include/switch/services/ssl.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/nx/include/switch/services/ssl.h b/nx/include/switch/services/ssl.h index 8ca79301..0319b5ea 100644 --- a/nx/include/switch/services/ssl.h +++ b/nx/include/switch/services/ssl.h @@ -434,10 +434,11 @@ Result sslConnectionGetIoMode(SslConnection *c, SslIoMode *out); * @note \ref sslConnectionSetSocketDescriptor must have been used prior to this successfully. * @note \ref sslConnectionSetHostName must have been used previously with a non-empty string when ::SslVerifyOption_HostName is set. * @note The DoHandshakeGetServerCert cmd is only used if both server_certbuf/server_certbuf_size are set, otherwise the DoHandshake cmd is used (in which case out_size/total_certs will be left at value 0). + * @note No certs are returned when ::SslVerifyOption_PeerCa is not set. * @param c \ref SslConnection * @param[out] out_size Total data size which was written to server_certbuf. Optional, can be NULL. * @param[out] total_certs Total certs which were written to server_certbuf, can be NULL. - * @param[out] server_certbuf Optional output server cert buffer, can be NULL. Normally this just contains the server cert DER, however with ::SslOptionType_GetServerCertChain set this will contain the full chain (\ref sslConnectionGetServerCertDetail can be used to parse that). + * @param[out] server_certbuf Optional output server cert buffer, can be NULL. Normally this just contains the server cert DER, however with ::SslOptionType_GetServerCertChain set this will contain the full chain (\ref sslConnectionGetServerCertDetail can be used to parse that). With ::SslIoMode_NonBlocking this buffer will be only filled in once - when this cmd returns successfully the buffer will generally be empty. * @param[in] server_certbuf_size Optional output server cert buffer size, can be 0. */ Result sslConnectionDoHandshake(SslConnection *c, u32 *out_size, u32 *total_certs, void* server_certbuf, u32 server_certbuf_size);