Skip to content

Latest commit

 

History

History
101 lines (70 loc) · 2.59 KB

README.md

File metadata and controls

101 lines (70 loc) · 2.59 KB
Raw

Conch SSH CA

Conch is an SSH CA for use in AIRR sites.

Installation

Conch can be deployed in a few different way, but all require a private SSH signeing key to be created:

ssh-keygen -q -t ed25519 -f ssh_signing_key -C '' -N ''

Helm

First, create the SSH signing key and put it in a Secret:

kubectl create secret generic conch-signing-key-secret --from-file=key=ssh_signing_key
rm ssh_signing_key

then, you can create a values.yaml like:

---
config:
  issuer: "https://keycloak.example.com/realms/example"
  platforms:
    service-one:
      alias: "s1.example"
      hostname: "s1.example.com"
      proxy_jump: "jump.example.com"

You should avoid making the alias a resolvable domain name as it will be used in SSH configs and works best if it forms its own namespace.

and install the chart with:

helm upgrade conch oci://ghcr.io/isambard-sc/charts/conch --version x.y.z --install --values values.yaml

OCI image

Conch can be deployed as a container using e.g. Podman.

Set up the config file:

signing_key_path = "/signing_key"

issuer = "https://keycloak.example.com/realms/example"

[platforms.service-one]
alias = "s1.example"
hostname = "s1.example.com"
proxy_jump = "jump.example.com"

and run the container, pointing it to those two files:

podman run \
  -v conch.toml:/conch.toml \
  -v ssh_signing_key:/signing_key \
  -e RUST_LOG=info \
  ghcr.io/isambard-sc/conch:0.1.4 --config=/conch.toml

Binary

Conch can be run as a simple binary. They can be downloaded from releases.

Create the config file as above (editing it to point to the local location of the signing key). You can then run it with:

env RUST_LOG=info conch --config=conch.toml

OIDC

All the methods above require an OIDC issuer to be specified. Any client communicating with Conch (e.g. Clifton) will need to provide a signed JWT which Conch will validate against the issuer. This means that the issuer that the client uses must match the issuer configured in Conch.

Name

The famous conch in William Golding's Lord of the Flies was, according to his daughter, inspired by a shell in the Bristol Museum of Natural History. Given that this tool is to give access to secure shells, it seemed a fitting reference.