Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mdevolde/my_ssh_service
A Windows SSH service to run an SSH connection in the background.
https://github.com/mdevolde/my_ssh_service
rust service ssh windows
Last synced: 12 days ago
JSON representation
A Windows SSH service to run an SSH connection in the background.
- Host: GitHub
- URL: https://github.com/mdevolde/my_ssh_service
- Owner: mdevolde
- License: mit
- Created: 2024-11-02T13:56:14.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2024-11-06T15:29:16.000Z (about 2 months ago)
- Last Synced: 2024-11-12T02:51:36.653Z (about 2 months ago)
- Topics: rust, service, ssh, windows
- Language: Rust
- Homepage:
- Size: 15.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# My SSH service
A Windows SSH service to run an SSH connection in the background.
## Requirements
Have [everything you need to compile Rust](https://www.rust-lang.org/tools/install).
## How to build and use
To build and run the service, follow these steps (be sure to replace generic values with your own data in the commands):
```powershell
cargo b -r
sc.exe create "mysshservice" binPath="""C:\path\to\your\generated\exe\my_ssh_service.exe"" -N -T -R 9999:localhost:9999 user@ip" obj="DOMAIN\Username" password="UserPassword" depend="Tcpip/nsi" DisplayName="My SSH service" start=delayed-auto # needs to be executed by an admin
sc.exe description "mysshservice" "A Windows SSH service to run an SSH connection in the background." # needs to be executed by an admin
sc.exe start mysshservice # needs to be executed by an admin
```
This example runs a reverse port forwarding on port 9999 in the background, but you can pass any arguments you like to SSH.
Obviously, the ssh connection must be able to be established using a key, without the need to enter a passphrase. It's the reason why the service is started using a user account, to access to the user ssh keys.
This service will start automatically when the computer boots up, after a lot of important services have started.
If you want to exceptionally run the service with other arguments (a different port for exemple), you proceed as follows:
```powershell
sc.exe stop "mysshservice" # needs to be executed by an admin
sc.exe start mysshservice -N -T -R 9998:localhost:9998 user@ip # needs to be executed by an admin
```
When the computer boots up, the service will start with the default arguments.
## How to stop the service and check its status
To stop the service, execute this command:
```powershell
sc.exe stop "mysshservice" # needs to be executed by an admin
```
To check the status of the service, you need to run this command:
```powershell
sc.exe query "mysshservice"
```
## Check the logs of the service
The logs of the service are available in `%ProgramData%\mysshservice\logs\`.