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 /* Backwards compatible with 0.0.2. */
122 #define RSE_INVALID_PKT RSE_INVALID_MSG
123 #define rs_packet rs_message
124 #define rs_conn_packet_received_cb rs_conn_message_received_cb
125 #define rs_conn_packet_sent_cb rs_conn_message_sent_cb
126 #define rs_conn_receive_packet rs_conn_receive_message
127 #define rs_dump_packet rs_dump_message
128 #define rs_packet_append_avp rs_message_append_avp
129 #define rs_packet_avps rs_message_avps
130 #define rs_packet_code rs_message_code
131 #define rs_packet_create rs_message_create
132 #define rs_packet_create_authn_request rs_message_create_authn_request
133 #define rs_packet_destroy rs_message_destroy
134 #define rs_packet_send rs_message_send
137 struct rs_context; /* radsec-impl.h */
138 struct rs_connection; /* radsec-impl.h */
139 struct rs_message; /* radsec-impl.h */
140 struct rs_conn; /* radsec-impl.h */
141 struct rs_error; /* radsec-impl.h */
142 struct rs_peer; /* radsec-impl.h */
143 struct radius_packet; /* <radius/client.h> */
144 struct value_pair; /* <radius/client.h> */
145 struct event_base; /* <event2/event-internal.h> */
147 typedef void *(*rs_calloc_fp) (size_t nmemb, size_t size);
148 typedef void *(*rs_malloc_fp) (size_t size);
149 typedef void (*rs_free_fp) (void *ptr);
150 typedef void *(*rs_realloc_fp) (void *ptr, size_t size);
151 struct rs_alloc_scheme {
155 rs_realloc_fp realloc;
158 typedef void (*rs_conn_connected_cb) (void *user_data /* FIXME: peer? */ );
159 typedef void (*rs_conn_disconnected_cb) (void *user_data /* FIXME: reason? */ );
160 typedef void (*rs_conn_message_received_cb) (struct rs_message *message,
162 typedef void (*rs_conn_message_sent_cb) (void *user_data);
163 struct rs_conn_callbacks {
164 /** Callback invoked when the connection has been established. */
165 rs_conn_connected_cb connected_cb;
166 /** Callback invoked when the connection has been torn down. */
167 rs_conn_disconnected_cb disconnected_cb;
168 /** Callback invoked when a message was received. */
169 rs_conn_message_received_cb received_cb;
170 /** Callback invoked when a message was successfully sent. */
171 rs_conn_message_sent_cb sent_cb;
174 typedef struct value_pair rs_avp;
175 typedef const struct value_pair rs_const_avp;
177 /* Function prototypes. */
182 /** Create a context. Freed by calling \a rs_context_destroy. Note
183 that the context must not be freed before all other libradsec
184 objects have been freed.
186 \a ctx Address of pointer to a struct rs_context. This is the
187 output of this function.
189 \return RSE_OK (0) on success or RSE_NOMEM on out of memory. */
190 int rs_context_create(struct rs_context **ctx);
192 /** Free a context. Note that the context must not be freed before
193 all other libradsec objects have been freed. */
194 void rs_context_destroy(struct rs_context *ctx);
196 /** Set allocation scheme to use. \a scheme is the allocation scheme
197 to use, see \a rs_alloc_scheme. \return On success, RSE_OK (0) is
198 returned. On error, !0 is returned and a struct \a rs_error is
199 pushed on the error stack for the context. The error can be
200 accessed using \a rs_err_ctx_pop. */
201 int rs_context_set_alloc_scheme(struct rs_context *ctx,
202 struct rs_alloc_scheme *scheme);
204 /** Read configuration file. \a config_file is the path of the
205 configuration file to read. \return On success, RSE_OK (0) is
206 returned. On error, !0 is returned and a struct \a rs_error is
207 pushed on the error stack for the context. The error can be
208 accessed using \a rs_err_ctx_pop. */
209 int rs_context_read_config(struct rs_context *ctx, const char *config_file);
214 /** Create a connection. \a conn is the address of a pointer to an \a
215 rs_connection, the output. Free the connection using \a
216 rs_conn_destroy. Note that a connection must not be freed before
217 all messages associated with the connection have been freed. A
218 message is associated with a connection when it's created
219 (\a rs_message_create) or received (\a rs_conn_receive_message).
221 If \a config is not NULL it should be the name of a realm found in
222 a config file that has already been read using \a rs_context_read_config.
224 \return On success, RSE_OK (0) is returned. On error, !0 is
225 returned and a struct \a rs_error is pushed on the error stack for
226 the context. The error can be accessed using \a
228 int rs_conn_create(struct rs_context *ctx,
229 struct rs_connection **conn,
232 /** Not implemented. */
233 int rs_conn_add_listener(struct rs_connection *conn,
235 const char *hostname,
237 /** Disconnect connection \a conn. \return RSE_OK (0) on success, !0
238 * on error. On error, errno is set appropriately. */
239 int rs_conn_disconnect (struct rs_connection *conn);
241 /** Disconnect and free memory allocated for connection \a conn. Note
242 that a connection must not be freed before all messages associated
243 with the connection have been freed. A message is associated with
244 a connection when it's created (\a rs_message_create) or received
245 (\a rs_conn_receive_message). \return RSE_OK (0) on success, !0 *
246 on error. On error, errno is set appropriately. */
247 int rs_conn_destroy(struct rs_connection *conn);
249 /** Set connection type for \a conn. */
250 void rs_conn_set_type(struct rs_connection *conn, rs_conn_type_t type);
252 /** Not implemented. */
253 int rs_conn_set_eventbase(struct rs_connection *conn, struct event_base *eb);
255 /** Register callbacks \a cb for connection \a conn. */
256 void rs_conn_set_callbacks(struct rs_connection *conn,
257 struct rs_conn_callbacks *cb);
259 /** Remove callbacks for connection \a conn. */
260 void rs_conn_del_callbacks(struct rs_connection *conn);
262 /** Return callbacks registered for connection \a conn. \return
263 Installed callbacks are returned. */
264 struct rs_conn_callbacks *rs_conn_get_callbacks(struct rs_connection *conn);
266 /** Not implemented. */
267 int rs_conn_select_peer(struct rs_connection *conn, const char *name);
269 /** Not implemented. */
270 int rs_conn_get_current_peer(struct rs_connection *conn,
274 /** Special function used in blocking mode, i.e. with no callbacks
275 registered. For any other use of libradsec, a \a received_cb
276 callback should be registered using \a rs_conn_set_callbacks.
278 If \a req_msg is not NULL, a successfully received RADIUS message
279 is verified against it. If \a pkt_out is not NULL it will upon
280 return contain a pointer to an \a rs_message containing the new
283 \return On error or if the connect (TCP only) or read times out,
284 \a pkt_out will not be changed and one or more errors are pushed
285 on \a conn (available through \a rs_err_conn_pop). */
286 int rs_conn_receive_message(struct rs_connection *conn,
287 struct rs_message *request,
288 struct rs_message **pkt_out);
290 /** Run the dispatcher for the event base associated with \a conn. A
291 * wrapper around event_base_dispatch() for not having to hand out the
293 int rs_conn_dispatch(struct rs_connection *conn);
296 /** Get the event base associated with connection \a conn.
297 * \return struct event_base*. */
298 struct event_base *rs_conn_get_evb(const struct rs_connection *conn);
301 #define rs_conn_fd rs_conn_get_fd /* Old name. */
302 /** Get the file descriptor associated with connection \a conn.
303 * \return File descriptor. */
304 int rs_conn_get_fd(struct rs_connection *conn);
306 /** Set the timeout value for connection \a conn. */
307 void rs_conn_set_timeout(struct rs_connection *conn, struct timeval *tv);
309 /* Peer -- client and server. */
310 int rs_peer_create(struct rs_connection *conn, struct rs_peer **peer_out);
311 int rs_peer_set_address(struct rs_peer *peer,
312 const char *hostname,
313 const char *service);
314 int rs_peer_set_secret(struct rs_peer *peer, const char *secret);
315 void rs_peer_set_timeout(struct rs_peer *peer, int timeout);
316 void rs_peer_set_retries(struct rs_peer *peer, int retries);
321 /** Create a message associated with connection \a conn. */
322 int rs_message_create(struct rs_connection *conn, struct rs_message **pkt_out);
324 /** Free all memory allocated for message \a msg. */
325 void rs_message_destroy(struct rs_message *msg);
327 /** Send message \a msg on the connection associated with \a msg.
328 \a user_data is sent to the \a rs_conn_message_received_cb callback
329 registered with the connection. If no callback is registered with
330 the connection, the event loop is run by \a rs_message_send and it
331 blocks until the message has been succesfully sent.
333 \return On success, RSE_OK (0) is returned. On error, !0 is
334 returned and a struct \a rs_error is pushed on the error stack for
335 the connection. The error can be accessed using \a
337 int rs_message_send(struct rs_message *msg, void *user_data);
339 /** Create a RADIUS authentication request message associated with
340 connection \a conn. Optionally, User-Name and User-Password
341 attributes are added to the message using the data in \a user_name,
342 \a user_pw and \a secret where \secret is the RADIUS shared
344 int rs_message_create_authn_request(struct rs_connection *conn,
345 struct rs_message **msg,
346 const char *user_name,
350 /*** Append \a tail to message \a msg. */
352 rs_message_append_avp(struct rs_message *msg,
353 unsigned int attribute, unsigned int vendor,
354 const void *data, size_t data_len);
356 /*** Get pointer to \a msg attribute value pairs. */
358 rs_message_avps(struct rs_message *msg, rs_avp ***vps);
360 /*** Get RADIUS message type of \a msg. */
362 rs_message_code(struct rs_message *msg);
364 /*** Get RADIUS AVP from \a msg. */
366 rs_message_find_avp(struct rs_message *msg, unsigned int attr,
367 unsigned int vendor);
369 /*** Set packet identifier in \a msg; returns old identifier */
371 rs_message_set_id (struct rs_message *msg, int id);
376 /** Find the realm named \a name in the configuration file previoiusly
377 read in using \a rs_context_read_config. */
378 struct rs_realm *rs_conf_find_realm(struct rs_context *ctx, const char *name);
383 /** Create a struct \a rs_error and push it on a FIFO associated with
384 context \a ctx. Note: The depth of the error stack is one (1) at
385 the moment. This will change in a future release. */
386 int rs_err_ctx_push(struct rs_context *ctx, int code, const char *fmt, ...);
387 int rs_err_ctx_push_fl(struct rs_context *ctx,
393 /** Pop the first error from the error FIFO associated with context \a
394 ctx or NULL if there are no errors in the FIFO. */
395 struct rs_error *rs_err_ctx_pop(struct rs_context *ctx);
397 /** Create a struct \a rs_error and push it on a FIFO associated with
398 connection \a conn. Note: The depth of the error stack is one (1)
399 at the moment. This will change in a future release. */
400 int rs_err_conn_push(struct rs_connection *conn,
404 int rs_err_conn_push_fl(struct rs_connection *conn,
410 /** Pop the first error from the error FIFO associated with connection
411 \a conn or NULL if there are no errors in the FIFO. */
412 struct rs_error *rs_err_conn_pop(struct rs_connection *conn);
414 int rs_err_conn_peek_code (struct rs_connection *conn);
415 void rs_err_free(struct rs_error *err);
416 char *rs_err_msg(struct rs_error *err);
417 int rs_err_code(struct rs_error *err, int dofree_flag);
422 #define rs_avp_is_string(vp) (rs_avp_typeof(vp) == RS_TYPE_STRING)
423 #define rs_avp_is_integer(vp) (rs_avp_typeof(vp) == RS_TYPE_INTEGER)
424 #define rs_avp_is_ipaddr(vp) (rs_avp_typeof(vp) == RS_TYPE_IPADDR)
425 #define rs_avp_is_date(vp) (rs_avp_typeof(vp) == RS_TYPE_DATE)
426 #define rs_avp_is_octets(vp) (rs_avp_typeof(vp) == RS_TYPE_OCTETS)
427 #define rs_avp_is_ifid(vp) (rs_avp_typeof(vp) == RS_TYPE_IFID)
428 #define rs_avp_is_ipv6addr(vp) (rs_avp_typeof(vp) == RS_TYPE_IPV6ADDR)
429 #define rs_avp_is_ipv6prefix(vp) (rs_avp_typeof(vp) == RS_TYPE_IPV6PREFIX)
430 #define rs_avp_is_byte(vp) (rs_avp_typeof(vp) == RS_TYPE_BYTE)
431 #define rs_avp_is_short(vp) (rs_avp_typeof(vp) == RS_TYPE_SHORT)
432 #define rs_avp_is_tlv(vp) (rs_avp_typeof(vp) == RS_TYPE_TLV)
434 /** The maximum length of a RADIUS attribute.
436 * The RFCs require that a RADIUS attribute transport no more than
437 * 253 octets of data. We add an extra byte for a trailing NUL, so
438 * that the VALUE_PAIR::vp_strvalue field can be handled as a C
441 #define RS_MAX_STRING_LEN 254
443 /** Free the AVP list \a vps */
445 rs_avp_free(rs_avp **vps);
447 /** Return the length of AVP \a vp in bytes */
449 rs_avp_length(rs_const_avp *vp);
451 /** Return the type of \a vp */
453 rs_avp_typeof(rs_const_avp *vp);
455 /** Retrieve the attribute and vendor ID of \a vp */
457 rs_avp_attrid(rs_const_avp *vp, unsigned int *attr, unsigned int *vendor);
459 /** Add \a vp to the list pointed to by \a head */
461 rs_avp_append(rs_avp **head, rs_avp *vp);
463 /** Find an AVP in \a vp that matches \a attr and \a vendor */
465 rs_avp_find(rs_avp *vp, unsigned int attr, unsigned int vendor);
467 /** Find an AVP in \a vp that matches \a attr and \a vendor */
469 rs_avp_find_const(rs_const_avp *vp, unsigned int attr, unsigned int vendor);
471 /** Alloc a new AVP for \a attr and \a vendor */
473 rs_avp_alloc(unsigned int attr, unsigned int vendor);
475 /** Duplicate existing AVP \a vp */
477 rs_avp_dup(rs_const_avp *vp);
479 /** Remove matching AVP from list \a vps */
481 rs_avp_delete(rs_avp **vps, unsigned int attr, unsigned int vendor);
483 /** Return next AVP in list */
485 rs_avp_next(rs_avp *vp);
487 /** Return next AVP in list */
489 rs_avp_next_const(rs_const_avp *avp);
491 /** Return string value of \a vp */
493 rs_avp_string_value(rs_const_avp *vp);
495 /** Set AVP \a vp to string \a str */
497 rs_avp_string_set(rs_avp *vp, const char *str);
499 /** Return integer value of \a vp */
501 rs_avp_integer_value(rs_const_avp *vp);
503 /** Set AVP \a vp to integer \a val */
505 rs_avp_integer_set(rs_avp *vp, uint32_t val);
507 /** Return IPv4 value of \a vp */
509 rs_avp_ipaddr_value(rs_const_avp *vp);
511 /** Set AVP \a vp to IPv4 address \a in */
513 rs_avp_ipaddr_set(rs_avp *vp, struct in_addr in);
515 /** Return POSIX time value of \a vp */
517 rs_avp_date_value(rs_const_avp *vp);
519 /** Set AVP \a vp to POSIX time \a date */
521 rs_avp_date_set(rs_avp *vp, time_t date);
523 /** Return constant pointer to octets in \a vp */
524 const unsigned char *
525 rs_avp_octets_value_const_ptr(rs_const_avp *vp);
527 /** Return pointer to octets in \a vp */
529 rs_avp_octets_value_ptr(rs_avp *vp);
531 /** Retrieve octet pointer \a p and length \a len from \a vp */
533 rs_avp_octets_value_byref(rs_avp *vp,
537 /** Copy octets from \a vp into \a buf and \a len */
539 rs_avp_octets_value(rs_const_avp *vp,
544 * Copy octets possibly fragmented across multiple VPs
545 * into \a buf and \a len
548 rs_avp_fragmented_value(rs_const_avp *vps,
552 /** Copy \a len octets in \a buf to AVP \a vp */
554 rs_avp_octets_set(rs_avp *vp,
555 const unsigned char *buf,
558 /** Return IFID value of \a vp */
560 rs_avp_ifid_value(rs_const_avp *vp, uint8_t val[8]);
563 rs_avp_ifid_set(rs_avp *vp, const uint8_t val[8]);
565 /** Return byte value of \a vp */
567 rs_avp_byte_value(rs_const_avp *vp);
569 /** Set AVP \a vp to byte \a val */
571 rs_avp_byte_set(rs_avp *vp, uint8_t val);
573 /** Return short value of \a vp */
575 rs_avp_short_value(rs_const_avp *vp);
577 /** Set AVP \a vp to short integer \a val */
579 rs_avp_short_set(rs_avp *vp, uint16_t val);
581 /** Display possibly \a canonical attribute name into \a buffer */
583 rs_attr_display_name (unsigned int attr,
589 /** Display AVP \a vp into \a buffer */
591 rs_avp_display_value(rs_const_avp *vp,
596 rs_attr_parse_name (const char *name,
598 unsigned int *vendor);
600 /** Lookup attribute \a name */
602 rs_attr_find(const char *name,
604 unsigned int *vendor);
606 /** Return dictionary name for AVP \a vp */
608 rs_avp_name(rs_const_avp *vp);
610 #if defined (__cplusplus)
614 #endif /* _RADSEC_RADSEC_H_ */
616 /* Local Variables: */
617 /* c-file-style: "stroustrup" */