@andrewheberle/serverless-ssh-ca 0.17.13 → 0.17.15

package/src/utils.ts

@@ -0,0 +1,414 @@
+import type { SshCaBindings } from "./types"
+import { JWKInvalid, JWKSInvalid, JWSInvalid, JWTClaimValidationFailed, JWTInvalid } from "jose/errors"
+import { Certificate, Key, KeyParseError, CertificateParseError, parseCertificate, parseKey, parsePrivateKey, PrivateKey } from "sshpk"
+import z from "zod"
+import { verifyJWT } from "./verify"
+import { CertificateRequestJWTPayload } from "./types"
+import { RenewalProofOfPossession, ProofOfPossession, PossessionParseError } from "./proof"
+import type { isRevoked as IsRevokedFn } from "./db"
+import { logger } from "./logger"
+import { ms } from "itty-time"
+
+export const fatalIssue = (ctx: z.RefinementCtx, message: string, val: unknown) => {
+	ctx.issues.push({
+		code: "custom",
+		message: message,
+		input: val
+	})
+
+	return z.NEVER
+}
+
+export const transformProofOfPossession = (env: SshCaBindings, val: string, ctx: z.core.$RefinementCtx<string>): ProofOfPossession | never => {
+	const l = logger(env)
+	try {
+		const proof = new ProofOfPossession(val, { logger: l, skew: ms(env.CERTIFICATE_REQUEST_TIME_SKEW_MAX) })
+
+		return proof
+	} catch (err) {
+		l.error("proof of possession parsing error", "error", err)
+		switch (true) {
+			case (err instanceof PossessionParseError):
+				ctx.issues.push({
+					code: "custom",
+					message: err.message,
+					input: val
+				})
+				break
+			default:
+				ctx.issues.push({
+					code: "custom",
+					message: "proof of possession transform unhandled error",
+					input: val
+				})
+		}
+
+		return z.NEVER
+	}
+}
+
+type AccessToken = {
+	email: string
+	sub: string
+}
+
+export const transformAuthorizationHeader = async (env: SshCaBindings, val: string, ctx: z.RefinementCtx): Promise<AccessToken | never> => {
+	if (!val.startsWith("Bearer ") || val.length <= 7) {
+		return fatalIssue(ctx, "authorization header must be a Bearer token", val)
+	}
+
+	const jwt = val.replace("Bearer ", "")
+	const l = logger(env)
+
+	if (jwt === "") {
+		return fatalIssue(ctx, "request did not contain a JWT", val)
+	}
+
+	try {
+		// verify jwt
+		const { payload } = await verifyJWT(env, jwt)
+
+		if (payload.email === undefined) {
+			return fatalIssue(ctx, "JWT was verified but was missing required email claim", val)
+		}
+
+		return {
+			email: payload.email,
+			sub: payload.sub,
+		}
+	} catch (err) {
+		switch (true) {
+			case (err instanceof JWSInvalid):
+				return fatalIssue(ctx, "the access token was invalid", val)
+			case (err instanceof JWTInvalid):
+				return fatalIssue(ctx, "the access token failed verification", val)
+			case (err instanceof JWKInvalid):
+				return fatalIssue(ctx, "the access token JWK was invalid", val)
+			case (err instanceof JWKSInvalid):
+				return fatalIssue(ctx, "the access token JWKS was invalid", val)
+			case (err instanceof JWTClaimValidationFailed):
+				return fatalIssue(ctx, "claim validtion of the JWT failed", val)
+			default:
+				l.error("unhandled access token validation error", "in", "transformAuthorizationHeader", "error", err)
+				return fatalIssue(ctx, "unhandled access token validation error", val)
+		}
+	}
+}
+
+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)
+
+		return key
+	} catch (err) {
+		switch (true) {
+			case (err instanceof TypeError):
+				ctx.issues.push({
+					code: "custom",
+					message: err.message,
+					input: val
+				})
+				break
+			case (err instanceof KeyParseError):
+				ctx.issues.push({
+					code: "custom",
+					message: err.message,
+					input: val
+				})
+				break
+			default:
+				ctx.issues.push({
+					code: "custom",
+					message: "unhandled error parsing public_key",
+					input: val
+				})
+		}
+
+		return z.NEVER
+	}
+}
+
+export const identityPrincipals = (env: SshCaBindings, payload: CertificateRequestJWTPayload, claim?: string): string[] => {
+	if (claim === undefined) {
+		claim = env.JWT_SSH_CERTIFICATE_PRINCIPALS_CLAIM
+	}
+
+	const l = logger(env)
+
+	if (claim === "__proto__" || claim === "prototype" || claim === "constructor") {
+ 		l.warn("invalid principals claim configured", "claim", claim)
+ 		return []
+ 	}
+ 	const p = payload[claim]
+
+	if (p === undefined) {
+		l.warn("claim was missing despite being set in CA config", "claim", claim)
+		return []
+	}
+
+	if (p === "") {
+		l.warn("claim was present but was an empty string", "claim", claim)
+		return []
+	}
+
+	// make sure its always a string[] and replace any spaces with underscores
+	const principals = (typeof p === "string" ? [p] : p)
+ 		.map((value) => value.replaceAll(" ", "_"))
+
+	l.info("identity token included principals", "principals", principals)
+
+	return principals
+}
+
+type IdentityToken = {
+	sub: string
+	principals: string[]
+}
+
+export const parseIdentity = async (env: SshCaBindings, jwt: string | undefined, claim?: string): Promise<IdentityToken> => {
+	if (jwt === undefined) {
+		throw new Error("missing identity token")
+	}
+
+	const aud = env.JWT_AUD === undefined || env.JWT_AUD as string === "" ? undefined : split(env.JWT_AUD as string)
+	const { payload } = await verifyJWT(env, jwt, { aud: aud })
+
+	const principals = identityPrincipals(env, payload, claim)
+
+	return {
+		sub: payload.sub,
+		principals: principals,
+	}
+}
+
+export const transformIdentityToken = async (env: SshCaBindings, val: string, ctx: z.RefinementCtx): Promise<IdentityToken | never> => {
+	try {
+		const identity = await parseIdentity(env, val, env.JWT_SSH_CERTIFICATE_PRINCIPALS_CLAIM)
+
+		return identity
+	} catch (err) {
+		ctx.issues.push({
+			code: "custom",
+			message: "problem parsing identity token",
+			input: val
+		})
+		return z.NEVER
+	}
+}
+
+/**
+ *
+ * @param val A SSH certificate either a base64 encoded "string" or a "Buffer\<ArrayBufferLike\>"
+ * @param ctx The Zod context for any errors
+ * @returns
+ */
+export const transformCertificate = (val: string | Buffer<ArrayBufferLike>, ctx: z.RefinementCtx): Certificate | never => {
+	try {
+		const cert = typeof val === "string" ? parseCertificate(Buffer.from(val, "base64"), "openssh") : parseCertificate(val, "openssh")
+
+		return cert
+	} catch (err) {
+		switch (true) {
+			case (err instanceof TypeError):
+				ctx.issues.push({
+					code: "custom",
+					message: err.message,
+					input: val
+				})
+				break
+			case (err instanceof CertificateParseError):
+				ctx.issues.push({
+					code: "custom",
+					message: err.message,
+					input: val
+				})
+				break
+			default:
+				ctx.issues.push({
+					code: "custom",
+					message: "unhandled error parsing certificate",
+					input: val
+				})
+		}
+
+		return z.NEVER
+	}
+}
+
+type ParsedCertificateRequest = {
+	proof: ProofOfPossession
+	public_key: Key
+	lifetime: number
+	identity: IdentityToken
+	extensions: string[]
+}
+
+export const refineCertificateRequest = async (env: SshCaBindings, val: ParsedCertificateRequest, ctx: z.RefinementCtx): Promise<never> => {
+	const l = logger(env)
+	try {
+		// check proof of possession fingerprint matches public key
+		if (!val.proof.matches(val.public_key)) {
+			return fatalIssue(ctx, "proof of possession fingerprint did not match public_key", val)
+		}
+
+		// verify proof of possession signature
+		const verified = await val.proof.verify()
+		if (!verified) {
+			return fatalIssue(ctx, "proof of possession signature validation failed", val)
+		}
+
+		return z.NEVER
+	} catch (err) {
+		l.error("proof of possession verification unhandled error", "in", "refineCertificateRequest", "error", err)
+		return fatalIssue(ctx, "proof of possession verification unhandled error", val)
+	}
+}
+
+export const transformRenewalProofOfPossession = (env: SshCaBindings, val: string, ctx: z.RefinementCtx): RenewalProofOfPossession | never => {
+	const l = logger(env)
+	try {
+		return new RenewalProofOfPossession(val, { logger: l, skew: ms(env.CERTIFICATE_REQUEST_TIME_SKEW_MAX) })
+	} catch (err) {
+		if (err instanceof PossessionParseError) {
+			return fatalIssue(ctx, err.message, val)
+		}
+
+		l.error("proof of possession verification unhandled error", "in", "transformRenewalProofOfPossession", "error", err)
+		return fatalIssue(ctx, "proof of possession transform unhandled error", val)
+	}
+}
+
+type HostCertificateRequest = {
+	public_key: Key
+	lifetime: number
+}
+
+type ParsedHostCertificateRequest = {
+	principals: string[]
+	proof: ProofOfPossession
+} & HostCertificateRequest
+
+export const refineHostCertificateRequest = async (env: SshCaBindings, val: ParsedHostCertificateRequest, ctx: z.RefinementCtx): Promise<never> => {
+	const l = logger(env).with("in", "refineHostCertificateRequest")
+
+	l.debug("started")
+
+	try {
+		// check proof of possession fingerprint matches public key
+		l.debug("checking val.proof.matches()", "public_key", val.public_key.toString("ssh"))
+		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)
+		}
+
+		// verify proof of possession signature
+		l.debug("await val.proof.verify()")
+		const verified = await val.proof.verify()
+		if (!verified) {
+			l.warn("proof of possession signature validation failed")
+			return fatalIssue(ctx, "proof of possession signature validation failed", val)
+		}
+
+		l.debug("done")
+
+		return z.NEVER
+	} catch (err) {
+		l.error("proof of possession verification unhandled error", "error", err)
+		return fatalIssue(ctx, "proof of possession verification unhandled error", val)
+	}
+}
+
+type ParsedHostCertificateRenewal = {
+	certificate: Certificate
+	proof: RenewalProofOfPossession
+} & HostCertificateRequest
+
+export const refineHostCertificateRenewal = async (env: SshCaBindings, isRevoked: typeof IsRevokedFn, val: ParsedHostCertificateRenewal, 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)
+		}
+
+		// check certificate is not expired
+		if (val.certificate.isExpired()) {
+			return fatalIssue(ctx, "the provided certificate is expired", 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)
+		}
+
+		// check proof of possession fingerprint matches public key and certificate subject key
+		if (!val.proof.matches(val.public_key, val.certificate.subjectKey)) {
+			return fatalIssue(ctx, "proof of possession fingerprints did not match public_key and/or certificate", val)
+		}
+
+		// verify proof of possession signature
+		const verified = await val.proof.verify()
+		if (!verified) {
+			return fatalIssue(ctx, "proof of possession signature validation failed", val)
+		}
+
+		return z.NEVER
+	} catch (err) {
+		l.error("proof of possession verification unhandled error", "in", "refineHostCertificateRenewal", "error", err)
+		return fatalIssue(ctx, "proof of possession verification unhandled error", val)
+	}
+}
+
+type ParsedRevokeCertificate = {
+	serial: bigint
+	public_key: Key
+	proof: ProofOfPossession
+}
+
+export const refineRevokeCertificate = async (env: SshCaBindings, val: ParsedRevokeCertificate, ctx: z.RefinementCtx): Promise<never> => {
+	const l = logger(env)
+	try {
+		// check proof of possession fingerprint matches public key
+		if (!val.proof.matches(val.public_key)) {
+			return fatalIssue(ctx, "proof of possession fingerprint did not match public_key", val)
+		}
+
+		// verify proof of possession signature
+		const verified = await val.proof.verify()
+		if (!verified) {
+			return fatalIssue(ctx, "proof of possession signature validation failed", val)
+		}
+
+		return z.NEVER
+	} catch (err) {
+		l.error("proof of possession verification unhandled error", "in", "refineRevokeCertificate", "error", err)
+		return fatalIssue(ctx, "proof of possession verification unhandled error", val)
+	}
+}
+
+export const split = (v: string): string[] => {
+	if (v === "" || v === undefined) {
+		return []
+	}
+
+	return v.split(",")
+}
+
+export const getPublic = async (env: SshCaBindings, key?: PrivateKey): Promise<Key> => {
+	if (key === undefined) {
+		// grab private key from secret store
+		const secret = await env.PRIVATE_KEY.get()
+
+		// parse it
+		key = parsePrivateKey(secret)
+	}
+
+	// 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
+}

package/src/verify.ts

@@ -0,0 +1,25 @@
+import { createRemoteJWKSet, jwtVerify } from "jose"
+import { CertificateRequestJWTPayload } from "./types"
+import type { SshCaBindings } from "./types"
+import { split } from "./utils"
+
+type VerifyOptions = {
+	aud?: string | string[]
+}
+
+export const verifyJWT = async (env: SshCaBindings, jwt: string, opts: VerifyOptions = {}) => {
+    const JWKS = createRemoteJWKSet(new URL(env.JWT_JWKS_URL))
+
+	if (opts.aud !== undefined) {
+		return await jwtVerify<CertificateRequestJWTPayload>(jwt, JWKS, {
+			issuer: env.JWT_ISSUER,
+			algorithms: split(env.JWT_ALGORITHMS),
+			audience: opts.aud
+		})
+	}
+
+    return await jwtVerify<CertificateRequestJWTPayload>(jwt, JWKS, {
+        issuer: env.JWT_ISSUER,
+        algorithms: split(env.JWT_ALGORITHMS),
+    })
+}

package/LICENSE

@@ -1,201 +0,0 @@
-Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright 2026 Andrew Heberle
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.