Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(sdk): client cert doesn't work in some cases when enabling pre-request script #8261

Draft
wants to merge 3 commits into
base: develop
Choose a base branch
from
Draft

fix(sdk): client cert doesn't work in some cases when enabling pre-request script #8261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cacd2fb
fix: doesn't expose the best cert in request interface
ihexxa Dec 20, 2024
a3461c2
fix: improve cert modification in script
ihexxa Dec 20, 2024
0437c63
fix: smoke test
ihexxa Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 15 additions & 13 deletions packages/insomnia-sdk/src/objects/insomnia.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,18 +167,18 @@ export async function initInsomniaObject(
localVars: localVariables,
});

const existClientCert = rawObj.clientCertificates != null && rawObj.clientCertificates.length > 0;
const certificate = existClientCert && rawObj.clientCertificates[0] ?
{
disabled: rawObj.clientCertificates[0].disabled,
name: 'The first certificate from Settings',
matches: [rawObj.clientCertificates[0].host],
key: { src: rawObj.clientCertificates[0].key || '' },
cert: { src: rawObj.clientCertificates[0].cert || '' },
passphrase: rawObj.clientCertificates[0].passphrase || undefined,
pfx: { src: rawObj.clientCertificates[0].pfx || '' }, // PFX or PKCS12 Certificate
} :
{ disabled: true };
// const existClientCert = rawObj.clientCertificates != null && rawObj.clientCertificates.length > 0;
// const certificate = existClientCert && rawObj.clientCertificates[0] ?
// {
// disabled: rawObj.clientCertificates[0].disabled,
// name: 'The first certificate from Settings',
// matches: [rawObj.clientCertificates[0].host],
// key: { src: rawObj.clientCertificates[0].key || '' },
// cert: { src: rawObj.clientCertificates[0].cert || '' },
// passphrase: rawObj.clientCertificates[0].passphrase || undefined,
// pfx: { src: rawObj.clientCertificates[0].pfx || '' }, // PFX or PKCS12 Certificate
// } :
// { disabled: true };

const proxy = transformToSdkProxyOptions(
rawObj.settings.httpProxy,
Expand All @@ -204,7 +204,9 @@ export async function initInsomniaObject(
body: toScriptRequestBody(rawObj.request.body),
auth: toPreRequestAuth(rawObj.request.authentication),
proxy,
certificate,
// the certificate is undefined
// as it is difficult to find the best cert before rendering
certificate: undefined,
pathParameters: rawObj.request.pathParameters,
};
const request = new ScriptRequest(reqOpt);
Expand Down
21 changes: 14 additions & 7 deletions packages/insomnia-sdk/src/objects/request.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,21 +511,26 @@ export function mergeClientCertificates(
};

if (updatedReq.certificate.pfx && updatedReq.certificate.pfx?.src !== '') {
return [{
const specifiedCert: ClientCertificate = {
...baseCertificate,
key: null,
cert: null,
name: updatedReq.certificate.name || '',
disabled: updatedReq.certificate.disabled || false,
passphrase: updatedReq.certificate.passphrase || null,
pfx: updatedReq.certificate.pfx?.src,
}];
host: '*',
};

return [specifiedCert, ...originalClientCertificates];
} else if (
updatedReq &&
updatedReq.certificate.key &&
updatedReq.certificate.cert &&
updatedReq.certificate.key?.src !== '' &&
updatedReq.certificate.cert?.src !== ''
) {
return [{
const specifiedCert: ClientCertificate = {
...baseCertificate,

_id: '',
Expand All @@ -534,15 +539,17 @@ export function mergeClientCertificates(
modified: 0,
created: 0,
isPrivate: false,
name: updatedReq.name || '',
host: updatedReq.url.getHost() || '',
disabled: updatedReq.disabled || false,
name: updatedReq.certificate.name || '',
disabled: updatedReq.certificate.disabled || false,
host: '*',

key: updatedReq.certificate.key?.src,
cert: updatedReq.certificate.cert?.src,
passphrase: updatedReq.certificate.passphrase || null,
pfx: null,
}];
};

return [specifiedCert, ...originalClientCertificates];
}

throw Error('Invalid certificate configuration: "cert+key" and "pfx" can not be set at the same time');
Expand Down
19 changes: 10 additions & 9 deletions packages/insomnia-smoke-test/fixtures/pre-request-collection.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,18 +288,19 @@ resources:
settingRebuildPath: true
settingFollowRedirects: global
preRequestScript: |-
const { Certificate } = require('insomnia-collection');
// print the original one
console.log('key:', insomnia.request.certificate.key.src);
console.log('cert:', insomnia.request.certificate.cert.src);
console.log('passphrass:', insomnia.request.certificate.passphrass);
console.log('pfx:', insomnia.request.certificate.pfx.src);
// console.log('key:', insomnia.request.certificate.key.src);
// console.log('cert:', insomnia.request.certificate.cert.src);
// console.log('passphrass:', insomnia.request.certificate.passphrass);
// console.log('pfx:', insomnia.request.certificate.pfx.src);
// update
insomnia.request.certificate.update({
disabled: true,
key: {src: 'invalid.key'},
cert: {src: 'invalid.cert'},
insomnia.request.certificate = new Certificate({
disabled: false,
key: {src: ''},
cert: {src: ''},
passphrase: '',
pfx: {src: ''},
pfx: {src: 'fake.pfx'},
});
_type: request
- _id: req_89dade2ee9ee42fbb22d588783a9df3e
Expand Down
2 changes: 1 addition & 1 deletion packages/insomnia-smoke-test/tests/smoke/pre-request-script-features.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ test.describe('pre-request features tests', async () => {
await page.getByTestId('request-pane').getByRole('button', { name: 'Send' }).click();
// verify
await page.getByRole('tab', { name: 'Console' }).click();
await expect(responsePane).toContainText('fixtures/certificates/fake.pfx'); // original proxy
await expect(responsePane).toContainText('Adding SSL P12 certificate');
});

test('pre: insomnia.test and insomnia.expect can work together', async ({ page }) => {
Expand Down
Loading