/* *********************************************************************

 *

 * Sun elects to have this file available under and governed by the

 * Mozilla Public License Version 1.1 ("MPL") (see

 * http://www.mozilla.org/MPL/ for full license text). For the avoidance

 * of doubt and subject to the following, Sun also elects to allow

 * licensees to use this file under the MPL, the GNU General Public

 * License version 2 only or the Lesser General Public License version

 * 2.1 only. Any references to the "GNU General Public License version 2

 * or later" or "GPL" in the following shall be construed to mean the

 * GNU General Public License version 2 only. Any references to the "GNU

 * Lesser General Public License version 2.1 or later" or "LGPL" in the

 * following shall be construed to mean the GNU Lesser General Public

 * License version 2.1 only. However, the following notice accompanied

 * the original version of this file:

 *

 * Version: MPL 1.1/GPL 2.0/LGPL 2.1

 *

 * The contents of this file are subject to the Mozilla Public License Version

 * 1.1 (the "License"); you may not use this file except in compliance with

 * the License. You may obtain a copy of the License at

 * http://www.mozilla.org/MPL/

 *

 * Software distributed under the License is distributed on an "AS IS" basis,

 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License

 * for the specific language governing rights and limitations under the

 * License.

 *

 * The Original Code is the Elliptic Curve Cryptography library.

 *

 * The Initial Developer of the Original Code is

 * Sun Microsystems, Inc.

 * Portions created by the Initial Developer are Copyright (C) 2003

 * the Initial Developer. All Rights Reserved.

 *

 * Contributor(s):

 *   Dr Vipul Gupta <vipul.gupta@sun.com> and

 *   Douglas Stebila <douglas@stebila.ca>, Sun Microsystems Laboratories

 *

 * Alternatively, the contents of this file may be used under the terms of

 * either the GNU General Public License Version 2 or later (the "GPL"), or

 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),

 * in which case the provisions of the GPL or the LGPL are applicable instead

 * of those above. If you wish to allow use of your version of this file only

 * under the terms of either the GPL or the LGPL, and not to allow others to

 * use your version of this file under the terms of the MPL, indicate your

 * decision by deleting the provisions above and replace them with the notice

 * and other provisions required by the GPL or the LGPL. If you do not delete

 * the provisions above, a recipient may use your version of this file under

 * the terms of any one of the MPL, the GPL or the LGPL.

 *

 *********************************************************************** */

/*

 * Use is subject to license terms.

 */

#include "mplogic.h"

#include "ec.h"

#include "ecl.h"

#include <sys/types.h>

#ifndef _KERNEL

#include <stdlib.h>

#include <string.h>

#ifndef _WIN32

#include <stdio.h>

#include <strings.h>

#endif /* _WIN32 */

#endif

#include "ecl-exp.h"

#include "mpi.h"

#include "ecc_impl.h"

#ifdef _KERNEL

#define PORT_ZFree(p, l)                bzero((p), (l)); kmem_free((p), (l))

#else

#ifndef _WIN32

#define PORT_ZFree(p, l)                bzero((p), (l)); free((p))

#else

#define PORT_ZFree(p, l)                memset((p), 0, (l)); free((p))

#endif /* _WIN32 */

#endif

/*

 * Returns true if pointP is the point at infinity, false otherwise

 */

PRBool

ec_point_at_infinity(SECItem *pointP)

{

    unsigned int i;

    for (i = 1; i < pointP->len; i++) {

        if (pointP->data[i] != 0x00) return PR_FALSE;

    }

    return PR_TRUE;

}

/*

 * Computes scalar point multiplication pointQ = k1 * G + k2 * pointP for

 * the curve whose parameters are encoded in params with base point G.

 */

SECStatus

ec_points_mul(const ECParams *params, const mp_int *k1, const mp_int *k2,

             const SECItem *pointP, SECItem *pointQ, int kmflag)

{

    mp_int Px, Py, Qx, Qy;

    mp_int Gx, Gy, order, irreducible, a, b;

#if 0 /* currently don't support non-named curves */

    unsigned int irr_arr[5];

#endif

    ECGroup *group = NULL;

    SECStatus rv = SECFailure;

    mp_err err = MP_OKAY;

    unsigned int len;

#if EC_DEBUG

    int i;

    char mpstr[256];

    printf("ec_points_mul: params [len=%d]:", params->DEREncoding.len);

    for (i = 0; i < params->DEREncoding.len; i++)

            printf("%02x:", params->DEREncoding.data[i]);

    printf("\n");

        if (k1 != NULL) {

                mp_tohex(k1, mpstr);

                printf("ec_points_mul: scalar k1: %s\n", mpstr);

                mp_todecimal(k1, mpstr);

                printf("ec_points_mul: scalar k1: %s (dec)\n", mpstr);

        }

        if (k2 != NULL) {

                mp_tohex(k2, mpstr);

                printf("ec_points_mul: scalar k2: %s\n", mpstr);

                mp_todecimal(k2, mpstr);

                printf("ec_points_mul: scalar k2: %s (dec)\n", mpstr);

        }

        if (pointP != NULL) {

                printf("ec_points_mul: pointP [len=%d]:", pointP->len);

                for (i = 0; i < pointP->len; i++)

                        printf("%02x:", pointP->data[i]);

                printf("\n");

        }

#endif

        /* NOTE: We only support uncompressed points for now */

        len = (params->fieldID.size + 7) >> 3;

        if (pointP != NULL) {

                if ((pointP->data[0] != EC_POINT_FORM_UNCOMPRESSED) ||

                        (pointP->len != (2 * len + 1))) {

                        return SECFailure;

                };

        }

        MP_DIGITS(&Px) = 0;

        MP_DIGITS(&Py) = 0;

        MP_DIGITS(&Qx) = 0;

        MP_DIGITS(&Qy) = 0;

        MP_DIGITS(&Gx) = 0;

        MP_DIGITS(&Gy) = 0;

        MP_DIGITS(&order) = 0;

        MP_DIGITS(&irreducible) = 0;

        MP_DIGITS(&a) = 0;

        MP_DIGITS(&b) = 0;

        CHECK_MPI_OK( mp_init(&Px, kmflag) );

        CHECK_MPI_OK( mp_init(&Py, kmflag) );

        CHECK_MPI_OK( mp_init(&Qx, kmflag) );

        CHECK_MPI_OK( mp_init(&Qy, kmflag) );

        CHECK_MPI_OK( mp_init(&Gx, kmflag) );

        CHECK_MPI_OK( mp_init(&Gy, kmflag) );

        CHECK_MPI_OK( mp_init(&order, kmflag) );

        CHECK_MPI_OK( mp_init(&irreducible, kmflag) );

        CHECK_MPI_OK( mp_init(&a, kmflag) );

        CHECK_MPI_OK( mp_init(&b, kmflag) );

        if ((k2 != NULL) && (pointP != NULL)) {

                /* Initialize Px and Py */

                CHECK_MPI_OK( mp_read_unsigned_octets(&Px, pointP->data + 1, (mp_size) len) );

                CHECK_MPI_OK( mp_read_unsigned_octets(&Py, pointP->data + 1 + len, (mp_size) len) );

        }

        /* construct from named params, if possible */

        if (params->name != ECCurve_noName) {

                group = ECGroup_fromName(params->name, kmflag);

        }

#if 0 /* currently don't support non-named curves */

        if (group == NULL) {

                /* Set up mp_ints containing the curve coefficients */

                CHECK_MPI_OK( mp_read_unsigned_octets(&Gx, params->base.data + 1,

                                                                                  (mp_size) len) );

                CHECK_MPI_OK( mp_read_unsigned_octets(&Gy, params->base.data + 1 + len,

                                                                                  (mp_size) len) );

                SECITEM_TO_MPINT( params->order, &order );

                SECITEM_TO_MPINT( params->curve.a, &a );

                SECITEM_TO_MPINT( params->curve.b, &b );

                if (params->fieldID.type == ec_field_GFp) {

                        SECITEM_TO_MPINT( params->fieldID.u.prime, &irreducible );

                        group = ECGroup_consGFp(&irreducible, &a, &b, &Gx, &Gy, &order, params->cofactor);

                } else {

                        SECITEM_TO_MPINT( params->fieldID.u.poly, &irreducible );

                        irr_arr[0] = params->fieldID.size;

                        irr_arr[1] = params->fieldID.k1;

                        irr_arr[2] = params->fieldID.k2;

                        irr_arr[3] = params->fieldID.k3;

                        irr_arr[4] = 0;

                        group = ECGroup_consGF2m(&irreducible, irr_arr, &a, &b, &Gx, &Gy, &order, params->cofactor);

                }

        }

#endif

        if (group == NULL)

                goto cleanup;

        if ((k2 != NULL) && (pointP != NULL)) {

                CHECK_MPI_OK( ECPoints_mul(group, k1, k2, &Px, &Py, &Qx, &Qy) );

        } else {

                CHECK_MPI_OK( ECPoints_mul(group, k1, NULL, NULL, NULL, &Qx, &Qy) );

    }

    /* Construct the SECItem representation of point Q */

    pointQ->data[0] = EC_POINT_FORM_UNCOMPRESSED;

    CHECK_MPI_OK( mp_to_fixlen_octets(&Qx, pointQ->data + 1,

                                      (mp_size) len) );

    CHECK_MPI_OK( mp_to_fixlen_octets(&Qy, pointQ->data + 1 + len,

                                      (mp_size) len) );

    rv = SECSuccess;

#if EC_DEBUG

    printf("ec_points_mul: pointQ [len=%d]:", pointQ->len);

    for (i = 0; i < pointQ->len; i++)

            printf("%02x:", pointQ->data[i]);

    printf("\n");

#endif

cleanup:

    ECGroup_free(group);

    mp_clear(&Px);

    mp_clear(&Py);

    mp_clear(&Qx);

    mp_clear(&Qy);

    mp_clear(&Gx);

    mp_clear(&Gy);

    mp_clear(&order);

    mp_clear(&irreducible);

    mp_clear(&a);

    mp_clear(&b);

    if (err) {

        MP_TO_SEC_ERROR(err);

        rv = SECFailure;

    }

    return rv;

}

/* Generates a new EC key pair. The private key is a supplied

 * value and the public key is the result of performing a scalar

 * point multiplication of that value with the curve's base point.

 */

SECStatus

ec_NewKey(ECParams *ecParams, ECPrivateKey **privKey,

    const unsigned char *privKeyBytes, int privKeyLen, int kmflag)

{

    SECStatus rv = SECFailure;

    PRArenaPool *arena;

    ECPrivateKey *key;

    mp_int k;

    mp_err err = MP_OKAY;

    int len;

#if EC_DEBUG

    printf("ec_NewKey called\n");

#endif

    if (!ecParams || !privKey || !privKeyBytes || (privKeyLen < 0)) {

        PORT_SetError(SEC_ERROR_INVALID_ARGS);

        return SECFailure;

    }

    /* Initialize an arena for the EC key. */

    if (!(arena = PORT_NewArena(NSS_FREEBL_DEFAULT_CHUNKSIZE)))

        return SECFailure;

    key = (ECPrivateKey *)PORT_ArenaZAlloc(arena, sizeof(ECPrivateKey),

        kmflag);

    if (!key) {

        PORT_FreeArena(arena, PR_TRUE);

        return SECFailure;

    }

    /* Set the version number (SEC 1 section C.4 says it should be 1) */

    SECITEM_AllocItem(arena, &key->version, 1, kmflag);

    key->version.data[0] = 1;

    /* Copy all of the fields from the ECParams argument to the

     * ECParams structure within the private key.

     */

    key->ecParams.arena = arena;

    key->ecParams.type = ecParams->type;

    key->ecParams.fieldID.size = ecParams->fieldID.size;

    key->ecParams.fieldID.type = ecParams->fieldID.type;

    if (ecParams->fieldID.type == ec_field_GFp) {

        CHECK_SEC_OK(SECITEM_CopyItem(arena, &key->ecParams.fieldID.u.prime,

            &ecParams->fieldID.u.prime, kmflag));

    } else {

        CHECK_SEC_OK(SECITEM_CopyItem(arena, &key->ecParams.fieldID.u.poly,

            &ecParams->fieldID.u.poly, kmflag));

    }

    key->ecParams.fieldID.k1 = ecParams->fieldID.k1;

    key->ecParams.fieldID.k2 = ecParams->fieldID.k2;

    key->ecParams.fieldID.k3 = ecParams->fieldID.k3;

    CHECK_SEC_OK(SECITEM_CopyItem(arena, &key->ecParams.curve.a,

        &ecParams->curve.a, kmflag));

    CHECK_SEC_OK(SECITEM_CopyItem(arena, &key->ecParams.curve.b,

        &ecParams->curve.b, kmflag));

    CHECK_SEC_OK(SECITEM_CopyItem(arena, &key->ecParams.curve.seed,

        &ecParams->curve.seed, kmflag));

    CHECK_SEC_OK(SECITEM_CopyItem(arena, &key->ecParams.base,

        &ecParams->base, kmflag));

    CHECK_SEC_OK(SECITEM_CopyItem(arena, &key->ecParams.order,

        &ecParams->order, kmflag));

    key->ecParams.cofactor = ecParams->cofactor;

    CHECK_SEC_OK(SECITEM_CopyItem(arena, &key->ecParams.DEREncoding,

        &ecParams->DEREncoding, kmflag));

    key->ecParams.name = ecParams->name;

    CHECK_SEC_OK(SECITEM_CopyItem(arena, &key->ecParams.curveOID,

        &ecParams->curveOID, kmflag));

    len = (ecParams->fieldID.size + 7) >> 3;

    SECITEM_AllocItem(arena, &key->publicValue, 2*len + 1, kmflag);

    len = ecParams->order.len;

    SECITEM_AllocItem(arena, &key->privateValue, len, kmflag);

    /* Copy private key */

    if (privKeyLen >= len) {

        memcpy(key->privateValue.data, privKeyBytes, len);

    } else {

        memset(key->privateValue.data, 0, (len - privKeyLen));

        memcpy(key->privateValue.data + (len - privKeyLen), privKeyBytes, privKeyLen);

    }

    /* Compute corresponding public key */

    MP_DIGITS(&k) = 0;

    CHECK_MPI_OK( mp_init(&k, kmflag) );

    CHECK_MPI_OK( mp_read_unsigned_octets(&k, key->privateValue.data,

        (mp_size) len) );

    rv = ec_points_mul(ecParams, &k, NULL, NULL, &(key->publicValue), kmflag);

    if (rv != SECSuccess) goto cleanup;

    *privKey = key;

cleanup:

    mp_clear(&k);

    if (rv) {

        PORT_FreeArena(arena, PR_TRUE);

    }

#if EC_DEBUG

    printf("ec_NewKey returning %s\n",

        (rv == SECSuccess) ? "success" : "failure");

#endif

    return rv;

}

/* Generates a new EC key pair. The private key is a supplied

 * random value (in seed) and the public key is the result of

 * performing a scalar point multiplication of that value with

 * the curve's base point.

 */

SECStatus

EC_NewKeyFromSeed(ECParams *ecParams, ECPrivateKey **privKey,

    const unsigned char *seed, int seedlen, int kmflag)

{

    SECStatus rv = SECFailure;

    rv = ec_NewKey(ecParams, privKey, seed, seedlen, kmflag);

    return rv;

}

/* Generate a random private key using the algorithm A.4.1 of ANSI X9.62,

 * modified a la FIPS 186-2 Change Notice 1 to eliminate the bias in the

 * random number generator.

 *

 * Parameters

 * - order: a buffer that holds the curve's group order

 * - len: the length in octets of the order buffer

 * - random: a buffer of 2 * len random bytes

 * - randomlen: the length in octets of the random buffer

 *

 * Return Value

 * Returns a buffer of len octets that holds the private key. The caller

 * is responsible for freeing the buffer with PORT_ZFree.

 */

static unsigned char *

ec_GenerateRandomPrivateKey(const unsigned char *order, int len,

    const unsigned char *random, int randomlen, int kmflag)

{

    SECStatus rv = SECSuccess;

    mp_err err;

    unsigned char *privKeyBytes = NULL;

    mp_int privKeyVal, order_1, one;

    MP_DIGITS(&privKeyVal) = 0;

    MP_DIGITS(&order_1) = 0;

    MP_DIGITS(&one) = 0;

    CHECK_MPI_OK( mp_init(&privKeyVal, kmflag) );

    CHECK_MPI_OK( mp_init(&order_1, kmflag) );

    CHECK_MPI_OK( mp_init(&one, kmflag) );

    /*

     * Reduces the 2*len buffer of random bytes modulo the group order.

     */

    if ((privKeyBytes = PORT_Alloc(2*len, kmflag)) == NULL) goto cleanup;

    if (randomlen != 2 * len) {

        randomlen = 2 * len;

    }

    /* No need to generate - random bytes are now supplied */

    /* CHECK_SEC_OK( RNG_GenerateGlobalRandomBytes(privKeyBytes, 2*len) );*/

    memcpy(privKeyBytes, random, randomlen);

    CHECK_MPI_OK( mp_read_unsigned_octets(&privKeyVal, privKeyBytes, 2*len) );

    CHECK_MPI_OK( mp_read_unsigned_octets(&order_1, order, len) );

    CHECK_MPI_OK( mp_set_int(&one, 1) );

    CHECK_MPI_OK( mp_sub(&order_1, &one, &order_1) );

    CHECK_MPI_OK( mp_mod(&privKeyVal, &order_1, &privKeyVal) );

    CHECK_MPI_OK( mp_add(&privKeyVal, &one, &privKeyVal) );

    CHECK_MPI_OK( mp_to_fixlen_octets(&privKeyVal, privKeyBytes, len) );

    memset(privKeyBytes+len, 0, len);

cleanup:

    mp_clear(&privKeyVal);

    mp_clear(&order_1);

    mp_clear(&one);

    if (err < MP_OKAY) {

        MP_TO_SEC_ERROR(err);

        rv = SECFailure;

    }

    if (rv != SECSuccess && privKeyBytes) {

#ifdef _KERNEL

        kmem_free(privKeyBytes, 2*len);

#else

        free(privKeyBytes);

#endif

        privKeyBytes = NULL;

    }

    return privKeyBytes;

}

/* Generates a new EC key pair. The private key is a random value and

 * the public key is the result of performing a scalar point multiplication

 * of that value with the curve's base point.

 */

SECStatus

EC_NewKey(ECParams *ecParams, ECPrivateKey **privKey,

    const unsigned char* random, int randomlen, int kmflag)

{

    SECStatus rv = SECFailure;

    int len;

    unsigned char *privKeyBytes = NULL;

    if (!ecParams) {

        PORT_SetError(SEC_ERROR_INVALID_ARGS);

        return SECFailure;

    }

    len = ecParams->order.len;

    privKeyBytes = ec_GenerateRandomPrivateKey(ecParams->order.data, len,

        random, randomlen, kmflag);

    if (privKeyBytes == NULL) goto cleanup;

    /* generate public key */

    CHECK_SEC_OK( ec_NewKey(ecParams, privKey, privKeyBytes, len, kmflag) );

cleanup:

    if (privKeyBytes) {

        PORT_ZFree(privKeyBytes, len * 2);

    }

#if EC_DEBUG

    printf("EC_NewKey returning %s\n",

        (rv == SECSuccess) ? "success" : "failure");

#endif

    return rv;

}

/* Validates an EC public key as described in Section 5.2.2 of

 * X9.62. The ECDH primitive when used without the cofactor does

 * not address small subgroup attacks, which may occur when the

 * public key is not valid. These attacks can be prevented by

 * validating the public key before using ECDH.

 */

SECStatus

EC_ValidatePublicKey(ECParams *ecParams, SECItem *publicValue, int kmflag)

{

    mp_int Px, Py;

    ECGroup *group = NULL;

    SECStatus rv = SECFailure;

    mp_err err = MP_OKAY;

    unsigned int len;

    if (!ecParams || !publicValue) {

        PORT_SetError(SEC_ERROR_INVALID_ARGS);

        return SECFailure;

    }

    /* NOTE: We only support uncompressed points for now */

    len = (ecParams->fieldID.size + 7) >> 3;

    if (publicValue->data[0] != EC_POINT_FORM_UNCOMPRESSED) {

        PORT_SetError(SEC_ERROR_UNSUPPORTED_EC_POINT_FORM);

        return SECFailure;

    } else if (publicValue->len != (2 * len + 1)) {

        PORT_SetError(SEC_ERROR_BAD_KEY);

        return SECFailure;

    }

    MP_DIGITS(&Px) = 0;

    MP_DIGITS(&Py) = 0;

    CHECK_MPI_OK( mp_init(&Px, kmflag) );

    CHECK_MPI_OK( mp_init(&Py, kmflag) );

    /* Initialize Px and Py */

    CHECK_MPI_OK( mp_read_unsigned_octets(&Px, publicValue->data + 1, (mp_size) len) );

    CHECK_MPI_OK( mp_read_unsigned_octets(&Py, publicValue->data + 1 + len, (mp_size) len) );