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