]> granicus.if.org Git - esp-idf/commitdiff
modify comments on esp_tls_cfg, to clarify that other formats besides PEM (such as...
authorHenning Fleddermann <henning.fleddermann@grandcentrix.net>
Mon, 15 Jul 2019 15:51:25 +0000 (17:51 +0200)
committerDavid Cermak <cermak@espressif.com>
Fri, 2 Aug 2019 07:25:16 +0000 (09:25 +0200)
Signed-off-by: David Cermak <cermak@espressif.com>
components/esp-tls/esp_tls.h

index 1c2f785ea5abd108c37eaea49d73a4a4e9b53655..ebdffa49e2b39d31aece0a05dd8abb3cade7c42f 100644 (file)
@@ -90,22 +90,28 @@ typedef struct esp_tls_cfg {
                                                  - where 'h2' is the protocol name */
  
     const unsigned char *cacert_pem_buf;    /*!< Certificate Authority's certificate in a buffer.
-                                                 This buffer should be NULL terminated */
+                                                 Format may be PEM or DER, depending on mbedtls-support
+                                                 This buffer should be NULL terminated in case of PEM */
  
     unsigned int cacert_pem_bytes;          /*!< Size of Certificate Authority certificate
-                                                 pointed to by cacert_pem_buf */
+                                                 pointed to by cacert_pem_buf
+                                                 (including NULL-terminator in case of PEM format) */
 
     const unsigned char *clientcert_pem_buf;/*!< Client certificate in a buffer
-                                                 This buffer should be NULL terminated */
+                                                 Format may be PEM or DER, depending on mbedtls-support
+                                                 This buffer should be NULL terminated in case of PEM */
 
     unsigned int clientcert_pem_bytes;      /*!< Size of client certificate pointed to by
-                                                 clientcert_pem_buf */
+                                                 clientcert_pem_buf
+                                                 (including NULL-terminator in case of PEM format) */
 
     const unsigned char *clientkey_pem_buf; /*!< Client key in a buffer
-                                                 This buffer should be NULL terminated */
+                                                 Format may be PEM or DER, depending on mbedtls-support
+                                                 This buffer should be NULL terminated in case of PEM */
 
     unsigned int clientkey_pem_bytes;       /*!< Size of client key pointed to by
-                                                 clientkey_pem_buf */
+                                                 clientkey_pem_buf
+                                                 (including NULL-terminator in case of PEM format) */
 
     const unsigned char *clientkey_password;/*!< Client key decryption password string */