WIP
[radsecproxy.git] / lib / libradsec.h
index 9d9ee9c..e487064 100644 (file)
@@ -1,24 +1,22 @@
-/*! \file libradsec.h
-  \brief Header file for libradsec.  */
-
-/* FIXME: License blurb goes here.  */
-
-#include <stdint.h>
-#include <sys/socket.h>
-#include "../list.h"
-
-
-/* Data types.  */
-
-enum rs_cred_type {
-    RS_CRED_NONE = 0,
-    RS_CRED_TLS_PSK_RSA,       /* RFC 4279.  */
-};
-
-struct rs_credentials {
-    enum rs_cred_type type;
-    char *identity;
-    char *secret;              /* Passphrase or PSK.  */
+/** @file libradsec.h
+    @brief Header file for libradsec.  */
+/* See the file COPYING for licensing information.  */
+
+#include <unistd.h>
+
+enum rs_err_code {
+    RSE_OK = 0,
+    RSE_NOMEM = 1,
+    RSE_NOSYS = 2,
+    RSE_INVALID_CTX = 3,
+    RSE_INVALID_CONN = 4,
+    RSE_CONN_TYPE_MISMATCH = 5,
+    RSE_FR = 6,
+    RSE_BADADDR = 7,
+    RSE_NOPEER = 8,
+    RSE_EVENT = 9,
+    RSE_CONNERR = 10,
+    RSE_SOME_ERROR = 21,
 };
 
 enum rs_conn_type {
@@ -28,120 +26,93 @@ enum rs_conn_type {
     RS_CONN_TYPE_TLS,
     RS_CONN_TYPE_DTLS,
 };
-struct rs_conn {
-    enum rs_conn_type type;
-    struct rs_credentials transport_credentials;
-    struct sockaddr_storage addr;
-    char open_flag;
-};
+typedef unsigned int rs_conn_type_t;
 
-struct rs_attribute {
-    uint8_t type;
-    uint8_t lenght;
-    uint8_t *value;
-};
 
-struct rs_packet {
-    uint8_t code;
-    uint8_t id;
-    uint8_t auth[16];
-    struct list *attrs;
+/* Data types.  */
+struct rs_handle;              /* radsec-impl.h */
+struct rs_connection;          /* radsec-impl.h */
+struct rs_packet;              /* radsec-impl.h */
+struct rs_conn;                        /* radsec-impl.h */
+struct rs_attr;                        /* radsec-impl.h */
+struct rs_error;               /* radsec-impl.h */
+struct rs_peer;                        /* radsec-impl.h */
+struct event_base;             /* <event.h> */
+
+typedef void * (*rs_calloc_fp)(size_t nmemb, size_t size);
+typedef void * (*rs_malloc_fp)(size_t size);
+typedef void (*rs_free_fp)(void *ptr);
+typedef void * (*rs_realloc_fp)(void *ptr, size_t size);
+struct rs_alloc_scheme {
+    rs_calloc_fp calloc;
+    rs_malloc_fp malloc;
+    rs_free_fp free;
+    rs_realloc_fp realloc;
 };
 
-
 typedef void (*rs_conn_connected_cb)(void *user_data /* FIXME: peer? */);
 typedef void (*rs_conn_disconnected_cb)(void *user_data /* FIXME: reason? */);
 typedef void (*rs_conn_packet_received_cb)(const struct rs_packet *packet,
                                           void *user_data);
 typedef void (*rs_conn_packet_sent_cb)(void *user_data);
-
-/*! Connection callbacks.  */
 struct rs_conn_callbacks {
-    /*! Callback invoked when the connection has been established.  */
+    /** Callback invoked when the connection has been established.  */
     rs_conn_connected_cb connected_cb;
-    /*! Callback invoked when the connection has been torn down.  */
+    /** Callback invoked when the connection has been torn down.  */
     rs_conn_disconnected_cb disconnected_cb;
-    /*! Callback invoked when a packet was received.  */
+    /** Callback invoked when a packet was received.  */
     rs_conn_packet_received_cb received_cb;
-    /*! Callback invoked when a packet was successfully sent.  */
+    /** Callback invoked when a packet was successfully sent.  */
     rs_conn_packet_sent_cb sent_cb;
 };
 
 
 /* Function prototypes.  */
-
-/*
-  FIXME: Do we want alloc and free?  Or perhaps init and free,
-  decoupling allocation from initialization?  IMO we want _some_ init
-  function, f.ex. for setting open_flag = 1 when type == UDP.
-
-struct conn *conn_alloc (enum conn_type type, struct sockaddr_in6 address, ...);
-void conn_free (struct conn *conn);
-*/
-
-/*! Open connection and return 0 on success.
-    \param conn Connection object, obtained through a call to \a
-    conn_alloc.
-    \param cb Callbacks for events on the connection.  If NULL, all I/O
-    will be blocking.
-    \param user_data A pointer passed to the callbacks when invoked.  */
-int rs_conn_open(struct rs_conn *conn,
-                const struct rs_conn_callbacks *cb,
-                void *user_data);
-
-/*! Close connection and return 0 on success.
-    \param conn Connection object, obtained through a call to \a
-    conn_alloc.
-    \param user_data A pointer passed to the callbacks when the \a
-    disconnected_cb in \a conn is invoked.  */
-int rs_conn_close(struct rs_conn *conn, void *user_data); /* FIXME: return type?  */
-
-/*! Allocate a packet object.  Should be freed using \a rs_packet_free.  */
-struct rs_packet *rs_packet_alloc();
-
-/*! Free a packet object previously allocated with \a rs_packet_alloc.  */
-void rs_packet_free();
-
-/*! Add an attribute to a packet.
-    \param packet The packet.
-    \param attribute Attribute to add to packet.  */
-int rs_packet_add_attribute(struct rs_packet *packet,
-                           const struct rs_attribute *attribute);
-
-/*! Send \a packet on \a conn and return 0 on success.
-    \param conn Connection object, obtained through a call to \a
-    conn_alloc and opened with \a rs_conn_open.
-    \param packet Packet to send.
-    \param user_data Pointer passed to \a rs_conn_packet_sent_cb, invoked
-    when packet has been sent.
- */
-int rs_packet_send(const struct rs_conn *conn,
-                  const struct rs_packet *packet,
-                  void *user_data);
-
-/*! Return the next packet received on \a conn, blocking while waiting.
-  The packet returned must be freed using \a rs_packet_free.  */
-struct rs_packet *rs_packet_receive(const struct rs_conn *conn);
-
-
-/* Thinking out loud here...
-
-   We could let the user drive the underlying libevent event loop in
-   three different ways, from easiest to hairiest:
-
-   i) Blocking i/o model: User passes NULL for the callbacks in
-   rs_conn_open() and the open, send and receive calls will block
-   until the wanted event occurs.  Other events occurring while
-   waiting will be either silently discarded or signaled as an error
-   (f.ex. broken connection while sending).
-
-   ii) Simple interface with a timeout: User calls
-   rs_event_loop(timeout) to process pending i/o.
-
-   iii) full libevent interface: TODO.
- */
-#error "need an rs_event_loop() and more"
-
+/* Context.  */
+int rs_context_create(struct rs_handle **ctx, const char *dict);
+void rs_context_destroy(struct rs_handle *ctx);
+int rs_context_set_alloc_scheme(struct rs_handle *ctx, struct rs_alloc_scheme *scheme);
+int rs_context_config_read(struct rs_handle *ctx, const char *config_file);
+
+/* Connection.  */
+int rs_conn_create(struct rs_handle *ctx, struct rs_connection **conn);
+int rs_conn_add_server(struct rs_connection *conn, struct rs_peer **server, rs_conn_type_t type, const char *hostname, int port);
+int rs_conn_add_listener(struct rs_connection  *conn, rs_conn_type_t type, const char *hostname, int port);
+void rs_conn_destroy(struct rs_connection *conn);
+int rs_conn_set_eventbase(struct rs_connection *conn, struct event_base *eb);
+int rs_conn_set_callbacks(struct rs_connection *conn, struct rs_conn_callbacks *cb);
+int rs_conn_select_server(struct rs_connection *conn, const char *name);
+int rs_conn_get_current_server(struct rs_connection *conn, const char *name, size_t buflen);
+
+/* Server and client configuration.  */
+void rs_server_set_timeout(struct rs_peer *server, int timeout);
+void rs_server_set_tries(struct rs_peer *server, int tries);
+int rs_server_set_secret(struct rs_peer *server, const char *secret);
+
+/* Packet.  */
+int rs_packet_create_acc_request(struct rs_connection *conn, struct rs_packet **pkt, const char *user_name, const char *user_pw);
+//int rs_packet_create_acc_accept(cstruct rs_connection *conn, struct rs_packet **pkt);
+//int rs_packet_create_acc_reject(struct rs_connection *conn, struct rs_packet **pkt);
+//int rs_packet_create_acc_challenge(struct rs_connection *conn, struct rs_packet **pkt);
+void rs_packet_destroy(struct rs_packet *pkt);
+void rs_packet_add_attr(struct rs_packet *pkt, struct rs_attr *attr);
+int rs_packet_send(struct rs_connection *conn, struct rs_packet *pkt, void *data);
+int rs_packet_receive(struct rs_connection *conn, struct rs_packet **pkt_out);
+
+/* Attribute.  */
+int rs_attr_create(struct rs_connection *conn, struct rs_attr **attr, const char *type, const char *val);
+void rs_attr_destroy(struct rs_attr *attr);
+
+/* Error.  */
+int rs_ctx_err_push(struct rs_handle *ctx, int code, const char *fmt, ...);
+int rs_ctx_err_push_fl(struct rs_handle *ctx, int code, const char *file, int line, const char *fmt, ...);
+struct rs_error *rs_ctx_err_pop (struct rs_handle *ctx);
+int rs_conn_err_push(struct rs_connection *conn, int code, const char *fmt, ...);
+int rs_conn_err_push_fl(struct rs_connection *conn, int code, const char *file, int line, const char *fmt, ...);
+struct rs_error *rs_conn_err_pop (struct rs_connection *conn);
+void rs_err_free(struct rs_error *err);
+char *rs_err_msg(struct rs_error *err, int dofree_flag);
+int rs_err_code(struct rs_error *err, int dofree_flag);
 
 /* Local Variables: */
 /* c-file-style: "stroustrup" */