]>
Commit | Line | Data |
---|---|---|
0f95a274 | 1 | /* authd/provider.h - authentication provider framework |
05e17ac2 EM |
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 | ||
0f95a274 EM |
21 | #ifndef __CHARYBDIS_AUTHD_PROVIDER_H__ |
22 | #define __CHARYBDIS_AUTHD_PROVIDER_H__ | |
05e17ac2 EM |
23 | |
24 | #include "stdinc.h" | |
a51487e0 | 25 | #include "authd.h" |
3e875f62 | 26 | #include "rb_dictionary.h" |
05e17ac2 | 27 | |
3e875f62 | 28 | #define MAX_PROVIDERS 32 /* This should be enough */ |
05e17ac2 EM |
29 | |
30 | /* Registered providers */ | |
31 | typedef enum | |
32 | { | |
3e875f62 EM |
33 | PROVIDER_RDNS, |
34 | PROVIDER_IDENT, | |
35 | PROVIDER_BLACKLIST, | |
05e17ac2 EM |
36 | } provider_t; |
37 | ||
38 | struct auth_client | |
39 | { | |
be67cfca | 40 | uint16_t cid; /* Client ID */ |
05e17ac2 | 41 | |
2b0cc3d3 EM |
42 | char l_ip[HOSTIPLEN + 1]; /* Listener IP address */ |
43 | uint16_t l_port; /* Listener port */ | |
9c7498d5 | 44 | struct rb_sockaddr_storage l_addr; /* Listener address/port */ |
2b0cc3d3 EM |
45 | |
46 | char c_ip[HOSTIPLEN + 1]; /* Client IP address */ | |
47 | uint16_t c_port; /* Client port */ | |
9c7498d5 | 48 | struct rb_sockaddr_storage c_addr; /* Client address/port */ |
05e17ac2 | 49 | |
5bfc606f | 50 | char hostname[HOSTLEN + 1]; /* Used for DNS lookup */ |
be67cfca | 51 | char username[USERLEN + 1]; /* Used for ident lookup */ |
05e17ac2 | 52 | |
3e875f62 | 53 | uint32_t providers; /* Providers at work, |
2b0cc3d3 | 54 | * none left when set to 0 */ |
a7d5aea1 | 55 | uint32_t providers_done; /* Providers completed */ |
247b304f | 56 | bool providers_starting; /* Providers are still warming up */ |
f7b37c1d | 57 | |
3e875f62 | 58 | void *data[MAX_PROVIDERS]; /* Provider-specific data slots */ |
2b0cc3d3 EM |
59 | }; |
60 | ||
61 | typedef bool (*provider_init_t)(void); | |
2b0cc3d3 EM |
62 | typedef void (*provider_destroy_t)(void); |
63 | ||
89d22b9a EM |
64 | typedef bool (*provider_start_t)(struct auth_client *); |
65 | typedef void (*provider_cancel_t)(struct auth_client *); | |
a51487e0 | 66 | typedef void (*provider_complete_t)(struct auth_client *, provider_t); |
89d22b9a | 67 | |
05e17ac2 EM |
68 | struct auth_provider |
69 | { | |
99e53867 EM |
70 | rb_dlink_node node; |
71 | ||
72 | provider_t id; | |
05e17ac2 EM |
73 | |
74 | provider_init_t init; /* Initalise the provider */ | |
75 | provider_destroy_t destroy; /* Terminate the provider */ | |
76 | ||
89d22b9a | 77 | provider_start_t start; /* Perform authentication */ |
05e17ac2 EM |
78 | provider_cancel_t cancel; /* Authentication cancelled */ |
79 | provider_complete_t completed; /* Callback for when other performers complete (think dependency chains) */ | |
a51487e0 EM |
80 | |
81 | struct auth_opts_handler *opt_handlers; | |
05e17ac2 EM |
82 | }; |
83 | ||
9b5b2ded | 84 | extern rb_dlink_list auth_providers; |
a52c7a8e | 85 | extern rb_dictionary *auth_clients; |
3e875f62 | 86 | |
18764319 | 87 | extern struct auth_provider rdns_provider; |
f1861e48 | 88 | extern struct auth_provider ident_provider; |
add80afd | 89 | extern struct auth_provider blacklist_provider; |
9b5b2ded EM |
90 | |
91 | void load_provider(struct auth_provider *provider); | |
92 | void unload_provider(struct auth_provider *provider); | |
93 | ||
05e17ac2 EM |
94 | void init_providers(void); |
95 | void destroy_providers(void); | |
96 | void cancel_providers(struct auth_client *auth); | |
97 | ||
91f870b3 EM |
98 | void provider_done(struct auth_client *auth, provider_t id); |
99 | void accept_client(struct auth_client *auth, provider_t id); | |
f7b37c1d | 100 | void reject_client(struct auth_client *auth, provider_t id, const char *reason); |
05e17ac2 | 101 | |
05e17ac2 EM |
102 | void handle_new_connection(int parc, char *parv[]); |
103 | ||
cdf15929 | 104 | /* Provider is operating on this auth_client (set this if you have async work to do) */ |
a7d5aea1 | 105 | static inline void set_provider_on(struct auth_client *auth, provider_t provider) |
05e17ac2 | 106 | { |
3e875f62 | 107 | auth->providers |= (1 << provider); |
05e17ac2 EM |
108 | } |
109 | ||
110 | /* Provider is no longer operating on this auth client (you should use provider_done) */ | |
a7d5aea1 | 111 | static inline void set_provider_off(struct auth_client *auth, provider_t provider) |
2b0cc3d3 | 112 | { |
3e875f62 | 113 | auth->providers &= ~(1 << provider); |
2b0cc3d3 EM |
114 | } |
115 | ||
a7d5aea1 EM |
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) | |
05e17ac2 | 118 | { |
a7d5aea1 | 119 | auth->providers_done |= (1 << provider); |
05e17ac2 EM |
120 | } |
121 | ||
122 | /* Check if provider is operating on this auth client */ | |
a7d5aea1 | 123 | static inline bool is_provider_on(struct auth_client *auth, provider_t provider) |
2b0cc3d3 | 124 | { |
3e875f62 | 125 | return auth->providers & (1 << provider); |
2b0cc3d3 EM |
126 | } |
127 | ||
a7d5aea1 | 128 | static inline bool is_provider_done(struct auth_client *auth, provider_t provider) |
05e17ac2 | 129 | { |
a7d5aea1 | 130 | return auth->providers_done & (1 << provider); |
05e17ac2 EM |
131 | } |
132 | ||
0f95a274 | 133 | #endif /* __CHARYBDIS_AUTHD_PROVIDER_H__ */ |