Home | History | Annotate | Download | only in radius
      1 /*
      2  * RADIUS message processing
      3  * Copyright (c) 2002-2009, Jouni Malinen <j (at) w1.fi>
      4  *
      5  * This software may be distributed under the terms of the BSD license.
      6  * See README for more details.
      7  */
      8 
      9 #ifndef RADIUS_H
     10 #define RADIUS_H
     11 
     12 /* RFC 2865 - RADIUS */
     13 
     14 #ifdef _MSC_VER
     15 #pragma pack(push, 1)
     16 #endif /* _MSC_VER */
     17 
     18 struct radius_hdr {
     19 	u8 code;
     20 	u8 identifier;
     21 	u16 length; /* including this header */
     22 	u8 authenticator[16];
     23 	/* followed by length-20 octets of attributes */
     24 } STRUCT_PACKED;
     25 
     26 enum { RADIUS_CODE_ACCESS_REQUEST = 1,
     27        RADIUS_CODE_ACCESS_ACCEPT = 2,
     28        RADIUS_CODE_ACCESS_REJECT = 3,
     29        RADIUS_CODE_ACCOUNTING_REQUEST = 4,
     30        RADIUS_CODE_ACCOUNTING_RESPONSE = 5,
     31        RADIUS_CODE_ACCESS_CHALLENGE = 11,
     32        RADIUS_CODE_STATUS_SERVER = 12,
     33        RADIUS_CODE_STATUS_CLIENT = 13,
     34        RADIUS_CODE_RESERVED = 255
     35 };
     36 
     37 struct radius_attr_hdr {
     38 	u8 type;
     39 	u8 length; /* including this header */
     40 	/* followed by length-2 octets of attribute value */
     41 } STRUCT_PACKED;
     42 
     43 #define RADIUS_MAX_ATTR_LEN (255 - sizeof(struct radius_attr_hdr))
     44 
     45 enum { RADIUS_ATTR_USER_NAME = 1,
     46        RADIUS_ATTR_USER_PASSWORD = 2,
     47        RADIUS_ATTR_NAS_IP_ADDRESS = 4,
     48        RADIUS_ATTR_NAS_PORT = 5,
     49        RADIUS_ATTR_FRAMED_MTU = 12,
     50        RADIUS_ATTR_REPLY_MESSAGE = 18,
     51        RADIUS_ATTR_STATE = 24,
     52        RADIUS_ATTR_CLASS = 25,
     53        RADIUS_ATTR_VENDOR_SPECIFIC = 26,
     54        RADIUS_ATTR_SESSION_TIMEOUT = 27,
     55        RADIUS_ATTR_IDLE_TIMEOUT = 28,
     56        RADIUS_ATTR_TERMINATION_ACTION = 29,
     57        RADIUS_ATTR_CALLED_STATION_ID = 30,
     58        RADIUS_ATTR_CALLING_STATION_ID = 31,
     59        RADIUS_ATTR_NAS_IDENTIFIER = 32,
     60        RADIUS_ATTR_PROXY_STATE = 33,
     61        RADIUS_ATTR_ACCT_STATUS_TYPE = 40,
     62        RADIUS_ATTR_ACCT_DELAY_TIME = 41,
     63        RADIUS_ATTR_ACCT_INPUT_OCTETS = 42,
     64        RADIUS_ATTR_ACCT_OUTPUT_OCTETS = 43,
     65        RADIUS_ATTR_ACCT_SESSION_ID = 44,
     66        RADIUS_ATTR_ACCT_AUTHENTIC = 45,
     67        RADIUS_ATTR_ACCT_SESSION_TIME = 46,
     68        RADIUS_ATTR_ACCT_INPUT_PACKETS = 47,
     69        RADIUS_ATTR_ACCT_OUTPUT_PACKETS = 48,
     70        RADIUS_ATTR_ACCT_TERMINATE_CAUSE = 49,
     71        RADIUS_ATTR_ACCT_MULTI_SESSION_ID = 50,
     72        RADIUS_ATTR_ACCT_LINK_COUNT = 51,
     73        RADIUS_ATTR_ACCT_INPUT_GIGAWORDS = 52,
     74        RADIUS_ATTR_ACCT_OUTPUT_GIGAWORDS = 53,
     75        RADIUS_ATTR_EVENT_TIMESTAMP = 55,
     76        RADIUS_ATTR_NAS_PORT_TYPE = 61,
     77        RADIUS_ATTR_TUNNEL_TYPE = 64,
     78        RADIUS_ATTR_TUNNEL_MEDIUM_TYPE = 65,
     79        RADIUS_ATTR_TUNNEL_PASSWORD = 69,
     80        RADIUS_ATTR_CONNECT_INFO = 77,
     81        RADIUS_ATTR_EAP_MESSAGE = 79,
     82        RADIUS_ATTR_MESSAGE_AUTHENTICATOR = 80,
     83        RADIUS_ATTR_TUNNEL_PRIVATE_GROUP_ID = 81,
     84        RADIUS_ATTR_ACCT_INTERIM_INTERVAL = 85,
     85        RADIUS_ATTR_CHARGEABLE_USER_IDENTITY = 89,
     86        RADIUS_ATTR_NAS_IPV6_ADDRESS = 95
     87 };
     88 
     89 
     90 /* Termination-Action */
     91 #define RADIUS_TERMINATION_ACTION_DEFAULT 0
     92 #define RADIUS_TERMINATION_ACTION_RADIUS_REQUEST 1
     93 
     94 /* NAS-Port-Type */
     95 #define RADIUS_NAS_PORT_TYPE_IEEE_802_11 19
     96 
     97 /* Acct-Status-Type */
     98 #define RADIUS_ACCT_STATUS_TYPE_START 1
     99 #define RADIUS_ACCT_STATUS_TYPE_STOP 2
    100 #define RADIUS_ACCT_STATUS_TYPE_INTERIM_UPDATE 3
    101 #define RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_ON 7
    102 #define RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_OFF 8
    103 
    104 /* Acct-Authentic */
    105 #define RADIUS_ACCT_AUTHENTIC_RADIUS 1
    106 #define RADIUS_ACCT_AUTHENTIC_LOCAL 2
    107 #define RADIUS_ACCT_AUTHENTIC_REMOTE 3
    108 
    109 /* Acct-Terminate-Cause */
    110 #define RADIUS_ACCT_TERMINATE_CAUSE_USER_REQUEST 1
    111 #define RADIUS_ACCT_TERMINATE_CAUSE_LOST_CARRIER 2
    112 #define RADIUS_ACCT_TERMINATE_CAUSE_LOST_SERVICE 3
    113 #define RADIUS_ACCT_TERMINATE_CAUSE_IDLE_TIMEOUT 4
    114 #define RADIUS_ACCT_TERMINATE_CAUSE_SESSION_TIMEOUT 5
    115 #define RADIUS_ACCT_TERMINATE_CAUSE_ADMIN_RESET 6
    116 #define RADIUS_ACCT_TERMINATE_CAUSE_ADMIN_REBOOT 7
    117 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_ERROR 8
    118 #define RADIUS_ACCT_TERMINATE_CAUSE_NAS_ERROR 9
    119 #define RADIUS_ACCT_TERMINATE_CAUSE_NAS_REQUEST 10
    120 #define RADIUS_ACCT_TERMINATE_CAUSE_NAS_REBOOT 11
    121 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_UNNEEDED 12
    122 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_PREEMPTED 13
    123 #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_SUSPENDED 14
    124 #define RADIUS_ACCT_TERMINATE_CAUSE_SERVICE_UNAVAILABLE 15
    125 #define RADIUS_ACCT_TERMINATE_CAUSE_CALLBACK 16
    126 #define RADIUS_ACCT_TERMINATE_CAUSE_USER_ERROR 17
    127 #define RADIUS_ACCT_TERMINATE_CAUSE_HOST_REQUEST 18
    128 
    129 #define RADIUS_TUNNEL_TAGS 32
    130 
    131 /* Tunnel-Type */
    132 #define RADIUS_TUNNEL_TYPE_PPTP 1
    133 #define RADIUS_TUNNEL_TYPE_L2TP 3
    134 #define RADIUS_TUNNEL_TYPE_IPIP 7
    135 #define RADIUS_TUNNEL_TYPE_GRE 10
    136 #define RADIUS_TUNNEL_TYPE_VLAN 13
    137 
    138 /* Tunnel-Medium-Type */
    139 #define RADIUS_TUNNEL_MEDIUM_TYPE_IPV4 1
    140 #define RADIUS_TUNNEL_MEDIUM_TYPE_IPV6 2
    141 #define RADIUS_TUNNEL_MEDIUM_TYPE_802 6
    142 
    143 
    144 struct radius_attr_vendor {
    145 	u8 vendor_type;
    146 	u8 vendor_length;
    147 } STRUCT_PACKED;
    148 
    149 #define RADIUS_VENDOR_ID_CISCO 9
    150 #define RADIUS_CISCO_AV_PAIR 1
    151 
    152 /* RFC 2548 - Microsoft Vendor-specific RADIUS Attributes */
    153 #define RADIUS_VENDOR_ID_MICROSOFT 311
    154 
    155 enum { RADIUS_VENDOR_ATTR_MS_MPPE_SEND_KEY = 16,
    156        RADIUS_VENDOR_ATTR_MS_MPPE_RECV_KEY = 17
    157 };
    158 
    159 #ifdef _MSC_VER
    160 #pragma pack(pop)
    161 #endif /* _MSC_VER */
    162 
    163 struct radius_ms_mppe_keys {
    164 	u8 *send;
    165 	size_t send_len;
    166 	u8 *recv;
    167 	size_t recv_len;
    168 };
    169 
    170 
    171 struct radius_msg;
    172 
    173 /* Default size to be allocated for new RADIUS messages */
    174 #define RADIUS_DEFAULT_MSG_SIZE 1024
    175 
    176 /* Default size to be allocated for attribute array */
    177 #define RADIUS_DEFAULT_ATTR_COUNT 16
    178 
    179 
    180 /* MAC address ASCII format for IEEE 802.1X use
    181  * (draft-congdon-radius-8021x-20.txt) */
    182 #define RADIUS_802_1X_ADDR_FORMAT "%02X-%02X-%02X-%02X-%02X-%02X"
    183 /* MAC address ASCII format for non-802.1X use */
    184 #define RADIUS_ADDR_FORMAT "%02x%02x%02x%02x%02x%02x"
    185 
    186 struct radius_hdr * radius_msg_get_hdr(struct radius_msg *msg);
    187 struct wpabuf * radius_msg_get_buf(struct radius_msg *msg);
    188 struct radius_msg * radius_msg_new(u8 code, u8 identifier);
    189 void radius_msg_free(struct radius_msg *msg);
    190 void radius_msg_dump(struct radius_msg *msg);
    191 int radius_msg_finish(struct radius_msg *msg, const u8 *secret,
    192 		      size_t secret_len);
    193 int radius_msg_finish_srv(struct radius_msg *msg, const u8 *secret,
    194 			  size_t secret_len, const u8 *req_authenticator);
    195 void radius_msg_finish_acct(struct radius_msg *msg, const u8 *secret,
    196 			    size_t secret_len);
    197 struct radius_attr_hdr * radius_msg_add_attr(struct radius_msg *msg, u8 type,
    198 					     const u8 *data, size_t data_len);
    199 struct radius_msg * radius_msg_parse(const u8 *data, size_t len);
    200 int radius_msg_add_eap(struct radius_msg *msg, const u8 *data,
    201 		       size_t data_len);
    202 u8 *radius_msg_get_eap(struct radius_msg *msg, size_t *len);
    203 int radius_msg_verify(struct radius_msg *msg, const u8 *secret,
    204 		      size_t secret_len, struct radius_msg *sent_msg,
    205 		      int auth);
    206 int radius_msg_verify_msg_auth(struct radius_msg *msg, const u8 *secret,
    207 			       size_t secret_len, const u8 *req_auth);
    208 int radius_msg_copy_attr(struct radius_msg *dst, struct radius_msg *src,
    209 			 u8 type);
    210 void radius_msg_make_authenticator(struct radius_msg *msg,
    211 				   const u8 *data, size_t len);
    212 struct radius_ms_mppe_keys *
    213 radius_msg_get_ms_keys(struct radius_msg *msg, struct radius_msg *sent_msg,
    214 		       const u8 *secret, size_t secret_len);
    215 struct radius_ms_mppe_keys *
    216 radius_msg_get_cisco_keys(struct radius_msg *msg, struct radius_msg *sent_msg,
    217 			  const u8 *secret, size_t secret_len);
    218 int radius_msg_add_mppe_keys(struct radius_msg *msg,
    219 			     const u8 *req_authenticator,
    220 			     const u8 *secret, size_t secret_len,
    221 			     const u8 *send_key, size_t send_key_len,
    222 			     const u8 *recv_key, size_t recv_key_len);
    223 struct radius_attr_hdr *
    224 radius_msg_add_attr_user_password(struct radius_msg *msg,
    225 				  const u8 *data, size_t data_len,
    226 				  const u8 *secret, size_t secret_len);
    227 int radius_msg_get_attr(struct radius_msg *msg, u8 type, u8 *buf, size_t len);
    228 int radius_msg_get_vlanid(struct radius_msg *msg);
    229 char * radius_msg_get_tunnel_password(struct radius_msg *msg, int *keylen,
    230 				      const u8 *secret, size_t secret_len,
    231 				      struct radius_msg *sent_msg);
    232 
    233 static inline int radius_msg_add_attr_int32(struct radius_msg *msg, u8 type,
    234 					    u32 value)
    235 {
    236 	u32 val = htonl(value);
    237 	return radius_msg_add_attr(msg, type, (u8 *) &val, 4) != NULL;
    238 }
    239 
    240 static inline int radius_msg_get_attr_int32(struct radius_msg *msg, u8 type,
    241 					    u32 *value)
    242 {
    243 	u32 val;
    244 	int res;
    245 	res = radius_msg_get_attr(msg, type, (u8 *) &val, 4);
    246 	if (res != 4)
    247 		return -1;
    248 
    249 	*value = ntohl(val);
    250 	return 0;
    251 }
    252 int radius_msg_get_attr_ptr(struct radius_msg *msg, u8 type, u8 **buf,
    253 			    size_t *len, const u8 *start);
    254 int radius_msg_count_attr(struct radius_msg *msg, u8 type, int min_len);
    255 
    256 
    257 struct radius_attr_data {
    258 	u8 *data;
    259 	size_t len;
    260 };
    261 
    262 struct radius_class_data {
    263 	struct radius_attr_data *attr;
    264 	size_t count;
    265 };
    266 
    267 void radius_free_class(struct radius_class_data *c);
    268 int radius_copy_class(struct radius_class_data *dst,
    269 		      const struct radius_class_data *src);
    270 
    271 #endif /* RADIUS_H */
    272