├── sysprep-op-yum-uuid.sh
├── sysprep-op-bash-history.sh
├── sysprep-op-cloud-init.sh
├── sysprep-op-crash-data.sh
├── sysprep-op-package-manager-db.sh
├── sysprep-op-package-manager-cache.sh
├── README.md
├── sysprep-op-mail-spool.sh
├── sysprep-op-firewall-rules.sh
├── sysprep-op-dhcp-client-state.sh
├── sysprep-op-machine-id.sh
├── sysprep-op-ssh-hostkeys.sh
├── sysprep-op-tmp-files.sh
├── sysprep-op-logfiles.sh
└── License.md
/sysprep-op-yum-uuid.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | #
3 | # Remove the yum package manager UUID associated with the guest
4 | #
5 | # A new UUID will be automatically generated the next time yum is run
6 | set -o errexit
7 |
8 | uuid="/var/lib/yum/uuid"
9 | [[ -e ${uuid} ]] && rm -f ${uuid}
10 |
11 | exit 0
12 |
--------------------------------------------------------------------------------
/sysprep-op-bash-history.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | #
3 | # Remove bash history for root and system users
4 | set -o errexit
5 |
6 | roots_hist="$(find /root -type f -name .bash_history)"
7 | users_hist="$(find /home -type f -name .bash_history | tr -s '\n' ' ')"
8 |
9 | rm -f ${roots_hist} ${users_hist}
10 |
11 | exit 0
12 |
--------------------------------------------------------------------------------
/sysprep-op-cloud-init.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | #
3 | # Remove all cloud-init run-time data and logs
4 | #
5 | # The removal completely resets cloud-init. When the instance is next
6 | # started cloud-init will run all configured modules as if running for the
7 | # first time
8 | set -o errexit
9 |
10 | rm -rf /var/lib/cloud/*
11 | rm -f /var/log/cloud-init.log
12 |
13 | exit 0
14 |
--------------------------------------------------------------------------------
/sysprep-op-crash-data.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | #
3 | # Remove crash data generated by kexec-tools
4 | set -o errexit
5 |
6 | crash_data_location=(
7 | "/var/crash/*"
8 | "/var/log/dump/*"
9 | )
10 |
11 | # Include hidden files in glob
12 | shopt -s nullglob dotglob
13 |
14 | for crash_data in ${crash_data_location[@]}
15 | do
16 | rm -rf ${crash_data}
17 | done
18 |
19 | exit 0
20 |
--------------------------------------------------------------------------------
/sysprep-op-package-manager-db.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | #
3 | # Remove dynamically created package manager files
4 | #
5 | set -o errexit
6 |
7 | # RPM Host DB files. RPM will recreate these files automatically if needed
8 | rm -f /var/lib/rpm/__db.*
9 |
10 | # APT lists. APT will recreate these on the first 'apt update'
11 | apt_lists=/var/lib/apt/lists
12 | if [ -d "${apt_lists}" ]; then
13 | find "${apt_lists}" -type f | xargs rm -f
14 | fi
15 |
16 | exit 0
17 |
--------------------------------------------------------------------------------
/sysprep-op-package-manager-cache.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | #
3 | # Remove cache files associated with the guests package manager
4 | set -o errexit
5 |
6 | # Set the locations under which various package managers store cache files
7 | cache_locations=(
8 | # Debian and derivatives
9 | "/var/cache/apt/"
10 | # Fedora
11 | "/var/cache/dnf/"
12 | # Red Hat and derivatives
13 | "/var/cache/yum/"
14 | # SUSE and openSUSE
15 | "/var/cache/zypp*"
16 | )
17 |
18 | # Note that globs in the cache locations will be auto expanded by bash
19 | for cache_dir in ${cache_locations[@]}
20 | do
21 | if [ -d ${cache_dir} ]; then
22 | # Recursively remove all files from under the given directory
23 | find ${cache_dir} -type f | xargs -I FILE rm -f FILE
24 | fi
25 | done
26 |
27 | exit 0
28 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Packer-Virt-Sysprep
2 |
3 | ---
4 |
5 | Scripts to clean and prepare a VM for cloning à la
6 | [libguestfs](http://libguestfs.org)'s
7 | [virt-sysprep](http://libguestfs.org/virt-sysprep.1.html) but from
8 | within a *running* guest.
9 |
10 | The intention is to provide
11 | [virt-sysprep](http://libguestfs.org/virt-sysprep.1.html) style
12 | **operations** such as log removal, removal of a guests host ssh keys,
13 | deletion of custom firewall rules etc for use with automated build tools
14 | such as [packer](http://www.packer.io).
15 |
16 | Currently [libguestfs](http://libguestfs.org) is not available for all
17 | host platforms. Additionally
18 | [virt-sysprep](http://libguestfs.org/virt-sysprep.1.html) requires that
19 | the guest VM be shutdown prior to use.
20 |
21 | ---
22 |
23 | Please see the
24 | [packer-virt-sysprep-example](https://github.com/DanHam/packer-virt-sysprep-example)
25 | repository for example usage and further details.
26 |
--------------------------------------------------------------------------------
/sysprep-op-mail-spool.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | #
3 | # Remove mail from the local mail spool
4 | set -o errexit
5 |
6 | mta_list=(
7 | "exim"
8 | "postfix"
9 | "sendmail"
10 | )
11 |
12 | mail_spool_locations=(
13 | "/var/spool/mail/*"
14 | "/var/mail/*"
15 | )
16 |
17 | # Best effort attempt to stop any MTA service
18 | for mta in ${mta_list[@]}
19 | do
20 | # Systemd
21 | if command -v systemctl &>/dev/null ; then
22 | mta_service="$(systemctl list-units --type service | grep ${mta} | \
23 | cut -d' ' -f1)"
24 | if [ "x${mta_service}" != "x" ]; then
25 | if systemctl is-active ${mta_service} &>/dev/null; then
26 | systemctl stop ${mta_service}
27 | fi
28 | fi
29 | # Sys-v-init
30 | else
31 | mta_service="$(find /etc/init.d/ -iname "*${mta}*")"
32 | if [ "x${mta_service}" != "x" ]; then
33 | if ${mta_service} status | grep running &>/dev/null; then
34 | ${mta_service} stop
35 | fi
36 | fi
37 | fi
38 | done
39 |
40 |
41 | # Include hidden files in globs
42 | shopt -s nullglob dotglob
43 |
44 | # Remove any mail
45 | for mail_spool in ${mail_spool_locations[@]}
46 | do
47 | rm -rf ${mail_spool}
48 | done
49 |
50 | exit 0
51 |
--------------------------------------------------------------------------------
/sysprep-op-firewall-rules.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | #
3 | # Remove any custom firewall rules or firewalld configuration
4 | #
5 | # Modern systems typically make use of the dynamic firewall daemon
6 | # firewalld which provides many advantages and additional features over
7 | # more traditional approaches. Customisation of the systems firewall rules
8 | # it handled through user space tools that output configuration
9 | # customisations to /etc/firewalld/zones and /etc/firewalld/services.
10 | # Deleting these files will remove any custom configuration from the
11 | # system
12 | #
13 | # Older systems or other firewall implementations usually persist rules
14 | # information for iptables in /etc/sysconfig/iptables and use the file to
15 | # configure the firewall at startup. As such simply deleting the file will
16 | # be enough to remove any custom configuration from the system
17 | set -o errexit
18 |
19 | fw_config_locations=(
20 | "/etc/sysconfig/iptables"
21 | "/etc/firewalld/services/*"
22 | "/etc/firewalld/zones/*"
23 | )
24 |
25 | # If using firewalld stop the daemon/service prior to removing the config
26 | if command -v systemctl &>/dev/null; then
27 | if systemctl is-active firewalld.service &>/dev/null; then
28 | systemctl stop firewalld.service
29 | fi
30 | fi
31 |
32 | # Include hidden files in globs
33 | shopt -s nullglob dotglob
34 |
35 | # Remove any custom configuration
36 | for fw_config in ${fw_config_locations[@]}
37 | do
38 | rm -rf ${fw_config}
39 | done
40 |
41 | exit 0
42 |
--------------------------------------------------------------------------------
/sysprep-op-dhcp-client-state.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | #
3 | # Remove DHCP client lease information. Note that Debian 10, and possibly
4 | # other OSes, now write a machine specific DUID (DHCP Unique ID) to the
5 | # leases file
6 | set -o errexit
7 |
8 | lease_data_locations=(
9 | "/var/lib/dhclient/*"
10 | "/var/lib/dhcp/*"
11 | )
12 |
13 | # Include hidden files in glob
14 | shopt -s nullglob dotglob
15 |
16 | # Ensure all interfaces are down prior to removing the leases file.
17 | # Otherwise the file is recreated by ifdown/dhclient
18 | for iface in $(ls /sys/class/net/ | grep -v lo); do
19 | # Wait for each interface to be taken down. Timeout after 20 secs
20 | timer=0
21 | while grep up "/sys/class/net/${iface}/operstate" &>/dev/null && \
22 | [[ timer -lt 20 ]]; do
23 | sleep 1
24 | let timer=${timer}+1
25 | done
26 |
27 | # If the interface is still up it is likely something has gone wrong
28 | # with the usual procedures that take the interface down at shutdown.
29 | # Make a best effort attempt to take the interface down manually
30 | # temporarily ignoring errors
31 | if grep up "/sys/class/net/${iface}/operstate" &>/dev/null; then
32 | set +o errexit
33 | ifdown ${iface}
34 | set -o errexit
35 | fi
36 |
37 | # Some implementations start the dhcp client when the interface is taken
38 | # down (even if the interface is statically configured). It is the dhcp
39 | # client that writes out to the leases file when the interface goes
40 | # down. Kill the client as a precautionary measure to prevent further
41 | # interference. Ignore errors in case the dhclient exits between
42 | # obtaining its pid and killing it
43 | pid="$(ps aux | grep /sbin/dhclient | grep "${iface}" | tr -s " " | \
44 | cut -d' ' -f2)"
45 | if [ "x${pid}" != "x" ]; then
46 | set +o errexit
47 | kill -9 "${pid}"
48 | set -o errexit
49 | fi
50 | done
51 |
52 | # Now that all interfaces are down remove all lease files
53 | for lease_file in ${lease_data_locations[@]}; do
54 | rm -f ${lease_file}
55 | done
56 |
57 | exit 0
58 |
--------------------------------------------------------------------------------
/sysprep-op-machine-id.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | #
3 | # Remove the local machine id prevent the possibility of machines having
4 | # duplicate identities post cloning operations
5 | #
6 | # The machine id is a identifier first generated at install from a random
7 | # source. The id then persists for all subsequent boots and can be used to
8 | # uniquely identify the system within the network. The machine-id is often
9 | # used in preference to other identifiers such as a mac address, that may
10 | # infact change over the lifetime of the machine
11 | #
12 | # For older systems the machine-id is located at /var/lib/dbus/machine-id
13 | # and is generated using the dbus-uuid utility.
14 | # To trigger the generation of a new machine-id, the machine-id file must
15 | # simply be removed. dbus will then create a new file and populate it with
16 | # a machine-id string on next boot. Note that if the file is only emptied
17 | # (rather than completely removed) then dbus will simply complain about
18 | # the fact and will NOT generate a new machine-id.
19 | #
20 | # For more modern systems the machine-id file is located at
21 | # /etc/machine-id and /var/lib/dbus/machine-id (if present) is either a
22 | # copy of /etc/machine-id or is simply a symlink pointing to it.
23 | # Modern systems now use the 'systemd-machine-id-setup' utility to
24 | # generate the id file in place of the dbus-uuid tool employed on older
25 | # systems.
26 | # To trigger the generation of a new machine-id the machine-id file under
27 | # /etc must be emptied (NOT removed) and the machine-id file under
28 | # /var/lib/dbus (as with older systems) must be removed. If the
29 | # /etc/machine-id file is removed rather than emptied the system will not
30 | # be able to generate a new machine-id. This has rather dire consequences
31 | # for the boot process.
32 | # Additionally, if the /etc/machine-id file is emptied but the
33 | # /var/lib/dbus/machine-id file remains populated with an id string
34 | # then the system will simply copy the dbus machine-id string
35 | # into /etc/machine-id on next boot - in other words a new id won't be
36 | # created and the old id will be copied back into /etc/machine-id
37 | set -o errexit
38 |
39 | # Machine ID file locations
40 | sysd_id="/etc/machine-id"
41 | dbus_id="/var/lib/dbus/machine-id"
42 |
43 | # Remove and recreate (and so empty) the machine-id file under /etc
44 | if [ -e ${sysd_id} ]; then
45 | rm -f ${sysd_id} && touch ${sysd_id}
46 | fi
47 |
48 | # Remove the machine-id file under /var/lib/dbus if it is not a symlink
49 | if [[ -e ${dbus_id} && ! -h ${dbus_id} ]]; then
50 | rm -f ${dbus_id}
51 | fi
52 |
53 | exit 0
54 |
--------------------------------------------------------------------------------
/sysprep-op-ssh-hostkeys.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | #
3 | # Remove the guests ssh host keys.
4 | #
5 | # The ssh server package shipped with Red Hat variants and SUSE/openSUSE
6 | # checks for the existance of ssh keys at service start up and
7 | # automatically generates new keys if they are missing.
8 | #
9 | # The ssh server package shipped with Debian and Debian derivatives (such
10 | # as Ubuntu) do not automatically generate host ssh keys if they are
11 | # absent from the system at service start
12 | #
13 | # As such, for Red Hat and Red Hat derivatives removing the hosts ssh keys
14 | # is all that is required to ensure new keys are generated the next time
15 | # the server is started. For Debian and its derivatives a service must be
16 | # placed on the system to run when the system is next booted. It must:
17 | #
18 | # - Run prior to start up of the sshd server
19 | # - Check for and generate new host ssh keys as required
20 | # - Remove itself from the system after completion (run once only)
21 | #
22 | set -o errexit
23 |
24 | unit_file="/etc/systemd/system/generate-ssh-host-keys.service"
25 | unit="${unit_file##*/}"
26 | keygen_file="/generate-ssh-host-keys.sh"
27 | cleanup_file="/generate-ssh-host-keys-cleanup.sh"
28 |
29 | # Remove all ssh host key types
30 | rm -f /etc/ssh/*_host_*
31 |
32 | # If Debian's package manager configuration tool is present on the system
33 | # we can be confident we are on a system running Debian or a Debian
34 | # derivative
35 | if command -v dpkg-reconfigure &>/dev/null; then
36 | # Create a service that will run before the sshd service/network is up
37 | printf "%s" \
38 | "[Unit]
39 | Description=Generate ssh host keys as required
40 | Before=network-pre.target
41 | Requires=network-pre.target
42 |
43 | [Service]
44 | Type=oneshot
45 | ExecStart=/bin/bash "${keygen_file}"
46 | ExecStart=/bin/bash "${cleanup_file}"
47 | ExecStop=/bin/true
48 |
49 | [Install]
50 | WantedBy=multi-user.target
51 | " | sed -r 's/^ {1,}//g' > "${unit_file}"
52 |
53 | # Create the script called by the service to generate ssh host keys
54 | printf "%s" \
55 | '#!/usr/bin/env bash
56 | #
57 | # Generate ssh host keys for the system if required.
58 | set -o errexit
59 | types="rsa ecdsa ed25519" # Recommended types
60 | for type in ${types}
61 | do
62 | keyfile="/etc/ssh/ssh_host_${type}_key"
63 | # Generate the key if the file is missing or empty
64 | if [ ! -s "${keyfile}" ]; then
65 | echo "Generating SSH ${type^^} key"
66 | /usr/bin/ssh-keygen -t "${type}" -q -N "" -f "${keyfile}"
67 | fi
68 | done
69 |
70 | exit 0
71 | ' | sed -r 's/^ {8}//g' > "${keygen_file}"
72 |
73 | # Create the script that will clean up and remove everything after the
74 | # first run
75 | printf "%s" \
76 | "#!/usr/bin/env bash
77 | #
78 | # Clean up
79 | set -o errexit
80 |
81 | # Remove the generate-ssh-host-keys.service unit file
82 | rm -f "${unit_file}"
83 |
84 | # Remove the key generation script
85 | rm -f "${keygen_file}"
86 |
87 | # Reload systemd to pick up the changes
88 | systemctl daemon-reload
89 |
90 | # Remove this script
91 | rm -f "${cleanup_file}"
92 |
93 | exit 0
94 | " | sed -r 's/^ {8}//g' > "${cleanup_file}"
95 |
96 | # Manually enable the unit. Note that using systemctl commands here can
97 | # cause issues if the packer-virt-sysprep scripts are themselves being
98 | # executed by a systemd unit. For example, systemd will stop running
99 | # the executing unit if a systemctl daemon-reload is issued in any of
100 | # the scripts that it calls. This means additional ExecStop commands
101 | # issued in the calling unit will not be executed.
102 | ln -s ${unit_file} /etc/systemd/system/multi-user.target.wants
103 | fi
104 |
105 | exit 0
106 |
--------------------------------------------------------------------------------
/sysprep-op-tmp-files.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | #
3 | # Remove temporary files from the guest
4 | #
5 | # Basic outline:
6 | # 1. Section 1 of 'Main' loop:
7 | # Create a tmpfs file system and copy any existing files from the temp
8 | # directory to the new file system
9 | # 2. Section 2 of 'Main' loop:
10 | # Mount the tmpfs file system over the top of the existing on-disk temp
11 | # files directory. This *hopefully* means than any process relying on
12 | # files in the temp directory will still have access to them and will
13 | # allow a clean shutdown while still allowing removal of all on disk
14 | # temp files.
15 | # Since tmpfs file systems live on memory the contents copied to them
16 | # will disappear on shutdown
17 | # 3. Section 3 of 'Main' loop:
18 | # Once the tmpfs file system has been mounted the original on-disk temp
19 | # directory will no longer be directly accessible. In order to access
20 | # and clear any temp files from these disk areas we need to re-mount or
21 | # bind mount the device or file system on which the temp directory is
22 | # residing to an alternate location. We can then access and remove
23 | # any files from the disk by doing so from the alternate mount point.
24 | set -o errexit
25 |
26 | # Absolute path to guest temp file directories
27 | tmp_locations=(
28 | "/tmp"
29 | "/var/tmp"
30 | )
31 |
32 | # Set mountpoint used to access original on disk content
33 | mntpnt_orig_tmp="/mnt/orig_tmp"
34 |
35 | # Include hidden files in glob
36 | shopt -s dotglob
37 |
38 | # Since the current contents of the temp file system will essentially be
39 | # copied into memory, we need to ensure that we don't cause an out of
40 | # memory condition for the guest. The limit of 128m should be extremely
41 | # generous for most systems
42 | sum_tmp_space=0
43 | for tmp in ${tmp_locations[@]}
44 | do
45 | if [ -d ${tmp} ]; then
46 | tmp_space="$(du -sm ${tmp} | cut -f1)"
47 | else
48 | tmp_space=0
49 | fi
50 | sum_tmp_space=$(( ${sum_tmp_space} + ${tmp_space} ))
51 | if [ ${sum_tmp_space} -gt 128 ]; then
52 | echo "ERROR: Space for copying tmp into memory > 128mb. Exiting"
53 | exit 1
54 | fi
55 | done
56 |
57 | # Test for tmpfs filesystem at /dev/shm creating one if it doesn't exist
58 | # If /dev/shm is not present, attempt to create it
59 | if ! mount -l -t tmpfs | grep /dev/shm &>/dev/null; then
60 | [[ -d /dev/shm ]] || mkdir /dev/shm && chmod 1777 /dev/shm
61 | mount -t tmpfs -o defaults,size=128m tmpfs /dev/shm
62 | fi
63 |
64 |
65 | # Main
66 | for tmp in ${tmp_locations[@]}
67 | do
68 | # Test if the path or its parents are already on a tmpfs file system
69 | tmp_path="${tmp}"
70 | on_tmpfs=false
71 |
72 | while [[ ${tmp_path:0:1} = "/" ]] && [[ ${#tmp_path} > 1 ]] && \
73 | [[ ${on_tmpfs} = false ]]
74 | do
75 | defifs=${IFS}
76 | IFS=$'\n' # Set for convenience with mount output
77 | for mountpoint in $(mount -l -t tmpfs | cut -d' ' -f3)
78 | do
79 | if [ "${mountpoint}" == "${tmp_path}" ]; then
80 | on_tmpfs=true
81 | continue # No need to test further
82 | fi
83 | done
84 | IFS=${defifs} # Restore the default IFS and split behaviour
85 | tmp_path=${tmp_path%/*} # Set to test parent on next iteration
86 | done
87 |
88 | # Perform required operations to delete temp files
89 | if [ "${on_tmpfs}" = false ]; then
90 | # Initialise/reset the var used to store where the temp is located
91 | tmp_located_on=""
92 | # If the temp directory is a mounted partition we need the device
93 | defifs=${IFS} && IFS=$'\n' # Set for convenience with df output
94 | for line in $(df | tr -s ' ')
95 | do
96 | # Sixth column of df output is the mountpoint
97 | if echo ${line} | cut -d' ' -f6 | grep ^${tmp}$ &>/dev/null; then
98 | # First column of df output is the device
99 | tmp_located_on="$(echo ${line} | cut -d' ' -f1)"
100 | fi
101 | done
102 | IFS=${defifs} # Restore the default IFS and split behaviour
103 | # If the temp directory is not a mounted partition it must be on
104 | # the root file system
105 | [[ "x${tmp_located_on}" = "x" ]] && tmp_located_on="/"
106 |
107 |
108 | # Recreate the temp directory under /dev/shm (on tmpfs)
109 | shmtmp="/dev/shm/${tmp}"
110 | mkdir -p ${shmtmp}
111 | chmod 1777 ${shmtmp}
112 | # Copy all files from original temp dir to new tmpfs based dir
113 | files=(${tmp}/*) # Array allows wildcard/glob with [[ test ]]
114 | [[ -e ${files} ]] && cp -pr ${tmp}/* ${shmtmp}
115 | # Replace the original disk based temp directory structure with
116 | # the ephemeral tmpfs based storage by mounting it over the top of
117 | # the original temp directories location on the file system
118 | mount --bind ${shmtmp} ${tmp}
119 |
120 |
121 | # Create a mount point from which the contents of the original
122 | # on-disk temp directory can be accessed post mount of the tmpfs
123 | # file system
124 | mkdir ${mntpnt_orig_tmp}
125 | # Mount or bind mount in order to access the original on disk temp
126 | if [ ${tmp_located_on} = "/" ]; then
127 | # Temp file system is a folder on the root file system
128 | mount_opts="--bind"
129 | # Contents will be under mount point + original path e.g
130 | # /mountpoint/var/tmp
131 | tmp_path="${mntpnt_orig_tmp}/${tmp}"
132 | else
133 | # Temp file system is a disk partition
134 | mount_opts=""
135 | # Contents will be directly available under the mount point
136 | tmp_path="${mntpnt_orig_tmp}"
137 | fi
138 | # Mount the device holding the temp file system or bind mount the
139 | # root file system
140 | mount ${mount_opts} ${tmp_located_on} ${mntpnt_orig_tmp}
141 | # Delete all files from the on-disk temp directory
142 | files=(${tmp_path}/*)
143 | [[ -e ${files} ]] && rm -rf ${tmp_path}/*
144 | # Cleanup
145 | umount ${mntpnt_orig_tmp} && rm -rf ${mntpnt_orig_tmp}
146 | fi
147 | done
148 |
149 | exit 0
150 |
--------------------------------------------------------------------------------
/sysprep-op-logfiles.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | #
3 | # Remove log files from the guest
4 | #
5 | # Basic outline for treatment of log directories:
6 | # 1. Section 1 of 'log directories' loop:
7 | # Create a tmpfs file system and copy any existing files from the log
8 | # directory to the new file system
9 | # 2. Section 2 of 'log directories' loop:
10 | # Mount the tmpfs file system over the top of the existing on-disk log
11 | # files directory. This *hopefully* means than any process relying on
12 | # files in the log directory will still have access to them and will
13 | # allow a clean shutdown while still allowing removal of all on disk
14 | # log files.
15 | # Since tmpfs file systems live on memory the contents copied to them
16 | # will disappear on shutdown
17 | # 3. Section 3 of 'log directories' loop:
18 | # Once the tmpfs file system has been mounted the original on-disk log
19 | # directory will no longer be directly accessible. In order to access
20 | # and clear any log files from these disk areas we need to re-mount or
21 | # bind mount the device or file system on which the log directory is
22 | # residing to an alternate location. We can then access and remove
23 | # any files from the disk by doing so from the alternate mount point.
24 | #
25 | # Static log files are removed directly at the end of the script
26 | #
27 | # Original log list taken from Libguestfs's sysprep_operation_logfiles.ml
28 | # See https://github.com/libguestfs/libguestfs/tree/master/sysprep
29 | set -o errexit
30 |
31 | # Absolute path to guest log file directories
32 | # All files under the given directories will be removed
33 | logd_locations=(
34 | # Log files and directories
35 | "/var/log"
36 |
37 | # GDM and session preferences
38 | "/var/cache/gdm"
39 | "/var/lib/AccountService/users"
40 |
41 | # Fingerprint service files
42 | "/var/lib/fprint"
43 |
44 | # fontconfig caches
45 | "/var/cache/fontconfig"
46 |
47 | # man pages cache
48 | "/var/cache/man"
49 | )
50 |
51 | # Absolute path to static log files that can be removed directly
52 | logf_locations=(
53 | # Logfiles configured by /etc/logrotate.d/*
54 | "/var/named/data/named.run"
55 | # Status file of logrotate
56 | "/var/lib/logrotate.status"
57 |
58 | # Installation files
59 | "/root/install.log"
60 | "/root/install.log.syslog"
61 | "/root/anaconda-ks.cfg"
62 | "/root/original-ks.cfg"
63 | "/root/anaconda-post.log"
64 | "/root/initial-setup-ks.cfg"
65 |
66 | # Pegasus certificates and other files
67 | "/etc/Pegasus/*.cnf"
68 | "/etc/Pegasus/*.crt"
69 | "/etc/Pegasus/*.csr"
70 | "/etc/Pegasus/*.pem"
71 | "/etc/Pegasus/*.srl"
72 | )
73 |
74 |
75 | # Set mountpoint used to access original on disk content
76 | mntpnt_orig_logd="/mnt/orig_log_dir"
77 |
78 | # Include hidden files in glob
79 | shopt -s dotglob
80 |
81 | # Since the current contents of the log directories will essentially be
82 | # copied into memory, we need to ensure that we don't cause an out of
83 | # memory condition for the guest. The limit of 128m should be extremely
84 | # generous for most systems
85 | sum_logd_space=0
86 | for logd in ${logd_locations[@]}
87 | do
88 | if [ -d ${logd} ]; then
89 | logd_space="$(du -sm ${logd} | cut -f1)"
90 | else
91 | logd_space=0
92 | fi
93 | sum_logd_space=$(( ${sum_logd_space} + ${logd_space} ))
94 | if [ ${sum_logd_space} -gt 128 ]; then
95 | echo "ERROR: Space for copying logs into memory > 128mb. Exiting"
96 | exit 1
97 | fi
98 | done
99 |
100 | # Test for tmpfs filesystem at /dev/shm creating one if it doesn't exist
101 | # If /dev/shm is not present, attempt to create it
102 | if ! mount -l -t tmpfs | grep /dev/shm &>/dev/null; then
103 | [[ -d /dev/shm ]] || mkdir /dev/shm && chmod 1777 /dev/shm
104 | mount -t tmpfs -o defaults,size=128m tmpfs /dev/shm
105 | fi
106 |
107 | # Remove logs from given log directories
108 | for logd in ${logd_locations[@]}
109 | do
110 | if [ -d ${logd} ]; then
111 | # Test if the path or its parents are already on tmpfs
112 | logd_path="${logd}"
113 | on_tmpfs=false
114 |
115 | while [[ ${logd_path:0:1} = "/" ]] && [[ ${#logd_path} > 1 ]] && \
116 | [[ ${on_tmpfs} = false ]]
117 | do
118 | defifs=${IFS}
119 | IFS=$'\n' # Set for convenience with mount output
120 | for mountpoint in $(mount -l -t tmpfs | cut -d' ' -f3)
121 | do
122 | if [ "${mountpoint}" == "${logd_path}" ]; then
123 | on_tmpfs=true
124 | continue # No need to test further
125 | fi
126 | done
127 | IFS=${defifs} # Restore the default IFS and split behaviour
128 | logd_path=${logd_path%/*} # Test parent on next iteration
129 | done
130 |
131 | if [ "${on_tmpfs}" = false ]; then
132 | # Initialise/reset var used to store where log dir is located
133 | logd_located_on=""
134 | # If log directory is a mounted partition we need the device
135 | defifs=${IFS} && IFS=$'\n' # Set for convenience with df output
136 | for line in $(df | tr -s ' ')
137 | do
138 | # Sixth column of df output is the mountpoint
139 | if echo ${line} | cut -d' ' -f6 | grep ^${logd}$ &>/dev/null; then
140 | # First column of df output is the device
141 | logd_located_on="$(echo ${line} | cut -d' ' -f1)"
142 | fi
143 | done
144 | IFS=${defifs} # Restore the default IFS and split behaviour
145 | # If the log directory is not a mounted partition it must be on
146 | # the root file system
147 | [[ "x${logd_located_on}" = "x" ]] && logd_located_on="/"
148 |
149 |
150 | # Recreate the log directory under /dev/shm (on tmpfs)
151 | shmlogd="/dev/shm/${logd}"
152 | mkdir -p ${shmlogd}
153 | chmod 1777 ${shmlogd}
154 | # Copy all files from original log dir to new tmpfs based dir
155 | files=(${logd}/*) # Array allows wildcard/glob with [[ test ]]
156 | [[ -e ${files} ]] && cp -pr ${logd}/* ${shmlogd}
157 | # Replace the original disk based log directory structure with
158 | # the ephemeral tmpfs based storage by mounting it over the top of
159 | # the original log directories location on the file system
160 | mount --bind ${shmlogd} ${logd}
161 |
162 |
163 | # Create a mount point from which the contents of the original
164 | # on-disk log directory can be accessed post mount of the tmpfs
165 | # file system
166 | mkdir ${mntpnt_orig_logd}
167 | # Mount or bind mount in order to access the original on disk logs
168 | if [ ${logd_located_on} = "/" ]; then
169 | # Temp file system is a folder on the root file system
170 | mount_opts="--bind"
171 | # Contents will be under mount point + original path e.g
172 | # /mountpoint/var/tmp
173 | logd_path="${mntpnt_orig_logd}/${logd}"
174 | else
175 | # Temp file system is a disk partition
176 | mount_opts=""
177 | # Contents will be directly available under the mount point
178 | logd_path="${mntpnt_orig_logd}"
179 | fi
180 | # Mount the device holding the temp file system or bind mount the
181 | # root file system
182 | mount ${mount_opts} ${logd_located_on} ${mntpnt_orig_logd}
183 | # The lastlog file cannot be created on demand for some reason
184 | # and errors occur if /var/log/lastlog is missing. So, check if
185 | # '/var/log/lastlog' exists and store the location so we can
186 | # recreate later
187 | if [ "${logd}" == "/var/log" ]; then
188 | lastlog="$(find ${logd_path} -type f -name lastlog)"
189 | fi
190 | # Delete all files from the on-disk log directory
191 | find "${logd_path}" -type f | xargs -I FILE rm -f FILE
192 | # Recreate the /var/log/lastlog file if required
193 | if [[ "${logd}" == "/var/log" ]] && [[ "x${lastlog}" != "x" ]]; then
194 | touch "${lastlog}"
195 | fi
196 | # Cleanup
197 | umount ${mntpnt_orig_logd} && rm -rf ${mntpnt_orig_logd}
198 | fi
199 | fi
200 | done
201 |
202 | # Remove static log files and files that may be removed directly
203 | for file in ${logf_locations[@]}
204 | do
205 | [[ -e ${file} ]] && rm -f ${file}
206 | done
207 |
208 |
209 | exit 0
210 |
--------------------------------------------------------------------------------
/License.md:
--------------------------------------------------------------------------------
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 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
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 | {project} Copyright (C) {year} {fullname}
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 | .
675 |
--------------------------------------------------------------------------------