Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

write_openssh_file() doesn't document the file permission it uses to create the file

Open Beginner friendly
#596 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
75/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
rust
Domain
documentation

Research direction

Read the write_openssh_file() documentation on PrivateKey and inspect its implementation to identify the file permission used when creating the file. Update the method documentation to state that permission, then verify the rendered docs describe it accurately.

Written by the indexing model from the issue text.

Description

write_openssh_file() doesn't document the file permission it uses to create the file. I wondered because someone set them afterwards, which is wrong but looking at https://docs.rs/ssh-key/latest/ssh_key/private/struct.PrivateKey.html#method.write_openssh_file doesn't say something about it.

Dominant language
Rust
Stars
247
Forks
66
Avg merge
2h 31m
Merged PRs (30d)
2

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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 RustCrypto/SSH

All issues in RustCrypto/SSH

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.