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_SOME_ERROR = 21,  /* Unspecified error.  Shouldn't happen.  */
  25 };
  26
  27 enum rs_conn_type {
  28     RS_CONN_TYPE_NONE = 0,
  29     RS_CONN_TYPE_UDP,
  30     RS_CONN_TYPE_TCP,
  31     RS_CONN_TYPE_TLS,
  32     RS_CONN_TYPE_DTLS,
  33 };
  34 typedef unsigned int rs_conn_type_t;
  35
  36
  37 #if defined (__cplusplus)
  38 extern "C" {
  39 #endif
  40
  41 /* Data types.  */
  42 struct rs_context;              /* radsec-impl.h */
  43 struct rs_connection;           /* radsec-impl.h */
  44 struct rs_packet;               /* radsec-impl.h */
  45 struct rs_conn;                 /* radsec-impl.h */
  46 struct rs_attr;                 /* radsec-impl.h */
  47 struct rs_error;                /* radsec-impl.h */
  48 struct rs_peer;                 /* radsec-impl.h */
  49 struct radius_packet;           /* <freeradius/libradius.h> */
  50 struct event_base;              /* <event2/event-internal.h> */
  51
  52 typedef void *(*rs_calloc_fp) (size_t nmemb, size_t size);
  53 typedef void *(*rs_malloc_fp) (size_t size);
  54 typedef void (*rs_free_fp) (void *ptr);
  55 typedef void *(*rs_realloc_fp) (void *ptr, size_t size);
  56 struct rs_alloc_scheme {
  57     rs_calloc_fp calloc;
  58     rs_malloc_fp malloc;
  59     rs_free_fp free;
  60     rs_realloc_fp realloc;
  61 };
  62
  63 typedef void (*rs_conn_connected_cb) (void *user_data /* FIXME: peer? */ );
  64 typedef void (*rs_conn_disconnected_cb) (void *user_data
  65                                          /* 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,
  88                            const char *config_file);
  89
  90 /* Connection.  */
  91 int rs_conn_create(struct rs_context *ctx, 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, rs_conn_type_t type,
  95                          const char *hostname, int port);
  96 int rs_conn_disconnect (struct rs_connection *conn);
  97 int rs_conn_destroy(struct rs_connection *conn);
  98 int rs_conn_set_eventbase(struct rs_connection *conn,
  99                           struct event_base *eb);
 100 void rs_conn_set_callbacks(struct rs_connection *conn,
 101                           struct rs_conn_callbacks *cb);
 102 void rs_conn_del_callbacks(struct rs_connection *conn);
 103 struct rs_conn_callbacks *rs_conn_get_callbacks(struct rs_connection *conn);
 104 int rs_conn_select_server(struct rs_connection *conn, const char *name);
 105 int rs_conn_get_current_server(struct rs_connection *conn,
 106                                const char *name, size_t buflen);
 107 int rs_conn_receive_packet(struct rs_connection *conn,
 108                            struct rs_packet *request,
 109                            struct rs_packet **pkt_out);
 110 int rs_conn_fd(struct rs_connection *conn);
 111
 112 /* Server and client.  */
 113 int rs_server_create(struct rs_connection *conn, struct rs_peer **server);
 114 int rs_server_set_address(struct rs_peer *server, const char *hostname,
 115                           const char *service);
 116 int rs_server_set_secret(struct rs_peer *server, const char *secret);
 117 void rs_server_set_timeout(struct rs_peer *server, int timeout);
 118 void rs_server_set_tries(struct rs_peer *server, int tries);
 119
 120 /* Packet.  */
 121 int rs_packet_create(struct rs_connection *conn, struct rs_packet **pkt_out);
 122 int rs_packet_create_auth_request(struct rs_connection *conn,
 123                                   struct rs_packet **pkt,
 124                                   const char *user_name, /* FIXME: remove? */
 125                                   const char *user_pw); /* FIXME: remove? */
 126 void rs_packet_add_attr(struct rs_packet *pkt, struct rs_attr *attr);
 127 int rs_packet_send(struct rs_packet *pkt, void *data);
 128 struct radius_packet *rs_packet_frpkt(struct rs_packet *pkt);
 129 void rs_packet_destroy(struct rs_packet *pkt);
 130
 131 /* Attribute.  */
 132 /* FIXME: Replace (or complement) with a wrapper for paircreate().  */
 133 int rs_attr_create(struct rs_connection *conn, struct rs_attr **attr,
 134                    const char *type, const char *val);
 135 void rs_attr_destroy(struct rs_attr *attr);
 136
 137 /* Config.  */
 138 struct rs_realm *rs_conf_find_realm(struct rs_context *ctx,
 139                                     const char *name);
 140
 141 /* Error.  */
 142 int rs_err_ctx_push(struct rs_context *ctx, int code, const char *fmt,
 143                     ...);
 144 int rs_err_ctx_push_fl(struct rs_context *ctx, int code, const char *file,
 145                        int line, const char *fmt, ...);
 146 struct rs_error *rs_err_ctx_pop(struct rs_context *ctx);
 147 int rs_err_conn_push(struct rs_connection *conn, int code, const char *fmt,
 148                      ...);
 149 int rs_err_conn_push_fl(struct rs_connection *conn, int code,
 150                         const char *file, int line, const char *fmt, ...);
 151 struct rs_error *rs_err_conn_pop(struct rs_connection *conn);
 152 void rs_err_free(struct rs_error *err);
 153 char *rs_err_msg(struct rs_error *err, int dofree_flag);
 154 int rs_err_code(struct rs_error *err, int dofree_flag);
 155
 156 #if defined (__cplusplus)
 157 }
 158 #endif
 159
 160 /* Local Variables: */
 161 /* c-file-style: "stroustrup" */
 162 /* End: */