1231200Smm/* 2232153Smm * IKEv2 definitions 3231200Smm * Copyright (c) 2007, Jouni Malinen <j@w1.fi> 4231200Smm * 5231200Smm * This software may be distributed under the terms of the BSD license. 6231200Smm * See README for more details. 7231200Smm */ 8231200Smm 9231200Smm#ifndef IKEV2_COMMON_H 10231200Smm#define IKEV2_COMMON_H 11231200Smm 12231200Smm/* 13231200Smm * Nonce length must be at least 16 octets. It must also be at least half the 14231200Smm * key size of the negotiated PRF. 15231200Smm */ 16231200Smm#define IKEV2_NONCE_MIN_LEN 16 17231200Smm#define IKEV2_NONCE_MAX_LEN 256 18231200Smm 19231200Smm/* IKE Header - RFC 4306, Sect. 3.1 */ 20231200Smm#ifdef _MSC_VER 21231200Smm#pragma pack(push, 1) 22231200Smm#endif /* _MSC_VER */ 23231200Smm 24231200Smm#define IKEV2_SPI_LEN 8 25231200Smm 26231200Smmstruct ikev2_hdr { 27231200Smm u8 i_spi[IKEV2_SPI_LEN]; /* IKE_SA Initiator's SPI */ 28231200Smm u8 r_spi[IKEV2_SPI_LEN]; /* IKE_SA Responder's SPI */ 29231200Smm u8 next_payload; 30231200Smm u8 version; /* MjVer | MnVer */ 31231200Smm u8 exchange_type; 32231200Smm u8 flags; 33231200Smm u8 message_id[4]; 34231200Smm u8 length[4]; /* total length of HDR + payloads */ 35231200Smm} STRUCT_PACKED; 36231200Smm 37231200Smmstruct ikev2_payload_hdr { 38231200Smm u8 next_payload; 39231200Smm u8 flags; 40231200Smm u8 payload_length[2]; /* this payload, including the payload header */ 41231200Smm} STRUCT_PACKED; 42231200Smm 43231200Smmstruct ikev2_proposal { 44231200Smm u8 type; /* 0 (last) or 2 (more) */ 45231200Smm u8 reserved; 46231200Smm u8 proposal_length[2]; /* including all transform and attributes */ 47231200Smm u8 proposal_num; 48231200Smm u8 protocol_id; /* IKEV2_PROTOCOL_* */ 49231200Smm u8 spi_size; 50231200Smm u8 num_transforms; 51231200Smm /* SPI of spi_size octets */ 52231200Smm /* Transforms */ 53231200Smm} STRUCT_PACKED; 54231200Smm 55231200Smmstruct ikev2_transform { 56231200Smm u8 type; /* 0 (last) or 3 (more) */ 57231200Smm u8 reserved; 58231200Smm u8 transform_length[2]; /* including Header and Attributes */ 59231200Smm u8 transform_type; 60231200Smm u8 reserved2; 61231200Smm u8 transform_id[2]; 62231200Smm /* Transform Attributes */ 63231200Smm} STRUCT_PACKED; 64231200Smm 65231200Smm#ifdef _MSC_VER 66231200Smm#pragma pack(pop) 67231200Smm#endif /* _MSC_VER */ 68231200Smm 69231200Smm 70311042Smm/* Current IKEv2 version from RFC 4306 */ 71231200Smm#define IKEV2_MjVer 2 72231200Smm#define IKEV2_MnVer 0 73231200Smm#ifdef CCNS_PL 74231200Smm#define IKEV2_VERSION ((IKEV2_MjVer) | ((IKEV2_MnVer) << 4)) 75231200Smm#else /* CCNS_PL */ 76231200Smm#define IKEV2_VERSION (((IKEV2_MjVer) << 4) | (IKEV2_MnVer)) 77231200Smm#endif /* CCNS_PL */ 78231200Smm 79231200Smm/* IKEv2 Exchange Types */ 80231200Smmenum { 81231200Smm /* 0-33 RESERVED */ 82231200Smm IKE_SA_INIT = 34, 83231200Smm IKE_SA_AUTH = 35, 84231200Smm CREATE_CHILD_SA = 36, 85231200Smm INFORMATION = 37 86231200Smm /* 38-239 RESERVED TO IANA */ 87231200Smm /* 240-255 Reserved for private use */ 88231200Smm}; 89231200Smm 90231200Smm/* IKEv2 Flags */ 91231200Smm#define IKEV2_HDR_INITIATOR 0x08 92231200Smm#define IKEV2_HDR_VERSION 0x10 93231200Smm#define IKEV2_HDR_RESPONSE 0x20 94231200Smm 95231200Smm/* Payload Header Flags */ 96231200Smm#define IKEV2_PAYLOAD_FLAGS_CRITICAL 0x01 97231200Smm 98231200Smm 99231200Smm/* EAP-IKEv2 Payload Types (in Next Payload Type field) 100231200Smm * http://www.iana.org/assignments/eap-ikev2-payloads */ 101231200Smmenum { 102231200Smm IKEV2_PAYLOAD_NO_NEXT_PAYLOAD = 0, 103231200Smm IKEV2_PAYLOAD_SA = 33, 104231200Smm IKEV2_PAYLOAD_KEY_EXCHANGE = 34, 105231200Smm IKEV2_PAYLOAD_IDi = 35, 106231200Smm IKEV2_PAYLOAD_IDr = 36, 107231200Smm IKEV2_PAYLOAD_CERTIFICATE = 37, 108231200Smm IKEV2_PAYLOAD_CERT_REQ = 38, 109231200Smm IKEV2_PAYLOAD_AUTHENTICATION = 39, 110231200Smm IKEV2_PAYLOAD_NONCE = 40, 111231200Smm IKEV2_PAYLOAD_NOTIFICATION = 41, 112231200Smm IKEV2_PAYLOAD_VENDOD_ID = 43, 113231200Smm IKEV2_PAYLOAD_ENCRYPTED = 46, 114231200Smm IKEV2_PAYLOAD_NEXT_FAST_ID = 121 115231200Smm}; 116231200Smm 117231200Smm 118231200Smm/* IKEv2 Proposal - Protocol ID */ 119231200Smmenum { 120231200Smm IKEV2_PROTOCOL_RESERVED = 0, 121231200Smm IKEV2_PROTOCOL_IKE = 1, /* IKE is the only one allowed for EAP-IKEv2 */ 122231200Smm IKEV2_PROTOCOL_AH = 2, 123231200Smm IKEV2_PROTOCOL_ESP = 3 124231200Smm}; 125231200Smm 126231200Smm 127231200Smm/* IKEv2 Transform Types */ 128231200Smmenum { 129231200Smm IKEV2_TRANSFORM_ENCR = 1, 130231200Smm IKEV2_TRANSFORM_PRF = 2, 131231200Smm IKEV2_TRANSFORM_INTEG = 3, 132231200Smm IKEV2_TRANSFORM_DH = 4, 133231200Smm IKEV2_TRANSFORM_ESN = 5 134231200Smm}; 135231200Smm 136231200Smm/* IKEv2 Transform Type 1 (Encryption Algorithm) */ 137231200Smmenum { 138231200Smm ENCR_DES_IV64 = 1, 139231200Smm ENCR_DES = 2, 140231200Smm ENCR_3DES = 3, 141231200Smm ENCR_RC5 = 4, 142231200Smm ENCR_IDEA = 5, 143231200Smm ENCR_CAST = 6, 144231200Smm ENCR_BLOWFISH = 7, 145231200Smm ENCR_3IDEA = 8, 146231200Smm ENCR_DES_IV32 = 9, 147231200Smm ENCR_NULL = 11, 148231200Smm ENCR_AES_CBC = 12, 149231200Smm ENCR_AES_CTR = 13 150231200Smm}; 151231200Smm 152231200Smm/* IKEv2 Transform Type 2 (Pseudo-random Function) */ 153231200Smmenum { 154231200Smm PRF_HMAC_MD5 = 1, 155231200Smm PRF_HMAC_SHA1 = 2, 156231200Smm PRF_HMAC_TIGER = 3, 157231200Smm PRF_AES128_XCBC = 4 158231200Smm}; 159231200Smm 160231200Smm/* IKEv2 Transform Type 3 (Integrity Algorithm) */ 161231200Smmenum { 162231200Smm AUTH_HMAC_MD5_96 = 1, 163231200Smm AUTH_HMAC_SHA1_96 = 2, 164231200Smm AUTH_DES_MAC = 3, 165231200Smm AUTH_KPDK_MD5 = 4, 166231200Smm AUTH_AES_XCBC_96 = 5 167231200Smm}; 168231200Smm 169231200Smm/* IKEv2 Transform Type 4 (Diffie-Hellman Group) */ 170231200Smmenum { 171231200Smm DH_GROUP1_768BIT_MODP = 1, /* RFC 4306 */ 172231200Smm DH_GROUP2_1024BIT_MODP = 2, /* RFC 4306 */ 173231200Smm DH_GROUP5_1536BIT_MODP = 5, /* RFC 3526 */ 174231200Smm DH_GROUP5_2048BIT_MODP = 14, /* RFC 3526 */ 175231200Smm DH_GROUP5_3072BIT_MODP = 15, /* RFC 3526 */ 176231200Smm DH_GROUP5_4096BIT_MODP = 16, /* RFC 3526 */ 177231200Smm DH_GROUP5_6144BIT_MODP = 17, /* RFC 3526 */ 178231200Smm DH_GROUP5_8192BIT_MODP = 18 /* RFC 3526 */ 179231200Smm}; 180231200Smm 181231200Smm 182316338Smm/* Identification Data Types (RFC 4306, Sect. 3.5) */ 183231200Smmenum { 184231200Smm ID_IPV4_ADDR = 1, 185231200Smm ID_FQDN = 2, 186231200Smm ID_RFC822_ADDR = 3, 187231200Smm ID_IPV6_ADDR = 5, 188231200Smm ID_DER_ASN1_DN = 9, 189231200Smm ID_DER_ASN1_GN= 10, 190231200Smm ID_KEY_ID = 11 191231200Smm}; 192231200Smm 193231200Smm 194231200Smm/* Certificate Encoding (RFC 4306, Sect. 3.6) */ 195231200Smmenum { 196231200Smm CERT_ENCODING_PKCS7_X509 = 1, 197231200Smm CERT_ENCODING_PGP_CERT = 2, 198231200Smm CERT_ENCODING_DNS_SIGNED_KEY = 3, 199231200Smm /* X.509 Certificate - Signature: DER encoded X.509 certificate whose 200231200Smm * public key is used to validate the sender's AUTH payload */ 201231200Smm CERT_ENCODING_X509_CERT_SIGN = 4, 202231200Smm CERT_ENCODING_KERBEROS_TOKEN = 6, 203231200Smm /* DER encoded X.509 certificate revocation list */ 204231200Smm CERT_ENCODING_CRL = 7, 205231200Smm CERT_ENCODING_ARL = 8, 206231200Smm CERT_ENCODING_SPKI_CERT = 9, 207231200Smm CERT_ENCODING_X509_CERT_ATTR = 10, 208231200Smm /* PKCS #1 encoded RSA key */ 209231200Smm CERT_ENCODING_RAW_RSA_KEY = 11, 210231200Smm CERT_ENCODING_HASH_AND_URL_X509_CERT = 12, 211231200Smm CERT_ENCODING_HASH_AND_URL_X509_BUNDLE = 13 212231200Smm}; 213231200Smm 214231200Smm 215231200Smm/* Authentication Method (RFC 4306, Sect. 3.8) */ 216231200Smmenum { 217231200Smm AUTH_RSA_SIGN = 1, 218231200Smm AUTH_SHARED_KEY_MIC = 2, 219231200Smm AUTH_DSS_SIGN = 3 220231200Smm}; 221231200Smm 222231200Smm 223231200Smm/* Notify Message Types (RFC 4306, Sect. 3.10.1) */ 224231200Smmenum { 225231200Smm UNSUPPORTED_CRITICAL_PAYLOAD = 1, 226231200Smm INVALID_IKE_SPI = 4, 227231200Smm INVALID_MAJOR_VERSION = 5, 228231200Smm INVALID_SYNTAX = 7, 229231200Smm INVALID_MESSAGE_ID = 9, 230231200Smm INVALID_SPI = 11, 231231200Smm NO_PROPOSAL_CHOSEN = 14, 232231200Smm INVALID_KE_PAYLOAD = 17, 233231200Smm AUTHENTICATION_FAILED = 24, 234231200Smm SINGLE_PAIR_REQUIRED = 34, 235231200Smm NO_ADDITIONAL_SAS = 35, 236231200Smm INTERNAL_ADDRESS_FAILURE = 36, 237231200Smm FAILED_CP_REQUIRED = 37, 238231200Smm TS_UNACCEPTABLE = 38, 239231200Smm INVALID_SELECTORS = 39 240231200Smm}; 241231200Smm 242231200Smm 243231200Smmstruct ikev2_keys { 244231200Smm u8 *SK_d, *SK_ai, *SK_ar, *SK_ei, *SK_er, *SK_pi, *SK_pr; 245231200Smm size_t SK_d_len, SK_integ_len, SK_encr_len, SK_prf_len; 246231200Smm}; 247231200Smm 248231200Smm 249231200Smmint ikev2_keys_set(struct ikev2_keys *keys); 250231200Smmvoid ikev2_free_keys(struct ikev2_keys *keys); 251231200Smm 252231200Smm 253231200Smm/* Maximum hash length for supported hash algorithms */ 254231200Smm#define IKEV2_MAX_HASH_LEN 20 255231200Smm 256231200Smmstruct ikev2_integ_alg { 257231200Smm int id; 258231200Smm size_t key_len; 259231200Smm size_t hash_len; 260231200Smm}; 261231200Smm 262231200Smmstruct ikev2_prf_alg { 263231200Smm int id; 264231200Smm size_t key_len; 265231200Smm size_t hash_len; 266231200Smm}; 267231200Smm 268231200Smmstruct ikev2_encr_alg { 269231200Smm int id; 270231200Smm size_t key_len; 271231200Smm size_t block_size; 272231200Smm}; 273231200Smm 274231200Smmconst struct ikev2_integ_alg * ikev2_get_integ(int id); 275231200Smmint ikev2_integ_hash(int alg, const u8 *key, size_t key_len, const u8 *data, 276231200Smm size_t data_len, u8 *hash); 277231200Smmconst struct ikev2_prf_alg * ikev2_get_prf(int id); 278231200Smmint ikev2_prf_hash(int alg, const u8 *key, size_t key_len, 279231200Smm size_t num_elem, const u8 *addr[], const size_t *len, 280231200Smm u8 *hash); 281231200Smmint ikev2_prf_plus(int alg, const u8 *key, size_t key_len, 282231200Smm const u8 *data, size_t data_len, 283231200Smm u8 *out, size_t out_len); 284231200Smmconst struct ikev2_encr_alg * ikev2_get_encr(int id); 285231200Smmint ikev2_encr_encrypt(int alg, const u8 *key, size_t key_len, const u8 *iv, 286231200Smm const u8 *plain, u8 *crypt, size_t len); 287238856Smmint ikev2_encr_decrypt(int alg, const u8 *key, size_t key_len, const u8 *iv, 288238856Smm const u8 *crypt, u8 *plain, size_t len); 289231200Smm 290231200Smmint ikev2_derive_auth_data(int prf_alg, const struct wpabuf *sign_msg, 291231200Smm const u8 *ID, size_t ID_len, u8 ID_type, 292231200Smm struct ikev2_keys *keys, int initiator, 293231200Smm const u8 *shared_secret, size_t shared_secret_len, 294231200Smm const u8 *nonce, size_t nonce_len, 295231200Smm const u8 *key_pad, size_t key_pad_len, 296231200Smm u8 *auth_data); 297231200Smm 298231200Smm 299231200Smmstruct ikev2_payloads { 300231200Smm const u8 *sa; 301231200Smm size_t sa_len; 302231200Smm const u8 *ke; 303231200Smm size_t ke_len; 304231200Smm const u8 *idi; 305231200Smm size_t idi_len; 306231200Smm const u8 *idr; 307231200Smm size_t idr_len; 308231200Smm const u8 *cert; 309231200Smm size_t cert_len; 310231200Smm const u8 *auth; 311231200Smm size_t auth_len; 312231200Smm const u8 *nonce; 313231200Smm size_t nonce_len; 314231200Smm const u8 *encrypted; 315231200Smm size_t encrypted_len; 316231200Smm u8 encr_next_payload; 317231200Smm const u8 *notification; 318231200Smm size_t notification_len; 319231200Smm}; 320231200Smm 321231200Smmint ikev2_parse_payloads(struct ikev2_payloads *payloads, 322231200Smm u8 next_payload, const u8 *pos, const u8 *end); 323231200Smm 324231200Smmu8 * ikev2_decrypt_payload(int encr_id, int integ_id, struct ikev2_keys *keys, 325231200Smm int initiator, const struct ikev2_hdr *hdr, 326231200Smm const u8 *encrypted, size_t encrypted_len, 327231200Smm size_t *res_len); 328231200Smmvoid ikev2_update_hdr(struct wpabuf *msg); 329231200Smmint ikev2_build_encrypted(int encr_id, int integ_id, struct ikev2_keys *keys, 330231200Smm int initiator, struct wpabuf *msg, 331231200Smm struct wpabuf *plain, u8 next_payload); 332231200Smmint ikev2_derive_sk_keys(const struct ikev2_prf_alg *prf, 333231200Smm const struct ikev2_integ_alg *integ, 334231200Smm const struct ikev2_encr_alg *encr, 335231200Smm const u8 *skeyseed, const u8 *data, size_t data_len, 336231200Smm struct ikev2_keys *keys); 337231200Smm 338231200Smm#endif /* IKEV2_COMMON_H */ 339231200Smm