raw_data/open5gs_source_code/lib/crypt/milenage.c

/*
 * 3GPP AKA - Milenage algorithm (3GPP TS 35.205, .206, .207, .208)
 * Copyright (c) 2006-2007 <j@w1.fi>
 *
 * This software may be distributed under the terms of the BSD license.
 * See README for more details.
 *
 * This file implements an example authentication algorithm defined for 3GPP
 * AKA. This can be used to implement a simple HLR/AuC into hlr_auc_gw to allow
 * EAP-AKA to be tested properly with real USIM cards.
 *
 * This implementations assumes that the r1..r5 and c1..c5 constants defined in
 * TS 35.206 are used, i.e., r1=64, r2=0, r3=32, r4=64, r5=96, c1=00..00,
 * c2=00..01, c3=00..02, c4=00..04, c5=00..08. The block cipher is assumed to
 * be AES (Rijndael).
 */
#include "ogs-crypt.h"

#include "milenage.h"

#define os_memcpy memcpy
#define os_memcmp memcmp
#define os_memcmp_const memcmp

static void ShiftBits(uint8_t r, uint8_t rijndaelInput[16],
                       uint8_t temp[16], const uint8_t opc[16]);
static uint8_t *bits_shift(uint32_t bit_valid, uint8_t *dst,
                            uint8_t *src, uint32_t numBits);

static int aes_128_encrypt_block(const uint8_t *key,
    const uint8_t *in, uint8_t *out)
{
    const int key_bits = 128;
    unsigned int rk[OGS_AES_RKLENGTH(128)];
    int nrounds;

    nrounds = ogs_aes_setup_enc(rk, key, key_bits);
    ogs_aes_encrypt(rk, nrounds, in, out);

    return 0;
}

/**
 * milenage_f1 - Milenage f1 and f1* algorithms
 * @opc: OPc = 128-bit value derived from OP and K
 * @k: K = 128-bit subscriber key
 * @_rand: RAND = 128-bit random challenge
 * @sqn: SQN = 48-bit sequence number
 * @amf: AMF = 16-bit authentication management field
 * @mac_a: Buffer for MAC-A = 64-bit network authentication code, or %NULL
 * @mac_s: Buffer for MAC-S = 64-bit resync authentication code, or %NULL
 * Returns: 0 on success, -1 on failure
 */
int milenage_f1(const uint8_t *opc, const uint8_t *k, 
    const uint8_t *_rand, const uint8_t *sqn, 
    const uint8_t *amf, uint8_t *mac_a, uint8_t *mac_s)
{
	uint8_t tmp1[16], tmp2[16], tmp3[16];
	int i;
#if 1 /* R1-R5 issues1153 */
    uint8_t r1 = 64;
#endif

	for (i = 0; i < 16; i++)
		tmp1[i] = _rand[i] ^ opc[i];
	if (aes_128_encrypt_block(k, tmp1, tmp1))
		return -1;

	/* tmp2 = IN1 = SQN || AMF || SQN || AMF */
	os_memcpy(tmp2, sqn, 6);
	os_memcpy(tmp2 + 6, amf, 2);
	os_memcpy(tmp2 + 8, tmp2, 8);

	/* OUT1 = E_K(TEMP XOR rot(IN1 XOR OP_C, r1) XOR c1) XOR OP_C */

	/* rotate (tmp2 XOR OP_C) by r1 (= 0x40 = 8 bytes) */
#if 0 /* R1-R5 issues1153 */
	for (i = 0; i < 16; i++)
		tmp3[(i + 8) % 16] = tmp2[i] ^ opc[i];
#else
    ShiftBits(r1, tmp3, tmp2, opc);
#endif
	/* XOR with TEMP = E_K(RAND XOR OP_C) */
	for (i = 0; i < 16; i++)
		tmp3[i] ^= tmp1[i];
	/* XOR with c1 (= ..00, i.e., NOP) */

	/* f1 || f1* = E_K(tmp3) XOR OP_c */
	if (aes_128_encrypt_block(k, tmp3, tmp1))
		return -1;
	for (i = 0; i < 16; i++)
		tmp1[i] ^= opc[i];
	if (mac_a)
		os_memcpy(mac_a, tmp1, 8); /* f1 */
	if (mac_s)
		os_memcpy(mac_s, tmp1 + 8, 8); /* f1* */
	return 0;
}


/**
 * milenage_f2345 - Milenage f2, f3, f4, f5, f5* algorithms
 * @opc: OPc = 128-bit value derived from OP and K
 * @k: K = 128-bit subscriber key
 * @_rand: RAND = 128-bit random challenge
 * @res: Buffer for RES = 64-bit signed response (f2), or %NULL
 * @ck: Buffer for CK = 128-bit confidentiality key (f3), or %NULL
 * @ik: Buffer for IK = 128-bit integrity key (f4), or %NULL
 * @ak: Buffer for AK = 48-bit anonymity key (f5), or %NULL
 * @akstar: Buffer for AK = 48-bit anonymity key (f5*), or %NULL
 * Returns: 0 on success, -1 on failure
 */
int milenage_f2345(const uint8_t *opc, const uint8_t *k, 
    const uint8_t *_rand, uint8_t *res, uint8_t *ck, 
    uint8_t *ik, uint8_t *ak, uint8_t *akstar)
{
	uint8_t tmp1[16], tmp2[16], tmp3[16];
	int i;

#if 1 /* R1-R5 issues1153 */
    uint8_t r2 = 0;
    uint8_t r3 = 32;
    uint8_t r4 = 64;
    uint8_t r5 = 96;
#endif

	/* tmp2 = TEMP = E_K(RAND XOR OP_C) */
	for (i = 0; i < 16; i++)
		tmp1[i] = _rand[i] ^ opc[i];
	if (aes_128_encrypt_block(k, tmp1, tmp2))
		return -1;

	/* OUT2 = E_K(rot(TEMP XOR OP_C, r2) XOR c2) XOR OP_C */
	/* OUT3 = E_K(rot(TEMP XOR OP_C, r3) XOR c3) XOR OP_C */
	/* OUT4 = E_K(rot(TEMP XOR OP_C, r4) XOR c4) XOR OP_C */
	/* OUT5 = E_K(rot(TEMP XOR OP_C, r5) XOR c5) XOR OP_C */

	/* f2 and f5 */
	/* rotate by r2 (= 0, i.e., NOP) */
#if 0 /* R1-R5 issues1153 */
	for (i = 0; i < 16; i++)
		tmp1[i] = tmp2[i] ^ opc[i];
#else
    ShiftBits(r2, tmp1, tmp2, opc);
#endif
	tmp1[15] ^= 1; /* XOR c2 (= ..01) */
	/* f5 || f2 = E_K(tmp1) XOR OP_c */
	if (aes_128_encrypt_block(k, tmp1, tmp3))
		return -1;
	for (i = 0; i < 16; i++)
		tmp3[i] ^= opc[i];
	if (res)
		os_memcpy(res, tmp3 + 8, 8); /* f2 */
	if (ak)
		os_memcpy(ak, tmp3, 6); /* f5 */

	/* f3 */
	if (ck) {
		/* rotate by r3 = 0x20 = 4 bytes */
#if 0 /* R1-R5 issues1153 */
		for (i = 0; i < 16; i++)
			tmp1[(i + 12) % 16] = tmp2[i] ^ opc[i];
#else
        ShiftBits(r3, tmp1, tmp2, opc);
#endif
		tmp1[15] ^= 2; /* XOR c3 (= ..02) */
		if (aes_128_encrypt_block(k, tmp1, ck))
			return -1;
		for (i = 0; i < 16; i++)
			ck[i] ^= opc[i];
	}

	/* f4 */
	if (ik) {
		/* rotate by r4 = 0x40 = 8 bytes */
#if 0 /* R1-R5 issues1153 */
		for (i = 0; i < 16; i++)
			tmp1[(i + 8) % 16] = tmp2[i] ^ opc[i];
#else
        ShiftBits(r4, tmp1, tmp2, opc);
#endif
		tmp1[15] ^= 4; /* XOR c4 (= ..04) */
		if (aes_128_encrypt_block(k, tmp1, ik))
			return -1;
		for (i = 0; i < 16; i++)
			ik[i] ^= opc[i];
	}

	/* f5* */
	if (akstar) {
		/* rotate by r5 = 0x60 = 12 bytes */
#if 0 /* R1-R5 issues1153 */
		for (i = 0; i < 16; i++)
			tmp1[(i + 4) % 16] = tmp2[i] ^ opc[i];
#else
        ShiftBits(r5, tmp1, tmp2, opc);
#endif
		tmp1[15] ^= 8; /* XOR c5 (= ..08) */
		if (aes_128_encrypt_block(k, tmp1, tmp1))
			return -1;
		for (i = 0; i < 6; i++)
			akstar[i] = tmp1[i] ^ opc[i];
	}

	return 0;
}


/**
 * milenage_generate - Generate AKA AUTN,IK,CK,RES
 * @opc: OPc = 128-bit operator variant algorithm configuration field (encr.)
 * @amf: AMF = 16-bit authentication management field
 * @k: K = 128-bit subscriber key
 * @sqn: SQN = 48-bit sequence number
 * @_rand: RAND = 128-bit random challenge
 * @autn: Buffer for AUTN = 128-bit authentication token
 * @ik: Buffer for IK = 128-bit integrity key (f4), or %NULL
 * @ck: Buffer for CK = 128-bit confidentiality key (f3), or %NULL
 * @res: Buffer for RES = 64-bit signed response (f2), or %NULL
 * @res_len: Max length for res; set to used length or 0 on failure
 */
void milenage_generate(const uint8_t *opc, const uint8_t *amf, 
    const uint8_t *k, const uint8_t *sqn, const uint8_t *_rand, 
    uint8_t *autn, uint8_t *ik, uint8_t *ck, uint8_t *ak, 
    uint8_t *res, size_t *res_len)
{
	int i;
	uint8_t mac_a[8];

	if (*res_len < 8) {
		*res_len = 0;
		return;
	}
	if (milenage_f1(opc, k, _rand, sqn, amf, mac_a, NULL) ||
	    milenage_f2345(opc, k, _rand, res, ck, ik, ak, NULL)) {
		*res_len = 0;
		return;
	}
	*res_len = 8;

	/* AUTN = (SQN ^ AK) || AMF || MAC */
	for (i = 0; i < 6; i++)
		autn[i] = sqn[i] ^ ak[i];
	os_memcpy(autn + 6, amf, 2);
	os_memcpy(autn + 8, mac_a, 8);
}

/**
 * milenage_auts - Milenage AUTS validation
 * @opc: OPc = 128-bit operator variant algorithm configuration field (encr.)
 * @k: K = 128-bit subscriber key
 * @_rand: RAND = 128-bit random challenge
 * @auts: AUTS = 112-bit authentication token from client
 * @sqn: Buffer for SQN = 48-bit sequence number
 * Returns: 0 = success (sqn filled), -1 on failure
 */
int milenage_auts(const uint8_t *opc, const uint8_t *k, 
    const uint8_t *_rand, const uint8_t *auts, uint8_t *sqn)
{
	uint8_t amf[2] = { 0x00, 0x00 }; /* TS 33.102 v7.0.0, 6.3.3 */
	uint8_t ak[6], mac_s[8];
	int i;

	if (milenage_f2345(opc, k, _rand, NULL, NULL, NULL, NULL, ak))
		return -1;
	for (i = 0; i < 6; i++)
		sqn[i] = auts[i] ^ ak[i];
	if (milenage_f1(opc, k, _rand, sqn, amf, NULL, mac_s) ||
	    os_memcmp_const(mac_s, auts + 6, 8) != 0)
		return -1;
	return 0;
}


/**
 * gsm_milenage - Generate GSM-Milenage (3GPP TS 55.205) authentication triplet
 * @opc: OPc = 128-bit operator variant algorithm configuration field (encr.)
 * @k: K = 128-bit subscriber key
 * @_rand: RAND = 128-bit random challenge
 * @sres: Buffer for SRES = 32-bit SRES
 * @kc: Buffer for Kc = 64-bit Kc
 * Returns: 0 on success, -1 on failure
 */
int gsm_milenage(const uint8_t *opc, const uint8_t *k, 
    const uint8_t *_rand, uint8_t *sres, uint8_t *kc)
{
	uint8_t res[8], ck[16], ik[16];
	int i;

	if (milenage_f2345(opc, k, _rand, res, ck, ik, NULL, NULL))
		return -1;

	for (i = 0; i < 8; i++)
		kc[i] = ck[i] ^ ck[i + 8] ^ ik[i] ^ ik[i + 8];

#ifdef GSM_MILENAGE_ALT_SRES
	os_memcpy(sres, res, 4);
#else /* GSM_MILENAGE_ALT_SRES */
	for (i = 0; i < 4; i++)
		sres[i] = res[i] ^ res[i + 4];
#endif /* GSM_MILENAGE_ALT_SRES */
	return 0;
}


/**
 * milenage_generate - Generate AKA AUTN,IK,CK,RES
 * @opc: OPc = 128-bit operator variant algorithm configuration field (encr.)
 * @k: K = 128-bit subscriber key
 * @sqn: SQN = 48-bit sequence number
 * @_rand: RAND = 128-bit random challenge
 * @autn: AUTN = 128-bit authentication token
 * @ik: Buffer for IK = 128-bit integrity key (f4), or %NULL
 * @ck: Buffer for CK = 128-bit confidentiality key (f3), or %NULL
 * @res: Buffer for RES = 64-bit signed response (f2), or %NULL
 * @res_len: Variable that will be set to RES length
 * @auts: 112-bit buffer for AUTS
 * Returns: 0 on success, -1 on failure, or -2 on synchronization failure
 */
int milenage_check(const uint8_t *opc, const uint8_t *k, 
    const uint8_t *sqn, const uint8_t *_rand, const uint8_t *autn, 
    uint8_t *ik, uint8_t *ck, uint8_t *res, size_t *res_len,
    uint8_t *auts)
{
	int i;
	uint8_t mac_a[8], ak[6], rx_sqn[6];
	const uint8_t *amf;

    ogs_log_print(OGS_LOG_INFO, "Milenage: AUTN\n");
    ogs_log_hexdump(OGS_LOG_INFO, autn, 16);
    ogs_log_print(OGS_LOG_INFO, "Milenage: RAND\n");
    ogs_log_hexdump(OGS_LOG_INFO, _rand, 16);

	if (milenage_f2345(opc, k, _rand, res, ck, ik, ak, NULL))
		return -1;

	*res_len = 8;
    ogs_log_print(OGS_LOG_INFO, "Milenage: RES\n");
    ogs_log_hexdump(OGS_LOG_INFO, res, *res_len);
    ogs_log_print(OGS_LOG_INFO, "Milenage: CK\n");
    ogs_log_hexdump(OGS_LOG_INFO, ck, 16);
    ogs_log_print(OGS_LOG_INFO, "Milenage: IK\n");
    ogs_log_hexdump(OGS_LOG_INFO, ik, 16);
    ogs_log_print(OGS_LOG_INFO, "Milenage: AK\n");
    ogs_log_hexdump(OGS_LOG_INFO, ak, 6);

	/* AUTN = (SQN ^ AK) || AMF || MAC */
	for (i = 0; i < 6; i++)
		rx_sqn[i] = autn[i] ^ ak[i];
    ogs_log_print(OGS_LOG_INFO, "Milenage: SQN\n");
    ogs_log_hexdump(OGS_LOG_INFO, rx_sqn, 6);

	if (os_memcmp(rx_sqn, sqn, 6) <= 0) {
		uint8_t auts_amf[2] = { 0x00, 0x00 }; /* TS 33.102 v7.0.0, 6.3.3 */
		if (milenage_f2345(opc, k, _rand, NULL, NULL, NULL, NULL, ak))
			return -1;
        ogs_log_print(OGS_LOG_INFO, "Milenage: AK*\n");
        ogs_log_hexdump(OGS_LOG_INFO, ak, 6);
		for (i = 0; i < 6; i++)
			auts[i] = sqn[i] ^ ak[i];
		if (milenage_f1(opc, k, _rand, sqn, auts_amf, NULL, auts + 6))
			return -1;
        ogs_log_print(OGS_LOG_INFO, "Milenage: AUTS*\n");
        ogs_log_hexdump(OGS_LOG_INFO, auts, 14);
		return -2;
	}

	amf = autn + 6;
    ogs_log_print(OGS_LOG_INFO, "Milenage: AMF\n");
    ogs_log_hexdump(OGS_LOG_INFO, amf, 2);
	if (milenage_f1(opc, k, _rand, rx_sqn, amf, mac_a, NULL))
		return -1;

    ogs_log_print(OGS_LOG_INFO, "Milenage: MAC_A\n");
    ogs_log_hexdump(OGS_LOG_INFO, mac_a, 8);

	if (os_memcmp_const(mac_a, autn + 8, 8) != 0) {
        ogs_log_print(OGS_LOG_INFO, "Milenage: MAC mismatch\n");
        ogs_log_print(OGS_LOG_INFO, "Milenage: Received MAC_A\n");
        ogs_log_hexdump(OGS_LOG_INFO, autn + 8, 8);
		return -1;
	}

	return 0;
}

void milenage_opc(const uint8_t *k, const uint8_t *op,  uint8_t *opc)
{
    int i;

    aes_128_encrypt_block(k,  op, opc);

    for (i = 0; i < 16; i++)
    {
        opc[i] ^= op[i];
    }
}

static void ShiftBits(uint8_t r, uint8_t rijndaelInput[16],
                       uint8_t temp[16], const uint8_t opc[16])
{
    uint32_t deltlen = 16 - (r / 8);
    uint32_t leftout = r % 8;
    uint32_t i;

    if (leftout == 0) {
        for (i = 0; i < 16; i++) {
            rijndaelInput[(i+deltlen) % 16] = temp[i] ^ opc[i];
        }
    } else {
        uint8_t temp1[16];
        uint32_t move_bits;
        uint8_t temp2;

        for (i = 0; i < 16; i++) {
            temp1[(i + deltlen) % 16] = temp[i] ^ opc[i];
        }
        rijndaelInput[15] = 0;
        move_bits = 8 - leftout;
        bits_shift(move_bits, &rijndaelInput[0], temp1, (128 - leftout));
        temp2 = temp1[0] >> (8-leftout);
        rijndaelInput[15] |= temp2;
    }
}

static uint8_t *bits_shift(uint32_t bit_valid, uint8_t *dst,
                            uint8_t *src, uint32_t numBits)
{
    uint32_t bit_used = bit_valid;
    uint32_t bit_empty = 8 - bit_used;
    uint32_t numBytes = numBits >> 3;
    uint32_t leftBits = numBits & 0x7;
    uint32_t i = 0;
    uint8_t *newDst = 0;

    for (i = 0; i < numBytes; i++) {
        dst[i] = (src[i] << bit_empty) | (src[i+1] >> bit_used);
    }

    if (leftBits) {
        if (leftBits == bit_used) {
            dst[numBytes] = src[numBytes] << bit_empty;
            bit_valid = 8;
            newDst = &src[numBytes+1];
        } else if (leftBits < bit_used) {
            dst[numBytes] = src[numBytes] << bit_empty;
            bit_valid = bit_used - leftBits;
            newDst = &src[numBytes];
        } else {
            dst[numBytes] = src[numBytes] << bit_empty |
                            (src[numBytes+1] >> bit_used);
            bit_valid = 8 - (leftBits - bit_used);
            newDst = &src[numBytes+1];
        }
    } else {
        bit_valid = bit_used;
        newDst = &src[numBytes];
    }

    return newDst;
}