ikev2_common.h 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338
  1. /*
  2. * IKEv2 definitions
  3. * Copyright (c) 2007, 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 IKEV2_COMMON_H
  9. #define IKEV2_COMMON_H
  10. /*
  11. * Nonce length must be at least 16 octets. It must also be at least half the
  12. * key size of the negotiated PRF.
  13. */
  14. #define IKEV2_NONCE_MIN_LEN 16
  15. #define IKEV2_NONCE_MAX_LEN 256
  16. /* IKE Header - RFC 4306, Sect. 3.1 */
  17. #ifdef _MSC_VER
  18. #pragma pack(push, 1)
  19. #endif /* _MSC_VER */
  20. #define IKEV2_SPI_LEN 8
  21. struct ikev2_hdr {
  22. u8 i_spi[IKEV2_SPI_LEN]; /* IKE_SA Initiator's SPI */
  23. u8 r_spi[IKEV2_SPI_LEN]; /* IKE_SA Responder's SPI */
  24. u8 next_payload;
  25. u8 version; /* MjVer | MnVer */
  26. u8 exchange_type;
  27. u8 flags;
  28. u8 message_id[4];
  29. u8 length[4]; /* total length of HDR + payloads */
  30. } STRUCT_PACKED;
  31. struct ikev2_payload_hdr {
  32. u8 next_payload;
  33. u8 flags;
  34. u8 payload_length[2]; /* this payload, including the payload header */
  35. } STRUCT_PACKED;
  36. struct ikev2_proposal {
  37. u8 type; /* 0 (last) or 2 (more) */
  38. u8 reserved;
  39. u8 proposal_length[2]; /* including all transform and attributes */
  40. u8 proposal_num;
  41. u8 protocol_id; /* IKEV2_PROTOCOL_* */
  42. u8 spi_size;
  43. u8 num_transforms;
  44. /* SPI of spi_size octets */
  45. /* Transforms */
  46. } STRUCT_PACKED;
  47. struct ikev2_transform {
  48. u8 type; /* 0 (last) or 3 (more) */
  49. u8 reserved;
  50. u8 transform_length[2]; /* including Header and Attributes */
  51. u8 transform_type;
  52. u8 reserved2;
  53. u8 transform_id[2];
  54. /* Transform Attributes */
  55. } STRUCT_PACKED;
  56. #ifdef _MSC_VER
  57. #pragma pack(pop)
  58. #endif /* _MSC_VER */
  59. /* Current IKEv2 version from RFC 4306 */
  60. #define IKEV2_MjVer 2
  61. #define IKEV2_MnVer 0
  62. #ifdef CCNS_PL
  63. #define IKEV2_VERSION ((IKEV2_MjVer) | ((IKEV2_MnVer) << 4))
  64. #else /* CCNS_PL */
  65. #define IKEV2_VERSION (((IKEV2_MjVer) << 4) | (IKEV2_MnVer))
  66. #endif /* CCNS_PL */
  67. /* IKEv2 Exchange Types */
  68. enum {
  69. /* 0-33 RESERVED */
  70. IKE_SA_INIT = 34,
  71. IKE_SA_AUTH = 35,
  72. CREATE_CHILD_SA = 36,
  73. INFORMATION = 37
  74. /* 38-239 RESERVED TO IANA */
  75. /* 240-255 Reserved for private use */
  76. };
  77. /* IKEv2 Flags */
  78. #define IKEV2_HDR_INITIATOR 0x08
  79. #define IKEV2_HDR_VERSION 0x10
  80. #define IKEV2_HDR_RESPONSE 0x20
  81. /* Payload Header Flags */
  82. #define IKEV2_PAYLOAD_FLAGS_CRITICAL 0x01
  83. /* EAP-IKEv2 Payload Types (in Next Payload Type field)
  84. * http://www.iana.org/assignments/eap-ikev2-payloads */
  85. enum {
  86. IKEV2_PAYLOAD_NO_NEXT_PAYLOAD = 0,
  87. IKEV2_PAYLOAD_SA = 33,
  88. IKEV2_PAYLOAD_KEY_EXCHANGE = 34,
  89. IKEV2_PAYLOAD_IDi = 35,
  90. IKEV2_PAYLOAD_IDr = 36,
  91. IKEV2_PAYLOAD_CERTIFICATE = 37,
  92. IKEV2_PAYLOAD_CERT_REQ = 38,
  93. IKEV2_PAYLOAD_AUTHENTICATION = 39,
  94. IKEV2_PAYLOAD_NONCE = 40,
  95. IKEV2_PAYLOAD_NOTIFICATION = 41,
  96. IKEV2_PAYLOAD_VENDOD_ID = 43,
  97. IKEV2_PAYLOAD_ENCRYPTED = 46,
  98. IKEV2_PAYLOAD_NEXT_FAST_ID = 121
  99. };
  100. /* IKEv2 Proposal - Protocol ID */
  101. enum {
  102. IKEV2_PROTOCOL_RESERVED = 0,
  103. IKEV2_PROTOCOL_IKE = 1, /* IKE is the only one allowed for EAP-IKEv2 */
  104. IKEV2_PROTOCOL_AH = 2,
  105. IKEV2_PROTOCOL_ESP = 3
  106. };
  107. /* IKEv2 Transform Types */
  108. enum {
  109. IKEV2_TRANSFORM_ENCR = 1,
  110. IKEV2_TRANSFORM_PRF = 2,
  111. IKEV2_TRANSFORM_INTEG = 3,
  112. IKEV2_TRANSFORM_DH = 4,
  113. IKEV2_TRANSFORM_ESN = 5
  114. };
  115. /* IKEv2 Transform Type 1 (Encryption Algorithm) */
  116. enum {
  117. ENCR_DES_IV64 = 1,
  118. ENCR_DES = 2,
  119. ENCR_3DES = 3,
  120. ENCR_RC5 = 4,
  121. ENCR_IDEA = 5,
  122. ENCR_CAST = 6,
  123. ENCR_BLOWFISH = 7,
  124. ENCR_3IDEA = 8,
  125. ENCR_DES_IV32 = 9,
  126. ENCR_NULL = 11,
  127. ENCR_AES_CBC = 12,
  128. ENCR_AES_CTR = 13
  129. };
  130. /* IKEv2 Transform Type 2 (Pseudo-random Function) */
  131. enum {
  132. PRF_HMAC_MD5 = 1,
  133. PRF_HMAC_SHA1 = 2,
  134. PRF_HMAC_TIGER = 3,
  135. PRF_AES128_XCBC = 4
  136. };
  137. /* IKEv2 Transform Type 3 (Integrity Algorithm) */
  138. enum {
  139. AUTH_HMAC_MD5_96 = 1,
  140. AUTH_HMAC_SHA1_96 = 2,
  141. AUTH_DES_MAC = 3,
  142. AUTH_KPDK_MD5 = 4,
  143. AUTH_AES_XCBC_96 = 5
  144. };
  145. /* IKEv2 Transform Type 4 (Diffie-Hellman Group) */
  146. enum {
  147. DH_GROUP1_768BIT_MODP = 1, /* RFC 4306 */
  148. DH_GROUP2_1024BIT_MODP = 2, /* RFC 4306 */
  149. DH_GROUP5_1536BIT_MODP = 5, /* RFC 3526 */
  150. DH_GROUP5_2048BIT_MODP = 14, /* RFC 3526 */
  151. DH_GROUP5_3072BIT_MODP = 15, /* RFC 3526 */
  152. DH_GROUP5_4096BIT_MODP = 16, /* RFC 3526 */
  153. DH_GROUP5_6144BIT_MODP = 17, /* RFC 3526 */
  154. DH_GROUP5_8192BIT_MODP = 18 /* RFC 3526 */
  155. };
  156. /* Identification Data Types (RFC 4306, Sect. 3.5) */
  157. enum {
  158. ID_IPV4_ADDR = 1,
  159. ID_FQDN = 2,
  160. ID_RFC822_ADDR = 3,
  161. ID_IPV6_ADDR = 5,
  162. ID_DER_ASN1_DN = 9,
  163. ID_DER_ASN1_GN= 10,
  164. ID_KEY_ID = 11
  165. };
  166. /* Certificate Encoding (RFC 4306, Sect. 3.6) */
  167. enum {
  168. CERT_ENCODING_PKCS7_X509 = 1,
  169. CERT_ENCODING_PGP_CERT = 2,
  170. CERT_ENCODING_DNS_SIGNED_KEY = 3,
  171. /* X.509 Certificate - Signature: DER encoded X.509 certificate whose
  172. * public key is used to validate the sender's AUTH payload */
  173. CERT_ENCODING_X509_CERT_SIGN = 4,
  174. CERT_ENCODING_KERBEROS_TOKEN = 6,
  175. /* DER encoded X.509 certificate revocation list */
  176. CERT_ENCODING_CRL = 7,
  177. CERT_ENCODING_ARL = 8,
  178. CERT_ENCODING_SPKI_CERT = 9,
  179. CERT_ENCODING_X509_CERT_ATTR = 10,
  180. /* PKCS #1 encoded RSA key */
  181. CERT_ENCODING_RAW_RSA_KEY = 11,
  182. CERT_ENCODING_HASH_AND_URL_X509_CERT = 12,
  183. CERT_ENCODING_HASH_AND_URL_X509_BUNDLE = 13
  184. };
  185. /* Authentication Method (RFC 4306, Sect. 3.8) */
  186. enum {
  187. AUTH_RSA_SIGN = 1,
  188. AUTH_SHARED_KEY_MIC = 2,
  189. AUTH_DSS_SIGN = 3
  190. };
  191. /* Notify Message Types (RFC 4306, Sect. 3.10.1) */
  192. enum {
  193. UNSUPPORTED_CRITICAL_PAYLOAD = 1,
  194. INVALID_IKE_SPI = 4,
  195. INVALID_MAJOR_VERSION = 5,
  196. INVALID_SYNTAX = 7,
  197. INVALID_MESSAGE_ID = 9,
  198. INVALID_SPI = 11,
  199. NO_PROPOSAL_CHOSEN = 14,
  200. INVALID_KE_PAYLOAD = 17,
  201. AUTHENTICATION_FAILED = 24,
  202. SINGLE_PAIR_REQUIRED = 34,
  203. NO_ADDITIONAL_SAS = 35,
  204. INTERNAL_ADDRESS_FAILURE = 36,
  205. FAILED_CP_REQUIRED = 37,
  206. TS_UNACCEPTABLE = 38,
  207. INVALID_SELECTORS = 39
  208. };
  209. struct ikev2_keys {
  210. u8 *SK_d, *SK_ai, *SK_ar, *SK_ei, *SK_er, *SK_pi, *SK_pr;
  211. size_t SK_d_len, SK_integ_len, SK_encr_len, SK_prf_len;
  212. };
  213. int ikev2_keys_set(struct ikev2_keys *keys);
  214. void ikev2_free_keys(struct ikev2_keys *keys);
  215. /* Maximum hash length for supported hash algorithms */
  216. #define IKEV2_MAX_HASH_LEN 20
  217. struct ikev2_integ_alg {
  218. int id;
  219. size_t key_len;
  220. size_t hash_len;
  221. };
  222. struct ikev2_prf_alg {
  223. int id;
  224. size_t key_len;
  225. size_t hash_len;
  226. };
  227. struct ikev2_encr_alg {
  228. int id;
  229. size_t key_len;
  230. size_t block_size;
  231. };
  232. const struct ikev2_integ_alg * ikev2_get_integ(int id);
  233. int ikev2_integ_hash(int alg, const u8 *key, size_t key_len, const u8 *data,
  234. size_t data_len, u8 *hash);
  235. const struct ikev2_prf_alg * ikev2_get_prf(int id);
  236. int ikev2_prf_hash(int alg, const u8 *key, size_t key_len,
  237. size_t num_elem, const u8 *addr[], const size_t *len,
  238. u8 *hash);
  239. int ikev2_prf_plus(int alg, const u8 *key, size_t key_len,
  240. const u8 *data, size_t data_len,
  241. u8 *out, size_t out_len);
  242. const struct ikev2_encr_alg * ikev2_get_encr(int id);
  243. int ikev2_encr_encrypt(int alg, const u8 *key, size_t key_len, const u8 *iv,
  244. const u8 *plain, u8 *crypt, size_t len);
  245. int ikev2_encr_decrypt(int alg, const u8 *key, size_t key_len, const u8 *iv,
  246. const u8 *crypt, u8 *plain, size_t len);
  247. int ikev2_derive_auth_data(int prf_alg, const struct wpabuf *sign_msg,
  248. const u8 *ID, size_t ID_len, u8 ID_type,
  249. struct ikev2_keys *keys, int initiator,
  250. const u8 *shared_secret, size_t shared_secret_len,
  251. const u8 *nonce, size_t nonce_len,
  252. const u8 *key_pad, size_t key_pad_len,
  253. u8 *auth_data);
  254. struct ikev2_payloads {
  255. const u8 *sa;
  256. size_t sa_len;
  257. const u8 *ke;
  258. size_t ke_len;
  259. const u8 *idi;
  260. size_t idi_len;
  261. const u8 *idr;
  262. size_t idr_len;
  263. const u8 *cert;
  264. size_t cert_len;
  265. const u8 *auth;
  266. size_t auth_len;
  267. const u8 *nonce;
  268. size_t nonce_len;
  269. const u8 *encrypted;
  270. size_t encrypted_len;
  271. u8 encr_next_payload;
  272. const u8 *notification;
  273. size_t notification_len;
  274. };
  275. int ikev2_parse_payloads(struct ikev2_payloads *payloads,
  276. u8 next_payload, const u8 *pos, const u8 *end);
  277. u8 * ikev2_decrypt_payload(int encr_id, int integ_id, struct ikev2_keys *keys,
  278. int initiator, const struct ikev2_hdr *hdr,
  279. const u8 *encrypted, size_t encrypted_len,
  280. size_t *res_len);
  281. void ikev2_update_hdr(struct wpabuf *msg);
  282. int ikev2_build_encrypted(int encr_id, int integ_id, struct ikev2_keys *keys,
  283. int initiator, struct wpabuf *msg,
  284. struct wpabuf *plain, u8 next_payload);
  285. int ikev2_derive_sk_keys(const struct ikev2_prf_alg *prf,
  286. const struct ikev2_integ_alg *integ,
  287. const struct ikev2_encr_alg *encr,
  288. const u8 *skeyseed, const u8 *data, size_t data_len,
  289. struct ikev2_keys *keys);
  290. #endif /* IKEV2_COMMON_H */