lib/libradius/radlib.h

   1 /*-
   2  * Copyright 1998 Juniper Networks, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  *      $FreeBSD: src/lib/libradius/radlib.h,v 1.8 2009/09/11 11:42:56 mav Exp $
  27  */
  28
  29 #ifndef _RADLIB_H_
  30 #define _RADLIB_H_
  31
  32 #include <sys/types.h>
  33 #include <netinet/in.h>
  34
  35 /* Limits */
  36 #define RAD_MAX_ATTR_LEN                253
  37
  38 /* Message types */
  39 #define RAD_ACCESS_REQUEST              1
  40 #define RAD_ACCESS_ACCEPT               2
  41 #define RAD_ACCESS_REJECT               3
  42 #define RAD_ACCOUNTING_REQUEST          4
  43 #define RAD_ACCOUNTING_RESPONSE         5
  44 #define RAD_ACCESS_CHALLENGE            11
  45 #define RAD_DISCONNECT_REQUEST          40
  46 #define RAD_DISCONNECT_ACK              41
  47 #define RAD_DISCONNECT_NAK              42
  48 #define RAD_COA_REQUEST                 43
  49 #define RAD_COA_ACK                     44
  50 #define RAD_COA_NAK                     45
  51
  52 /* Attribute types and values */
  53 #define RAD_USER_NAME                   1       /* String */
  54 #define RAD_USER_PASSWORD               2       /* String */
  55 #define RAD_CHAP_PASSWORD               3       /* String */
  56 #define RAD_NAS_IP_ADDRESS              4       /* IP address */
  57 #define RAD_NAS_PORT                    5       /* Integer */
  58 #define RAD_SERVICE_TYPE                6       /* Integer */
  59         #define RAD_LOGIN                       1
  60         #define RAD_FRAMED                      2
  61         #define RAD_CALLBACK_LOGIN              3
  62         #define RAD_CALLBACK_FRAMED             4
  63         #define RAD_OUTBOUND                    5
  64         #define RAD_ADMINISTRATIVE              6
  65         #define RAD_NAS_PROMPT                  7
  66         #define RAD_AUTHENTICATE_ONLY           8
  67         #define RAD_CALLBACK_NAS_PROMPT         9
  68 #define RAD_FRAMED_PROTOCOL             7       /* Integer */
  69         #define RAD_PPP                         1
  70         #define RAD_SLIP                        2
  71         #define RAD_ARAP                        3       /* Appletalk */
  72         #define RAD_GANDALF                     4
  73         #define RAD_XYLOGICS                    5
  74 #define RAD_FRAMED_IP_ADDRESS           8       /* IP address */
  75 #define RAD_FRAMED_IP_NETMASK           9       /* IP address */
  76 #define RAD_FRAMED_ROUTING              10      /* Integer */
  77 #define RAD_FILTER_ID                   11      /* String */
  78 #define RAD_FRAMED_MTU                  12      /* Integer */
  79 #define RAD_FRAMED_COMPRESSION          13      /* Integer */
  80         #define RAD_COMP_NONE                   0
  81         #define RAD_COMP_VJ                     1
  82         #define RAD_COMP_IPXHDR                 2
  83 #define RAD_LOGIN_IP_HOST               14      /* IP address */
  84 #define RAD_LOGIN_SERVICE               15      /* Integer */
  85 #define RAD_LOGIN_TCP_PORT              16      /* Integer */
  86      /* unassiged                       17 */
  87 #define RAD_REPLY_MESSAGE               18      /* String */
  88 #define RAD_CALLBACK_NUMBER             19      /* String */
  89 #define RAD_CALLBACK_ID                 20      /* String */
  90      /* unassiged                       21 */
  91 #define RAD_FRAMED_ROUTE                22      /* String */
  92 #define RAD_FRAMED_IPX_NETWORK          23      /* IP address */
  93 #define RAD_STATE                       24      /* String */
  94 #define RAD_CLASS                       25      /* Integer */
  95 #define RAD_VENDOR_SPECIFIC             26      /* Integer */
  96 #define RAD_SESSION_TIMEOUT             27      /* Integer */
  97 #define RAD_IDLE_TIMEOUT                28      /* Integer */
  98 #define RAD_TERMINATION_ACTION          29      /* Integer */
  99 #define RAD_CALLED_STATION_ID           30      /* String */
 100 #define RAD_CALLING_STATION_ID          31      /* String */
 101 #define RAD_NAS_IDENTIFIER              32      /* Integer */
 102 #define RAD_PROXY_STATE                 33      /* Integer */
 103 #define RAD_LOGIN_LAT_SERVICE           34      /* Integer */
 104 #define RAD_LOGIN_LAT_NODE              35      /* Integer */
 105 #define RAD_LOGIN_LAT_GROUP             36      /* Integer */
 106 #define RAD_FRAMED_APPLETALK_LINK       37      /* Integer */
 107 #define RAD_FRAMED_APPLETALK_NETWORK    38      /* Integer */
 108 #define RAD_FRAMED_APPLETALK_ZONE       39      /* Integer */
 109      /* reserved for accounting         40-59 */
 110 #define RAD_ACCT_INPUT_GIGAWORDS        52
 111 #define RAD_ACCT_OUTPUT_GIGAWORDS       53
 112
 113 #define RAD_CHAP_CHALLENGE              60      /* String */
 114 #define RAD_NAS_PORT_TYPE               61      /* Integer */
 115         #define RAD_ASYNC                       0
 116         #define RAD_SYNC                        1
 117         #define RAD_ISDN_SYNC                   2
 118         #define RAD_ISDN_ASYNC_V120             3
 119         #define RAD_ISDN_ASYNC_V110             4
 120         #define RAD_VIRTUAL                     5
 121         #define RAD_PIAFS                       6
 122         #define RAD_HDLC_CLEAR_CHANNEL          7
 123         #define RAD_X_25                        8
 124         #define RAD_X_75                        9
 125         #define RAD_G_3_FAX                     10
 126         #define RAD_SDSL                        11
 127         #define RAD_ADSL_CAP                    12
 128         #define RAD_ADSL_DMT                    13
 129         #define RAD_IDSL                        14
 130         #define RAD_ETHERNET                    15
 131         #define RAD_XDSL                        16
 132         #define RAD_CABLE                       17
 133         #define RAD_WIRELESS_OTHER              18
 134         #define RAD_WIRELESS_IEEE_802_11        19
 135 #define RAD_PORT_LIMIT                  62      /* Integer */
 136 #define RAD_LOGIN_LAT_PORT              63      /* Integer */
 137 #define RAD_CONNECT_INFO                77      /* String */
 138 #define RAD_EAP_MESSAGE                 79      /* Octets */
 139 #define RAD_MESSAGE_AUTHENTIC           80      /* Octets */
 140 #define RAD_ACCT_INTERIM_INTERVAL       85      /* Integer */
 141 #define RAD_NAS_IPV6_ADDRESS            95      /* IPv6 address */
 142 #define RAD_FRAMED_INTERFACE_ID         96      /* 8 octets */
 143 #define RAD_FRAMED_IPV6_PREFIX          97      /* Octets */
 144 #define RAD_LOGIN_IPV6_HOST             98      /* IPv6 address */
 145 #define RAD_FRAMED_IPV6_ROUTE           99      /* String */
 146 #define RAD_FRAMED_IPV6_POOL            100     /* String */
 147
 148 /* Accounting attribute types and values */
 149 #define RAD_ACCT_STATUS_TYPE            40      /* Integer */
 150         #define RAD_START                       1
 151         #define RAD_STOP                        2
 152         #define RAD_UPDATE                      3
 153         #define RAD_ACCOUNTING_ON               7
 154         #define RAD_ACCOUNTING_OFF              8
 155 #define RAD_ACCT_DELAY_TIME             41      /* Integer */
 156 #define RAD_ACCT_INPUT_OCTETS           42      /* Integer */
 157 #define RAD_ACCT_OUTPUT_OCTETS          43      /* Integer */
 158 #define RAD_ACCT_SESSION_ID             44      /* String */
 159 #define RAD_ACCT_AUTHENTIC              45      /* Integer */
 160         #define RAD_AUTH_RADIUS                 1
 161         #define RAD_AUTH_LOCAL                  2
 162         #define RAD_AUTH_REMOTE                 3
 163 #define RAD_ACCT_SESSION_TIME           46      /* Integer */
 164 #define RAD_ACCT_INPUT_PACKETS          47      /* Integer */
 165 #define RAD_ACCT_OUTPUT_PACKETS         48      /* Integer */
 166 #define RAD_ACCT_TERMINATE_CAUSE        49      /* Integer */
 167         #define RAD_TERM_USER_REQUEST           1
 168         #define RAD_TERM_LOST_CARRIER           2
 169         #define RAD_TERM_LOST_SERVICE           3
 170         #define RAD_TERM_IDLE_TIMEOUT           4
 171         #define RAD_TERM_SESSION_TIMEOUT        5
 172         #define RAD_TERM_ADMIN_RESET            6
 173         #define RAD_TERM_ADMIN_REBOOT           7
 174         #define RAD_TERM_PORT_ERROR             8
 175         #define RAD_TERM_NAS_ERROR              9
 176         #define RAD_TERM_NAS_REQUEST            10
 177         #define RAD_TERM_NAS_REBOOT             11
 178         #define RAD_TERM_PORT_UNNEEDED          12
 179         #define RAD_TERM_PORT_PREEMPTED         13
 180         #define RAD_TERM_PORT_SUSPENDED         14
 181         #define RAD_TERM_SERVICE_UNAVAILABLE    15
 182         #define RAD_TERM_CALLBACK               16
 183         #define RAD_TERM_USER_ERROR             17
 184         #define RAD_TERM_HOST_REQUEST           18
 185 #define RAD_ACCT_MULTI_SESSION_ID       50      /* String */
 186 #define RAD_ACCT_LINK_COUNT             51      /* Integer */
 187
 188 #define RAD_ERROR_CAUSE                 101     /* Integer */
 189
 190 struct rad_handle;
 191 struct timeval;
 192
 193 __BEGIN_DECLS
 194 struct rad_handle       *rad_acct_open(void);
 195 int                      rad_add_server(struct rad_handle *,
 196                             const char *, int, const char *, int, int);
 197 int                      rad_add_server_ex(struct rad_handle *,
 198                             const char *, int, const char *, int, int,
 199                             int, struct in_addr *);
 200 struct rad_handle       *rad_auth_open(void);
 201 void                     rad_bind_to(struct rad_handle *, in_addr_t);
 202 void                     rad_close(struct rad_handle *);
 203 int                      rad_config(struct rad_handle *, const char *);
 204 int                      rad_continue_send_request(struct rad_handle *, int,
 205                             int *, struct timeval *);
 206 int                      rad_create_request(struct rad_handle *, int);
 207 int                      rad_create_response(struct rad_handle *, int);
 208 struct in_addr           rad_cvt_addr(const void *);
 209 struct in6_addr          rad_cvt_addr6(const void *);
 210 u_int32_t                rad_cvt_int(const void *);
 211 char                    *rad_cvt_string(const void *, size_t);
 212 int                      rad_get_attr(struct rad_handle *, const void **,
 213                             size_t *);
 214 int                      rad_init_send_request(struct rad_handle *, int *,
 215                             struct timeval *);
 216 struct rad_handle       *rad_open(void);  /* Deprecated, == rad_auth_open */
 217 int                      rad_put_addr(struct rad_handle *, int, struct in_addr);
 218 int                      rad_put_addr6(struct rad_handle *, int, struct in6_addr);
 219 int                      rad_put_attr(struct rad_handle *, int,
 220                             const void *, size_t);
 221 int                      rad_put_int(struct rad_handle *, int, u_int32_t);
 222 int                      rad_put_string(struct rad_handle *, int,
 223                             const char *);
 224 int                      rad_put_message_authentic(struct rad_handle *);
 225 ssize_t                  rad_request_authenticator(struct rad_handle *, char *,
 226                             size_t);
 227 int                      rad_receive_request(struct rad_handle *);
 228 int                      rad_send_request(struct rad_handle *);
 229 int                      rad_send_response(struct rad_handle *);
 230 struct rad_handle       *rad_server_open(int fd);
 231 const char              *rad_server_secret(struct rad_handle *);
 232 const char              *rad_strerror(struct rad_handle *);
 233 u_char                  *rad_demangle(struct rad_handle *, const void *,
 234                             size_t);
 235
 236 __END_DECLS
 237
 238 #endif /* _RADLIB_H_ */