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