@andrewheberle/serverless-ssh-ca 0.22.0 → 0.23.0

package/src/utils.ts

@@ -1,7 +1,7 @@
 import type { SshCaBindings } from "./types.js"
 import { JWKInvalid, JWKSInvalid, JWSInvalid, JWSSignatureVerificationFailed, JWTClaimValidationFailed, JWTExpired, JWTInvalid } from "jose/errors"
-import sshpk from "sshpk"
-import type { Certificate, Key, PrivateKey } from "sshpk"
+import { CertificateParseError, SshCertificate } from "./ssh/certificate.js"
+import { KeyParseError, parsePrivateKey, PublicKey, UnsupportedKeyError, type PrivateKey } from "./ssh/keys.js"
 import z from "zod"
 import { verifyJWT } from "./verify.js"
 import { CertificateRequestJWTPayload } from "./types.js"
@@ -11,8 +11,7 @@ import { logger } from "./logger.js"
 import { ms } from "itty-time"
 import { InternalServerErrorException } from "chanfana"
 
-// sshpk is CommonJS and Node's ESM loader cannot detect most of its named exports, so values are taken from the default import
-const { KeyParseError, CertificateParseError, parseCertificate, parseKey, parsePrivateKey } = sshpk
+export { UnsupportedKeyError }
 
 export const fatalIssue = (ctx: z.RefinementCtx, message: string, val: unknown) => {
 	ctx.issues.push({
@@ -104,11 +103,20 @@ export const transformAuthorizationHeader = async (env: SshCaBindings, val: stri
 	}
 }
 
-export const transformPublicKey = (val: string | Buffer<ArrayBufferLike>, ctx: z.RefinementCtx): Key | never => {
-	try {
-		const key = typeof val === "string" ? parseKey(Buffer.from(val, "base64")) : parseKey(val)
+// decodes a value sent as base64, which may already have been decoded by the schema
+const fromBase64 = (val: string | Buffer<ArrayBufferLike>): string => {
+	return (typeof val === "string" ? Buffer.from(val, "base64") : Buffer.from(val)).toString("utf8")
+}
 
-		return key
+/**
+ * Parses a public key in OpenSSH format, `${type} ${base64}[ ${comment}]`
+ *
+ * @param val The public key, either base64 encoded or as bytes
+ * @param ctx The Zod context for any errors
+ */
+export const transformPublicKey = (val: string | Buffer<ArrayBufferLike>, ctx: z.RefinementCtx): PublicKey | never => {
+	try {
+		return PublicKey.parse(fromBase64(val))
 	} catch (err) {
 		switch (true) {
 			case (err instanceof TypeError):
@@ -234,11 +242,9 @@ export const transformIdentityToken = async (env: SshCaBindings, val: string, ct
  * @param ctx The Zod context for any errors
  * @returns
  */
-export const transformCertificate = (val: string | Buffer<ArrayBufferLike>, ctx: z.RefinementCtx): Certificate | never => {
+export const transformCertificate = (val: string | Buffer<ArrayBufferLike>, ctx: z.RefinementCtx): SshCertificate | never => {
 	try {
-		const cert = typeof val === "string" ? parseCertificate(Buffer.from(val, "base64"), "openssh") : parseCertificate(val, "openssh")
-
-		return cert
+		return SshCertificate.parse(fromBase64(val))
 	} catch (err) {
 		switch (true) {
 			case (err instanceof TypeError):
@@ -269,7 +275,7 @@ export const transformCertificate = (val: string | Buffer<ArrayBufferLike>, ctx:
 
 type ParsedCertificateRequest = {
 	proof: ProofOfPossession
-	public_key: Key
+	public_key: PublicKey
 	lifetime: number
 	identity: IdentityToken
 	extensions: string[]
@@ -311,7 +317,7 @@ export const transformRenewalProofOfPossession = (env: SshCaBindings, val: strin
 }
 
 type HostCertificateRequest = {
-	public_key: Key
+	public_key: PublicKey
 	lifetime: number
 }
 
@@ -327,7 +333,7 @@ export const refineHostCertificateRequest = async (env: SshCaBindings, val: Pars
 
 	try {
 		// check proof of possession fingerprint matches public key
-		l.debug("checking val.proof.matches()", "public_key", val.public_key.toString("ssh"))
+		l.debug("checking val.proof.matches()", "public_key", val.public_key.toString())
 		if (!val.proof.matches(val.public_key)) {
 			l.warn("proof of possession fingerprint did not match public_key")
 			return fatalIssue(ctx, "proof of possession fingerprint did not match public_key", val)
@@ -351,38 +357,86 @@ export const refineHostCertificateRequest = async (env: SshCaBindings, val: Pars
 }
 
 type ParsedHostCertificateRenewal = {
-	certificate: Certificate
+	certificate: SshCertificate
 	proof: RenewalProofOfPossession
 } & HostCertificateRequest
 
-export const refineHostCertificateRenewal = async (env: SshCaBindings, isRevoked: typeof IsRevokedFn, val: ParsedHostCertificateRenewal, ctx: z.RefinementCtx): Promise<never> => {
+/**
+ * Checks a certificate presented for renewal was issued by this CA, is a host
+ * certificate, is within its validity period and has not been revoked.
+ *
+ * @param env The CA bindings
+ * @param isRevoked Returns whether a serial has been revoked
+ * @param certificate The certificate presented for renewal
+ * @returns The reason the certificate cannot be renewed, or undefined if it can be
+ * @throws {@link UnsupportedKeyError} when the CA key is not supported
+ */
+export const checkRenewableCertificate = async (env: SshCaBindings, isRevoked: typeof IsRevokedFn, certificate: SshCertificate): Promise<string | undefined> => {
+	// ensure certificate is signed by CA
+	const issuer = await getPublic(env)
+	if (!await certificate.isSignedBy(issuer)) {
+		return "the provided certificate was not signed by this CA"
+	}
+
+	// only host certificates can be renewed, as renewal does not need the
+	// OIDC authentication a user certificate is issued with
+	if (certificate.kind !== "host") {
+		return "the provided certificate is not a host certificate"
+	}
+
+	// check certificate is within its validity period, allowing for clock
+	// skew at the start as a certificate issued moments ago may have a
+	// validity start up to a second in the future
+	const now = Date.now()
+	if (now >= certificate.validBefore.getTime()) {
+		return "the provided certificate is expired"
+	}
+	if (certificate.validAfter.getTime() > now + ms(env.CERTIFICATE_REQUEST_TIME_SKEW_MAX)) {
+		return "the provided certificate is not yet valid"
+	}
+
+	// ensure certificate presented for renewal is not revoked
+	if (await isRevoked(env, certificate.serial)) {
+		return "the provided certificate is revoked"
+	}
+
+	return undefined
+}
+
+/**
+ * Refines a host certificate renewal so only a certificate that can be
+ * renewed (see {@link checkRenewableCertificate}) is accepted.
+ */
+export const refineRenewableCertificate = async (env: SshCaBindings, isRevoked: typeof IsRevokedFn, val: { certificate: SshCertificate }, ctx: z.RefinementCtx): Promise<never> => {
 	const l = logger(env)
 	try {
-		// ensure certificate is signed by CA
-		const issuer = await getPublic(env)
-		if (!val.certificate.isSignedByKey(issuer)) {
-			return fatalIssue(ctx, "the provided certificate was not signed by this CA", val)
+		const reason = await checkRenewableCertificate(env, isRevoked, val.certificate)
+		if (reason !== undefined) {
+			return fatalIssue(ctx, reason, val)
 		}
 
-		// check certificate is within its validity period, allowing for clock
-		// skew at the start as a certificate issued moments ago may have a
-		// validity start up to a second in the future
-		const now = Date.now()
-		if (now >= val.certificate.validUntil.getTime()) {
-			return fatalIssue(ctx, "the provided certificate is expired", val)
-		}
-		if (val.certificate.validFrom.getTime() > now + ms(env.CERTIFICATE_REQUEST_TIME_SKEW_MAX)) {
-			return fatalIssue(ctx, "the provided certificate is not yet valid", val)
+		return z.NEVER
+	} catch (err) {
+		// a misconfigured CA key is a server error, not a validation failure
+		if (err instanceof UnsupportedKeyError) {
+			l.error(err.message, "in", "refineRenewableCertificate")
+			throw new InternalServerErrorException(err.message)
 		}
+		l.error("certificate renewal check unhandled error", "in", "refineRenewableCertificate", "error", err)
+		return fatalIssue(ctx, "certificate renewal check unhandled error", val)
+	}
+}
 
-		// ensure certificate presented for renewal is not revoked
-		const serial = val.certificate.serial.readBigUInt64BE(0)
-		if (await isRevoked(env, serial)) {
-			return fatalIssue(ctx, "the provided certificate is revoked", val)
+export const refineHostCertificateRenewal = async (env: SshCaBindings, isRevoked: typeof IsRevokedFn, val: ParsedHostCertificateRenewal, ctx: z.RefinementCtx): Promise<never> => {
+	const l = logger(env)
+	try {
+		const reason = await checkRenewableCertificate(env, isRevoked, val.certificate)
+		if (reason !== undefined) {
+			return fatalIssue(ctx, reason, val)
 		}
 
 		// check proof of possession fingerprint matches public key and certificate subject key
-		if (!val.proof.matches(val.public_key, val.certificate.subjectKey)) {
+		if (!val.proof.matches(val.public_key, val.certificate.publicKey)) {
 			return fatalIssue(ctx, "proof of possession fingerprints did not match public_key and/or certificate", val)
 		}
 
@@ -406,7 +460,7 @@ export const refineHostCertificateRenewal = async (env: SshCaBindings, isRevoked
 
 type ParsedRevokeCertificate = {
 	serial: bigint
-	public_key: Key
+	public_key: PublicKey
 	proof: ProofOfPossession
 }
 
@@ -441,53 +495,29 @@ export const split = (v?: string | string[]): string[] => {
 			: v
 }
 
-/**
- * Thrown by {@link getPrivateKey} when the CA private key is of a type that
- * cannot be used.
- */
-export class UnsupportedKeyError extends Error {
-	constructor(message: string) {
-		super(message)
-		this.name = "UnsupportedKeyError"
-
-		Object.setPrototypeOf(this, UnsupportedKeyError.prototype)
-	}
-}
-
 /**
  * Load and parse the CA private key from the `PRIVATE_KEY` secret.
  *
- * Only Ed25519 and ECDSA keys are supported. RSA keys are rejected because
- * sshpk signs RSA certificates with SHA-1 (`ssh-rsa`), which OpenSSH 8.2 and
- * later refuse by default, and because RSA keys in OpenSSH format are
- * converted with invalid CRT parameters that the Workers runtime rejects.
+ * Only Ed25519 and ECDSA keys are supported, as these are the key types that
+ * certificates and KRLs are signed with (see `createSigner` in `ssh/signer.ts`).
  *
- * @throws KeyParseError when the secret cannot be parsed.
+ * @throws {@link KeyParseError} when the secret cannot be parsed.
  * @throws {@link UnsupportedKeyError} when the key is not Ed25519 or ECDSA.
  */
 export const getPrivateKey = async (env: SshCaBindings): Promise<PrivateKey> => {
 	// grab private key from secret store
 	const secret = await env.PRIVATE_KEY.get()
 
-	// parse it
-	const key = parsePrivateKey(secret)
-
-	if (key.type !== "ed25519" && key.type !== "ecdsa") {
-		throw new UnsupportedKeyError(`CA key type ${key.type} is not supported, the CA key must be Ed25519 or ECDSA`)
-	}
-
-	return key
+	return parsePrivateKey(secret)
 }
 
-export const getPublic = async (env: SshCaBindings, key?: PrivateKey): Promise<Key> => {
+/**
+ * Returns the public key of the CA, with `ISSUER_DN` as its comment
+ */
+export const getPublic = async (env: SshCaBindings, key?: PrivateKey): Promise<PublicKey> => {
 	if (key === undefined) {
 		key = await getPrivateKey(env)
 	}
 
-	// convert to a public key and add comment
-	const pub = key.toPublic()
-	pub.comment = env.ISSUER_DN
-
-	// return in ssh format trimmed of any whitespace
-	return pub
+	return key.publicKey.withComment(env.ISSUER_DN)
 }