Updated OpenSSH utility scripts to fix file permissions (markdown)

Yanbing 2017-06-02 19:33:53 -07:00
parent dbbf55a20d
commit 4be5fe3a83

@ -1,14 +1,14 @@
Powershell utility scripts are included starting release [V0.0.15.0](https://github.com/PowerShell/Win32-OpenSSH/releases/tag/v0.0.15.0) to help you fix the permissions on various keys and configuration files. Powershell utility scripts are included starting release [V0.0.15.0](https://github.com/PowerShell/Win32-OpenSSH/releases/tag/v0.0.15.0) to automatically fix the permissions on various keys and configuration files for host and user. [Secure protection of various files](https://github.com/PowerShell/Win32-OpenSSH/wiki/Security-protection-of-various-files-in-Win32-OpenSSH) explains why secure enforcement is needed.
- `FixHostFilePermissions.ps1`: checks and fixes the below permission on default host files. - `FixHostFilePermissions.ps1`: checks and fixes the below permissions on default host files:
- user's authorized_keys located at ```$env:systemdrive\Users\...\.ssh\authorized_keys``` - user's authorized_keys located at ```$env:systemdrive\Users\...\.ssh\authorized_keys```
- host keys generated by `ssh-keygen.exe -A` in the same folder of the script - host keys generated by `ssh-keygen.exe -A` in the same folder of the script
- sshd_config in the same folder of the script - sshd_config in the same folder of the script
```PowerShell ```PowerShell
# -Quiet suppresses prompting to confirm you want to update each permission # script prompt to confirm you want to update each permission if Quiet is not specified
.\FixHostFilePermissions.ps1 -Quiet .\FixHostFilePermissions.ps1
``` ```
- `FixUserFilePermissions.ps1`: check and fix the file permission for user's default files: - `FixUserFilePermissions.ps1`: checks and fixes the below file permissions for user's default files:
- user's ssh_config located at ~\.ssh\config - user's ssh_config located at ~\.ssh\config
- user's keys located at ~\.ssh\id_rsa, id_rsa.pub - user's keys located at ~\.ssh\id_rsa, id_rsa.pub
- user's keys located at ~\.ssh\id_dsa, id_dsa.pub - user's keys located at ~\.ssh\id_dsa, id_dsa.pub
@ -17,15 +17,15 @@ Powershell utility scripts are included starting release [V0.0.15.0](https://git
# -Quiet suppresses prompting to confirm you want to update each permission # -Quiet suppresses prompting to confirm you want to update each permission
.\FixUserFilePermissions.ps1 -Quiet .\FixUserFilePermissions.ps1 -Quiet
``` ```
- Powershell module `OpenSSHUtils.psm1` helps to check and fix customer specified files. - Powershell module `OpenSSHUtils.psm1` checks and fixes customer specified files.
- Function `Fix-HostSSHDConfigPermissions` fix the sshd_config file specified by user - Function `Fix-HostSSHDConfigPermissions` fixes the sshd_config file specified by user
- Function `Fix-HostKeyPermissions` fix the permission for host keys specified by user - Function `Fix-HostKeyPermissions` fixes the permission for host keys specified by user
- Function `Fix-UserKeyPermissions` fix the the permissions for user's key files specified by user - Function `Fix-UserKeyPermissions` fixes the the permissions for user's key files specified by user
- Function `Fix-AuthorizedKeyPermissions` fix the permissions for the authorized_keys file specified by user - Function `Fix-AuthorizedKeyPermissions` fixes the permissions for the authorized_keys file specified by user
- Function `Fix-UserSSHConfigPermissions` fix the permissions for user's ssh config specified by user - Function `Fix-UserSSHConfigPermissions` fixes the permissions for user's ssh config specified by user
```PowerShell ```PowerShell
import-module .\OpenSSHUtils.psm1 -force Import-Module .\OpenSSHUtils.psm1 -Force
# prompt to confirm you want to confirm you want to update each permission on the file # prompt to confirm you want to confirm you want to update each permission on the file
Fix-HostSSHDConfigPermissions c:\test\sshd_config Fix-HostSSHDConfigPermissions c:\test\sshd_config
# -Quiet suppresses prompting to confirm you want to update each permission on the file # -Quiet suppresses prompting to confirm you want to update each permission on the file