2 \brief Public interface for libradsec. */
4 /* See LICENSE for licensing information. */
6 #ifndef _RADSEC_RADSEC_H_
7 #define _RADSEC_RADSEC_H_ 1
12 #ifdef HAVE_SYS_TIME_H
15 #ifdef HAVE_ARPA_INET_H
16 #include <arpa/inet.h>
31 RSE_CONN_TYPE_MISMATCH = 5,
35 RSE_EVENT = 9, /* libevent error. */
40 RSE_SSLERR = 14, /* OpenSSL error. */
42 RSE_TIMEOUT_CONN = 16, /* Connection timeout. */
43 RSE_INVAL = 17, /* Invalid argument. */
44 RSE_TIMEOUT_IO = 18, /* I/O timeout. */
45 RSE_TIMEOUT = 19, /* High level timeout. */
48 RSE_PACKET_TOO_SMALL = 22,
49 RSE_PACKET_TOO_LARGE = 23,
50 RSE_ATTR_OVERFLOW = 24,
51 RSE_ATTR_TOO_SMALL = 25,
52 RSE_ATTR_TOO_LARGE = 26,
53 RSE_ATTR_UNKNOWN = 27,
54 RSE_ATTR_BAD_NAME = 28,
55 RSE_ATTR_VALUE_MALFORMED = 29,
56 RSE_ATTR_INVALID = 30,
57 RSE_TOO_MANY_ATTRS = 31,
58 RSE_ATTR_TYPE_UNKNOWN = 32,
59 RSE_MSG_AUTH_LEN = 33,
60 RSE_MSG_AUTH_WRONG = 34,
61 RSE_REQUEST_REQUIRED = 35,
62 RSE_INVALID_REQUEST_CODE = 36,
63 RSE_AUTH_VECTOR_WRONG = 37,
64 RSE_INVALID_RESPONSE_CODE = 38,
65 RSE_INVALID_RESPONSE_ID = 39,
66 RSE_INVALID_RESPONSE_SRC = 40,
67 RSE_NO_PACKET_DATA = 41,
68 RSE_VENDOR_UNKNOWN = 42,
75 RS_CONN_TYPE_NONE = 0,
81 typedef unsigned int rs_conn_type_t;
83 typedef enum rs_attr_type_t {
84 RS_TYPE_INVALID = 0, /**< Invalid data type */
85 RS_TYPE_STRING, /**< printable-text */
86 RS_TYPE_INTEGER, /**< a 32-bit unsigned integer */
87 RS_TYPE_IPADDR, /**< an IPv4 address */
88 RS_TYPE_DATE, /**< a 32-bit date, of seconds since January 1, 1970 */
89 RS_TYPE_OCTETS, /**< a sequence of binary octets */
90 RS_TYPE_IFID, /**< an Interface Id */
91 RS_TYPE_IPV6ADDR, /**< an IPv6 address */
92 RS_TYPE_IPV6PREFIX, /**< an IPv6 prefix */
93 RS_TYPE_BYTE, /**< an 8-bit integer */
94 RS_TYPE_SHORT, /**< a 16-bit integer */
97 #define PW_ACCESS_REQUEST 1
98 #define PW_ACCESS_ACCEPT 2
99 #define PW_ACCESS_REJECT 3
100 #define PW_ACCOUNTING_REQUEST 4
101 #define PW_ACCOUNTING_RESPONSE 5
102 #define PW_ACCOUNTING_STATUS 6
103 #define PW_PASSWORD_REQUEST 7
104 #define PW_PASSWORD_ACK 8
105 #define PW_PASSWORD_REJECT 9
106 #define PW_ACCOUNTING_MESSAGE 10
107 #define PW_ACCESS_CHALLENGE 11
108 #define PW_STATUS_SERVER 12
109 #define PW_STATUS_CLIENT 13
110 #define PW_DISCONNECT_REQUEST 40
111 #define PW_DISCONNECT_ACK 41
112 #define PW_DISCONNECT_NAK 42
113 #define PW_COA_REQUEST 43
114 #define PW_COA_ACK 44
115 #define PW_COA_NAK 45
117 #if defined (__cplusplus)
121 #define rs_packet rs_message
122 #define rs_conn_packet_received_cb rs_conn_message_received_cb
123 #define rs_conn_packet_sent_cb rs_conn_message_sent_cb
124 #define rs_conn_receive_packet rs_conn_receive_message
127 struct rs_context; /* radsec-impl.h */
128 struct rs_connection; /* radsec-impl.h */
129 struct rs_message; /* radsec-impl.h */
130 struct rs_conn; /* radsec-impl.h */
131 struct rs_error; /* radsec-impl.h */
132 struct rs_peer; /* radsec-impl.h */
133 struct radius_packet; /* <radius/client.h> */
134 struct value_pair; /* <radius/client.h> */
135 struct event_base; /* <event2/event-internal.h> */
137 typedef void *(*rs_calloc_fp) (size_t nmemb, size_t size);
138 typedef void *(*rs_malloc_fp) (size_t size);
139 typedef void (*rs_free_fp) (void *ptr);
140 typedef void *(*rs_realloc_fp) (void *ptr, size_t size);
141 struct rs_alloc_scheme {
145 rs_realloc_fp realloc;
148 typedef void (*rs_conn_connected_cb) (void *user_data /* FIXME: peer? */ );
149 typedef void (*rs_conn_disconnected_cb) (void *user_data /* FIXME: reason? */ );
150 typedef void (*rs_conn_message_received_cb) (struct rs_message *message,
152 typedef void (*rs_conn_message_sent_cb) (void *user_data);
153 struct rs_conn_callbacks {
154 /** Callback invoked when the connection has been established. */
155 rs_conn_connected_cb connected_cb;
156 /** Callback invoked when the connection has been torn down. */
157 rs_conn_disconnected_cb disconnected_cb;
158 /** Callback invoked when a message was received. */
159 rs_conn_packet_message_cb received_cb;
160 /** Callback invoked when a message was successfully sent. */
161 rs_conn_message_sent_cb sent_cb;
164 typedef struct value_pair rs_avp;
165 typedef const struct value_pair rs_const_avp;
167 /* Function prototypes. */
172 /** Create a context. Freed by calling \a rs_context_destroy. Note
173 that the context must not be freed before all other libradsec
174 objects have been freed.
176 \a ctx Address of pointer to a struct rs_context. This is the
177 output of this function.
179 \return RSE_OK (0) on success or RSE_NOMEM on out of memory. */
180 int rs_context_create(struct rs_context **ctx);
182 /** Free a context. Note that the context must not be freed before
183 all other libradsec objects have been freed. */
184 void rs_context_destroy(struct rs_context *ctx);
186 /** Set allocation scheme to use. \a scheme is the allocation scheme
187 to use, see \a rs_alloc_scheme. \return On success, RSE_OK (0) is
188 returned. On error, !0 is returned and a struct \a rs_error is
189 pushed on the error stack for the context. The error can be
190 accessed using \a rs_err_ctx_pop. */
191 int rs_context_set_alloc_scheme(struct rs_context *ctx,
192 struct rs_alloc_scheme *scheme);
194 /** Read configuration file. \a config_file is the path of the
195 configuration file to read. \return On success, RSE_OK (0) is
196 returned. On error, !0 is returned and a struct \a rs_error is
197 pushed on the error stack for the context. The error can be
198 accessed using \a rs_err_ctx_pop. */
199 int rs_context_read_config(struct rs_context *ctx, const char *config_file);
204 /** Create a connection. \a conn is the address of a pointer to an \a
205 rs_connection, the output. Free the connection using \a
206 rs_conn_destroy. Note that a connection must not be freed before
207 all messages associated with the connection have been freed. A
208 message is associated with a connection when it's created
209 (\a rs_message_create) or received (\a rs_conn_receive_message).
211 If \a config is not NULL it should be the name of a realm found in
212 a config file that has already been read using \a
213 rs_context_read_config.
215 \return On success, RSE_OK (0) is returned. On error, !0 is
216 returned and a struct \a rs_error is pushed on the error stack for
217 the context. The error can be accessed using \a
219 int rs_conn_create(struct rs_context *ctx,
220 struct rs_connection **conn,
223 /** Not implemented. */
224 int rs_conn_add_listener(struct rs_connection *conn,
226 const char *hostname,
228 /** Disconnect connection \a conn. \return RSE_OK (0) on success, !0
229 * on error. On error, errno is set appropriately. */
230 int rs_conn_disconnect (struct rs_connection *conn);
232 /** Disconnect and free memory allocated for connection \a conn. Note
233 that a connection must not be freed before all messages associated
234 with the connection have been freed. A message is associated with
235 a connection when it's created (\a rs_message_create) or received
236 (\a rs_conn_receive_message). \return RSE_OK (0) on success, !0 *
237 on error. On error, errno is set appropriately. */
238 int rs_conn_destroy(struct rs_connection *conn);
240 /** Set connection type for \a conn. */
241 void rs_conn_set_type(struct rs_connection *conn, rs_conn_type_t type);
243 /** Not implemented. */
244 int rs_conn_set_eventbase(struct rs_connection *conn, struct event_base *eb);
246 /** Register callbacks \a cb for connection \a conn. */
247 void rs_conn_set_callbacks(struct rs_connection *conn,
248 struct rs_conn_callbacks *cb);
250 /** Remove callbacks for connection \a conn. */
251 void rs_conn_del_callbacks(struct rs_connection *conn);
253 /** Return callbacks registered for connection \a conn. \return
254 Installed callbacks are returned. */
255 struct rs_conn_callbacks *rs_conn_get_callbacks(struct rs_connection *conn);
257 /** Not implemented. */
258 int rs_conn_select_peer(struct rs_connection *conn, const char *name);
260 /** Not implemented. */
261 int rs_conn_get_current_peer(struct rs_connection *conn,
265 /** Special function used in blocking mode, i.e. with no callbacks
266 registered. For any other use of libradsec, a \a received_cb
267 callback should be registered using \a rs_conn_set_callbacks.
269 If \a req_msg is not NULL, a successfully received RADIUS message
270 is verified against it. If \a pkt_out is not NULL it will upon
271 return contain a pointer to an \a rs_message containing the new
274 \return On error or if the connect (TCP only) or read times out,
275 \a pkt_out will not be changed and one or more errors are pushed
276 on \a conn (available through \a rs_err_conn_pop). */
277 int rs_conn_receive_message(struct rs_connection *conn,
278 struct rs_message *request,
279 struct rs_message **pkt_out);
281 /** Get the file descriptor associated with connection \a conn.
282 * \return File descriptor. */
283 int rs_conn_fd(struct rs_connection *conn);
285 /** Set the timeout value for connection \a conn. */
286 void rs_conn_set_timeout(struct rs_connection *conn, struct timeval *tv);
288 /* Peer -- client and server. */
289 int rs_peer_create(struct rs_connection *conn, struct rs_peer **peer_out);
290 int rs_peer_set_address(struct rs_peer *peer,
291 const char *hostname,
292 const char *service);
293 int rs_peer_set_secret(struct rs_peer *peer, const char *secret);
294 void rs_peer_set_timeout(struct rs_peer *peer, int timeout);
295 void rs_peer_set_retries(struct rs_peer *peer, int retries);
300 /** Create a packet associated with connection \a conn. */
301 int rs_packet_create(struct rs_connection *conn, struct rs_packet **pkt_out);
303 /** Free all memory allocated for packet \a pkt. */
304 void rs_packet_destroy(struct rs_packet *pkt);
306 /** Send packet \a pkt on the connection associated with \a pkt. \a
307 user_data is sent to the \a rs_conn_packet_received_cb callback
308 registered with the connection. If no callback is registered with
309 the connection, the event loop is run by \a rs_packet_send and it
310 blocks until the packet has been succesfully sent.
312 \return On success, RSE_OK (0) is returned. On error, !0 is
313 returned and a struct \a rs_error is pushed on the error stack for
314 the connection. The error can be accessed using \a
316 int rs_packet_send(struct rs_packet *pkt, void *user_data);
318 /** Create a RADIUS authentication request packet associated with
319 connection \a conn. Optionally, User-Name and User-Password
320 attributes are added to the packet using the data in \a user_name,
321 \a user_pw and \a secret where \secret is the RADIUS shared
323 int rs_packet_create_authn_request(struct rs_connection *conn,
324 struct rs_packet **pkt,
325 const char *user_name,
329 /*** Append \a tail to packet \a pkt. */
331 rs_packet_append_avp(struct rs_packet *pkt,
332 unsigned int attribute, unsigned int vendor,
333 const void *data, size_t data_len);
335 /*** Get pointer to \a pkt attribute value pairs. */
337 rs_packet_avps(struct rs_packet *pkt, rs_avp ***vps);
339 /*** Get RADIUS packet type of \a pkt. */
341 rs_packet_code(struct rs_packet *pkt);
343 /*** Get RADIUS AVP from \a pkt. */
345 rs_packet_find_avp(struct rs_packet *pkt, unsigned int attr, unsigned int vendor);
347 /*** Set packet identifier in \a pkt; returns old identifier */
349 rs_packet_set_id (struct rs_packet *pkt, int id);
354 /** Find the realm named \a name in the configuration file previoiusly
355 read in using \a rs_context_read_config. */
356 struct rs_realm *rs_conf_find_realm(struct rs_context *ctx, const char *name);
361 /** Create a struct \a rs_error and push it on a FIFO associated with
362 context \a ctx. Note: The depth of the error stack is one (1) at
363 the moment. This will change in a future release. */
364 int rs_err_ctx_push(struct rs_context *ctx, int code, const char *fmt, ...);
365 int rs_err_ctx_push_fl(struct rs_context *ctx,
371 /** Pop the first error from the error FIFO associated with context \a
372 ctx or NULL if there are no errors in the FIFO. */
373 struct rs_error *rs_err_ctx_pop(struct rs_context *ctx);
375 /** Create a struct \a rs_error and push it on a FIFO associated with
376 connection \a conn. Note: The depth of the error stack is one (1)
377 at the moment. This will change in a future release. */
378 int rs_err_conn_push(struct rs_connection *conn,
382 int rs_err_conn_push_fl(struct rs_connection *conn,
388 /** Pop the first error from the error FIFO associated with connection
389 \a conn or NULL if there are no errors in the FIFO. */
390 struct rs_error *rs_err_conn_pop(struct rs_connection *conn);
392 int rs_err_conn_peek_code (struct rs_connection *conn);
393 void rs_err_free(struct rs_error *err);
394 char *rs_err_msg(struct rs_error *err);
395 int rs_err_code(struct rs_error *err, int dofree_flag);
400 #define rs_avp_is_string(vp) (rs_avp_typeof(vp) == RS_TYPE_STRING)
401 #define rs_avp_is_integer(vp) (rs_avp_typeof(vp) == RS_TYPE_INTEGER)
402 #define rs_avp_is_ipaddr(vp) (rs_avp_typeof(vp) == RS_TYPE_IPADDR)
403 #define rs_avp_is_date(vp) (rs_avp_typeof(vp) == RS_TYPE_DATE)
404 #define rs_avp_is_octets(vp) (rs_avp_typeof(vp) == RS_TYPE_OCTETS)
405 #define rs_avp_is_ifid(vp) (rs_avp_typeof(vp) == RS_TYPE_IFID)
406 #define rs_avp_is_ipv6addr(vp) (rs_avp_typeof(vp) == RS_TYPE_IPV6ADDR)
407 #define rs_avp_is_ipv6prefix(vp) (rs_avp_typeof(vp) == RS_TYPE_IPV6PREFIX)
408 #define rs_avp_is_byte(vp) (rs_avp_typeof(vp) == RS_TYPE_BYTE)
409 #define rs_avp_is_short(vp) (rs_avp_typeof(vp) == RS_TYPE_SHORT)
410 #define rs_avp_is_tlv(vp) (rs_avp_typeof(vp) == RS_TYPE_TLV)
412 /** The maximum length of a RADIUS attribute.
414 * The RFCs require that a RADIUS attribute transport no more than
415 * 253 octets of data. We add an extra byte for a trailing NUL, so
416 * that the VALUE_PAIR::vp_strvalue field can be handled as a C
419 #define RS_MAX_STRING_LEN 254
421 /** Free the AVP list \a vps */
423 rs_avp_free(rs_avp **vps);
425 /** Return the length of AVP \a vp in bytes */
427 rs_avp_length(rs_const_avp *vp);
429 /** Return the type of \a vp */
431 rs_avp_typeof(rs_const_avp *vp);
433 /** Retrieve the attribute and vendor ID of \a vp */
435 rs_avp_attrid(rs_const_avp *vp, unsigned int *attr, unsigned int *vendor);
437 /** Add \a vp to the list pointed to by \a head */
439 rs_avp_append(rs_avp **head, rs_avp *vp);
441 /** Find an AVP in \a vp that matches \a attr and \a vendor */
443 rs_avp_find(rs_avp *vp, unsigned int attr, unsigned int vendor);
445 /** Find an AVP in \a vp that matches \a attr and \a vendor */
447 rs_avp_find_const(rs_const_avp *vp, unsigned int attr, unsigned int vendor);
449 /** Alloc a new AVP for \a attr and \a vendor */
451 rs_avp_alloc(unsigned int attr, unsigned int vendor);
453 /** Duplicate existing AVP \a vp */
455 rs_avp_dup(rs_const_avp *vp);
457 /** Remove matching AVP from list \a vps */
459 rs_avp_delete(rs_avp **vps, unsigned int attr, unsigned int vendor);
461 /** Return next AVP in list */
463 rs_avp_next(rs_avp *vp);
465 /** Return next AVP in list */
467 rs_avp_next_const(rs_const_avp *avp);
469 /** Return string value of \a vp */
471 rs_avp_string_value(rs_const_avp *vp);
473 /** Set AVP \a vp to string \a str */
475 rs_avp_string_set(rs_avp *vp, const char *str);
477 /** Return integer value of \a vp */
479 rs_avp_integer_value(rs_const_avp *vp);
481 /** Set AVP \a vp to integer \a val */
483 rs_avp_integer_set(rs_avp *vp, uint32_t val);
485 /** Return IPv4 value of \a vp */
487 rs_avp_ipaddr_value(rs_const_avp *vp);
489 /** Set AVP \a vp to IPv4 address \a in */
491 rs_avp_ipaddr_set(rs_avp *vp, struct in_addr in);
493 /** Return POSIX time value of \a vp */
495 rs_avp_date_value(rs_const_avp *vp);
497 /** Set AVP \a vp to POSIX time \a date */
499 rs_avp_date_set(rs_avp *vp, time_t date);
501 /** Return constant pointer to octets in \a vp */
502 const unsigned char *
503 rs_avp_octets_value_const_ptr(rs_const_avp *vp);
505 /** Return pointer to octets in \a vp */
507 rs_avp_octets_value_ptr(rs_avp *vp);
509 /** Retrieve octet pointer \a p and length \a len from \a vp */
511 rs_avp_octets_value_byref(rs_avp *vp,
515 /** Copy octets from \a vp into \a buf and \a len */
517 rs_avp_octets_value(rs_const_avp *vp,
522 * Copy octets possibly fragmented across multiple VPs
523 * into \a buf and \a len
526 rs_avp_fragmented_value(rs_const_avp *vps,
530 /** Copy \a len octets in \a buf to AVP \a vp */
532 rs_avp_octets_set(rs_avp *vp,
533 const unsigned char *buf,
536 /** Return IFID value of \a vp */
538 rs_avp_ifid_value(rs_const_avp *vp, uint8_t val[8]);
541 rs_avp_ifid_set(rs_avp *vp, const uint8_t val[8]);
543 /** Return byte value of \a vp */
545 rs_avp_byte_value(rs_const_avp *vp);
547 /** Set AVP \a vp to byte \a val */
549 rs_avp_byte_set(rs_avp *vp, uint8_t val);
551 /** Return short value of \a vp */
553 rs_avp_short_value(rs_const_avp *vp);
555 /** Set AVP \a vp to short integer \a val */
557 rs_avp_short_set(rs_avp *vp, uint16_t val);
559 /** Display possibly \a canonical attribute name into \a buffer */
561 rs_attr_display_name (unsigned int attr,
567 /** Display AVP \a vp into \a buffer */
569 rs_avp_display_value(rs_const_avp *vp,
574 rs_attr_parse_name (const char *name,
576 unsigned int *vendor);
578 /** Lookup attribute \a name */
580 rs_attr_find(const char *name,
582 unsigned int *vendor);
584 /** Return dictionary name for AVP \a vp */
586 rs_avp_name(rs_const_avp *vp);
588 #if defined (__cplusplus)
592 #endif /* _RADSEC_RADSEC_H_ */
594 /* Local Variables: */
595 /* c-file-style: "stroustrup" */