jfr.im git - solanum.git/blame_incremental

... / ...

Commit	Line	Data
	1	/* authd/provider.h - authentication provider framework
	2	* Copyright (c) 2016 Elizabeth Myers <elizabeth@interlinked.me>
	3	*
	4	* Permission to use, copy, modify, and/or distribute this software for any
	5	* purpose with or without fee is hereby granted, provided that the above
	6	* copyright notice and this permission notice is present in all copies.
	7	*
	8	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
	9	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
	10	* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	11	* DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
	12	* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
	13	* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
	14	* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	15	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	16	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	17	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	18	* POSSIBILITY OF SUCH DAMAGE.
	19	*/
	20
	21	#ifndef __CHARYBDIS_AUTHD_PROVIDER_H__
	22	#define __CHARYBDIS_AUTHD_PROVIDER_H__
	23
	24	#include "stdinc.h"
	25	#include "authd.h"
	26	#include "rb_dictionary.h"
	27
	28	#define MAX_PROVIDERS 32 /* This should be enough */
	29
	30	/* Registered providers */
	31	typedef enum
	32	{
	33	PROVIDER_RDNS,
	34	PROVIDER_IDENT,
	35	PROVIDER_BLACKLIST,
	36	} provider_t;
	37
	38	struct auth_client
	39	{
	40	uint16_t cid; /* Client ID */
	41
	42	char l_ip[HOSTIPLEN + 1]; /* Listener IP address */
	43	uint16_t l_port; /* Listener port */
	44	struct rb_sockaddr_storage l_addr; /* Listener address/port */
	45
	46	char c_ip[HOSTIPLEN + 1]; /* Client IP address */
	47	uint16_t c_port; /* Client port */
	48	struct rb_sockaddr_storage c_addr; /* Client address/port */
	49
	50	char hostname[HOSTLEN + 1]; /* Used for DNS lookup */
	51	char username[USERLEN + 1]; /* Used for ident lookup */
	52
	53	uint32_t providers; /* Providers at work,
	54	* none left when set to 0 */
	55	uint32_t providers_done; /* Providers completed */
	56	bool providers_starting; /* Providers are still warming up */
	57
	58	void data[MAX_PROVIDERS]; / Provider-specific data slots */
	59	};
	60
	61	typedef bool (*provider_init_t)(void);
	62	typedef void (*provider_destroy_t)(void);
	63
	64	typedef bool (provider_start_t)(struct auth_client );
	65	typedef void (provider_cancel_t)(struct auth_client );
	66	typedef void (provider_complete_t)(struct auth_client , provider_t);
	67
	68	struct auth_stats_handler
	69	{
	70	const char letter;
	71	authd_stat_handler handler;
	72	};
	73
	74	struct auth_provider
	75	{
	76	rb_dlink_node node;
	77
	78	provider_t id;
	79
	80	provider_init_t init; /* Initalise the provider */
	81	provider_destroy_t destroy; /* Terminate the provider */
	82
	83	provider_start_t start; /* Perform authentication */
	84	provider_cancel_t cancel; /* Authentication cancelled */
	85	provider_complete_t completed; /* Callback for when other performers complete (think dependency chains) */
	86
	87	struct auth_stats_handler stats_handler;
	88
	89	struct auth_opts_handler *opt_handlers;
	90	};
	91
	92	extern rb_dlink_list auth_providers;
	93	extern rb_dictionary *auth_clients;
	94
	95	extern struct auth_provider rdns_provider;
	96	extern struct auth_provider ident_provider;
	97	extern struct auth_provider blacklist_provider;
	98
	99	void load_provider(struct auth_provider *provider);
	100	void unload_provider(struct auth_provider *provider);
	101
	102	void init_providers(void);
	103	void destroy_providers(void);
	104	void cancel_providers(struct auth_client *auth);
	105
	106	void provider_done(struct auth_client *auth, provider_t id);
	107	void accept_client(struct auth_client *auth, provider_t id);
	108	void reject_client(struct auth_client auth, provider_t id, const char data, const char *reason);
	109
	110	void handle_new_connection(int parc, char *parv[]);
	111	void handle_cancel_connection(int parc, char *parv[]);
	112
	113	/* Provider is operating on this auth_client (set this if you have async work to do) */
	114	static inline void
	115	set_provider_on(struct auth_client *auth, provider_t provider)
	116	{
	117	auth->providers \|= (1 << provider);
	118	}
	119
	120	/* Provider is no longer operating on this auth client (you should use provider_done) */
	121	static inline void
	122	set_provider_off(struct auth_client *auth, provider_t provider)
	123	{
	124	auth->providers &= ~(1 << provider);
	125	}
	126
	127	/* Set the provider to done (you should use provider_done) */
	128	static inline void
	129	set_provider_done(struct auth_client *auth, provider_t provider)
	130	{
	131	auth->providers_done \|= (1 << provider);
	132	}
	133
	134	/* Check if provider is operating on this auth client */
	135	static inline bool
	136	is_provider_on(struct auth_client *auth, provider_t provider)
	137	{
	138	return auth->providers & (1 << provider);
	139	}
	140
	141	static inline bool
	142	is_provider_done(struct auth_client *auth, provider_t provider)
	143	{
	144	return auth->providers_done & (1 << provider);
	145	}
	146
	147	#endif /* __CHARYBDIS_AUTHD_PROVIDER_H__ */