@mherod/get-cookie 2.0.0-rc.1 → 2.0.0-rc.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mherod/get-cookie",
-  "version": "2.0.0-rc.1",
+  "version": "2.0.0-rc.10",
   "description": "Node.js module for querying a local user's Chrome cookie",
   "source": "src/index.ts",
   "bin": "dist/cli.js",
@@ -11,7 +11,7 @@
     "access": "public"
   },
   "scripts": {
-    "clean": "git clean -fXd && yarn",
+    "clean": "git clean -fdX && rm -rf node_modules dist && yarn install",
     "build": "parcel build",
     "prepare": "npm run build && npm run prettier",
     "test": "jest",
@@ -27,14 +27,13 @@
     "main": {},
     "types": {},
     "library": {
-      "source": [
-        "src/index.ts"
-      ],
+      "source": "src/index.ts",
       "distDir": "dist",
       "isLibrary": true,
       "engines": {
         "node": "16"
-      }
+      },
+      "includeNodeModules": false
     },
     "cli": {
       "source": "src/cli.ts",
@@ -66,7 +65,10 @@
     "lodash": "^4.17.21",
     "lru-cache": "^7.14.0",
     "minimist": "^1.2.6",
-    "sqlite3": "^5.1.1"
+    "sqlite3": "^5.1.1",
+    "tough-cookie": "^4.1.2",
+    "tough-cookie-file-store": "^2.0.3",
+    "user-agents": "^1.0.1165"
   },
   "devDependencies": {
     "@parcel/packager-ts": "^2.7.0",
@@ -75,6 +77,7 @@
     "@types/lodash": "^4.14.186",
     "@types/minimist": "^1.2.2",
     "@types/node": "^18.8.2",
+    "@types/tough-cookie": "^4.0.2",
     "@types/user-agents": "^1.0.2",
     "jest": "^29.0.3",
     "parcel": "^2.7.0",

package/src/CookieRow.ts

@@ -1,4 +1,5 @@
-export interface CookieRow {
+export default interface CookieRow {
+  expiry?: number;
   domain: string;
   name: string;
   value: Buffer;

package/src/CookieSpec.ts

@@ -1,4 +1,4 @@
-export interface CookieSpec {
-  name: string;
+export default interface CookieSpec {
   domain: string;
+  name: string;
 }

package/src/CookieStore.ts

@@ -0,0 +1,10 @@
+import { CookieJar } from "tough-cookie";
+import { env } from "./global";
+const { FileCookieStore } = require("tough-cookie-file-store");
+
+export const cookieStore = new FileCookieStore(
+  `${env["HOME"]}/cookie-star.json`
+);
+// export const cookieStore = new MemoryCookieStore();
+
+export const cookieJar = new CookieJar(cookieStore);

package/src/ExportedCookie.ts

@@ -1,6 +1,7 @@
-export interface ExportedCookie {
+export default interface ExportedCookie {
   domain: string;
   name: string;
   value: string;
+  expiry?: Date | "Infinity";
   meta?: any;
 }

package/src/FetchResponse.ts

@@ -1,3 +1,5 @@
+// noinspection JSUnusedGlobalSymbols
+
 import { Response } from "cross-fetch";
 
 export default interface FetchResponse extends Response {

package/src/IsCookieRow.ts

@@ -1,4 +1,4 @@
-import { CookieRow } from "./CookieRow";
+import CookieRow from "./CookieRow";
 
 export function isCookieRow(obj: any): obj is CookieRow {
   return (

package/src/IsExportedCookie.ts

@@ -1,4 +1,4 @@
-import { ExportedCookie } from "./ExportedCookie";
+import ExportedCookie from "./ExportedCookie";
 
 export function isExportedCookie(obj: any): obj is ExportedCookie {
   return (

package/src/SpecialCases.ts

@@ -1,4 +1,4 @@
-import { CookieSpec } from "./CookieSpec";
+import CookieSpec from "./CookieSpec";
 
 export function specialCases({ name, domain }: CookieSpec): {
   specifiedName: boolean;

package/src/StringToRegex.ts

@@ -0,0 +1,6 @@
+export function stringToRegex(s: string): RegExp {
+  const s1 = s.replaceAll(/\./gi, ".");
+  const s2 = s1.replace(/%/g, ".*");
+  const s3 = s2.replace(/\*/g, ".*");
+  return new RegExp(s3);
+}

package/src/argv.ts

@@ -1 +1,5 @@
+import minimist from "minimist";
+
 export const argv: string[] = process.argv ?? [];
+
+export const parsedArgs: minimist.ParsedArgs = minimist(argv.slice(2));

package/src/browsers/ChromeCookieQueryStrategy.ts

@@ -9,10 +9,17 @@ import { doSqliteQuery1 } from "../doSqliteQuery1";
 import { merge } from "lodash";
 import { isCookieRow } from "../IsCookieRow";
 import { isExportedCookie } from "../IsExportedCookie";
-import { CookieRow } from "../CookieRow";
-import { ExportedCookie } from "../ExportedCookie";
+import CookieRow from "../CookieRow";
+import ExportedCookie from "../ExportedCookie";
+import { stringToRegex } from "../StringToRegex";
+import { parsedArgs } from "../argv";
+import fs from "fs";
+import * as sqlite3 from "sqlite3";
+import { DoSqliteQuery1Params } from "../doSqliteQuery1Params";
 
 export default class ChromeCookieQueryStrategy implements CookieQueryStrategy {
+  browserName = "Chrome";
+
   async queryCookies(name: string, domain: string): Promise<ExportedCookie[]> {
     if (process.platform !== "darwin") {
       throw new Error("This only works on macOS");
@@ -40,7 +47,7 @@ async function getPromise1(
       file: file,
     });
   } catch (e) {
-    if (env.VERBOSE) {
+    if (parsedArgs.verbose) {
       console.log("Error getting encrypted cookie", e);
     }
     return [];
@@ -56,10 +63,10 @@ async function getPromise(name: string, domain: string): Promise<CookieRow[]> {
     const promises: Promise<CookieRow[]>[] = files.map((file) =>
       getPromise1(name, domain, file)
     );
-    const results1: Awaited<CookieRow[]>[] = await Promise.all(promises);
+    const results1: CookieRow[][] = await Promise.all(promises);
     return results1.flat().filter(isCookieRow);
   } catch (error) {
-    if (env.VERBOSE) {
+    if (parsedArgs.verbose) {
       console.log("error", error);
     }
     return [];
@@ -71,7 +78,7 @@ async function decryptValue(password: string, encryptedValue: Buffer) {
   try {
     d = await decrypt(password, encryptedValue);
   } catch (e) {
-    if (env.VERBOSE) {
+    if (parsedArgs.verbose) {
       console.log("Error decrypting cookie", e);
     }
     d = null;
@@ -99,17 +106,24 @@ Promise<ExportedCookie[]> {
       const decryptedValue = await decryptValue(password, encryptedValue);
       const meta = {};
       merge(meta, cookieRow.meta ?? {});
-      return {
+      const exportedCookie: ExportedCookie = {
         domain: cookieRow.domain,
         name: cookieRow.name,
         value: decryptedValue,
         meta: meta,
       };
+      const expiry = cookieRow.expiry;
+      if (expiry) {
+        merge(exportedCookie, {
+          expiry: new Date(expiry),
+        });
+      }
+      return exportedCookie;
     });
   const results: ExportedCookie[] = (await Promise.all(decrypted)).filter(
     isExportedCookie
   );
-  if (env.VERBOSE) {
+  if (parsedArgs.verbose) {
     console.log("results", results);
   }
   return results;
@@ -136,39 +150,54 @@ async function getEncryptedChromeCookie({
   if (!existsSync(file)) {
     throw new Error(`File ${file} does not exist`);
   }
-  if (env.VERBOSE) {
+  if (parsedArgs.verbose) {
     const s = file.split("/").slice(-3).join("/");
     console.log(`Trying Chrome (at ${s}) cookie ${name} for domain ${domain}`);
   }
   let sql;
   //language=SQL
-  sql = "SELECT encrypted_value, name, host_key FROM cookies";
+  sql = "SELECT * FROM cookies";
+  // sql = "SELECT encrypted_value, name, host_key FROM cookies";
+
   const wildcardRegexp = /^([*%])$/i;
   const specifiedName = name.match(wildcardRegexp) == null;
   const specifiedDomain = domain.match(wildcardRegexp) == null;
-  if (specifiedName || specifiedDomain) {
+  const wildcardDomain = domain.match(/[%*]/) != null;
+  const queryDomain = specifiedDomain && !wildcardDomain;
+  // if we have a wildcard domain, we need to use a regexp
+  if (specifiedName || queryDomain) {
     sql += ` WHERE `;
     if (specifiedName) {
       sql += `name = '${name}'`;
-      if (specifiedDomain) {
+      if (queryDomain) {
         sql += ` AND `;
       }
     }
-    if (specifiedDomain) {
-      sql += `host_key LIKE '${domain}';`;
+    if (queryDomain) {
+      // leading dot replaced with % to match subdomains
+      const sqlEmbedDomain = domain.replace(/^[.%]?/, "%");
+      sql += `host_key LIKE '${sqlEmbedDomain}';`;
     }
   }
-  return doSqliteQuery1({
+  const sqliteQuery1: CookieRow[] = await doChromeSqliteQuery1({
     file: file,
     sql: sql,
     rowTransform: (row) => {
-      return {
+      const cookieRow = {
+        expiry: (row["expires_utc"] / 1000000 - 11644473600) * 1000,
         domain: row["host_key"],
         name: row["name"],
         value: row["encrypted_value"],
       };
+      if (parsedArgs.verbose) {
+        console.log("CookieRow", cookieRow);
+      }
+      return cookieRow;
     },
   });
+  return sqliteQuery1.filter((row) => {
+    return row.domain.match(stringToRegex(domain)) != null;
+  });
 }
 
 async function getChromePassword(): Promise<string> {
@@ -192,7 +221,7 @@ async function decrypt(
   if (!(encryptedData1 instanceof Buffer)) {
     if (Array.isArray(encryptedData1) && encryptedData1[0] instanceof Buffer) {
       [encryptedData1] = encryptedData1;
-      if (env.VERBOSE) {
+      if (parsedArgs.verbose) {
         console.log(
           `encryptedData is an array of buffers, selected first: ${encryptedData1}`
         );
@@ -202,14 +231,14 @@ async function decrypt(
     }
     encryptedData1 = Buffer.from(encryptedData1);
   }
-  if (env.VERBOSE) {
+  if (parsedArgs.verbose) {
     console.log(`Trying to decrypt with password ${password}`);
   }
   return new Promise((resolve, reject) => {
     crypto.pbkdf2(password, "saltysalt", 1003, 16, "sha1", (error, buffer) => {
       try {
         if (error) {
-          if (env.VERBOSE) {
+          if (parsedArgs.verbose) {
             console.log("Error doing pbkdf2", error);
           }
           reject(error);
@@ -217,7 +246,7 @@ async function decrypt(
         }
 
         if (buffer.length !== 16) {
-          if (env.VERBOSE) {
+          if (parsedArgs.verbose) {
             console.log(
               "Error doing pbkdf2, buffer length is not 16",
               buffer.length
@@ -237,7 +266,7 @@ async function decrypt(
         }
 
         if (encryptedData1.length % 16 !== 0) {
-          if (env.VERBOSE) {
+          if (parsedArgs.verbose) {
             console.log(
               "Error doing pbkdf2, encryptedData length is not a multiple of 16",
               encryptedData1.length
@@ -251,7 +280,7 @@ async function decrypt(
         try {
           decipher.final("utf-8");
         } catch (e) {
-          if (env.VERBOSE) {
+          if (parsedArgs.verbose) {
             console.log("Error doing decipher.final()", e);
           }
           reject(e);
@@ -271,3 +300,44 @@ async function decrypt(
     });
   });
 }
+
+export async function doChromeSqliteQuery1({
+  file,
+  sql,
+  rowTransform,
+}: DoSqliteQuery1Params): Promise<CookieRow[]> {
+  if (!file || (file && !fs.existsSync(file))) {
+    throw new Error(`doSqliteQuery1: file ${file} does not exist`);
+  }
+  const db = new sqlite3.Database(file);
+  return new Promise((resolve, reject) => {
+    db.all(sql, (err: Error, rows: any[]) => {
+      if (err) {
+        reject(err);
+        return;
+      }
+      const rows1: any[] = rows;
+      if (rows1 == null || rows1.length === 0) {
+        resolve([]);
+        return;
+      }
+      if (Array.isArray(rows1)) {
+        const cookieRows: CookieRow[] = rows1.map((row: any) => {
+          const newVar = {
+            meta: {
+              file: file,
+            },
+          };
+          const cookieRow: CookieRow = rowTransform(row);
+          return merge(newVar, cookieRow);
+        });
+        resolve(cookieRows);
+        return;
+      }
+      if (parsedArgs.verbose) {
+        console.log(`doSqliteQuery1: rows ${JSON.stringify(rows1)}`);
+      }
+      resolve([rows1]);
+    });
+  });
+}

package/src/browsers/CompositeCookieQueryStrategy.ts

@@ -2,8 +2,12 @@ import ChromeCookieQueryStrategy from "./ChromeCookieQueryStrategy";
 import FirefoxCookieQueryStrategy from "./FirefoxCookieQueryStrategy";
 import SafariCookieQueryStrategy from "./SafariCookieQueryStrategy";
 import CookieQueryStrategy from "./CookieQueryStrategy";
-import { ExportedCookie } from "../ExportedCookie";
+import ExportedCookie from "../ExportedCookie";
 import LRUCache from "lru-cache";
+import CookieStoreQueryStrategy from "./CookieStoreQueryStrategy";
+import { red } from "colorette";
+import { merge } from "lodash";
+import { parsedArgs } from "../argv";
 
 const cache = new LRUCache<string, ExportedCookie[]>({
   ttl: 1000 * 2,
@@ -13,10 +17,13 @@ const cache = new LRUCache<string, ExportedCookie[]>({
 export default class CompositeCookieQueryStrategy
   implements CookieQueryStrategy
 {
+  browserName = "all";
+
   #strategies;
 
   constructor() {
     this.#strategies = [
+      CookieStoreQueryStrategy,
       ChromeCookieQueryStrategy,
       FirefoxCookieQueryStrategy,
       SafariCookieQueryStrategy,
@@ -26,19 +33,36 @@ export default class CompositeCookieQueryStrategy
   }
 
   async queryCookies(name: string, domain: string): Promise<ExportedCookie[]> {
+    // domain = domain.match(/(\w+.+\w+)/gi)?.pop() ?? domain;
     const key = `${name}:${domain}`;
     const cached = cache.get(key);
     if (cached) {
       return cached;
     }
-    const results = await Promise.all(
-      this.#strategies.map(async (strategy) => {
+    if (parsedArgs.verbose) {
+      console.log("Querying cookies:", name, domain);
+    }
+    const results: ExportedCookie[][] = await Promise.all(
+      this.#strategies.map(async (strategy: CookieQueryStrategy) => {
         // @ts-ignore
-        const cookies: Promise<ExportedCookie[]> = strategy.queryCookies(
-          name,
-          domain
-        );
-        return cookies.catch(() => []);
+        return strategy
+          .queryCookies(name, domain)
+          .then((cookies: ExportedCookie[]) => {
+            return cookies.map((cookie: ExportedCookie) => {
+              return merge(cookie, {
+                meta: {
+                  browser: strategy.browserName,
+                },
+              });
+            });
+          })
+          .catch((e) => {
+            console.log(
+              red(`Error querying ${strategy.browserName} cookies`),
+              e
+            );
+            return [];
+          });
       })
     );
     const flat: ExportedCookie[] = results.flat();

package/src/browsers/CookieQueryStrategy.ts

@@ -1,5 +1,6 @@
-import { ExportedCookie } from "../ExportedCookie";
+import ExportedCookie from "../ExportedCookie";
 
 export default interface CookieQueryStrategy {
+  browserName: string;
   queryCookies(name: string, domain: string): Promise<ExportedCookie[]>;
 }

package/src/browsers/CookieStoreQueryStrategy.ts

@@ -0,0 +1,94 @@
+import CookieQueryStrategy from "./CookieQueryStrategy";
+import CookieSpec from "../CookieSpec";
+import ExportedCookie from "../ExportedCookie";
+import { Cookie } from "tough-cookie";
+import { cookieStore, cookieJar } from "../CookieStore";
+import { stringToRegex } from "../StringToRegex";
+
+export default class CookieStoreQueryStrategy implements CookieQueryStrategy {
+  browserName = "internal";
+
+  async queryCookies(name: string, domain: string): Promise<ExportedCookie[]> {
+    const exportedCookies: ExportedCookie[] = [];
+
+    // if (name.match(/[%*]/) || domain.match(/[%*]/)) {
+    const cookies: Cookie[] = await this.#getAllCookies();
+    const allExportedCookies = cookies.map((cookie: Cookie) => {
+      return this.#extracted(cookie, { name, domain });
+    });
+    exportedCookies.push(...allExportedCookies);
+    // }
+
+    const wildcardRegexp = /^([*%])$/i;
+    if (name.match(wildcardRegexp) && domain.match(wildcardRegexp)) {
+      return exportedCookies;
+    }
+
+    const path = "/";
+
+    if (domain != "%") {
+      const domain1 = domain.match(/(\w+.+\w+)/gi)?.pop() ?? domain;
+      const url = new URL("https://" + domain1);
+      url.pathname = path;
+      const cookies: Cookie[] = await this.#getCookies(url.href);
+      const domainCookies = cookies.map((cookie: Cookie) => {
+        return this.#extracted(cookie, {
+          domain,
+          name,
+        });
+      });
+      exportedCookies.push(...domainCookies);
+    }
+
+    if (name == "%") {
+      return exportedCookies.filter((cookie: ExportedCookie) => {
+        return cookie.domain.match(stringToRegex(domain));
+      });
+    }
+
+    return exportedCookies.filter((cookie: ExportedCookie) => {
+      return (
+        cookie.name.match(stringToRegex(name)) &&
+        cookie.domain.match(stringToRegex(domain))
+      );
+    });
+  }
+
+  #extracted(cookie: Cookie, cookieSpec: CookieSpec): ExportedCookie {
+    return {
+      domain: cookie.domain ?? cookieSpec.domain,
+      name: cookie.key ?? cookieSpec.name,
+      value: cookie.value,
+      expiry: cookie.expires ?? Infinity,
+      meta: {
+        file: "tough-cookie",
+      },
+    };
+  }
+
+  #getCookies(url: string): Promise<Cookie[]> {
+    return new Promise((resolve, reject) => {
+      // @ts-ignore
+      return cookieJar.getCookies(url, (err, cookies) => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve(cookies ?? []);
+        }
+      });
+    });
+  }
+
+  #getAllCookies(): Promise<Cookie[]> {
+    return new Promise((resolve, reject) => {
+      // @ts-ignore
+      return cookieStore.getAllCookies((err, cookies) => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve(cookies ?? []);
+        }
+      });
+    });
+  }
+}

package/src/browsers/FirefoxCookieQueryStrategy.ts

@@ -4,12 +4,14 @@ import { env, HOME } from "../global";
 import { existsSync } from "fs";
 import { findAllFiles } from "../findAllFiles";
 import { doSqliteQuery1 } from "../doSqliteQuery1";
-import { ExportedCookie } from "../ExportedCookie";
-import { CookieRow } from "../CookieRow";
-import { CookieSpec } from "../CookieSpec";
+import ExportedCookie from "../ExportedCookie";
+import CookieRow from "../CookieRow";
+import CookieSpec from "../CookieSpec";
 import { specialCases } from "../SpecialCases";
 
 export default class FirefoxCookieQueryStrategy implements CookieQueryStrategy {
+  browserName = "Firefox";
+
   async queryCookies(name: string, domain: string): Promise<ExportedCookie[]> {
     if (process.platform !== "darwin") {
       throw new Error("This only works on macOS");

package/src/browsers/SafariCookieQueryStrategy.ts

@@ -1,7 +1,9 @@
 import CookieQueryStrategy from "./CookieQueryStrategy";
-import { ExportedCookie } from "../ExportedCookie";
+import ExportedCookie from "../ExportedCookie";
 
 export default class SafariCookieQueryStrategy implements CookieQueryStrategy {
+  browserName = "Safari";
+
   async queryCookies(name: string, domain: string): Promise<ExportedCookie[]> {
     return [];
   }