Update copyright to JANET(UK)
[radsecproxy.git] / lib / include / radsec / radsec.h
1 /** \file radsec.h
2     \brief Public interface for libradsec.  */
3
4 /* See the file COPYING for licensing information.  */
5
6 #ifndef _RADSEC_RADSEC_H_
7 #define _RADSEC_RADSEC_H_ 1
8
9 #ifdef HAVE_CONFIG_H
10 #include <config.h>
11 #endif
12 #ifdef HAVE_SYS_TIME_H
13 #include <sys/time.h>
14 #endif
15 #ifdef HAVE_ARPA_INET_H
16 #include <arpa/inet.h>
17 #endif
18 #ifdef HAVE_UNISTD_H
19 #include <unistd.h>
20 #endif
21 #ifdef HAVE_STDINT_H
22 #include <stdint.h>
23 #endif
24
25 enum rs_error_code {
26     RSE_OK = 0,
27     RSE_NOMEM = 1,
28     RSE_NOSYS = 2,
29     RSE_INVALID_CTX = 3,
30     RSE_INVALID_CONN = 4,
31     RSE_CONN_TYPE_MISMATCH = 5,
32     RSE_FR = 6,
33     RSE_BADADDR = 7,
34     RSE_NOPEER = 8,
35     RSE_EVENT = 9,              /* libevent error.  */
36     RSE_SOCKERR = 10,
37     RSE_CONFIG = 11,
38     RSE_BADAUTH = 12,
39     RSE_INTERNAL = 13,
40     RSE_SSLERR = 14,            /* OpenSSL error.  */
41     RSE_INVALID_PKT = 15,
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.  */
46     RSE_DISCO = 20,
47     RSE_INUSE = 21,
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,
69     RSE_MAX = RSE_VENDOR_UNKNOWN
70 };
71
72 enum rs_conn_type {
73     RS_CONN_TYPE_NONE = 0,
74     RS_CONN_TYPE_UDP,
75     RS_CONN_TYPE_TCP,
76     RS_CONN_TYPE_TLS,
77     RS_CONN_TYPE_DTLS,
78 };
79 typedef unsigned int rs_conn_type_t;
80
81 typedef enum rs_attr_type_t {
82     RS_TYPE_INVALID = 0,                /**< Invalid data type */
83     RS_TYPE_STRING,                     /**< printable-text */
84     RS_TYPE_INTEGER,                    /**< a 32-bit unsigned integer */
85     RS_TYPE_IPADDR,                     /**< an IPv4 address */
86     RS_TYPE_DATE,                       /**< a 32-bit date, of seconds since January 1, 1970 */
87     RS_TYPE_OCTETS,                     /**< a sequence of binary octets */
88     RS_TYPE_IFID,                       /**< an Interface Id */
89     RS_TYPE_IPV6ADDR,                   /**< an IPv6 address */
90     RS_TYPE_IPV6PREFIX,                 /**< an IPv6 prefix */
91     RS_TYPE_BYTE,                       /**< an 8-bit integer */
92     RS_TYPE_SHORT,                      /**< a 16-bit integer */
93 } rs_attr_type_t;
94
95 #define PW_ACCESS_REQUEST               1
96 #define PW_ACCESS_ACCEPT                2
97 #define PW_ACCESS_REJECT                3
98 #define PW_ACCOUNTING_REQUEST           4
99 #define PW_ACCOUNTING_RESPONSE          5
100 #define PW_ACCOUNTING_STATUS            6
101 #define PW_PASSWORD_REQUEST             7
102 #define PW_PASSWORD_ACK                 8
103 #define PW_PASSWORD_REJECT              9
104 #define PW_ACCOUNTING_MESSAGE           10
105 #define PW_ACCESS_CHALLENGE             11
106 #define PW_STATUS_SERVER                12
107 #define PW_STATUS_CLIENT                13
108 #define PW_DISCONNECT_REQUEST           40
109 #define PW_DISCONNECT_ACK               41
110 #define PW_DISCONNECT_NAK               42
111 #define PW_COA_REQUEST                  43
112 #define PW_COA_ACK                      44
113 #define PW_COA_NAK                      45
114
115 #if defined (__cplusplus)
116 extern "C" {
117 #endif
118
119 /* Data types.  */
120 struct rs_context;              /* radsec-impl.h */
121 struct rs_connection;           /* radsec-impl.h */
122 struct rs_packet;               /* radsec-impl.h */
123 struct rs_conn;                 /* radsec-impl.h */
124 struct rs_error;                /* radsec-impl.h */
125 struct rs_peer;                 /* radsec-impl.h */
126 struct radius_packet;           /* <radius/client.h> */
127 struct value_pair;              /* <radius/client.h> */
128 struct event_base;              /* <event2/event-internal.h> */
129
130 typedef void *(*rs_calloc_fp) (size_t nmemb, size_t size);
131 typedef void *(*rs_malloc_fp) (size_t size);
132 typedef void (*rs_free_fp) (void *ptr);
133 typedef void *(*rs_realloc_fp) (void *ptr, size_t size);
134 struct rs_alloc_scheme {
135     rs_calloc_fp calloc;
136     rs_malloc_fp malloc;
137     rs_free_fp free;
138     rs_realloc_fp realloc;
139 };
140
141 typedef void (*rs_conn_connected_cb) (void *user_data /* FIXME: peer? */ );
142 typedef void (*rs_conn_disconnected_cb) (void *user_data /* FIXME: reason? */ );
143 typedef void (*rs_conn_packet_received_cb) (struct rs_packet *packet,
144                                             void *user_data);
145 typedef void (*rs_conn_packet_sent_cb) (void *user_data);
146 struct rs_conn_callbacks {
147     /** Callback invoked when the connection has been established.  */
148     rs_conn_connected_cb connected_cb;
149     /** Callback invoked when the connection has been torn down.  */
150     rs_conn_disconnected_cb disconnected_cb;
151     /** Callback invoked when a packet was received.  */
152     rs_conn_packet_received_cb received_cb;
153     /** Callback invoked when a packet was successfully sent.  */
154     rs_conn_packet_sent_cb sent_cb;
155 };
156
157 typedef struct value_pair rs_avp;
158 typedef const struct value_pair rs_const_avp;
159
160 /* Function prototypes.  */
161
162 /*************/
163 /* Context.  */
164 /*************/
165 /** Create a context.  Freed by calling \a rs_context_destroy.  Note
166     that the context must not be freed before all other libradsec
167     objects have been freed.
168
169     \a ctx Address of pointer to a struct rs_context.  This is the
170     output of this function.
171
172     \return RSE_OK (0) on success or RSE_NOMEM on out of memory.  */
173 int rs_context_create(struct rs_context **ctx);
174
175 /** Free a context.  Note that the context must not be freed before
176     all other libradsec objects have been freed.  */
177 void rs_context_destroy(struct rs_context *ctx);
178
179 /** Set allocation scheme to use.  \a scheme is the allocation scheme
180     to use, see \a rs_alloc_scheme.  \return On success, RSE_OK (0) is
181     returned.  On error, !0 is returned and a struct \a rs_error is
182     pushed on the error stack for the context.  The error can be
183     accessed using \a rs_err_ctx_pop.  */
184 int rs_context_set_alloc_scheme(struct rs_context *ctx,
185                                 struct rs_alloc_scheme *scheme);
186
187 /** Read configuration file. \a config_file is the path of the
188     configuration file to read.  \return On success, RSE_OK (0) is
189     returned.  On error, !0 is returned and a struct \a rs_error is
190     pushed on the error stack for the context.  The error can be
191     accessed using \a rs_err_ctx_pop.  */
192 int rs_context_read_config(struct rs_context *ctx, const char *config_file);
193
194 /****************/
195 /* Connection.  */
196 /****************/
197 /** Create a connection.  \a conn is the address of a pointer to an \a
198     rs_connection, the output.  Free the connection using \a
199     rs_conn_destroy.  Note that a connection must not be freed before
200     all packets associated with the connection have been freed.  A
201     packet is associated with a connection when it's created (\a
202     rs_packet_create) or received (\a rs_conn_receive_packet).
203
204     If \a config is not NULL it should be the name of a configuration
205     found in the config file read in using \a rs_context_read_config.
206     \return On success, RSE_OK (0) is returned.  On error, !0 is
207     returned and a struct \a rs_error is pushed on the error stack for
208     the context.  The error can be accessed using \a
209     rs_err_ctx_pop.  */
210 int rs_conn_create(struct rs_context *ctx,
211                    struct rs_connection **conn,
212                    const char *config);
213
214 /** Not implemented.  */
215 int rs_conn_add_listener(struct rs_connection *conn,
216                          rs_conn_type_t type,
217                          const char *hostname,
218                          int port);
219 /** Disconnect connection \a conn.  \return RSE_OK (0) on success, !0
220  * on error.  On error, errno is set appropriately.  */
221 int rs_conn_disconnect (struct rs_connection *conn);
222
223 /** Disconnect and free memory allocated for connection \a conn.  Note
224     that a connection must not be freed before all packets associated
225     with the connection have been freed.  A packet is associated with
226     a connection when it's created (\a rs_packet_create) or received
227     (\a rs_conn_receive_packet).  \return RSE_OK (0) on success, !0 *
228     on error.  On error, errno is set appropriately. */
229 int rs_conn_destroy(struct rs_connection *conn);
230
231 /** Set connection type for \a conn.  */
232 void rs_conn_set_type(struct rs_connection *conn, rs_conn_type_t type);
233
234 /** Not implemented.  */
235 int rs_conn_set_eventbase(struct rs_connection *conn, struct event_base *eb);
236
237 /** Register callbacks \a cb for connection \a conn.  */
238 void rs_conn_set_callbacks(struct rs_connection *conn,
239                            struct rs_conn_callbacks *cb);
240
241 /** Remove callbacks for connection \a conn.  */
242 void rs_conn_del_callbacks(struct rs_connection *conn);
243
244 /** Return callbacks registered for connection \a conn.  \return
245     Installed callbacks are returned.  */
246 struct rs_conn_callbacks *rs_conn_get_callbacks(struct rs_connection *conn);
247
248 /** Not implemented.  */
249 int rs_conn_select_peer(struct rs_connection *conn, const char *name);
250
251 /** Not implemented.  */
252 int rs_conn_get_current_peer(struct rs_connection *conn,
253                              const char *name,
254                              size_t buflen);
255
256 /** Special function used in blocking mode, i.e. with no callbacks
257     registered.  For any other use of libradsec, a \a received_cb
258     callback should be registered using \a rs_conn_set_callbacks.
259
260     If \a req_msg is not NULL, a successfully received RADIUS message
261     is verified against it.  If \a pkt_out is not NULL it will upon
262     return contain a pointer to an \a rs_packet containing the new
263     message.
264
265     \return On error or if the connect (TCP only) or read times out,
266     \a pkt_out will not be changed and one or more errors are pushed
267     on \a conn (available through \a rs_err_conn_pop).  */
268 int rs_conn_receive_packet(struct rs_connection *conn,
269                            struct rs_packet *request,
270                            struct rs_packet **pkt_out);
271
272 /** Get the file descriptor associated with connection \a conn.
273  * \return File descriptor.  */
274 int rs_conn_fd(struct rs_connection *conn);
275
276 /** Set the timeout value for connection \a conn.  */
277 void rs_conn_set_timeout(struct rs_connection *conn, struct timeval *tv);
278
279 /* Peer -- client and server.  */
280 int rs_peer_create(struct rs_connection *conn, struct rs_peer **peer_out);
281 int rs_peer_set_address(struct rs_peer *peer,
282                         const char *hostname,
283                         const char *service);
284 int rs_peer_set_secret(struct rs_peer *peer, const char *secret);
285 void rs_peer_set_timeout(struct rs_peer *peer, int timeout);
286 void rs_peer_set_retries(struct rs_peer *peer, int retries);
287
288 /************/
289 /* Packet.  */
290 /************/
291 /** Create a packet associated with connection \a conn.  */
292 int rs_packet_create(struct rs_connection *conn, struct rs_packet **pkt_out);
293
294 /** Free all memory allocated for packet \a pkt.  */
295 void rs_packet_destroy(struct rs_packet *pkt);
296
297 /** Send packet \a pkt on the connection associated with \a pkt.  \a
298     user_data is sent to the \a rs_conn_packet_received_cb callback
299     registered with the connection.  If no callback is registered with
300     the connection, the event loop is run by \a rs_packet_send and it
301     blocks until the packet has been succesfully sent.
302
303     \return On success, RSE_OK (0) is returned.  On error, !0 is
304     returned and a struct \a rs_error is pushed on the error stack for
305     the connection.  The error can be accessed using \a
306     rs_err_conn_pop.  */
307 int rs_packet_send(struct rs_packet *pkt, void *user_data);
308
309 /** Create a RADIUS authentication request packet associated with
310     connection \a conn.  Optionally, User-Name and User-Password
311     attributes are added to the packet using the data in \a user_name
312     and \a user_pw.  */
313 int rs_packet_create_authn_request(struct rs_connection *conn,
314                                    struct rs_packet **pkt,
315                                    const char *user_name,
316                                    const char *user_pw);
317
318 /*** Append \a tail to packet \a pkt.  */
319 int
320 rs_packet_append_avp(struct rs_packet *pkt,
321                      unsigned int attribute, unsigned int vendor,
322                      const void *data, size_t data_len);
323
324 /*** Get pointer to \a pkt attribute value pairs. */
325 void
326 rs_packet_avps(struct rs_packet *pkt, rs_avp ***vps);
327
328 /*** Get RADIUS packet type of \a pkt. */
329 unsigned int
330 rs_packet_code(struct rs_packet *pkt);
331
332 /*** Get RADIUS AVP from \a pkt. */
333 rs_const_avp *
334 rs_packet_find_avp(struct rs_packet *pkt, unsigned int attr, unsigned int vendor);
335
336 /*** Set packet identifier in \a pkt; returns old identifier */
337 int
338 rs_packet_set_id (struct rs_packet *pkt, int id);
339
340 /************/
341 /* Config.  */
342 /************/
343 /** Find the realm named \a name in the configuration file previoiusly
344     read in using \a rs_context_read_config.  */
345 struct rs_realm *rs_conf_find_realm(struct rs_context *ctx, const char *name);
346
347 /***********/
348 /* Error.  */
349 /***********/
350 /** Create a struct \a rs_error and push it on a FIFO associated with
351     context \a ctx.  Note: The depth of the error stack is one (1) at
352     the moment.  This will change in a future release.  */
353 int rs_err_ctx_push(struct rs_context *ctx, int code, const char *fmt, ...);
354 int rs_err_ctx_push_fl(struct rs_context *ctx,
355                        int code,
356                        const char *file,
357                        int line,
358                        const char *fmt,
359                        ...);
360 /** Pop the first error from the error FIFO associated with context \a
361     ctx or NULL if there are no errors in the FIFO.  */
362 struct rs_error *rs_err_ctx_pop(struct rs_context *ctx);
363
364 /** Create a struct \a rs_error and push it on a FIFO associated with
365     connection \a conn.  Note: The depth of the error stack is one (1)
366     at the moment.  This will change in a future release.  */
367 int rs_err_conn_push(struct rs_connection *conn,
368                      int code,
369                      const char *fmt,
370                      ...);
371 int rs_err_conn_push_fl(struct rs_connection *conn,
372                         int code,
373                         const char *file,
374                         int line,
375                         const char *fmt,
376                         ...);
377 /** Pop the first error from the error FIFO associated with connection
378     \a conn or NULL if there are no errors in the FIFO.  */
379 struct rs_error *rs_err_conn_pop(struct rs_connection *conn);
380
381 int rs_err_conn_peek_code (struct rs_connection *conn);
382 void rs_err_free(struct rs_error *err);
383 char *rs_err_msg(struct rs_error *err);
384 int rs_err_code(struct rs_error *err, int dofree_flag);
385
386 /************/
387 /* AVPs.    */
388 /************/
389 #define rs_avp_is_string(vp)      (rs_avp_typeof(vp) == RS_TYPE_STRING)
390 #define rs_avp_is_integer(vp)     (rs_avp_typeof(vp) == RS_TYPE_INTEGER)
391 #define rs_avp_is_ipaddr(vp)      (rs_avp_typeof(vp) == RS_TYPE_IPADDR)
392 #define rs_avp_is_date(vp)        (rs_avp_typeof(vp) == RS_TYPE_DATE)
393 #define rs_avp_is_octets(vp)      (rs_avp_typeof(vp) == RS_TYPE_OCTETS)
394 #define rs_avp_is_ifid(vp)        (rs_avp_typeof(vp) == RS_TYPE_IFID)
395 #define rs_avp_is_ipv6addr(vp)    (rs_avp_typeof(vp) == RS_TYPE_IPV6ADDR)
396 #define rs_avp_is_ipv6prefix(vp)  (rs_avp_typeof(vp) == RS_TYPE_IPV6PREFIX)
397 #define rs_avp_is_byte(vp)        (rs_avp_typeof(vp) == RS_TYPE_BYTE)
398 #define rs_avp_is_short(vp)       (rs_avp_typeof(vp) == RS_TYPE_SHORT)
399 #define rs_avp_is_tlv(vp)         (rs_avp_typeof(vp) == RS_TYPE_TLV)
400
401 /**  The maximum length of a RADIUS attribute.
402  *
403  *  The RFCs require that a RADIUS attribute transport no more than
404  *  253 octets of data.  We add an extra byte for a trailing NUL, so
405  *  that the VALUE_PAIR::vp_strvalue field can be handled as a C
406  *  string.
407  */
408 #define RS_MAX_STRING_LEN         254
409
410 /** Free the AVP list \a vps */
411 void
412 rs_avp_free(rs_avp **vps);
413
414 /** Return the length of AVP \a vp in bytes */
415 size_t
416 rs_avp_length(rs_const_avp *vp);
417
418 /** Return the type of \a vp */
419 rs_attr_type_t
420 rs_avp_typeof(rs_const_avp *vp);
421
422 /** Retrieve the attribute and vendor ID of \a vp */
423 void
424 rs_avp_attrid(rs_const_avp *vp, unsigned int *attr, unsigned int *vendor);
425
426 /** Add \a vp to the list pointed to by \a head */
427 void
428 rs_avp_append(rs_avp **head, rs_avp *vp);
429
430 /** Find an AVP in \a vp that matches \a attr and \a vendor */
431 rs_avp *
432 rs_avp_find(rs_avp *vp, unsigned int attr, unsigned int vendor);
433
434 /** Find an AVP in \a vp that matches \a attr and \a vendor */
435 rs_const_avp *
436 rs_avp_find_const(rs_const_avp *vp, unsigned int attr, unsigned int vendor);
437
438 /** Alloc a new AVP for \a attr and \a vendor */
439 rs_avp *
440 rs_avp_alloc(unsigned int attr, unsigned int vendor);
441
442 /** Duplicate existing AVP \a vp */
443 rs_avp *
444 rs_avp_dup(rs_const_avp *vp);
445
446 /** Remove matching AVP from list \a vps */
447 int
448 rs_avp_delete(rs_avp **vps, unsigned int attr, unsigned int vendor);
449
450 /** Return next AVP in list */
451 rs_avp *
452 rs_avp_next(rs_avp *vp);
453
454 /** Return next AVP in list */
455 rs_const_avp *
456 rs_avp_next_const(rs_const_avp *avp);
457
458 /** Return string value of \a vp */
459 const char *
460 rs_avp_string_value(rs_const_avp *vp);
461
462 /** Set AVP \a vp to string \a str */
463 int
464 rs_avp_string_set(rs_avp *vp, const char *str);
465
466 /** Return integer value of \a vp */
467 uint32_t
468 rs_avp_integer_value(rs_const_avp *vp);
469
470 /** Set AVP \a vp to integer \a val */
471 int
472 rs_avp_integer_set(rs_avp *vp, uint32_t val);
473
474 /** Return IPv4 value of \a vp */
475 uint32_t
476 rs_avp_ipaddr_value(rs_const_avp *vp);
477
478 /** Set AVP \a vp to IPv4 address \a in */
479 int
480 rs_avp_ipaddr_set(rs_avp *vp, struct in_addr in);
481
482 /** Return POSIX time value of \a vp */
483 time_t
484 rs_avp_date_value(rs_const_avp *vp);
485
486 /** Set AVP \a vp to POSIX time \a date */
487 int
488 rs_avp_date_set(rs_avp *vp, time_t date);
489
490 /** Return constant pointer to octets in \a vp */
491 const unsigned char *
492 rs_avp_octets_value_const_ptr(rs_const_avp *vp);
493
494 /** Return pointer to octets in \a vp */
495 unsigned char *
496 rs_avp_octets_value_ptr(rs_avp *vp);
497
498 /** Retrieve octet pointer \a p and length \a len from \a vp */
499 int
500 rs_avp_octets_value_byref(rs_avp *vp,
501                           unsigned char **p,
502                           size_t *len);
503
504 /** Copy octets from \a vp into \a buf and \a len */
505 int
506 rs_avp_octets_value(rs_const_avp *vp,
507                     unsigned char *buf,
508                     size_t *len);
509
510 /**
511  * Copy octets possibly fragmented across multiple VPs
512  * into \a buf and \a len
513  */
514 int
515 rs_avp_fragmented_value(rs_const_avp *vps,
516                         unsigned char *buf,
517                         size_t *len);
518
519 /** Copy \a len octets in \a buf to AVP \a vp */
520 int
521 rs_avp_octets_set(rs_avp *vp,
522                   const unsigned char *buf,
523                   size_t len);
524
525 /** Return IFID value of \a vp */
526 int
527 rs_avp_ifid_value(rs_const_avp *vp, uint8_t val[8]);
528
529 int
530 rs_avp_ifid_set(rs_avp *vp, const uint8_t val[8]);
531
532 /** Return byte value of \a vp */
533 uint8_t
534 rs_avp_byte_value(rs_const_avp *vp);
535
536 /** Set AVP \a vp to byte \a val */
537 int
538 rs_avp_byte_set(rs_avp *vp, uint8_t val);
539
540 /** Return short value of \a vp */
541 uint16_t
542 rs_avp_short_value(rs_const_avp *vp);
543
544 /** Set AVP \a vp to short integer \a val */
545 int
546 rs_avp_short_set(rs_avp *vp, uint16_t val);
547
548 /** Display possibly \a canonical attribute name into \a buffer */
549 int
550 rs_attr_display_name (unsigned int attr,
551                       unsigned int vendor,
552                       char *buffer,
553                       size_t bufsize,
554                       int canonical);
555
556 /** Display AVP \a vp into \a buffer */
557 size_t
558 rs_avp_display_value(rs_const_avp *vp,
559                      char *buffer,
560                      size_t buflen);
561
562 int
563 rs_attr_parse_name (const char *name,
564                     unsigned int *attr,
565                     unsigned int *vendor);
566
567 /** Lookup attribute \a name */
568 int
569 rs_attr_find(const char *name,
570              unsigned int *attr,
571              unsigned int *vendor);
572
573 /** Return dictionary name for AVP \a vp */
574 const char *
575 rs_avp_name(rs_const_avp *vp);
576
577 #if defined (__cplusplus)
578 }
579 #endif
580
581 #endif /* _RADSEC_RADSEC_H_ */
582
583 /* Local Variables: */
584 /* c-file-style: "stroustrup" */
585 /* End: */