@vlasky/shacrypt 0.4.0 → 0.5.1

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [0.5.1] - 2026-01-29
+
+### Added
+- TypeScript type declarations (`index.d.ts`)
+
+## [0.5.0] - 2026-01-28
+
+### Changed
+- **Breaking:** Minimum Node.js version is now 18.0.0
+- Updated NAN to 2.25.0 for Node.js 25 compatibility
+- Updated mocha to 11.3.0 and chai to 6.2.2
+- Replaced `NODE_MODULE` with `NAN_MODULE_WORKER_ENABLED` for proper module registration
+- Fixed null pointer subtraction warnings in sha256crypt.c and sha512crypt.c using `uintptr_t`
+
+### Added
+- Support for Node.js 25
+
 ## [0.4.0] - 2025-06-27
 
 ### Added

package/README.md

@@ -16,6 +16,8 @@ Asynchronous mode is especially useful in that computation is performed in Node.
 npm install @vlasky/shacrypt
 ```
 
+TypeScript type declarations are included.
+
 NOTE: You will need to have C++ build tools installed on your system to successfully install the package. If you are running under Windows, you can download Microsoft's [Build Tools for Visual Studio 2017](https://www.visualstudio.com/downloads/#build-tools-for-visual-studio-2017).
 
 ### Usage

package/index.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Callback function for async hash operations.
+ */
+type HashCallback = (error: Error | null, hash: string) => void;
+
+/**
+ * Generate SHA256-CRYPT hash (synchronous).
+ *
+ * @param password - The password to hash
+ * @param salt - Optional salt string (auto-generated if not provided)
+ * @param rounds - Optional number of rounds (default: 5000, minimum: 1000)
+ * @returns The hashed password string
+ */
+export function sha256crypt(password: string, salt?: string, rounds?: number): string;
+
+/**
+ * Generate SHA256-CRYPT hash (callback-based async).
+ *
+ * @param password - The password to hash
+ * @param salt - Optional salt string (auto-generated if not provided)
+ * @param rounds - Optional number of rounds (default: 5000, minimum: 1000)
+ * @param callback - Callback function receiving (error, hash)
+ */
+export function sha256crypt(password: string, salt: string | undefined, rounds: number | undefined, callback: HashCallback): void;
+
+/**
+ * Generate SHA512-CRYPT hash (synchronous).
+ *
+ * @param password - The password to hash
+ * @param salt - Optional salt string (auto-generated if not provided)
+ * @param rounds - Optional number of rounds (default: 5000, minimum: 1000)
+ * @returns The hashed password string
+ */
+export function sha512crypt(password: string, salt?: string, rounds?: number): string;
+
+/**
+ * Generate SHA512-CRYPT hash (callback-based async).
+ *
+ * @param password - The password to hash
+ * @param salt - Optional salt string (auto-generated if not provided)
+ * @param rounds - Optional number of rounds (default: 5000, minimum: 1000)
+ * @param callback - Callback function receiving (error, hash)
+ */
+export function sha512crypt(password: string, salt: string | undefined, rounds: number | undefined, callback: HashCallback): void;
+
+/**
+ * Generate SHA256-CRYPT hash (async/await compatible).
+ *
+ * @param password - The password to hash
+ * @param salt - Optional salt string (auto-generated if not provided)
+ * @param rounds - Optional number of rounds (default: 5000, minimum: 1000)
+ * @returns Promise resolving to the hashed password string
+ */
+export function sha256cryptAsync(password: string, salt?: string, rounds?: number): Promise<string>;
+
+/**
+ * Generate SHA512-CRYPT hash (async/await compatible).
+ *
+ * @param password - The password to hash
+ * @param salt - Optional salt string (auto-generated if not provided)
+ * @param rounds - Optional number of rounds (default: 5000, minimum: 1000)
+ * @returns Promise resolving to the hashed password string
+ */
+export function sha512cryptAsync(password: string, salt?: string, rounds?: number): Promise<string>;

package/package.json

@@ -1,33 +1,34 @@
 {
   "name": "@vlasky/shacrypt",
   "description": "Node.js wrapper over sha256-crypt and sha512-crypt functions originally created by Ulrich Drepper https://www.akkadia.org/drepper/SHA-crypt.txt",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "homepage": "https://github.com/vlasky/shacrypt",
   "author": "Vlad Lasky <github@vladlasky.com> (https://github.com/vlasky/)",
   "contributors": [
     "Oleksiy Krivoshey <oleksiyk@gmail.com> (https://github.com/oleksiyk/)"
   ],
   "main": "shacrypt",
+  "types": "index.d.ts",
   "scripts": {
     "install": "node-gyp rebuild",
     "test": "make test"
   },
   "dependencies": {
-    "nan": "^2.22.2"
+    "nan": "^2.25.0"
   },
   "devDependencies": {
-      "mocha": "^10.8.2",
-      "chai": "^4.5.0"
+    "chai": "^6.2.2",
+    "mocha": "^11.3.0"
   },
   "engines": {
-    "node": ">= 16.0.0"
+    "node": ">= 18.0.0"
   },
   "bugs": {
     "url": "https://github.com/vlasky/shacrypt/issues"
   },
   "repository": {
-        "type": "git",
-        "url": "git://github.com/vlasky/shacrypt.git"
+    "type": "git",
+    "url": "git://github.com/vlasky/shacrypt.git"
   },
   "gypfile": true,
   "readmeFilename": "README.md",

package/src/sha256crypt.c

@@ -364,21 +364,21 @@ sha256_crypt_r (const char *key, const char *salt, char *buffer, int buflen)
   salt_len = MIN (strcspn (salt, "$"), SALT_LEN_MAX);
   key_len = strlen (key);
 
-  if ((key - (char *) 0) % __alignof__ (uint32_t) != 0)
+  if ((uintptr_t)key % __alignof__ (uint32_t) != 0)
     {
       char *tmp = (char *) alloca (key_len + __alignof__ (uint32_t));
       key = copied_key = (char *)
 	memcpy (tmp + __alignof__ (uint32_t)
-		- (tmp - (char *) 0) % __alignof__ (uint32_t),
+		- (uintptr_t)tmp % __alignof__ (uint32_t),
 		key, key_len);
     }
 
-  if ((salt - (char *) 0) % __alignof__ (uint32_t) != 0)
+  if ((uintptr_t)salt % __alignof__ (uint32_t) != 0)
     {
       char *tmp = (char *) alloca (salt_len + __alignof__ (uint32_t));
       salt = copied_salt = (char *)
 	memcpy (tmp + __alignof__ (uint32_t)
-		- (tmp - (char *) 0) % __alignof__ (uint32_t),
+		- (uintptr_t)tmp % __alignof__ (uint32_t),
 		salt, salt_len);
     }
 

package/src/sha512crypt.c

@@ -394,21 +394,21 @@ sha512_crypt_r (const char *key, const char *salt, char *buffer, int buflen)
   salt_len = MIN (strcspn (salt, "$"), SALT_LEN_MAX);
   key_len = strlen (key);
 
-  if ((key - (char *) 0) % __alignof__ (uint64_t) != 0)
+  if ((uintptr_t)key % __alignof__ (uint64_t) != 0)
     {
       char *tmp = (char *) alloca (key_len + __alignof__ (uint64_t));
       key = copied_key = (char *)
 	memcpy (tmp + __alignof__ (uint64_t)
-		- (tmp - (char *) 0) % __alignof__ (uint64_t),
+		- (uintptr_t)tmp % __alignof__ (uint64_t),
 		key, key_len);
     }
 
-  if ((salt - (char *) 0) % __alignof__ (uint64_t) != 0)
+  if ((uintptr_t)salt % __alignof__ (uint64_t) != 0)
     {
       char *tmp = (char *) alloca (salt_len + __alignof__ (uint64_t));
       salt = copied_salt = (char *)
 	memcpy (tmp + __alignof__ (uint64_t)
-		- (tmp - (char *) 0) % __alignof__ (uint64_t),
+		- (uintptr_t)tmp % __alignof__ (uint64_t),
 		salt, salt_len);
     }
 

package/src/shacrypt.cc

@@ -177,5 +177,5 @@ NAN_MODULE_INIT(init) {
 }
 
 
-NODE_MODULE(shacrypt, init);
+NAN_MODULE_WORKER_ENABLED(shacrypt, init)