saltstack / saltstack/salt

ssh_priv master configuration option is undocumented

Open
#57,416 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug documentation severity-low time-estimate-sprint
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

The code supports it (https://github.com/saltstack/salt/blob/master/salt/client/ssh/__init__.py#L254) and the related ssh_priv_passwd (https://docs.saltstack.com/en/2019.2/ref/configuration/master.html#ssh-priv-passwd) and ssh_use_home_key (https://docs.saltstack.com/en/2019.2/ref/configuration/master.html#ssh-use-home-key) options are documented.

Following a recent compromise, we have been told to replace rsa keys with ed255519 keys, and salt only looks in rsa key locations which is why I needed to use this (undocumented) option.

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 salt/client/ssh/init.py at the referenced configuration handling and compare the master configuration documentation for ssh_priv_passwd and ssh_use_home_key. Document the supported ssh_priv option in the corresponding master configuration page, including its purpose and relationship to SSH key locations.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.