Back to index

lightning-sunbird  0.9+nobinonly
alghmac.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 
00037 #ifndef _ALGHMAC_H_
00038 #define _ALGHMAC_H_
00039 
00040 typedef struct HMACContextStr HMACContext;
00041 
00042 SEC_BEGIN_PROTOS
00043 
00044 /* destroy HMAC context */
00045 extern void
00046 HMAC_Destroy(HMACContext *cx, PRBool freeit);
00047 
00048 /* create HMAC context
00049  *  hash_obj    hash object from SECRawHashObjects[]
00050  *  secret    the secret with which the HMAC is performed.
00051  *  secret_len       the length of the secret.
00052  *  isFIPS    true if conforming to FIPS 198.
00053  *
00054  * NULL is returned if an error occurs.
00055  */
00056 extern HMACContext *
00057 HMAC_Create(const SECHashObject *hash_obj, const unsigned char *secret, 
00058            unsigned int secret_len, PRBool isFIPS);
00059 
00060 /* like HMAC_Create, except caller allocates HMACContext. */
00061 SECStatus
00062 HMAC_Init(HMACContext *cx, const SECHashObject *hash_obj, 
00063          const unsigned char *secret, unsigned int secret_len, PRBool isFIPS);
00064 
00065 /* reset HMAC for a fresh round */
00066 extern void
00067 HMAC_Begin(HMACContext *cx);
00068 
00069 /* update HMAC 
00070  *  cx        HMAC Context
00071  *  data      the data to perform HMAC on
00072  *  data_len  the length of the data to process
00073  */
00074 extern void 
00075 HMAC_Update(HMACContext *cx, const unsigned char *data, unsigned int data_len);
00076 
00077 /* Finish HMAC -- place the results within result
00078  *  cx        HMAC context
00079  *  result    buffer for resulting hmac'd data
00080  *  result_len       where the resultant hmac length is stored
00081  *  max_result_len  maximum possible length that can be stored in result
00082  */
00083 extern SECStatus
00084 HMAC_Finish(HMACContext *cx, unsigned char *result, unsigned int *result_len,
00085            unsigned int max_result_len);
00086 
00087 /* clone a copy of the HMAC state.  this is usefult when you would
00088  * need to keep a running hmac but also need to extract portions 
00089  * partway through the process.
00090  */
00091 extern HMACContext *
00092 HMAC_Clone(HMACContext *cx);
00093 
00094 SEC_END_PROTOS
00095 
00096 #endif