##// END OF EJS Templates
Raspi2-3_GenImage
RSS

Cloner depuis https://github.com/drtyhlpr/rpi23-gen-image.git

set better defaults for arm64 builds...
Brian J. Tarricone -
r184:bc2d9952f399
parent child
Show More
Show file before | Show file after | Hide comments
@@ -1,452 +1,452
1 1 # rpi23-gen-image
2 2 ## Introduction
3 3 `rpi23-gen-image.sh` is an advanced Debian Linux bootstrapping shell script for generating Debian OS images for Raspberry Pi 2 (RPi2) and Raspberry Pi 3 (RPi3) computers. The script at this time supports the bootstrapping of the Debian (armhf) releases `jessie` and `stretch`. Raspberry Pi 3 images are generated for 32-bit mode only. Raspberry Pi 3 64-bit images can be generated using custom configuration parameters (```templates/rpi3-stretch-arm64-4.11.y```).
4 4
5 5 ## Build dependencies
6 6 The following list of Debian packages must be installed on the build system because they are essentially required for the bootstrapping process. The script will check if all required packages are installed and missing packages will be installed automatically if confirmed by the user.
7 7
8 8 ```debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus sudo```
9 9
10 10 It is recommended to configure the `rpi23-gen-image.sh` script to build and install the latest Raspberry Pi Linux kernel. For the RPi3 this is mandetory. Kernel compilation and linking will be performed on the build system using an ARM (armhf) cross-compiler toolchain.
11 11
12 12 The script has been tested using the default `crossbuild-essential-armhf` toolchain meta package on Debian Linux `jessie` and `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.
13 13
14 14 If a Debian Linux `jessie` build system is used it will be required to add the [Debian Cross-toolchains repository](http://emdebian.org/tools/debian/) first:
15 15
16 16 ```
17 17 echo "deb http://emdebian.org/tools/debian/ jessie main" > /etc/apt/sources.list.d/crosstools.list
18 18 sudo -u nobody wget -O - http://emdebian.org/tools/debian/emdebian-toolchain-archive.key | apt-key add -
19 19 dpkg --add-architecture armhf
20 20 apt-get update
21 21 ```
22 22
23 23 ## Command-line parameters
24 24 The script accepts certain command-line parameters to enable or disable specific OS features, services and configuration settings. These parameters are passed to the `rpi23-gen-image.sh` script via (simple) shell-variables. Unlike environment shell-variables (simple) shell-variables are defined at the beginning of the command-line call of the `rpi23-gen-image.sh` script.
25 25
26 26 ##### Command-line examples:
27 27 ```shell
28 28 ENABLE_UBOOT=true ./rpi23-gen-image.sh
29 29 ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh
30 30 ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh
31 31 ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh
32 32 APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh
33 33 ENABLE_MINBASE=true ./rpi23-gen-image.sh
34 34 BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh
35 35 BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh
36 36 ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
37 37 ENABLE_CRYPTFS=true CRYPTFS_PASSWORD=changeme EXPANDROOT=false ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
38 38 RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh
39 39 RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
40 40 RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
41 41 ```
42 42
43 43 ## Configuration template files
44 44 To avoid long lists of command-line parameters and to help to store the favourite parameter configurations the `rpi23-gen-image.sh` script supports so called configuration template files (`CONFIG_TEMPLATE`=template). These are simple text files located in the `./templates` directory that contain the list of configuration parameters that will be used. New configuration template files can be added to the `./templates` directory.
45 45
46 46 ##### Command-line examples:
47 47 ```shell
48 48 CONFIG_TEMPLATE=rpi3stretch ./rpi23-gen-image.sh
49 49 CONFIG_TEMPLATE=rpi2stretch ./rpi23-gen-image.sh
50 50 ```
51 51
52 52 ## Supported parameters and settings
53 53 #### APT settings:
54 54 ##### `APT_SERVER`="ftp.debian.org"
55 55 Set Debian packages server address. Choose a server from the list of Debian worldwide [mirror sites](https://www.debian.org/mirror/list). Using a nearby server will probably speed-up all required downloads within the bootstrapping process.
56 56
57 57 ##### `APT_PROXY`=""
58 58 Set Proxy server address. Using a local Proxy-Cache like `apt-cacher-ng` will speed-up the bootstrapping process because all required Debian packages will only be downloaded from the Debian mirror site once.
59 59
60 60 ##### `APT_INCLUDES`=""
61 61 A comma separated list of additional packages to be installed by debootstrap during bootstrapping.
62 62
63 63 ##### `APT_INCLUDES_LATE`=""
64 64 A comma separated list of additional packages to be installed by apt after bootstrapping and after APT sources are set up. This is useful for packages with pre-depends, which debootstrap do not handle well.
65 65
66 66 ---
67 67
68 68 #### General system settings:
69 69 ##### `RPI_MODEL`=2
70 70 Specifiy the target Raspberry Pi hardware model. The script at this time supports the Raspberry Pi models `2` and `3`. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` is used.
71 71
72 72 ##### `RELEASE`="jessie"
73 73 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases "jessie" and "stretch". `BUILD_KERNEL`=true will automatically be set if the Debian release `stretch` is used.
74 74
75 75 ##### `RELEASE_ARCH`="armhf"
76 76 Set the desired Debian release architecture.
77 77
78 78 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
79 79 Set system host name. It's recommended that the host name is unique in the corresponding subnet.
80 80
81 81 ##### `PASSWORD`="raspberry"
82 82 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
83 83
84 84 ##### `USER_PASSWORD`="raspberry"
85 85 Set password for the created non-root user `USER_NAME`=pi. Ignored if `ENABLE_USER`=false. It's **STRONGLY** recommended that you choose a custom password.
86 86
87 87 ##### `DEFLOCAL`="en_US.UTF-8"
88 88 Set default system locale. This setting can also be changed inside the running OS using the `dpkg-reconfigure locales` command. Please note that on using this parameter the script will automatically install the required packages `locales`, `keyboard-configuration` and `console-setup`.
89 89
90 90 ##### `TIMEZONE`="Europe/Berlin"
91 91 Set default system timezone. All available timezones can be found in the `/usr/share/zoneinfo/` directory. This setting can also be changed inside the running OS using the `dpkg-reconfigure tzdata` command.
92 92
93 93 ##### `EXPANDROOT`=true
94 94 Expand the root partition and filesystem automatically on first boot.
95 95
96 96 ---
97 97
98 98 #### Keyboard settings:
99 99 These options are used to configure keyboard layout in `/etc/default/keyboard` for console and Xorg. These settings can also be changed inside the running OS using the `dpkg-reconfigure keyboard-configuration` command.
100 100
101 101 ##### `XKB_MODEL`=""
102 102 Set the name of the model of your keyboard type.
103 103
104 104 ##### `XKB_LAYOUT`=""
105 105 Set the supported keyboard layout(s).
106 106
107 107 ##### `XKB_VARIANT`=""
108 108 Set the supported variant(s) of the keyboard layout(s).
109 109
110 110 ##### `XKB_OPTIONS`=""
111 111 Set extra xkb configuration options.
112 112
113 113 ---
114 114
115 115 #### Networking settings (DHCP):
116 116 This parameter is used to set up networking auto configuration in `/etc/systemd/network/eth.network`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.`
117 117
118 118 ##### `ENABLE_DHCP`=true
119 119 Set the system to use DHCP. This requires an DHCP server.
120 120
121 121 ---
122 122
123 123 #### Networking settings (static):
124 124 These parameters are used to set up a static networking configuration in `/etc/systemd/network/eth.network`. The following static networking parameters are only supported if `ENABLE_DHCP` was set to `false`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.
125 125
126 126 ##### `NET_ADDRESS`=""
127 127 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
128 128
129 129 ##### `NET_GATEWAY`=""
130 130 Set the IP address for the default gateway.
131 131
132 132 ##### `NET_DNS_1`=""
133 133 Set the IP address for the first DNS server.
134 134
135 135 ##### `NET_DNS_2`=""
136 136 Set the IP address for the second DNS server.
137 137
138 138 ##### `NET_DNS_DOMAINS`=""
139 139 Set the default DNS search domains to use for non fully qualified host names.
140 140
141 141 ##### `NET_NTP_1`=""
142 142 Set the IP address for the first NTP server.
143 143
144 144 ##### `NET_NTP_2`=""
145 145 Set the IP address for the second NTP server.
146 146
147 147 ---
148 148
149 149 #### Basic system features:
150 150 ##### `ENABLE_CONSOLE`=true
151 151 Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi2/3. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system.
152 152
153 153 ##### `ENABLE_I2C`=false
154 154 Enable I2C interface on the RPi2/3. Please check the [RPi2/3 pinout diagrams](http://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
155 155
156 156 ##### `ENABLE_SPI`=false
157 157 Enable SPI interface on the RPi2/3. Please check the [RPi2/3 pinout diagrams](http://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
158 158
159 159 ##### `ENABLE_IPV6`=true
160 160 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
161 161
162 162 ##### `ENABLE_SSHD`=true
163 163 Install and enable OpenSSH service. The default configuration of the service doesn't allow `root` to login. Please use the user `pi` instead and `su -` or `sudo` to execute commands as root.
164 164
165 165 ##### `ENABLE_NONFREE`=false
166 166 Allow the installation of non-free Debian packages that do not comply with the DFSG. This is required to install closed-source firmware binary blobs.
167 167
168 168 ##### `ENABLE_WIRELESS`=false
169 169 Download and install the [closed-source firmware binary blob](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm) that is required to run the internal wireless interface of the Raspberry Pi model `3`. This parameter is ignored if the specified `RPI_MODEL` is not `3`.
170 170
171 171 ##### `ENABLE_RSYSLOG`=true
172 172 If set to false, disable and uninstall rsyslog (so logs will be available only
173 173 in journal files)
174 174
175 175 ##### `ENABLE_SOUND`=true
176 176 Enable sound hardware and install Advanced Linux Sound Architecture.
177 177
178 178 ##### `ENABLE_HWRANDOM`=true
179 179 Enable Hardware Random Number Generator. Strong random numbers are important for most network based communications that use encryption. It's recommended to be enabled.
180 180
181 181 ##### `ENABLE_MINGPU`=false
182 182 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
183 183
184 184 ##### `ENABLE_DBUS`=true
185 185 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
186 186
187 187 ##### `ENABLE_XORG`=false
188 188 Install Xorg open-source X Window System.
189 189
190 190 ##### `ENABLE_WM`=""
191 191 Install a user defined window manager for the X Window System. To make sure all X related package dependencies are getting installed `ENABLE_XORG` will automatically get enabled if `ENABLE_WM` is used. The `rpi23-gen-image.sh` script has been tested with the following list of window managers: `blackbox`, `openbox`, `fluxbox`, `jwm`, `dwm`, `xfce4`, `awesome`.
192 192
193 193 ---
194 194
195 195 #### Advanced system features:
196 196 ##### `ENABLE_MINBASE`=false
197 197 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
198 198
199 199 ##### `ENABLE_REDUCE`=false
200 200 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
201 201
202 202 ##### `ENABLE_UBOOT`=false
203 203 Replace the default RPi2/3 second stage bootloader (bootcode.bin) with [U-Boot bootloader](http://git.denx.de/?p=u-boot.git;a=summary). U-Boot can boot images via the network using the BOOTP/TFTP protocol.
204 204
205 205 ##### `UBOOTSRC_DIR`=""
206 206 Path to a directory (`u-boot`) of [U-Boot bootloader sources](http://git.denx.de/?p=u-boot.git;a=summary) that will be copied, configured, build and installed inside the chroot.
207 207
208 208 ##### `ENABLE_FBTURBO`=false
209 209 Install and enable the [hardware accelerated Xorg video driver](https://github.com/ssvb/xf86-video-fbturbo) `fbturbo`. Please note that this driver is currently limited to hardware accelerated window moving and scrolling.
210 210
211 211 ##### `FBTURBOSRC_DIR`=""
212 212 Path to a directory (`xf86-video-fbturbo`) of [hardware accelerated Xorg video driver sources](https://github.com/ssvb/xf86-video-fbturbo) that will be copied, configured, build and installed inside the chroot.
213 213
214 214 ##### `ENABLE_IPTABLES`=false
215 215 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
216 216
217 217 ##### `ENABLE_USER`=true
218 218 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, username will be `pi`.
219 219
220 220 ##### `USER_NAME`=pi
221 221 Non-root user to create. Ignored if `ENABLE_USER`=false
222 222
223 223 ##### `ENABLE_ROOT`=false
224 224 Set root user password so root login will be enabled
225 225
226 226 ##### `ENABLE_HARDNET`=false
227 227 Enable IPv4/IPv6 network stack hardening settings.
228 228
229 229 ##### `ENABLE_SPLITFS`=false
230 230 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
231 231
232 232 ##### `CHROOT_SCRIPTS`=""
233 233 Path to a directory with scripts that should be run in the chroot before the image is finally built. Every executable file in this directory is run in lexicographical order.
234 234
235 235 ##### `ENABLE_INITRAMFS`=false
236 236 Create an initramfs that that will be loaded during the Linux startup process. `ENABLE_INITRAMFS` will automatically get enabled if `ENABLE_CRYPTFS`=true. This parameter will be ignored if `BUILD_KERNEL`=false.
237 237
238 238 ##### `ENABLE_IFNAMES`=true
239 239 Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names. This parameter is only supported if the Debian release `stretch` is used.
240 240
241 241 ##### `DISABLE_UNDERVOLT_WARNINGS`=
242 242 Disable RPi2/3 under-voltage warnings and overlays. Setting the parameter to `1` will disable the warning overlay. Setting it to `2` will additionally allow RPi2/3 turbo mode when low-voltage is present.
243 243
244 244 ---
245 245
246 246 #### SSH settings:
247 247 ##### `SSH_ENABLE_ROOT`=false
248 248 Enable password root login via SSH. This may be a security risk with default password, use only in trusted environments. `ENABLE_ROOT` must be set to `true`.
249 249
250 250 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
251 251 Disable password based SSH authentication. Only public key based SSH (v2) authentication will be supported.
252 252
253 253 ##### `SSH_LIMIT_USERS`=false
254 254 Limit the users that are allowed to login via SSH. Only allow user `USER_NAME`=pi and root if `SSH_ENABLE_ROOT`=true to login. This parameter will be ignored if `dropbear` SSH is used (`REDUCE_SSHD`=true).
255 255
256 256 ##### `SSH_ROOT_PUB_KEY`=""
257 257 Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `root`. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported. `ENABLE_ROOT` **and** `SSH_ENABLE_ROOT` must be set to `true`.
258 258
259 259 ##### `SSH_USER_PUB_KEY`=""
260 260 Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `USER_NAME`=pi. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported.
261 261
262 262 ---
263 263
264 264 #### Kernel compilation:
265 265 ##### `BUILD_KERNEL`=false
266 266 Build and install the latest RPi2/3 Linux kernel. Currently only the default RPi2/3 kernel configuration is used. `BUILD_KERNEL`=true will automatically be set if the Raspberry Pi model `3` is used.
267 267
268 268 ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
269 269 This sets the cross compile enviornment for the compiler.
270 270
271 271 ##### `KERNEL_ARCH`="arm"
272 272 This sets the kernel architecture for the compiler.
273 273
274 274 ##### `KERNEL_IMAGE`="kernel7.img"
275 Name of the image file in the boot partition.
275 Name of the image file in the boot partition. If not set, `KERNEL_IMAGE` will be set to "kernel8.img" automatically if building for arm64.
276 276
277 277 ##### `KERNEL_BRANCH`=""
278 278 Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.
279 279
280 280 ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
281 Sets the QEMU enviornment for the Debian archive.
281 Sets the QEMU enviornment for the Debian archive. If not set, `QEMU_BINARY` will be set to "/usr/bin/qemu-aarch64-static" automatically if building for arm64.
282 282
283 283 ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
284 Sets the default config for kernel compiling.
284 Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
285 285
286 286 ##### `KERNEL_REDUCE`=false
287 287 Reduce the size of the generated kernel by removing unwanted device, network and filesystem drivers (experimental).
288 288
289 289 ##### `KERNEL_THREADS`=1
290 290 Number of parallel kernel building threads. If the parameter is left untouched the script will automatically determine the number of CPU cores to set the number of parallel threads to speed the kernel compilation.
291 291
292 292 ##### `KERNEL_HEADERS`=true
293 293 Install kernel headers with built kernel.
294 294
295 295 ##### `KERNEL_MENUCONFIG`=false
296 296 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
297 297
298 298 ##### `KERNEL_REMOVESRC`=true
299 299 Remove all kernel sources from the generated OS image after it was built and installed.
300 300
301 301 ##### `KERNELSRC_DIR`=""
302 302 Path to a directory (`linux`) of [RaspberryPi Linux kernel sources](https://github.com/raspberrypi/linux) that will be copied, configured, build and installed inside the chroot.
303 303
304 304 ##### `KERNELSRC_CLEAN`=false
305 305 Clean the existing kernel sources directory `KERNELSRC_DIR` (using `make mrproper`) after it was copied to the chroot and before the compilation of the kernel has started. This parameter will be ignored if no `KERNELSRC_DIR` was specified or if `KERNELSRC_PREBUILT`=true.
306 306
307 307 ##### `KERNELSRC_CONFIG`=true
308 308 Run `make bcm2709_defconfig` (and optional `make menuconfig`) to configure the kernel sources before building. This parameter is automatically set to `true` if no existing kernel sources directory was specified using `KERNELSRC_DIR`. This parameter is ignored if `KERNELSRC_PREBUILT`=true.
309 309
310 310 ##### `KERNELSRC_USRCONFIG`=""
311 311 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
312 312
313 313 ##### `KERNELSRC_PREBUILT`=false
314 314 With this parameter set to true the script expects the existing kernel sources directory to be already successfully cross-compiled. The parameters `KERNELSRC_CLEAN`, `KERNELSRC_CONFIG`, `KERNELSRC_USRCONFIG` and `KERNEL_MENUCONFIG` are ignored and no kernel compilation tasks are performed.
315 315
316 316 ##### `RPI_FIRMWARE_DIR`=""
317 317 The directory (`firmware`) containing a local copy of the firmware from the [RaspberryPi firmware project](https://github.com/raspberrypi/firmware). Default is to download the latest firmware directly from the project.
318 318
319 319 ---
320 320
321 321 #### Reduce disk usage:
322 322 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
323 323
324 324 ##### `REDUCE_APT`=true
325 325 Configure APT to use compressed package repository lists and no package caching files.
326 326
327 327 ##### `REDUCE_DOC`=true
328 328 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
329 329
330 330 ##### `REDUCE_MAN`=true
331 331 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
332 332
333 333 ##### `REDUCE_VIM`=false
334 334 Replace `vim-tiny` package by `levee` a tiny vim clone.
335 335
336 336 ##### `REDUCE_BASH`=false
337 337 Remove `bash` package and switch to `dash` shell (experimental).
338 338
339 339 ##### `REDUCE_HWDB`=true
340 340 Remove PCI related hwdb files (experimental).
341 341
342 342 ##### `REDUCE_SSHD`=true
343 343 Replace `openssh-server` with `dropbear`.
344 344
345 345 ##### `REDUCE_LOCALE`=true
346 346 Remove all `locale` translation files.
347 347
348 348 ---
349 349
350 350 #### Encrypted root partition:
351 351 ##### `ENABLE_CRYPTFS`=false
352 352 Enable full system encryption with dm-crypt. Setup a fully LUKS encrypted root partition (aes-xts-plain64:sha512) and generate required initramfs. The /boot directory will not be encrypted. This parameter will be ignored if `BUILD_KERNEL`=false. `ENABLE_CRYPTFS` is experimental. SSH-to-initramfs is currently not supported but will be soon - feel free to help.
353 353
354 354 ##### `CRYPTFS_PASSWORD`=""
355 355 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
356 356
357 357 ##### `CRYPTFS_MAPPING`="secure"
358 358 Set name of dm-crypt managed device-mapper mapping.
359 359
360 360 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
361 361 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
362 362
363 363 ##### `CRYPTFS_XTSKEYSIZE`=512
364 364 Sets key size in bits. The argument has to be a multiple of 8.
365 365
366 366 ---
367 367
368 368 #### Build settings:
369 369 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
370 370 Set a path to a working directory used by the script to generate an image.
371 371
372 372 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
373 373 Set a filename for the output file(s). Note: the script will create $IMAGE_NAME.img if `ENABLE_SPLITFS`=false or $IMAGE_NAME-frmw.img and $IMAGE_NAME-root.img if `ENABLE_SPLITFS`=true. Note 2: If the KERNEL_BRANCH is not set, the word "CURRENT" is used.
374 374
375 375 ## Understanding the script
376 376 The functions of this script that are required for the different stages of the bootstrapping are split up into single files located inside the `bootstrap.d` directory. During the bootstrapping every script in this directory gets executed in lexicographical order:
377 377
378 378 | Script | Description |
379 379 | --- | --- |
380 380 | `10-bootstrap.sh` | Debootstrap basic system |
381 381 | `11-apt.sh` | Setup APT repositories |
382 382 | `12-locale.sh` | Setup Locales and keyboard settings |
383 383 | `13-kernel.sh` | Build and install RPi2/3 Kernel |
384 384 | `14-fstab.sh` | Setup fstab and initramfs |
385 385 | `15-rpi-config.sh` | Setup RPi2/3 config and cmdline |
386 386 | `20-networking.sh` | Setup Networking |
387 387 | `21-firewall.sh` | Setup Firewall |
388 388 | `30-security.sh` | Setup Users and Security settings |
389 389 | `31-logging.sh` | Setup Logging |
390 390 | `32-sshd.sh` | Setup SSH and public keys |
391 391 | `41-uboot.sh` | Build and Setup U-Boot |
392 392 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
393 393 | `50-firstboot.sh` | First boot actions |
394 394 | `99-reduce.sh` | Reduce the disk space usage |
395 395
396 396 All the required configuration files that will be copied to the generated OS image are located inside the `files` directory. It is not recommended to modify these configuration files manually.
397 397
398 398 | Directory | Description |
399 399 | --- | --- |
400 400 | `apt` | APT management configuration files |
401 401 | `boot` | Boot and RPi2/3 configuration files |
402 402 | `dpkg` | Package Manager configuration |
403 403 | `etc` | Configuration files and rc scripts |
404 404 | `firstboot` | Scripts that get executed on first boot |
405 405 | `initramfs` | Initramfs scripts |
406 406 | `iptables` | Firewall configuration files |
407 407 | `locales` | Locales configuration |
408 408 | `modules` | Kernel Modules configuration |
409 409 | `mount` | Fstab configuration |
410 410 | `network` | Networking configuration files |
411 411 | `sysctl.d` | Swapping and Network Hardening configuration |
412 412 | `xorg` | fbturbo Xorg driver configuration |
413 413
414 414 ## Custom packages and scripts
415 415 Debian custom packages, i.e. those not in the debian repositories, can be installed by placing them in the `packages` directory. They are installed immediately after packages from the repositories are installed. Any dependencies listed in the custom packages will be downloaded automatically from the repositories. Do not list these custom packages in `APT_INCLUDES`.
416 416
417 417 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
418 418
419 419 ## Logging of the bootstrapping process
420 420 All information related to the bootstrapping process and the commands executed by the `rpi23-gen-image.sh` script can easily be saved into a logfile. The common shell command `script` can be used for this purpose:
421 421
422 422 ```shell
423 423 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
424 424 ```
425 425
426 426 ## Flashing the image file
427 427 After the image file was successfully created by the `rpi23-gen-image.sh` script it can be copied to the microSD card that will be used by the RPi2/3 computer. This can be performed by using the tools `bmaptool` or `dd`. Using `bmaptool` will probably speed-up the copy process because `bmaptool` copies more wisely than `dd`.
428 428
429 429 ##### Flashing examples:
430 430 ```shell
431 431 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie.img /dev/mmcblk0
432 432 dd bs=4M if=./images/jessie/2017-01-23-rpi3-jessie.img of=/dev/mmcblk0
433 433 ```
434 434 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
435 435 ```shell
436 436 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-frmw.img /dev/mmcblk0
437 437 bmaptool copy ./images/jessie/2017-01-23-rpi3-jessie-root.img /dev/sdc
438 438 ```
439 439 ## Weekly image builds
440 440 The image files are provided by JRWR'S I/O PORT and are built once a Sunday at midnight UTC!
441 441 * [Debian Stretch Raspberry Pi2/3 Weekly Image Builds](https://jrwr.io/doku.php?id=projects:debianpi)
442 442
443 443 ## External links and references
444 444 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
445 445 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
446 446 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
447 447 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
448 448 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
449 449 * [U-BOOT git repository](http://git.denx.de/?p=u-boot.git;a=summary)
450 450 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
451 451 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
452 452 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
Show file before | Show file after | Hide comments
@@ -1,640 +1,653
1 1 #!/bin/sh
2 2
3 3 ########################################################################
4 4 # rpi23-gen-image.sh 2015-2017
5 5 #
6 6 # Advanced Debian "jessie" and "stretch" bootstrap script for RPi2/3
7 7 #
8 8 # This program is free software; you can redistribute it and/or
9 9 # modify it under the terms of the GNU General Public License
10 10 # as published by the Free Software Foundation; either version 2
11 11 # of the License, or (at your option) any later version.
12 12 #
13 13 # Copyright (C) 2015 Jan Wagner <mail@jwagner.eu>
14 14 #
15 15 # Big thanks for patches and enhancements by 10+ github contributors!
16 16 ########################################################################
17 17
18 18 # Are we running as root?
19 19 if [ "$(id -u)" -ne "0" ] ; then
20 20 echo "error: this script must be executed with root privileges!"
21 21 exit 1
22 22 fi
23 23
24 24 # Check if ./functions.sh script exists
25 25 if [ ! -r "./functions.sh" ] ; then
26 26 echo "error: './functions.sh' required script not found!"
27 27 exit 1
28 28 fi
29 29
30 30 # Load utility functions
31 31 . ./functions.sh
32 32
33 33 # Load parameters from configuration template file
34 34 if [ ! -z "$CONFIG_TEMPLATE" ] ; then
35 35 use_template
36 36 fi
37 37
38 38 # Introduce settings
39 39 set -e
40 40 echo -n -e "\n#\n# RPi2/3 Bootstrap Settings\n#\n"
41 41 set -x
42 42
43 43 # Raspberry Pi model configuration
44 44 RPI_MODEL=${RPI_MODEL:=2}
45 45 RPI2_DTB_FILE=${RPI2_DTB_FILE:=bcm2709-rpi-2-b.dtb}
46 46 RPI2_UBOOT_CONFIG=${RPI2_UBOOT_CONFIG:=rpi_2_defconfig}
47 47 RPI3_DTB_FILE=${RPI3_DTB_FILE:=bcm2710-rpi-3-b.dtb}
48 48 RPI3_UBOOT_CONFIG=${RPI3_UBOOT_CONFIG:=rpi_3_32b_defconfig}
49 49
50 50 # Debian release
51 51 RELEASE=${RELEASE:=jessie}
52 52 KERNEL_ARCH=${KERNEL_ARCH:=arm}
53 53 RELEASE_ARCH=${RELEASE_ARCH:=armhf}
54 54 CROSS_COMPILE=${CROSS_COMPILE:=arm-linux-gnueabihf-}
55 55 COLLABORA_KERNEL=${COLLABORA_KERNEL:=3.18.0-trunk-rpi2}
56 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcm2709_defconfig}
57 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel7.img}
58 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-arm-static}
56 if [ "$KERNEL_ARCH" = "arm64" ] ; then
57 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcmrpi3_defconfig}
58 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel8.img}
59 else
60 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcm2709_defconfig}
61 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel7.img}
62 fi
63 if [ "$RELEASE_ARCH" = "arm64" ] ; then
64 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-aarch64-static}
65 else
66 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-arm-static}
67 fi
59 68 KERNEL_BRANCH=${KERNEL_BRANCH:=""}
60 69
61 70 # URLs
62 71 KERNEL_URL=${KERNEL_URL:=https://github.com/raspberrypi/linux}
63 72 FIRMWARE_URL=${FIRMWARE_URL:=https://github.com/raspberrypi/firmware/raw/master/boot}
64 73 WLAN_FIRMWARE_URL=${WLAN_FIRMWARE_URL:=https://github.com/RPi-Distro/firmware-nonfree/raw/master/brcm80211/brcm}
65 74 COLLABORA_URL=${COLLABORA_URL:=https://repositories.collabora.co.uk/debian}
66 75 FBTURBO_URL=${FBTURBO_URL:=https://github.com/ssvb/xf86-video-fbturbo.git}
67 76 UBOOT_URL=${UBOOT_URL:=git://git.denx.de/u-boot.git}
68 77
69 78 # Build directories
70 79 BASEDIR=${BASEDIR:=$(pwd)/images/${RELEASE}}
71 80 BUILDDIR="${BASEDIR}/build"
72 81
73 82 # Prepare date string for default image file name
74 83 DATE="$(date +%Y-%m-%d)"
75 84 if [ -z "$KERNEL_BRANCH" ] ; then
76 85 IMAGE_NAME=${IMAGE_NAME:=${BASEDIR}/${DATE}-${KERNEL_ARCH}-CURRENT-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}}
77 86 else
78 87 IMAGE_NAME=${IMAGE_NAME:=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}}
79 88 fi
80 89
81 90 # Chroot directories
82 91 R="${BUILDDIR}/chroot"
83 92 ETC_DIR="${R}/etc"
84 93 LIB_DIR="${R}/lib"
85 94 BOOT_DIR="${R}/boot/firmware"
86 95 KERNEL_DIR="${R}/usr/src/linux"
87 96 WLAN_FIRMWARE_DIR="${R}/lib/firmware/brcm"
88 97
89 98 # Firmware directory: Blank if download from github
90 99 RPI_FIRMWARE_DIR=${RPI_FIRMWARE_DIR:=""}
91 100
92 101 # General settings
93 102 HOSTNAME=${HOSTNAME:=rpi${RPI_MODEL}-${RELEASE}}
94 103 PASSWORD=${PASSWORD:=raspberry}
95 104 USER_PASSWORD=${USER_PASSWORD:=raspberry}
96 105 DEFLOCAL=${DEFLOCAL:="en_US.UTF-8"}
97 106 TIMEZONE=${TIMEZONE:="Europe/Berlin"}
98 107 EXPANDROOT=${EXPANDROOT:=true}
99 108
100 109 # Keyboard settings
101 110 XKB_MODEL=${XKB_MODEL:=""}
102 111 XKB_LAYOUT=${XKB_LAYOUT:=""}
103 112 XKB_VARIANT=${XKB_VARIANT:=""}
104 113 XKB_OPTIONS=${XKB_OPTIONS:=""}
105 114
106 115 # Network settings (DHCP)
107 116 ENABLE_DHCP=${ENABLE_DHCP:=true}
108 117
109 118 # Network settings (static)
110 119 NET_ADDRESS=${NET_ADDRESS:=""}
111 120 NET_GATEWAY=${NET_GATEWAY:=""}
112 121 NET_DNS_1=${NET_DNS_1:=""}
113 122 NET_DNS_2=${NET_DNS_2:=""}
114 123 NET_DNS_DOMAINS=${NET_DNS_DOMAINS:=""}
115 124 NET_NTP_1=${NET_NTP_1:=""}
116 125 NET_NTP_2=${NET_NTP_2:=""}
117 126
118 127 # APT settings
119 128 APT_PROXY=${APT_PROXY:=""}
120 129 APT_SERVER=${APT_SERVER:="ftp.debian.org"}
121 130
122 131 # Feature settings
123 132 ENABLE_CONSOLE=${ENABLE_CONSOLE:=true}
124 133 ENABLE_I2C=${ENABLE_I2C:=false}
125 134 ENABLE_SPI=${ENABLE_SPI:=false}
126 135 ENABLE_IPV6=${ENABLE_IPV6:=true}
127 136 ENABLE_SSHD=${ENABLE_SSHD:=true}
128 137 ENABLE_NONFREE=${ENABLE_NONFREE:=false}
129 138 ENABLE_WIRELESS=${ENABLE_WIRELESS:=false}
130 139 ENABLE_SOUND=${ENABLE_SOUND:=true}
131 140 ENABLE_DBUS=${ENABLE_DBUS:=true}
132 141 ENABLE_HWRANDOM=${ENABLE_HWRANDOM:=true}
133 142 ENABLE_MINGPU=${ENABLE_MINGPU:=false}
134 143 ENABLE_XORG=${ENABLE_XORG:=false}
135 144 ENABLE_WM=${ENABLE_WM:=""}
136 145 ENABLE_RSYSLOG=${ENABLE_RSYSLOG:=true}
137 146 ENABLE_USER=${ENABLE_USER:=true}
138 147 USER_NAME=${USER_NAME:="pi"}
139 148 ENABLE_ROOT=${ENABLE_ROOT:=false}
140 149
141 150 # SSH settings
142 151 SSH_ENABLE_ROOT=${SSH_ENABLE_ROOT:=false}
143 152 SSH_DISABLE_PASSWORD_AUTH=${SSH_DISABLE_PASSWORD_AUTH:=false}
144 153 SSH_LIMIT_USERS=${SSH_LIMIT_USERS:=false}
145 154 SSH_ROOT_PUB_KEY=${SSH_ROOT_PUB_KEY:=""}
146 155 SSH_USER_PUB_KEY=${SSH_USER_PUB_KEY:=""}
147 156
148 157 # Advanced settings
149 158 ENABLE_MINBASE=${ENABLE_MINBASE:=false}
150 159 ENABLE_REDUCE=${ENABLE_REDUCE:=false}
151 160 ENABLE_UBOOT=${ENABLE_UBOOT:=false}
152 161 UBOOTSRC_DIR=${UBOOTSRC_DIR:=""}
153 162 ENABLE_FBTURBO=${ENABLE_FBTURBO:=false}
154 163 FBTURBOSRC_DIR=${FBTURBOSRC_DIR:=""}
155 164 ENABLE_HARDNET=${ENABLE_HARDNET:=false}
156 165 ENABLE_IPTABLES=${ENABLE_IPTABLES:=false}
157 166 ENABLE_SPLITFS=${ENABLE_SPLITFS:=false}
158 167 ENABLE_INITRAMFS=${ENABLE_INITRAMFS:=false}
159 168 ENABLE_IFNAMES=${ENABLE_IFNAMES:=true}
160 169 DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS:=}
161 170
162 171 # Kernel compilation settings
163 172 BUILD_KERNEL=${BUILD_KERNEL:=false}
164 173 KERNEL_REDUCE=${KERNEL_REDUCE:=false}
165 174 KERNEL_THREADS=${KERNEL_THREADS:=1}
166 175 KERNEL_HEADERS=${KERNEL_HEADERS:=true}
167 176 KERNEL_MENUCONFIG=${KERNEL_MENUCONFIG:=false}
168 177 KERNEL_REMOVESRC=${KERNEL_REMOVESRC:=true}
169 KERNEL_BIN_IMAGE=${KERNEL_BIN_IMAGE:="zImage"}
178 if [ "$KERNEL_ARCH" = "arm64" ] ; then
179 KERNEL_BIN_IMAGE=${KERNEL_BIN_IMAGE:="Image"}
180 else
181 KERNEL_BIN_IMAGE=${KERNEL_BIN_IMAGE:="zImage"}
182 fi
170 183
171 184 # Kernel compilation from source directory settings
172 185 KERNELSRC_DIR=${KERNELSRC_DIR:=""}
173 186 KERNELSRC_CLEAN=${KERNELSRC_CLEAN:=false}
174 187 KERNELSRC_CONFIG=${KERNELSRC_CONFIG:=true}
175 188 KERNELSRC_PREBUILT=${KERNELSRC_PREBUILT:=false}
176 189
177 190 # Reduce disk usage settings
178 191 REDUCE_APT=${REDUCE_APT:=true}
179 192 REDUCE_DOC=${REDUCE_DOC:=true}
180 193 REDUCE_MAN=${REDUCE_MAN:=true}
181 194 REDUCE_VIM=${REDUCE_VIM:=false}
182 195 REDUCE_BASH=${REDUCE_BASH:=false}
183 196 REDUCE_HWDB=${REDUCE_HWDB:=true}
184 197 REDUCE_SSHD=${REDUCE_SSHD:=true}
185 198 REDUCE_LOCALE=${REDUCE_LOCALE:=true}
186 199
187 200 # Encrypted filesystem settings
188 201 ENABLE_CRYPTFS=${ENABLE_CRYPTFS:=false}
189 202 CRYPTFS_PASSWORD=${CRYPTFS_PASSWORD:=""}
190 203 CRYPTFS_MAPPING=${CRYPTFS_MAPPING:="secure"}
191 204 CRYPTFS_CIPHER=${CRYPTFS_CIPHER:="aes-xts-plain64:sha512"}
192 205 CRYPTFS_XTSKEYSIZE=${CRYPTFS_XTSKEYSIZE:=512}
193 206
194 207 # Stop the Crypto Wars
195 208 DISABLE_FBI=${DISABLE_FBI:=false}
196 209
197 210 # Chroot scripts directory
198 211 CHROOT_SCRIPTS=${CHROOT_SCRIPTS:=""}
199 212
200 213 # Packages required in the chroot build environment
201 214 APT_INCLUDES=${APT_INCLUDES:=""}
202 215 APT_INCLUDES="${APT_INCLUDES},apt-transport-https,apt-utils,ca-certificates,debian-archive-keyring,dialog,sudo,systemd,sysvinit-utils"
203 216
204 217 # Packages required for bootstrapping
205 218 REQUIRED_PACKAGES="debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus sudo"
206 219 MISSING_PACKAGES=""
207 220
208 221 # Packages installed for c/c++ build environment in chroot (keep empty)
209 222 COMPILER_PACKAGES=""
210 223
211 224 set +x
212 225
213 226 # Set Raspberry Pi model specific configuration
214 227 if [ "$RPI_MODEL" = 2 ] ; then
215 228 DTB_FILE=${RPI2_DTB_FILE}
216 229 UBOOT_CONFIG=${RPI2_UBOOT_CONFIG}
217 230 elif [ "$RPI_MODEL" = 3 ] ; then
218 231 DTB_FILE=${RPI3_DTB_FILE}
219 232 UBOOT_CONFIG=${RPI3_UBOOT_CONFIG}
220 233 BUILD_KERNEL=true
221 234 else
222 235 echo "error: Raspberry Pi model ${RPI_MODEL} is not supported!"
223 236 exit 1
224 237 fi
225 238
226 239 # Check if the internal wireless interface is supported by the RPi model
227 240 if [ "$ENABLE_WIRELESS" = true ] && [ "$RPI_MODEL" != 3 ] ; then
228 241 echo "error: The selected Raspberry Pi model has no internal wireless interface"
229 242 exit 1
230 243 fi
231 244
232 245 # Check if DISABLE_UNDERVOLT_WARNINGS parameter value is supported
233 246 if [ ! -z "$DISABLE_UNDERVOLT_WARNINGS" ] ; then
234 247 if [ "$DISABLE_UNDERVOLT_WARNINGS" != 1 ] && [ "$DISABLE_UNDERVOLT_WARNINGS" != 2 ] ; then
235 248 echo "error: DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS} is not supported"
236 249 exit 1
237 250 fi
238 251 fi
239 252
240 253 # Build RPi2/3 Linux kernel if required by Debian release
241 254 if [ "$RELEASE" = "stretch" ] ; then
242 255 BUILD_KERNEL=true
243 256 fi
244 257
245 258 # Add packages required for kernel cross compilation
246 259 if [ "$BUILD_KERNEL" = true ] ; then
247 260 if [ "$KERNEL_ARCH" = "arm" ] ; then
248 261 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-armhf"
249 262 else
250 263 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-arm64"
251 264 fi
252 265 fi
253 266
254 267 # Add libncurses5 to enable kernel menuconfig
255 268 if [ "$KERNEL_MENUCONFIG" = true ] ; then
256 269 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} libncurses5-dev"
257 270 fi
258 271
259 272 # Stop the Crypto Wars
260 273 if [ "$DISABLE_FBI" = true ] ; then
261 274 ENABLE_CRYPTFS=true
262 275 fi
263 276
264 277 # Add cryptsetup package to enable filesystem encryption
265 278 if [ "$ENABLE_CRYPTFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
266 279 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} cryptsetup"
267 280 APT_INCLUDES="${APT_INCLUDES},cryptsetup"
268 281
269 282 if [ -z "$CRYPTFS_PASSWORD" ] ; then
270 283 echo "error: no password defined (CRYPTFS_PASSWORD)!"
271 284 exit 1
272 285 fi
273 286 ENABLE_INITRAMFS=true
274 287 fi
275 288
276 289 # Add initramfs generation tools
277 290 if [ "$ENABLE_INITRAMFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
278 291 APT_INCLUDES="${APT_INCLUDES},initramfs-tools"
279 292 fi
280 293
281 294 # Add device-tree-compiler required for building the U-Boot bootloader
282 295 if [ "$ENABLE_UBOOT" = true ] ; then
283 296 APT_INCLUDES="${APT_INCLUDES},device-tree-compiler"
284 297 fi
285 298
286 299 # Check if root SSH (v2) public key file exists
287 300 if [ ! -z "$SSH_ROOT_PUB_KEY" ] ; then
288 301 if [ ! -f "$SSH_ROOT_PUB_KEY" ] ; then
289 302 echo "error: '$SSH_ROOT_PUB_KEY' specified SSH public key file not found (SSH_ROOT_PUB_KEY)!"
290 303 exit 1
291 304 fi
292 305 fi
293 306
294 307 # Check if $USER_NAME SSH (v2) public key file exists
295 308 if [ ! -z "$SSH_USER_PUB_KEY" ] ; then
296 309 if [ ! -f "$SSH_USER_PUB_KEY" ] ; then
297 310 echo "error: '$SSH_USER_PUB_KEY' specified SSH public key file not found (SSH_USER_PUB_KEY)!"
298 311 exit 1
299 312 fi
300 313 fi
301 314
302 315 # Check if all required packages are installed on the build system
303 316 for package in $REQUIRED_PACKAGES ; do
304 317 if [ "`dpkg-query -W -f='${Status}' $package`" != "install ok installed" ] ; then
305 318 MISSING_PACKAGES="${MISSING_PACKAGES} $package"
306 319 fi
307 320 done
308 321
309 322 # If there are missing packages ask confirmation for install, or exit
310 323 if [ -n "$MISSING_PACKAGES" ] ; then
311 324 echo "the following packages needed by this script are not installed:"
312 325 echo "$MISSING_PACKAGES"
313 326
314 327 echo -n "\ndo you want to install the missing packages right now? [y/n] "
315 328 read confirm
316 329 [ "$confirm" != "y" ] && exit 1
317 330
318 331 # Make sure all missing required packages are installed
319 332 apt-get -qq -y install ${MISSING_PACKAGES}
320 333 fi
321 334
322 335 # Check if ./bootstrap.d directory exists
323 336 if [ ! -d "./bootstrap.d/" ] ; then
324 337 echo "error: './bootstrap.d' required directory not found!"
325 338 exit 1
326 339 fi
327 340
328 341 # Check if ./files directory exists
329 342 if [ ! -d "./files/" ] ; then
330 343 echo "error: './files' required directory not found!"
331 344 exit 1
332 345 fi
333 346
334 347 # Check if specified KERNELSRC_DIR directory exists
335 348 if [ -n "$KERNELSRC_DIR" ] && [ ! -d "$KERNELSRC_DIR" ] ; then
336 349 echo "error: '${KERNELSRC_DIR}' specified directory not found (KERNELSRC_DIR)!"
337 350 exit 1
338 351 fi
339 352
340 353 # Check if specified UBOOTSRC_DIR directory exists
341 354 if [ -n "$UBOOTSRC_DIR" ] && [ ! -d "$UBOOTSRC_DIR" ] ; then
342 355 echo "error: '${UBOOTSRC_DIR}' specified directory not found (UBOOTSRC_DIR)!"
343 356 exit 1
344 357 fi
345 358
346 359 # Check if specified FBTURBOSRC_DIR directory exists
347 360 if [ -n "$FBTURBOSRC_DIR" ] && [ ! -d "$FBTURBOSRC_DIR" ] ; then
348 361 echo "error: '${FBTURBOSRC_DIR}' specified directory not found (FBTURBOSRC_DIR)!"
349 362 exit 1
350 363 fi
351 364
352 365 # Check if specified CHROOT_SCRIPTS directory exists
353 366 if [ -n "$CHROOT_SCRIPTS" ] && [ ! -d "$CHROOT_SCRIPTS" ] ; then
354 367 echo "error: ${CHROOT_SCRIPTS} specified directory not found (CHROOT_SCRIPTS)!"
355 368 exit 1
356 369 fi
357 370
358 371 # Check if specified device mapping already exists (will be used by cryptsetup)
359 372 if [ -r "/dev/mapping/${CRYPTFS_MAPPING}" ] ; then
360 373 echo "error: mapping /dev/mapping/${CRYPTFS_MAPPING} already exists, not proceeding"
361 374 exit 1
362 375 fi
363 376
364 377 # Don't clobber an old build
365 378 if [ -e "$BUILDDIR" ] ; then
366 379 echo "error: directory ${BUILDDIR} already exists, not proceeding"
367 380 exit 1
368 381 fi
369 382
370 383 # Setup chroot directory
371 384 mkdir -p "${R}"
372 385
373 386 # Check if build directory has enough of free disk space >512MB
374 387 if [ "$(df --output=avail ${BUILDDIR} | sed "1d")" -le "524288" ] ; then
375 388 echo "error: ${BUILDDIR} not enough space left to generate the output image!"
376 389 exit 1
377 390 fi
378 391
379 392 set -x
380 393
381 394 # Call "cleanup" function on various signals and errors
382 395 trap cleanup 0 1 2 3 6
383 396
384 397 # Add required packages for the minbase installation
385 398 if [ "$ENABLE_MINBASE" = true ] ; then
386 399 APT_INCLUDES="${APT_INCLUDES},vim-tiny,netbase,net-tools,ifupdown"
387 400 fi
388 401
389 402 # Add required locales packages
390 403 if [ "$DEFLOCAL" != "en_US.UTF-8" ] ; then
391 404 APT_INCLUDES="${APT_INCLUDES},locales,keyboard-configuration,console-setup"
392 405 fi
393 406
394 407 # Add parted package, required to get partprobe utility
395 408 if [ "$EXPANDROOT" = true ] ; then
396 409 APT_INCLUDES="${APT_INCLUDES},parted"
397 410 fi
398 411
399 412 # Add dbus package, recommended if using systemd
400 413 if [ "$ENABLE_DBUS" = true ] ; then
401 414 APT_INCLUDES="${APT_INCLUDES},dbus"
402 415 fi
403 416
404 417 # Add iptables IPv4/IPv6 package
405 418 if [ "$ENABLE_IPTABLES" = true ] ; then
406 419 APT_INCLUDES="${APT_INCLUDES},iptables"
407 420 fi
408 421
409 422 # Add openssh server package
410 423 if [ "$ENABLE_SSHD" = true ] ; then
411 424 APT_INCLUDES="${APT_INCLUDES},openssh-server"
412 425 fi
413 426
414 427 # Add alsa-utils package
415 428 if [ "$ENABLE_SOUND" = true ] ; then
416 429 APT_INCLUDES="${APT_INCLUDES},alsa-utils"
417 430 fi
418 431
419 432 # Add rng-tools package
420 433 if [ "$ENABLE_HWRANDOM" = true ] ; then
421 434 APT_INCLUDES="${APT_INCLUDES},rng-tools"
422 435 fi
423 436
424 437 # Add fbturbo video driver
425 438 if [ "$ENABLE_FBTURBO" = true ] ; then
426 439 # Enable xorg package dependencies
427 440 ENABLE_XORG=true
428 441 fi
429 442
430 443 # Add user defined window manager package
431 444 if [ -n "$ENABLE_WM" ] ; then
432 445 APT_INCLUDES="${APT_INCLUDES},${ENABLE_WM}"
433 446
434 447 # Enable xorg package dependencies
435 448 ENABLE_XORG=true
436 449 fi
437 450
438 451 # Add xorg package
439 452 if [ "$ENABLE_XORG" = true ] ; then
440 453 APT_INCLUDES="${APT_INCLUDES},xorg"
441 454 fi
442 455
443 456 # Replace selected packages with smaller clones
444 457 if [ "$ENABLE_REDUCE" = true ] ; then
445 458 # Add levee package instead of vim-tiny
446 459 if [ "$REDUCE_VIM" = true ] ; then
447 460 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/vim-tiny/levee/")"
448 461 fi
449 462
450 463 # Add dropbear package instead of openssh-server
451 464 if [ "$REDUCE_SSHD" = true ] ; then
452 465 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/openssh-server/dropbear/")"
453 466 fi
454 467 fi
455 468
456 469 # Configure kernel sources if no KERNELSRC_DIR
457 470 if [ "$BUILD_KERNEL" = true ] && [ -z "$KERNELSRC_DIR" ] ; then
458 471 KERNELSRC_CONFIG=true
459 472 fi
460 473
461 474 # Configure reduced kernel
462 475 if [ "$KERNEL_REDUCE" = true ] ; then
463 476 KERNELSRC_CONFIG=false
464 477 fi
465 478
466 479 # Execute bootstrap scripts
467 480 for SCRIPT in bootstrap.d/*.sh; do
468 481 head -n 3 "$SCRIPT"
469 482 . "$SCRIPT"
470 483 done
471 484
472 485 ## Execute custom bootstrap scripts
473 486 if [ -d "custom.d" ] ; then
474 487 for SCRIPT in custom.d/*.sh; do
475 488 . "$SCRIPT"
476 489 done
477 490 fi
478 491
479 492 # Execute custom scripts inside the chroot
480 493 if [ -n "$CHROOT_SCRIPTS" ] && [ -d "$CHROOT_SCRIPTS" ] ; then
481 494 cp -r "${CHROOT_SCRIPTS}" "${R}/chroot_scripts"
482 495 chroot_exec /bin/bash -x <<'EOF'
483 496 for SCRIPT in /chroot_scripts/* ; do
484 497 if [ -f $SCRIPT -a -x $SCRIPT ] ; then
485 498 $SCRIPT
486 499 fi
487 500 done
488 501 EOF
489 502 rm -rf "${R}/chroot_scripts"
490 503 fi
491 504
492 505 # Remove c/c++ build environment from the chroot
493 506 chroot_remove_cc
494 507
495 508 # Remove apt-utils
496 509 if [ "$RELEASE" = "jessie" ] ; then
497 510 chroot_exec apt-get purge -qq -y --force-yes apt-utils
498 511 fi
499 512
500 513 # Generate required machine-id
501 514 MACHINE_ID=$(dbus-uuidgen)
502 515 echo -n "${MACHINE_ID}" > "${R}/var/lib/dbus/machine-id"
503 516 echo -n "${MACHINE_ID}" > "${ETC_DIR}/machine-id"
504 517
505 518 # APT Cleanup
506 519 chroot_exec apt-get -y clean
507 520 chroot_exec apt-get -y autoclean
508 521 chroot_exec apt-get -y autoremove
509 522
510 523 # Unmount mounted filesystems
511 524 umount -l "${R}/proc"
512 525 umount -l "${R}/sys"
513 526
514 527 # Clean up directories
515 528 rm -rf "${R}/run/*"
516 529 rm -rf "${R}/tmp/*"
517 530
518 531 # Clean up files
519 532 rm -f "${ETC_DIR}/ssh/ssh_host_*"
520 533 rm -f "${ETC_DIR}/dropbear/dropbear_*"
521 534 rm -f "${ETC_DIR}/apt/sources.list.save"
522 535 rm -f "${ETC_DIR}/resolvconf/resolv.conf.d/original"
523 536 rm -f "${ETC_DIR}/*-"
524 537 rm -f "${ETC_DIR}/apt/apt.conf.d/10proxy"
525 538 rm -f "${ETC_DIR}/resolv.conf"
526 539 rm -f "${R}/root/.bash_history"
527 540 rm -f "${R}/var/lib/urandom/random-seed"
528 541 rm -f "${R}/initrd.img"
529 542 rm -f "${R}/vmlinuz"
530 543 rm -f "${R}${QEMU_BINARY}"
531 544
532 545 # Calculate size of the chroot directory in KB
533 546 CHROOT_SIZE=$(expr `du -s "${R}" | awk '{ print $1 }'`)
534 547
535 548 # Calculate the amount of needed 512 Byte sectors
536 549 TABLE_SECTORS=$(expr 1 \* 1024 \* 1024 \/ 512)
537 550 FRMW_SECTORS=$(expr 64 \* 1024 \* 1024 \/ 512)
538 551 ROOT_OFFSET=$(expr ${TABLE_SECTORS} + ${FRMW_SECTORS})
539 552
540 553 # The root partition is EXT4
541 554 # This means more space than the actual used space of the chroot is used.
542 555 # As overhead for journaling and reserved blocks 25% are added.
543 556 ROOT_SECTORS=$(expr $(expr ${CHROOT_SIZE} + ${CHROOT_SIZE} \/ 100 \* 25) \* 1024 \/ 512)
544 557
545 558 # Calculate required image size in 512 Byte sectors
546 559 IMAGE_SECTORS=$(expr ${TABLE_SECTORS} + ${FRMW_SECTORS} + ${ROOT_SECTORS})
547 560
548 561 # Prepare image file
549 562 if [ "$ENABLE_SPLITFS" = true ] ; then
550 563 dd if=/dev/zero of="$IMAGE_NAME-frmw.img" bs=512 count=${TABLE_SECTORS}
551 564 dd if=/dev/zero of="$IMAGE_NAME-frmw.img" bs=512 count=0 seek=${FRMW_SECTORS}
552 565 dd if=/dev/zero of="$IMAGE_NAME-root.img" bs=512 count=${TABLE_SECTORS}
553 566 dd if=/dev/zero of="$IMAGE_NAME-root.img" bs=512 count=0 seek=${ROOT_SECTORS}
554 567
555 568 # Write firmware/boot partition tables
556 569 sfdisk -q -L -uS -f "$IMAGE_NAME-frmw.img" 2> /dev/null <<EOM
557 570 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
558 571 EOM
559 572
560 573 # Write root partition table
561 574 sfdisk -q -L -uS -f "$IMAGE_NAME-root.img" 2> /dev/null <<EOM
562 575 ${TABLE_SECTORS},${ROOT_SECTORS},83
563 576 EOM
564 577
565 578 # Setup temporary loop devices
566 579 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $IMAGE_NAME-frmw.img)"
567 580 ROOT_LOOP="$(losetup -o 1M -f --show $IMAGE_NAME-root.img)"
568 581 else # ENABLE_SPLITFS=false
569 582 dd if=/dev/zero of="$IMAGE_NAME.img" bs=512 count=${TABLE_SECTORS}
570 583 dd if=/dev/zero of="$IMAGE_NAME.img" bs=512 count=0 seek=${IMAGE_SECTORS}
571 584
572 585 # Write partition table
573 586 sfdisk -q -L -uS -f "$IMAGE_NAME.img" 2> /dev/null <<EOM
574 587 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
575 588 ${ROOT_OFFSET},${ROOT_SECTORS},83
576 589 EOM
577 590
578 591 # Setup temporary loop devices
579 592 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show $IMAGE_NAME.img)"
580 593 ROOT_LOOP="$(losetup -o 65M -f --show $IMAGE_NAME.img)"
581 594 fi
582 595
583 596 if [ "$ENABLE_CRYPTFS" = true ] ; then
584 597 # Create dummy ext4 fs
585 598 mkfs.ext4 "$ROOT_LOOP"
586 599
587 600 # Setup password keyfile
588 601 touch .password
589 602 chmod 600 .password
590 603 echo -n ${CRYPTFS_PASSWORD} > .password
591 604
592 605 # Initialize encrypted partition
593 606 echo "YES" | cryptsetup luksFormat "${ROOT_LOOP}" -c "${CRYPTFS_CIPHER}" -s "${CRYPTFS_XTSKEYSIZE}" .password
594 607
595 608 # Open encrypted partition and setup mapping
596 609 cryptsetup luksOpen "${ROOT_LOOP}" -d .password "${CRYPTFS_MAPPING}"
597 610
598 611 # Secure delete password keyfile
599 612 shred -zu .password
600 613
601 614 # Update temporary loop device
602 615 ROOT_LOOP="/dev/mapper/${CRYPTFS_MAPPING}"
603 616
604 617 # Wipe encrypted partition (encryption cipher is used for randomness)
605 618 dd if=/dev/zero of="${ROOT_LOOP}" bs=512 count=$(blockdev --getsz "${ROOT_LOOP}")
606 619 fi
607 620
608 621 # Build filesystems
609 622 mkfs.vfat "$FRMW_LOOP"
610 623 mkfs.ext4 "$ROOT_LOOP"
611 624
612 625 # Mount the temporary loop devices
613 626 mkdir -p "$BUILDDIR/mount"
614 627 mount "$ROOT_LOOP" "$BUILDDIR/mount"
615 628
616 629 mkdir -p "$BUILDDIR/mount/boot/firmware"
617 630 mount "$FRMW_LOOP" "$BUILDDIR/mount/boot/firmware"
618 631
619 632 # Copy all files from the chroot to the loop device mount point directory
620 633 rsync -a "${R}/" "$BUILDDIR/mount/"
621 634
622 635 # Unmount all temporary loop devices and mount points
623 636 cleanup
624 637
625 638 # Create block map file(s) of image(s)
626 639 if [ "$ENABLE_SPLITFS" = true ] ; then
627 640 # Create block map files for "bmaptool"
628 641 bmaptool create -o "$IMAGE_NAME-frmw.bmap" "$IMAGE_NAME-frmw.img"
629 642 bmaptool create -o "$IMAGE_NAME-root.bmap" "$IMAGE_NAME-root.img"
630 643
631 644 # Image was successfully created
632 645 echo "$IMAGE_NAME-frmw.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
633 646 echo "$IMAGE_NAME-root.img ($(expr \( ${TABLE_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
634 647 else
635 648 # Create block map file for "bmaptool"
636 649 bmaptool create -o "$IMAGE_NAME.bmap" "$IMAGE_NAME.img"
637 650
638 651 # Image was successfully created
639 652 echo "$IMAGE_NAME.img ($(expr \( ${TABLE_SECTORS} + ${FRMW_SECTORS} + ${ROOT_SECTORS} \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
640 653 fi
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant