Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lifailon/dotnet-systemd-api

REST API server and set of endpoints for managing Linux services based on .NET HttpListener.
https://github.com/lifailon/dotnet-systemd-api

api api-server bash dotnet endpoint endpoints linux net netcore powershell powershell-core powershell-script pwsh rest rest-api systemctl systemd

Last synced: 27 days ago
JSON representation

REST API server and set of endpoints for managing Linux services based on .NET HttpListener.

Awesome Lists containing this project

README 

        
# dotNET-Systemd-API



Set of endpoints for managing Linux services via **systemctl (systemd)**. Cross-platform REST API server **is based .NET HttpListener and PowerShell** with base authorization and error handling.



The goal is to demonstrate the ability of **PowerShell to be operating system independent** and used concurrently with the Bash language 🐧. It was also prompted by the impossibility to create a full-fledged server for REST API using standard means of Bash language and netcat.



![Image alt](https://github.com/Lifailon/dotNET-Systemd-API/blob/rsa/Example.gif)



## 🚀 Launch



**Dependencies**:



Only **[PowerShell Core](https://github.com/PowerShell/PowerShell)**



Download latest version the distribution from the official repository on GitHub and install it on your system, here is an example for Ubuntu:



```Bash

deb_latest=$(curl https://api.github.com/repos/PowerShell/PowerShell/releases/latest | grep -Eom 1 "https://.+.deb")

curl -LO $deb_latest

deb_name=$(echo $deb_latest | awk -F / '{print $NF}')

dpkg -i $deb_name

```



Set variables:

```Bash

$ip   = "192.168.3.104"

$port = "8080"

$path = "/var/log/systemctl-api.log"

$cred = "cmVzdDphcGk="

```



Open the specified network port in your firewall.



**Uncomplicated Firewall**:



```

ufw allow in 8080

ufw reload

```



**iptables**:



```

iptables -A INPUT -p tcp --dport 8080 -j ACCEPT

iptables-save

```



**FirewallD**:



```

firewall-cmd --permanent --add-port=8080/tcp

firewall-cmd --reload

```



**Start the server**: \

`powershell systemctl-api.ps1`



Warning: **use root privileges** to start the server if you need to manage services via POST requests.



## 🔒 Authorization



Basic authentication scheme is used on the basis of **Base64**.



For authorization it is necessary to pass the login and password in Base64 format to the server in the **variable $cred**. To get the login and password in Base64 format, use the construct:



```PowerShell

$user = "rest"

$pass = "api"

[System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("${user}:${pass}"))

```



**For client connectivity, use one of the designs**:



```PowerShell

$user = "rest"

$pass = "api"

$SecureString = ConvertTo-SecureString $pass -AsPlainText -Force

$Credential = New-Object System.Management.Automation.PSCredential($user, $SecureString)

#$Credential = Get-Credential

Invoke-RestMethod -Credential $Credential -AllowUnencryptedAuthentication -Uri http://192.168.3.104:8080/api/service/cron

```



2nd option, using header:



```PowerShell

$user = "rest"

$pass = "api"

$EncodingCred = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("${user}:${pass}"))

$Headers = @{"Authorization" = "Basic ${EncodingCred}"}

Invoke-RestMethod -Headers $Headers -Uri http://192.168.3.104:8080/api/service/cron

```



The server will match the credentials received in the header request from the client.



## 🎉 GET Request



To obtain specific service status:



```PowerShell

PS C:\Users\Lifailon> Invoke-RestMethod -Credential $Credential -AllowUnencryptedAuthentication -Uri http://192.168.3.104:8080/api/service/cron | Format-List                                       



Loaded : loaded (/lib/systemd/system/cron.service; enabled; vendor preset: enabled)

Active : active (running) since Sun 2023-10-15 20:57:43 MSK; 1h 23min ago

Tasks  : 1 (limit: 2220)

Memory : 2.2M

```



To get a list of all registered unit services:



`Invoke-RestMethod -Credential $Credential -AllowUnencryptedAuthentication -Uri http://192.168.3.104:8080/api/service`



To get the list of all registered unit services with their operation status (works slower):



`Invoke-RestMethod -Credential $Credential -AllowUnencryptedAuthentication -Uri http://192.168.3.104:8080/api/service-status`



## 💎 POST Request



**Stop** the service:



`Invoke-RestMethod -Credential $Credential -AllowUnencryptedAuthentication -Uri http://192.168.3.104:8080/api/service/cron -Method Post -Headers @{"Status" = "Stop"}`



**Start** the service:



`Invoke-RestMethod -Credential $Credential -AllowUnencryptedAuthentication -Uri http://192.168.3.104:8080/api/service/cron -Method Post -Headers @{"Status" = "Start"}`



**Restart** the service:



`Invoke-RestMethod -Credential $Credential -AllowUnencryptedAuthentication -Uri http://192.168.3.104:8080/api/service/cron -Method Post -Headers @{"Status" = "Restart"}`



## 🎊 Other Endpoints



Get a list of all processes with a detailed description of all characteristics in **html format**:



`Invoke-RestMethod -Credential $Credential -AllowUnencryptedAuthentication -Uri http://192.168.3.104:8080/process`



Get a list of all processes with a detailed description of all characteristics in **json format**:



`Invoke-RestMethod -Credential $Credential -AllowUnencryptedAuthentication -Uri http://192.168.3.104:8080/api/process`



Get current uptime and average load:



```PowerShell

PS C:\Users\Lifailon> Invoke-RestMethod -Credential $Credential -AllowUnencryptedAuthentication -Uri http://192.168.3.104:8080/api/uptime | Format-List



Uptime : 22:26:54 up 1 day

Users  : 2

avg    : 0.35 0.21 0.19

```



Output the state of physical disks (lsblk is used):



```PowerShell

PS C:\Users\Lifailon> $(Invoke-RestMethod -Credential $Credential -AllowUnencryptedAuthentication 

-Uri http://192.168.3.104:8080/api/disk).blockdevices.children



name       : sda1

maj:min    : 8:1

rm         : False

size       : 1M

ro         : False

type       : part

mountpoint : 



name       : sda2

maj:min    : 8:2

rm         : False

size       : 1G

ro         : False

type       : part

mountpoint : /boot



name       : sda3

maj:min    : 8:3

rm         : False

size       : 49G

ro         : False

type       : part

mountpoint : 

children   : {@{name=ubuntu--vg-ubuntu--lv; maj:min=253:0; rm=False; size=49G; ro=False; type=lvm 

             ; mountpoint=/}}

```



## ⚠️ Error Handling



If the service name is incorrect or the service does not exist, you will receive a message.



**400. Bad Request**:



```PowerShell

PS C:\Users\Lifailon> Invoke-RestMethod -Credential $Credential -AllowUnencryptedAuthentication -Uri http://192.168.3.104:8080/api/service/cronn

Invoke-RestMethod: Bad Request (service cronn could not be found)

```



In case your login or password is incorrect, you will receive the following message.



**401. Unauthorized**:



```PowerShell

Invoke-RestMethod: Unauthorized (login or password is invalid)

```



**404. Not Found endpoint**:



```PowerShell

PS C:\Users\Lifailon> Invoke-RestMethod -Credential $Credential -AllowUnencryptedAuthentication -Uri http://192.168.3.104:8080/api

Invoke-RestMethod: Not Found endpoint

```



**405. Method Not Allowed**:



```PowerShell

PS C:\Users\Lifailon> Invoke-RestMethod -Credential $Credential -AllowUnencryptedAuthentication -Uri http://192.168.3.104:8080/api/service/cron -Method Put -Headers @{"Status" = "Restart"} | fl   

Invoke-RestMethod: Method Not Allowed

```