1 /* authd/auth.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_AUTH_H__
22 #define __CHARYBDIS_AUTHD_AUTH_H__
27 #define MAX_CLIENTS 1024
29 /* Registered providers */
32 PROVIDER_NULL
= 0x0, /* Dummy value */
35 PROVIDER_BLACKLIST
= 0x4,
40 uint16_t cid
; /* Client ID */
42 char l_ip
[HOSTIPLEN
+ 1]; /* Listener IP address */
43 uint16_t l_port
; /* Listener port */
45 char c_ip
[HOSTIPLEN
+ 1]; /* Client IP address */
46 uint16_t c_port
; /* Client port */
48 char hostname
[IRCD_RES_HOSTLEN
+ 1]; /* Used for DNS lookup */
49 char username
[USERLEN
+ 1]; /* Used for ident lookup */
51 unsigned int providers
; /* Providers at work,
52 * none left when set to 0 */
55 typedef bool (*provider_init_t
)(void);
56 typedef bool (*provider_perform_t
)(struct auth_client
*);
57 typedef void (*provider_complete_t
)(struct auth_client
*, provider_t provider
);
58 typedef void (*provider_cancel_t
)(struct auth_client
*);
59 typedef void (*provider_destroy_t
)(void);
65 provider_init_t init
; /* Initalise the provider */
66 provider_destroy_t destroy
; /* Terminate the provider */
68 provider_perform_t start
; /* Perform authentication */
69 provider_cancel_t cancel
; /* Authentication cancelled */
70 provider_complete_t completed
; /* Callback for when other performers complete (think dependency chains) */
73 #define AUTH_PROVIDER_FOREACH(a) for((a) = auth_providers; (a)->provider; (a)++)
75 void init_providers(void);
76 void destroy_providers(void);
77 void cancel_providers(struct auth_client
*auth
);
79 void provider_done(struct auth_client
*auth
, provider_t provider
);
80 void reject_client(struct auth_client
*auth
, provider_t provider
, const char *reason
);
81 void accept_client(struct auth_client
*auth
, provider_t provider
);
83 void notice_client(struct auth_client
*auth
, const char *notice
);
85 void start_auth(const char *cid
, const char *l_ip
, const char *l_port
, const char *c_ip
, const char *c_port
);
86 void handle_new_connection(int parc
, char *parv
[]);
88 /* Provider is operating on this auth_client (set this if you have async work to do) */
89 static inline void set_provider(struct auth_client
*auth
, provider_t provider
)
91 auth
->providers
|= provider
;
94 /* Provider is no longer operating on this auth client (you should use provider_done) */
95 static inline void unset_provider(struct auth_client
*auth
, provider_t provider
)
97 auth
->providers
&= ~provider
;
100 /* Check if provider is operating on this auth client */
101 static inline bool is_provider(struct auth_client
*auth
, provider_t provider
)
103 return auth
->providers
& provider
;
106 #endif /* __CHARYBDIS_AUTHD_AUTH_H__ */