Back to index

lightning-sunbird  0.9+nobinonly
pqgutil.h
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is the Netscape security libraries.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Netscape Communications Corporation.
00018  * Portions created by the Initial Developer are Copyright (C) 1994-2000
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *
00023  * Alternatively, the contents of this file may be used under the terms of
00024  * either the GNU General Public License Version 2 or later (the "GPL"), or
00025  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00026  * in which case the provisions of the GPL or the LGPL are applicable instead
00027  * of those above. If you wish to allow use of your version of this file only
00028  * under the terms of either the GPL or the LGPL, and not to allow others to
00029  * use your version of this file under the terms of the MPL, indicate your
00030  * decision by deleting the provisions above and replace them with the notice
00031  * and other provisions required by the GPL or the LGPL. If you do not delete
00032  * the provisions above, a recipient may use your version of this file under
00033  * the terms of any one of the MPL, the GPL or the LGPL.
00034  *
00035  * ***** END LICENSE BLOCK ***** */
00036 #ifndef _PQGUTIL_H_
00037 #define _PQGUTIL_H_ 1
00038 
00039 #include "blapi.h"
00040 
00041 /**************************************************************************
00042  *  Return a pointer to a new PQGParams struct that is a duplicate of     *
00043  *  the one passed as an argument.                                        *
00044  *  Return NULL on failure, or if NULL was passed in.                     *
00045  **************************************************************************/
00046 extern PQGParams * PQG_DupParams(const PQGParams *src);
00047 
00048 
00049 /**************************************************************************
00050  *  Return a pointer to a new PQGParams struct that is constructed from   *
00051  *  copies of the arguments passed in.                                    *
00052  *  Return NULL on failure.                                               *
00053  **************************************************************************/
00054 extern PQGParams * PQG_NewParams(const SECItem * prime, 
00055                                  const SECItem * subPrime, 
00056                                  const SECItem * base);
00057 
00058 
00059 /**************************************************************************
00060  * Fills in caller's "prime" SECItem with the prime value in params.
00061  * Contents can be freed by calling SECITEM_FreeItem(prime, PR_FALSE);       
00062  **************************************************************************/
00063 extern SECStatus PQG_GetPrimeFromParams(const PQGParams *params, 
00064                                         SECItem * prime);
00065 
00066 
00067 /**************************************************************************
00068  * Fills in caller's "subPrime" SECItem with the prime value in params.
00069  * Contents can be freed by calling SECITEM_FreeItem(subPrime, PR_FALSE);    
00070  **************************************************************************/
00071 extern SECStatus PQG_GetSubPrimeFromParams(const PQGParams *params, 
00072                                            SECItem * subPrime);
00073 
00074 
00075 /**************************************************************************
00076  * Fills in caller's "base" SECItem with the base value in params.
00077  * Contents can be freed by calling SECITEM_FreeItem(base, PR_FALSE); 
00078  **************************************************************************/
00079 extern SECStatus PQG_GetBaseFromParams(const PQGParams *params, SECItem *base);
00080 
00081 
00082 /**************************************************************************
00083  *  Free the PQGParams struct and the things it points to.                *
00084  **************************************************************************/
00085 extern void PQG_DestroyParams(PQGParams *params);
00086 
00087 
00088 /**************************************************************************
00089  *  Return a pointer to a new PQGVerify struct that is a duplicate of     *
00090  *  the one passed as an argument.                                        *
00091  *  Return NULL on failure, or if NULL was passed in.                     *
00092  **************************************************************************/
00093 extern PQGVerify * PQG_DupVerify(const PQGVerify *src);
00094 
00095 
00096 /**************************************************************************
00097  *  Return a pointer to a new PQGVerify struct that is constructed from   *
00098  *  copies of the arguments passed in.                                    *
00099  *  Return NULL on failure.                                               *
00100  **************************************************************************/
00101 extern PQGVerify * PQG_NewVerify(unsigned int counter, const SECItem * seed, 
00102                                  const SECItem * h);
00103 
00104 
00105 /**************************************************************************
00106  * Returns "counter" value from the PQGVerify.
00107  **************************************************************************/
00108 extern unsigned int PQG_GetCounterFromVerify(const PQGVerify *verify);
00109 
00110 /**************************************************************************
00111  * Fills in caller's "seed" SECItem with the seed value in verify.
00112  * Contents can be freed by calling SECITEM_FreeItem(seed, PR_FALSE); 
00113  **************************************************************************/
00114 extern SECStatus PQG_GetSeedFromVerify(const PQGVerify *verify, SECItem *seed);
00115 
00116 
00117 /**************************************************************************
00118  * Fills in caller's "h" SECItem with the h value in verify.
00119  * Contents can be freed by calling SECITEM_FreeItem(h, PR_FALSE);    
00120  **************************************************************************/
00121 extern SECStatus PQG_GetHFromVerify(const PQGVerify *verify, SECItem * h);
00122 
00123 
00124 /**************************************************************************
00125  *  Free the PQGVerify struct and the things it points to.                *
00126  **************************************************************************/
00127 extern void PQG_DestroyVerify(PQGVerify *vfy);
00128 
00129 
00130 #endif