oxidecomputer / oxidecomputer/omicron

Validate SSH public key on create

Open
#3,180 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
572
Forks
97
Avg merge
2d 12h
Merged PRs (30d)
96

Description

API side of https://github.com/oxidecomputer/console/issues/1510

Right now, SSH keys are a free-form string. We could stand to do some basic validation to make sure they at least resemble an SSH key.

https://github.com/oxidecomputer/omicron/blob/e83f7b69fb1685d36d8db01dede75d9c4f1cc58d/nexus/types/src/external_api/params.rs#L1301-L1309

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with nexus/types/src/external_api/params.rs at lines 1301-1309, which the issue identifies as the API parameter definition. Trace how the SSH key string is handled on creation and determine the project's existing validation patterns. Done means rejecting values that do not resemble an SSH public key while accepting valid keys, with coverage for the validation behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.