[people/pmueller/ipfire-2.x.git] / src / initscripts / helper / gcp-setup

#!/bin/bash
###############################################################################
#                                                                             #
# IPFire.org - A linux based firewall                                         #
# Copyright (C) 2007-2022  IPFire Team  <info@ipfire.org>                     #
#                                                                             #
# This program is free software: you can redistribute it and/or modify        #
# it under the terms of the GNU General Public License as published by        #
# the Free Software Foundation, either version 3 of the License, or           #
# (at your option) any later version.                                         #
#                                                                             #
# This program is distributed in the hope that it will be useful,             #
# but WITHOUT ANY WARRANTY; without even the implied warranty of              #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               #
# GNU General Public License for more details.                                #
#                                                                             #
# You should have received a copy of the GNU General Public License           #
# along with this program.  If not, see <http://www.gnu.org/licenses/>.       #
#                                                                             #
###############################################################################

. /etc/sysconfig/rc
. ${rc_functions}

# Set PATH to find our own executables
export PATH=/usr/local/sbin:/usr/local/bin:${PATH}

# GCP only supports an MTU of 1460
DEFAULT_MTU=1460

get() {
	local file="${1}"

	wget --header="Metadata-Flavor: Google" -qO - "http://169.254.169.254/computeMetadata/v1/${file}"
}

to_address() {
	local n="${1}"

	local o1=$(( (n & 0xff000000) >> 24 ))
	local o2=$(( (n & 0xff0000) >> 16 ))
	local o3=$(( (n & 0xff00) >> 8 ))
	local o4=$(( (n & 0xff) ))

	printf "%d.%d.%d.%d\n" "${o1}" "${o2}" "${o3}" "${o4}"
}

to_integer() {
	local address="${1}"

	local integer=0

	local i
	for i in ${address//\./ }; do
		integer=$(( (integer << 8) + i ))
	done

	printf "%d\n" "${integer}"
}

prefix2netmask() {
	local prefix=${1}

	local zeros=$(( 32 - prefix ))
	local netmask=0

	local i
	for (( i=0; i<${zeros}; i++ )); do
		netmask=$(( (netmask << 1) ^ 1 ))
	done

	to_address "$(( netmask ^ 0xffffffff ))"
}

import_gcp_configuration() {
	local instance_id="$(get instance/id)"

	boot_mesg "Importing Google Compute Platform configuration for instance ${instance_id}..."

	# Store instance ID
	echo "${instance_id}" > /var/run/gcp-instance-id

	# Initialise system settings
	local hostname=$(get instance/hostname)

	# Set hostname
	if ! grep -q "^HOSTNAME=" /var/ipfire/main/settings; then
		echo "HOSTNAME=${hostname%%.*}" >> /var/ipfire/main/settings
	fi

	# Set domainname
	if ! grep -q "^DOMAINNAME=" /var/ipfire/main/settings; then
		echo "DOMAINNAME=${hostname#*.}" >> /var/ipfire/main/settings
	fi

	# Create setup user
	if ! getent passwd setup &>/dev/null; then
		useradd setup -s /usr/bin/run-setup -g nobody -m

		# Unlock the account
		usermod -p "x" setup
	fi

	# Import SSH keys for setup user
	local line
	while read -r line; do
		# Strip the username part from the key
		local key="${line#*:}"

		if [ -n "${key}" ] && ! grep -q "^${key}$" "/home/setup/.ssh/authorized_keys" 2>/dev/null; then
			mkdir -p "/home/setup/.ssh"
			chmod 700 "/home/setup/.ssh"
			chown setup.nobody "/home/setup/.ssh"

			echo "${key}" >> "/home/setup/.ssh/authorized_keys"
			chmod 600 "/home/setup/.ssh/authorized_keys"
			chown setup.nobody "/home/setup/.ssh/authorized_keys"
		fi
	done <<<"$(get instance/attributes/ssh-keys)"

	# Import network configuration
	# After this, no network connectivity will be available from this script due to the
	# renaming of the network interfaces for which they have to be shut down
	local config_type=1
	: > /var/ipfire/ethernet/settings

	local device_number
	for device_number in $(get instance/network-interfaces/); do
		# Remove trailing slash
		device_number="${device_number//\//}"

		local mac="$(get "instance/network-interfaces/${device_number}/mac")"

		# XXX TODO read the MTU because Google seems to only support 1460

		# First IPv4 address
		local ipv4_address="$(get "instance/network-interfaces/${device_number}/ip")"
		local ipv4_address_num="$(to_integer "${ipv4_address}")"

		local netmask="$(get "instance/network-interfaces/${device_number}/subnetmask")"
		local netmask_num="$(to_integer "${netmask}")"

		# Calculate the network and broadcast addresses
		local netaddress="$(to_address $(( ipv4_address_num & netmask_num )))"

		case "${device_number}" in
			# RED
			0)
				local interface_name="red0"
				local gateway="$(get instance/network-interfaces/${device_number}/gateway)"

				(
					echo "RED_TYPE=STATIC"
					echo "RED_DEV=${interface_name}"
					echo "RED_MACADDR=${mac}"
					echo "RED_DESCRIPTION='${interface_id}'"
					echo "RED_ADDRESS=${ipv4_address}"
					echo "RED_NETMASK=${netmask}"
					echo "RED_NETADDRESS=${netaddress}"
					echo "RED_MTU=${DEFAULT_MTU}"
					echo "DEFAULT_GATEWAY=${gateway}"
				) >> /var/ipfire/ethernet/settings

				# Import aliases for RED
				for alias in $(get "instance/network-interfaces/${device_number}/ip-aliases"); do
					echo "${alias},on,"
				done > /var/ipfire/ethernet/aliases
				;;

			# GREEN
			1)
				local interface_name="green0"

				(
					echo "GREEN_DEV=${interface_name}"
					echo "GREEN_MACADDR=${mac}"
					echo "GREEN_DESCRIPTION='${interface_id}'"
					echo "GREEN_ADDRESS=${ipv4_address}"
					echo "GREEN_NETMASK=${netmask}"
					echo "GREEN_NETADDRESS=${netaddress}"
					echo "GREEN_MTU=${DEFAULT_MTU}"
				) >> /var/ipfire/ethernet/settings
				;;

			# ORANGE
			2)
				local interface_name="orange0"
				config_type=2

				(
					echo "ORANGE_DEV=${interface_name}"
					echo "ORANGE_MACADDR=${mac}"
					echo "ORANGE_DESCRIPTION='${interface_id}'"
					echo "ORANGE_ADDRESS=${ipv4_address}"
					echo "ORANGE_NETMASK=${netmask}"
					echo "ORANGE_NETADDRESS=${netaddress}"
					echo "ORANGE_MTU=${DEFAULT_MTU}"
				) >> /var/ipfire/ethernet/settings
				;;
		esac
	done

	# Save CONFIG_TYPE
	echo "CONFIG_TYPE=${config_type}" >> /var/ipfire/ethernet/settings

	# Actions performed only on the very first start
	if [ ! -e "/var/ipfire/main/firstsetup_ok" ]; then
		# Disable using ISP nameservers
		sed -e "s/^USE_ISP_NAMESERVERS=.*/USE_ISP_NAMESERVERS=off/" -i /var/ipfire/dns/settings

		# Enable SSH
		sed -e "s/ENABLE_SSH=.*/ENABLE_SSH=on/g" -i /var/ipfire/remote/settings

		# Disable SSH password authentication
		sed -e "s/^ENABLE_SSH_PASSWORDS=.*/ENABLE_SSH_PASSWORDS=off/" -i /var/ipfire/remote/settings

		# Enable SSH key authentication
		sed -e "s/^ENABLE_SSH_KEYS=.*/ENABLE_SSH_KEYS=on/" -i /var/ipfire/remote/settings

		# Apply SSH settings
		/usr/local/bin/sshctrl

		# Mark SSH to start immediately (but not right now)
		touch /var/ipfire/remote/enablessh
		chown nobody:nobody /var/ipfire/remote/enablessh

		# Firewall rules for SSH and WEBIF
		(
			echo "1,ACCEPT,INPUTFW,ON,std_net_src,ALL,ipfire,RED1,,TCP,,,ON,,,cust_srv,SSH,,,,,,,,,,,00:00,00:00,,AUTO,,dnat,,,,,second"
			echo "2,ACCEPT,INPUTFW,ON,std_net_src,ALL,ipfire,RED1,,TCP,,,ON,,,TGT_PORT,444,,,,,,,,,,,00:00,00:00,,AUTO,,dnat,,,,,second"
		) >> /var/ipfire/firewall/input

		# Download a startup script
		local script="$(get instance/attributes/startup-script)"

		# Execute the script
		if [ "${script:0:2}" = "#!" ]; then
			echo "${script}" > /tmp/gcp-startup.script
			chmod 700 /tmp/gcp-startup.script

			# Run the script
			local now="$(date -u +"%s")"
			/tmp/gcp-startup.script &>/var/log/startup-script.log.${now}

			# Delete the script right away
			rm /tmp/gcp-startup.script
		fi

		# This script has now completed the first steps of setup
		touch /var/ipfire/main/firstsetup_ok
	fi

	# All done
	echo_ok
}

case "${reason}" in
	PREINIT)
		# Bring up the interface
		ip link set "${interface}" up
		;;

	BOUND|RENEW|REBIND|REBOOT)
		# Remove any previous IP addresses
		ip addr flush dev "${interface}"

		# Add (or re-add) the new IP address
		ip addr add "${new_ip_address}/${new_subnet_mask}" dev "${interface}"

		# Add the default route
		ip route add "${new_routers}" dev "${interface}"
		ip route add default via "${new_routers}"

		# Setup DNS
		for domain_name_server in ${new_domain_name_servers}; do
			echo "nameserver ${domain_name_server}"
		done > /etc/resolv.conf

		# The system is online now
		touch /var/ipfire/red/active

		# Import GCP configuration
		import_gcp_configuration
		;;

	EXPIRE|FAIL|RELEASE|STOP)
		# The system is no longer online
		rm -f /var/ipfire/red/active

		# Remove all IP addresses
		ip addr flush dev "${interface}"

		# Shut down the interface
		ip link set "${interface}" down
		;;

	*)
		echo "Unhandled reason: ${reason}" >&2
		exit 2
		;;
esac

# Terminate
exit 0
Commit	Line	Data
89b10e70	1	#!/bin/bash
66c36198 PM	2	###############################################################################
	3	# #
	4	# IPFire.org - A linux based firewall #
	5	# Copyright (C) 2007-2022 IPFire Team <info@ipfire.org> #
	6	# #
	7	# This program is free software: you can redistribute it and/or modify #
	8	# it under the terms of the GNU General Public License as published by #
	9	# the Free Software Foundation, either version 3 of the License, or #
	10	# (at your option) any later version. #
	11	# #
	12	# This program is distributed in the hope that it will be useful, #
	13	# but WITHOUT ANY WARRANTY; without even the implied warranty of #
	14	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
	15	# GNU General Public License for more details. #
	16	# #
	17	# You should have received a copy of the GNU General Public License #
	18	# along with this program. If not, see <http://www.gnu.org/licenses/>. #
	19	# #
	20	###############################################################################
89b10e70 MT	21
	22	. /etc/sysconfig/rc
	23	. ${rc_functions}
	24
	25	# Set PATH to find our own executables
	26	export PATH=/usr/local/sbin:/usr/local/bin:${PATH}
	27
bf1ae6aa MT	28	# GCP only supports an MTU of 1460
	29	DEFAULT_MTU=1460
	30
89b10e70 MT	31	get() {
	32	local file="${1}"
	33
	34	wget --header="Metadata-Flavor: Google" -qO - "http://169.254.169.254/computeMetadata/v1/${file}"
	35	}
	36
	37	to_address() {
	38	local n="${1}"
	39
	40	local o1=$(( (n & 0xff000000) >> 24 ))
	41	local o2=$(( (n & 0xff0000) >> 16 ))
	42	local o3=$(( (n & 0xff00) >> 8 ))
	43	local o4=$(( (n & 0xff) ))
	44
	45	printf "%d.%d.%d.%d\n" "${o1}" "${o2}" "${o3}" "${o4}"
	46	}
	47
	48	to_integer() {
	49	local address="${1}"
	50
	51	local integer=0
	52
	53	local i
	54	for i in ${address//\./ }; do
	55	integer=$(( (integer << 8) + i ))
	56	done
	57
	58	printf "%d\n" "${integer}"
	59	}
	60
	61	prefix2netmask() {
	62	local prefix=${1}
	63
	64	local zeros=$(( 32 - prefix ))
	65	local netmask=0
	66
	67	local i
	68	for (( i=0; i<${zeros}; i++ )); do
	69	netmask=$(( (netmask << 1) ^ 1 ))
	70	done
	71
	72	to_address "$(( netmask ^ 0xffffffff ))"
	73	}
	74
	75	import_gcp_configuration() {
	76	local instance_id="$(get instance/id)"
	77
	78	boot_mesg "Importing Google Compute Platform configuration for instance ${instance_id}..."
	79
	80	# Store instance ID
	81	echo "${instance_id}" > /var/run/gcp-instance-id
	82
	83	# Initialise system settings
	84	local hostname=$(get instance/hostname)
	85
	86	# Set hostname
	87	if ! grep -q "^HOSTNAME=" /var/ipfire/main/settings; then
	88	echo "HOSTNAME=${hostname%%.*}" >> /var/ipfire/main/settings
	89	fi
	90
	91	# Set domainname
	92	if ! grep -q "^DOMAINNAME=" /var/ipfire/main/settings; then
	93	echo "DOMAINNAME=${hostname#*.}" >> /var/ipfire/main/settings
	94	fi
95
96	# Create setup user
97	if ! getent passwd setup &>/dev/null; then
98	useradd setup -s /usr/bin/run-setup -g nobody -m
99
100	# Unlock the account
101	usermod -p "x" setup
102	fi
103
104	# Import SSH keys for setup user
105	local line
106	while read -r line; do
107	# Strip the username part from the key
108	local key="${line#*:}"
109
110	if [ -n "${key}" ] && ! grep -q "^${key}$" "/home/setup/.ssh/authorized_keys" 2>/dev/null; then
111	mkdir -p "/home/setup/.ssh"
112	chmod 700 "/home/setup/.ssh"
113	chown setup.nobody "/home/setup/.ssh"
114
115	echo "${key}" >> "/home/setup/.ssh/authorized_keys"
116	chmod 600 "/home/setup/.ssh/authorized_keys"
117	chown setup.nobody "/home/setup/.ssh/authorized_keys"
118	fi
119	done <<<"$(get instance/attributes/ssh-keys)"
120
89b10e70 MT	121	# Import network configuration
	122	# After this, no network connectivity will be available from this script due to the
	123	# renaming of the network interfaces for which they have to be shut down
	124	local config_type=1
	125	: > /var/ipfire/ethernet/settings
	126
	127	local device_number
	128	for device_number in $(get instance/network-interfaces/); do
	129	# Remove trailing slash
	130	device_number="${device_number//\//}"
	131
	132	local mac="$(get "instance/network-interfaces/${device_number}/mac")"
	133
	134	# XXX TODO read the MTU because Google seems to only support 1460
	135
	136	# First IPv4 address
	137	local ipv4_address="$(get "instance/network-interfaces/${device_number}/ip")"
	138	local ipv4_address_num="$(to_integer "${ipv4_address}")"
	139
	140	local netmask="$(get "instance/network-interfaces/${device_number}/subnetmask")"
	141	local netmask_num="$(to_integer "${netmask}")"
	142
	143	# Calculate the network and broadcast addresses
	144	local netaddress="$(to_address $(( ipv4_address_num & netmask_num )))"
89b10e70 MT	145
	146	case "${device_number}" in
	147	# RED
	148	0)
	149	local interface_name="red0"
	150	local gateway="$(get instance/network-interfaces/${device_number}/gateway)"
	151
	152	(
	153	echo "RED_TYPE=STATIC"
	154	echo "RED_DEV=${interface_name}"
	155	echo "RED_MACADDR=${mac}"
	156	echo "RED_DESCRIPTION='${interface_id}'"
	157	echo "RED_ADDRESS=${ipv4_address}"
	158	echo "RED_NETMASK=${netmask}"
	159	echo "RED_NETADDRESS=${netaddress}"
bf1ae6aa	160	echo "RED_MTU=${DEFAULT_MTU}"
89b10e70 MT	161	echo "DEFAULT_GATEWAY=${gateway}"
	162	) >> /var/ipfire/ethernet/settings
	163
	164	# Import aliases for RED
	165	for alias in $(get "instance/network-interfaces/${device_number}/ip-aliases"); do
	166	echo "${alias},on,"
	167	done > /var/ipfire/ethernet/aliases
	168	;;
	169
	170	# GREEN
	171	1)
	172	local interface_name="green0"
	173
	174	(
	175	echo "GREEN_DEV=${interface_name}"
	176	echo "GREEN_MACADDR=${mac}"
	177	echo "GREEN_DESCRIPTION='${interface_id}'"
	178	echo "GREEN_ADDRESS=${ipv4_address}"
	179	echo "GREEN_NETMASK=${netmask}"
	180	echo "GREEN_NETADDRESS=${netaddress}"
bf1ae6aa	181	echo "GREEN_MTU=${DEFAULT_MTU}"
89b10e70 MT	182	) >> /var/ipfire/ethernet/settings
	183	;;
	184
	185	# ORANGE
	186	2)
	187	local interface_name="orange0"
	188	config_type=2
	189
	190	(
	191	echo "ORANGE_DEV=${interface_name}"
	192	echo "ORANGE_MACADDR=${mac}"
	193	echo "ORANGE_DESCRIPTION='${interface_id}'"
	194	echo "ORANGE_ADDRESS=${ipv4_address}"
	195	echo "ORANGE_NETMASK=${netmask}"
	196	echo "ORANGE_NETADDRESS=${netaddress}"
bf1ae6aa	197	echo "ORANGE_MTU=${DEFAULT_MTU}"
89b10e70 MT	198	) >> /var/ipfire/ethernet/settings
	199	;;
	200	esac
	201	done
	202
	203	# Save CONFIG_TYPE
	204	echo "CONFIG_TYPE=${config_type}" >> /var/ipfire/ethernet/settings
	205
	206	# Actions performed only on the very first start
	207	if [ ! -e "/var/ipfire/main/firstsetup_ok" ]; then
	208	# Disable using ISP nameservers
	209	sed -e "s/^USE_ISP_NAMESERVERS=.*/USE_ISP_NAMESERVERS=off/" -i /var/ipfire/dns/settings
	210
	211	# Enable SSH
	212	sed -e "s/ENABLE_SSH=.*/ENABLE_SSH=on/g" -i /var/ipfire/remote/settings
	213
	214	# Disable SSH password authentication
	215	sed -e "s/^ENABLE_SSH_PASSWORDS=.*/ENABLE_SSH_PASSWORDS=off/" -i /var/ipfire/remote/settings
	216
	217	# Enable SSH key authentication
	218	sed -e "s/^ENABLE_SSH_KEYS=.*/ENABLE_SSH_KEYS=on/" -i /var/ipfire/remote/settings
	219
	220	# Apply SSH settings
	221	/usr/local/bin/sshctrl
	222
	223	# Mark SSH to start immediately (but not right now)
	224	touch /var/ipfire/remote/enablessh
	225	chown nobody:nobody /var/ipfire/remote/enablessh
	226
	227	# Firewall rules for SSH and WEBIF
	228	(
	229	echo "1,ACCEPT,INPUTFW,ON,std_net_src,ALL,ipfire,RED1,,TCP,,,ON,,,cust_srv,SSH,,,,,,,,,,,00:00,00:00,,AUTO,,dnat,,,,,second"
	230	echo "2,ACCEPT,INPUTFW,ON,std_net_src,ALL,ipfire,RED1,,TCP,,,ON,,,TGT_PORT,444,,,,,,,,,,,00:00,00:00,,AUTO,,dnat,,,,,second"
	231	) >> /var/ipfire/firewall/input
	232
9e413732 MT	233	# Download a startup script
	234	local script="$(get instance/attributes/startup-script)"
	235
	236	# Execute the script
	237	if [ "${script:0:2}" = "#!" ]; then
	238	echo "${script}" > /tmp/gcp-startup.script
	239	chmod 700 /tmp/gcp-startup.script
	240
	241	# Run the script
	242	local now="$(date -u +"%s")"
	243	/tmp/gcp-startup.script &>/var/log/startup-script.log.${now}
	244
	245	# Delete the script right away
	246	rm /tmp/gcp-startup.script
	247	fi
	248
89b10e70 MT	249	# This script has now completed the first steps of setup
	250	touch /var/ipfire/main/firstsetup_ok
	251	fi
	252
	253	# All done
	254	echo_ok
	255	}
	256
	257	case "${reason}" in
	258	PREINIT)
	259	# Bring up the interface
	260	ip link set "${interface}" up
	261	;;
	262
	263	BOUND\|RENEW\|REBIND\|REBOOT)
	264	# Remove any previous IP addresses
	265	ip addr flush dev "${interface}"
	266
	267	# Add (or re-add) the new IP address
	268	ip addr add "${new_ip_address}/${new_subnet_mask}" dev "${interface}"
	269
	270	# Add the default route
b6a58881	271	ip route add "${new_routers}" dev "${interface}"
89b10e70 MT	272	ip route add default via "${new_routers}"
	273
	274	# Setup DNS
	275	for domain_name_server in ${new_domain_name_servers}; do
	276	echo "nameserver ${domain_name_server}"
	277	done > /etc/resolv.conf
	278
	279	# The system is online now
	280	touch /var/ipfire/red/active
	281
	282	# Import GCP configuration
	283	import_gcp_configuration
	284	;;
	285
	286	EXPIRE\|FAIL\|RELEASE\|STOP)
	287	# The system is no longer online
	288	rm -f /var/ipfire/red/active
	289
	290	# Remove all IP addresses
	291	ip addr flush dev "${interface}"
	292
	293	# Shut down the interface
	294	ip link set "${interface}" down
	295	;;
	296
	297	*)
	298	echo "Unhandled reason: ${reason}" >&2
	299	exit 2
	300	;;
	301	esac
	302
	303	# Terminate
	304	exit 0