radius.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  1. /*
  2. * RADIUS message processing
  3. * Copyright (c) 2002-2009, 2012, 2014-2015, Jouni Malinen <j@w1.fi>
  4. *
  5. * This software may be distributed under the terms of the BSD license.
  6. * See README for more details.
  7. */
  8. #ifndef RADIUS_H
  9. #define RADIUS_H
  10. /* RFC 2865 - RADIUS */
  11. #ifdef _MSC_VER
  12. #pragma pack(push, 1)
  13. #endif /* _MSC_VER */
  14. struct radius_hdr {
  15. u8 code;
  16. u8 identifier;
  17. be16 length; /* including this header */
  18. u8 authenticator[16];
  19. /* followed by length-20 octets of attributes */
  20. } STRUCT_PACKED;
  21. enum { RADIUS_CODE_ACCESS_REQUEST = 1,
  22. RADIUS_CODE_ACCESS_ACCEPT = 2,
  23. RADIUS_CODE_ACCESS_REJECT = 3,
  24. RADIUS_CODE_ACCOUNTING_REQUEST = 4,
  25. RADIUS_CODE_ACCOUNTING_RESPONSE = 5,
  26. RADIUS_CODE_ACCESS_CHALLENGE = 11,
  27. RADIUS_CODE_STATUS_SERVER = 12,
  28. RADIUS_CODE_STATUS_CLIENT = 13,
  29. RADIUS_CODE_DISCONNECT_REQUEST = 40,
  30. RADIUS_CODE_DISCONNECT_ACK = 41,
  31. RADIUS_CODE_DISCONNECT_NAK = 42,
  32. RADIUS_CODE_COA_REQUEST = 43,
  33. RADIUS_CODE_COA_ACK = 44,
  34. RADIUS_CODE_COA_NAK = 45,
  35. RADIUS_CODE_RESERVED = 255
  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. #define RADIUS_MAX_ATTR_LEN (255 - sizeof(struct radius_attr_hdr))
  43. enum { RADIUS_ATTR_USER_NAME = 1,
  44. RADIUS_ATTR_USER_PASSWORD = 2,
  45. RADIUS_ATTR_NAS_IP_ADDRESS = 4,
  46. RADIUS_ATTR_NAS_PORT = 5,
  47. RADIUS_ATTR_SERVICE_TYPE = 6,
  48. RADIUS_ATTR_FRAMED_IP_ADDRESS = 8,
  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_EGRESS_VLANID = 56,
  77. RADIUS_ATTR_NAS_PORT_TYPE = 61,
  78. RADIUS_ATTR_TUNNEL_TYPE = 64,
  79. RADIUS_ATTR_TUNNEL_MEDIUM_TYPE = 65,
  80. RADIUS_ATTR_TUNNEL_PASSWORD = 69,
  81. RADIUS_ATTR_CONNECT_INFO = 77,
  82. RADIUS_ATTR_EAP_MESSAGE = 79,
  83. RADIUS_ATTR_MESSAGE_AUTHENTICATOR = 80,
  84. RADIUS_ATTR_TUNNEL_PRIVATE_GROUP_ID = 81,
  85. RADIUS_ATTR_ACCT_INTERIM_INTERVAL = 85,
  86. RADIUS_ATTR_CHARGEABLE_USER_IDENTITY = 89,
  87. RADIUS_ATTR_NAS_IPV6_ADDRESS = 95,
  88. RADIUS_ATTR_ERROR_CAUSE = 101,
  89. RADIUS_ATTR_EAP_KEY_NAME = 102,
  90. RADIUS_ATTR_OPERATOR_NAME = 126,
  91. RADIUS_ATTR_LOCATION_INFO = 127,
  92. RADIUS_ATTR_LOCATION_DATA = 128,
  93. RADIUS_ATTR_BASIC_LOCATION_POLICY_RULES = 129,
  94. RADIUS_ATTR_EXTENDED_LOCATION_POLICY_RULES = 130,
  95. RADIUS_ATTR_LOCATION_CAPABLE = 131,
  96. RADIUS_ATTR_REQUESTED_LOCATION_INFO = 132,
  97. RADIUS_ATTR_MOBILITY_DOMAIN_ID = 177,
  98. RADIUS_ATTR_WLAN_HESSID = 181,
  99. RADIUS_ATTR_WLAN_REASON_CODE = 185,
  100. RADIUS_ATTR_WLAN_PAIRWISE_CIPHER = 186,
  101. RADIUS_ATTR_WLAN_GROUP_CIPHER = 187,
  102. RADIUS_ATTR_WLAN_AKM_SUITE = 188,
  103. RADIUS_ATTR_WLAN_GROUP_MGMT_CIPHER = 189,
  104. };
  105. /* Service-Type values (RFC 2865, 5.6) */
  106. #define RADIUS_SERVICE_TYPE_FRAMED 2
  107. /* Termination-Action */
  108. #define RADIUS_TERMINATION_ACTION_DEFAULT 0
  109. #define RADIUS_TERMINATION_ACTION_RADIUS_REQUEST 1
  110. /* NAS-Port-Type */
  111. #define RADIUS_NAS_PORT_TYPE_IEEE_802_11 19
  112. /* Acct-Status-Type */
  113. #define RADIUS_ACCT_STATUS_TYPE_START 1
  114. #define RADIUS_ACCT_STATUS_TYPE_STOP 2
  115. #define RADIUS_ACCT_STATUS_TYPE_INTERIM_UPDATE 3
  116. #define RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_ON 7
  117. #define RADIUS_ACCT_STATUS_TYPE_ACCOUNTING_OFF 8
  118. /* Acct-Authentic */
  119. #define RADIUS_ACCT_AUTHENTIC_RADIUS 1
  120. #define RADIUS_ACCT_AUTHENTIC_LOCAL 2
  121. #define RADIUS_ACCT_AUTHENTIC_REMOTE 3
  122. /* Acct-Terminate-Cause */
  123. #define RADIUS_ACCT_TERMINATE_CAUSE_USER_REQUEST 1
  124. #define RADIUS_ACCT_TERMINATE_CAUSE_LOST_CARRIER 2
  125. #define RADIUS_ACCT_TERMINATE_CAUSE_LOST_SERVICE 3
  126. #define RADIUS_ACCT_TERMINATE_CAUSE_IDLE_TIMEOUT 4
  127. #define RADIUS_ACCT_TERMINATE_CAUSE_SESSION_TIMEOUT 5
  128. #define RADIUS_ACCT_TERMINATE_CAUSE_ADMIN_RESET 6
  129. #define RADIUS_ACCT_TERMINATE_CAUSE_ADMIN_REBOOT 7
  130. #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_ERROR 8
  131. #define RADIUS_ACCT_TERMINATE_CAUSE_NAS_ERROR 9
  132. #define RADIUS_ACCT_TERMINATE_CAUSE_NAS_REQUEST 10
  133. #define RADIUS_ACCT_TERMINATE_CAUSE_NAS_REBOOT 11
  134. #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_UNNEEDED 12
  135. #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_PREEMPTED 13
  136. #define RADIUS_ACCT_TERMINATE_CAUSE_PORT_SUSPENDED 14
  137. #define RADIUS_ACCT_TERMINATE_CAUSE_SERVICE_UNAVAILABLE 15
  138. #define RADIUS_ACCT_TERMINATE_CAUSE_CALLBACK 16
  139. #define RADIUS_ACCT_TERMINATE_CAUSE_USER_ERROR 17
  140. #define RADIUS_ACCT_TERMINATE_CAUSE_HOST_REQUEST 18
  141. #define RADIUS_TUNNEL_TAGS 32
  142. /* Tunnel-Type */
  143. #define RADIUS_TUNNEL_TYPE_PPTP 1
  144. #define RADIUS_TUNNEL_TYPE_L2TP 3
  145. #define RADIUS_TUNNEL_TYPE_IPIP 7
  146. #define RADIUS_TUNNEL_TYPE_GRE 10
  147. #define RADIUS_TUNNEL_TYPE_VLAN 13
  148. /* Tunnel-Medium-Type */
  149. #define RADIUS_TUNNEL_MEDIUM_TYPE_IPV4 1
  150. #define RADIUS_TUNNEL_MEDIUM_TYPE_IPV6 2
  151. #define RADIUS_TUNNEL_MEDIUM_TYPE_802 6
  152. struct radius_attr_vendor {
  153. u8 vendor_type;
  154. u8 vendor_length;
  155. } STRUCT_PACKED;
  156. #define RADIUS_VENDOR_ID_CISCO 9
  157. #define RADIUS_CISCO_AV_PAIR 1
  158. /* RFC 2548 - Microsoft Vendor-specific RADIUS Attributes */
  159. #define RADIUS_VENDOR_ID_MICROSOFT 311
  160. enum { RADIUS_VENDOR_ATTR_MS_MPPE_SEND_KEY = 16,
  161. RADIUS_VENDOR_ATTR_MS_MPPE_RECV_KEY = 17
  162. };
  163. /* Hotspot 2.0 - WFA Vendor-specific RADIUS Attributes */
  164. #define RADIUS_VENDOR_ID_WFA 40808
  165. enum {
  166. RADIUS_VENDOR_ATTR_WFA_HS20_SUBSCR_REMEDIATION = 1,
  167. RADIUS_VENDOR_ATTR_WFA_HS20_AP_VERSION = 2,
  168. RADIUS_VENDOR_ATTR_WFA_HS20_STA_VERSION = 3,
  169. RADIUS_VENDOR_ATTR_WFA_HS20_DEAUTH_REQ = 4,
  170. RADIUS_VENDOR_ATTR_WFA_HS20_SESSION_INFO_URL = 5,
  171. };
  172. #ifdef _MSC_VER
  173. #pragma pack(pop)
  174. #endif /* _MSC_VER */
  175. struct radius_ms_mppe_keys {
  176. u8 *send;
  177. size_t send_len;
  178. u8 *recv;
  179. size_t recv_len;
  180. };
  181. struct radius_msg;
  182. /* Default size to be allocated for new RADIUS messages */
  183. #define RADIUS_DEFAULT_MSG_SIZE 1024
  184. /* Default size to be allocated for attribute array */
  185. #define RADIUS_DEFAULT_ATTR_COUNT 16
  186. /* MAC address ASCII format for IEEE 802.1X use
  187. * (draft-congdon-radius-8021x-20.txt) */
  188. #define RADIUS_802_1X_ADDR_FORMAT "%02X-%02X-%02X-%02X-%02X-%02X"
  189. /* MAC address ASCII format for non-802.1X use */
  190. #define RADIUS_ADDR_FORMAT "%02x%02x%02x%02x%02x%02x"
  191. struct radius_hdr * radius_msg_get_hdr(struct radius_msg *msg);
  192. struct wpabuf * radius_msg_get_buf(struct radius_msg *msg);
  193. struct radius_msg * radius_msg_new(u8 code, u8 identifier);
  194. void radius_msg_free(struct radius_msg *msg);
  195. void radius_msg_dump(struct radius_msg *msg);
  196. int radius_msg_finish(struct radius_msg *msg, const u8 *secret,
  197. size_t secret_len);
  198. int radius_msg_finish_srv(struct radius_msg *msg, const u8 *secret,
  199. size_t secret_len, const u8 *req_authenticator);
  200. int radius_msg_finish_das_resp(struct radius_msg *msg, const u8 *secret,
  201. size_t secret_len,
  202. const struct radius_hdr *req_hdr);
  203. void radius_msg_finish_acct(struct radius_msg *msg, const u8 *secret,
  204. size_t secret_len);
  205. void radius_msg_finish_acct_resp(struct radius_msg *msg, const u8 *secret,
  206. size_t secret_len,
  207. const u8 *req_authenticator);
  208. int radius_msg_verify_acct_req(struct radius_msg *msg, const u8 *secret,
  209. size_t secret_len);
  210. int radius_msg_verify_das_req(struct radius_msg *msg, const u8 *secret,
  211. size_t secret_len,
  212. int require_message_authenticator);
  213. struct radius_attr_hdr * radius_msg_add_attr(struct radius_msg *msg, u8 type,
  214. const u8 *data, size_t data_len);
  215. struct radius_msg * radius_msg_parse(const u8 *data, size_t len);
  216. int radius_msg_add_eap(struct radius_msg *msg, const u8 *data,
  217. size_t data_len);
  218. struct wpabuf * radius_msg_get_eap(struct radius_msg *msg);
  219. int radius_msg_verify(struct radius_msg *msg, const u8 *secret,
  220. size_t secret_len, struct radius_msg *sent_msg,
  221. int auth);
  222. int radius_msg_verify_msg_auth(struct radius_msg *msg, const u8 *secret,
  223. size_t secret_len, const u8 *req_auth);
  224. int radius_msg_copy_attr(struct radius_msg *dst, struct radius_msg *src,
  225. u8 type);
  226. int radius_msg_make_authenticator(struct radius_msg *msg);
  227. struct radius_ms_mppe_keys *
  228. radius_msg_get_ms_keys(struct radius_msg *msg, struct radius_msg *sent_msg,
  229. const u8 *secret, size_t secret_len);
  230. struct radius_ms_mppe_keys *
  231. radius_msg_get_cisco_keys(struct radius_msg *msg, struct radius_msg *sent_msg,
  232. const u8 *secret, size_t secret_len);
  233. int radius_msg_add_mppe_keys(struct radius_msg *msg,
  234. const u8 *req_authenticator,
  235. const u8 *secret, size_t secret_len,
  236. const u8 *send_key, size_t send_key_len,
  237. const u8 *recv_key, size_t recv_key_len);
  238. int radius_msg_add_wfa(struct radius_msg *msg, u8 subtype, const u8 *data,
  239. size_t len);
  240. int radius_user_password_hide(struct radius_msg *msg,
  241. const u8 *data, size_t data_len,
  242. const u8 *secret, size_t secret_len,
  243. u8 *buf, size_t buf_len);
  244. struct radius_attr_hdr *
  245. radius_msg_add_attr_user_password(struct radius_msg *msg,
  246. const u8 *data, size_t data_len,
  247. const u8 *secret, size_t secret_len);
  248. int radius_msg_get_attr(struct radius_msg *msg, u8 type, u8 *buf, size_t len);
  249. int radius_msg_get_vlanid(struct radius_msg *msg, int *untagged, int numtagged,
  250. int *tagged);
  251. char * radius_msg_get_tunnel_password(struct radius_msg *msg, int *keylen,
  252. const u8 *secret, size_t secret_len,
  253. struct radius_msg *sent_msg, size_t n);
  254. static inline int radius_msg_add_attr_int32(struct radius_msg *msg, u8 type,
  255. u32 value)
  256. {
  257. u32 val = htonl(value);
  258. return radius_msg_add_attr(msg, type, (u8 *) &val, 4) != NULL;
  259. }
  260. static inline int radius_msg_get_attr_int32(struct radius_msg *msg, u8 type,
  261. u32 *value)
  262. {
  263. u32 val;
  264. int res;
  265. res = radius_msg_get_attr(msg, type, (u8 *) &val, 4);
  266. if (res != 4)
  267. return -1;
  268. *value = ntohl(val);
  269. return 0;
  270. }
  271. int radius_msg_get_attr_ptr(struct radius_msg *msg, u8 type, u8 **buf,
  272. size_t *len, const u8 *start);
  273. int radius_msg_count_attr(struct radius_msg *msg, u8 type, int min_len);
  274. struct radius_attr_data {
  275. u8 *data;
  276. size_t len;
  277. };
  278. struct radius_class_data {
  279. struct radius_attr_data *attr;
  280. size_t count;
  281. };
  282. void radius_free_class(struct radius_class_data *c);
  283. int radius_copy_class(struct radius_class_data *dst,
  284. const struct radius_class_data *src);
  285. u8 radius_msg_find_unlisted_attr(struct radius_msg *msg, u8 *attrs);
  286. int radius_gen_session_id(u8 *id, size_t len);
  287. #endif /* RADIUS_H */