/********************************************************************************/
/*										*/
/*			     				*/
/*			     Written by Ken Goldman				*/
/*		       IBM Thomas J. Watson Research Center			*/
/*            $Id: BnMemory.c 1262 2018-07-11 21:03:43Z kgoldman $			*/
/*										*/
/*  Licenses and Notices							*/
/*										*/
/*  1. Copyright Licenses:							*/
/*										*/
/*  - Trusted Computing Group (TCG) grants to the user of the source code in	*/
/*    this specification (the "Source Code") a worldwide, irrevocable, 		*/
/*    nonexclusive, royalty free, copyright license to reproduce, create 	*/
/*    derivative works, distribute, display and perform the Source Code and	*/
/*    derivative works thereof, and to grant others the rights granted herein.	*/
/*										*/
/*  - The TCG grants to the user of the other parts of the specification 	*/
/*    (other than the Source Code) the rights to reproduce, distribute, 	*/
/*    display, and perform the specification solely for the purpose of 		*/
/*    developing products based on such documents.				*/
/*										*/
/*  2. Source Code Distribution Conditions:					*/
/*										*/
/*  - Redistributions of Source Code must retain the above copyright licenses, 	*/
/*    this list of conditions and the following disclaimers.			*/
/*										*/
/*  - Redistributions in binary form must reproduce the above copyright 	*/
/*    licenses, this list of conditions	and the following disclaimers in the 	*/
/*    documentation and/or other materials provided with the distribution.	*/
/*										*/
/*  3. Disclaimers:								*/
/*										*/
/*  - THE COPYRIGHT LICENSES SET FORTH ABOVE DO NOT REPRESENT ANY FORM OF	*/
/*  LICENSE OR WAIVER, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, WITH	*/
/*  RESPECT TO PATENT RIGHTS HELD BY TCG MEMBERS (OR OTHER THIRD PARTIES)	*/
/*  THAT MAY BE NECESSARY TO IMPLEMENT THIS SPECIFICATION OR OTHERWISE.		*/
/*  Contact TCG Administration (admin@trustedcomputinggroup.org) for 		*/
/*  information on specification licensing rights available through TCG 	*/
/*  membership agreements.							*/
/*										*/
/*  - THIS SPECIFICATION IS PROVIDED "AS IS" WITH NO EXPRESS OR IMPLIED 	*/
/*    WARRANTIES WHATSOEVER, INCLUDING ANY WARRANTY OF MERCHANTABILITY OR 	*/
/*    FITNESS FOR A PARTICULAR PURPOSE, ACCURACY, COMPLETENESS, OR 		*/
/*    NONINFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS, OR ANY WARRANTY 		*/
/*    OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION OR SAMPLE.		*/
/*										*/
/*  - Without limitation, TCG and its members and licensors disclaim all 	*/
/*    liability, including liability for infringement of any proprietary 	*/
/*    rights, relating to use of information in this specification and to the	*/
/*    implementation of this specification, and TCG disclaims all liability for	*/
/*    cost of procurement of substitute goods or services, lost profits, loss 	*/
/*    of use, loss of data or any incidental, consequential, direct, indirect, 	*/
/*    or special damages, whether under contract, tort, warranty or otherwise, 	*/
/*    arising in any way out of use or reliance upon this specification or any 	*/
/*    information herein.							*/
/*										*/
/*  (c) Copyright IBM Corp. and others, 2016					*/
/*										*/
/********************************************************************************/

/* 10.2.5 BnMemory.c */
/* 10.2.5.1 Introduction */
/* This file contains the memory setup functions used by the bigNum functions in CryptoEngine() */
/* 10.2.5.2 Includes */
#include "Tpm.h"
/* 10.2.5.3 Functions */
/* 10.2.5.3.1 BnSetTop() */
/* This function is used when the size of a bignum_t is changed. It makes sure that the unused words
   are set to zero and that any significant words of zeros are eliminated from the used size
   indicator. */
LIB_EXPORT bigNum
BnSetTop(
	 bigNum           bn,        // IN/OUT: number to clean
	 crypt_uword_t    top        // IN: the new top
	 )
{
    if(bn != NULL)
	{
	    pAssert(top <= bn->allocated);
	    // If forcing the size to be decreased, make sure that the words being
	    // discarded are being set to 0
	    while(bn->size > top)
		bn->d[--bn->size] = 0;
	    bn->size = top;
	    // Now make sure that the words that are left are 'normalized' (no high-order
	    // words of zero.
	    while((bn->size > 0) && (bn->d[bn->size - 1] == 0))
		bn->size -= 1;
	}
    return bn;
}
/* 10.2.5.3.2 BnClearTop() */
/* This function will make sure that all unused words are zero. */
LIB_EXPORT bigNum
BnClearTop(
	   bigNum          bn
	   )
{
    crypt_uword_t       i;
    //
    if(bn != NULL)
	{
	    for(i = bn->size; i < bn->allocated; i++)
		bn->d[i] = 0;
	    while((bn->size > 0) && (bn->d[bn->size] == 0))
		bn->size -= 1;
	}
    return bn;
}
/* 10.2.5.3.3 BnInitializeWord() */
/* This function is used to initialize an allocated bigNum with a word value. The bigNum does not
   have to be allocated with a single word. */
LIB_EXPORT bigNum
BnInitializeWord(
		 bigNum          bn,         // IN:
		 crypt_uword_t   allocated,  // IN:
		 crypt_uword_t   word        // IN:
		 )
{
    bn->allocated = allocated;
    bn->size = (word != 0);
    bn->d[0] = word;
    while(allocated > 1)
	bn->d[--allocated] = 0;
    return bn;
}
/* 10.2.5.3.4 BnInit() */
/* This function initializes a stack allocated bignum_t. It initializes allocated and size and zeros
   the words of d. */
LIB_EXPORT bigNum
BnInit(
       bigNum               bn,
       crypt_uword_t        allocated
       )
{
    if(bn != NULL)
	{
	    bn->allocated = allocated;
	    bn->size = 0;
	    while(allocated != 0)
		bn->d[--allocated] = 0;
	}
    return bn;
}
/* 10.2.5.3.5 BnCopy() */
/* Function to copy a bignum_t. If the output is NULL, then nothing happens. If the input is NULL,
   the output is set to zero. */
LIB_EXPORT BOOL
BnCopy(
       bigNum           out,
       bigConst         in
       )
{
    if(in == out)
	BnSetTop(out, BnGetSize(out));
    else if(out != NULL)
	{
	    if(in != NULL)
		{
		    unsigned int         i;
		    pAssert(BnGetAllocated(out) >= BnGetSize(in));
		    for(i = 0; i < BnGetSize(in); i++)
			out->d[i] = in->d[i];
		    BnSetTop(out, BnGetSize(in));
		}
	    else
		BnSetTop(out, 0);
	}
    return TRUE;
}
#if ALG_ECC
/* 10.2.5.3.6 BnPointCopy() */
/* Function to copy a bn point. */
LIB_EXPORT BOOL
BnPointCopy(
	    bigPoint                 pOut,
	    pointConst               pIn
	    )
{
    return BnCopy(pOut->x, pIn->x)
	&& BnCopy(pOut->y, pIn->y)
	&& BnCopy(pOut->z, pIn->z);
}
/* 10.2.5.3.7 BnInitializePoint() */
/* This function is used to initialize a point structure with the addresses of the coordinates. */
LIB_EXPORT bn_point_t *
BnInitializePoint(
		  bigPoint             p,     // OUT: structure to receive pointers
		  bigNum               x,     // IN: x coordinate
		  bigNum               y,     // IN: y coordinate
		  bigNum               z      // IN: x coordinate
		  )
{
    p->x = x;
    p->y = y;
    p->z = z;
    BnSetWord(z, 1);
    return p;
}
#endif // TPM_ALG_ECC