Back to index

lightning-sunbird  0.9+nobinonly
hasht.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 /* $Id: hasht.h,v 1.7 2005/11/07 18:44:20 wtchang%redhat.com Exp $ */
00037 
00038 #ifndef _HASHT_H_
00039 #define _HASHT_H_
00040 
00041 /* Opaque objects */
00042 typedef struct SECHashObjectStr SECHashObject;
00043 typedef struct HASHContextStr HASHContext;
00044 
00045 /*
00046  * The hash functions the security library supports
00047  * NOTE the order must match the definition of SECHashObjects[]!
00048  */
00049 typedef enum {
00050     HASH_AlgNULL   = 0,
00051     HASH_AlgMD2    = 1,
00052     HASH_AlgMD5    = 2,
00053     HASH_AlgSHA1   = 3,
00054     HASH_AlgSHA256 = 4,
00055     HASH_AlgSHA384 = 5,
00056     HASH_AlgSHA512 = 6,
00057     HASH_AlgTOTAL
00058 } HASH_HashType;
00059 
00060 /*
00061  * Number of bytes each hash algorithm produces
00062  */
00063 #define MD2_LENGTH   16
00064 #define MD5_LENGTH   16
00065 #define SHA1_LENGTH  20
00066 #define SHA256_LENGTH       32
00067 #define SHA384_LENGTH       48
00068 #define SHA512_LENGTH       64
00069 #define HASH_LENGTH_MAX SHA512_LENGTH
00070 
00071 /*
00072  * Structure to hold hash computation info and routines
00073  */
00074 struct SECHashObjectStr {
00075     unsigned int length;  /* hash output length (in bytes) */
00076     void * (*create)(void);
00077     void * (*clone)(void *);
00078     void (*destroy)(void *, PRBool);
00079     void (*begin)(void *);
00080     void (*update)(void *, const unsigned char *, unsigned int);
00081     void (*end)(void *, unsigned char *, unsigned int *, unsigned int);
00082     unsigned int blocklength;  /* hash input block size (in bytes) */
00083     HASH_HashType type;
00084 };
00085 
00086 struct HASHContextStr {
00087     const struct SECHashObjectStr *hashobj;
00088     void *hash_context;
00089 };
00090 
00091 /* This symbol is NOT exported from the NSS DLL.  Code that needs a 
00092  * pointer to one of the SECHashObjects should call HASH_GetHashObject()
00093  * instead. See "sechash.h".
00094  */
00095 extern const SECHashObject SECHashObjects[];
00096 
00097 /* Only those functions below the PKCS #11 line should use SECRawHashObjects.
00098  * This symbol is not exported from the NSS DLL.
00099  */
00100 extern const SECHashObject SECRawHashObjects[];
00101 
00102 #endif /* _HASHT_H_ */