PowerShell / PowerShell/Win32-OpenSSH

SFTP logging documentation

Open
#1,685 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
8.3k
Forks
819
PR merge metrics
No merged PRs in 30d

Description

The documentation in the wiki is a bit lacking. [https://github.com/PowerShell/Win32-OpenSSH/wiki/sshd_config]
It indicates how to get sftp-server to log such as:
Subsystem sftp sftp-server.exe -l INFO -f AUTH

However if one were to use ForceCommand internall-sftp ... this doesn't log. You have to append flags here if you want to log using ForceCommand. This is not clear from the documentation. I used this line to achieve logging with ForceCommand:
ForceCommand internal-sftp -l INFO -f AUTH

It would be awesome if this were explained properly in the wiki. I spent a couple of hours figuring this out.

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

Open the wiki's sshd_config page linked in the issue and compare the documented Subsystem sftp command with the ForceCommand internal-sftp example. Clarify that logging flags must be appended to ForceCommand as well, using the provided -l INFO -f AUTH example. Done means the wiki explains both configurations and when each logs.

Written by the indexing model from the issue text.

Assessment

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.