michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: /* Thse functions are stub functions which will get replaced with calls through
michael@0:  * PKCS #11.
michael@0:  */
michael@0: 
michael@0: #ifndef _PK11PQG_H_
michael@0: #define  _PK11PQG_H_ 1
michael@0: 
michael@0: #include "blapit.h"
michael@0: 
michael@0: SEC_BEGIN_PROTOS
michael@0: 
michael@0: /* Generate PQGParams and PQGVerify structs.
michael@0:  * Length of seed and length of h both equal length of P. 
michael@0:  * All lengths are specified by "j", according to the table above.
michael@0:  */
michael@0: extern SECStatus PK11_PQG_ParamGen(unsigned int j, PQGParams **pParams, 
michael@0: 							PQGVerify **pVfy);
michael@0: 
michael@0: /* Generate PQGParams and PQGVerify structs.
michael@0:  * Length of P specified by j.  Length of h will match length of P.
michael@0:  * Length of SEED in bytes specified in seedBytes.
michael@0:  * seedBbytes must be in the range [20..255] or an error will result.
michael@0:  */
michael@0: extern SECStatus PK11_PQG_ParamGenSeedLen( unsigned int j, 
michael@0: 	unsigned int seedBytes, PQGParams **pParams, PQGVerify **pVfy);
michael@0: 
michael@0: 
michael@0: /* Generate PQGParams and PQGVerify structs.
michael@0:  * Length of P specified by L.
michael@0:  *   if L is greater than 1024 then the resulting verify parameters will be
michael@0:  *   DSA2.
michael@0:  * Length of Q specified by N. If zero, The PKCS #11 module will
michael@0:  *   pick an appropriately sized Q for L. If N is specified and L = 1024, then
michael@0:  *   the resulting verify parameters will be DSA2, Otherwise DSA1 parameters 
michael@0:  *   will be returned.
michael@0:  * Length of SEED in bytes specified in seedBytes.
michael@0:  *
michael@0:  * The underlying PKCS #11 module will check the values for L, N, 
michael@0:  * and seedBytes. The rules for softoken are:
michael@0:  * 
michael@0:  * If L <= 1024, then L must be between 512 and 1024 in increments of 64 bits.
michael@0:  * If L <= 1024, then N must be 0 or 160.
michael@0:  * If L >= 1024, then L and N must match the following table:
michael@0:  *   L=1024   N=0 or 160
michael@0:  *   L=2048   N=0 or 224
michael@0:  *   L=2048   N=256
michael@0:  *   L=3072   N=0 or 256
michael@0:  * if L <= 1024
michael@0:  *   seedBbytes must be in the range [20..256].
michael@0:  * if L >= 1024
michael@0:  *   seedBbytes must be in the range [20..L/16].
michael@0:  */
michael@0: extern SECStatus
michael@0: PK11_PQG_ParamGenV2(unsigned int L, unsigned int N, unsigned int seedBytes,
michael@0: 		    PQGParams **pParams, PQGVerify **pVfy);
michael@0: 
michael@0: /*  Test PQGParams for validity as DSS PQG values.
michael@0:  *  If vfy is non-NULL, test PQGParams to make sure they were generated
michael@0:  *       using the specified seed, counter, and h values.
michael@0:  *
michael@0:  *  Return value indicates whether Verification operation ran successfully
michael@0:  *  to completion, but does not indicate if PQGParams are valid or not.
michael@0:  *  If return value is SECSuccess, then *pResult has these meanings:
michael@0:  *       SECSuccess: PQGParams are valid.
michael@0:  *       SECFailure: PQGParams are invalid.
michael@0:  *
michael@0:  * Verify the following 12 facts about PQG counter SEED g and h
michael@0:  * These tests are specified in FIPS 186-3 Appendix A.1.1.1, A.1.1.3, and A.2.2
michael@0:  * PQG_VerifyParams in softoken/freebl will automatically choose the 
michael@0:  * appropriate test.
michael@0:  */
michael@0: extern SECStatus PK11_PQG_VerifyParams(const PQGParams *params, 
michael@0:                                     const PQGVerify *vfy, SECStatus *result);
michael@0: extern void PK11_PQG_DestroyParams(PQGParams *params);
michael@0: extern void PK11_PQG_DestroyVerify(PQGVerify *vfy);
michael@0: 
michael@0: /**************************************************************************
michael@0:  *  Return a pointer to a new PQGParams struct that is constructed from   *
michael@0:  *  copies of the arguments passed in.                                    *
michael@0:  *  Return NULL on failure.                                               *
michael@0:  **************************************************************************/
michael@0: extern PQGParams * PK11_PQG_NewParams(const SECItem * prime, const 
michael@0: 				SECItem * subPrime, const SECItem * base);
michael@0: 
michael@0: 
michael@0: /**************************************************************************
michael@0:  * Fills in caller's "prime" SECItem with the prime value in params.
michael@0:  * Contents can be freed by calling SECITEM_FreeItem(prime, PR_FALSE);	
michael@0:  **************************************************************************/
michael@0: extern SECStatus PK11_PQG_GetPrimeFromParams(const PQGParams *params, 
michael@0: 							SECItem * prime);
michael@0: 
michael@0: 
michael@0: /**************************************************************************
michael@0:  * Fills in caller's "subPrime" SECItem with the prime value in params.
michael@0:  * Contents can be freed by calling SECITEM_FreeItem(subPrime, PR_FALSE);	
michael@0:  **************************************************************************/
michael@0: extern SECStatus PK11_PQG_GetSubPrimeFromParams(const PQGParams *params, 
michael@0: 							SECItem * subPrime);
michael@0: 
michael@0: 
michael@0: /**************************************************************************
michael@0:  * Fills in caller's "base" SECItem with the base value in params.
michael@0:  * Contents can be freed by calling SECITEM_FreeItem(base, PR_FALSE);	
michael@0:  **************************************************************************/
michael@0: extern SECStatus PK11_PQG_GetBaseFromParams(const PQGParams *params, 
michael@0: 							SECItem *base);
michael@0: 
michael@0: 
michael@0: /**************************************************************************
michael@0:  *  Return a pointer to a new PQGVerify struct that is constructed from   *
michael@0:  *  copies of the arguments passed in.                                    *
michael@0:  *  Return NULL on failure.                                               *
michael@0:  **************************************************************************/
michael@0: extern PQGVerify * PK11_PQG_NewVerify(unsigned int counter, 
michael@0: 				const SECItem * seed, const SECItem * h);
michael@0: 
michael@0: 
michael@0: /**************************************************************************
michael@0:  * Returns "counter" value from the PQGVerify.
michael@0:  **************************************************************************/
michael@0: extern unsigned int PK11_PQG_GetCounterFromVerify(const PQGVerify *verify);
michael@0: 
michael@0: /**************************************************************************
michael@0:  * Fills in caller's "seed" SECItem with the seed value in verify.
michael@0:  * Contents can be freed by calling SECITEM_FreeItem(seed, PR_FALSE);	
michael@0:  **************************************************************************/
michael@0: extern SECStatus PK11_PQG_GetSeedFromVerify(const PQGVerify *verify, 
michael@0: 							SECItem *seed);
michael@0: 
michael@0: /**************************************************************************
michael@0:  * Fills in caller's "h" SECItem with the h value in verify.
michael@0:  * Contents can be freed by calling SECITEM_FreeItem(h, PR_FALSE);	
michael@0:  **************************************************************************/
michael@0: extern SECStatus PK11_PQG_GetHFromVerify(const PQGVerify *verify, SECItem * h);
michael@0: 
michael@0: SEC_END_PROTOS
michael@0: 
michael@0: #endif