### Added

- TypeScript interfaces. #6, #9
- HMAC feature.
- support for web worker. #14

### Fixed
- deprecated `new Buffer`, replace with `Buffer.from`. #10
- dependencies and security issues.
- refactor: simplify formatMessage internal logic.
- Generates incorrect hash in some cases.

### Changed
- remove `eval` and use `require` directly. #8
- throw error by Error oject.
- throw error if update after finalize
- use unsigned right shift.

CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change Log
 
+## v0.7.0 / 2024-01-24
+### Added
+- TypeScript interfaces. #6, #9
+- HMAC feature.
+- support for web worker. #14
+
+### Fixed
+- deprecated `new Buffer`, replace with `Buffer.from`. #10
+- dependencies and security issues.
+- refactor: simplify formatMessage internal logic.
+- Generates incorrect hash in some cases.
+
+### Changed
+- remove `eval` and use `require` directly. #8
+- throw error by Error oject.
+- throw error if update after finalize
+- use unsigned right shift.
+
 ## v0.6.0 / 2017-12-21
 ### Fixed
 - incorrect result when first bit is 1 of bytes.

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright 2014-2017 Chen, Yi-Cyuan
+Copyright 2014-2024 Chen, Yi-Cyuan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.md

@@ -6,6 +6,7 @@ A simple SHA1 hash function for JavaScript supports UTF-8 encoding.
 
 ## Demo
 [SHA1 Online](http://emn178.github.io/online-tools/sha1.html)
+[SHA1 File Checksum Online](https://emn178.github.io/online-tools/sha1_checksum.html)
 
 ## Download
 [Compress](https://raw.github.com/emn178/js-sha1/master/build/sha1.min.js)  
@@ -20,18 +21,38 @@ For node.js, you can use this command to install:
 
     npm install js-sha1
 
+## Notice
+NIST formally deprecated use of SHA-1 in 2011 and disallowed its use for digital signatures in 2013, and declared that it should be phased out by 2030. However, SHA-1 is still secure for HMAC. [wiki](https://en.wikipedia.org/wiki/SHA-1)
+
 ## Usage
 You could use like this:
 ```JavaScript
 sha1('Message to hash');
 var hash = sha1.create();
 hash.update('Message to hash');
 hash.hex();
+
+// HMAC
+sha1.hmac('key', 'Message to hash');
+
+var hash = sha1.hmac.create('key');
+hash.update('Message to hash');
+hash.hex();
 ```
+
+### Node.js
 If you use node.js, you should require the module first:
 ```JavaScript
-sha1 = require('js-sha1');
+var sha1 = require('js-sha1');
 ```
+
+### TypeScript
+If you use TypeScript, you can import like this:
+```TypeScript
+import { sha1 } from 'js-sha1';
+```
+
+## RequireJS
 It supports AMD:
 ```JavaScript
 require(['your/path/sha1.js'], function(sha1) {
@@ -58,6 +79,11 @@ sha1.hex(''); // da39a3ee5e6b4b0d3255bfef95601890afd80709
 sha1.array(''); // [218, 57, 163, 238, 94, 107, 75, 13, 50, 85, 191, 239, 149, 96, 24, 144, 175, 216, 7, 9]
 sha1.digest(''); // [218, 57, 163, 238, 94, 107, 75, 13, 50, 85, 191, 239, 149, 96, 24, 144, 175, 216, 7, 9]
 sha1.arrayBuffer(''); // ArrayBuffer
+
+// HMAC
+sha1.hmac.hex('key', 'Message to hash');
+sha1.hmac.array('key', 'Message to hash');
+// ...
 ```
 
 ## License

index.d.ts

@@ -0,0 +1,148 @@
+type Message = string | number[] | ArrayBuffer | Uint8Array;
+
+interface Hasher {
+  /**
+   * Update hash
+   *
+   * @param message The message you want to hash.
+   */
+  update(message: Message): Hasher;
+
+  /**
+   * Return hash in hex string.
+   */
+  hex(): string;
+
+  /**
+   * Return hash in hex string.
+   */
+  toString(): string;
+
+  /**
+   * Return hash in ArrayBuffer.
+   */
+  arrayBuffer(): ArrayBuffer;
+
+  /**
+   * Return hash in integer array.
+   */
+  digest(): number[];
+
+  /**
+   * Return hash in integer array.
+   */
+  array(): number[];
+}
+
+interface Hmac {
+  /**
+   * Computes a Hash-based message authentication code (HMAC) using a secret key
+   *
+   * @param secretKey The Secret Key
+   * @param message The message you want to hash.
+   */
+  (secretKey: Message, message: Message): string;
+
+  /**
+   * Create a hash object using a secret key.
+   *
+   * @param secretKey The Secret Key
+   */
+  create(secretKey: Message): Hasher;
+
+  /**
+   * Create a hash object and hash message using a secret key
+   *
+   * @param secretKey The Secret Key
+   * @param message The message you want to hash.
+   */
+  update(secretKey: Message, message: Message): Hasher;
+
+  /**
+   * Return hash in hex string.
+   *
+   * @param secretKey The Secret Key
+   * @param message The message you want to hash.
+   */
+  hex(secretKey: Message, message: Message): string;
+
+  /**
+   * Return hash in ArrayBuffer.
+   *
+   * @param secretKey The Secret Key
+   * @param message The message you want to hash.
+   */
+  arrayBuffer(secretKey: Message, message: Message): ArrayBuffer;
+
+  /**
+   * Return hash in integer array.
+   *
+   * @param secretKey The Secret Key
+   * @param message The message you want to hash.
+   */
+  digest(secretKey: Message, message: Message): number[];
+
+  /**
+   * Return hash in integer array.
+   *
+   * @param secretKey The Secret Key
+   * @param message The message you want to hash.
+   */
+  array(secretKey: Message, message: Message): number[];
+}
+
+interface Hash {
+  /**
+   * Hash and return hex string.
+   *
+   * @param message The message you want to hash.
+   */
+  (message: Message): string;
+
+  /**
+   * Create a hash object.
+   */
+  create(): Hasher;
+
+  /**
+   * Create a hash object and hash message.
+   *
+   * @param message The message you want to hash.
+   */
+  update(message: Message): Hasher;
+
+  /**
+   * Return hash in hex string.
+   *
+   * @param message The message you want to hash.
+   */
+  hex(message: Message): string;
+
+  /**
+   * Return hash in ArrayBuffer.
+   *
+   * @param message The message you want to hash.
+   */
+  arrayBuffer(message: Message): ArrayBuffer;
+
+  /**
+   * Return hash in integer array.
+   *
+   * @param message The message you want to hash.
+   */
+  digest(message: Message): number[];
+
+  /**
+   * Return hash in integer array.
+   *
+   * @param message The message you want to hash.
+   */
+  array(message: Message): number[];
+
+  /**
+   * HMAC interface
+   */
+  hmac: Hmac;
+}
+
+export var sha1: Hash;