scripts/system/add_domain.sh

   1 #!/bin/bash
   2
   3 # this set of functions serve the main purpose of adding new domains or subdomains to the bind9 DNS server on the current host.
   4 # it is currently highly specific to running a bunch of domains on a linux VM, where the VM has one IP address.
   5 # note that bind 'named' must already be configured.
   6 # also, it is assumed that if a subdomain is being added, then the containing domain has already been configured and is
   7 # configured in a file similar to "blah.com.conf" in /etc/bind.
   8 #
   9 # Author: Chris Koeritz
  10
  11 export WORKDIR="$( \cd "$(\dirname "$0")" && \pwd )"  # obtain the script's working directory.
  12 export FEISTY_MEOW_APEX="$( \cd "$WORKDIR/../.." && \pwd )"
  13
  14 source "$FEISTY_MEOW_APEX/scripts/core/launch_feisty_meow.sh"
  15
  16 # some defaults that are convenient for current purposes.
  17
  18 # hmmm: !!! these would need to be parameterized somehow for this script to become really general.
  19
  20 # in our scheme, the single IP address that all our domains map to.
  21 IP_ADDRESS="10.28.42.20"
  22 # the email address (where first dot is replaced by @) for the administrator of the domain.
  23 SERVER_ADMIN="developer.cakelampvm.com"
  24 # the name of the name server for the new domains (should already be configured).
  25 MAIN_NAME_SERVER="ns.cakelampvm.com"
  26 # the name of the mail server for a new domain (should already be configured).
  27 MAIL_SERVER="mail.cakelampvm.com"
  28 # the distribution name to be listed in info for the new domain or subdomain.
  29 DISTRO="ubuntu"
  30
  31 # creates a totally new domain config file for DNS.
  32 function write_new_domain_file()
  33 {
  34   local domain_name="$1"; shift
  35
  36   local domain_file="/etc/bind/${domain_name}.conf"
  37
  38   echo "adding a totally new domain called $domain_name"
  39   echo "using the config file: $domain_file"
  40
  41   if [ -f $domain_file ]; then
  42     echo
  43     echo "The domain configuration file already exists at:"
  44     echo "  $domain_file"
  45     echo "Since we don't want to tear that down if it has specialized configuration"
  46     echo "data in it, we will just leave it in place and consider our job done."
  47     echo
  48     exit 0
  49   fi
  50
  51   echo "
  52 \$TTL 1W
  53 @       IN SOA  @       ${SERVER_ADMIN}. (
  54                 2017100801 ; serial
  55                 2H ; refresh
  56                 8M ; retry
  57                 14D ; expiry
  58                 6H ) ; minimum
  59
  60         IN NS           ${MAIN_NAME_SERVER}.
  61         IN MX   10      ${MAIL_SERVER}.
  62
  63 ${domain_name}. IN A    ${IP_ADDRESS}
  64         IN HINFO        \"linux server\" \"${DISTRO}\"
  65 " >"$domain_file"
  66 }
  67
  68 # hooks up a new config file into bind's list of zones.
  69 function add_zone_for_new_domain()
  70 {
  71   local domain_name="$1"; shift
  72
  73   local domain_file="/etc/bind/${domain_name}.conf"
  74
  75   echo "adding a new domain configured by ${domain_file} into"
  76   echo "the named.conf.local configuration file."
  77
  78   # append the reference to the new conf file in the zone list.
  79   echo "
  80 zone \"${domain_name}\" in {
  81         file \"${domain_file}\";
  82         type master;
  83         allow-query { any; };
  84 };
  85
  86 ////////////////////////////////////////////////////////////////////////////
  87
  88 " >> /etc/bind/named.conf.local
  89 }
  90
  91 # adds a new subdomain under a containing domain.
  92 function add_new_subdomain()
  93 {
  94   local new_domain="$1"; shift
  95
  96   # split up the full domain name into subdomain portion and containing domain.
  97   local subdomain="${new_domain%.*.*}"
  98   local containing_domain="${new_domain#*.}"
  99
 100   echo "adding a subdomain $subdomain to containing domain $containing_domain"
 101
 102   local domain_file="/etc/bind/${containing_domain}.conf"
 103   # see if config file already exists; if not, complain.
 104   if [ ! -f "$domain_file" ]; then
 105     echo "The domain configuration file for $new_domain is missing."
 106     echo "It should already be present in: $domain_file"
 107     echo "Please add the containing domain before trying to add a subdomain."
 108     exit 1
 109   fi
 110
 111   # see if subdomain already present in config.
 112   if [ $(grep -q "$new_domain" "$domain_file") ]; then
 113     echo "The subdomain $subdomain already seems to exist in the domain"
 114     echo "configuration file: $domain_file"
 115     echo "Please edit the config file to remove the subdomain before trying"
 116     echo "to re-add the subdomain."
 117     exit 1
 118   fi
 119
 120   # append the new subdomain into the config file.
 121   echo "
 122 ${subdomain}.${containing_domain}.    IN A    ${IP_ADDRESS}
 123         IN HINFO \"linux server\" \"${DISTRO}\"
 124 " >> /etc/bind/${containing_domain}.conf
 125
 126 }
 127
 128 function restart_bind()
 129 {
 130   echo restarting DNS server.
 131   service bind9 restart
 132   if [ $? -ne 0 ]; then
 133     echo "The bind service did not restart properly.  Please check the error logs."
 134     exit 1
 135   fi
 136   echo DNS server restarted.
 137 }
 138
 139 # main body of script.
 140
 141 if [[ $EUID != 0 ]]; then
 142   echo "This script must be run as root or sudo."
 143   exit 1
 144 fi
 145
 146 new_domain="$1"; shift
 147
 148 if [ -z "$new_domain" ]; then
 149   echo "This script needs a domain name to add to DNS."
 150   exit 1
 151 fi
 152
 153 # if domain name has three or more components, then add a subdomain.
 154 # otherwise, add a full new domain.
 155 if [[ $new_domain == *"."*"."* ]]; then
 156   # add a subdomain to the containing domain.
 157   add_new_subdomain "$new_domain"
 158   restart_bind
 159 else
 160   # create a totally new domain in DNS.
 161   write_new_domain_file "$new_domain"
 162   add_zone_for_new_domain "$new_domain"
 163   restart_bind
 164 fi
 165
 166