e487064bb92e32f0139c33689f5563667d5208b5
[radsecproxy.git] / lib / libradsec.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_SOME_ERROR = 21,
20 };
21
22 enum rs_conn_type {
23     RS_CONN_TYPE_NONE = 0,
24     RS_CONN_TYPE_UDP,
25     RS_CONN_TYPE_TCP,
26     RS_CONN_TYPE_TLS,
27     RS_CONN_TYPE_DTLS,
28 };
29 typedef unsigned int rs_conn_type_t;
30
31
32 /* Data types.  */
33 struct rs_handle;               /* radsec-impl.h */
34 struct rs_connection;           /* radsec-impl.h */
35 struct rs_packet;               /* radsec-impl.h */
36 struct rs_conn;                 /* radsec-impl.h */
37 struct rs_attr;                 /* radsec-impl.h */
38 struct rs_error;                /* radsec-impl.h */
39 struct rs_peer;                 /* radsec-impl.h */
40 struct event_base;              /* <event.h> */
41
42 typedef void * (*rs_calloc_fp)(size_t nmemb, size_t size);
43 typedef void * (*rs_malloc_fp)(size_t size);
44 typedef void (*rs_free_fp)(void *ptr);
45 typedef void * (*rs_realloc_fp)(void *ptr, size_t size);
46 struct rs_alloc_scheme {
47     rs_calloc_fp calloc;
48     rs_malloc_fp malloc;
49     rs_free_fp free;
50     rs_realloc_fp realloc;
51 };
52
53 typedef void (*rs_conn_connected_cb)(void *user_data /* FIXME: peer? */);
54 typedef void (*rs_conn_disconnected_cb)(void *user_data /* FIXME: reason? */);
55 typedef void (*rs_conn_packet_received_cb)(const struct rs_packet *packet,
56                                            void *user_data);
57 typedef void (*rs_conn_packet_sent_cb)(void *user_data);
58 struct rs_conn_callbacks {
59     /** Callback invoked when the connection has been established.  */
60     rs_conn_connected_cb connected_cb;
61     /** Callback invoked when the connection has been torn down.  */
62     rs_conn_disconnected_cb disconnected_cb;
63     /** Callback invoked when a packet was received.  */
64     rs_conn_packet_received_cb received_cb;
65     /** Callback invoked when a packet was successfully sent.  */
66     rs_conn_packet_sent_cb sent_cb;
67 };
68
69
70 /* Function prototypes.  */
71 /* Context.  */
72 int rs_context_create(struct rs_handle **ctx, const char *dict);
73 void rs_context_destroy(struct rs_handle *ctx);
74 int rs_context_set_alloc_scheme(struct rs_handle *ctx, struct rs_alloc_scheme *scheme);
75 int rs_context_config_read(struct rs_handle *ctx, const char *config_file);
76
77 /* Connection.  */
78 int rs_conn_create(struct rs_handle *ctx, struct rs_connection **conn);
79 int rs_conn_add_server(struct rs_connection *conn, struct rs_peer **server, rs_conn_type_t type, const char *hostname, int port);
80 int rs_conn_add_listener(struct rs_connection  *conn, rs_conn_type_t type, const char *hostname, int port);
81 void rs_conn_destroy(struct rs_connection *conn);
82 int rs_conn_set_eventbase(struct rs_connection *conn, struct event_base *eb);
83 int rs_conn_set_callbacks(struct rs_connection *conn, struct rs_conn_callbacks *cb);
84 int rs_conn_select_server(struct rs_connection *conn, const char *name);
85 int rs_conn_get_current_server(struct rs_connection *conn, const char *name, size_t buflen);
86
87 /* Server and client configuration.  */
88 void rs_server_set_timeout(struct rs_peer *server, int timeout);
89 void rs_server_set_tries(struct rs_peer *server, int tries);
90 int rs_server_set_secret(struct rs_peer *server, const char *secret);
91
92 /* Packet.  */
93 int rs_packet_create_acc_request(struct rs_connection *conn, struct rs_packet **pkt, const char *user_name, const char *user_pw);
94 //int rs_packet_create_acc_accept(cstruct rs_connection *conn, struct rs_packet **pkt);
95 //int rs_packet_create_acc_reject(struct rs_connection *conn, struct rs_packet **pkt);
96 //int rs_packet_create_acc_challenge(struct rs_connection *conn, struct rs_packet **pkt);
97 void rs_packet_destroy(struct rs_packet *pkt);
98 void rs_packet_add_attr(struct rs_packet *pkt, struct rs_attr *attr);
99 int rs_packet_send(struct rs_connection *conn, struct rs_packet *pkt, void *data);
100 int rs_packet_receive(struct rs_connection *conn, struct rs_packet **pkt_out);
101
102 /* Attribute.  */
103 int rs_attr_create(struct rs_connection *conn, struct rs_attr **attr, const char *type, const char *val);
104 void rs_attr_destroy(struct rs_attr *attr);
105
106 /* Error.  */
107 int rs_ctx_err_push(struct rs_handle *ctx, int code, const char *fmt, ...);
108 int rs_ctx_err_push_fl(struct rs_handle *ctx, int code, const char *file, int line, const char *fmt, ...);
109 struct rs_error *rs_ctx_err_pop (struct rs_handle *ctx);
110 int rs_conn_err_push(struct rs_connection *conn, int code, const char *fmt, ...);
111 int rs_conn_err_push_fl(struct rs_connection *conn, int code, const char *file, int line, const char *fmt, ...);
112 struct rs_error *rs_conn_err_pop (struct rs_connection *conn);
113 void rs_err_free(struct rs_error *err);
114 char *rs_err_msg(struct rs_error *err, int dofree_flag);
115 int rs_err_code(struct rs_error *err, int dofree_flag);
116
117 /* Local Variables: */
118 /* c-file-style: "stroustrup" */
119 /* End: */