freedombone-image 12KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452
  1. #!/bin/bash
  2. #
  3. # .---. . .
  4. # | | |
  5. # |--- .--. .-. .-. .-.| .-. .--.--. |.-. .-. .--. .-.
  6. # | | (.-' (.-' ( | ( )| | | | )( )| | (.-'
  7. # ' ' --' --' -' - -' ' ' -' -' -' ' - --'
  8. #
  9. # Freedom in the Cloud
  10. #
  11. # Creates a debian image using vmdebootstrap
  12. #
  13. # License
  14. # =======
  15. #
  16. # Copyright (C) 2015-2016 Bob Mottram <bob@robotics.uk.to>
  17. #
  18. # This program is free software: you can redistribute it and/or modify
  19. # it under the terms of the GNU Affero General Public License as published by
  20. # the Free Software Foundation, either version 3 of the License, or
  21. # (at your option) any later version.
  22. #
  23. # This program is distributed in the hope that it will be useful,
  24. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  25. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  26. # GNU Affero General Public License for more details.
  27. #
  28. # You should have received a copy of the GNU Affero General Public License
  29. # along with this program. If not, see <http://www.gnu.org/licenses/>.
  30. PROJECT_NAME='freedombone'
  31. export TEXTDOMAIN=${PROJECT_NAME}-image
  32. export TEXTDOMAINDIR="/usr/share/locale"
  33. PROJECT_REPO="https://github.com/bashrc/${PROJECT_NAME}"
  34. # recommended RAM for virtual machines
  35. VM_MEMORY='1G'
  36. VARIANT='full'
  37. # fixed username and password when the --generic option is used
  38. GENERIC_IMAGE_USERNAME='fbone'
  39. GENERIC_IMAGE_PASSWORD='freedombone'
  40. IMAGE_TYPE='beaglebone'
  41. CURR_DIR=$(pwd)
  42. CURR_USER=$(echo $USER)
  43. TEMPBUILD_DIR=~/.tmp_${PROJECT_NAME}_build
  44. VMDEBOOTSTRAP_REPO=git://git.liw.fi/vmdebootstrap
  45. VMDEBOOTSTRAP_VERSION=0.8
  46. MAKEFILE=${PROJECT_NAME}-image-makefile
  47. IMAGE_SIZE=8G
  48. IMAGE_NAME='full'
  49. USERNAME=$(echo $USER)
  50. PASSWORD=
  51. # IP address of the router (gateway)
  52. ROUTER_IP_ADDRESS="192.168.1.254"
  53. # The fixed IP address of the Beaglebone Black (or other SBC) on your local network
  54. BOX_IP_ADDRESS="192.168.1.55"
  55. # DNS
  56. NAMESERVER1='213.73.91.35'
  57. NAMESERVER2='85.214.20.141'
  58. # An optional freedombone configuration file
  59. CONFIG_FILENAME=
  60. DEFAULT_DOMAIN_NAME="${PROJECT_NAME}.local"
  61. # Minimum number of characters in a password
  62. MINIMUM_PASSWORD_LENGTH=10
  63. # Optional ssh public key to allow
  64. SSH_PUBKEY="no"
  65. # interactive mode
  66. INTERACTIVE="no"
  67. # Whether this is a generic image for mass redistribution on the interwebs
  68. GENERIC_IMAGE="yes"
  69. # Whether to reduce the number of decisions during interactive install
  70. MINIMAL_INSTALL="yes"
  71. # default SSH port
  72. SSH_PORT=2222
  73. # Whether sites are accessible only within a Tor browser
  74. ONION_ONLY="no"
  75. # Where to fetch packages
  76. #MIRROR='http://httpredir.debian.org/debian'
  77. MIRROR='http://ftp.de.debian.org/debian'
  78. # Whether to only install debian but nothing else
  79. DEBIAN_INSTALL_ONLY='no'
  80. # wifi settings
  81. WIFI_INTERFACE='wlan0'
  82. WIFI_SSID=
  83. WIFI_TYPE='wpa-psk'
  84. WIFI_PASSPHRASE=
  85. WIFI_HOTSPOT='no'
  86. WIFI_NETWORKS_FILE=~/${PROJECT_NAME}-wifi.cfg
  87. mesh_router_setup_script() {
  88. # create a setup script for a mesh router
  89. mesh_script_filename=$1
  90. echo "MY_USERNAME=${USERNAME}" > $mesh_script_filename
  91. echo "DEFAULT_DOMAIN_NAME=${USERNAME}" >> $mesh_script_filename
  92. echo 'SYSTEM_TYPE=mesh' >> $mesh_script_filename
  93. echo 'INSTALLING_ON_BBB=no' >> $mesh_script_filename
  94. echo 'USB_DRIVE=/dev/sda1' >> $mesh_script_filename
  95. echo 'DDNS_PROVIDER=' >> $mesh_script_filename
  96. echo 'DDNS_USERNAME=' >> $mesh_script_filename
  97. echo 'DDNS_PASSWORD=' >> $mesh_script_filename
  98. echo 'DEFAULT_LANGUAGE=en_GB.UTF-8' >> $mesh_script_filename
  99. echo 'MY_EMAIL_ADDRESS=' >> $mesh_script_filename
  100. echo 'ENABLE_CJDNS=no' >> $mesh_script_filename
  101. echo 'ENABLE_BATMAN=yes' >> $mesh_script_filename
  102. echo 'ENABLE_BABEL=no' >> $mesh_script_filename
  103. echo 'DEBIAN_REPO=' >> $mesh_script_filename
  104. echo 'NAMESERVER1=' >> $mesh_script_filename
  105. echo 'NAMESERVER2=' >> $mesh_script_filename
  106. echo 'BATMAN_CELLID=any' >> $mesh_script_filename
  107. echo 'WIFI_CHANNEL=9' >> $mesh_script_filename
  108. }
  109. while [[ $# > 1 ]]
  110. do
  111. key="$1"
  112. case $key in
  113. -h|--help)
  114. show_help
  115. ;;
  116. -c|--config)
  117. shift
  118. CONFIG_FILENAME="$1"
  119. if [ ! -f $CONFIG_FILENAME ]; then
  120. echo $"Config file $CONFIG_FILENAME not found"
  121. exit 3
  122. fi
  123. DEFAULT_DOMAIN_NAME=$(cat $CONFIG_FILENAME | grep 'DEFAULT_DOMAIN_NAME' | awk -F '=' '{print $2}')
  124. ;;
  125. -t|--target|--board)
  126. shift
  127. IMAGE_TYPE="$1"
  128. ;;
  129. -u|--user|--username)
  130. shift
  131. USERNAME="$1"
  132. ;;
  133. -p|--password)
  134. shift
  135. PASSWORD="$1"
  136. if [ ${#PASSWORD} -lt $MINIMUM_PASSWORD_LENGTH ]; then
  137. echo $"Your password chould contain at least ${MINIMUM_PASSWORD_LENGTH} characters"
  138. exit 3628
  139. fi
  140. ;;
  141. --sshkey|--sshpubkey|--pubkey)
  142. shift
  143. SSH_PUBKEY="$1"
  144. ;;
  145. -s|--size)
  146. shift
  147. IMAGE_SIZE="$1"
  148. ;;
  149. # Box static IP address on the LAN
  150. --ip)
  151. shift
  152. BOX_IP_ADDRESS="$1"
  153. ;;
  154. # Router IP address on the LAN
  155. --iprouter)
  156. shift
  157. ROUTER_IP_ADDRESS="$1"
  158. ;;
  159. # nameserver 1
  160. --ns1|--nameserver1)
  161. shift
  162. NAMESERVER1="$1"
  163. ;;
  164. # nameserver 2
  165. --ns2|--nameserver2)
  166. shift
  167. NAMESERVER2="$1"
  168. ;;
  169. -i|--interactive)
  170. shift
  171. INTERACTIVE="$1"
  172. ;;
  173. -g|--generic)
  174. shift
  175. GENERIC_IMAGE="$1"
  176. ;;
  177. --minimal)
  178. shift
  179. MINIMAL_INSTALL="$1"
  180. ;;
  181. --ssh|--sshport)
  182. shift
  183. SSH_PORT="$1"
  184. ;;
  185. -v|--variant)
  186. shift
  187. VARIANT="$1"
  188. ;;
  189. -o|--onion)
  190. shift
  191. ONION_ONLY="$1"
  192. ;;
  193. -r|--repo|--repository)
  194. shift
  195. PROJECT_REPO="$1"
  196. ;;
  197. -m|--mirror)
  198. shift
  199. MIRROR="$1"
  200. ;;
  201. --debianonly|--basic|--minimal)
  202. shift
  203. DEBIAN_INSTALL_ONLY="$1"
  204. ;;
  205. --interface|--if)
  206. shift
  207. WIFI_INTERFACE="$1"
  208. ;;
  209. --ssid|--essid)
  210. shift
  211. WIFI_SSID="$1"
  212. ;;
  213. --wifitype)
  214. shift
  215. WIFI_TYPE="$1"
  216. ;;
  217. --wifipass|--passphrase)
  218. shift
  219. WIFI_PASSPHRASE="$1"
  220. ;;
  221. --hotspot)
  222. shift
  223. if [[ $"$1" == $'yes' || $"$1" == $'y' ]]; then
  224. WIFI_HOTSPOT='yes'
  225. fi
  226. ;;
  227. --networks)
  228. shift
  229. WIFI_NETWORKS_FILE="$1"
  230. ;;
  231. *)
  232. # unknown option
  233. ;;
  234. esac
  235. shift
  236. done
  237. if [[ $INTERACTIVE == "yes" || $INTERACTIVE == "y" || $INTERACTIVE == "Yes" ]]; then
  238. ${PROJECT_NAME}-config --minimal "$MINIMAL_INSTALL"
  239. if [ -f freedombone.cfg ]; then
  240. CONFIG_FILENAME=freedombone.cfg
  241. DEFAULT_DOMAIN_NAME=$(cat $CONFIG_FILENAME | grep 'DEFAULT_DOMAIN_NAME' | awk -F '=' '{print $2}')
  242. fi
  243. fi
  244. if [[ $GENERIC_IMAGE == "yes" ]]; then
  245. USERNAME=$GENERIC_IMAGE_USERNAME
  246. PASSWORD=$GENERIC_IMAGE_PASSWORD
  247. fi
  248. # If this is a mesh variant then create an appropriate script
  249. #if [[ $VARIANT == "mesh"* ]]; then
  250. #CONFIG_FILENAME=/tmp/${PROJECT_NAME}_mesh.cfg
  251. #mesh_router_setup_script $CONFIG_FILENAME
  252. #DEFAULT_DOMAIN_NAME=$(cat $CONFIG_FILENAME | grep 'DEFAULT_DOMAIN_NAME' | awk -F '=' '{print $2}')
  253. #fi
  254. if [ ! $PASSWORD ]; then
  255. # generate a random password
  256. PASSWORD="$(openssl rand -base64 10 | cut -c1-8)"
  257. fi
  258. # Move any existing images into a build subdirectory
  259. image_types=( xz img sig vdi qcow2 )
  260. for im in "${image_types[@]}"
  261. do
  262. no_of_files=$(ls -afq ${CURR_DIR}/${PROJECT_NAME}*.${im} | wc -l)
  263. if (( no_of_files > 0 )); then
  264. if [ ! -d ${CURR_DIR}/build ]; then
  265. mkdir ${CURR_DIR}/build
  266. fi
  267. mv -f ${CURR_DIR}/${PROJECT_NAME}*.${im} ${CURR_DIR}/build
  268. fi
  269. done
  270. # Delete anything which didn't move
  271. for im in "${image_types[@]}"
  272. do
  273. no_of_files=$(ls -afq ${CURR_DIR}/${PROJECT_NAME}*.${im} | wc -l)
  274. if (( no_of_files > 0 )); then
  275. rm -f ${CURR_DIR}/${PROJECT_NAME}*.${im}
  276. fi
  277. done
  278. # Remove any existing login credentials file
  279. if [ -f ${CURR_DIR}/${PROJECT_NAME}_login_credentials.txt ]; then
  280. rm ${CURR_DIR}/${PROJECT_NAME}_login_credentials.txt
  281. fi
  282. if [ -d $TEMPBUILD_DIR ]; then
  283. rm -rf $TEMPBUILD_DIR
  284. fi
  285. mkdir -p $TEMPBUILD_DIR
  286. if [ -f /usr/local/bin/$MAKEFILE ]; then
  287. cp /usr/local/bin/$MAKEFILE $TEMPBUILD_DIR/Makefile
  288. else
  289. cp /usr/bin/$MAKEFILE $TEMPBUILD_DIR/Makefile
  290. fi
  291. cp -r /etc/${PROJECT_NAME}/* $TEMPBUILD_DIR
  292. rm -rf $TEMPBUILD_DIR/vendor
  293. chown -R $CURR_USER:$CURR_USER $TEMPBUILD_DIR
  294. cd $TEMPBUILD_DIR
  295. if [[ $MINIMAL_INSTALL == "yes" ]]; then
  296. IMAGE_NAME='min'
  297. fi
  298. if [[ $ONION_ONLY != "no" ]]; then
  299. IMAGE_NAME='onion'
  300. fi
  301. cd $TEMPBUILD_DIR
  302. make $IMAGE_TYPE \
  303. USERNAME="$USERNAME" \
  304. PASSWORD="$PASSWORD" \
  305. ROUTER_IP_ADDRESS="$ROUTER_IP_ADDRESS" \
  306. BOX_IP_ADDRESS="$BOX_IP_ADDRESS" \
  307. NAMESERVER1="$NAMESERVER1" \
  308. NAMESERVER2="$NAMESERVER2" \
  309. PROJECT_NAME="$PROJECT_NAME" \
  310. CONFIG_FILENAME="$CONFIG_FILENAME" \
  311. IMAGE_SIZE="$IMAGE_SIZE" \
  312. SSH_PUBKEY="$SSH_PUBKEY" \
  313. GENERIC_IMAGE="$GENERIC_IMAGE" \
  314. MINIMAL_INSTALL="$MINIMAL_INSTALL" \
  315. SSH_PORT="$SSH_PORT" \
  316. ONION_ONLY="$ONION_ONLY" \
  317. IMAGE_NAME="$IMAGE_NAME" \
  318. PROJECT_REPO="$PROJECT_REPO" \
  319. MIRROR="$MIRROR" \
  320. BUILD_MIRROR="$MIRROR" \
  321. DEBIAN_INSTALL_ONLY="$DEBIAN_INSTALL_ONLY" \
  322. WIFI_INTERFACE="$WIFI_INTERFACE" \
  323. WIFI_SSID="$WIFI_SSID" \
  324. WIFI_TYPE="$WIFI_TYPE" \
  325. WIFI_PASSPHRASE="$WIFI_PASSPHRASE" \
  326. WIFI_HOTSPOT="$WIFI_HOTSPOT" \
  327. WIFI_NETWORKS_FILE="$WIFI_NETWORKS_FILE"
  328. if [ ! "$?" = "0" ]; then
  329. echo $'Build failed'
  330. rm -rf $TEMPBUILD_DIR
  331. exit 1
  332. fi
  333. EXPECTED_EXTENSION='xz'
  334. if [[ $IMAGE_TYPE == "qemu"* ]]; then
  335. EXPECTED_EXTENSION='qcow2'
  336. fi
  337. if [[ $IMAGE_TYPE == "virtualbox"* ]]; then
  338. EXPECTED_EXTENSION='vdi'
  339. fi
  340. shopt -s nullglob
  341. imgfiles=(build/${PROJECT_NAME}*.${EXPECTED_EXTENSION})
  342. if [ ${#imgfiles[@]} -eq 0 ]; then
  343. echo $'Image was not created'
  344. rm -rf $TEMPBUILD_DIR
  345. exit 2
  346. fi
  347. # Move images from temporary directory to the current directory
  348. for im in "${image_types[@]}"
  349. do
  350. no_of_files=$(ls -afq build/${PROJECT_NAME}*.${im} | wc -l)
  351. if (( no_of_files > 0 )); then
  352. mv build/${PROJECT_NAME}*.${im} ${CURR_DIR}/
  353. fi
  354. done
  355. # Remove the temporary directory
  356. rm -rf ${TEMPBUILD_DIR}
  357. cd ${CURR_DIR}
  358. clear
  359. echo $"
  360. Image was created.
  361. You will be able to log into it with:
  362. "
  363. if [[ $IMAGE_TYPE != "virtualbox"* && $IMAGE_TYPE != "qemu"* ]]; then
  364. echo $" ssh $USERNAME@$DEFAULT_DOMAIN_NAME -p $SSH_PORT
  365. Password: $PASSWORD
  366. "
  367. else
  368. if [[ $IMAGE_TYPE != "qemu"* ]]; then
  369. echo $" Username: $USERNAME
  370. Password: $PASSWORD
  371. "
  372. else
  373. if [[ $IMAGE_TYPE != "qemu-x86_64"* && $IMAGE_TYPE != "qemu-amd64"* ]]; then
  374. echo "qemu-system-i386 -m ${VM_MEMORY} $(ls ${PROJECT_NAME}*.qcow2)"
  375. else
  376. echo "qemu-system-x86_64 -m ${VM_MEMORY} $(ls ${PROJECT_NAME}*.qcow2)"
  377. fi
  378. echo $"
  379. Username: $USERNAME
  380. Password: $PASSWORD
  381. "
  382. fi
  383. fi
  384. ls -lh ${PROJECT_NAME}*.img ${PROJECT_NAME}*.sig ${PROJECT_NAME}*.xz ${PROJECT_NAME}*.vdi ${PROJECT_NAME}*.qcow2
  385. # Remove the mesh script after use
  386. if [[ $VARIANT == "mesh"* ]]; then
  387. rm -f $CONFIG_FILENAME
  388. fi
  389. # record the default login credentials for later use
  390. echo $"Username: $USERNAME
  391. Password: $PASSWORD" > ${CURR_DIR}/${PROJECT_NAME}_login_credentials.txt
  392. chmod 600 ${CURR_DIR}/${PROJECT_NAME}_login_credentials.txt
  393. if [[ $IMAGE_TYPE != "virtualbox"* && $IMAGE_TYPE != "qemu"* ]]; then
  394. echo ''
  395. echo $'You can copy the image to a microSD card with:'
  396. echo ''
  397. echo " unxz -k ${PROJECT_NAME}*.img.xz"
  398. echo " sudo dd bs=1M if=${PROJECT_NAME}*.img of=/dev/sdX conv=fdatasync"
  399. echo ''
  400. fi
  401. exit 0