From 2470e747a5f03307e6cebee12312546a0652556c Mon Sep 17 00:00:00 2001 From: "relyea%netscape.com" Date: Thu, 7 Jun 2001 21:48:35 +0000 Subject: [PATCH] Add Stub functions for PQG functions (until we implent PQG through the PKCS #11 interface). --- security/nss/lib/pk11wrap/manifest.mn | 1 + security/nss/lib/pk11wrap/pk11pqg.c | 190 ++++++++++++++++++++++++++ security/nss/lib/pk11wrap/pk11pqg.h | 149 ++++++++++++++++++++ 3 files changed, 340 insertions(+) create mode 100644 security/nss/lib/pk11wrap/pk11pqg.c create mode 100644 security/nss/lib/pk11wrap/pk11pqg.h diff --git a/security/nss/lib/pk11wrap/manifest.mn b/security/nss/lib/pk11wrap/manifest.mn index 0eddc6696a2..e300f57ebe2 100644 --- a/security/nss/lib/pk11wrap/manifest.mn +++ b/security/nss/lib/pk11wrap/manifest.mn @@ -57,6 +57,7 @@ CSRCS = \ pk11kea.c \ pk11util.c \ pk11sdr.c \ + pk11pqg.c \ $(NULL) REQUIRES = security dbm diff --git a/security/nss/lib/pk11wrap/pk11pqg.c b/security/nss/lib/pk11wrap/pk11pqg.c new file mode 100644 index 00000000000..d8ea86e04d9 --- /dev/null +++ b/security/nss/lib/pk11wrap/pk11pqg.c @@ -0,0 +1,190 @@ +/* + * 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 Netscape security libraries. + * + * The Initial Developer of the Original Code is Netscape + * Communications Corporation. Portions created by Netscape are + * Copyright (C) 1994-2001 Netscape Communications Corporation. All + * Rights Reserved. + * + * Contributor(s): + * + * Alternatively, the contents of this file may be used under the + * terms of the GNU General Public License Version 2 or later (the + * "GPL"), in which case the provisions of the GPL are applicable + * instead of those above. If you wish to allow use of your + * version of this file only under the terms of the GPL and not to + * allow others to use your version of this file under the MPL, + * indicate your decision by deleting the provisions above and + * replace them with the notice and other provisions required by + * the GPL. If you do not delete the provisions above, a recipient + * may use your version of this file under either the MPL or the + * GPL. + */ +/* Thse functions are stub functions which will get replaced with calls through + * PKCS #11. + */ + +#include "pk11pqg.h" + +/* Generate PQGParams and PQGVerify structs. + * Length of seed and length of h both equal length of P. + * All lengths are specified by "j", according to the table above. + */ +extern SECStatus +PK11_PQG_ParamGen(unsigned int j, PQGParams **pParams, PQGVerify **pVfy) { + return PQG_ParamGen(j, pParams, pVfy); +} + +/* Generate PQGParams and PQGVerify structs. + * Length of P specified by j. Length of h will match length of P. + * Length of SEED in bytes specified in seedBytes. + * seedBbytes must be in the range [20..255] or an error will result. + */ +extern SECStatus +PK11_QG_ParamGenSeedLen( unsigned int j, unsigned int seedBytes, + PQGParams **pParams, PQGVerify **pVfy) { + return PQG_ParamGenSeedLen(j, seedBytes, pParams, pVfy); +} + +/* Test PQGParams for validity as DSS PQG values. + * If vfy is non-NULL, test PQGParams to make sure they were generated + * using the specified seed, counter, and h values. + * + * Return value indicates whether Verification operation ran succesfully + * to completion, but does not indicate if PQGParams are valid or not. + * If return value is SECSuccess, then *pResult has these meanings: + * SECSuccess: PQGParams are valid. + * SECFailure: PQGParams are invalid. + * + * Verify the following 12 facts about PQG counter SEED g and h + * 1. Q is 160 bits long. + * 2. P is one of the 9 valid lengths. + * 3. G < P + * 4. P % Q == 1 + * 5. Q is prime + * 6. P is prime + * Steps 7-12 are done only if the optional PQGVerify is supplied. + * 7. counter < 4096 + * 8. g >= 160 and g < 2048 (g is length of seed in bits) + * 9. Q generated from SEED matches Q in PQGParams. + * 10. P generated from (L, counter, g, SEED, Q) matches P in PQGParams. + * 11. 1 < h < P-1 + * 12. G generated from h matches G in PQGParams. + */ + +extern SECStatus +PK11_PQG_VerifyParams(const PQGParams *params, + const PQGVerify *vfy, SECStatus *result) { + return PQG_VerifyParams(params, vfy, result); +} + + + +/************************************************************************** + * Free the PQGParams struct and the things it points to. * + **************************************************************************/ +extern void +PK11_PQG_DestroyParams(PQGParams *params) { + PQG_DestroyParams(params); + return; +} + +/************************************************************************** + * Free the PQGVerify struct and the things it points to. * + **************************************************************************/ +extern void +PK11_PQG_DestroyVerify(PQGVerify *vfy) { + PQG_DestroyVerify(vfy); + return; +} + +/************************************************************************** + * Return a pointer to a new PQGParams struct that is constructed from * + * copies of the arguments passed in. * + * Return NULL on failure. * + **************************************************************************/ +extern PQGParams * +PK11_PQG_NewParams(const SECItem * prime, const SECItem * subPrime, + const SECItem * base) { + return PQG_NewParams(prime, subPrime, base); +} + + +/************************************************************************** + * Fills in caller's "prime" SECItem with the prime value in params. + * Contents can be freed by calling SECITEM_FreeItem(prime, PR_FALSE); + **************************************************************************/ +extern SECStatus +PK11_PQG_GetPrimeFromParams(const PQGParams *params, SECItem * prime) { + return PQG_GetPrimeFromParams(params, prime); +} + + +/************************************************************************** + * Fills in caller's "subPrime" SECItem with the prime value in params. + * Contents can be freed by calling SECITEM_FreeItem(subPrime, PR_FALSE); + **************************************************************************/ +extern SECStatus +PK11_PQG_GetSubPrimeFromParams(const PQGParams *params, SECItem * subPrime) { + return PQG_GetSubPrimeFromParams(params, subPrime); +} + + +/************************************************************************** + * Fills in caller's "base" SECItem with the base value in params. + * Contents can be freed by calling SECITEM_FreeItem(base, PR_FALSE); + **************************************************************************/ +extern SECStatus +PK11_PQG_GetBaseFromParams(const PQGParams *params, SECItem *base) { + return PQG_GetBaseFromParams(params, base); +} + + +/************************************************************************** + * Return a pointer to a new PQGVerify struct that is constructed from * + * copies of the arguments passed in. * + * Return NULL on failure. * + **************************************************************************/ +extern PQGVerify * +PK11_PQG_NewVerify(unsigned int counter, const SECItem * seed, + const SECItem * h) { + return PQG_NewVerify(counter, seed, h); +} + + +/************************************************************************** + * Returns "counter" value from the PQGVerify. + **************************************************************************/ +extern unsigned int +PK11_PQG_GetCounterFromVerify(const PQGVerify *verify) { + return PQG_GetCounterFromVerify(verify); +} + +/************************************************************************** + * Fills in caller's "seed" SECItem with the seed value in verify. + * Contents can be freed by calling SECITEM_FreeItem(seed, PR_FALSE); + **************************************************************************/ +extern SECStatus +PK11_PQG_GetSeedFromVerify(const PQGVerify *verify, SECItem *seed) { + return PQG_GetSeedFromVerify(verify, seed); +} + + +/************************************************************************** + * Fills in caller's "h" SECItem with the h value in verify. + * Contents can be freed by calling SECITEM_FreeItem(h, PR_FALSE); + **************************************************************************/ +extern SECStatus +PK11_PQG_GetHFromVerify(const PQGVerify *verify, SECItem * h) { + return PQG_GetHFromVerify(verify, h); +} diff --git a/security/nss/lib/pk11wrap/pk11pqg.h b/security/nss/lib/pk11wrap/pk11pqg.h new file mode 100644 index 00000000000..a6e9f543393 --- /dev/null +++ b/security/nss/lib/pk11wrap/pk11pqg.h @@ -0,0 +1,149 @@ +/* + * 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 Netscape security libraries. + * + * The Initial Developer of the Original Code is Netscape + * Communications Corporation. Portions created by Netscape are + * Copyright (C) 1994-2001 Netscape Communications Corporation. All + * Rights Reserved. + * + * Contributor(s): + * + * Alternatively, the contents of this file may be used under the + * terms of the GNU General Public License Version 2 or later (the + * "GPL"), in which case the provisions of the GPL are applicable + * instead of those above. If you wish to allow use of your + * version of this file only under the terms of the GPL and not to + * allow others to use your version of this file under the MPL, + * indicate your decision by deleting the provisions above and + * replace them with the notice and other provisions required by + * the GPL. If you do not delete the provisions above, a recipient + * may use your version of this file under either the MPL or the + * GPL. + */ +/* Thse functions are stub functions which will get replaced with calls through + * PKCS #11. + */ + +#ifndef _PK11PQG_H_ +#define _PK11PQG_H_ 1 + +#include "blapit.h" +#include "pqgutil.h" + +/* Generate PQGParams and PQGVerify structs. + * Length of seed and length of h both equal length of P. + * All lengths are specified by "j", according to the table above. + */ +extern SECStatus PK11_PQG_ParamGen(unsigned int j, PQGParams **pParams, + PQGVerify **pVfy); + +/* Generate PQGParams and PQGVerify structs. + * Length of P specified by j. Length of h will match length of P. + * Length of SEED in bytes specified in seedBytes. + * seedBbytes must be in the range [20..255] or an error will result. + */ +extern SECStatus PK11_QG_ParamGenSeedLen( unsigned int j, + unsigned int seedBytes, PQGParams **pParams, PQGVerify **pVfy); + +/* Test PQGParams for validity as DSS PQG values. + * If vfy is non-NULL, test PQGParams to make sure they were generated + * using the specified seed, counter, and h values. + * + * Return value indicates whether Verification operation ran succesfully + * to completion, but does not indicate if PQGParams are valid or not. + * If return value is SECSuccess, then *pResult has these meanings: + * SECSuccess: PQGParams are valid. + * SECFailure: PQGParams are invalid. + * + * Verify the following 12 facts about PQG counter SEED g and h + * 1. Q is 160 bits long. + * 2. P is one of the 9 valid lengths. + * 3. G < P + * 4. P % Q == 1 + * 5. Q is prime + * 6. P is prime + * Steps 7-12 are done only if the optional PQGVerify is supplied. + * 7. counter < 4096 + * 8. g >= 160 and g < 2048 (g is length of seed in bits) + * 9. Q generated from SEED matches Q in PQGParams. + * 10. P generated from (L, counter, g, SEED, Q) matches P in PQGParams. + * 11. 1 < h < P-1 + * 12. G generated from h matches G in PQGParams. + */ + +extern SECStatus PK11_PQG_VerifyParams(const PQGParams *params, + const PQGVerify *vfy, SECStatus *result); +extern void PK11_PQG_DestroyParams(PQGParams *params); +extern void PK11_PQG_DestroyVerify(PQGVerify *vfy); + +/************************************************************************** + * Return a pointer to a new PQGParams struct that is constructed from * + * copies of the arguments passed in. * + * Return NULL on failure. * + **************************************************************************/ +extern PQGParams * PK11_PQG_NewParams(const SECItem * prime, const + SECItem * subPrime, const SECItem * base); + + +/************************************************************************** + * Fills in caller's "prime" SECItem with the prime value in params. + * Contents can be freed by calling SECITEM_FreeItem(prime, PR_FALSE); + **************************************************************************/ +extern SECStatus PK11_PQG_GetPrimeFromParams(const PQGParams *params, + SECItem * prime); + + +/************************************************************************** + * Fills in caller's "subPrime" SECItem with the prime value in params. + * Contents can be freed by calling SECITEM_FreeItem(subPrime, PR_FALSE); + **************************************************************************/ +extern SECStatus PK11_PQG_GetSubPrimeFromParams(const PQGParams *params, + SECItem * subPrime); + + +/************************************************************************** + * Fills in caller's "base" SECItem with the base value in params. + * Contents can be freed by calling SECITEM_FreeItem(base, PR_FALSE); + **************************************************************************/ +extern SECStatus PK11_PQG_GetBaseFromParams(const PQGParams *params, + SECItem *base); + + +/************************************************************************** + * Return a pointer to a new PQGVerify struct that is constructed from * + * copies of the arguments passed in. * + * Return NULL on failure. * + **************************************************************************/ +extern PQGVerify * PK11_PQG_NewVerify(unsigned int counter, + const SECItem * seed, const SECItem * h); + + +/************************************************************************** + * Returns "counter" value from the PQGVerify. + **************************************************************************/ +extern unsigned int PK11_PQG_GetCounterFromVerify(const PQGVerify *verify); + +/************************************************************************** + * Fills in caller's "seed" SECItem with the seed value in verify. + * Contents can be freed by calling SECITEM_FreeItem(seed, PR_FALSE); + **************************************************************************/ +extern SECStatus PK11_PQG_GetSeedFromVerify(const PQGVerify *verify, + SECItem *seed); + +/************************************************************************** + * Fills in caller's "h" SECItem with the h value in verify. + * Contents can be freed by calling SECITEM_FreeItem(h, PR_FALSE); + **************************************************************************/ +extern SECStatus PK11_PQG_GetHFromVerify(const PQGVerify *verify, SECItem * h); + +#endif