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
	57	void data[MAX_PROVIDERS]; / Provider-specific data slots */
	58	};
	59
	60	typedef bool (*provider_init_t)(void);
	61	typedef void (*provider_destroy_t)(void);
	62
	63	typedef bool (provider_start_t)(struct auth_client );
	64	typedef void (provider_cancel_t)(struct auth_client );
	65	typedef void (provider_complete_t)(struct auth_client , provider_t);
	66
	67	struct auth_provider
	68	{
	69	rb_dlink_node node;
	70
	71	provider_t id;
	72
	73	provider_init_t init; /* Initalise the provider */
	74	provider_destroy_t destroy; /* Terminate the provider */
	75
	76	provider_start_t start; /* Perform authentication */
	77	provider_cancel_t cancel; /* Authentication cancelled */
	78	provider_complete_t completed; /* Callback for when other performers complete (think dependency chains) */
	79
	80	struct auth_opts_handler *opt_handlers;
	81	};
	82
	83	extern rb_dlink_list auth_providers;
	84	extern rb_dictionary *auth_clients;
	85
	86	extern struct auth_provider rdns_provider;
	87	extern struct auth_provider ident_provider;
	88	extern struct auth_provider blacklist_provider;
	89
	90	void load_provider(struct auth_provider *provider);
	91	void unload_provider(struct auth_provider *provider);
	92
	93	void init_providers(void);
	94	void destroy_providers(void);
	95	void cancel_providers(struct auth_client *auth);
	96
	97	void provider_done(struct auth_client *auth, provider_t id);
	98	void accept_client(struct auth_client *auth, provider_t id);
	99	void reject_client(struct auth_client auth, provider_t id, const char reason);
	100
	101	void handle_new_connection(int parc, char *parv[]);
	102
	103	/* Provider is operating on this auth_client (set this if you have async work to do) */
	104	static inline void set_provider_on(struct auth_client *auth, provider_t provider)
	105	{
	106	auth->providers \|= (1 << provider);
	107	}
	108
	109	/* Provider is no longer operating on this auth client (you should use provider_done) */
	110	static inline void set_provider_off(struct auth_client *auth, provider_t provider)
	111	{
	112	auth->providers &= ~(1 << provider);
	113	}
	114
	115	/* Set the provider to done (you should use provider_done) */
	116	static inline void set_provider_done(struct auth_client *auth, provider_t provider)
	117	{
	118	auth->providers_done \|= (1 << provider);
	119	}
	120
	121	/* Check if provider is operating on this auth client */
	122	static inline bool is_provider_on(struct auth_client *auth, provider_t provider)
	123	{
	124	return auth->providers & (1 << provider);
	125	}
	126
	127	static inline bool is_provider_done(struct auth_client *auth, provider_t provider)
	128	{
	129	return auth->providers_done & (1 << provider);
	130	}
	131
	132	#endif /* __CHARYBDIS_AUTHD_PROVIDER_H__ */