freedombone-image 9.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387
  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 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 General Public License for more details.
  27. #
  28. # You should have received a copy of the GNU 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. BUILD_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=4G
  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. mesh_router_setup_script() {
  78. # create a setup script for a mesh router
  79. mesh_script_filename=$1
  80. echo "MY_USERNAME=${USERNAME}" > $mesh_script_filename
  81. echo "DEFAULT_DOMAIN_NAME=${USERNAME}" >> $mesh_script_filename
  82. echo 'SYSTEM_TYPE=mesh' >> $mesh_script_filename
  83. echo 'INSTALLING_ON_BBB=no' >> $mesh_script_filename
  84. echo 'USB_DRIVE=/dev/sda1' >> $mesh_script_filename
  85. echo 'DDNS_PROVIDER=' >> $mesh_script_filename
  86. echo 'DDNS_USERNAME=' >> $mesh_script_filename
  87. echo 'DDNS_PASSWORD=' >> $mesh_script_filename
  88. echo 'DEFAULT_LANGUAGE=en_GB.UTF-8' >> $mesh_script_filename
  89. echo 'MY_EMAIL_ADDRESS=' >> $mesh_script_filename
  90. echo 'ENABLE_CJDNS=no' >> $mesh_script_filename
  91. echo 'ENABLE_BATMAN=yes' >> $mesh_script_filename
  92. echo 'ENABLE_BABEL=no' >> $mesh_script_filename
  93. echo 'DEBIAN_REPO=' >> $mesh_script_filename
  94. echo 'NAMESERVER1=' >> $mesh_script_filename
  95. echo 'NAMESERVER2=' >> $mesh_script_filename
  96. echo 'BATMAN_CELLID=any' >> $mesh_script_filename
  97. echo 'WIFI_CHANNEL=9' >> $mesh_script_filename
  98. }
  99. while [[ $# > 1 ]]
  100. do
  101. key="$1"
  102. case $key in
  103. -h|--help)
  104. show_help
  105. ;;
  106. -c|--config)
  107. shift
  108. CONFIG_FILENAME="$1"
  109. if [ ! -f $CONFIG_FILENAME ]; then
  110. echo $"Config file $CONFIG_FILENAME not found"
  111. exit 3
  112. fi
  113. DEFAULT_DOMAIN_NAME=$(cat $CONFIG_FILENAME | grep 'DEFAULT_DOMAIN_NAME' | awk -F '=' '{print $2}')
  114. ;;
  115. -t|--target|--board)
  116. shift
  117. IMAGE_TYPE="$1"
  118. ;;
  119. -u|--user|--username)
  120. shift
  121. USERNAME="$1"
  122. ;;
  123. -p|--password)
  124. shift
  125. PASSWORD="$1"
  126. if [ ${#PASSWORD} -lt $MINIMUM_PASSWORD_LENGTH ]; then
  127. echo $"Your password chould contain at least ${MINIMUM_PASSWORD_LENGTH} characters"
  128. exit 3628
  129. fi
  130. ;;
  131. --sshkey|--sshpubkey|--pubkey)
  132. shift
  133. SSH_PUBKEY="$1"
  134. ;;
  135. -s|--size)
  136. shift
  137. IMAGE_SIZE="$1"
  138. ;;
  139. # Box static IP address on the LAN
  140. --ip)
  141. shift
  142. BOX_IP_ADDRESS="$1"
  143. ;;
  144. # Router IP address on the LAN
  145. --iprouter)
  146. shift
  147. ROUTER_IP_ADDRESS="$1"
  148. ;;
  149. # nameserver 1
  150. --ns1|--nameserver1)
  151. shift
  152. NAMESERVER1="$1"
  153. ;;
  154. # nameserver 2
  155. --ns2|--nameserver2)
  156. shift
  157. NAMESERVER2="$1"
  158. ;;
  159. -i|--interactive)
  160. shift
  161. INTERACTIVE="$1"
  162. ;;
  163. -g|--generic)
  164. shift
  165. GENERIC_IMAGE="$1"
  166. ;;
  167. --minimal)
  168. shift
  169. MINIMAL_INSTALL="$1"
  170. ;;
  171. --ssh|--sshport)
  172. shift
  173. SSH_PORT="$1"
  174. ;;
  175. -v|--variant)
  176. shift
  177. VARIANT="$1"
  178. ;;
  179. -o|--onion)
  180. shift
  181. ONION_ONLY="$1"
  182. ;;
  183. -r|--repo|--repository)
  184. shift
  185. PROJECT_REPO="$1"
  186. ;;
  187. -m|--mirror)
  188. shift
  189. MIRROR="$1"
  190. ;;
  191. *)
  192. # unknown option
  193. ;;
  194. esac
  195. shift
  196. done
  197. if [[ $INTERACTIVE == "yes" || $INTERACTIVE == "y" || $INTERACTIVE == "Yes" ]]; then
  198. ${PROJECT_NAME}-config --minimal "$MINIMAL_INSTALL"
  199. if [ -f freedombone.cfg ]; then
  200. CONFIG_FILENAME=freedombone.cfg
  201. DEFAULT_DOMAIN_NAME=$(cat $CONFIG_FILENAME | grep 'DEFAULT_DOMAIN_NAME' | awk -F '=' '{print $2}')
  202. fi
  203. fi
  204. if [[ $GENERIC_IMAGE == "yes" ]]; then
  205. USERNAME=$GENERIC_IMAGE_USERNAME
  206. PASSWORD=$GENERIC_IMAGE_PASSWORD
  207. fi
  208. # If this is a mesh variant then create an appropriate script
  209. #if [[ $VARIANT == "mesh"* ]]; then
  210. #CONFIG_FILENAME=/tmp/${PROJECT_NAME}_mesh.cfg
  211. #mesh_router_setup_script $CONFIG_FILENAME
  212. #DEFAULT_DOMAIN_NAME=$(cat $CONFIG_FILENAME | grep 'DEFAULT_DOMAIN_NAME' | awk -F '=' '{print $2}')
  213. #fi
  214. if [ ! $PASSWORD ]; then
  215. # generate a random password
  216. PASSWORD="$(openssl rand -base64 10 | cut -c1-8)"
  217. fi
  218. image_types=( xz img sig vdi qcow2 )
  219. for im in "${image_types[@]}"
  220. do
  221. no_of_files=$(ls -afq ${CURR_DIR}/${PROJECT_NAME}*.${im} | wc -l)
  222. if (( no_of_files > 0 )); then
  223. rm ${CURR_DIR}/${PROJECT_NAME}*.${im}
  224. fi
  225. done
  226. if [ -f ${CURR_DIR}/${PROJECT_NAME}_login_credentials.txt ]; then
  227. rm ${CURR_DIR}/${PROJECT_NAME}_login_credentials.txt
  228. fi
  229. if [ -d $BUILD_DIR ]; then
  230. rm -rf $BUILD_DIR
  231. fi
  232. mkdir -p $BUILD_DIR
  233. if [ -f /usr/local/bin/$MAKEFILE ]; then
  234. cp /usr/local/bin/$MAKEFILE $BUILD_DIR/Makefile
  235. else
  236. cp /usr/bin/$MAKEFILE $BUILD_DIR/Makefile
  237. fi
  238. cp -r /etc/${PROJECT_NAME}/* $BUILD_DIR
  239. rm -rf $BUILD_DIR/vendor
  240. chown -R $CURR_USER:$CURR_USER $BUILD_DIR
  241. cd $BUILD_DIR
  242. if [[ $MINIMAL_INSTALL == "yes" ]]; then
  243. IMAGE_NAME='min'
  244. fi
  245. if [[ $ONION_ONLY != "no" ]]; then
  246. IMAGE_NAME='onion'
  247. fi
  248. cd $BUILD_DIR
  249. make $IMAGE_TYPE \
  250. USERNAME="$USERNAME" \
  251. PASSWORD="$PASSWORD" \
  252. ROUTER_IP_ADDRESS="$ROUTER_IP_ADDRESS" \
  253. BOX_IP_ADDRESS="$BOX_IP_ADDRESS" \
  254. NAMESERVER1="$NAMESERVER1" \
  255. NAMESERVER2="$NAMESERVER2" \
  256. PROJECT_NAME="$PROJECT_NAME" \
  257. CONFIG_FILENAME="$CONFIG_FILENAME" \
  258. IMAGE_SIZE="$IMAGE_SIZE" \
  259. SSH_PUBKEY="$SSH_PUBKEY" \
  260. GENERIC_IMAGE="$GENERIC_IMAGE" \
  261. MINIMAL_INSTALL="$MINIMAL_INSTALL" \
  262. SSH_PORT="$SSH_PORT" \
  263. ONION_ONLY="$ONION_ONLY" \
  264. IMAGE_NAME="$IMAGE_NAME" \
  265. PROJECT_REPO="$PROJECT_REPO" \
  266. MIRROR="$MIRROR" \
  267. BUILD_MIRROR="$MIRROR"
  268. if [ ! "$?" = "0" ]; then
  269. echo $'Build failed'
  270. rm -rf $BUILD_DIR
  271. exit 1
  272. fi
  273. EXPECTED_EXTENSION='xz'
  274. if [[ $IMAGE_TYPE == "qemu"* ]]; then
  275. EXPECTED_EXTENSION='qcow2'
  276. fi
  277. if [[ $IMAGE_TYPE == "virtualbox"* ]]; then
  278. EXPECTED_EXTENSION='vdi'
  279. fi
  280. shopt -s nullglob
  281. imgfiles=(build/${PROJECT_NAME}*.${EXPECTED_EXTENSION})
  282. if [ ${#imgfiles[@]} -eq 0 ]; then
  283. echo $'Image was not created'
  284. rm -rf $BUILD_DIR
  285. exit 2
  286. fi
  287. # Move images to the current directory
  288. for im in "${image_types[@]}"
  289. do
  290. no_of_files=$(ls -afq build/${PROJECT_NAME}*.${im} | wc -l)
  291. if (( no_of_files > 0 )); then
  292. mv build/${PROJECT_NAME}*.${im} ${CURR_DIR}/
  293. fi
  294. done
  295. rm -rf ${BUILD_DIR}
  296. cd ${CURR_DIR}
  297. clear
  298. echo $"
  299. Image was created.
  300. You will be able to log into it with:
  301. "
  302. if [[ $IMAGE_TYPE != "virtualbox"* && $IMAGE_TYPE != "qemu"* ]]; then
  303. echo $" ssh $USERNAME@$DEFAULT_DOMAIN_NAME -p $SSH_PORT
  304. Password: $PASSWORD
  305. "
  306. else
  307. if [[ $IMAGE_TYPE != "qemu"* ]]; then
  308. echo $" Username: $USERNAME
  309. Password: $PASSWORD
  310. "
  311. else
  312. if [[ $IMAGE_TYPE != "qemu-x86_64"* && $IMAGE_TYPE != "qemu-amd64"* ]]; then
  313. echo "qemu-system-i386 -m ${VM_MEMORY} $(ls ${PROJECT_NAME}*.qcow2)"
  314. else
  315. echo "qemu-system-x86_64 -m ${VM_MEMORY} $(ls ${PROJECT_NAME}*.qcow2)"
  316. fi
  317. echo $"
  318. Username: $USERNAME
  319. Password: $PASSWORD
  320. "
  321. fi
  322. fi
  323. ls -lh ${PROJECT_NAME}*.img ${PROJECT_NAME}*.sig ${PROJECT_NAME}*.xz ${PROJECT_NAME}*.vdi ${PROJECT_NAME}*.qcow2
  324. # Remove the mesh script after use
  325. if [[ $VARIANT == "mesh"* ]]; then
  326. rm -f $CONFIG_FILENAME
  327. fi
  328. # record the default login credentials for later use
  329. echo $"Username: $USERNAME
  330. Password: $PASSWORD" > ${CURR_DIR}/${PROJECT_NAME}_login_credentials.txt
  331. chmod 600 ${CURR_DIR}/${PROJECT_NAME}_login_credentials.txt
  332. if [[ $IMAGE_TYPE != "virtualbox"* && $IMAGE_TYPE != "qemu"* ]]; then
  333. echo ''
  334. echo $'You can copy the image to a microSD card with:'
  335. echo ''
  336. echo " sudo dd bs=1M if=$(ls ${PROJECT_NAME}*.img) of=/dev/sdX conv=fdatasync"
  337. echo ''
  338. fi
  339. exit 0