1 /* authd/provider.h - authentication provider framework
2 * Copyright (c) 2016 Elizabeth Myers <elizabeth@interlinked.me>
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.
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.
21 #ifndef __CHARYBDIS_AUTHD_PROVIDER_H__
22 #define __CHARYBDIS_AUTHD_PROVIDER_H__
26 #include "rb_dictionary.h"
28 #define MAX_PROVIDERS 32 /* This should be enough */
32 PROVIDER_STATUS_NOTRUN
= 0,
33 PROVIDER_STATUS_RUNNING
,
37 struct auth_client_data
39 struct auth_provider
*provider
; /* Pointer back */
40 time_t timeout
; /* Provider timeout */
41 void *data
; /* Provider data */
42 provider_status_t status
; /* Provider status */
47 uint32_t cid
; /* Client ID */
49 char l_ip
[HOSTIPLEN
+ 1]; /* Listener IP address */
50 uint16_t l_port
; /* Listener port */
51 struct rb_sockaddr_storage l_addr
; /* Listener address/port */
53 char c_ip
[HOSTIPLEN
+ 1]; /* Client IP address */
54 uint16_t c_port
; /* Client port */
55 struct rb_sockaddr_storage c_addr
; /* Client address/port */
57 char hostname
[HOSTLEN
+ 1]; /* Used for DNS lookup */
58 char username
[USERLEN
+ 1]; /* Used for ident lookup */
60 bool providers_starting
; /* Providers are still warming up */
61 bool providers_cancelled
; /* Providers are being cancelled */
62 unsigned int providers_active
; /* Number of active providers */
63 unsigned int refcount
; /* Held references */
65 struct auth_client_data
*data
; /* Provider-specific data */
68 typedef bool (*provider_init_t
)(void);
69 typedef void (*provider_destroy_t
)(void);
71 typedef bool (*provider_start_t
)(struct auth_client
*);
72 typedef void (*provider_cancel_t
)(struct auth_client
*);
73 typedef void (*uint32_timeout_t
)(struct auth_client
*);
74 typedef void (*provider_complete_t
)(struct auth_client
*, uint32_t);
76 struct auth_stats_handler
79 authd_stat_handler handler
;
86 uint32_t id
; /* Provider ID */
88 const char *name
; /* Name of the provider */
89 char letter
; /* Letter used on reject, etc. */
91 provider_init_t init
; /* Initalise the provider */
92 provider_destroy_t destroy
; /* Terminate the provider */
94 provider_start_t start
; /* Perform authentication */
95 provider_cancel_t cancel
; /* Authentication cancelled */
96 uint32_timeout_t timeout
; /* Timeout callback */
97 provider_complete_t completed
; /* Callback for when other performers complete (think dependency chains) */
99 struct auth_stats_handler stats_handler
;
101 struct auth_opts_handler
*opt_handlers
;
104 extern struct auth_provider rdns_provider
;
105 extern struct auth_provider ident_provider
;
106 extern struct auth_provider blacklist_provider
;
107 extern struct auth_provider opm_provider
;
109 extern rb_dlink_list auth_providers
;
110 extern rb_dictionary
*auth_clients
;
112 void load_provider(struct auth_provider
*provider
);
113 void unload_provider(struct auth_provider
*provider
);
115 void init_providers(void);
116 void destroy_providers(void);
117 void cancel_providers(struct auth_client
*auth
);
119 void provider_done(struct auth_client
*auth
, uint32_t id
);
120 void accept_client(struct auth_client
*auth
);
121 void reject_client(struct auth_client
*auth
, uint32_t id
, const char *data
, const char *fmt
, ...);
123 void handle_new_connection(int parc
, char *parv
[]);
124 void handle_cancel_connection(int parc
, char *parv
[]);
125 void auth_client_free(struct auth_client
*auth
);
128 auth_client_ref(struct auth_client
*auth
)
134 auth_client_unref(struct auth_client
*auth
)
137 if (auth
->refcount
== 0)
138 auth_client_free(auth
);
141 /* Get a provider by name */
142 static inline struct auth_provider
*
143 find_provider(const char *name
)
147 RB_DLINK_FOREACH(ptr
, auth_providers
.head
)
149 struct auth_provider
*provider
= ptr
->data
;
151 if(strcasecmp(provider
->name
, name
) == 0)
158 /* Get a provider's id by name */
160 get_provider_id(const char *name
, uint32_t *id
)
162 struct auth_provider
*provider
= find_provider(name
);
173 /* Get a provider's raw status */
174 static inline provider_status_t
175 get_provider_status(struct auth_client
*auth
, uint32_t provider
)
177 return auth
->data
[provider
].status
;
180 /* Set a provider's raw status */
182 set_provider_status(struct auth_client
*auth
, uint32_t provider
, provider_status_t status
)
184 auth
->data
[provider
].status
= status
;
187 /* Set the provider as running
188 * If you're doing asynchronous work call this */
190 set_provider_running(struct auth_client
*auth
, uint32_t provider
)
192 auth
->providers_active
++;
193 set_provider_status(auth
, provider
, PROVIDER_STATUS_RUNNING
);
196 /* Provider is no longer operating on this auth client
197 * You should use provider_done and not this */
199 set_provider_done(struct auth_client
*auth
, uint32_t provider
)
201 set_provider_status(auth
, provider
, PROVIDER_STATUS_DONE
);
202 auth
->providers_active
--;
205 /* Check if provider is operating on this auth client */
207 is_provider_running(struct auth_client
*auth
, uint32_t provider
)
209 return get_provider_status(auth
, provider
) == PROVIDER_STATUS_RUNNING
;
212 /* Check if provider has finished on this client */
214 is_provider_done(struct auth_client
*auth
, uint32_t provider
)
216 return get_provider_status(auth
, provider
) == PROVIDER_STATUS_DONE
;
219 /* Get provider auth client data */
221 get_provider_data(struct auth_client
*auth
, uint32_t id
)
223 return auth
->data
[id
].data
;
226 /* Set provider auth client data */
228 set_provider_data(struct auth_client
*auth
, uint32_t id
, void *data
)
230 auth
->data
[id
].data
= data
;
233 /* Set timeout relative to current time on provider
234 * When the timeout lapses, the provider's timeout call will execute */
236 set_provider_timeout_relative(struct auth_client
*auth
, uint32_t id
, time_t timeout
)
238 auth
->data
[id
].timeout
= timeout
+ rb_current_time();
241 /* Set timeout value in absolute time (Unix timestamp)
242 * When the timeout lapses, the provider's timeout call will execute */
244 set_provider_timeout_absolute(struct auth_client
*auth
, uint32_t id
, time_t timeout
)
246 auth
->data
[id
].timeout
= timeout
;
249 /* Get the timeout value for the provider */
251 get_provider_timeout(struct auth_client
*auth
, uint32_t id
)
253 return auth
->data
[id
].timeout
;
256 #endif /* __CHARYBDIS_AUTHD_PROVIDER_H__ */