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.

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

Add support for PFX or PKCS12 encoded certificates #708

Merged
merged 5 commits into from Jul 19, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions source/utilities/cli.ts
Expand Up @@ -83,8 +83,10 @@ const helpText = chalk`
-S, --symlinks Resolve symlinks instead of showing 404 errors

--ssl-cert Optional path to an SSL/TLS certificate to serve with HTTPS
{grey Supported formats: PEM (default) and PKCS12 (PFX)}

--ssl-key Optional path to the SSL/TLS certificate\'s private key
{grey Applicable only for PEM certificates}

--ssl-pass Optional path to the SSL/TLS certificate\'s passphrase

Expand Down
43 changes: 27 additions & 16 deletions source/utilities/server.ts
Expand Up @@ -62,21 +62,31 @@ export const startServer = async (
};

// Create the server.
const useSsl = args['--ssl-cert'] && args['--ssl-key'];
const httpMode = useSsl ? 'https' : 'http';
const sslCert = args['--ssl-cert'];
const sslKey = args['--ssl-key'];
const sslPass = args['--ssl-pass'];
const serverConfig =
httpMode === 'https' && args['--ssl-cert'] && args['--ssl-key']
? {
key: await readFile(args['--ssl-key']),
cert: await readFile(args['--ssl-cert']),
passphrase: sslPass ? await readFile(sslPass, 'utf8') : '',
}
: {};
const server =
httpMode === 'https'
? https.createServer(serverConfig, serverHandler)
: http.createServer(serverHandler);
const isPFXFormat = sslCert && /[.](?<extension>pfx|p12)$/.exec(sslCert);
const useSsl = sslCert && (sslKey || sslPass || isPFXFormat);

let serverConfig: http.ServerOptions | https.ServerOptions = {};
if (useSsl && sslCert && sslKey) {
// Format detected is PEM due to usage of SSL Key and Optional Passphrase.
serverConfig = {
key: await readFile(sslKey),
cert: await readFile(sslCert),
passphrase: sslPass ? await readFile(sslPass, 'utf8') : '',
};
} else if (useSsl && sslCert && isPFXFormat) {
// Format detected is PFX.
serverConfig = {
pfx: await readFile(sslCert),
passphrase: sslPass ? await readFile(sslPass, 'utf8') : '',
};
}

const server = useSsl
? https.createServer(serverConfig, serverHandler)
: http.createServer(serverHandler);

// Once the server starts, return the address it is running on so the CLI
// can tell the user.
Expand All @@ -101,8 +111,9 @@ export const startServer = async (
else address = details.address;
const ip = getNetworkAddress();

local = `${httpMode}://${address}:${details.port}`;
network = ip ? `${httpMode}://${ip}:${details.port}` : undefined;
const protocol = useSsl ? 'https' : 'http';
local = `${protocol}://${address}:${details.port}`;
network = ip ? `${protocol}://${ip}:${details.port}` : undefined;
}

return {
Expand Down