spawn/vultr/lib/common.sh
A b0f924b511
fix: Prevent Python/shell injection via env vars and triple-quote strings (#102)
- Fix triple-quote injection in SSH keys (Scaleway, UpCloud), userdata
  (BinaryLane), init scripts (Civo, Kamatera), and GraphQL queries
  (RunPod) by passing data via stdin/json_escape instead of inline
  string interpolation
- Add input validation for all cloud provider env vars (region, type,
  plan, etc.) using validate_region_name/validate_resource_name to block
  shell metacharacters before they reach Python string interpolation
- Validate Modal image name as Python identifier to prevent code injection
- Validate numeric env vars (RAM, GPU count, disk size) across all providers

Affects: 19 cloud provider lib/common.sh files
Agent: security-auditor

Co-authored-by: A <6723574+louisgv@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-02-09 10:22:39 -08:00

264 lines
8.6 KiB
Bash
Executable file

#!/bin/bash
# Common bash functions for Vultr spawn scripts
# Bash safety flags
set -eo pipefail
# ============================================================
# Provider-agnostic functions
# ============================================================
# Source shared provider-agnostic functions (local or remote fallback)
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" 2>/dev/null && pwd)"
if [[ -n "$SCRIPT_DIR" && -f "$SCRIPT_DIR/../../shared/common.sh" ]]; then
source "$SCRIPT_DIR/../../shared/common.sh"
else
eval "$(curl -fsSL https://raw.githubusercontent.com/OpenRouterTeam/spawn/main/shared/common.sh)"
fi
# Note: Provider-agnostic functions (logging, OAuth, browser, nc_listen) are now in shared/common.sh
# ============================================================
# Vultr specific functions
# ============================================================
readonly VULTR_API_BASE="https://api.vultr.com/v2"
# SSH_OPTS is now defined in shared/common.sh
# Configurable timeout/delay constants
INSTANCE_STATUS_POLL_DELAY=${INSTANCE_STATUS_POLL_DELAY:-5} # Delay between instance status checks
vultr_api() {
local method="$1"
local endpoint="$2"
local body="${3:-}"
generic_cloud_api "$VULTR_API_BASE" "$VULTR_API_KEY" "$method" "$endpoint" "$body"
}
test_vultr_token() {
local response
response=$(vultr_api GET "/account")
if echo "$response" | grep -q '"account"'; then
log_info "API key validated"
return 0
else
local error_msg
error_msg=$(echo "$response" | python3 -c "import json,sys; d=json.loads(sys.stdin.read()); print(d.get('error','No details available'))" 2>/dev/null || echo "Unable to parse error")
log_error "API Error: $error_msg"
log_warn "Remediation steps:"
log_warn " 1. Verify API key at: https://my.vultr.com/settings/#settingsapi"
log_warn " 2. Ensure the key has appropriate permissions"
log_warn " 3. Check key hasn't been revoked"
return 1
fi
}
ensure_vultr_token() {
ensure_api_token_with_provider \
"Vultr" \
"VULTR_API_KEY" \
"$HOME/.config/spawn/vultr.json" \
"https://my.vultr.com/settings/#settingsapi" \
"test_vultr_token"
}
# Check if SSH key is registered with Vultr
vultr_check_ssh_key() {
local fingerprint="$1"
local existing_keys
existing_keys=$(vultr_api GET "/ssh-keys")
echo "$existing_keys" | grep -q "$fingerprint"
}
# Register SSH key with Vultr
vultr_register_ssh_key() {
local key_name="$1"
local pub_path="$2"
local pub_key
pub_key=$(cat "$pub_path")
local json_pub_key
json_pub_key=$(json_escape "$pub_key")
local register_body="{\"name\":\"$key_name\",\"ssh_key\":$json_pub_key}"
local register_response
register_response=$(vultr_api POST "/ssh-keys" "$register_body")
if echo "$register_response" | grep -q '"ssh_key"'; then
return 0
else
# Parse error details
local error_msg
error_msg=$(echo "$register_response" | python3 -c "import json,sys; d=json.loads(sys.stdin.read()); print(d.get('error','Unknown error'))" 2>/dev/null || echo "$register_response")
log_error "API Error: $error_msg"
log_warn "Common causes:"
log_warn " - SSH key already registered with this name"
log_warn " - Invalid SSH key format (must be valid ed25519 public key)"
log_warn " - API key lacks write permissions"
return 1
fi
}
ensure_ssh_key() {
ensure_ssh_key_with_provider vultr_check_ssh_key vultr_register_ssh_key "Vultr"
}
get_server_name() {
local server_name
server_name=$(get_resource_name "VULTR_SERVER_NAME" "Enter server name: ") || return 1
if ! validate_server_name "$server_name"; then
return 1
fi
echo "$server_name"
}
# get_cloud_init_userdata is now defined in shared/common.sh
create_server() {
local name="$1"
local plan="${VULTR_PLAN:-vc2-1c-2gb}"
local region="${VULTR_REGION:-ewr}"
# Ubuntu 24.04 x64 OS ID
local os_id="${VULTR_OS_ID:-2284}"
# Validate env var inputs to prevent injection into Python code
validate_resource_name "$plan" || { log_error "Invalid VULTR_PLAN"; return 1; }
validate_region_name "$region" || { log_error "Invalid VULTR_REGION"; return 1; }
if [[ ! "$os_id" =~ ^[0-9]+$ ]]; then log_error "Invalid VULTR_OS_ID: must be numeric"; return 1; fi
log_warn "Creating Vultr instance '$name' (plan: $plan, region: $region)..."
# Get all SSH key IDs
local ssh_keys_response
ssh_keys_response=$(vultr_api GET "/ssh-keys")
local ssh_key_ids
ssh_key_ids=$(extract_ssh_key_ids "$ssh_keys_response" "ssh_keys")
local userdata
userdata=$(get_cloud_init_userdata)
local userdata_b64
userdata_b64=$(echo "$userdata" | base64 -w0 2>/dev/null || echo "$userdata" | base64)
local body
body=$(python3 -c "
import json
body = {
'label': '$name',
'hostname': '$name',
'region': '$region',
'plan': '$plan',
'os_id': $os_id,
'sshkey_id': $ssh_key_ids,
'user_data': '$userdata_b64',
'backups': 'disabled'
}
print(json.dumps(body))
")
local response
response=$(vultr_api POST "/instances" "$body")
if echo "$response" | grep -q '"instance"'; then
VULTR_SERVER_ID=$(echo "$response" | python3 -c "import json,sys; print(json.loads(sys.stdin.read())['instance']['id'])")
export VULTR_SERVER_ID
log_info "Instance created: ID=$VULTR_SERVER_ID"
else
log_error "Failed to create Vultr instance"
# Parse error details
local error_msg
error_msg=$(echo "$response" | python3 -c "import json,sys; d=json.loads(sys.stdin.read()); print(d.get('error','Unknown error'))" 2>/dev/null || echo "$response")
log_error "API Error: $error_msg"
log_warn "Common issues:"
log_warn " - Insufficient account balance"
log_warn " - Plan/region unavailable (try different VULTR_PLAN or VULTR_REGION)"
log_warn " - Instance limit reached"
log_warn " - Invalid cloud-init userdata"
log_warn "Remediation: Check https://my.vultr.com/"
return 1
fi
# Wait for instance to get an IP
log_warn "Waiting for instance to become active..."
local max_attempts=60
local attempt=1
while [[ "$attempt" -le "$max_attempts" ]]; do
local status_response
status_response=$(vultr_api GET "/instances/$VULTR_SERVER_ID")
local status
status=$(echo "$status_response" | python3 -c "import json,sys; print(json.loads(sys.stdin.read())['instance']['status'])")
local power
power=$(echo "$status_response" | python3 -c "import json,sys; print(json.loads(sys.stdin.read())['instance']['power_status'])")
if [[ "$status" == "active" && "$power" == "running" ]]; then
VULTR_SERVER_IP=$(echo "$status_response" | python3 -c "import json,sys; print(json.loads(sys.stdin.read())['instance']['main_ip'])")
export VULTR_SERVER_IP
log_info "Instance active: IP=$VULTR_SERVER_IP"
return 0
fi
log_warn "Instance status: $status/$power ($attempt/$max_attempts)"
sleep "${INSTANCE_STATUS_POLL_DELAY}"
((attempt++))
done
log_error "Instance did not become active in time"
return 1
}
verify_server_connectivity() {
local ip="$1"
local max_attempts=${2:-30}
# SSH_OPTS is defined in shared/common.sh
# shellcheck disable=SC2154
generic_ssh_wait "root" "$ip" "$SSH_OPTS -o ConnectTimeout=5" "echo ok" "SSH connectivity" "$max_attempts" 5
}
run_server() {
local ip="$1"; local cmd="$2"
# shellcheck disable=SC2086
ssh $SSH_OPTS "root@$ip" "$cmd"
}
upload_file() {
local ip="$1"; local local_path="$2"; local remote_path="$3"
# shellcheck disable=SC2086
scp $SSH_OPTS "$local_path" "root@$ip:$remote_path"
}
interactive_session() {
local ip="$1"; local cmd="$2"
ssh -t $SSH_OPTS "root@$ip" "$cmd"
}
destroy_server() {
local server_id="$1"
log_warn "Destroying instance $server_id..."
vultr_api DELETE "/instances/$server_id"
log_info "Instance $server_id destroyed"
}
list_servers() {
local response
response=$(vultr_api GET "/instances")
python3 -c "
import json, sys
data = json.loads(sys.stdin.read())
instances = data.get('instances', [])
if not instances:
print('No instances found')
sys.exit(0)
print(f\"{'LABEL':<25} {'ID':<40} {'STATUS':<12} {'IP':<16} {'PLAN':<15}\")
print('-' * 108)
for i in instances:
label = i.get('label', 'N/A')
iid = i['id']
status = i['status']
ip = i.get('main_ip', 'N/A')
plan = i['plan']
print(f'{label:<25} {iid:<40} {status:<12} {ip:<16} {plan:<15}')
" <<< "$response"
}