authd/provider.h

   1 /* authd/provider.h - authentication provider framework
   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
  21 #ifndef __CHARYBDIS_AUTHD_PROVIDER_H__
  22 #define __CHARYBDIS_AUTHD_PROVIDER_H__
  23
  24 #include "stdinc.h"
  25 #include "rb_dictionary.h"
  26
  27 #define MAX_PROVIDERS 32        /* This should be enough */
  28
  29 /* Registered providers */
  30 typedef enum
  31 {
  32         PROVIDER_RDNS,
  33         PROVIDER_IDENT,
  34         PROVIDER_BLACKLIST,
  35 } provider_t;
  36
  37 typedef enum
  38 {
  39         L_DEBUG = 'D',
  40         L_INFO = 'I',
  41         L_WARN = 'W',
  42         L_CRIT ='C',
  43 } notice_level_t;
  44
  45 struct auth_client
  46 {
  47         uint16_t cid;                           /* Client ID */
  48
  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 */
  52
  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 */
  56
  57         char hostname[HOSTLEN + 1];             /* Used for DNS lookup */
  58         char username[USERLEN + 1];             /* Used for ident lookup */
  59
  60         uint32_t providers;                     /* Providers at work,
  61                                                  * none left when set to 0 */
  62         uint32_t providers_done;                /* Providers completed */
  63
  64         void *data[MAX_PROVIDERS];              /* Provider-specific data slots */
  65 };
  66
  67 typedef bool (*provider_init_t)(void);
  68 typedef void (*provider_destroy_t)(void);
  69
  70 typedef bool (*provider_start_t)(struct auth_client *);
  71 typedef void (*provider_cancel_t)(struct auth_client *);
  72 typedef void (*provider_complete_t)(struct auth_client *, provider_t provider);
  73
  74 struct auth_provider
  75 {
  76         rb_dlink_node node;
  77
  78         provider_t id;
  79
  80         provider_init_t init;           /* Initalise the provider */
  81         provider_destroy_t destroy;     /* Terminate the provider */
  82
  83         provider_start_t start;         /* Perform authentication */
  84         provider_cancel_t cancel;       /* Authentication cancelled */
  85         provider_complete_t completed;  /* Callback for when other performers complete (think dependency chains) */
  86 };
  87
  88 extern rb_dlink_list auth_providers;
  89 extern rb_dictionary *auth_clients;
  90
  91 extern struct auth_provider rdns_provider;
  92 extern struct auth_provider ident_provider;
  93 extern struct auth_provider blacklist_provider;
  94
  95 void load_provider(struct auth_provider *provider);
  96 void unload_provider(struct auth_provider *provider);
  97
  98 void init_providers(void);
  99 void destroy_providers(void);
 100 void cancel_providers(struct auth_client *auth);
 101
 102 void provider_done(struct auth_client *auth, provider_t id);
 103 void accept_client(struct auth_client *auth, provider_t id);
 104 void reject_client(struct auth_client *auth, provider_t id, const char *reason);
 105
 106 void notice_client(struct auth_client *auth, const char *fmt, ...);
 107 void warn_opers(notice_level_t level, const char *fmt, ...);
 108
 109 void handle_new_connection(int parc, char *parv[]);
 110
 111 /* Provider is operating on this auth_client (set this if you have async work to do) */
 112 static inline void set_provider_on(struct auth_client *auth, provider_t provider)
 113 {
 114         auth->providers |= (1 << provider);
 115 }
 116
 117 /* Provider is no longer operating on this auth client (you should use provider_done) */
 118 static inline void set_provider_off(struct auth_client *auth, provider_t provider)
 119 {
 120         auth->providers &= ~(1 << provider);
 121 }
 122
 123 /* Set the provider to done (you should use provider_done) */
 124 static inline void set_provider_done(struct auth_client *auth, provider_t provider)
 125 {
 126         auth->providers_done |= (1 << provider);
 127 }
 128
 129 /* Check if provider is operating on this auth client */
 130 static inline bool is_provider_on(struct auth_client *auth, provider_t provider)
 131 {
 132         return auth->providers & (1 << provider);
 133 }
 134
 135 static inline bool is_provider_done(struct auth_client *auth, provider_t provider)
 136 {
 137         return auth->providers_done & (1 << provider);
 138 }
 139
 140 #endif /* __CHARYBDIS_AUTHD_PROVIDER_H__ */