ethers.js/lib.esm/crypto/hmac.js

47 lines
1.3 KiB
JavaScript
Raw Normal View History

2022-12-03 05:27:06 +03:00
/**
* An **HMAC** enables verification that a given key was used
* to authenticate a payload.
*
* See: [[link-wiki-hmac]]
*
* @_subsection: api/crypto:HMAC [about-hmac]
*/
2022-11-09 10:57:02 +03:00
import { createHmac } from "./crypto.js";
2022-09-16 05:58:45 +03:00
import { getBytes, hexlify } from "../utils/index.js";
2022-09-05 23:57:11 +03:00
let locked = false;
const _computeHmac = function (algorithm, key, data) {
2022-10-20 12:03:32 +03:00
return createHmac(algorithm, key).update(data).digest();
2022-09-05 23:57:11 +03:00
};
let __computeHmac = _computeHmac;
2022-12-03 05:27:06 +03:00
/**
* Return the HMAC for %%data%% using the %%key%% key with the underlying
* %%algo%% used for compression.
2022-12-10 02:24:58 +03:00
*
* @example:
* key = id("some-secret")
*
* // Compute the HMAC
* computeHmac("sha256", key, "0x1337")
* //_result:
*
* // To compute the HMAC of UTF-8 data, the data must be
* // converted to UTF-8 bytes
* computeHmac("sha256", key, toUtf8Bytes("Hello World"))
* //_result:
*
2022-12-03 05:27:06 +03:00
*/
2022-09-05 23:57:11 +03:00
export function computeHmac(algorithm, _key, _data) {
2022-09-16 05:58:45 +03:00
const key = getBytes(_key, "key");
const data = getBytes(_data, "data");
2022-09-05 23:57:11 +03:00
return hexlify(__computeHmac(algorithm, key, data));
}
computeHmac._ = _computeHmac;
computeHmac.lock = function () { locked = true; };
computeHmac.register = function (func) {
if (locked) {
throw new Error("computeHmac is locked");
}
__computeHmac = func;
};
Object.freeze(computeHmac);
//# sourceMappingURL=hmac.js.map