Back to index

lightning-sunbird  0.9+nobinonly
nsIHash.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Mozilla Communicator.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corp..
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s): David Drinan <ddrinan@netscape.com>
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 
00040 %{ C++
00041 #define NS_HASH_CONTRACTID "@mozilla.org/nsHash;1"
00042 %}
00043 
00044 [ptr] native UnsignedCharPtr(unsigned char);
00045 
00046 /*
00047  * nsIHash
00048  *  Generic hashing interface
00049  */
00050 [uuid(a31a3028-ae28-11d5-ba4b-00108303b117)]
00051 interface nsIHash : nsISupports
00052 {
00053   const short HASH_AlgNULL = 0;
00054   const short HASH_AlgMD2  = 1;
00055   const short HASH_AlgMD5  = 2;
00056   const short HASH_AlgSHA1 = 3;
00057   const unsigned long MD2_LEN  = 16;
00058   const unsigned long MD5_LEN  = 16;
00059   const unsigned long SHA1_LEN = 20;
00060   const unsigned long MAX_HASH_LEN = SHA1_LEN;  
00061 
00062   unsigned long resultLen(in short aAlg);
00063   void create(in short aAlg);
00064   void begin();
00065   void update(in UnsignedCharPtr aBuf, in  unsigned long aLen);
00066   void end(in UnsignedCharPtr aHash, out unsigned long aLen, in unsigned long aMaxLen);
00067 };
00068