mosquitto/lib/util_mosq.h

/*
Copyright (c) 2009-2019 Roger Light <roger@atchoo.org>

All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
and Eclipse Distribution License v1.0 which accompany this distribution.
 
The Eclipse Public License is available at
   http://www.eclipse.org/legal/epl-v10.html
and the Eclipse Distribution License is available at
  http://www.eclipse.org/org/documents/edl-v10.php.
 
Contributors:
   Roger Light - initial implementation and documentation.
*/
#ifndef UTIL_MOSQ_H
#define UTIL_MOSQ_H

#include <stdio.h>

#include "tls_mosq.h"
#include "mosquitto.h"
#include "mosquitto_internal.h"
#ifdef WITH_BROKER
#  include "mosquitto_broker_internal.h"
#endif

#ifdef WITH_BROKER
int mosquitto__check_keepalive(struct mosquitto_db *db, struct mosquitto *mosq);
#else
int mosquitto__check_keepalive(struct mosquitto *mosq);
#endif
uint16_t mosquitto__mid_generate(struct mosquitto *mosq);
FILE *mosquitto__fopen(const char *path, const char *mode, bool restrict_read);

#ifdef WITH_TLS
int mosquitto__hex2bin_sha1(const char *hex, unsigned char **bin);
int mosquitto__hex2bin(const char *hex, unsigned char *bin, int bin_max_len);
#endif

int util__random_bytes(void *bytes, int count);

void util__increment_receive_quota(struct mosquitto *mosq);
void util__increment_send_quota(struct mosquitto *mosq);
void util__decrement_receive_quota(struct mosquitto *mosq);
void util__decrement_send_quota(struct mosquitto *mosq);
#endif
Initial contribution. 2014-05-07 22:27:00 +00:00			`/*`
Update changelog, bump version, bump copyright year. 2019-02-28 16:56:15 +00:00			`Copyright (c) 2009-2019 Roger Light <roger@atchoo.org>`
Initial contribution. 2014-05-07 22:27:00 +00:00
			`All rights reserved. This program and the accompanying materials`
			`are made available under the terms of the Eclipse Public License v1.0`
			`and Eclipse Distribution License v1.0 which accompany this distribution.`

			`The Eclipse Public License is available at`
			`http://www.eclipse.org/legal/epl-v10.html`
			`and the Eclipse Distribution License is available at`
			`http://www.eclipse.org/org/documents/edl-v10.php.`

			`Contributors:`
			`Roger Light - initial implementation and documentation.`
			`*/`
Don't use reserved names in header guards. Closes #3. 2016-03-13 18:43:13 +00:00			`#ifndef UTIL_MOSQ_H`
			`#define UTIL_MOSQ_H`
Initial contribution. 2014-05-07 22:27:00 +00:00
			`#include <stdio.h>`

			`#include "tls_mosq.h"`
			`#include "mosquitto.h"`
[458410] Add missing headers to util_mosq.h Thanks to Michael Laing. Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=458410 2015-01-26 20:46:15 +00:00			`#include "mosquitto_internal.h"`
			`#ifdef WITH_BROKER`
Rename mosquitto_broker.h -> mosquitto_broker_internal.h 2016-07-08 09:10:04 +00:00			`# include "mosquitto_broker_internal.h"`
[458410] Add missing headers to util_mosq.h Thanks to Michael Laing. Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=458410 2015-01-26 20:46:15 +00:00			`#endif`
Initial contribution. 2014-05-07 22:27:00 +00:00
Use hash functions to store client data. 2014-06-23 16:57:35 +00:00			`#ifdef WITH_BROKER`
Don't call on_disconnect() twice if keepalive tests fail. Closes #1067. Thanks to xingchen02. Bug: https://github.com/eclipse/mosquitto/issues/1067 2018-12-06 10:45:57 +00:00			`int mosquitto__check_keepalive(struct mosquitto_db db, struct mosquitto mosq);`
Use hash functions to store client data. 2014-06-23 16:57:35 +00:00			`#else`
Don't call on_disconnect() twice if keepalive tests fail. Closes #1067. Thanks to xingchen02. Bug: https://github.com/eclipse/mosquitto/issues/1067 2018-12-06 10:45:57 +00:00			`int mosquitto__check_keepalive(struct mosquitto *mosq);`
Use hash functions to store client data. 2014-06-23 16:57:35 +00:00			`#endif`
Change internal funcs _foo_bar() to foo__bar(). 2015-04-19 21:10:59 +00:00			`uint16_t mosquitto__mid_generate(struct mosquitto *mosq);`
Merge branch 'master' into develop 2017-07-16 21:52:01 +00:00			`FILE mosquitto__fopen(const char path, const char *mode, bool restrict_read);`
Initial contribution. 2014-05-07 22:27:00 +00:00
Minor build variant fixes. 2019-04-17 09:59:52 +00:00			`#ifdef WITH_TLS`
Add engine private key password support Some OpenSSL engines (selectable via tls_engine option) may require a password to make use of private keys created with them in the first place. The TPM engine for example, will require a password to access the underlying TPM's Storage Root Key (SRK), which is the root key of a hierarchy of keys associated with a TPM; it is generated within a TPM and is a non-migratable key. Each owned TPM contains a SRK, generated by the TPM at the request of the Owner. [1] By default, the engine will prompt the user to introduce the SRK password before any private keys created with the engine can be used. This could be inconvenient when running on an unattended system. Here's where the new tls_engine_kpass_sha option comes in handy. The user can specify a SHA1 hash of its engine private key password via command line or config file and it will be passed on to the engine directly. This commit adds support for both clients (libmosquitto) and broker. [1] https://goo.gl/qQoXBY Signed-off-by: Nicolás Pernas Maradei <nicopernas@gmail.com> 2018-08-11 16:57:58 +00:00			`int mosquitto__hex2bin_sha1(const char hex, unsigned char *bin);`
Change internal funcs _foo_bar() to foo__bar(). 2015-04-19 21:10:59 +00:00			`int mosquitto__hex2bin(const char hex, unsigned char bin, int bin_max_len);`
Initial contribution. 2014-05-07 22:27:00 +00:00			`#endif`

Use better random numbers for everything, where possible. 2019-02-27 14:15:31 +00:00			`int util__random_bytes(void *bytes, int count);`

Receive maximum support for clients. 2019-01-08 12:27:19 +00:00			`void util__increment_receive_quota(struct mosquitto *mosq);`
Send maximum limits for QoS>0. This needs more work on the broker front to simplify the design. 2019-01-08 18:38:47 +00:00			`void util__increment_send_quota(struct mosquitto *mosq);`
Separate broker message queues into in/out. This allows and includes better flow control handling for QoS>0. 2019-04-13 21:59:29 +00:00			`void util__decrement_receive_quota(struct mosquitto *mosq);`
			`void util__decrement_send_quota(struct mosquitto *mosq);`
Initial contribution. 2014-05-07 22:27:00 +00:00			`#endif`