/security/nss/lib/freebl/alghmac.h

 1/* ***** BEGIN LICENSE BLOCK *****
 2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 3 *
 4 * The contents of this file are subject to the Mozilla Public License Version
 5 * 1.1 (the "License"); you may not use this file except in compliance with
 6 * the License. You may obtain a copy of the License at
 7 * http://www.mozilla.org/MPL/
 8 *
 9 * Software distributed under the License is distributed on an "AS IS" basis,
10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 * for the specific language governing rights and limitations under the
12 * License.
13 *
14 * The Original Code is the Netscape security libraries.
15 *
16 * The Initial Developer of the Original Code is
17 * Netscape Communications Corporation.
18 * Portions created by the Initial Developer are Copyright (C) 1994-2000
19 * the Initial Developer. All Rights Reserved.
20 *
21 * Contributor(s):
22 *
23 * Alternatively, the contents of this file may be used under the terms of
24 * either the GNU General Public License Version 2 or later (the "GPL"), or
25 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
26 * in which case the provisions of the GPL or the LGPL are applicable instead
27 * of those above. If you wish to allow use of your version of this file only
28 * under the terms of either the GPL or the LGPL, and not to allow others to
29 * use your version of this file under the terms of the MPL, indicate your
30 * decision by deleting the provisions above and replace them with the notice
31 * and other provisions required by the GPL or the LGPL. If you do not delete
32 * the provisions above, a recipient may use your version of this file under
33 * the terms of any one of the MPL, the GPL or the LGPL.
34 *
35 * ***** END LICENSE BLOCK ***** */
36
37#ifndef _ALGHMAC_H_
38#define _ALGHMAC_H_
39
40typedef struct HMACContextStr HMACContext;
41
42SEC_BEGIN_PROTOS
43
44/* destroy HMAC context */
45extern void
46HMAC_Destroy(HMACContext *cx, PRBool freeit);
47
48/* create HMAC context
49 *  hash_obj    hash object from SECRawHashObjects[]
50 *  secret	the secret with which the HMAC is performed.
51 *  secret_len	the length of the secret.
52 *  isFIPS	true if conforming to FIPS 198.
53 *
54 * NULL is returned if an error occurs.
55 */
56extern HMACContext *
57HMAC_Create(const SECHashObject *hash_obj, const unsigned char *secret, 
58	    unsigned int secret_len, PRBool isFIPS);
59
60/* like HMAC_Create, except caller allocates HMACContext. */
61SECStatus
62HMAC_Init(HMACContext *cx, const SECHashObject *hash_obj, 
63	  const unsigned char *secret, unsigned int secret_len, PRBool isFIPS);
64
65/* reset HMAC for a fresh round */
66extern void
67HMAC_Begin(HMACContext *cx);
68
69/* update HMAC 
70 *  cx		HMAC Context
71 *  data	the data to perform HMAC on
72 *  data_len	the length of the data to process
73 */
74extern void 
75HMAC_Update(HMACContext *cx, const unsigned char *data, unsigned int data_len);
76
77/* Finish HMAC -- place the results within result
78 *  cx		HMAC context
79 *  result	buffer for resulting hmac'd data
80 *  result_len	where the resultant hmac length is stored
81 *  max_result_len  maximum possible length that can be stored in result
82 */
83extern SECStatus
84HMAC_Finish(HMACContext *cx, unsigned char *result, unsigned int *result_len,
85	    unsigned int max_result_len);
86
87/* clone a copy of the HMAC state.  this is usefult when you would
88 * need to keep a running hmac but also need to extract portions 
89 * partway through the process.
90 */
91extern HMACContext *
92HMAC_Clone(HMACContext *cx);
93
94SEC_END_PROTOS
95
96#endif