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