security/manager/ssl/nsICryptoHash.idl

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #include "nsISupports.idl"
   6 interface nsIInputStream;
   7
   8 %{C++
   9 #include "mozilla/AlreadyAddRefed.h"
  10 %}
  11
  12 /**
  13  * nsICryptoHash
  14  * This interface provides crytographic hashing algorithms.
  15  */
  16
  17 [builtinclass, scriptable, uuid(1e5b7c43-4688-45ce-92e1-77ed931e3bbe)]
  18 interface nsICryptoHash : nsISupports
  19 {
  20     /**
  21      * Hashing Algorithms.  These values are to be used by the
  22      * |init| method to indicate which hashing function to
  23      * use.  These values must be identical to the values defined
  24      * in security/nss/lib/util/hasht.h in type HASH_HashType.
  25      * This allows us to use NSS mapping functions like
  26      * HASH_GetHashOidTagByHashType with these values.
  27      */
  28     const short MD5    = 2;  /* String value: "md5"    */
  29     const short SHA1   = 3;  /* String value: "sha1"   */
  30     const short SHA256 = 4;  /* String value: "sha256" */
  31     const short SHA384 = 5;  /* String value: "sha384" */
  32     const short SHA512 = 6;  /* String value: "sha512" */
  33
  34     /**
  35      * Initialize the hashing object. This method may be
  36      * called multiple times with different algorithm types.
  37      *
  38      * @param aAlgorithm the algorithm type to be used.
  39      *        This value must be one of the above valid
  40      *        algorithm types.
  41      *
  42      * @throws NS_ERROR_INVALID_ARG if an unsupported algorithm
  43      *         type is passed.
  44      *
  45      * NOTE: This method or initWithString must be called
  46      *       before any other method on this interface is called.
  47      */
  48     void init(in unsigned long aAlgorithm);
  49
  50     /**
  51      * Initialize the hashing object. This method may be
  52      * called multiple times with different algorithm types.
  53      *
  54      * @param aAlgorithm the algorithm type to be used.
  55      *
  56      * @throws NS_ERROR_INVALID_ARG if an unsupported algorithm
  57      *         type is passed.
  58      *
  59      * NOTE: This method or init must be called before any
  60      *       other method on this interface is called.
  61      */
  62     [must_use]
  63     void initWithString(in ACString aAlgorithm);
  64
  65     /**
  66      * @param aData a buffer to calculate the hash over
  67      *
  68      * @param aLen the length of the buffer |aData|
  69      *
  70      * @throws NS_ERROR_NOT_INITIALIZED If |init| has not been called.
  71      */
  72     void update([const, array, size_is(aLen)] in octet aData, in unsigned long aLen);
  73
  74     /**
  75      * Calculates and updates a new hash based on a given data stream.
  76      *
  77      * @param aStream an input stream to read from.
  78      *
  79      * @param aLen How much to read from the given |aStream|. Passing UINT32_MAX
  80      *        indicates that all data available will be used to update the hash.
  81      *
  82      * @throws NS_ERROR_NOT_INITIALIZED If |init| has not been called.
  83      *
  84      * @throws NS_ERROR_NOT_AVAILABLE If the requested amount of
  85      *         data to be calculated into the hash is not available.
  86      *
  87      */
  88     [must_use]
  89     void updateFromStream(in nsIInputStream aStream, in unsigned long aLen);
  90
  91     /**
  92      * Completes this hash object and produces the actual hash data.
  93      *
  94      * @param aASCII If true then the returned value is a base64 encoded string.
  95      *        If false, then the returned value is binary data.
  96      *
  97      * @return a hash of the data that was read by this object.  This can
  98      *         be either binary data or base 64 encoded.
  99      *
 100      * @throws NS_ERROR_NOT_INITIALIZED If |init| has not been called.
 101      *
 102      * NOTE: This method may be called any time after |init|
 103      *       is called.  This call resets the object to its
 104      *       pre-init state.
 105      */
 106     ACString finish(in boolean aASCII);
 107 };
 108
 109 %{C++
 110 already_AddRefed<nsICryptoHash> NS_NewCryptoHash();
 111 nsresult NS_NewCryptoHash(uint32_t aHashType, nsICryptoHash** aOutHasher);
 112 nsresult NS_NewCryptoHash(const nsACString& aHashType, nsICryptoHash** aOutHasher);
 113 %}