Correctly document how to build OpenSSH with mlock

Open
#69 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
42/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale

Research direction

Read the OpenSSH release notes and the referenced NixOS common.nix attribute, then review issue #43 for the repository's build variants. Document how each setup preserves mlocking by using an OpenSSH build with the required flag, and make the integration requirement explicit for all supported build methods.

Written by the indexing model from the issue text.

Description

Note that to preserve mlocking, we need to tunnel the socket with a version of OpenSSH that is build with this build flag (see here)

 * sshd(8): add support for locking sshd into memory, enabled with
   the --with-linux-memlock-onfault c

On nix, this is easy, as per this attribute.

Given the various ways we build (see #43 ), we should create documentation on how to integrate this requirement in the setup.

Dominant language
Haskell
Stars
2
Forks
13
PR merge metrics
No merged PRs in 30d

Getting set up

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.

More from IntersectMBO/kes-agent

All issues in IntersectMBO/kes-agent

Similar issues

More Haskell issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.