mirror of
https://github.com/0x1d/rcond.git
synced 2025-12-14 10:16:50 +01:00
c2b483d20d060674be154209b86253fe576a785b
rcond
A simple daemon and REST API to manage:
- network connections through NetworkManager's D-Bus interface
- system hostname through the hostname1 service
- authorized SSH keys through the user's authorized_keys file
Requirements
- Make
- Go 1.19 or later
- NetworkManager
- systemd
- Linux operating system
Installation
In order to install rcondas a systemd service, you need to specify the target architecture and then run the build and install make targets.
export ARCH=arm64
make build
make install
Build and Run
make build
make run
Develop
make dev
Configuration
File
The default config file location is /etc/rcond/config.yaml.
It can be overwritten by environment variables and flags.
An full example configuration with comments can be found in config/rcond.yaml
Example configuration:
rcond:
addr: 0.0.0.0:8080
api_token: 1234567890
Environment Variables
| Environment Variable | Description | Default |
|---|---|---|
| RCOND_ADDR | Address to bind the HTTP server to. | 0.0.0.0:8080 |
| RCOND_API_TOKEN | API token to use for authentication. | N/A |
API
The full API specification can be found in api/rcond.yaml.
Authentication
All endpoints except /health require authentication via an API token passed in the X-API-Token header. The token is configured via the RCOND_API_TOKEN environment variable when starting the daemon.
Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /health |
Health check endpoint |
| POST | /network/ap |
Create and activate a WiFi access point |
| PUT | /network/interface/{interface} |
Activate a connection |
| DELETE | /network/interface/{interface} |
Deactivate a connection |
| DELETE | /network/connection/{uuid} |
Remove a connection |
| GET | /hostname |
Get the hostname |
| POST | /hostname |
Set the hostname |
| POST | /users/{user}/keys |
Add an authorized SSH key |
| DELETE | /users/{user}/keys/{fingerprint} |
Remove an authorized SSH key |
Response Codes
- 200: Success
- 400: Bad request (invalid JSON payload)
- 405: Method not allowed
- 500: Internal server error
Request/Response Format
All endpoints use JSON for request and response payloads.
Examples
Setup an Access Point
#!/usr/bin/env bash
set -euo pipefail
# Example script to create and activate a WiFi access point
# Requires:
# - RCOND_ADDR (default: http://0.0.0.0:8080)
# - RCOND_API_TOKEN (your API token)
API_URL="${RCOND_ADDR:-http://0.0.0.0:8080}"
API_TOKEN="${RCOND_API_TOKEN:-your_api_token}"
INTERFACE="wlan0"
SSID="MyAccessPoint"
PASSWORD="StrongPassword"
echo "Creating access point '$SSID' on interface '$INTERFACE'..."
ap_response=$(curl -sSf -X POST "$API_URL/network/ap" \
-H "Content-Type: application/json" \
-H "X-API-Token: $API_TOKEN" \
-d '{
"interface": "'"$INTERFACE"'",
"ssid": "'"$SSID"'",
"password": "'"$PASSWORD"'"
}')
# Extract the UUID from the JSON response
AP_UUID=$(echo "$ap_response" | jq -r '.uuid')
echo "Activating connection with UUID '$AP_UUID' on interface '$INTERFACE'..."
curl -sSf -X PUT "$API_URL/network/interface/$INTERFACE" \
-H "Content-Type: application/json" \
-H "X-API-Token: $API_TOKEN" \
-d '{
"uuid": "'"$AP_UUID"'"
}'
echo "Access point '$SSID' is now up and running on $INTERFACE."
Description
Languages
Go
96.8%
Makefile
3.2%