Experimental image based ezjail support

1 files changed, 194 insertions, 0 deletions

diff --git a/ezjail-img.sh b/ezjail-img.sh
new file mode 100644
index 0000000..b577682
--- /dev/null
+++ b/ezjail-img.sh
@@ -0,0 +1,194 @@
+#!/bin/sh
+
+# ugly: this variable is set during port install time
+ezjail_prefix=EZJAIL_PREFIX
+ezjail_etc=${ezjail_prefix}/etc
+ezjail_share=${ezjail_prefix}/share/ezjail
+ezjail_examples=${ezjail_prefix}/share/examples/ezjail
+ezjail_jailcfgs=${ezjail_etc}/ezjail
+
+# read user config
+[ -f ${ezjail_etc}/ezjail.conf ] && . ${ezjail_etc}/ezjail.conf
+
+# set defaults
+ezjail_jaildir=${ezjail_jaildir:-"/usr/jails"}
+ezjail_jailtemplate=${ezjail_jailtemplate:-"${ezjail_jaildir}/newjail"}
+ezjail_jailbase=${ezjail_jailbase:-"${ezjail_jaildir}/basejail"}
+ezjail_jailfull=${ezjail_jailfull:-"${ezjail_jaildir}/fulljail"}
+ezjail_flavours=${ezjail_flavours:-"${ezjail_jaildir}/flavours"}
+ezjail_sourcetree=${ezjail_sourcetree:-"/usr/src"}
+ezjail_portscvsroot=${ezjail_portscvsroot:-":pserver:anoncvs@anoncvs.at.FreeBSD.org:/home/ncvs"}
+
+ezjail_mount_enable=${ezjail_mount_enable:-"YES"}
+ezjail_devfs_enable=${ezjail_devfs_enable:-"YES"}
+ezjail_devfs_ruleset=${ezjail_devfs_ruleset:-"devfsrules_jail"}
+ezjail_procfs_enable=${ezjail_procfs_enable:-"YES"}
+ezjail_fdescfs_enable=${ezjail_fdescfs_enable:-"YES"}
+
+# define our bail out shortcut
+exerr () { echo -e "$*"; exit 1; }
+
+# check for command
+[ "$1" ] || exerr "Usage: `basename -- $0` [create] {params}"
+
+case "$1" in
+######################## ezjail-admin CREATE ########################
+create)
+  shift
+  args=`getopt xf:r:i: $*` || exerr "Usage: `basename -- $0` create [-f flavour] [-r jailroot] [-i size] [-xc] jailname jailip"
+  
+  newjail_root=
+  newjail_flavour=
+  newjail_softlink=
+  newjail_imagesize=
+  newjail_cryptimage=
+  newjail_fill="YES"
+  
+  set -- ${args}
+  for arg do
+    case ${arg} in
+      -x) newjail_fill="NO"; shift;;
+      -r) newjail_root="$2"; shift 2;;
+      -f) newjail_flavour="$2"; shift 2;;
+      -i) newjail_imagesize="$2"; shift 2;;
+      -c) newjail_cryptimage="YES"; shift;;
+      --) shift; break;;
+    esac
+  done
+  newjail_name=$1; newjail_ip=$2   
+  
+  # we need at least a name and an ip for new jail
+  [ "${newjail_name}" -a "${newjail_ip}" -a $# = 2 ] || exerr "Usage: `basename -- $0` create [-f flavour] [-r jailroot] [-x] jailname jailip"
+
+  # check for sanity of settings concerning the image feature
+  [ "${newjail_cryptimage}" = "YES" -a ! "${newjail_imagesize}" ] && exerr "Cryptimages need an image size."
+
+  # check, whether ezjail-update has been called. existence of
+  # ezjail_jailbase is our indicator
+  [ -d ${ezjail_jailbase} ] || exerr "Error: base jail does not exist. Please run 'ezjail-admin update' first."
+
+  # relative paths don't make sense in rc.scripts
+  [ "${ezjail_jaildir%%[!/]*}" ] || exerr "Error: Need an absolute path in ezjail_jaildir, it currently is set to: ${ezjail_jaildir}."
+
+  # jail names must not irritate file systems, excluding dots from this list
+  # was done intentionally to permit foo.com style directory names, however,
+  # the jail name will be foo_com in most scripts
+
+  newjail_name=`echo -n ${newjail_name} | tr /~ __`
+  newjail_nname=`echo -n "${newjail_name}" | tr -c [:alnum:] _`
+  newjail_root=${newjail_root:-"${ezjail_jaildir}/${newjail_name}"}
+
+  # This scenario really will only lead to real troubles in the 'fulljail'
+  # case, but I should still explain this to the user and not claim that
+  # "an ezjail would already exist"
+  [ "${newjail_nname}" = "basejail" -o "${newjail_nname}" = "newjail" -o "${newjail_nname}" = "fulljail" -o "${newjail_nname}" = "flavours" ] && \
+    exerr "Error: ezjail needs the ${newjail_nname} directory for its own administrative purposes. Please rename the ezjail."
+  
+  # jail names may lead to identical configs, eg. foo.bar.com == foo-bar.com
+  # so check, whether we might be running into problems
+  [ -e ${ezjail_jailcfgs}/${newjail_nname} ] && exerr "Error: an ezjail config already exists at ${ezjail_jailcfgs}/${newjail_nname}. Please rename the ezjail."
+  
+  # if jail root specified on command line is not absolute, make it absolute
+  # inside our jail directory
+  [ "${newjail_root%%[!/]*}" ] || newjail_root=${ezjail_jaildir}/${newjail_root}
+
+  # if a directory at the specified jail root already exists, refuse to
+  # install
+  [ -e ${newjail_root} -a "${newjail_fill}" = "YES" ] && exerr "Error: the specified jail root ${newjail_root} alread exists."
+
+  # if jail root specified on command line does not lie within our jail
+  # directory, we need to create a softlink
+  if [ "${newjail_root##${ezjail_jaildir}}" = "${newjail_root}" ]; then
+    newjail_softlink=${ezjail_jaildir}/`basename -- ${newjail_root}`
+    [ -e ${newjail_softlink} -a "${newjail_fill}" = "YES" ] && exerr "Error: an ezjail already exists at ${newjail_softlink}."
+  fi
+
+  # do some sanity checks on the selected flavour (if any)
+  [ "${newjail_flavour}" -a ! -d ${ezjail_flavours}/${newjail_flavour} ] && exerr "Error: Flavour config directory ${ezjail_flavours}/${newjail_flavour} not found."
+
+  #
+  # All sanity checks that may lead to errors are hopefully passed here
+  #
+
+  # if image is wanted, check, whether the img-file already is present
+  if [ "${newjail_imagesize}" ]; then
+    newjail_image=${newjail_root%/}; while [ "${newjail_image}" -a -z "${newjail_image%%*/" ]; do newjail_image=${newjail_image%/}; done
+    [ -z "${newjail_image}" ] && exerr Could not determine image file name, something is wrong with the jail root: ${newjail_root}.
+    newjail_image=${newjail_image}.img
+    [ -e "${newjail_image}" ] && exerr "Error: a file exists at the location ${newjail_image}, preventing our own image file to be created.
+
+    touch "${newjail_image}"
+    dd if=/dev/random of="${newjail_image}" bs=${newjail_imagesize} count=1 || exerr Could not (or not fully) create the image file. You might want to check (and possibly remove) the file "${newjail_image}". The image size provided was ${newjail_imagesize}.
+    newjail_device=/dev/`mdconfig -a -t vnode -f ${newjail_image}`
+    newfs ${newjail_device}
+    mount ${newjail_device} ${newjail_root}
+  fi
+
+  # now take a copy of our template jail
+  if [ "${newjail_fill}" = "YES" ]; then
+    mkdir -p ${newjail_root} && cd ${ezjail_jailtemplate} && \
+    find * | cpio -p -v ${newjail_root} > /dev/null
+    [ $? = 0 ] || exerr "Error: Could not copy template jail."
+  fi
+
+  # if a soft link is necessary, create it now
+  [ "${newjail_softlink}" ] && ln -s ${newjail_root} ${newjail_softlink}  
+
+  # if the automount feature is not disabled, this fstab entry for new jail
+  # will be obeyed
+  echo ${ezjail_jailbase} ${newjail_root}/basejail nullfs ro 0 0 > /etc/fstab.${newjail_nname}
+
+  # now, where everything seems to have gone right, create control file in  
+  # ezjails config dir
+  mkdir -p ${ezjail_jailcfgs}
+  echo export jail_${newjail_nname}_hostname=\"${newjail_name}\"  > ${ezjail_jailcfgs}/${newjail_nname}
+  echo export jail_${newjail_nname}_ip=\"${newjail_ip}\"  >> ${ezjail_jailcfgs}/${newjail_nname}
+  echo export jail_${newjail_nname}_rootdir=\"${newjail_root}\"  >> ${ezjail_jailcfgs}/${newjail_nname}
+  echo export jail_${newjail_nname}_exec=\"/bin/sh /etc/rc\"  >> ${ezjail_jailcfgs}/${newjail_nname}
+  echo export jail_${newjail_nname}_mount_enable=\"${ezjail_mount_enable}\"  >> ${ezjail_jailcfgs}/${newjail_nname}
+  echo export jail_${newjail_nname}_devfs_enable=\"${ezjail_devfs_enable}\"  >> ${ezjail_jailcfgs}/${newjail_nname}
+  echo export jail_${newjail_nname}_devfs_ruleset=\"devfsrules_jail\"  >> ${ezjail_jailcfgs}/${newjail_nname}
+  echo export jail_${newjail_nname}_procfs_enable=\"${ezjail_procfs_enable}\"  >> ${ezjail_jailcfgs}/${newjail_nname}
+  echo export jail_${newjail_nname}_fdescfs_enable=\"${ezjail_fdescfs_enable}\" >> ${ezjail_jailcfgs}/${newjail_nname}
+  [ "${newjail_imagesize}" ] && \
+  echo export jail_${newjail_nname}_image=\"YES\" >> ${ezjail_jailcfgs}/${newjail_nname}
+  [ "${newjail_cryptimage}" ] && \
+  echo export jail_${newjail_nname}_cryptimage=\"YES\" >> ${ezjail_jailcfgs}/${newjail_nname}
+
+  # Final steps for flavour installation   
+  if [ "${newjail_flavour}" ]; then
+    # install files and config to new jail
+    cd ${ezjail_flavours}/${newjail_flavour} && find * | cpio -p -v ${newjail_root} > /dev/null
+    [ $? = 0 ] || echo "Warning: Could not fully install flavour."
+  
+    # If a config is found, make it auto run on jails startup
+    if [ -f ${newjail_root}/ezjail.flavour ]; then
+      ln -s /ezjail.flavour ${newjail_root}/etc/rc.d/ezjail-config.sh
+      chmod 0700 ${newjail_root}/ezjail.flavour
+      echo "Note: Shell scripts installed, flavourizing on jails first startup."
+    fi
+  fi
+  
+  #
+  # For user convenience some scenarios commonly causing headaches are checked
+  #
+    
+  # check, whether IP is configured on a local interface, warn if it isnt
+  ping -c 1 -m 1 -t 1 -q ${newjail_ip} > /dev/null
+  [ $? = 0 ] || echo "Warning: IP ${newjail_ip} not configured on a local interface."
+  
+  # check, whether some host system services do listen on the Jails IP
+  TIFS=${IFS}; IFS=_
+  newjail_listener=`sockstat -4 -l | grep ${newjail_ip}:[[:digit:]]`
+  [ $? = 0 ] && echo -e "Warning: Some services already seem to be listening on IP ${newjail_ip}\n  This may cause some confusion, here they are:\n${newjail_listener}"
+  
+  newjail_listener=`sockstat -4 -l | grep \*:[[:digit:]]`
+  [ $? = 0 ] && echo -e "Warning: Some services already seem to be listening on all IP, (including ${newjail_ip})\n  This may cause some confusion, here they are:\n${$
+  IFS=${TIFS}
+  
+  ;;
+*)
+  exerr "Usage: `basename -- $0` [create|delete|list|update] {params}"
+  ;;
+esac
+