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 */
30 /* Registered providers */
40 uint16_t cid
; /* Client ID */
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 */
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 */
50 char hostname
[HOSTLEN
+ 1]; /* Used for DNS lookup */
51 char username
[USERLEN
+ 1]; /* Used for ident lookup */
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 */
58 void *data
[MAX_PROVIDERS
]; /* Provider-specific data slots */
61 typedef bool (*provider_init_t
)(void);
62 typedef void (*provider_destroy_t
)(void);
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
);
74 provider_init_t init
; /* Initalise the provider */
75 provider_destroy_t destroy
; /* Terminate the provider */
77 provider_start_t start
; /* Perform authentication */
78 provider_cancel_t cancel
; /* Authentication cancelled */
79 provider_complete_t completed
; /* Callback for when other performers complete (think dependency chains) */
81 struct auth_opts_handler
*opt_handlers
;
84 extern rb_dlink_list auth_providers
;
85 extern rb_dictionary
*auth_clients
;
87 extern struct auth_provider rdns_provider
;
88 extern struct auth_provider ident_provider
;
89 extern struct auth_provider blacklist_provider
;
91 void load_provider(struct auth_provider
*provider
);
92 void unload_provider(struct auth_provider
*provider
);
94 void init_providers(void);
95 void destroy_providers(void);
96 void cancel_providers(struct auth_client
*auth
);
98 void provider_done(struct auth_client
*auth
, provider_t id
);
99 void accept_client(struct auth_client
*auth
, provider_t id
);
100 void reject_client(struct auth_client
*auth
, provider_t id
, const char *reason
);
102 void handle_new_connection(int parc
, char *parv
[]);
104 /* Provider is operating on this auth_client (set this if you have async work to do) */
105 static inline void set_provider_on(struct auth_client
*auth
, provider_t provider
)
107 auth
->providers
|= (1 << provider
);
110 /* Provider is no longer operating on this auth client (you should use provider_done) */
111 static inline void set_provider_off(struct auth_client
*auth
, provider_t provider
)
113 auth
->providers
&= ~(1 << provider
);
116 /* Set the provider to done (you should use provider_done) */
117 static inline void set_provider_done(struct auth_client
*auth
, provider_t provider
)
119 auth
->providers_done
|= (1 << provider
);
122 /* Check if provider is operating on this auth client */
123 static inline bool is_provider_on(struct auth_client
*auth
, provider_t provider
)
125 return auth
->providers
& (1 << provider
);
128 static inline bool is_provider_done(struct auth_client
*auth
, provider_t provider
)
130 return auth
->providers_done
& (1 << provider
);
133 #endif /* __CHARYBDIS_AUTHD_PROVIDER_H__ */