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