Document that X509_free() must be called after using mosquitto_client_certificate().

Closes #1842. Thanks to Wolfgang Petroschka.
This commit is contained in:
Roger A. Light 2020-10-13 10:41:08 +01:00
parent 5b4e4f047b
commit be8b94189c
2 changed files with 5 additions and 0 deletions

View File

@ -50,6 +50,8 @@ Broker:
- Enabling certificate based TLS encryption is now through certfile and
keyfile, not capath or cafile.
- Added support for controlling UNSUBSCRIBE calls in v5 plugin ACL checks.
- Document that X509_free() must be called after using
mosquitto_client_certificate(). Closes #1842.
Client library:
- Client no longer generates random client ids for v3.1.1 clients, these are

View File

@ -260,6 +260,9 @@ mosq_EXPORT int mosquitto_client_keepalive(const struct mosquitto *client);
* NULL will be returned. This function will only ever return a non-NULL value
* if the `require_certificate` option is set to true.
*
* When you have finished with the x509 pointer, it must be freed using
* X509_free().
*
* If TLS is not supported, this function will always return NULL.
*/
mosq_EXPORT void *mosquitto_client_certificate(const struct mosquitto *client);