Add pfx HTTPS option

[markdboyd]

Fixes #1306

Adds support for the pfx option from TLS SecureContextOptions to the HTTPSOptions accepted by got.

I tried to follow the existing convention of passphrase where options.pfx and options.https.pfx are both allowed, but using options.pfx prints a deprecation warning.

I also added a basic test of the deprecation warning. I removed this test because it was failing since I wasn't providing a real PFX fixture. It also wasn't a very meaningful test.

I wasn't sure what other tests to add but I'm happy to add any that are requested.

Checklist

• I have read the documentation.
• I have included a pull request description of my changes.
• I have included some tests.
• If it's a new feature, I have included documentation updates.

[markdboyd]

@sindresorhus Thanks for the feedback! I think this is ready for re-review

[szmarczak]

This needs tests: https://github.com/sindresorhus/got/blob/master/test/https.ts

Here's Node.js tutorial on how to generate pfx: https://nodejs.org/api/tls.html#tls_tls_ssl_concepts

[sindresorhus]

@markdboyd Friendly bump :)

[markdboyd]

Yeah, sorry. I had started to work on adding the requested test, but I was having trouble creating a working PFX fixture using the instructions that @szmarczak linked. I can take another crack at it though

[szmarczak]

I'll try to do this tomorrow

[Giotino]

This PR is missing the "HTTPS options restore" after the request (which has been recently added).

In case of retry a DeprecationWarning is emitted, in order to prevent this you need to add pfx to this section

got/source/core/index.ts

Lines 2391 to 2417 in 38bbb04

	// HTTPS options restore
	if (options.https) {
	if ('rejectUnauthorized' in options.https) {
	delete requestOptions.rejectUnauthorized;
	}
	if (options.https.checkServerIdentity) {
	// @ts-expect-error - This one will be removed when we remove the alias.
	delete requestOptions.checkServerIdentity;
	}
	if (options.https.certificateAuthority) {
	delete requestOptions.ca;
	}
	if (options.https.certificate) {
	delete requestOptions.cert;
	}
	if (options.https.key) {
	delete requestOptions.key;
	}
	if (options.https.passphrase) {
	delete requestOptions.passphrase;
	}
	}

Related issue: #1389
Related PR: #1391

[Giotino]

Yeah, sorry. I had started to work on adding the requested test, but I was having trouble creating a working PFX fixture using the instructions that @szmarczak linked. I can take another crack at it though

@markdboyd I've set-up in the "HTTPS Tests" PR a test for the PFX option.
13fcbdc (#1430)

Currently it uses the "hidden pfx option" which is deprecated.

[markdboyd]

Thanks @Giotino and @szmarczak !