├── tests ├── 0004.bats ├── 0002.bats ├── 0005.bats ├── test_helper.bash ├── 0008.bats ├── 0006.bats ├── 0007.bats ├── 0003.bats └── 0001.bats ├── .gitignore ├── exstage4.sh ├── .github └── workflows │ └── CI.yml ├── cpstage4.sh ├── README.md ├── mkstage4.sh └── LICENSE /tests/0004.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | load test_helper 4 | 5 | setup() { 6 | f test/boot/kernel 7 | d test/boot/boot 8 | mkstage4.sh -b -q -t test test 9 | } 10 | 11 | teardown() { 12 | rm -rf test test.tar.bz2 13 | } 14 | 15 | @test "/boot/kernel is excluded" { 16 | assert_tar_excludes test/boot/kernel 17 | } 18 | 19 | @test "/boot/boot is included" { 20 | skip "TODO: Not yet implemented" 21 | assert_tar_includes test/boot/boot 22 | } 23 | 24 | # vim: ft=bash 25 | -------------------------------------------------------------------------------- /tests/0002.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | load test_helper 4 | 5 | setup() { 6 | f test/usr/bin/ping 7 | f test/usr/bin/lost+found 8 | f test/lost+found 9 | mkstage4.sh -q -l -t test test 10 | } 11 | 12 | teardown() { 13 | rm -rf test test.tar.bz2 14 | } 15 | 16 | @test "/usr/bin/ping is included" { 17 | assert_tar_includes test/usr/bin/ping 18 | } 19 | 20 | @test "/usr/bin/lost+found is excluded" { 21 | assert_tar_excludes test/usr/bin/lost+found 22 | } 23 | 24 | @test "/lost+found is excluded" { 25 | assert_tar_excludes test/lost+found 26 | } 27 | 28 | # vim: ft=bash 29 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled source: 2 | *.com 3 | *.class 4 | *.dll 5 | *.exe 6 | *.o 7 | *.so 8 | 9 | # Logs and databases: 10 | *.log 11 | *.sql 12 | *.sqlite 13 | 14 | # OS generated files: 15 | .DS_Store 16 | .DS_Store? 17 | ._* 18 | .Trashes 19 | ehthumbs.db 20 | Thumbs.db 21 | 22 | # Python: 23 | *.pyc 24 | *.pyo 25 | 26 | # Data traces: 27 | output/* 28 | results/* 29 | */results/ 30 | image-*.pdf 31 | image.pdf 32 | image.pmg 33 | image*.png 34 | *.backup/ 35 | 36 | #geany 37 | geany_run_script.sh 38 | 39 | #Folders with non-free data: 40 | img*/ 41 | 42 | #Archive folders: 43 | */*/.old 44 | */.old 45 | .old 46 | 47 | #config files: 48 | #*.cfg 49 | 50 | #IPython: 51 | .ipynb_checkpoints/ 52 | 53 | #gedit 54 | *~ 55 | 56 | #git 57 | *.py.* 58 | 59 | #archives 60 | *.tar* 61 | -------------------------------------------------------------------------------- /exstage4.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | STAGE_FILE=${1} 4 | 5 | EXT="${STAGE_FILE##*.}" 6 | 7 | TARFILE="${STAGE_FILE%%.$EXT}" 8 | TAREXT="${TARFILE##*.}" 9 | 10 | if [[ $TAREXT != "tar" ]]; then 11 | echo "The stage file you are trying to unpack (\`$STAGE_FILE\`) does not appear to be an archived TAR file" 12 | else 13 | echo "Extracting \`${STAGE_FILE}\` inplace." 14 | fi 15 | 16 | if [ "$EXT" == "xz" ]; then 17 | tar -I 'xz -T0' -xvf "${STAGE_FILE}" --xattrs-include='*.*' --numeric-owner 18 | elif [ "$EXT" == "bz2" ]; then 19 | tar -I pbzip2 -xvf "${STAGE_FILE}" --xattrs-include='*.*' --numeric-owner 20 | elif [ "$EXT" == "gz" ]; then 21 | tar -I unpigz -xvf "${STAGE_FILE}" --xattrs-include='*.*' --numeric-owner 22 | else 23 | echo "Not sure how to unpack \`${STAGE_FILE}\`" 24 | fi 25 | -------------------------------------------------------------------------------- /tests/0005.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | load test_helper 4 | 5 | setup() { 6 | f test/var/lib/connman/file 7 | f test/root/.bash_history 8 | f test/home/user/.bash_history 9 | mkstage4.sh -c -q -t test test 10 | } 11 | 12 | teardown() { 13 | rm -rf test test.tar.bz2 14 | } 15 | 16 | @test "/var/lib/connman/file is excluded" { 17 | assert_tar_excludes test/var/lib/connman/file 18 | } 19 | 20 | @test "/var/lib/connman/ is included" { 21 | assert_tar_includes test/var/lib/connman/ 22 | } 23 | 24 | @test "/home/user/.bash_history is exlucded" { 25 | assert_tar_excludes test/home/user/.bash_history 26 | } 27 | 28 | @test "/home/user/ is included" { 29 | assert_tar_includes test/home/user/ 30 | } 31 | 32 | @test "/root/.bash_history is exlucded" { 33 | assert_tar_excludes test/root/.bash_history 34 | } 35 | 36 | @test "/root/ is included" { 37 | assert_tar_includes test/root/ 38 | } 39 | 40 | # vim: ft=bash 41 | -------------------------------------------------------------------------------- /.github/workflows/CI.yml: -------------------------------------------------------------------------------- 1 | name: "CI" 2 | on: [push, pull_request] 3 | jobs: 4 | shellcheck: 5 | name: "Shellcheck" 6 | runs-on: ubuntu-latest 7 | steps: 8 | - name: "Check out code" 9 | uses: actions/checkout@v1 10 | 11 | - name: "Run Shellcheck" 12 | uses: azohra/shell-linter@v0.3.0 13 | 14 | - name: "Run Shellcheck on BATS files" 15 | uses: azohra/shell-linter@v0.3.0 16 | with: 17 | path: "tests/*.bash,tests/*.bats" 18 | 19 | bats: 20 | name: "BATS Tests" 21 | runs-on: ubuntu-latest 22 | steps: 23 | - name: "Setup BATS testing framework" 24 | uses: mig4/setup-bats@v1.2.0 25 | with: 26 | bats-version: 1.9.0 27 | 28 | - name: "Check out code" 29 | uses: actions/checkout@v1 30 | 31 | - name: "Run BATS tests" 32 | run: bats -r tests 33 | -------------------------------------------------------------------------------- /tests/test_helper.bash: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | test_directory="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" 4 | export PATH="$test_directory/..:$PATH" 5 | 6 | # export so that uname hook in mkstage4.sh has access to var 7 | export TEST_UNAME="test-uname" 8 | uname() { echo "$TEST_UNAME"; } 9 | export -f uname 10 | 11 | # bypasses mkstage4.sh root check 12 | whoami() { echo "root"; } 13 | export -f whoami 14 | 15 | skip_if_not_root() { 16 | if [ "$EUID" -ne 0 ]; then 17 | skip "Must be root for this test." 18 | fi 19 | } 20 | 21 | d() { 22 | mkdir -p "${1}" 23 | } 24 | 25 | f() { 26 | mkdir -p "$(dirname "${1}")" && touch "${1}" 27 | } 28 | 29 | assert_tar_includes() { 30 | test -f "${1}" || test -d "${1}" 31 | tar --list -f "${2-test.tar.bz2}" | grep -q "^${1}$" 32 | } 33 | 34 | assert_tar_includes_partial() { 35 | tar --list -f "${2-test.tar.bz2}" | grep -q "${1}" 36 | } 37 | 38 | assert_tar_excludes() { 39 | test -f "${1}" || test -d "${1}" 40 | ! tar --list -f "${2-test.tar.bz2}" | grep -q "^${1}$" 41 | } 42 | 43 | assert_tar_excludes_partial() { 44 | ! tar --list -f "${2-test.tar.bz2}" | grep -q "${1}" 45 | } 46 | -------------------------------------------------------------------------------- /tests/0008.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | load test_helper 4 | 5 | setup() { 6 | f test/home/user/.dotfile 7 | f test/home/user/.keep 8 | f test/etc/ssh/key 9 | f test/etc/ssh/config 10 | f test/boot/boot 11 | f test/boot/kernel 12 | f test/mnt/5/media 13 | mkstage4.sh \ 14 | -i 'test/home/user/.keep' \ 15 | -e 'user/.*' \ 16 | -i 'test/etc/ssh/config' \ 17 | -e 'ssh' \ 18 | -b \ 19 | -i 'test/boot/boot' \ 20 | -i 'test/mnt/5' \ 21 | -q -t test test 22 | } 23 | 24 | teardown() { 25 | rm -rf test test.tar.bz2 26 | } 27 | 28 | @test "-i 'test/home/user/.keep and -e 'user/.*'" { 29 | assert_tar_excludes test/home/user/.dotfile 30 | assert_tar_includes test/home/user/.keep 31 | } 32 | 33 | @test "-i 'test/etc/ssh/config and -e 'ssh'" { 34 | assert_tar_excludes test/etc/ssh/key 35 | assert_tar_includes test/etc/ssh/config 36 | } 37 | 38 | @test "-i 'test/boot/boot' and -b" { 39 | assert_tar_excludes test/boot/kernel 40 | assert_tar_includes test/boot/boot 41 | } 42 | 43 | @test "-i 'test/mnt/5'" { 44 | assert_tar_includes test/mnt/5/media 45 | } 46 | 47 | # vim: ft=bash 48 | -------------------------------------------------------------------------------- /tests/0006.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | load test_helper 4 | 5 | setup() { 6 | f test/var/db/repos/gentoo/app-backup/mkstage4/ebuild 7 | f test/var/db/repos/science/sci-biology/fsl/ebuild 8 | f test/var/cache/distfiles/mkstage4.tar.gz 9 | f test/usr/portage/Manifest 10 | mkstage4.sh -q -t test test 11 | } 12 | 13 | teardown() { 14 | rm -rf test test.tar.bz2 15 | } 16 | 17 | @test "/var/db/repos/gentoo/ is included" { 18 | assert_tar_includes test/var/db/repos/gentoo/ 19 | } 20 | 21 | @test "/var/db/repos/gentoo/app-backup is excluded" { 22 | assert_tar_excludes_partial test/var/db/repos/gentoo/app-backup 23 | } 24 | 25 | @test "/var/db/repos/science/ is included" { 26 | assert_tar_includes test/var/db/repos/gentoo/ 27 | } 28 | 29 | @test "/var/db/repos/science/sci-biology is excluded" { 30 | assert_tar_excludes_partial test/var/db/repos/gentoo/app-backup 31 | } 32 | 33 | @test "/var/cache/distfiles/mkstage4.tar.gz is excluded" { 34 | assert_tar_excludes test/var/cache/distfiles/mkstage4.tar.gz 35 | } 36 | 37 | @test "/var/cache/distfiles/ is included" { 38 | assert_tar_includes test/var/cache/distfiles/ 39 | } 40 | 41 | @test "/usr/portage/Manifest is excluded" { 42 | assert_tar_excludes test/usr/portage/Manifest 43 | } 44 | 45 | @test "/usr/portage/ is included" { 46 | assert_tar_includes test/usr/portage/ 47 | } 48 | 49 | # vim: ft=bash 50 | -------------------------------------------------------------------------------- /tests/0007.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | load test_helper 4 | 5 | setup() { 6 | f test/usr/bin/lost+found 7 | f test/lost+found 8 | f test/home/user/.dotfile 9 | f test/home/user/chroot/var/tmp/file 10 | f test/home/user/ccache/file 11 | f test/root/ccache/file 12 | f test/etc/secrets/key 13 | mkstage4.sh -q -t test test0 14 | mkstage4.sh \ 15 | -e 'test/lost+found' \ 16 | -e 'user/.*' \ 17 | -e 'test/home/user/chroot/var/tmp/file' \ 18 | -e 'ccache/*' \ 19 | -e 'secrets' \ 20 | -q -t test test 21 | } 22 | 23 | teardown() { 24 | rm -rf test test.tar.bz2 test0.tar.bz2 25 | } 26 | 27 | @test "-e '/lost+found'" { 28 | assert_tar_includes test/usr/bin/lost+found test0.tar.bz2 29 | assert_tar_includes test/usr/bin/lost+found 30 | 31 | assert_tar_includes test/lost+found test0.tar.bz2 32 | assert_tar_excludes test/lost+found 33 | } 34 | 35 | @test "-e 'user/.*'" { 36 | assert_tar_includes test/home/user/.dotfile test0.tar.bz2 37 | assert_tar_excludes test/home/user/.dotfile 38 | assert_tar_includes test/home/user/ 39 | } 40 | 41 | @test "-e 'test/home/user/chroot/var/tmp/file'" { 42 | assert_tar_includes test/home/user/chroot/var/tmp/file test0.tar.bz2 43 | assert_tar_excludes test/home/user/chroot/var/tmp/file 44 | } 45 | 46 | @test "-e 'ccache/*'" { 47 | assert_tar_includes test/home/user/ccache/file test0.tar.bz2 48 | assert_tar_excludes test/home/user/ccache/file 49 | assert_tar_includes test/home/user/ccache/ 50 | 51 | assert_tar_includes test/root/ccache/file test0.tar.bz2 52 | assert_tar_excludes test/root/ccache/file 53 | assert_tar_includes test/root/ccache/ 54 | } 55 | 56 | @test "-e 'secrets'" { 57 | assert_tar_includes test/etc/secrets/key test0.tar.bz2 58 | assert_tar_excludes test/etc/secrets/key 59 | assert_tar_excludes test/etc/secrets/ 60 | } 61 | 62 | # vim: ft=bash 63 | -------------------------------------------------------------------------------- /tests/0003.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | load test_helper 4 | 5 | setup() { 6 | f test/usr/bin/ping 7 | f test/usr/src/linux-"$TEST_UNAME"/.config 8 | f test/usr/src/linux-"$TEST_UNAME"/vmlinux 9 | f test/usr/src/linux-different-uname/.config 10 | f test/usr/src/linux-different-uname/vmlinux 11 | f test/lib/modules/"$TEST_UNAME"/mod.ko 12 | f test/lib64/modules/"$TEST_UNAME"/mod.ko 13 | f test/lib/modules/different-uname/mod.ko 14 | f test/lib64/modules/different-uname/mod.ko 15 | mkstage4.sh -k -q -t test test 16 | } 17 | 18 | teardown() { 19 | rm -rf test test.tar.bz2 test.tar.bz2.ksrc test.tar.bz2.kmod 20 | } 21 | 22 | @test "/usr/bin/ping is included" { 23 | assert_tar_includes test/usr/bin/ping 24 | } 25 | 26 | @test "/usr/src/ is included" { 27 | assert_tar_includes test/usr/src/ 28 | } 29 | 30 | @test "/lib/modules/ is included" { 31 | assert_tar_includes test/lib/modules/ 32 | } 33 | 34 | @test "/lib64/modules/ is included" { 35 | assert_tar_includes test/lib64/modules/ 36 | } 37 | 38 | @test "/usr/src/linux-$TEST_UNAME/ is excluded" { 39 | assert_tar_excludes test/usr/src/linux-"$TEST_UNAME"/ 40 | } 41 | 42 | @test "/usr/src/linux-different-uname/ is excluded" { 43 | assert_tar_excludes test/usr/src/linux-different-uname/ 44 | } 45 | 46 | @test "/lib/modules/$TEST_UNAME/ is excluded" { 47 | assert_tar_excludes test/lib/modules/"$TEST_UNAME"/ 48 | } 49 | 50 | @test "/lib/modules/different-uname/ is excluded" { 51 | assert_tar_excludes test/lib/modules/different-uname/ 52 | } 53 | 54 | @test "/lib64/modules/$TEST_UNAME/ is excluded" { 55 | assert_tar_excludes test/lib64/modules/"$TEST_UNAME"/ 56 | } 57 | 58 | @test "/lib64/modules/different-uname/ is excluded" { 59 | assert_tar_excludes test/lib64/modules/different-uname/ 60 | } 61 | 62 | @test "/usr/src/linux-$TEST_UNAME/.config is included in ksrc" { 63 | assert_tar_includes test/usr/src/linux-"$TEST_UNAME"/.config test.tar.bz2.ksrc 64 | } 65 | 66 | @test "/usr/src/linux-$TEST_UNAME/vmlinux is included in ksrc" { 67 | assert_tar_includes test/usr/src/linux-"$TEST_UNAME"/vmlinux test.tar.bz2.ksrc 68 | } 69 | 70 | @test "/usr/src/linux-different-uname/ is excluded in ksrc" { 71 | assert_tar_excludes test/usr/src/linux-different-uname/ test.tar.bz2.ksrc 72 | } 73 | 74 | @test "/lib/modules/$TEST_UNAME/mod.ko is included in kmod" { 75 | assert_tar_includes test/lib/modules/"$TEST_UNAME"/mod.ko test.tar.bz2.kmod 76 | } 77 | 78 | @test "/lib64/modules/$TEST_UNAME/mod.ko is included in kmod" { 79 | assert_tar_includes test/lib64/modules/"$TEST_UNAME"/mod.ko test.tar.bz2.kmod 80 | } 81 | 82 | @test "/lib/modules/different-uname/ is excluded in kmod" { 83 | assert_tar_excludes test/lib/modules/different-uname/ test.tar.bz2.kmod 84 | } 85 | 86 | @test "/lib64/modules/different-uname/ is excluded in kmod" { 87 | assert_tar_excludes test/lib64/modules/different-uname/ test.tar.bz2.kmod 88 | } 89 | 90 | # vim: ft=bash 91 | -------------------------------------------------------------------------------- /tests/0001.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | load test_helper 4 | 5 | setup() { 6 | f test/.hiddenfile 7 | f test/usr/bin/ping 8 | f test/usr/bin/lost+found 9 | f test/usr/src/linux-"$TEST_UNAME"/.config 10 | f test/usr/src/linux-"$TEST_UNAME"/vmlinux 11 | f test/lib/modules/"$TEST_UNAME"/mod.ko 12 | f test/lib64/modules/"$TEST_UNAME"/mod.ko 13 | f test/dev/sda 14 | f test/proc/cpuinfo 15 | f test/run/pid 16 | d test/sys/fs 17 | f test/tmp/junk 18 | d test/media/cdrom 19 | f test/mnt/1/content 20 | f test/root/.bash_history 21 | f test/home/user/.bash_history 22 | f test/home/user/chroot/var/tmp/file 23 | f test/boot/kernel 24 | f test/var/tmp/file 25 | f test/var/lock/lockfile 26 | f test/var/run/pid 27 | f test/var/lib/docker/image 28 | f test/var/log/messages 29 | f test/var/log/portage/elog/.keep_sys-apps_portage-0 30 | mkstage4.sh -q -t test test 31 | } 32 | 33 | teardown() { 34 | rm -rf test test.tar.bz2 35 | } 36 | 37 | @test "/usr/bin/ping is included" { 38 | assert_tar_includes test/usr/bin/ping 39 | } 40 | 41 | @test "/usr/bin/lost+found is included" { 42 | assert_tar_includes test/usr/bin/lost+found 43 | } 44 | 45 | @test "/usr/src/linux-uname/.config is included" { 46 | assert_tar_includes test/usr/src/linux-"$TEST_UNAME"/.config 47 | } 48 | 49 | @test "/usr/src/linux-uname/vmlinux is included" { 50 | assert_tar_includes test/usr/src/linux-"$TEST_UNAME"/vmlinux 51 | } 52 | 53 | @test "/lib/modules/uname/mod.ko is included" { 54 | assert_tar_includes test/lib/modules/"$TEST_UNAME"/mod.ko 55 | } 56 | 57 | @test "/lib64/modules/uname/mod.ko is included" { 58 | assert_tar_includes test/lib64/modules/"$TEST_UNAME"/mod.ko 59 | } 60 | 61 | @test "/dev/* is excluded" { 62 | assert_tar_excludes test/dev/sda 63 | } 64 | 65 | @test "/var/tmp/* is excluded" { 66 | assert_tar_excludes test/var/tmp/file 67 | } 68 | 69 | @test "/media/* is excluded" { 70 | assert_tar_excludes test/media/cdrom 71 | } 72 | 73 | @test "/mnt/* is excluded" { 74 | assert_tar_excludes test/mnt/1 75 | } 76 | 77 | @test "/proc/* is excluded" { 78 | assert_tar_excludes test/proc/cpuinfo 79 | } 80 | 81 | @test "/run/* is excluded" { 82 | assert_tar_excludes test/run/pid 83 | } 84 | 85 | @test "/sys/* is excluded" { 86 | assert_tar_excludes test/sys/fs 87 | } 88 | 89 | @test "/tmp/* is excluded" { 90 | assert_tar_excludes test/tmp/junk 91 | } 92 | 93 | @test "/var/lock/* is excluded" { 94 | assert_tar_excludes test/var/lock/lockfile 95 | } 96 | 97 | @test "/var/log/* is excluded" { 98 | assert_tar_excludes test/var/log/messages 99 | } 100 | 101 | @test "/var/run/* is excluded" { 102 | assert_tar_excludes test/var/run/pid 103 | } 104 | 105 | @test "/var/lib/docker/* is excluded" { 106 | assert_tar_excludes test/var/lib/docker/image 107 | } 108 | 109 | @test "/dev/ is included" { 110 | assert_tar_includes test/dev/ 111 | } 112 | 113 | @test "/var/tmp/ is included" { 114 | assert_tar_includes test/var/tmp/ 115 | } 116 | 117 | @test "/media/ is included" { 118 | assert_tar_includes test/media/ 119 | } 120 | 121 | @test "/mnt/ is included" { 122 | assert_tar_includes test/mnt/ 123 | } 124 | 125 | @test "/proc/ is included" { 126 | assert_tar_includes test/proc/ 127 | } 128 | 129 | @test "/run/ is included" { 130 | assert_tar_includes test/run/ 131 | } 132 | 133 | @test "/sys/ is included" { 134 | assert_tar_includes test/sys/ 135 | } 136 | 137 | @test "/tmp/ is included" { 138 | assert_tar_includes test/tmp/ 139 | } 140 | 141 | @test "/var/lock/ is included" { 142 | assert_tar_includes test/var/lock/ 143 | } 144 | 145 | @test "/var/log/ is included" { 146 | assert_tar_includes test/var/log/ 147 | } 148 | 149 | @test "/var/run/ is included" { 150 | assert_tar_includes test/var/run/ 151 | } 152 | 153 | @test "/var/lib/docker/ is included" { 154 | assert_tar_includes test/var/lib/docker/ 155 | } 156 | 157 | @test "/boot/kernel is included" { 158 | assert_tar_includes test/boot/kernel 159 | } 160 | 161 | @test "/.hiddenfile is included" { 162 | assert_tar_includes test/.hiddenfile 163 | } 164 | 165 | @test "/var/log/**/.keep is included" { 166 | skip "TODO: Not yet implemented" 167 | assert_tar_includes test/var/log/portage/elog/.keep_sys-apps_portage-0 168 | } 169 | 170 | @test "/home/user/.bash_history is included" { 171 | assert_tar_includes test/home/user/.bash_history 172 | } 173 | 174 | @test "/root/.bash_history is included" { 175 | assert_tar_includes test/root/.bash_history 176 | } 177 | 178 | @test "/home/user/chroot/var/tmp/file is included" { 179 | assert_tar_includes test/home/user/chroot/var/tmp/file 180 | } 181 | 182 | # vim: ft=bash 183 | -------------------------------------------------------------------------------- /cpstage4.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # checks if run as root: 4 | if [ "$(whoami)" != 'root' ] 5 | then 6 | echo "$(basename "$0"): must be root." 7 | exit 1 8 | fi 9 | 10 | # set flag variables to null/default 11 | EXCLUDE_BOOT=0 12 | EXCLUDE_LOST=0 13 | QUIET=0 14 | HAS_PORTAGEQ=0 15 | 16 | if command -v portageq &>/dev/null 17 | then 18 | HAS_PORTAGEQ=1 19 | fi 20 | 21 | USAGE="Usage:\n\ 22 | $(basename "$0") [-b -c -k -l -q] [-e ] \n\ 23 | Positional Arguments:\n\ 24 | : from where to copy system files.\n\ 25 | : where to copy system files to.\n\ 26 | Flags:\n\ 27 | -b: excludes boot directory.\n\ 28 | -c: excludes some confidential files (currently only .bash_history and connman network lists).\n\ 29 | -e: an additional excludes directory (one dir one -e, donot use it with *).\n\ 30 | -l: excludes lost+found directory.\n\ 31 | -q: activate quiet mode (no confirmation).\n\ 32 | -h: display this help message." 33 | 34 | # reads options: 35 | while getopts ":e:bcelqh" flag 36 | do 37 | case "$flag" in 38 | c) 39 | EXCLUDE_CONFIDENTIAL=1 40 | ;; 41 | b) 42 | EXCLUDE_BOOT=1 43 | ;; 44 | l) 45 | EXCLUDE_LOST=1 46 | ;; 47 | e) 48 | USER_EXCL+=("--exclude=${OPTARG}") 49 | ;; 50 | q) 51 | QUIET=1 52 | ;; 53 | h) 54 | echo -e "$USAGE" 55 | exit 0 56 | ;; 57 | \?) 58 | echo "Invalid option: -$OPTARG" >&2 59 | exit 1 60 | ;; 61 | :) 62 | echo "Option -$OPTARG requires an argument." >&2 63 | exit 1 64 | ;; 65 | esac 66 | done 67 | 68 | # shifts pointer to read mandatory output file specification 69 | shift $((OPTIND - 1)) 70 | SOURCE=${1} 71 | DESTINATION=${2} 72 | 73 | if [ -z "$SOURCE" ] 74 | then 75 | echo "$(basename "$0"): no source specified." 76 | echo -e "$USAGE" 77 | exit 1 78 | fi 79 | if [ -z "$DESTINATION" ] 80 | then 81 | echo "$(basename "$0"): no source specified." 82 | echo -e "$USAGE" 83 | exit 1 84 | fi 85 | 86 | # make sure SOURCE path ends with slash 87 | if [[ "$SOURCE" != */ ]] 88 | then 89 | SOURCE="${SOURCE}/" 90 | fi 91 | # make sure DESTINATION path ends with slash 92 | if [[ "$DESTINATION" != */ ]] 93 | then 94 | DESTINATION="${DESTINATION}/" 95 | fi 96 | 97 | # checks for quiet mode (no confirmation) 98 | if ((QUIET)) 99 | then 100 | AGREE="yes" 101 | fi 102 | 103 | # Excludes: 104 | EXCLUDES=( 105 | "--exclude=${SOURCE}dev/*" 106 | "--exclude=${SOURCE}var/tmp/*" 107 | "--exclude=${SOURCE}media/*" 108 | "--exclude=${SOURCE}mnt/*/*" 109 | "--exclude=${SOURCE}proc/*" 110 | "--exclude=${SOURCE}run/*" 111 | "--exclude=${SOURCE}sys/*" 112 | "--exclude=${SOURCE}tmp/*" 113 | "--exclude=${SOURCE}var/lock/*" 114 | "--exclude=${SOURCE}var/log/*" 115 | "--exclude=${SOURCE}var/run/*" 116 | "--exclude=${SOURCE}var/lib/docker/*" 117 | ) 118 | 119 | EXCLUDES_DEFAULT_PORTAGE=( 120 | "--exclude=${SOURCE}var/db/repos/gentoo/*" 121 | "--exclude=${SOURCE}var/cache/distfiles/*" 122 | "--exclude=${SOURCE}usr/portage/*" 123 | ) 124 | 125 | EXCLUDES+=("${USER_EXCL[@]}") 126 | 127 | if [ "$SOURCE" == '/' ] 128 | then 129 | if ((HAS_PORTAGEQ)) 130 | then 131 | PORTAGEQ_REPOS=$(portageq get_repos /) 132 | for i in ${PORTAGEQ_REPOS}; do 133 | REPO_PATH=$(portageq get_repo_path / "${i}") 134 | EXCLUDES+=("--exclude=${REPO_PATH}/*") 135 | done 136 | EXCLUDES+=("--exclude=$(portageq distdir)/*") 137 | else 138 | EXCLUDES+=("${EXCLUDES_DEFAULT_PORTAGE[@]}") 139 | fi 140 | else 141 | EXCLUDES+=("${EXCLUDES_DEFAULT_PORTAGE[@]}") 142 | fi 143 | 144 | if ((EXCLUDE_BOOT)) 145 | then 146 | EXCLUDES+=("--exclude=${SOURCE}boot/*") 147 | fi 148 | 149 | if ((EXCLUDE_CONFIDENTIAL)) 150 | then 151 | EXCLUDES+=("--exclude=${SOURCE}home/*/.bash_history") 152 | EXCLUDES+=("--exclude=${SOURCE}root/.bash_history") 153 | EXCLUDES+=("--exclude=${SOURCE}var/lib/connman/*") 154 | fi 155 | 156 | if ((EXCLUDE_LOST)) 157 | then 158 | EXCLUDES+=("--exclude=lost+found") 159 | fi 160 | 161 | # Generic tar options: 162 | RSYNC_OPTIONS=( 163 | -avxHAXS 164 | --numeric-ids 165 | "--info=progress2" 166 | ) 167 | 168 | # if not in quiet mode, this message will be displayed: 169 | if [[ "$AGREE" != 'yes' ]] 170 | then 171 | echo "Are you sure that you want to copy system files located under" 172 | echo "$SOURCE" 173 | echo "to the following directory" 174 | echo "$DESTINATION" 175 | echo 176 | echo "WARNING: since all data is copied by default the user should exclude all" 177 | echo "security- or privacy-related files and directories, which are not" 178 | echo "already excluded, manually per cmdline." 179 | echo "example: \$ $(basename "$0") --exclude=/etc/ssh/ssh_host* " 180 | echo 181 | echo "COMMAND LINE PREVIEW:" 182 | echo 'rsync' "${RSYNC_OPTIONS[@]}" "${EXCLUDES[@]}" "${SOURCE}" "${DESTINATION}" 183 | echo 184 | echo -n 'Type "yes" to continue or anything else to quit: ' 185 | read -r AGREE 186 | fi 187 | 188 | # start stage4 creation: 189 | if [ "$AGREE" == 'yes' ] 190 | then 191 | rsync "${RSYNC_OPTIONS[@]}" "${EXCLUDES[@]}" "${SOURCE}" "${DESTINATION}" 192 | fi 193 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mkstage4 2 | 3 | ![CI](https://github.com/TheChymera/mkstage4/workflows/CI/badge.svg) 4 | [![GitHub release](https://img.shields.io/github/release/TheChymera/mkstage4.svg)](https://GitHub.com/TheChymera/mkstage4/releases/) 5 | [![Gentoo package](https://repology.org/badge/version-for-repo/gentoo/mkstage4.svg?header=Gentoo)](https://repology.org/project/mkstage4/versions) 6 | [![LiGurOS package](https://repology.org/badge/version-for-repo/liguros_stable/mkstage4.svg?header=LiGurOS)](https://repology.org/project/mkstage4/versions) 7 | 8 | This is a Bash script which creates “stage 4” tarballs (i.e. system archives) either for the running system, or a system at a specified mount point. 9 | The script was inspired by an earlier [mkstage4 script](https://github.com/gregf/bin/blob/master/mkstage4) by Greg Fitzgerald (unmaintained as of 2012) which itself was a revamped edition of the [original mkstage4](http://blinkeye.ch/dokuwiki/doku.php/projects/mkstage4) by Reto Glauser (unmaintained as of 2009). 10 | 11 | ## Installation 12 | 13 | The script can be run directly from its containing folder (and thus, is installed simply by downloading or cloning it from here - and adding run permissions): 14 | 15 | ```bash 16 | git clone https://github.com/TheChymera/mkstage4.git /your/mkstage4/directory 17 | cd /your/mkstage4/directory 18 | chmod +x cpstage4.sh exstage4.sh mkstage4.sh 19 | ``` 20 | 21 | For [Gentoo Linux](http://en.wikipedia.org/wiki/Gentoo_linux) and [Derivatives](http://en.wikipedia.org/wiki/Category:Gentoo_Linux_derivatives), mkstage4 is also available in [Portage](http://en.wikipedia.org/wiki/Portage_(software)) via the base Gentoo overlay. 22 | On any Gentoo system, just run the following command: 23 | 24 | ```bash 25 | emerge app-backup/mkstage4 26 | ``` 27 | 28 | ## Usage 29 | 30 | *If you are running the script from the containing folder (first install method) please make sure you use the e.g. `./mkstage4.sh` command instead of just `mkstage4`!* 31 | 32 | Note that the extension (e.g. `.tar.xz`) will be automatically appended to the `archive_name` string which you specify in calling the `mkstage4` command. 33 | This is done based on the compression type, which can be specifiled via the `-C` parameter, if another compression than the default (`bz2`, creating files ending in `.tar.bz2`) is desired. 34 | 35 | ### Examples 36 | 37 | Archive your current system (mounted at /): 38 | 39 | ```bash 40 | mkstage4 -s archive_name 41 | ``` 42 | 43 | Archive a system located at a custom mount point: 44 | 45 | ```bash 46 | mkstage4 -t /custom/mount/point archive_name 47 | ``` 48 | 49 | Copy a system to a separate drive, e.g. for quick backup. 50 | 51 | ```bash 52 | cpstage4 / /run/media/myuser/mybackupdrive 53 | ``` 54 | 55 | ### Command line arguments 56 | 57 | ```console 58 | Usage: 59 | mkstage4.sh [-b -c -k -l -q] [-C ] [-s || -t ] [-e ] [-i ] [custom-tar-options] 60 | -b: excludes boot directory. 61 | -c: excludes some confidential files (currently only .bash_history and connman network lists). 62 | -k: separately save current kernel modules and src (creates smaller archives and saves decompression time). 63 | -l: excludes lost+found directory. 64 | -q: activates quiet mode (no confirmation). 65 | -C: specify tar compression (default: bz2, available: lz4 xz bz2 zst gz). 66 | -s: makes tarball of current system. 67 | -t: makes tarball of system located at the . 68 | -e: an additional excludes directory (one dir one -e, donot use it with *). 69 | -i: an additional target to include. This has higher precedence than -e, -t, and -s. 70 | -h: displays help message. 71 | ``` 72 | 73 | ## System Tarball Extraction 74 | 75 | ### Automatic (Multi-threaded) 76 | 77 | We provide a script for convenient extraction, `exstage4`, which is shipped with this package. 78 | Currently it simply automates the Multi-threaded extraction selection listed below and otherwise has no functionality except checking that the file name looks sane. 79 | If in doubt, use one of the explicit extraction methods described below. 80 | Otherwise, you can extract an archive inplace with: 81 | 82 | ```bash 83 | exstage4 archive_name.tar.bz2 84 | ``` 85 | 86 | ### Explicit Single-threaded 87 | 88 | Tarballs created with mkstage4 can be extracted with: 89 | 90 | To preserve binary attributes and use numeric owner identifiers, you can simply append the relevant flags to the respective `tar` commands, e.g.: 91 | 92 | ```bash 93 | tar xvjpf archive_name.tar.bz2 --xattrs-include='*.*' --numeric-owner 94 | ``` 95 | 96 | If you use the `-k` option, extract the `src` and modules archives separately: 97 | 98 | ```bash 99 | tar xvjpf archive_name.tar.bz2.kmod 100 | tar xvjpf archive_name.tar.bz2.ksrc 101 | ``` 102 | 103 | ### Explicit Multi-threaded 104 | 105 | If you have a parallel de/compressor installed, you can extract the archive with one of the respective commands: 106 | 107 | #### `pbzip2` 108 | 109 | ```bash 110 | tar -I pbzip2 -xvf archive_name.tar.bz2 --xattrs-include='*.*' --numeric-owner 111 | ``` 112 | 113 | #### `xz` 114 | 115 | ```bash 116 | tar -I 'xz -T0' -xvf archive_name.tar.xz --xattrs-include='*.*' --numeric-owner 117 | ``` 118 | 119 | #### `gzip` 120 | 121 | Similarly to other compressors, `gzip` uses a separate binary for parallel decompression: 122 | 123 | ```bash 124 | tar -I unpigz -xvf archive_name.tar.gz --xattrs-include='*.*' --numeric-owner 125 | ``` 126 | 127 | ## Dependencies 128 | 129 | *Please note that these are very basic dependencies and should already be included in any Linux system.* 130 | 131 | * **[Bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell))** - in [Portage](http://en.wikipedia.org/wiki/Portage_(software)) as **[app-shells/bash](https://packages.gentoo.org/packages/app-shells/bash)** 132 | * **[tar](https://en.wikipedia.org/wiki/Tar_(computing))** - in Portage as **[app-arch/tar](https://packages.gentoo.org/packages/app-arch/tar)** 133 | * **[bzip2](https://gitlab.com/federicomenaquintero/bzip2)** - in Portage as **[app-arch/bzip2](https://packages.gentoo.org/packages/app-arch/bzip2)** (single thread, default compression) 134 | 135 | 136 | **Optionals**: 137 | *If one the following is installed the archive will be compressed using multiple parallel threads when available, in order of succession:* 138 | 139 | * `-C xz`: 140 | * **[xz](https://tukaani.org/xz/)** - in Portage as **[app-arch/xz](https://packages.gentoo.org/packages/app-arch/xz-utils)**, (parallel) 141 | * **[pixz](https://github.com/vasi/pixz)** - in Portage as **[app-arch/pixz](https://packages.gentoo.org/packages/app-arch/pixz)**, (parallel, indexed) 142 | 143 | * `-C bz2`: 144 | * **[pbzip2](https://launchpad.net/pbzip2/)** - in Portage as **[app-arch/pbzip2](https://packages.gentoo.org/packages/app-arch/pbzip2)**, (parallel) 145 | * **[lbzip2](https://github.com/kjn/lbzip2/)** - in Portage as **[app-arch/lbzip2](https://packages.gentoo.org/packages/app-arch/lbzip2)**, (parallel, faster and more efficient) 146 | 147 | * `-C gz`: 148 | * **[gzip](https://www.gnu.org/software/gzip/)** - in Portage as **[app-arch/gzip](https://packages.gentoo.org/packages/app-arch/gzip)**, (single thread) 149 | * **[pigz](https://www.zlib.net/pigz/)** - in Portage as **[app-arch/pigz](https://packages.gentoo.org/packages/app-arch/pigz)**, (parallel) 150 | 151 | * `-C lrz`: 152 | * **[lrzip](https://github.com/ckolivas/lrzip/)** - in Portage as **[app-arch/lrzip](https://packages.gentoo.org/packages/app-arch/lrzip)**, (parallel) 153 | 154 | * `-C lz`: 155 | * **[lzip](https://www.nongnu.org/lzip/)** - in Portage as **[app-arch/lzip](https://packages.gentoo.org/packages/app-arch/lzip)**, (single thread) 156 | * **[plzip](https://www.nongnu.org/lzip/plzip.html)** - in Portage as **[app-arch/plzip](https://packages.gentoo.org/packages/app-arch/plzip)**, (parallel) 157 | 158 | * `-C lz4`: 159 | * **[lz4](https://github.com/lz4/lz4)** - in Portage as **[app-arch/lz4](https://packages.gentoo.org/packages/app-arch/lz4)**, (parallel) 160 | 161 | * `-C lzo`: 162 | * **[lzop](https://www.lzop.org/)** - in Portage as **[app-arch/lzop](https://packages.gentoo.org/packages/app-arch/lzop)**, (parallel) 163 | 164 | * `-C zstd`: 165 | * **[zstd](https://facebook.github.io/zstd/)** - in Portage as **[app-arch/zstd](https://packages.gentoo.org/packages/app-arch/zstd)**, (parallel) 166 | 167 | -------------------------------------------------------------------------------- /mkstage4.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # checks if run as root: 4 | if [ "$(whoami)" != 'root' ] 5 | then 6 | echo "$(basename "$0"): must be root." 7 | exit 1 8 | fi 9 | 10 | # get available compression types 11 | declare -A COMPRESS_TYPES 12 | COMPRESS_TYPES=( 13 | ["bz2"]="bzip2 pbzip2 lbzip2" 14 | ["gz"]="gzip pigz" 15 | ["lrz"]="lrzip" 16 | ["lz"]="lzip plzip" 17 | ["lz4"]="lz4" 18 | ["lzo"]="lzop" 19 | ["xz"]="xz pixz" 20 | ["zst"]="zstd" 21 | ) 22 | declare -A COMPRESS_AVAILABLE 23 | for ext in "${!COMPRESS_TYPES[@]}"; do 24 | for exe in ${COMPRESS_TYPES[${ext}]}; do 25 | BIN=$(command -v "${exe}") 26 | if [ "${BIN}" != "" ]; then 27 | COMPRESS_AVAILABLE+=(["${ext}"]="${BIN}") 28 | fi 29 | done 30 | done 31 | 32 | # set flag variables to null/default 33 | EXCLUDE_BOOT=0 34 | EXCLUDE_CONFIDENTIAL=0 35 | EXCLUDE_LOST=0 36 | QUIET=0 37 | USER_EXCL=() 38 | USER_INCL=() 39 | S_KERNEL=0 40 | HAS_PORTAGEQ=0 41 | COMPRESS_TYPE="bz2" 42 | 43 | if command -v portageq &>/dev/null 44 | then 45 | HAS_PORTAGEQ=1 46 | fi 47 | 48 | USAGE="Usage:\n\ 49 | $(basename "$0") [-b -c -k -l -q] [-C ] [-s || -t ] [-e ] [-i ] [custom-tar-options]\n\ 50 | -b: excludes boot directory.\n\ 51 | -c: excludes some confidential files (currently only .bash_history and connman network lists).\n\ 52 | -k: separately save current kernel modules and src (creates smaller archives and saves decompression time).\n\ 53 | -l: excludes lost+found directory.\n\ 54 | -q: activates quiet mode (no confirmation).\n\ 55 | -C: specify tar compression (default: ${COMPRESS_TYPE}, available: ${!COMPRESS_AVAILABLE[*]}).\n\ 56 | -s: makes tarball of current system.\n\ 57 | -t: makes tarball of system located at the .\n\ 58 | -e: an additional excludes directory (one dir one -e, do not use it with *).\n\ 59 | -i: an additional target to include. This has higher precedence than -e, -t, and -s.\n\ 60 | -h: display this help message." 61 | 62 | # reads options: 63 | while getopts ":t:C:e:i:skqcblh" flag 64 | do 65 | case "$flag" in 66 | t) 67 | TARGET="$OPTARG" 68 | ;; 69 | s) 70 | TARGET="/" 71 | ;; 72 | C) 73 | COMPRESS_TYPE="$OPTARG" 74 | ;; 75 | q) 76 | QUIET=1 77 | ;; 78 | k) 79 | S_KERNEL=1 80 | ;; 81 | c) 82 | EXCLUDE_CONFIDENTIAL=1 83 | ;; 84 | b) 85 | EXCLUDE_BOOT=1 86 | ;; 87 | l) 88 | EXCLUDE_LOST=1 89 | ;; 90 | e) 91 | USER_EXCL+=("--exclude=${OPTARG}") 92 | ;; 93 | i) 94 | USER_INCL+=("${OPTARG}") 95 | ;; 96 | h) 97 | echo -e "$USAGE" 98 | exit 0 99 | ;; 100 | \?) 101 | echo "Invalid option: -$OPTARG" >&2 102 | exit 1 103 | ;; 104 | :) 105 | echo "Option -$OPTARG requires an argument." >&2 106 | exit 1 107 | ;; 108 | esac 109 | done 110 | 111 | if [ -z "$TARGET" ] 112 | then 113 | echo "$(basename "$0"): no target specified." 114 | echo -e "$USAGE" 115 | exit 1 116 | fi 117 | 118 | # make sure TARGET path ends with slash 119 | if [[ "$TARGET" != */ ]] 120 | then 121 | TARGET="${TARGET}/" 122 | fi 123 | 124 | # shifts pointer to read mandatory output file specification 125 | shift $((OPTIND - 1)) 126 | ARCHIVE=$1 127 | 128 | # checks for correct output file specification 129 | if [ -z "$ARCHIVE" ] 130 | then 131 | echo "$(basename "$0"): no archive file name specified." 132 | echo -e "$USAGE" 133 | exit 1 134 | fi 135 | 136 | # checks for quiet mode (no confirmation) 137 | if ((QUIET)) 138 | then 139 | AGREE="yes" 140 | fi 141 | 142 | # determines if filename was given with relative or absolute path 143 | if (($(grep -c '^/' <<< "$ARCHIVE") > 0)) 144 | then 145 | STAGE4_FILENAME="${ARCHIVE}.tar" 146 | else 147 | STAGE4_FILENAME="$(pwd)/${ARCHIVE}.tar" 148 | fi 149 | 150 | # Check if compression in option and filename 151 | if [ -z "$COMPRESS_TYPE" ] 152 | then 153 | echo "$(basename "$0"): no archive compression type specified." 154 | echo -e "$USAGE" 155 | exit 1 156 | else 157 | STAGE4_FILENAME="${STAGE4_FILENAME}.${COMPRESS_TYPE}" 158 | fi 159 | 160 | # Check if specified type is available 161 | if [ -z "${COMPRESS_AVAILABLE[$COMPRESS_TYPE]}" ] 162 | then 163 | echo "$(basename "$0"): specified archive compression type not supported." 164 | echo "Supported: ${COMPRESS_AVAILABLE[*]}" 165 | exit 1 166 | fi 167 | 168 | # Shifts pointer to read custom tar options 169 | shift 170 | mapfile -t OPTIONS <<< "$@" 171 | # Handle when no options are passed 172 | ((${#OPTIONS[@]} == 1)) && [ -z "${OPTIONS[0]}" ] && unset OPTIONS 173 | 174 | if ((S_KERNEL)) 175 | then 176 | USER_EXCL+=("--exclude=${TARGET}usr/src/*") 177 | USER_EXCL+=("--exclude=${TARGET}lib*/modules/*") 178 | fi 179 | 180 | 181 | # Excludes: 182 | EXCLUDES=( 183 | "--exclude=${TARGET}dev/*" 184 | "--exclude=${TARGET}var/tmp/*" 185 | "--exclude=${TARGET}media/*" 186 | "--exclude=${TARGET}mnt/*/*" 187 | "--exclude=${TARGET}proc/*" 188 | "--exclude=${TARGET}run/*" 189 | "--exclude=${TARGET}sys/*" 190 | "--exclude=${TARGET}tmp/*" 191 | "--exclude=${TARGET}var/lock/*" 192 | "--exclude=${TARGET}var/log/*" 193 | "--exclude=${TARGET}var/run/*" 194 | "--exclude=${TARGET}var/lib/docker/*" 195 | ) 196 | 197 | EXCLUDES_DEFAULT_PORTAGE=( 198 | "--exclude=${TARGET}var/db/repos/*/*" 199 | "--exclude=${TARGET}var/cache/distfiles/*" 200 | "--exclude=${TARGET}usr/portage/*" 201 | ) 202 | 203 | EXCLUDES+=("${USER_EXCL[@]}") 204 | 205 | INCLUDES=( 206 | ) 207 | 208 | INCLUDES+=("${USER_INCL[@]}") 209 | 210 | if [ "$TARGET" == '/' ] 211 | then 212 | EXCLUDES+=("--exclude=$(realpath "$STAGE4_FILENAME")") 213 | if ((HAS_PORTAGEQ)) 214 | then 215 | PORTAGEQ_REPOS=$(portageq get_repos /) 216 | for i in ${PORTAGEQ_REPOS}; do 217 | REPO_PATH=$(portageq get_repo_path / "${i}") 218 | EXCLUDES+=("--exclude=${REPO_PATH}/*") 219 | done 220 | EXCLUDES+=("--exclude=$(portageq distdir)/*") 221 | else 222 | EXCLUDES+=("${EXCLUDES_DEFAULT_PORTAGE[@]}") 223 | fi 224 | else 225 | EXCLUDES+=("${EXCLUDES_DEFAULT_PORTAGE[@]}") 226 | fi 227 | 228 | if ((EXCLUDE_CONFIDENTIAL)) 229 | then 230 | EXCLUDES+=("--exclude=${TARGET}home/*/.bash_history") 231 | EXCLUDES+=("--exclude=${TARGET}root/.bash_history") 232 | EXCLUDES+=("--exclude=${TARGET}var/lib/connman/*") 233 | fi 234 | 235 | if ((EXCLUDE_BOOT)) 236 | then 237 | EXCLUDES+=("--exclude=${TARGET}boot/*") 238 | fi 239 | 240 | if ((EXCLUDE_LOST)) 241 | then 242 | EXCLUDES+=("--exclude=lost+found") 243 | fi 244 | 245 | # Compression options 246 | COMP_OPTIONS=("${COMPRESS_AVAILABLE[$COMPRESS_TYPE]}") 247 | if [[ "${COMPRESS_AVAILABLE[$COMPRESS_TYPE]}" == *"/xz" ]] 248 | then 249 | COMP_OPTIONS+=( "-T0" ) 250 | fi 251 | 252 | # Generic tar options: 253 | TAR_OPTIONS=( 254 | -cpP 255 | --ignore-failed-read 256 | "--xattrs-include=*.*" 257 | --numeric-owner 258 | "--checkpoint=.500" 259 | "--use-compress-prog=${COMP_OPTIONS[*]}" 260 | ) 261 | 262 | # if not in quiet mode, this message will be displayed: 263 | if [[ "$AGREE" != 'yes' ]] 264 | then 265 | echo "Are you sure that you want to make a stage 4 tarball of the system" 266 | echo "located under the following directory?" 267 | echo "$TARGET" 268 | echo 269 | echo "WARNING: since all data is saved by default the user should exclude all" 270 | echo "security- or privacy-related files and directories, which are not" 271 | echo "already excluded by mkstage4 options (such as -c), manually per cmdline." 272 | echo "example: \$ $(basename "$0") -s /my-backup --exclude=/etc/ssh/ssh_host*" 273 | echo 274 | echo "COMMAND LINE PREVIEW:" 275 | echo 'tar' "${TAR_OPTIONS[@]}" "${INCLUDES[@]}" "${EXCLUDES[@]}" "${OPTIONS[@]}" -f "$STAGE4_FILENAME" "${TARGET}" 276 | if ((S_KERNEL)) 277 | then 278 | echo 279 | echo 'tar' "${TAR_OPTIONS[@]}" -f "$STAGE4_FILENAME.ksrc" "${TARGET}usr/src/linux-$(uname -r)" 280 | echo 'tar' "${TAR_OPTIONS[@]}" -f "$STAGE4_FILENAME.kmod" "${TARGET}lib"*"/modules/$(uname -r)" 281 | fi 282 | echo 283 | echo -n 'Type "yes" to continue or anything else to quit: ' 284 | read -r AGREE 285 | fi 286 | 287 | # start stage4 creation: 288 | if [ "$AGREE" == 'yes' ] 289 | then 290 | tar "${TAR_OPTIONS[@]}" "${INCLUDES[@]}" "${EXCLUDES[@]}" "${OPTIONS[@]}" -f "$STAGE4_FILENAME" "${TARGET}" 291 | if ((S_KERNEL)) 292 | then 293 | tar "${TAR_OPTIONS[@]}" -f "$STAGE4_FILENAME.ksrc" "${TARGET}usr/src/linux-$(uname -r)" 294 | tar "${TAR_OPTIONS[@]}" -f "$STAGE4_FILENAME.kmod" "${TARGET}lib"*"/modules/$(uname -r)" 295 | fi 296 | fi 297 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------