@andrewheberle/serverless-ssh-ca 0.17.5 → 0.17.7

package/LICENSE

@@ -0,0 +1,201 @@
+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.

package/README.md

@@ -0,0 +1,268 @@
+# Serverless SSH CA on Cloudflare Workers
+
+[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https%3A%2F%2Fgithub.com%2Fandrewheberle%2Fserverless-ssh-ca-template)
+
+[![codecov](https://codecov.io/gh/andrewheberle/serverless-ssh-ca/graph/badge.svg?flag=worker&token=AZLFIBTTFK)](https://codecov.io/gh/andrewheberle/serverless-ssh-ca)
+
+This repository contains a serverless Certificate Authority (CA) that can be used
+to provide signed certificates for SSH users and hosts running on Cloudflare Workers.
+
+## @andrewheberle/serverless-ssh-ca
+
+This is the package that implements the SSH CA functionality which can be deployed
+to Cloudflare as a working solution using the "Deploy to Cloudflare" button.
+
+To use the package in your own Worker manually (assuming you have the requried
+bindings in place), the following code in `src/index.ts` (your Worker's main
+file) will work:
+
+```ts
+import app from "@andrewheberle/serverless-ssh-ca"
+
+export default app
+```
+
+This package **only** works with Cloudflare Workers and there are no plans to make
+this a generic solution at this time.
+
+See the following respositories for additional information:
+
+
+| Repostitory | Details |
+|---|---|
+| https://github.com/andrewheberle/ssh-ca-client | Contains client code for issuing user and host certificates |
+| https://github.com/andrewheberle/severless-ssh-ca-template | Contains a template repository for deployment to Cloudflare Workers |
+
+## Architecture
+
+The solution comprises of the CA running as a Worker, a Go based client
+(found [here](https://github.com/andrewheberle/ssh-ca-client])) and a third
+party OIDC IdP.
+
+The IdP may be any OIDC compatible service that returns a JWT with at least
+an `email` claim in the OIDC access token, however at this time only
+Cloudflare Access has been tested.
+
+### User Certificates
+
+The flow to obtain a User SSH certificate using the CLI version is as follows:
+
+1. The user initiates `ssh-ca-client-cli login`
+2. If required a new SSH key is generated and the a browser is opened to
+   visit `http://localhost:3000/auth/login`
+3. The client redirects the user to the configured IdP
+4. The IdP returns the user to the callback URL (default
+   `http://localhost:3000/auth/callback`)
+5. The client uses the JWT from the IdP as `Authorization: Bearer <TOKEN>`
+   in a `POST` request containing the users SSH public key to the CA's
+   `/api/v3/user/certificate` endpoint
+6. The CA verifies the incoming JWT and assuming it is valid and verified, will
+   respond with a signed certificate based on the provided public key
+7. The client saves the certificate and adds the SSH private key and
+   certificate to the local SSH Agent.
+
+This flow is shown below once the user executes `ssh-ca-client-cli login`:
+
+```mermaid
+sequenceDiagram
+    User->>Client: GET /auth/login
+    activate Client
+    Client-->>User: Redirect to IdP
+    deactivate Client
+    activate User
+    User->>IdP: OIDC authentication flow
+    deactivate User
+    activate IdP
+    IdP-->>User: Redirect to Client
+    deactivate IdP
+    activate User
+    User->>Client: Completes OIDC redirect
+    deactivate User
+    activate Client
+    activate Client
+    Client-->>User: Auth flow completed
+    deactivate Client
+    Client->>CA: POST /api/v3/user/certificate
+    deactivate Client
+    activate CA
+    CA-->>Client: Signed certificate
+    deactivate CA
+    activate Client
+    Client->>SSH Agent: Add key and certificate to Agent
+    deactivate Client
+```
+
+If a refresh token is available, the process looks like this when running
+`ssh-ca-client-cli login`:
+
+```mermaid
+sequenceDiagram
+    Client->>IdP: Request authentication token
+    activate IdP
+    IdP-->>Client: Token returned
+    deactivate IdP
+    activate Client
+    Client->>CA: POST /api/v3/user/certificate
+    deactivate Client
+    activate CA
+    CA-->>Client: Signed certificate
+    deactivate CA
+    activate Client
+    Client->>SSH Agent: Add key and certificate to Agent
+    deactivate Client
+```
+
+If the process to request a new authentication token fails using the refresh
+token, the standard authentication process is followed which requires user
+interaction.
+
+### Host Certificates
+
+#### Initial Request
+
+The process to request an intitial Host certificate is similar to obtaining
+a User certificate once `ssh-ca-client-cli host` is run, however instead of
+adding the obtained certificate to a SSH Agent, it is written to
+`<KEYPATH>-cert.pub` instead:
+
+```mermaid
+sequenceDiagram
+    User->>Client: GET /auth/login
+    activate Client
+    Client-->>User: Redirect to IdP
+    deactivate Client
+    activate User
+    User->>IdP: OIDC authentication flow
+    deactivate User
+    activate IdP
+    IdP-->>User: Redirect to Client
+    deactivate IdP
+    activate User
+    User->>Client: Completes OIDC redirect
+    deactivate User
+    activate Client
+    activate Client
+    Client-->>User: Auth flow completed
+    deactivate Client
+    Client->>CA: POST /api/v3/host/certificate
+    deactivate Client
+    activate CA
+    CA-->>Client: Signed certificate
+    deactivate CA
+    activate Client
+    Client->>Writes Certificate: Certificate written to disk
+    deactivate Client
+```
+
+#### Renewals
+
+Renewals are done using the existing certificate and will succeed if:
+
+1. The certificate is not expired
+2. It was issued by the CA
+3. The public key used to obtain the certificate is the same as the one
+currently presented
+
+This means the OIDC authentication flow is not required in this case as shown
+below when `ssh-ca-client-cli host --renew` is run:
+
+```mermaid
+sequenceDiagram
+    Client->>CA: POST /api/v3/host/renew
+    activate CA
+    CA-->>Client: Signed certificate
+    deactivate CA
+    activate Client
+    Client->>Writes Certificate: Certificate written to disk
+    deactivate Client
+```
+
+## Configuration
+
+### Identity Provider
+
+This example shows the configuration in Cloudflare Access, however other
+OIDC IdP's should be generally equivalent:
+
+![Basic OIDC Settings](images/oidc-example_01.png)
+
+The `Redirect URL` must match the configured value in the client.
+
+Transfer the IdP settings as follows:
+
+![IdP Settings](images/oidc-example_02.png)
+
+The `openid` and `email` scopes are required, with enabling of refresh tokens
+(the `offline_access` scope) being optional, but recommended.
+
+### Client
+
+Please visit the client repository for further information:
+
+https://github.com/andrewheberle/ssh-ca-client
+
+### SSH Endpoints
+
+#### Host Configuration
+
+For systems to allow SSH login using certificates the following configuration
+changes must be made:
+
+```ssh
+PubkeyAuthentication yes
+TrustedUserCAKeys /etc/ssh/ca.pub
+AuthorizedPrincipalsFile /etc/ssh/principals.d/%u
+# Uncomment the following lines to enable host certificates
+# HostCertificate /etc/ssh/ssh_host_rsa_key-cert.pub
+# HostCertificate /etc/ssh/ssh_host_ecdsa_key-cert.pub
+# HostCertificate /etc/ssh/ssh_host_ed25519_key-cert.pub
+```
+
+The contents of `/etc/ssh/ca.pub` is the public key of the SSH CA, which can be
+retrieved as follows:
+
+```sh
+curl https://ssh-ca.example.com/api/v3/ca | sudo tee /etc/ssh/ca.pub
+```
+
+The `/etc/ssh/principals.d` directory should contain a file corresponding to
+a local user that contains a list of principals that should be allowed
+login.
+
+Using the principals list in `SSH_CERTIFICATE_PRINCIPALS` above, the
+following file named `/etc/ssh/principals.d/admin` would allow login
+as the SSH user `admin` for the bearer of an issued (and valid) certificate:
+
+```
+ssh-admin
+```
+
+#### Client Configuration
+
+In order for a client to trust a certificate presented by a host the following
+configuration must be added to `/etc/ssh/ssh_known_hosts` (system wide) or
+`~/.ssh/known_hosts` (user specific):
+
+```
+@cert-authority *.example.com ecdsa-sha2-nistp256 ....
+```
+
+The format of the above file is documented in the `ssh(1)` man page however
+the important items of note is the `*.example.com` above tells `ssh` that the
+CA public key (ie `ecdsa-sha2-nistp256 ....`) is trusted for all hosts, that
+match `*.example.com`.
+
+This will need adjusting depending on your environment along with the actual
+SSH CA public key which can be retrieved as follows:
+
+```sh
+curl https://ssh-ca.example.com/api/v3/ca
+```
+
+Once the above configuration is completed and host certificates are in place
+clients will not require "trust on first use" (TOFU) as the certificate will be
+verified as being signed by the configured SSH CA.
+
+# Attributions
+
+The icons used by the client are made by Freepik from [www.flaticon.com](https://www.flaticon.com).

package/dist/api/v3/schema.js

@@ -2,6 +2,7 @@ import z from "zod";
 import { split, refineCertificateRequest, transformAuthorizationHeader, transformProofOfPossession, transformPublicKey, transformRenewalProofOfPossession, refineHostCertificateRequest, transformCertificate, refineHostCertificateRenewal, refineRevokeCertificate, transformIdentityToken, } from "../../utils";
 import { ConflictException, contentJson, ForbiddenException, InputValidationException, InternalServerErrorException, UnauthorizedException, UnprocessableEntityException, } from "chanfana";
 import { seconds } from "itty-time";
+import { isRevoked } from "../../db";
 const openapiStringByte = z.base64()
     .transform((v) => {
     const a = z.util.base64ToUint8Array(v);
@@ -156,7 +157,7 @@ export const createHostCertificateRenewEndpointSchema = (env) => ({
                 .default(seconds(env.SSH_HOST_CERTIFICATE_LIFETIME))
                 .meta({ description: "Lifetime of renewed Host SSH certificate" }),
         })
-            .superRefine((val, ctx) => refineHostCertificateRenewal(env, val, ctx))
+            .superRefine((val, ctx) => refineHostCertificateRenewal(env, isRevoked, val, ctx))
             .openapi("Host Certificate Renew"))
     },
     responses: {

package/dist/proof.js

@@ -48,7 +48,7 @@ export class ProofOfPossession {
         }
         const now = options?.from !== undefined ? options?.from : Date.now();
         const age = now - timestamp;
-        const skew = options?.skew !== undefined ? options.skew : ms("5 minutes");
+        const skew = options?.skew !== undefined ? options.skew : ms("90 seconds");
         if (age > skew) {
             throw new PossessionParseError("timestamp too old");
         }

package/dist/sshsig/formats.js

@@ -105,7 +105,7 @@ export function convertPublicKey(publickey) {
         else if (pk_algo === "ecdsa-sha2-nistp384") {
             crv = "P-384";
         }
-        {
+        else {
             crv = "P-521";
         }
         return {

package/dist/utils.d.ts

@@ -3,6 +3,7 @@ import { Certificate, Key, PrivateKey } from "sshpk";
 import z from "zod";
 import { CertificateRequestJWTPayload } from "./types";
 import { RenewalProofOfPossession, ProofOfPossession } from "./proof";
+import type { isRevoked as IsRevokedFn } from "./db";
 export declare const fatalIssue: (ctx: z.RefinementCtx, message: string, val: unknown) => never;
 export declare const transformProofOfPossession: (env: SshCaBindings, val: string, ctx: z.core.$RefinementCtx<string>) => ProofOfPossession | never;
 type AccessToken = {
@@ -47,7 +48,7 @@ type ParsedHostCertificateRenewal = {
     certificate: Certificate;
     proof: RenewalProofOfPossession;
 } & HostCertificateRequest;
-export declare const refineHostCertificateRenewal: (env: SshCaBindings, val: ParsedHostCertificateRenewal, ctx: z.RefinementCtx) => Promise<never>;
+export declare const refineHostCertificateRenewal: (env: SshCaBindings, isRevoked: typeof IsRevokedFn, val: ParsedHostCertificateRenewal, ctx: z.RefinementCtx) => Promise<never>;
 type ParsedRevokeCertificate = {
     serial: bigint;
     public_key: Key;

package/dist/utils.js

@@ -3,7 +3,6 @@ import { KeyParseError, CertificateParseError, parseCertificate, parseKey, parse
 import z from "zod";
 import { verifyJWT } from "./verify";
 import { RenewalProofOfPossession, ProofOfPossession, PossessionParseError } from "./proof";
-import { isRevoked } from "./db";
 import { logger } from "./logger";
 import { ms } from "itty-time";
 export const fatalIssue = (ctx, message, val) => {
@@ -250,7 +249,7 @@ export const refineHostCertificateRequest = async (env, val, ctx) => {
         return fatalIssue(ctx, "proof of possession verification unhandled error", val);
     }
 };
-export const refineHostCertificateRenewal = async (env, val, ctx) => {
+export const refineHostCertificateRenewal = async (env, isRevoked, val, ctx) => {
     const l = logger(env);
     try {
         // ensure certificate is signed by CA

package/package.json

@@ -1,9 +1,8 @@
 {
 	"name": "@andrewheberle/serverless-ssh-ca",
-	"version": "0.17.5",
+	"version": "0.17.7",
 	"description": "A serverless SSH CA built on Cloudflare Workers",
 	"type": "module",
-	"main": "dist/index.js",
 	"types": "./dist/index.d.ts",
 	"files": [
 		"dist"
@@ -16,6 +15,7 @@
 	},
 	"scripts": {
 		"build": "tsc",
+		"coverage": "vitest run --coverage",
 		"test": "vitest run",
 		"test:watch": "vitest",
 		"prepublishOnly": "npm run build",
@@ -24,6 +24,7 @@
 	"dependencies": {
 		"@andrewheberle/ts-slog": "^1.3.0",
 		"@cloudflare/actors": "^0.0.1-beta.6",
+		"@cloudflare/workers-types": "^4.20260528.1",
 		"chanfana": "^3.0.0",
 		"hono": "^4.10.6",
 		"itty-time": "^2.0.2",
@@ -32,27 +33,22 @@
 		"zod": "^4.0.0"
 	},
 	"devDependencies": {
-		"@cloudflare/workers-types": "^4.20260528.1",
 		"@types/sshpk": "^1.17.4",
+		"@vitest/coverage-istanbul": "^4.1.7",
+		"auto-changelog": "^2.5.1",
 		"release-it": "^20.0.1",
 		"tsx": "^4.21.0",
-		"typescript": "^6.0.0"
+		"typescript": "^6.0.0",
+		"vitest": "^4.1.7"
 	},
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/andrewheberle/serverless-ssh-ca.git",
-		"directory": "packages/ssh-ca"
+		"url": "git+https://github.com/andrewheberle/serverless-ssh-ca.git"
 	},
 	"homepage": "https://github.com/andrewheberle/serverless-ssh-ca#readme",
 	"bugs": {
 		"url": "https://github.com/andrewheberle/serverless-ssh-ca/issues"
 	},
 	"author": "Andrew Heberle",
-	"license": "Apache-2.0",
-	"release-it": {
-		"git": false,
-		"npm": {
-			"skipChecks": true
-		}
-	}
+	"license": "Apache-2.0"
 }

package/dist/src/api/v3/index.d.ts

@@ -1 +0,0 @@
-export declare const api: import("chanfana").HonoOpenAPIRouterType<import("hono/types").BlankEnv, import("hono/types").BlankSchema, "/">;