Added cookie support to CLI requests

This commit is contained in:
Matthew Dickinson 2024-10-18 17:46:51 -04:00
parent ac67c4c0d8
commit b82a2c3312
4 changed files with 124 additions and 0 deletions

View File

@ -41,6 +41,7 @@
"lodash": "^4.17.21", "lodash": "^4.17.21",
"qs": "^6.11.0", "qs": "^6.11.0",
"socks-proxy-agent": "^8.0.2", "socks-proxy-agent": "^8.0.2",
"tough-cookie": "^4.1.3",
"@usebruno/vm2": "^3.9.13", "@usebruno/vm2": "^3.9.13",
"xmlbuilder": "^15.1.1", "xmlbuilder": "^15.1.1",
"yargs": "^17.6.2" "yargs": "^17.6.2"

View File

@ -211,6 +211,11 @@ const builder = async (yargs) => {
description: description:
'The specified custom CA certificate (--cacert) will be used exclusively and the default truststore is ignored, if this option is specified. Evaluated in combination with "--cacert" only.' 'The specified custom CA certificate (--cacert) will be used exclusively and the default truststore is ignored, if this option is specified. Evaluated in combination with "--cacert" only.'
}) })
.option('use-cookies', {
type: 'boolean',
default: false,
description: 'Automatically save and sent cookies with requests'
})
.option('env', { .option('env', {
describe: 'Environment variables', describe: 'Environment variables',
type: 'string' type: 'string'
@ -301,6 +306,7 @@ const handler = async function (argv) {
filename, filename,
cacert, cacert,
ignoreTruststore, ignoreTruststore,
useCookies,
env, env,
envVar, envVar,
insecure, insecure,
@ -392,6 +398,9 @@ const handler = async function (argv) {
if (insecure) { if (insecure) {
options['insecure'] = true; options['insecure'] = true;
} }
if (useCookies) {
options['useCookies'] = true;
}
if (cacert && cacert.length) { if (cacert && cacert.length) {
if (insecure) { if (insecure) {
console.error(chalk.red(`Ignoring the cacert option since insecure connections are enabled`)); console.error(chalk.red(`Ignoring the cacert option since insecure connections are enabled`));

View File

@ -20,6 +20,7 @@ const { addAwsV4Interceptor, resolveAwsV4Credentials } = require('./awsv4auth-he
const { shouldUseProxy, PatchedHttpsProxyAgent } = require('../utils/proxy-util'); const { shouldUseProxy, PatchedHttpsProxyAgent } = require('../utils/proxy-util');
const path = require('path'); const path = require('path');
const { createFormData } = require('../utils/common'); const { createFormData } = require('../utils/common');
const { getCookieStringForUrl, saveCookies, shouldUseCookies } = require('../utils/cookies');
const protocolRegex = /^([-+\w]{1,25})(:?\/\/|:)/; const protocolRegex = /^([-+\w]{1,25})(:?\/\/|:)/;
const onConsoleLog = (type, args) => { const onConsoleLog = (type, args) => {
@ -178,6 +179,14 @@ const runSingleRequest = async function (
}); });
} }
//set cookies if enabled
if (options.useCookies) {
const cookieString = getCookieStringForUrl(request.url);
if (cookieString && typeof cookieString === 'string' && cookieString.length) {
request.headers['cookie'] = cookieString;
}
}
// stringify the request url encoded params // stringify the request url encoded params
if (request.headers['content-type'] === 'application/x-www-form-urlencoded') { if (request.headers['content-type'] === 'application/x-www-form-urlencoded') {
request.data = qs.stringify(request.data); request.data = qs.stringify(request.data);
@ -220,6 +229,11 @@ const runSingleRequest = async function (
// Prevents the duration on leaking to the actual result // Prevents the duration on leaking to the actual result
responseTime = response.headers.get('request-duration'); responseTime = response.headers.get('request-duration');
response.headers.delete('request-duration'); response.headers.delete('request-duration');
//save cookies if enabled
if (options.useCookies) {
saveCookies(request.url, response.headers);
}
} catch (err) { } catch (err) {
if (err?.response) { if (err?.response) {
response = err.response; response = err.response;

View File

@ -0,0 +1,100 @@
const { Cookie, CookieJar } = require('tough-cookie');
const each = require('lodash/each');
const cookieJar = new CookieJar();
const addCookieToJar = (setCookieHeader, requestUrl) => {
const cookie = Cookie.parse(setCookieHeader, { loose: true });
cookieJar.setCookieSync(cookie, requestUrl, {
ignoreError: true // silently ignore things like parse errors and invalid domains
});
};
const getCookiesForUrl = (url) => {
return cookieJar.getCookiesSync(url);
};
const getCookieStringForUrl = (url) => {
const cookies = getCookiesForUrl(url);
if (!Array.isArray(cookies) || !cookies.length) {
return '';
}
const validCookies = cookies.filter((cookie) => !cookie.expires || cookie.expires > Date.now());
return validCookies.map((cookie) => cookie.cookieString()).join('; ');
};
const getDomainsWithCookies = () => {
return new Promise((resolve, reject) => {
const domainCookieMap = {};
cookieJar.store.getAllCookies((err, cookies) => {
if (err) {
return reject(err);
}
cookies.forEach((cookie) => {
if (!domainCookieMap[cookie.domain]) {
domainCookieMap[cookie.domain] = [cookie];
} else {
domainCookieMap[cookie.domain].push(cookie);
}
});
const domains = Object.keys(domainCookieMap);
const domainsWithCookies = [];
each(domains, (domain) => {
const cookies = domainCookieMap[domain];
const validCookies = cookies.filter((cookie) => !cookie.expires || cookie.expires > Date.now());
if (validCookies.length) {
domainsWithCookies.push({
domain,
cookies: validCookies,
cookieString: validCookies.map((cookie) => cookie.cookieString()).join('; ')
});
}
});
resolve(domainsWithCookies);
});
});
};
const deleteCookiesForDomain = (domain) => {
return new Promise((resolve, reject) => {
cookieJar.store.removeCookies(domain, null, (err) => {
if (err) {
return reject(err);
}
return resolve();
});
});
};
const saveCookies = (url, headers) => {
let setCookieHeaders = [];
if (headers['set-cookie']) {
setCookieHeaders = Array.isArray(headers['set-cookie'])
? headers['set-cookie']
: [headers['set-cookie']];
for (let setCookieHeader of setCookieHeaders) {
if (typeof setCookieHeader === 'string' && setCookieHeader.length) {
addCookieToJar(setCookieHeader, url);
}
}
}
}
module.exports = {
addCookieToJar,
getCookiesForUrl,
getCookieStringForUrl,
getDomainsWithCookies,
deleteCookiesForDomain,
saveCookies
};