lib/include/radsec/radsec.h

   1 /** @file libradsec.h
   2     @brief Header file for libradsec.  */
   3 /* See the file COPYING for licensing information.  */
   4
   5 #include <unistd.h>
   6
   7 enum rs_err_code {
   8     RSE_OK = 0,
   9     RSE_NOMEM = 1,
  10     RSE_NOSYS = 2,
  11     RSE_INVALID_CTX = 3,
  12     RSE_INVALID_CONN = 4,
  13     RSE_CONN_TYPE_MISMATCH = 5,
  14     RSE_FR = 6,                 /* FreeRADIUS error.  */
  15     RSE_BADADDR = 7,
  16     RSE_NOPEER = 8,
  17     RSE_EVENT = 9,              /* libevent error.  */
  18     RSE_SOCKERR = 10,
  19     RSE_CONFIG = 11,
  20     RSE_BADAUTH = 12,
  21     RSE_INTERNAL = 13,
  22     RSE_SSLERR = 14,            /* OpenSSL error.  */
  23     RSE_INVALID_PKT = 15,
  24     RSE_IOTIMEOUT = 16,
  25     RSE_SOME_ERROR = 21,  /* Unspecified error.  Shouldn't happen.  */
  26 };
  27
  28 enum rs_conn_type {
  29     RS_CONN_TYPE_NONE = 0,
  30     RS_CONN_TYPE_UDP,
  31     RS_CONN_TYPE_TCP,
  32     RS_CONN_TYPE_TLS,
  33     RS_CONN_TYPE_DTLS,
  34 };
  35 typedef unsigned int rs_conn_type_t;
  36
  37
  38 #if defined (__cplusplus)
  39 extern "C" {
  40 #endif
  41
  42 /* Data types.  */
  43 struct rs_context;              /* radsec-impl.h */
  44 struct rs_connection;           /* radsec-impl.h */
  45 struct rs_packet;               /* radsec-impl.h */
  46 struct rs_conn;                 /* radsec-impl.h */
  47 struct rs_attr;                 /* radsec-impl.h */
  48 struct rs_error;                /* radsec-impl.h */
  49 struct rs_peer;                 /* radsec-impl.h */
  50 struct radius_packet;           /* <freeradius/libradius.h> */
  51 struct event_base;              /* <event2/event-internal.h> */
  52
  53 typedef void *(*rs_calloc_fp) (size_t nmemb, size_t size);
  54 typedef void *(*rs_malloc_fp) (size_t size);
  55 typedef void (*rs_free_fp) (void *ptr);
  56 typedef void *(*rs_realloc_fp) (void *ptr, size_t size);
  57 struct rs_alloc_scheme {
  58     rs_calloc_fp calloc;
  59     rs_malloc_fp malloc;
  60     rs_free_fp free;
  61     rs_realloc_fp realloc;
  62 };
  63
  64 typedef void (*rs_conn_connected_cb) (void *user_data /* FIXME: peer? */ );
  65 typedef void (*rs_conn_disconnected_cb) (void *user_data /* FIXME: reason? */ );
  66 typedef void (*rs_conn_packet_received_cb) (struct rs_packet *packet,
  67                                             void *user_data);
  68 typedef void (*rs_conn_packet_sent_cb) (void *user_data);
  69 struct rs_conn_callbacks {
  70     /** Callback invoked when the connection has been established.  */
  71     rs_conn_connected_cb connected_cb;
  72     /** Callback invoked when the connection has been torn down.  */
  73     rs_conn_disconnected_cb disconnected_cb;
  74     /** Callback invoked when a packet was received.  */
  75     rs_conn_packet_received_cb received_cb;
  76     /** Callback invoked when a packet was successfully sent.  */
  77     rs_conn_packet_sent_cb sent_cb;
  78 };
  79
  80
  81 /* Function prototypes.  */
  82 /* Context.  */
  83 int rs_context_create(struct rs_context **ctx, const char *dict);
  84 void rs_context_destroy(struct rs_context *ctx);
  85 int rs_context_set_alloc_scheme(struct rs_context *ctx,
  86                                 struct rs_alloc_scheme *scheme);
  87 int rs_context_read_config(struct rs_context *ctx, const char *config_file);
  88
  89 /* Connection.  */
  90 int rs_conn_create(struct rs_context *ctx,
  91                    struct rs_connection **conn,
  92                    const char *config);
  93 void rs_conn_set_type(struct rs_connection *conn, rs_conn_type_t type);
  94 int rs_conn_add_listener(struct rs_connection *conn,
  95                          rs_conn_type_t type,
  96                          const char *hostname,
  97                          int port);
  98 int rs_conn_disconnect (struct rs_connection *conn);
  99 int rs_conn_destroy(struct rs_connection *conn);
 100 int rs_conn_set_eventbase(struct rs_connection *conn, struct event_base *eb);
 101 void rs_conn_set_callbacks(struct rs_connection *conn,
 102                            struct rs_conn_callbacks *cb);
 103 void rs_conn_del_callbacks(struct rs_connection *conn);
 104 struct rs_conn_callbacks *rs_conn_get_callbacks(struct rs_connection *conn);
 105 int rs_conn_select_server(struct rs_connection *conn, const char *name);
 106 int rs_conn_get_current_server(struct rs_connection *conn,
 107                                const char *name,
 108                                size_t buflen);
 109 int rs_conn_receive_packet(struct rs_connection *conn,
 110                            struct rs_packet *request,
 111                            struct rs_packet **pkt_out);
 112 int rs_conn_fd(struct rs_connection *conn);
 113
 114 /* Peers.  */
 115 int rs_peer_create(struct rs_connection *conn, struct rs_peer **peer_out);
 116 int rs_peer_set_address(struct rs_peer *peer, const char *hostname,
 117                         const char *service);
 118 int rs_peer_set_secret(struct rs_peer *peer, const char *secret);
 119 void rs_peer_set_timeout(struct rs_peer *peer, int timeout);
 120 void rs_peer_set_retries(struct rs_peer *peer, int retries);
 121
 122 /* Packet.  */
 123 int rs_packet_create(struct rs_connection *conn, struct rs_packet **pkt_out);
 124 void rs_packet_destroy(struct rs_packet *pkt);
 125 void rs_packet_add_attr(struct rs_packet *pkt, struct rs_attr *attr);
 126 int rs_packet_send(struct rs_packet *pkt, void *data);
 127 struct radius_packet *rs_packet_frpkt(struct rs_packet *pkt);
 128 int rs_packet_create_auth_request(struct rs_connection *conn,
 129                                   struct rs_packet **pkt,
 130                                   const char *user_name,
 131                                   const char *user_pw);
 132
 133 /* Attribute.  */
 134 /* FIXME: Replace (or complement) with a wrapper for paircreate().  */
 135 int rs_attr_create(struct rs_connection *conn,
 136                    struct rs_attr **attr,
 137                    const char *type,
 138                    const char *val);
 139 void rs_attr_destroy(struct rs_attr *attr);
 140
 141 /* Config.  */
 142 struct rs_realm *rs_conf_find_realm(struct rs_context *ctx, const char *name);
 143
 144 /* Error.  */
 145 int rs_err_ctx_push(struct rs_context *ctx, int code, const char *fmt, ...);
 146 int rs_err_ctx_push_fl(struct rs_context *ctx,
 147                        int code,
 148                        const char *file,
 149                        int line,
 150                        const char *fmt,
 151                        ...);
 152 struct rs_error *rs_err_ctx_pop(struct rs_context *ctx);
 153 int rs_err_conn_push(struct rs_connection *conn,
 154                      int code,
 155                      const char *fmt,
 156                      ...);
 157 int rs_err_conn_push_fl(struct rs_connection *conn,
 158                         int code,
 159                         const char *file,
 160                         int line,
 161                         const char *fmt,
 162                         ...);
 163 struct rs_error *rs_err_conn_pop(struct rs_connection *conn);
 164 int rs_err_conn_peek_code (struct rs_connection *conn);
 165 void rs_err_free(struct rs_error *err);
 166 char *rs_err_msg(struct rs_error *err, int dofree_flag);
 167 int rs_err_code(struct rs_error *err, int dofree_flag);
 168
 169 #if defined (__cplusplus)
 170 }
 171 #endif
 172
 173 /* Local Variables: */
 174 /* c-file-style: "stroustrup" */
 175 /* End: */