summaryrefslogtreecommitdiffstats
path: root/netwerk/base/nsICryptoHash.idl
diff options
context:
space:
mode:
authorMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
committerMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
commit5f8de423f190bbb79a62f804151bc24824fa32d8 (patch)
tree10027f336435511475e392454359edea8e25895d /netwerk/base/nsICryptoHash.idl
parent49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff)
downloadUXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip
Add m-esr52 at 52.6.0
Diffstat (limited to 'netwerk/base/nsICryptoHash.idl')
-rw-r--r--netwerk/base/nsICryptoHash.idl105
1 files changed, 105 insertions, 0 deletions
diff --git a/netwerk/base/nsICryptoHash.idl b/netwerk/base/nsICryptoHash.idl
new file mode 100644
index 000000000..cd865a3a9
--- /dev/null
+++ b/netwerk/base/nsICryptoHash.idl
@@ -0,0 +1,105 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "nsISupports.idl"
+interface nsIInputStream;
+
+/**
+ * nsICryptoHash
+ * This interface provides crytographic hashing algorithms.
+ */
+
+[scriptable, uuid(1e5b7c43-4688-45ce-92e1-77ed931e3bbe)]
+interface nsICryptoHash : nsISupports
+{
+ /**
+ * Hashing Algorithms. These values are to be used by the
+ * |init| method to indicate which hashing function to
+ * use. These values map directly onto the values defined
+ * in mozilla/security/nss/lib/cryptohi/hasht.h.
+ */
+ const short MD2 = 1; /* String value: "md2" */
+ const short MD5 = 2; /* String value: "md5" */
+ const short SHA1 = 3; /* String value: "sha1" */
+ const short SHA256 = 4; /* String value: "sha256" */
+ const short SHA384 = 5; /* String value: "sha384" */
+ const short SHA512 = 6; /* String value: "sha512" */
+
+ /**
+ * Initialize the hashing object. This method may be
+ * called multiple times with different algorithm types.
+ *
+ * @param aAlgorithm the algorithm type to be used.
+ * This value must be one of the above valid
+ * algorithm types.
+ *
+ * @throws NS_ERROR_INVALID_ARG if an unsupported algorithm
+ * type is passed.
+ *
+ * NOTE: This method or initWithString must be called
+ * before any other method on this interface is called.
+ */
+ void init(in unsigned long aAlgorithm);
+
+ /**
+ * Initialize the hashing object. This method may be
+ * called multiple times with different algorithm types.
+ *
+ * @param aAlgorithm the algorithm type to be used.
+ *
+ * @throws NS_ERROR_INVALID_ARG if an unsupported algorithm
+ * type is passed.
+ *
+ * NOTE: This method or init must be called before any
+ * other method on this interface is called.
+ */
+ void initWithString(in ACString aAlgorithm);
+
+ /**
+ * @param aData a buffer to calculate the hash over
+ *
+ * @param aLen the length of the buffer |aData|
+ *
+ * @throws NS_ERROR_NOT_INITIALIZED if |init| has not been
+ * called.
+ */
+ void update([const, array, size_is(aLen)] in octet aData, in unsigned long aLen);
+
+ /**
+ * Calculates and updates a new hash based on a given data stream.
+ *
+ * @param aStream an input stream to read from.
+ *
+ * @param aLen how much to read from the given |aStream|. Passing
+ * UINT32_MAX indicates that all data available will be used
+ * to update the hash.
+ *
+ * @throws NS_ERROR_NOT_INITIALIZED if |init| has not been
+ * called.
+ *
+ * @throws NS_ERROR_NOT_AVAILABLE if the requested amount of
+ * data to be calculated into the hash is not available.
+ *
+ */
+ void updateFromStream(in nsIInputStream aStream, in unsigned long aLen);
+
+ /**
+ * Completes this hash object and produces the actual hash data.
+ *
+ * @param aASCII if true then the returned value is a base-64
+ * encoded string. if false, then the returned value is
+ * binary data.
+ *
+ * @return a hash of the data that was read by this object. This can
+ * be either binary data or base 64 encoded.
+ *
+ * @throws NS_ERROR_NOT_INITIALIZED if |init| has not been
+ * called.
+ *
+ * NOTE: This method may be called any time after |init|
+ * is called. This call resets the object to its
+ * pre-init state.
+ */
+ ACString finish(in boolean aASCII);
+};