1 /* authd/auth.c - 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 /* So the basic design here is to have "authentication providers" that do
22 * things like query ident and blacklists and even open proxies.
24 * Providers are registered statically in the struct auth_providers array. You will
25 * probably want to add an item to the provider_t enum also.
27 * Providers can either return failure immediately, immediate acceptance, or
28 * do work in the background (calling set_provider to signal this).
30 * It is up to providers to keep their own state on clients if they need to.
32 * All providers must implement at a minimum a perform_provider function. You
33 * don't have to implement the others if you don't need them.
35 * Providers may kick clients off by rejecting them. Upon rejection, all
36 * providers are cancelled. They can also unconditionally accept them.
38 * When a provider is done and is neutral on accepting/rejecting a client, it
39 * should call provider_done. Do NOT call this if you have accepted or rejected
42 * --Elizafox, 9 March 2016
48 #define NULL_PROVIDER { \
49 .provider = PROVIDER_NULL, \
58 static struct auth_provider auth_providers
[] =
64 struct auth_client auth_clients
[MAX_CLIENTS
];
66 /* Initalise all providers */
67 void init_providers(void)
69 struct auth_provider
*pptr
;
71 AUTH_PROVIDER_FOREACH(pptr
)
73 if(pptr
->init
&& !pptr
->init())
74 /* Provider failed to init, time to go */
79 /* Terminate all providers */
80 void destroy_providers(void)
82 struct auth_provider
*pptr
;
84 /* Cancel outstanding connections */
85 for (size_t i
= 0; i
< MAX_CLIENTS
; i
++)
87 if(auth_clients
[i
].cid
)
89 /* TBD - is this the right thing?
90 * (NOTE - this error message is designed for morons) */
91 reject_client(&auth_clients
[i
], 0,
92 "IRC server reloading... try reconnecting in a few seconds");
96 AUTH_PROVIDER_FOREACH(pptr
)
103 /* Cancel outstanding providers for a client */
104 void cancel_providers(struct auth_client
*auth
)
106 struct auth_provider
*pptr
;
108 AUTH_PROVIDER_FOREACH(pptr
)
110 if(pptr
->cancel
&& is_provider(auth
, pptr
->provider
))
111 /* Cancel if required */
116 /* Provider is done */
117 void provider_done(struct auth_client
*auth
, provider_t provider
)
119 struct auth_provider
*pptr
;
121 unset_provider(auth
, provider
);
125 /* No more providers, done */
126 accept_client(auth
, 0);
130 AUTH_PROVIDER_FOREACH(pptr
)
132 if(pptr
->completed
&& is_provider(auth
, pptr
->provider
))
133 /* Notify pending clients who asked for it */
134 pptr
->completed(auth
, provider
);
138 /* Reject a client, cancel outstanding providers if any */
139 void reject_client(struct auth_client
*auth
, provider_t provider
, const char *reason
)
141 uint16_t cid
= auth
->cid
;
143 rb_helper_write(authd_helper
, "R %x :%s", auth
->cid
, reason
);
145 unset_provider(auth
, provider
);
148 cancel_providers(auth
);
150 memset(&auth_clients
[cid
], 0, sizeof(struct auth_client
));
153 /* Accept a client, cancel outstanding providers if any */
154 void accept_client(struct auth_client
*auth
, provider_t provider
)
156 uint16_t cid
= auth
->cid
;
158 rb_helper_write(authd_helper
, "A %x %s %s", auth
->cid
, auth
->username
, auth
->hostname
);
160 unset_provider(auth
, provider
);
163 cancel_providers(auth
);
165 memset(&auth_clients
[cid
], 0, sizeof(struct auth_client
));
168 /* Send a notice to a client */
169 void notice_client(struct auth_client
*auth
, const char *notice
)
171 rb_helper_write(authd_helper
, "N %x :%s", auth
->cid
, notice
);
174 /* Begin authenticating user */
175 void start_auth(const char *cid
, const char *l_ip
, const char *l_port
, const char *c_ip
, const char *c_port
)
177 struct auth_provider
*pptr
;
178 struct auth_client
*auth
;
179 long lcid
= strtol(cid
, NULL
, 16);
181 if(lcid
>= MAX_CLIENTS
)
184 auth
= &auth_clients
[lcid
];
186 /* Shouldn't get here */
189 auth
->cid
= (uint16_t)lcid
;
191 rb_strlcpy(auth
->l_ip
, l_ip
, sizeof(auth
->l_ip
));
192 auth
->l_port
= (uint16_t)atoi(l_port
); /* Safe cast, port shouldn't exceed 16 bits */
194 rb_strlcpy(auth
->c_ip
, c_ip
, sizeof(auth
->c_ip
));
195 auth
->c_port
= (uint16_t)atoi(c_port
);
197 AUTH_PROVIDER_FOREACH(pptr
)
199 /* Execute providers */
200 if(!pptr
->start(auth
))
202 /* Rejected immediately */
203 cancel_providers(auth
);
208 /* If no providers are running, accept the client */
210 accept_client(auth
, 0);
213 /* Callback for the initiation */
214 void handle_new_connection(int parc
, char *parv
[])
219 start_auth(parv
[1], parv
[2], parv
[3], parv
[4], parv
[5]);