Merge pull request #33 from cedwards/master

May 2019 update: HardenedBSD, tzdata, NS

.gitignore

@@ -0,0 +1 @@
+docs/_build

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -4,9 +4,46 @@ Bastille is a jail automation framework that allows you to quickly and
 easily create and manage FreeBSD jail.
 
 
+Installation
+------------
+Bastille is available in the official ports tree.
+
+```
+pkg install bastille
+```
+
+Development builds are available on the `pkg.bastillebsd.org` package server.
+To subscribe to this repo, use the following two configuration additions.
+
+Note: The BastilleBSD pkg server will usually be ahead of FreeBSD latest.
+
+```
+## /usr/local/etc/pkg/repos/BastilleBSD.conf
+BastilleBSD: {
+  url: "https://pkg.bastillebsd.org/pkg/${ABI}",
+  signature_type: "pubkey",
+  pubkey: "/usr/local/etc/ssl/poudriere.pub",
+  enabled: yes
+}
+```
+
+```
+## /usr/local/etc/ssl/poudriere.pub
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAq28OLDhJ12JmsKKcJpnn
+pCW3fFYBNI1BtdvTvFx57ZXvQ2qecBvnR9+XWi83hKS9ALTKZI6CLC2uTv1fIsZl
+u6rDRRNZwZFfITACSfwI+7UObMXz3oBZjk94J3rIegk49EyjDswKdVWv5k1EiVXF
+SAwXSl2kA2hGfQJkj5NS4nrfoRBc0z6fm+BGdNuHKSTmeZh1dbLEHt9EArD20DJ7
+HIr8vUSPLwONeqJCBFA/MeDO+GpwtwA/ldc2ZZy1RCPctdC2NeiGW7oy1yVDu6wp
+mHCq8qDfmCx5Aex84rWUf9iH8TM92AWmegTaz2p+BgESctpjNRCUuSEwOCBIO6g5
+3wIDAQAB
+-----END PUBLIC KEY-----
+```
+
+
 Basic Usage
 -----------
-```
+```shell
 ishmael ~ # bastille -h
 Usage:
   bastille command [ALL|glob] [args]
@@ -38,10 +75,7 @@ Use "bastille command -h|--help" for more information about a command.
 
 ## 0.3-beta
 This document outlines the basic usage of the Bastille jail management
-framework. This release, obviously, is beta quality. I make no guarantees of
+framework. This release is still considered beta.
-quality, and if it screws up your system... Sorry, bro. 
-
-With all that said, here's how to use this tool in its current beta state...
 
 
 ## Network Requirements
@@ -52,7 +86,7 @@ the firewall, permitting and denying traffic as needed.
 First, create the loopback interface:
 
 ```shell
-ishmael ~ # sysrc cloned_interfaces="lo1"
+ishmael ~ # sysrc cloned_interfaces+=lo1
 ishmael ~ # service netif cloneup
 ```
 
@@ -71,7 +105,7 @@ set block-policy drop
 scrub in on $ext_if all fragment reassemble
 
 set skip on lo
-nat on $ext_if from !($ext_if) -> ($ext_if:0)
+nat on $ext_if from lo1:network to any -> ($ext_if)
 
 ## rdr example
 ## rdr pass inet proto tcp from any to any port {80, 443} -> 10.88.9.45
@@ -119,9 +153,9 @@ This step only needs to be done once in order to prepare the host.
 
 bastille bootstrap
 ------------------
-The first step is to "bootstrap" a release. Current supported release is
+The first step is to "bootstrap" a release. Current supported releases are
-11.2-RELEASE, but you can bootstrap anything in the ftp.FreeBSD.org RELEASES
+11.2-RELEASE and 12.0-RELEASE, but you can bootstrap anything in the
-directory. 
+ftp.FreeBSD.org RELEASES directory.
 
 Note: your mileage may vary with unsupported releases and releases newer than
 the host system likely will NOT work at all.
@@ -130,17 +164,17 @@ To `bootstrap` a release, run the bootstrap sub-command with the
 release version as the argument.
 
 ```shell
-ishmael ~ # bastille bootstrap 11.2-RELEASE
 ishmael ~ # bastille bootstrap 12.0-RELEASE
+ishmael ~ # bastille bootstrap 11.2-RELEASE
 ```
 
 This command will ensure the required directory structures are in place and
 download the requested release. For each requested release, `bootstrap` will
-download the base.txz and lib32.txz. These are both verified (sha256 via
+download the base.txz. These are verified (sha256 via MANIFEST file) before
-MANIFEST file) before they are extracted for use.
+they are extracted for use.
 
 Downloaded artifacts are stored in the `cache` directory. "bootstrapped"
-releases are stored in `releases/version`.
+releases are stored in `releases/$RELEASE`.
 
 The bootstrap subcommand is generally only used once to prepare the system. The
 only other use case for the bootstrap command is when a new FreeBSD version is
@@ -153,7 +187,7 @@ command.
 bastille create
 ---------------
 Bastille create uses any available bootstrapped release to create a lightweight
-jailized system. To create a jail simply provide a name, release and
+jailed system. To create a jail simply provide a name, release and
 a private (rfc1918) IP address.
 
 - name
@@ -161,15 +195,14 @@ a private (rfc1918) IP address.
 - ip
 
 ```shell
-ishmael ~ # bastille create folsom 11.2-RELEASE 10.8.62.1
+ishmael ~ # bastille create folsom 12.0-RELEASE 10.8.62.1
 
-RELEASE: 11.2-RELEASE.
+RELEASE: 12.0-RELEASE.
 NAME: folsom.
 IP: 10.8.62.1.
-
 ```
 
-This command will create a 11.2-RELEASE jail assigning the 10.8.62.1 ip address
+This command will create a 12.0-RELEASE jail assigning the 10.8.62.1 ip address
 to the new system.
 
 I recommend using private (rfc1918) ip address ranges for your jails.
@@ -343,11 +376,11 @@ ishmael ~ # bastille pkg ALL upgrade
 Targeting all jails.
 
 [bastion]:
-Updating iniquity.io repository catalogue...
+Updating pkg.bastillebsd.org repository catalogue...
 [bastion] Fetching meta.txz: 100%    560 B   0.6kB/s    00:01
 [bastion] Fetching packagesite.txz: 100%  118 KiB 121.3kB/s    00:01
 Processing entries: 100%
-iniquity.io repository update completed. 493 packages processed.
+pkg.bastillebsd.org repository update completed. 493 packages processed.
 All repositories are up to date.
 Checking for upgrades (1 candidates): 100%
 Processing candidates (1 candidates): 100%
@@ -355,11 +388,11 @@ Checking integrity... done (0 conflicting)
 Your packages are up to date.
 
 [unbound0]:
-Updating iniquity.io repository catalogue...
+Updating pkg.bastillebsd.org repository catalogue...
 [unbound0] Fetching meta.txz: 100%    560 B   0.6kB/s    00:01
 [unbound0] Fetching packagesite.txz: 100%  118 KiB 121.3kB/s    00:01
 Processing entries: 100%
-iniquity.io repository update completed. 493 packages processed.
+pkg.bastillebsd.org repository update completed. 493 packages processed.
 All repositories are up to date.
 Checking for upgrades (0 candidates): 100%
 Processing candidates (0 candidates): 100%
@@ -367,11 +400,11 @@ Checking integrity... done (0 conflicting)
 Your packages are up to date.
 
 [unbound1]:
-Updating iniquity.io repository catalogue...
+Updating pkg.bastillebsd.org repository catalogue...
 [unbound1] Fetching meta.txz: 100%    560 B   0.6kB/s    00:01
 [unbound1] Fetching packagesite.txz: 100%  118 KiB 121.3kB/s    00:01
 Processing entries: 100%
-iniquity.io repository update completed. 493 packages processed.
+pkg.bastillebsd.org repository update completed. 493 packages processed.
 All repositories are up to date.
 Checking for upgrades (0 candidates): 100%
 Processing candidates (0 candidates): 100%
@@ -379,11 +412,11 @@ Checking integrity... done (0 conflicting)
 Your packages are up to date.
 
 [squid]:
-Updating iniquity.io repository catalogue...
+Updating pkg.bastillebsd.org repository catalogue...
 [squid] Fetching meta.txz: 100%    560 B   0.6kB/s    00:01
 [squid] Fetching packagesite.txz: 100%  118 KiB 121.3kB/s    00:01
 Processing entries: 100%
-iniquity.io repository update completed. 493 packages processed.
+pkg.bastillebsd.org repository update completed. 493 packages processed.
 All repositories are up to date.
 Checking for upgrades (0 candidates): 100%
 Processing candidates (0 candidates): 100%
@@ -391,11 +424,11 @@ Checking integrity... done (0 conflicting)
 Your packages are up to date.
 
 [nginx]:
-Updating iniquity.io repository catalogue...
+Updating pkg.bastillebsd.org repository catalogue...
 [nginx] Fetching meta.txz: 100%    560 B   0.6kB/s    00:01
 [nginx] Fetching packagesite.txz: 100%  118 KiB 121.3kB/s    00:01
 Processing entries: 100%
-iniquity.io repository update completed. 493 packages processed.
+pkg.bastillebsd.org repository update completed. 493 packages processed.
 All repositories are up to date.
 Checking for upgrades (1 candidates): 100%
 Processing candidates (1 candidates): 100%
@@ -447,7 +480,7 @@ Bastille supports a templating system allowing you to apply files, pkgs and
 execute commands inside the jail automatically.
 
 Currently supported template hooks are: `PRE`, `CONFIG`, `PKG`, `SYSRC`, `CMD`.
-Planned template hooks include: `FSTAB`, `PF`
+Planned template hooks include: `FSTAB`, `PF`, `LOG`
 
 Templates are created in `${bastille_prefix}/templates` and can leverage any of
 the template hooks. Simply create a new directory named after the template. eg;
@@ -468,12 +501,20 @@ echo "etc root usr" > /usr/local/bastille/templates/base/CONFIG
 Template hooks are executed in specific order and require specific syntax to
 work as expected. This table outlines those requirements:
 
-| HOOK    | format           | example                              |
+| SUPPORTED | format           | example                                                        |
-|---------|------------------|--------------------------------------|
+|-----------|------------------|----------------------------------------------------------------|
-| PRE/CMD | /bin/sh command  | /usr/bin/chsh -s /usr/local/bin/zsh  |
+| PRE/CMD   | /bin/sh command  | /usr/bin/chsh -s /usr/local/bin/zsh                            |
-| CONFIG  | path             | etc root usr                         |
+| CONFIG    | path             | etc root usr                                                   |
-| PKG     | port/pkg name(s) | vim-console zsh git-lite tree htop   |
+| PKG       | port/pkg name(s) | vim-console zsh git-lite tree htop                             |
-| SYSRC   | sysrc command(s) | nginx_enable="YES" nginx_flags="..." |
+| SYSRC     | sysrc command(s) | nginx_enable=YES                                               |
+
+| PLANNED | format           | example                                                        |
+|---------|------------------|----------------------------------------------------------------|
+| PF      | pf rdr entry     | rdr pass inet proto tcp from any to any port 80 -> 10.17.89.80 |
+| LOG     | path             | /var/log/nginx/access.log                                      |
+| FSTAB   | fstab syntax     | /path/on/host /path/in/jail nullfs ro 0 0                      |
+
+Note: SYSRC requires NO quotes or that quotes (`"`) be escaped. ie; `\"`)
 
 In addition to supporting template hooks, Bastille supports overlaying files
 into the jail. This is done by placing the files in their full path, using the
@@ -499,6 +540,7 @@ The above example "etc usr" will include anything under "etc" and "usr" inside
 the template. You do not need to list individual files. Just include the
 top-level directory name.
 
+
 Applying Templates
 ------------------
 
@@ -591,6 +633,7 @@ At this point you are logged in to the jail and have full shell access.
 The system is yours to use and/or abuse as you like. Any changes made inside
 the jail are limited to the jail. 
 
+
 bastille cp
 -----------
 Note: this sub-command may need a little work. 
@@ -838,8 +881,25 @@ rdr pass inet proto tcp from any to any port 8081 -> 10.7.6.5 port 8080
 rdr pass inet proto tcp from any to any port 8181 -> 10.7.6.5 port 443
 ```
 
-Tip: Initially I spent time worrying about what IP addresses to assign. In the
+Tip #3:
+-------
+Don't worry too much about IP assignments.
+Initially I spent time worrying about what IP addresses to assign. In the
 end I've come to the conclusion that it _really_ doesn't matter. Pick *any*
 private address and be done with it. These are all isolated networks. In the
 end, what matters is you can map host:port to jail:port reliably, and we
 can.
+
+
+Community Support
+=================
+We would love to hear your feedback on Bastille! Please join us on the
+[BastilleBSD Chat Server](https://chat.bastillebsd.org) and let us know what
+you think. Registration is currently open pending email verification. 
+
+Be mindful of the [Bastille Code of
+Conduct](https://github.com/BastilleBSD/bastille/blob/master/CODE-OF-CONDUCT.md)
+when participating in the chat rooms.
+
+If you've found a bug in Bastille, please submit it to the [Bastille Issue
+Tracker](https://github.com/bastillebsd/bastille/issues/new).

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/chapters/installation.rst

@@ -0,0 +1,30 @@
+Installation
+============
+
+Bastille is not (yet) in the official ports tree, but I have built and
+verified binary packages.
+
+To install using one of the BETA binary packages, copy the URL for the
+latest release here (TXZ file):
+https://github.com/bastillebsd/bastille/releases
+
+Then, install via pkg. 
+Example:
+
+.. code-block:: shell
+
+  pkg add https://github.com/BastilleBSD/bastille/releases/download/0.3.20181124/bastille-0.3.20181124.txz
+
+BETA binary packages are signed. These can be verified with this pubkey:
+
+.. code-block:: shell
+
+  -----BEGIN PUBLIC KEY-----
+  MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAq28OLDhJ12JmsKKcJpnn
+  pCW3fFYBNI1BtdvTvFx57ZXvQ2qecBvnR9+XWi83hKS9ALTKZI6CLC2uTv1fIsZl
+  u6rDRRNZwZFfITACSfwI+7UObMXz3oBZjk94J3rIegk49EyjDswKdVWv5k1EiVXF
+  SAwXSl2kA2hGfQJkj5NS4nrfoRBc0z6fm+BGdNuHKSTmeZh1dbLEHt9EArD20DJ7
+  HIr8vUSPLwONeqJCBFA/MeDO+GpwtwA/ldc2ZZy1RCPctdC2NeiGW7oy1yVDu6wp
+  mHCq8qDfmCx5Aex84rWUf9iH8TM92AWmegTaz2p+BgESctpjNRCUuSEwOCBIO6g5
+  3wIDAQAB
+  -----END PUBLIC KEY-----

docs/chapters/networking.rst

@@ -0,0 +1,79 @@
+====================
+Network Requirements
+====================
+
+In order to segregate jails from the network and from the world, Bastille
+attaches jails to a loopback interface only. The host system then acts as
+the firewall, permitting and denying traffic as needed.
+
+First, create the loopback interface:
+
+.. code-block:: shell
+
+  ishmael ~ # sysrc cloned_interfaces+=lo1
+  ishmael ~ # service netif cloneup
+
+Second, enable NAT through the firewall:
+
+.. code-block:: shell
+
+  ishmael ~ # sysrc pf_enable="YES"
+
+/etc/pf.conf
+------------
+
+Create the firewall config, or merge as necessary.
+
+.. code-block:: shell
+
+  ext_if="vtnet0"
+  
+  set block-policy drop
+  scrub in on $ext_if all fragment reassemble
+  
+  set skip on lo
+  nat on $ext_if from !($ext_if) -> ($ext_if:0)
+  
+  ## rdr example
+  ## rdr pass inet proto tcp from any to any port {80, 443} -> 10.88.9.45
+  
+  block in log all
+  pass out quick modulate state
+  antispoof for $ext_if inet
+  pass in inet proto tcp from any to any port ssh flags S/SA keep state
+
+
+- Make sure to change the `ext_if` variable to match your host system interface.
+- Make sure to include the last line (`port ssh`) or you'll end up locked out.
+
+
+Note: if you have an existing firewall, the key lines for in/out traffic
+to jails are:
+
+.. code-block:: shell
+
+  nat on $ext_if from lo1:network to any -> ($ext_if)
+  
+  ## rdr example
+  ## rdr pass inet proto tcp from any to any port {80, 443} -> 10.88.9.45
+
+The `nat` routes traffic from the loopback interface to the external
+interface for outbound access.
+
+The `rdr pass ...` will redirect traffic from the host firewall on port X
+to the ip of Jail Y. The example shown redirects web traffic (80 & 443) to
+the jails at `10.88.9.45`.
+
+We'll get to that later, but when you're ready to allow traffic inbound to
+your jails, that's where you'd do it.
+
+Finally, start up the firewall:
+
+.. code-block:: shell
+
+  ishmael ~ # service pf restart
+
+At this point you'll likely be disconnected from the host. Reconnect the
+ssh session and continue.
+
+This step only needs to be done once in order to prepare the host.

docs/chapters/subcommands/bootstrap.rst

@@ -0,0 +1,34 @@
+=========
+bootstrap
+=========
+
+The first step is to "bootstrap" a release. Current supported release is
+11.2-RELEASE, but you can bootstrap anything in the ftp.FreeBSD.org
+RELEASES directory. 
+
+Note: your mileage may vary with unsupported releases and releases newer
+than the host system likely will NOT work at all.
+
+To `bootstrap` a release, run the bootstrap sub-command with the
+release version as the argument.
+
+.. code-block:: shell
+    
+  ishmael ~ # bastille bootstrap 11.2-RELEASE
+  ishmael ~ # bastille bootstrap 12.0-RELEASE
+
+This command will ensure the required directory structures are in place
+and download the requested release. For each requested release,
+`bootstrap` will download the base.txz and lib32.txz. These are both
+verified (sha256 via MANIFEST file) before they are extracted for use.
+
+Downloaded artifacts are stored in the `cache` directory. "bootstrapped"
+releases are stored in `releases/version`.
+
+The bootstrap subcommand is generally only used once to prepare the
+system. The only other use case for the bootstrap command is when a new
+FreeBSD version is released and you want to start building jails on that
+version.
+
+To update a release as patches are made available, see the `bastille
+update` command.

docs/chapters/subcommands/cmd.rst

@@ -0,0 +1,14 @@
+===
+cmd
+===
+
+To execute commands within the jail you can use `bastille cmd`.
+
+.. code-block:: shell
+
+  ishmael ~ # bastille cmd folsom 'ps -auxw'
+  [folsom]:
+  USER   PID %CPU %MEM   VSZ  RSS TT  STAT STARTED    TIME COMMAND
+  root 71464  0.0  0.0 14536 2000  -  IsJ   4:52PM 0:00.00 /usr/sbin/syslogd -ss
+  root 77447  0.0  0.0 16632 2140  -  SsJ   4:52PM 0:00.00 /usr/sbin/cron -J 60 -s
+  root 80591  0.0  0.0 18784 2340  1  R+J   4:53PM 0:00.00 ps -auxw

docs/chapters/subcommands/console.rst

@@ -0,0 +1,36 @@
+console
+=======
+
+This sub-command launches a login shell into the jail. Default is
+password-less root login.
+
+.. code-block:: shell
+
+  ishmael ~ # bastille console folsom
+  [folsom]:
+  FreeBSD 11.2-RELEASE-p4 (GENERIC) #0: Thu Sep 27 08:16:24 UTC 2018
+  
+  Welcome to FreeBSD!
+  
+  Release Notes, Errata: https://www.FreeBSD.org/releases/
+  Security Advisories:   https://www.FreeBSD.org/security/
+  FreeBSD Handbook:      https://www.FreeBSD.org/handbook/
+  FreeBSD FAQ:           https://www.FreeBSD.org/faq/
+  Questions List: https://lists.FreeBSD.org/mailman/listinfo/freebsd-questions/
+  FreeBSD Forums:        https://forums.FreeBSD.org/
+  
+  Documents installed with the system are in the /usr/local/share/doc/freebsd/
+  directory, or can be installed later with:  pkg install en-freebsd-doc
+  For other languages, replace "en" with a language code like de or fr.
+  
+  Show the version of FreeBSD installed:  freebsd-version ; uname -a
+  Please include that output and any error messages when posting questions.
+  Introduction to manual pages:  man man
+  FreeBSD directory layout:      man hier
+  
+  Edit /etc/motd to change this login announcement.
+  root@folsom:~ #
+
+At this point you are logged in to the jail and have full shell access.
+The system is yours to use and/or abuse as you like. Any changes made
+inside the jail are limited to the jail. 

docs/chapters/subcommands/cp.rst

@@ -0,0 +1,21 @@
+cp
+==
+
+This command allows efficiently copying files from host to jail(s).
+
+.. code-block:: shell
+
+  ishmael ~ # bastille cp ALL /tmp/resolv.conf-cf etc/resolv.conf
+  [bastion]:
+  
+  [unbound0]:
+  
+  [unbound1]:
+  
+  [squid]:
+  
+  [nginx]:
+  
+  [folsom]:
+
+Unless you see errors reported in the output the `cp` was successful.

docs/chapters/subcommands/create.rst

@@ -0,0 +1,32 @@
+======
+create
+======
+
+Bastille create uses any available bootstrapped release to create a
+lightweight jailed system. To create a jail simply provide a name,
+bootstrapped release and a private (rfc1918) IP address.
+
+- name
+- release
+- ip
+
+.. code-block:: shell
+
+  ishmael ~ # bastille create folsom 11.2-RELEASE 10.8.62.1
+  
+  RELEASE: 11.2-RELEASE.
+  NAME: folsom.
+  IP: 10.8.62.1.
+
+This command will create a 11.2-RELEASE jail assigning the 10.8.62.1 ip
+address to the new system.
+
+I recommend using private (rfc1918) ip address ranges for your jails.
+These ranges include:
+
+- 10.0.0.0/8
+- 172.16.0.0/12
+- 192.168.0.0/16
+
+Bastille does its best to validate the submitted ip is valid. This has not
+been thouroughly tested--I generally use the 10/8 range.

docs/chapters/subcommands/destroy.rst

@@ -0,0 +1,18 @@
+destroy
+=======
+
+Jails can be destroyed and thrown away just as easily as they were
+created.  Note: jails must be stopped before destroyed.
+
+.. code-block:: shell
+
+  ishmael ~ # bastille stop folsom
+  [folsom]:
+  folsom: removed
+
+.. code-block:: shell
+
+  ishmael ~ # bastille destroy folsom
+  Deleting Jail: folsom.
+  Note: jail console logs not destroyed.
+  /usr/local/bastille/logs/folsom_console.log

docs/chapters/subcommands/htop.rst

@@ -0,0 +1,11 @@
+====
+htop
+====
+
+This one runs `htop` inside the jail. 
+note: won't work if you don't have htop installed in the jail.
+
+
+.. image:: ../../images/htop.png
+    :align: center
+    :alt: bastille htop jail

docs/chapters/subcommands/index.rst

@@ -0,0 +1,24 @@
+Bastille sub-commands
+=====================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   bootstrap
+   cmd
+   console
+   cp
+   create
+   destroy
+   htop
+   pkg
+   restart
+   start
+   stop
+   sysrc
+   top
+   update
+   update
+   upgrade
+   verify

docs/chapters/subcommands/pkg.rst

@@ -0,0 +1,164 @@
+===
+pkg
+===
+
+To manage binary packages within the jail use `bastille pkg`.
+
+.. code-block:: shell
+
+  ishmael ~ # bastille pkg folsom 'install vim-console git-lite zsh'
+  [folsom]:
+  The package management tool is not yet installed on your system.
+  Do you want to fetch and install it now? [y/N]: y
+  Bootstrapping pkg from pkg+http://pkg.FreeBSD.org/FreeBSD:10:amd64/quarterly, please wait...
+  Verifying signature with trusted certificate pkg.freebsd.org.2013102301... done
+  [folsom] Installing pkg-1.10.5_5...
+  [folsom] Extracting pkg-1.10.5_5: 100%
+  Updating FreeBSD repository catalogue...
+  pkg: Repository FreeBSD load error: access repo file(/var/db/pkg/repo-FreeBSD.sqlite) failed: No such file or directory
+  [folsom] Fetching meta.txz: 100%    944 B   0.9kB/s    00:01
+  [folsom] Fetching packagesite.txz: 100%    6 MiB   3.4MB/s    00:02
+  Processing entries: 100%
+  FreeBSD repository update completed. 32550 packages processed.
+  All repositories are up to date.
+  Updating database digests format: 100%
+  The following 10 package(s) will be affected (of 0 checked):
+  
+  New packages to be INSTALLED:
+      vim-console: 8.1.0342
+      git-lite: 2.19.1
+      zsh: 5.6.2
+      expat: 2.2.6_1
+      curl: 7.61.1
+      libnghttp2: 1.33.0
+      ca_root_nss: 3.40
+      pcre: 8.42
+      gettext-runtime: 0.19.8.1_1
+      indexinfo: 0.3.1
+  
+  Number of packages to be installed: 10
+  
+  The process will require 77 MiB more space.
+  17 MiB to be downloaded.
+  
+  Proceed with this action? [y/N]: y
+  [folsom] [1/10] Fetching vim-console-8.1.0342.txz: 100%    5 MiB   5.8MB/s    00:01
+  [folsom] [2/10] Fetching git-lite-2.19.1.txz: 100%    4 MiB   2.1MB/s    00:02
+  [folsom] [3/10] Fetching zsh-5.6.2.txz: 100%    4 MiB   4.4MB/s    00:01
+  [folsom] [4/10] Fetching expat-2.2.6_1.txz: 100%  109 KiB 111.8kB/s    00:01
+  [folsom] [5/10] Fetching curl-7.61.1.txz: 100%    1 MiB   1.2MB/s    00:01
+  [folsom] [6/10] Fetching libnghttp2-1.33.0.txz: 100%  107 KiB 109.8kB/s    00:01
+  [folsom] [7/10] Fetching ca_root_nss-3.40.txz: 100%  287 KiB 294.3kB/s    00:01
+  [folsom] [8/10] Fetching pcre-8.42.txz: 100%    1 MiB   1.2MB/s    00:01
+  [folsom] [9/10] Fetching gettext-runtime-0.19.8.1_1.txz: 100%  148 KiB 151.3kB/s    00:01
+  [folsom] [10/10] Fetching indexinfo-0.3.1.txz: 100%    6 KiB   5.7kB/s    00:01
+  Checking integrity... done (0 conflicting)
+  [folsom] [1/10] Installing libnghttp2-1.33.0...
+  [folsom] [1/10] Extracting libnghttp2-1.33.0: 100%
+  [folsom] [2/10] Installing ca_root_nss-3.40...
+  [folsom] [2/10] Extracting ca_root_nss-3.40: 100%
+  [folsom] [3/10] Installing indexinfo-0.3.1...
+  [folsom] [3/10] Extracting indexinfo-0.3.1: 100%
+  [folsom] [4/10] Installing expat-2.2.6_1...
+  [folsom] [4/10] Extracting expat-2.2.6_1: 100%
+  [folsom] [5/10] Installing curl-7.61.1...
+  [folsom] [5/10] Extracting curl-7.61.1: 100%
+  [folsom] [6/10] Installing pcre-8.42...
+  [folsom] [6/10] Extracting pcre-8.42: 100%
+  [folsom] [7/10] Installing gettext-runtime-0.19.8.1_1...
+  [folsom] [7/10] Extracting gettext-runtime-0.19.8.1_1: 100%
+  [folsom] [8/10] Installing vim-console-8.1.0342...
+  [folsom] [8/10] Extracting vim-console-8.1.0342: 100%
+  [folsom] [9/10] Installing git-lite-2.19.1...
+  ===> Creating groups.
+  Creating group 'git_daemon' with gid '964'.
+  ===> Creating users
+  Creating user 'git_daemon' with uid '964'.
+  [folsom] [9/10] Extracting git-lite-2.19.1: 100%
+  [folsom] [10/10] Installing zsh-5.6.2...
+  [folsom] [10/10] Extracting zsh-5.6.2: 100%
+    
+
+The PKG sub-command can, of course, do more than just `install`. The
+expectation is that you can fully leverage the pkg manager. This means,
+`install`, `update`, `upgrade`, `audit`, `clean`, `autoremove`, etc., etc.
+
+.. code-block:: shell
+
+  ishmael ~ # bastille pkg ALL upgrade
+  [bastion]:
+  Updating iniquity.io repository catalogue...
+  [bastion] Fetching meta.txz: 100%    560 B   0.6kB/s    00:01
+  [bastion] Fetching packagesite.txz: 100%  118 KiB 121.3kB/s    00:01
+  Processing entries: 100%
+  iniquity.io repository update completed. 493 packages processed.
+  All repositories are up to date.
+  Checking for upgrades (1 candidates): 100%
+  Processing candidates (1 candidates): 100%
+  Checking integrity... done (0 conflicting)
+  Your packages are up to date.
+  
+  [unbound0]:
+  Updating iniquity.io repository catalogue...
+  [unbound0] Fetching meta.txz: 100%    560 B   0.6kB/s    00:01
+  [unbound0] Fetching packagesite.txz: 100%  118 KiB 121.3kB/s    00:01
+  Processing entries: 100%
+  iniquity.io repository update completed. 493 packages processed.
+  All repositories are up to date.
+  Checking for upgrades (0 candidates): 100%
+  Processing candidates (0 candidates): 100%
+  Checking integrity... done (0 conflicting)
+  Your packages are up to date.
+  
+  [unbound1]:
+  Updating iniquity.io repository catalogue...
+  [unbound1] Fetching meta.txz: 100%    560 B   0.6kB/s    00:01
+  [unbound1] Fetching packagesite.txz: 100%  118 KiB 121.3kB/s    00:01
+  Processing entries: 100%
+  iniquity.io repository update completed. 493 packages processed.
+  All repositories are up to date.
+  Checking for upgrades (0 candidates): 100%
+  Processing candidates (0 candidates): 100%
+  Checking integrity... done (0 conflicting)
+  Your packages are up to date.
+  
+  [squid]:
+  Updating iniquity.io repository catalogue...
+  [squid] Fetching meta.txz: 100%    560 B   0.6kB/s    00:01
+  [squid] Fetching packagesite.txz: 100%  118 KiB 121.3kB/s    00:01
+  Processing entries: 100%
+  iniquity.io repository update completed. 493 packages processed.
+  All repositories are up to date.
+  Checking for upgrades (0 candidates): 100%
+  Processing candidates (0 candidates): 100%
+  Checking integrity... done (0 conflicting)
+  Your packages are up to date.
+  
+  [nginx]:
+  Updating iniquity.io repository catalogue...
+  [nginx] Fetching meta.txz: 100%    560 B   0.6kB/s    00:01
+  [nginx] Fetching packagesite.txz: 100%  118 KiB 121.3kB/s    00:01
+  Processing entries: 100%
+  iniquity.io repository update completed. 493 packages processed.
+  All repositories are up to date.
+  Checking for upgrades (1 candidates): 100%
+  Processing candidates (1 candidates): 100%
+  The following 1 package(s) will be affected (of 0 checked):
+  
+  Installed packages to be UPGRADED:
+      nginx-lite: 1.14.0_14,2 -> 1.14.1,2
+  
+  Number of packages to be upgraded: 1
+  
+  315 KiB to be downloaded.
+  
+  Proceed with this action? [y/N]: y
+  [nginx] [1/1] Fetching nginx-lite-1.14.1,2.txz: 100%  315 KiB 322.8kB/s    00:01
+  Checking integrity... done (0 conflicting)
+  [nginx] [1/1] Upgrading nginx-lite from 1.14.0_14,2 to 1.14.1,2...
+  ===> Creating groups.
+  Using existing group 'www'.
+  ===> Creating users
+  Using existing user 'www'.
+  [nginx] [1/1] Extracting nginx-lite-1.14.1,2: 100%
+  You may need to manually remove /usr/local/etc/nginx/nginx.conf if it is no longer needed.

docs/chapters/subcommands/restart.rst

@@ -0,0 +1,13 @@
+restart
+=======
+
+To restart a jail you can use the `bastille restart` command.
+
+.. code-block:: shell
+
+  ishmael ~ # bastille restart folsom
+  [folsom]:
+  folsom: removed
+  
+  [folsom]:
+  folsom: created

docs/chapters/subcommands/start.rst

@@ -0,0 +1,10 @@
+start
+=====
+
+To start a jail you can use the `bastille start` command.
+
+.. code-block:: shell
+
+  ishmael ~ # bastille start folsom
+  [folsom]:
+  folsom: created

docs/chapters/subcommands/stop.rst

@@ -0,0 +1,10 @@
+stop
+====
+
+To stop a jail you can use the `bastille stop` command.
+
+.. code-block:: shell
+
+  ishmael ~ # bastille stop folsom
+  [folsom]:
+  folsom: removed

docs/chapters/subcommands/sysrc.rst

@@ -0,0 +1,14 @@
+=====
+sysrc
+=====
+
+The `sysrc` sub-command allows for safely editing system configuration files.
+In jail terms, this allows us to toggle on/off services and options at startup.
+
+.. code-block:: shell
+
+  ishmael ~ # bastille sysrc nginx nginx_enable="YES"
+  [nginx]:
+  nginx_enable: NO -> YES
+
+See `man sysrc(8)` for more info.

docs/chapters/subcommands/top.rst

@@ -0,0 +1,10 @@
+===
+top
+===
+
+This one runs `top` in that jail. 
+
+
+.. image:: ../../images/top.png
+    :align: center
+    :alt: bastille top jail

docs/chapters/subcommands/update.rst

@@ -0,0 +1,41 @@
+======
+update
+======
+
+The `update` command targets a release instead of a jail. Because every jail is
+based on a release, when the release is updated all the jails are automatically
+updated as well.
+
+If no updates are available, a message will be shown:
+
+.. code-block:: shell
+
+  ishmael ~ # bastille update 11.2-RELEASE
+  Looking up update.FreeBSD.org mirrors... 2 mirrors found.
+  Fetching metadata signature for 11.2-RELEASE from update4.freebsd.org... done.
+  Fetching metadata index... done.
+  Inspecting system... done.
+  Preparing to download files... done.
+  
+  No updates needed to update system to 11.2-RELEASE-p4.
+  No updates are available to install.
+
+
+The older the release, however, the more updates will be available:
+
+.. code-block:: shell
+
+  ishmael ~ # bastille update 10.4-RELEASE
+  Looking up update.FreeBSD.org mirrors... 2 mirrors found.
+  Fetching metadata signature for 10.4-RELEASE from update1.freebsd.org... done.
+  Fetching metadata index... done.
+  Fetching 2 metadata patches.. done.
+  Applying metadata patches... done.
+  Fetching 2 metadata files... done.
+  Inspecting system... done.
+  Preparing to download files... done.
+  
+  The following files will be added as part of updating to 10.4-RELEASE-p13:
+  ...[snip]...
+
+To be safe, you may want to restart any jails that have been updated live.

docs/chapters/subcommands/upgrade.rst

@@ -0,0 +1,11 @@
+=======
+upgrade
+=======
+
+This command lets you upgrade a release to a new release. Depending on the
+workflow this can be similar to a `bootstrap`.
+
+.. code-block:: shell
+
+  ishmael ~ # bastille upgrade 11.2-RELEASE 12.0-RELEASE
+

docs/chapters/subcommands/verify.rst

@@ -0,0 +1,21 @@
+======
+verify
+======
+
+This command scans a bootstrapped release and validates that everything looks
+in order. This is not a 100% comprehensive check, but it compares the release
+against a "known good" index.
+
+If you see errors or issues here, consider deleting and re-bootstrapping
+the release.
+
+.. code-block:: shell
+
+  ishmael ~ # bastille verify 11.2-RELEASE
+  Looking up update.FreeBSD.org mirrors... 2 mirrors found.
+  Fetching metadata signature for 11.2-RELEASE from update1.freebsd.org... done.
+  Fetching metadata index... done.
+  Fetching 1 metadata patches. done.
+  Applying metadata patches... done.
+  Fetching 1 metadata files... done.
+  Inspecting system... done.

docs/chapters/targeting.rst

@@ -0,0 +1,69 @@
+=========
+Targeting
+=========
+
+Bastille uses a `command-target-args` syntax, meaning that each command
+requires a target. Targets are usually jails, but can also be releases.
+
+Targeting a jail is done by providing the exact jail name.
+
+Targeting a release is done by providing the release name. (Note: do note
+include the `-pX` point-release version.)
+
+Bastille includes a pre-defined keyword ALL to target all running jails.
+
+In the future I would like to support more options, including globbing, lists
+and regular-expressions.
+
+Examples: Jails
+===============
+
+.. code-block:: shell
+
+  ishmael ~ # bastille ...
+
+
++-----------+--------+------------------+-------------------------------------------------------------+
+| command   | target | args             | description                                                 |
++===========+========+==================+=============================================================+
+| cmd       | ALL    | 'sockstat -4'    | execute `sockstat -4` in ALL jails (listening ip4 sockets)  |
++-----------+--------+-----+------------+-------------------------------------------------------------+ 
+| console   | mariadb02    | ---        | console (shell) access to mariadb02                         |
++----+------+----+---------+------------+--------------+----------------------------------------------+ 
+| pkg       | web01  | 'install nginx'  | install nginx package in web01 jail                         |
++-----------+--------+------------------+-------------------------------------------------------------+
+| pkg       | ALL    | upgrade          | upgrade packages in ALL jails                               |
++-----------+--------+------------------+-------------------------------------------------------------+ 
+| pkg       | ALL    | audit            | (CVE) audit packages in ALL jails                           |
++-----------+--------+------------------+-------------------------------------------------------------+ 
+| sysrc     | web01  | nginx_enable=YES | execute `sysrc nginx_enable=YES` in web01 jail              |
++-----------+--------+------------------+-------------------------------------------------------------+ 
+| template  | ALL    | base             | apply `base` template to ALL jails                          |
++-----------+--------+------------------+-------------------------------------------------------------+ 
+| start     | web02  | ---              | start web02 jail                                            |
++-----------+--------+-----+------------+-------------------------------------------------------------+ 
+| cp | bastion03 | /tmp/resolv.conf-cf etc/resolv.conf | copy host-path to jail-path in bastion03     |
++----+------+----+---+------------------+--------------+----------------------------------------------+ 
+| create    | folsom | 12.0-RELEASE 10.10.10.10        | create v12.0 jail named `folsom` with IP     |
++-----------+--------+------------------+--------------+----------------------------------------------+
+
+
+Examples: Releases
+==================
+
+.. code-block:: shell
+
+  ishmael ~ # bastille ...
+
+
++-----------+--------------+--------------+-------------------------------------------------------------+
+| command   | target       | args         | description                                                 |
++===========+==============+==============+=============================================================+
+| bootstrap | 12.0-RELEASE | ---          | bootstrap 12.0-RELEASE release                              |
++-----------+--------------+--------------+-------------------------------------------------------------+ 
+| update    | 11.2-RELEASE | ---          | update 11.2-RELEASE release                                 |
++-----------+--------------+--------------+-------------------------------------------------------------+ 
+| upgrade   | 11.1-RELEASE | 11.2-RELEASE | update 11.2-RELEASE release                                 |
++-----------+--------------+--------------+-------------------------------------------------------------+ 
+| verify    | 11.2-RELEASE | ---          | update 11.2-RELEASE release                                 |
++-----------+--------------+--------------+-------------------------------------------------------------+ 

docs/chapters/template.rst

@@ -0,0 +1,132 @@
+========
+Template
+========
+
+Bastille supports a templating system allowing you to apply files, pkgs and
+execute commands inside the jail automatically.
+
+Currently supported template hooks are: `PRE`, `CONFIG`, `PKG`, `SYSRC`, `CMD`.
+Planned template hooks include: `FSTAB`, `PF`
+
+Templates are created in `${bastille_prefix}/templates` and can leverage any of
+the template hooks. Simply create a new directory named after the template. eg;
+
+.. code-block:: shell
+
+  mkdir -p /usr/local/bastille/templates/base
+
+To leverage a template hook, create an UPPERCASE file in the root of the
+template directory named after the hook you want to execute. eg;
+
+.. code-block:: shell
+
+  echo "zsh vim-console git-lite htop" > /usr/local/bastille/templates/base/PKG
+  echo "/usr/bin/chsh -s /usr/local/bin/zsh" > /usr/local/bastille/templates/base/CMD
+  echo "etc root usr" > /usr/local/bastille/templates/base/CONFIG
+
+Template hooks are executed in specific order and require specific syntax to
+work as expected. This table outlines those requirements:
+
+
++---------+------------------+--------------------------------------+
+| HOOK    | format           | example                              |
++=========+==================+======================================+
+| PRE/CMD | /bin/sh command  | /usr/bin/chsh -s /usr/local/bin/zsh  |
++---------+------------------+--------------------------------------+
+| CONFIG  | path             | etc root usr                         |
++---------+------------------+--------------------------------------+
+| PKG     | port/pkg name(s) | vim-console zsh git-lite tree htop   |
++---------+------------------+--------------------------------------+
+| SYSRC   | sysrc command(s) | nginx_enable=YES                     |
++---------+------------------+--------------------------------------+
+
+Note: SYSRC requires NO quotes or that quotes (`"`) be escaped. ie; `\"`)
+
+In addition to supporting template hooks, Bastille supports overlaying
+files into the jail. This is done by placing the files in their full path,
+using the template directory as "/".
+
+An example here may help. Think of `/usr/local/bastille/templates/base`,
+our example template, as the root of our filesystem overlay. If you create
+an `etc/hosts` or `etc/resolv.conf` *inside* the base template directory,
+these can be overlayed into your jail.
+
+Note: due to the way FreeBSD segregates user-space, the majority of your
+overlayed template files will be in `usr/local`. The few general
+exceptions are the `etc/hosts`, `etc/resolv.conf`, and
+`etc/rc.conf.local`.
+
+After populating `usr/local/` with custom config files that your jail will
+use, be sure to include `usr` in the template CONFIG definition. eg;
+
+.. code-block:: shell
+
+  echo "etc usr" > /usr/local/bastille/templates/base/CONFIG
+
+The above example "etc usr" will include anything under "etc" and "usr"
+inside the template. You do not need to list individual files. Just
+include the top-level directory name.
+
+Applying Templates
+------------------
+
+Jails must be running to apply templates.
+
+Bastille includes a `template` command. This command requires a target and a
+template name. As covered in the previous section, template names correspond to
+directory names in the `bastille/templates` directory.
+
+.. code-block:: shell
+
+  ishmael ~ # bastille template ALL base
+  [cdn]:
+  Copying files...
+  Copy complete.
+  Installing packages.
+  pkg already bootstrapped at /usr/local/sbin/pkg
+  vulnxml file up-to-date
+  0 problem(s) in the installed packages found.
+  Updating iniquity.io repository catalogue...
+  [cdn] Fetching meta.txz: 100%    560 B   0.6kB/s    00:01
+  [cdn] Fetching packagesite.txz: 100%  121 KiB 124.3kB/s    00:01
+  Processing entries: 100%
+  iniquity.io repository update completed. 499 packages processed.
+  All repositories are up to date.
+  Checking integrity... done (0 conflicting)
+  The most recent version of packages are already installed
+  Updating services.
+  cron_flags: -J 60 -> -J 60
+  sendmail_enable: NONE -> NONE
+  syslogd_flags: -ss -> -ss
+  Executing final command(s).
+  chsh: user information updated
+  Template Complete.
+  
+  [poudriere]:
+  Copying files...
+  Copy complete.
+  Installing packages.
+  pkg already bootstrapped at /usr/local/sbin/pkg
+  vulnxml file up-to-date
+  0 problem(s) in the installed packages found.
+  Updating cdn.iniquity.io repository catalogue...
+  [poudriere] Fetching meta.txz: 100%    560 B   0.6kB/s    00:01
+  [poudriere] Fetching packagesite.txz: 100%  121 KiB 124.3kB/s    00:01
+  Processing entries: 100%
+  cdn.iniquity.io repository update completed. 499 packages processed.
+  Updating iniquity.io repository catalogue...
+  [poudriere] Fetching meta.txz: 100%    560 B   0.6kB/s    00:01
+  [poudriere] Fetching packagesite.txz: 100%  121 KiB 124.3kB/s    00:01
+  Processing entries: 100%
+  iniquity.io repository update completed. 499 packages processed.
+  All repositories are up to date.
+  Checking integrity... done (0 conflicting)
+  The most recent version of packages are already installed
+  Updating services.
+  cron_flags: -J 60 -> -J 60
+  sendmail_enable: NONE -> NONE
+  syslogd_flags: -ss -> -ss
+  Executing final command(s).
+  chsh: user information updated
+  Template Complete.
+

docs/chapters/usage.rst

@@ -0,0 +1,32 @@
+=====
+Usage
+=====
+
+.. code-block:: shell
+
+    ishmael ~ # bastille -h
+    Usage:
+      bastille command [ALL|glob] [args]
+    
+    Available Commands:
+      bootstrap   Bootstrap a FreeBSD release for jail base.
+      cmd         Execute arbitrary command on targeted jail(s).
+      console     Console into a running jail.
+      cp          cp(1) files from host to targeted jail(s).
+      create      Create a new jail.
+      destroy     Destroy a stopped jail.
+      help        Help about any command
+      htop        Interactive process viewer (requires htop).
+      list        List jails (running and stopped).
+      pkg         Manipulate binary packages within targeted jail(s). See pkg(8).
+      restart     Restart a running jail.
+      start       Start a stopped jail.
+      stop        Stop a running jail.
+      sysrc       Safely edit rc files within targeted jail(s).
+      template    Apply Bastille template to running jail(s).
+      top         Display and update information about the top(1) cpu processes.
+      update      Update jail base -pX release.
+      upgrade     Upgrade jail release to X.Y-RELEASE.
+    
+    Use "bastille -v|--version" for version information.
+    Use "bastille command -h|--help" for more information about a command.

docs/conf.py

@@ -0,0 +1,79 @@
+import os
+on_rtd = os.environ.get('READTHEDOCS') == 'True'
+if on_rtd:
+    html_theme = 'default'
+else:
+    html_theme = 'sphinx_rtd_theme'
+
+# -- Project information -----------------------------------------------------
+
+project = 'Bastille'
+copyright = '2018-2019, Christer Edwards'
+author = 'Christer Edwards'
+
+# The short X.Y version
+version = '0.3.20181124'
+# The full version, including alpha/beta/rc tags
+release = '0.3.20181124-beta'
+
+
+# -- General configuration ---------------------------------------------------
+
+extensions = [
+]
+
+templates_path = ['_templates']
+
+source_suffix = ['.rst', '.md']
+
+from recommonmark.parser import CommonMarkParser
+source_parsers = {
+    '.md': CommonMarkParser,
+}
+
+master_doc = 'index'
+language = None
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+pygments_style = None
+
+# -- Options for HTML output -------------------------------------------------
+
+html_static_path = ['_static']
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+htmlhelp_basename = 'Bastilledoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+}
+
+latex_documents = [
+    (master_doc, 'Bastille.tex', 'Bastille Documentation',
+     'Christer Edwards', 'manual'),
+]
+
+# -- Options for manual page output ------------------------------------------
+
+man_pages = [
+    (master_doc, 'bastille', 'Bastille Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+texinfo_documents = [
+    (master_doc, 'Bastille', 'Bastille Documentation',
+     author, 'Bastille', 'Bastille is a jail automation framework that allows you to quickly and easily create and manage FreeBSD jails.',
+     'Miscellaneous'),
+]
+
+# -- Options for Epub output -------------------------------------------------
+
+epub_title = project
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']

docs/copyright.rst

@@ -0,0 +1,8 @@
+=========
+Copyright
+=========
+
+This content is copyright Christer Edwards. All rights reserved.
+
+Duplication of this content without the express written permission of the
+author is not permitted.

docs/index.rst

@@ -0,0 +1,23 @@
+Bastille
+========
+
+Welcome to the official Bastille documentation. This collection of documents
+will outline installation and usage of Bastille.
+
+The latest version of this documentation can always be found at
+https://docs.bastillebsd.org.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   chapters/installation
+   chapters/networking
+   chapters/usage
+   chapters/targeting
+   chapters/subcommands/index
+   chapters/template
+
+   copyright
+
+Note: this documentation is included with the source code in `docs`.

usr/local/bin/bastille

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -28,14 +28,11 @@
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-SAVED_TERM=$TERM
-
 . /usr/local/share/bastille/colors.pre.sh
 . /usr/local/etc/bastille/bastille.conf
 
 ## version
-BASTILLE_VERSION="0.3.20181114"
+BASTILLE_VERSION="0.3.20190204"
-
 
 usage() {
     cat << EOF
@@ -91,19 +88,18 @@ esac
 # Filter out all non-commands
 case "${CMD}" in
 cmd|cp|create|destroy|list|pkg|restart|start|stop|sysrc|template|verify)
-	;;
+    ;;
 update|upgrade)
-	;;
+    ;;
 console|bootstrap|htop|top)
     ;;
 bootstrap|update|upgrade)
-	;;
+    ;;
 *)
-	usage
+usage
-	;;
+    ;;
 esac
 
-
 SCRIPTPATH="${bastille_sharedir}/${CMD}.sh"
 
 : ${UMASK:=022}

usr/local/etc/bastille/bastille.conf

@@ -9,3 +9,9 @@ bastille_logsdir=${bastille_prefix}/logs
 bastille_releasesdir=${bastille_prefix}/releases
 bastille_templatesdir=${bastille_prefix}/templates
 bastille_sharedir=/usr/local/share/bastille
+bastille_bootstrap_archives="base"
+bastille_tzdata="America/Denver"
+bastille_nameserver1="1.1.1.1"
+bastille_nameserver2="1.0.0.1"
+bastille_nameserver3=""
+bastille_nameserver_options="options edns0 rotate"

usr/local/etc/rc.d/bastille

@@ -1,8 +1,6 @@
 #!/bin/sh
 
-# $FreeBSD: $
+# Bastille jail startup script
-#
-# Bastille startup script
 #
 # PROVIDE: bastille
 # REQUIRE: LOGIN
@@ -12,25 +10,22 @@
 #
 # bastille_enable (bool):          Set to NO by default.
 #               Set it to YES to enable bastille.
-# bastille_list (string):        Set to "" by default.
+# bastille_list (string):        Set to "ALL" by default.
 #               Space separated list of jails to start.
 #
 
 . /etc/rc.subr
 
 name=bastille
-rcvar=bastille_enable
+rcvar=${name}_enable
-
-load_rc_config ${name}
 
 : ${bastille_enable:=NO}
-: ${bastille_list:=""}
+: ${bastille_list:="ALL"}
 
-start_cmd=bastille_start
+command=/usr/local/bin/${name}
-stop_cmd=bastille_stop
+start_cmd="bastille_start"
-
+stop_cmd="bastille_stop"
-start_command="%%PREFIX%%/bin/bastille start"
+restart_cmd="bastille_stop && bastille_start"
-stop_command="%%PREFIX%%/bin/bastille stop"
 
 bastille_start()
 {
@@ -43,7 +38,7 @@ bastille_start()
 
     for _jail in ${bastille_list}; do
         echo "Starting Bastille Jail: ${_jail}"
-        ${start_command} ${_jail}
+        ${command} start ${_jail}
     done
 }
 
@@ -58,8 +53,9 @@ bastille_stop()
 
     for _jail in ${bastille_list}; do
         echo "Stopping Bastille Jail: ${_jail}"
-        ${stop_command} ${_jail}
+        ${command} stop ${_jail}
     done
 }
 
+load_rc_config ${name}
 run_rc_command "$1"

usr/local/share/bastille/bootstrap.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -32,7 +32,7 @@
 . /usr/local/etc/bastille/bastille.conf
 
 usage() {
-    echo -e "${COLOR_RED}Usage: bastille bootstrap release.${COLOR_RESET}"
+    echo -e "${COLOR_RED}Usage: bastille bootstrap [release|template].${COLOR_RESET}"
     exit 1
 }
 
@@ -43,89 +43,170 @@ help|-h|--help)
     ;;
 esac
 
-RELEASE=$1
+bootstrap_release() {
-
+    ## ensure required directories are in place
-bootstrap() {
-    ### create $bastille_base/release/$release directory
-    ### fetch $release/base.txz -o $bastille_base/cache/$release/base.txz
-    ### extract $release/base.txz to $bastille_base/release/$release
     if [ ! -d ${bastille_jailsdir} ]; then
         mkdir -p ${bastille_jailsdir}
     fi
     if [ ! -d ${bastille_logsdir} ]; then
         mkdir -p ${bastille_logsdir}
     fi
-    if [ ! -d ${bastille_cachedir}/${RELEASE} ]; then
+    if [ ! -d ${bastille_templatesdir} ]; then
-        mkdir -p ${bastille_cachedir}/${RELEASE}
+        mkdir -p ${bastille_templatesdir}
+    fi
+    if [ ! -d "${bastille_cachedir}/${RELEASE}" ]; then
+        mkdir -p "${bastille_cachedir}/${RELEASE}"
     fi
 
-    if [ ! -d ${bastille_releasesdir}/${RELEASE} ]; then
+    ## if release exists, quit
-        mkdir -p ${bastille_releasesdir}/${RELEASE}
+    if [ -d "${bastille_releasesdir}/${RELEASE}" ]; then
-        sh ${bastille_sharedir}/freebsd_dist_fetch.sh -r ${RELEASE} base lib32
+        echo -e "${COLOR_RED}Bootstrap appears complete.${COLOR_RESET}"
+        exit 1
+    fi
+
+    ## if existing ${CACHEDIR}/${RELEASE}/base.txz; extract
+    if [ -f "${bastille_cachedir}/${RELEASE}/base.txz" ] && [ ! -d "${bastille_releasesdir}/${RELEASE}" ]; then
+        mkdir -p "${bastille_releasesdir}/${RELEASE}"
+        for _archive in ${bastille_bootstrap_archives}; do
+            echo -e "${COLOR_GREEN}Extracting FreeBSD ${RELEASE} ${_archive}.txz.${COLOR_RESET}"
+            /usr/bin/tar -C "${bastille_releasesdir}/${RELEASE}" -xf "${bastille_cachedir}/${RELEASE}/${_archive}.txz"
+        done
+
+        echo -e "${COLOR_GREEN}Bootstrap successful.${COLOR_RESET}"
+        echo -e "${COLOR_GREEN}See 'bastille --help' for available commands.${COLOR_RESET}"
+        echo
+    fi
+
+    ## if no existing ${CACHEDIR}/${RELEASE} download and extract
+    if [ ! -f "${bastille_cachedir}/${RELEASE}/base.txz" ] && [ ! -d "${bastille_releasesdir}/${RELEASE}" ]; then
+        mkdir -p "${bastille_releasesdir}/${RELEASE}"
+	fetch ${UPSTREAM_URL}/base.txz -o ${bastille_cachedir}/${RELEASE}/base.txz
 
         echo
-        echo -e "${COLOR_GREEN}Extracting FreeBSD ${RELEASE} base.txz.${COLOR_RESET}"
+        for _archive in ${bastille_bootstrap_archives}; do
-        /usr/bin/tar -C ${bastille_releasesdir}/${RELEASE} -xf ${bastille_cachedir}/${RELEASE}/base.txz
+            echo -e "${COLOR_GREEN}Extracting FreeBSD ${RELEASE} ${_archive}.txz.${COLOR_RESET}"
+            /usr/bin/tar -C "${bastille_releasesdir}/${RELEASE}" -xf "${bastille_cachedir}/${RELEASE}/${_archive}.txz"
+        done
 
-        echo -e "${COLOR_GREEN}Extracting FreeBSD ${RELEASE} lib32.txz.${COLOR_RESET}"
+        echo -e "${COLOR_GREEN}Bootstrap successful.${COLOR_RESET}"
-        /usr/bin/tar -C ${bastille_releasesdir}/${RELEASE} -xf ${bastille_cachedir}/${RELEASE}/lib32.txz
+        echo -e "${COLOR_GREEN}See 'bastille --help' for available commands.${COLOR_RESET}"
-
+        echo
-	    echo -e "${COLOR_GREEN}Bootstrap successful.${COLOR_RESET}"
-	    echo -e "${COLOR_GREEN}See 'bastille --help' for available commands.${COLOR_RESET}"
-	    echo
-    else
-        echo -e "${COLOR_RED}Bootstrap appears complete.${COLOR_RESET}"
-	exit 1
     fi
 }
 
+bootstrap_template() {
+    ## define basic variables
+    _url=${BASTILLE_TEMPLATE_URL}
+    _user=${BASTILLE_TEMPLATE_USER}
+    _repo=${BASTILLE_TEMPLATE_REPO}
+    _template=${bastille_templatesdir}/${_user}/${_repo}
+
+    ## verify essential directories are in place
+    if [ ! -d ${bastille_jailsdir} ]; then
+        mkdir -p ${bastille_jailsdir}
+    fi
+    if [ ! -d ${bastille_logsdir} ]; then
+        mkdir -p ${bastille_logsdir}
+    fi
+    if [ ! -d ${bastille_templatesdir} ]; then
+        mkdir -p ${bastille_templatesdir}
+    fi
+    if [ ! -d ${_template} ]; then
+        mkdir -p ${_template}
+    fi
+
+    ## support for non-git
+    if [ ! -x /usr/local/bin/git ]; then
+	echo -e "${COLOR_RED}We're gonna have to use fetch. Strap in.${COLOR_RESET}"
+	echo -e "${COLOR_RED}Not yet implemented...${COLOR_RESET}"
+    fi
+
+    ## support for git
+    if [ -x /usr/local/bin/git ]; then
+        if [ ! -d "${_template}/.git" ]; then
+            /usr/local/bin/git clone "${_url}" "${_template}" ||\
+                echo -e "${COLOR_RED}Clone unsuccessful.${COLOR_RESET}"
+                echo
+        elif [ -d "${_template}/.git" ]; then
+            cd ${_template} &&
+            /usr/local/bin/git pull ||\
+                echo -e "${COLOR_RED}Template update unsuccessful.${COLOR_RESET}"
+                echo
+        fi
+    fi
+
+    ## template validation
+    _hook_validate=0
+    for _hook in PRE FSTAB PF PKG SYSRC CMD; do
+        if [ -s ${_template}/${_hook} ]; then
+            _hook_validate=$((_hook_validate+1))
+            echo -e "${COLOR_GREEN}Detected ${_hook} hook.${COLOR_RESET}"
+            echo -e "${COLOR_GREEN}[${_hook}]:${COLOR_RESET}"
+            cat "${_template}/${_hook}"
+            echo
+        fi
+    done
+    if [ -s ${_template}/CONFIG ]; then
+        _hook_validate=$((_hook_validate+1))
+        echo -e "${COLOR_GREEN}Detected CONFIG hook.${COLOR_RESET}"
+        while read _dir; do
+            echo -e "${COLOR_GREEN}[${_dir}]:${COLOR_RESET}"
+            tree -a ${_template}/${_dir}
+        done < ${_template}/CONFIG
+        echo
+    fi
+
+    ## remove bad templates
+    if [ ${_hook_validate} -lt 1 ]; then
+        echo -e "${COLOR_GREEN}Template validation failed.${COLOR_RESET}"
+        echo -e "${COLOR_GREEN}Deleting template.${COLOR_RESET}"
+        rm -rf ${_template}
+	exit 1
+    fi
+
+    ## if validated; ready to use 
+    if [ ${_hook_validate} -gt 0 ]; then
+        echo -e "${COLOR_GREEN}Template ready to use.${COLOR_RESET}"
+        echo
+    fi
+}
+
+#Usage: bastille bootstrap [release|template].${COLOR_RESET}"
+
+HW_MACHINE=$(sysctl hw.machine | awk '{ print $2 }')
+HW_MACHINE_ARCH=$(sysctl hw.machine_arch | awk '{ print $2 }')
+
 # Filter sane release names
-case "${RELEASE}" in
+case "${1}" in
-10.1-RELEASE)
-    bootstrap
-    echo -e "${COLOR_RED}This release is End of Life. No security updates.${COLOR_RESET}"
-	;;
-10.2-RELEASE)
-    bootstrap
-    echo -e "${COLOR_RED}This release is End of Life. No security updates.${COLOR_RESET}"
-	;;
-10.3-RELEASE)
-    bootstrap
-    echo -e "${COLOR_RED}This release is End of Life. No security updates.${COLOR_RESET}"
-	;;
-10.4-RELEASE)
-    bootstrap
-    echo -e "${COLOR_RED}This release is End of Life. No security updates.${COLOR_RESET}"
-	;;
-11.0-RELEASE)
-    bootstrap
-    echo -e "${COLOR_RED}This release is End of Life. No security updates.${COLOR_RESET}"
-	;;
-11.1-RELEASE)
-    bootstrap
-    echo -e "${COLOR_RED}This release is End of Life. No security updates.${COLOR_RESET}"
-	;;
 11.2-RELEASE)
-    bootstrap
+    RELEASE="${1}"
-	;;
+    UPSTREAM_URL="http://ftp.freebsd.org/pub/FreeBSD/releases/${HW_MACHINE}/${HW_MACHINE_ARCH}/11.2-RELEASE/"
-12.0-BETA1)
+    bootstrap_release
-    bootstrap
+    ;;
-    echo -e "${COLOR_RED}BETA releases are completely untested.${COLOR_RESET}"
+12.0-RELEASE)
-	;;
+    RELEASE="${1}"
-12.0-BETA2)
+    UPSTREAM_URL="http://ftp.freebsd.org/pub/FreeBSD/releases/${HW_MACHINE}/${HW_MACHINE_ARCH}/12.0-RELEASE/"
-    bootstrap
+    bootstrap_release
-    echo -e "${COLOR_RED}BETA releases are completely untested.${COLOR_RESET}"
+    ;;
-	;;
+11-stable-LAST)
-12.0-BETA3)
+    RELEASE="${1}"
-    bootstrap
+    UPSTREAM_URL="https://installer.hardenedbsd.org/pub/HardenedBSD/releases/${HW_MACHINE}/${HW_MACHINE_ARCH}/hardenedbsd-11-stable-LAST/"
-    echo -e "${COLOR_RED}BETA releases are completely untested.${COLOR_RESET}"
+    bootstrap_release
-	;;
+    ;;
-12.0-BETA4)
+12-stable-LAST)
-    bootstrap
+    RELEASE="${1}"
-    echo -e "${COLOR_RED}BETA releases are completely untested.${COLOR_RESET}"
+    UPSTREAM_URL="https://installer.hardenedbsd.org/pub/HardenedBSD/releases/${HW_MACHINE}/${HW_MACHINE_ARCH}/hardenedbsd-12-stable-LAST/"
-	;;
+    bootstrap_release
+    ;;
+http?://github.com/*/*)
+    BASTILLE_TEMPLATE_URL=${1}
+    BASTILLE_TEMPLATE_USER=$(echo "${1}" | awk -F / '{ print $4 }')
+    BASTILLE_TEMPLATE_REPO=$(echo "${1}" | awk -F / '{ print $5 }')
+    echo -e "${COLOR_GREEN}Template: ${1}${COLOR_RESET}"
+    echo
+    bootstrap_template
+    ;;
 *)
-    echo -e "${COLOR_RED}BETA releases are completely untested.${COLOR_RESET}"
     usage
     ;;
 esac

usr/local/share/bastille/cmd.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -47,10 +47,10 @@ if [ $# -gt 2 ] || [ $# -lt 2 ]; then
 fi
 
 if [ "$1" = 'ALL' ]; then
-    JAILS=$(jls -N name)
+    JAILS=$(jls name)
 fi
 if [ "$1" != 'ALL' ]; then
-    JAILS=$(jls -N name | grep "$1")
+    JAILS=$(jls name | grep -E "(^|\b)${1}($|\b)")
 fi
 
 for _jail in ${JAILS}; do

usr/local/share/bastille/console.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -42,15 +42,14 @@ help|-h|--help)
     ;;
 esac
 
-
 if [ $# -gt 1 ] || [ $# -lt 1 ]; then
     usage
 fi
 if [ "$1" = 'ALL' ]; then
-    JAILS=$(jls -N name)
+    JAILS=$(jls name)
 fi
 if [ "$1" != 'ALL' ]; then
-    JAILS=$(jls -N name | grep "$1")
+    JAILS=$(jls name | grep -E "(^|\b)${1}($|\b)")
 fi
 
 for _jail in ${JAILS}; do

usr/local/share/bastille/cp.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -47,15 +47,15 @@ if [ $# -gt 3 ] || [ $# -lt 3 ]; then
     usage
 fi
 
-if [ "$1" != 'ALL' ]; then
-    JAILS=$(jls -N name | grep "$1")
-fi
 if [ "$1" = 'ALL' ]; then
-    JAILS=$(jls -N name)
+    JAILS=$(jls name)
+fi
+if [ "$1" != 'ALL' ]; then
+    JAILS=$(jls name | grep -E "(^|\b)${1}($|\b)")
 fi
 
 for _jail in ${JAILS}; do
-    bastille_jail_path="${bastille_jailsdir}/${_jail}/root"
+    bastille_jail_path="$(jls -j "${_jail}" path)"
     echo -e "${COLOR_GREEN}[${_jail}]:${COLOR_RESET}"
     cp -a "$2" "${bastille_jail_path}/$3"
     echo

usr/local/share/bastille/create.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -37,7 +37,7 @@ usage() {
 }
 
 running_jail() {
-    jls -N name | grep ${NAME}
+    jls name | grep -E "(^|\b)${NAME}($|\b)"
 }
 
 validate_ip() {
@@ -65,7 +65,7 @@ create_jail() {
     bastille_jail_fstab="${bastille_jailsdir}/${NAME}/fstab"  ## file
     bastille_jail_conf="${bastille_jailsdir}/${NAME}/jail.conf"  ## file
     bastille_jail_log="${bastille_logsdir}/${NAME}_console.log"  ## file
-    bastille_jail_rc_conf="${bastille_jailsdir}/${NAME}/root/etc/rc.conf.local" ## file
+    bastille_jail_rc_conf="${bastille_jailsdir}/${NAME}/root/etc/rc.conf" ## file
     bastille_jail_resolv_conf="${bastille_jailsdir}/${NAME}/root/etc/resolv.conf" ## file
 
     if [ ! -d "${bastille_jail_base}" ]; then
@@ -94,7 +94,6 @@ create_jail() {
 
     ## using relative paths here
     ## MAKE SURE WE'RE IN THE RIGHT PLACE
-    ## ro
     cd "${bastille_jail_path}"
     echo
     echo -e "${COLOR_GREEN}NAME: ${NAME}.${COLOR_RESET}"
@@ -125,17 +124,30 @@ create_jail() {
     cp -a "${bastille_releasesdir}/${RELEASE}/usr/obj" "${bastille_jail_path}"
     if [ "${RELEASE}" == "11.2-RELEASE" ]; then cp -a "${bastille_releasesdir}/${RELEASE}/usr/tests" "${bastille_jail_path}"; fi
 
-    ## rc.conf.local & resolv.conf
+    ## rc.conf
+    ##  + syslogd_flags="-ss"
+    ##  + sendmail_none="NONE"
+    ##  + cron_flags="-J 60" ## cedwards 20181118
     if [ ! -f "${bastille_jail_rc_conf}" ]; then
-        echo -e "syslogd_flags=\"-ss\"\nsendmail_enable=\"NONE\"" > ${bastille_jail_rc_conf}
+        touch "${bastille_jail_rc_conf}"
+        /usr/sbin/sysrc -f "${bastille_jail_rc_conf}" syslogd_flags=-ss
+        /usr/sbin/sysrc -f "${bastille_jail_rc_conf}" sendmail_enable=NONE
+        /usr/sbin/sysrc -f "${bastille_jail_rc_conf}" cron_flags='-J 60'
+        echo
     fi
 
+    ## resolv.conf
+    ##  + default nameservers configurable; 1 required, 3 optional ## cedwards 20190522
+    ##  + nameserver options supported
     if [ ! -f "${bastille_jail_resolv_conf}" ]; then
-        echo -e "nameserver 1.1.1.1\nnameserver 1.0.0.1\noptions edns0 rotate" > ${bastille_jail_resolv_conf}
+        [ ! -z "${bastille_nameserver1}" ] && echo -e "nameserver ${bastille_nameserver1}" >> ${bastille_jail_resolv_conf}
+        [ ! -z "${bastille_nameserver2}" ] && echo -e "nameserver ${bastille_nameserver2}" >> ${bastille_jail_resolv_conf}
+        [ ! -z "${bastille_nameserver3}" ] && echo -e "nameserver ${bastille_nameserver3}" >> ${bastille_jail_resolv_conf}
+        [ ! -z "${bastille_nameserver_options}" ] && echo -e "${bastille_nameserver_options}" >> ${bastille_jail_resolv_conf}
     fi
 
-    ## TZ: UTC
+    ## TZ: configurable (default: etc/UTC)
-    ln -s /usr/share/zoneinfo/Etc/UTC etc/localtime
+    ln -s /usr/share/zoneinfo/${bastille_tzdata} etc/localtime
 }
 
 # Handle special-case commands first.
@@ -155,12 +167,18 @@ IP="$3"
 
 ## verify release
 case "${RELEASE}" in
-10.4-RELEASE)
-    RELEASE="10.4-RELEASE"
-    ;;
 11.2-RELEASE)
     RELEASE="11.2-RELEASE"
     ;;
+12.0-RELEASE)
+    RELEASE="12.0-RELEASE"
+    ;;
+11-stable-LAST)
+    RELEASE="11-stable-LAST"
+    ;;
+12-stable-LAST)
+    RELEASE="12-stable-LAST"
+    ;;
 *)
     echo -e "${COLOR_RED}Unknown Release.${COLOR_RESET}"
     usage
@@ -168,14 +186,15 @@ case "${RELEASE}" in
 esac
 
 ## check for name/root/.bastille
-if [ -d "/usr/local/bastille/jails/${NAME}/root/.bastille" ]; then
+if [ -d "${bastille_jailsdir}/${NAME}/root/.bastille" ]; then
     echo -e "${COLOR_RED}Jail: ${NAME} already created. ${NAME}/root/.bastille exists.${COLOR_RESET}"
     exit 1
 fi
 
 ## check if a running jail matches name
 if running_jail ${NAME}; then
-    echo -e "${COLOR_RED}Running jail matches name.${COLOR_RESET}"
+    echo -e "${COLOR_RED}A running jail matches name.${COLOR_RESET}"
+    echo -e "${COLOR_RED}Jails must be stopped before they are destroyed.${COLOR_RESET}"
     exit 1
 fi
 

usr/local/share/bastille/destroy.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -37,10 +37,10 @@ usage() {
 }
 
 destroy_jail() {
-    bastille_jail_base="${bastille_jailsdir}/${NAME}"  ## dir
+    bastille_jail_base="${bastille_jailsdir}/${NAME}"            ## dir
     bastille_jail_log="${bastille_logsdir}/${NAME}_console.log"  ## file
 
-    if [ $(jls -N name | grep ${NAME}) ]; then
+    if [ $(jls name | grep ${NAME}) ]; then
         echo -e "${COLOR_RED}Jail running.${COLOR_RESET}"
         echo -e "${COLOR_RED}See 'bastille stop ${NAME}'.${COLOR_RESET}"
         exit 1
@@ -55,8 +55,9 @@ destroy_jail() {
         echo -e "${COLOR_GREEN}Deleting Jail: ${NAME}.${COLOR_RESET}"
         chflags -R noschg ${bastille_jail_base}
         rm -rf ${bastille_jail_base}
-        echo -e "${COLOR_GREEN}Note: jail console logs not destroyed.${COLOR_RESET}"
+        mv ${bastille_jail_log} ${bastille_jail_log}-$(date +%F)
-	echo -e "${COLOR_GREEN}${bastille_jail_log}${COLOR_RESET}"
+        echo -e "${COLOR_GREEN}Note: jail console logs archived.${COLOR_RESET}"
+        echo -e "${COLOR_GREEN}${bastille_jail_log}-$(date +%F)${COLOR_RESET}"
         echo
     fi
 }

usr/local/share/bastille/freebsd_dist_fetch.sh

@@ -1,9 +1,9 @@
 #!/bin/sh
 # https://pastebin.com/T6eThbKu
 
+. /usr/local/etc/bastille/bastille.conf
+
 DEVICE_SELF_SCAN_ALL=NO
-DIALOG_BACKTITLE="BastilleBSD"
-DIALOG_TITLE="bootstrap"
 [ "$_SCRIPT_SUBR" ] || . /usr/share/bsdconfig/script.subr
 usage(){ echo "Usage: ${0##*/} [-r releaseName] [dists ...]" >&2; exit 1; }
 while getopts hr: flag; do
@@ -20,17 +20,17 @@ mediaSetFTP
 mediaOpen
 set -e
 #debug=1
-REL_DIST=/usr/local/bastille/cache/$releaseName
+REL_DIST=${bastille_cachedir}/$releaseName
 download() # $src to $dest
 {
 	size=$( f_device_get device_media "$1" $PROBE_SIZE )
-	f_device_get device_media "$1" | dpv -kb "$DIALOG_BACKTITLE" \
+	f_device_get device_media "$1" | dpv -kb "BastilleBSD" \
-		-t "$DIALOG_TITLE" -p "Downloading $releaseName" \
+		-t "bootstrap" -p "Downloading $releaseName" \
 		-o "$3" "$size:$1"
 }
 sign() # $file
 {
-	dpv -kb "$DIALOG_BACKTITLE" -t "$DIALOG_TITLE" \
+	dpv -kb "BastilleBSD" -t "bootstrap" \
 		-p "Signing $releaseName" -mx "sha256 >&2" \
 		"$size:${1##*/}" "$1" 2>&1 >&$TERMINAL_STDOUT_PASSTHRU
 }

usr/local/share/bastille/htop.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -48,21 +48,19 @@ if [ $# -gt 1 ] || [ $# -lt 1 ]; then
 fi
 
 if [ "$1" = 'ALL' ]; then
-    JAILS=$(jls -N name)
+    JAILS=$(jls name)
 fi
 if [ "$1" != 'ALL' ]; then
-    JAILS=$(jls -N name | grep "$1")
+    JAILS=$(jls name | grep -E "(^|\b)${1}($|\b)")
 fi
 
 for _jail in ${JAILS}; do
-    if [ ! -x "${bastille_jailsdir}/${_jail}/root/usr/local/bin/htop" ]; then
+    bastille_jail_path=$(jls -j "${_jail}" path)
+    if [ ! -x "${bastille_jail_path}/usr/local/bin/htop" ]; then
         echo -e "${COLOR_RED}htop not found on ${_jail}.${COLOR_RESET}"
-    fi
+    elif [ -x "${bastille_jail_path}/usr/local/bin/htop" ]; then
-    if [ -x "${bastille_jailsdir}/${_jail}/root/usr/local/bin/htop" ]; then
         echo -e "${COLOR_GREEN}[${_jail}]:${COLOR_RESET}"
         jexec -l ${_jail} /usr/local/bin/htop
     fi
     echo -e "${COLOR_RESET}"
 done
-
-TERM=${SAVED_TERM}

usr/local/share/bastille/list.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -47,16 +47,16 @@ if [ $# -gt 0 ]; then
         usage
         ;;
     release|releases)
-        ls "${bastille_releasesdir}"
+        ls "${bastille_releasesdir}" | sed "s/\n//g"
         ;;
     template|templates)
-        ls "${bastille_templatesdir}"
+	ls "${bastille_templatesdir}" | sed "s/\n//g"
         ;;
     jail|jails)
-        ls "${bastille_jailsdir}"
+	ls "${bastille_jailsdir}" | sed "s/\n//g"
         ;;
     log|logs)
-        ls "${bastille_logsdir}"
+        ls "${bastille_logsdir}" | sed "s/\n//g"
         ;;
     *)
         usage

usr/local/share/bastille/pkg.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -47,10 +47,10 @@ if [ $# -gt 2 ] || [ $# -lt 2 ]; then
 fi
 
 if [ "$1" = 'ALL' ]; then
-    JAILS=$(jls -N name)
+    JAILS=$(jls name)
 fi
 if [ "$1" != 'ALL' ]; then
-    JAILS=$(jls -N name | grep "$1")
+    JAILS=$(jls name | grep -E "(^|\b)${1}($|\b)")
 fi
 
 for _jail in ${JAILS}; do

usr/local/share/bastille/restart.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without

usr/local/share/bastille/service.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -47,11 +47,11 @@ if [ $# -gt 2 ] || [ $# -lt 2 ]; then
 fi
 
 if [ "$1" = 'ALL' ]; then
-    JAILS=$(jls -N name)
+    JAILS=$(jls name)
 fi
 
 if [ "$1" != 'ALL' ]; then
-    JAILS=$(jls -N name | grep "$1")
+    JAILS=$(jls name | grep -E "(^|\b)${1}($|\b)")
 fi
 
 for _jail in ${JAILS}; do

usr/local/share/bastille/start.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -48,22 +48,19 @@ if [ $# -gt 1 ] || [ $# -lt 1 ]; then
 fi
 
 if [ "$1" = 'ALL' ]; then
-    JAILS=$(find ${bastille_jailsdir} -d 1 | awk -F / '{ print $6 }')
+    JAILS=$(/usr/local/bin/bastille list jails)
 fi
 if [ "$1" != 'ALL' ]; then
-    JAILS=$(find ${bastille_jailsdir} -d 1 | awk -F / '{ print $6 }' | grep $1)
+    JAILS=$(/usr/local/bin/bastille list jails | grep "$1")
-fi
-
-if [ $(jls -N name | ${NAME}) ]; then
-    echo -e "${COLOR_RED}${NAME} already running.${COLOR_RESET}"
-    exit 1
 fi
 
 for _jail in ${JAILS}; do
-    echo -e "${COLOR_GREEN}[${_jail}]:${COLOR_RESET}"
+    if [ $(jls name | grep ${_jail}) ]; then
-    jail -f "${bastille_jailsdir}/${_jail}/jail.conf" -c ${_jail}
+        echo -e "${COLOR_RED}[${_jail}]: Already started.${COLOR_RESET}"
+    elif [ ! $(jls name | grep ${_jail}) ]; then
+        echo -e "${COLOR_GREEN}[${_jail}]:${COLOR_RESET}"
+        jail -f "${bastille_jailsdir}/${_jail}/jail.conf" -c ${_jail}
+        pfctl -f /etc/pf.conf
+    fi
     echo
 done
-
-## HUP the firewall
-pfctl -f /etc/pf.conf

usr/local/share/bastille/stop.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -48,10 +48,10 @@ if [ $# -gt 1 ] || [ $# -lt 1 ]; then
 fi
 
 if [ "$1" = 'ALL' ]; then
-    JAILS=$(jls -N name)
+    JAILS=$(jls name)
 fi
 if [ "$1" != 'ALL' ]; then
-    JAILS=$(jls -N name | grep "$1")
+    JAILS=$(jls name | grep -E "(^|\b)${1}($|\b)")
 fi
 
 for _jail in ${JAILS}; do
@@ -59,6 +59,3 @@ for _jail in ${JAILS}; do
     jail -f "${bastille_jailsdir}/${_jail}/jail.conf" -r ${_jail}
     echo
 done
-
-## HUP the firewall
-pfctl -f /etc/pf.conf

usr/local/share/bastille/sysrc.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -47,11 +47,11 @@ if [ $# -gt 2 ] || [ $# -lt 2 ]; then
 fi
 
 if [ "$1" = 'ALL' ]; then
-    JAILS=$(jls -N name)
+    JAILS=$(jls name)
 fi
 
 if [ "$1" != 'ALL' ]; then
-    JAILS=$(jls -N name | grep "$1")
+    JAILS=$(jls name | grep -E "(^|\b)${1}($|\b)")
 fi
 
 for _jail in ${JAILS}; do

usr/local/share/bastille/template.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -48,69 +48,103 @@ if [ $# -gt 2 ] || [ $# -lt 2 ]; then
 fi
 
 if [ "$1" = 'ALL' ]; then
-    JAILS=$(jls -N name)
+    JAILS=$(jls name)
 fi
 if [ "$1" != 'ALL' ]; then
-    JAILS=$(jls -N name | grep "$1")
+    JAILS=$(jls name | grep -E "(^|\b)${1}($|\b)")
 fi
 
+## global variables
 TEMPLATE=$2
 bastille_template=${bastille_templatesdir}/${TEMPLATE}
+bastille_template_TARGET=${bastille_template}/TARGET
+bastille_template_INCLUDE=${bastille_template}/INCLUDE
+bastille_template_PRE=${bastille_template}/PRE
+bastille_template_CONFIG=${bastille_template}/CONFIG
+bastille_template_FSTAB=${bastille_template}/FSTAB
+bastille_template_PF=${bastille_template}/PF
+bastille_template_PKG=${bastille_template}/PKG
+bastille_template_SYSRC=${bastille_template}/SYSRC
+bastille_template_CMD=${bastille_template}/CMD
 
 for _jail in ${JAILS}; do
+    ## jail-specific variables. 
+    bastille_jail_path=$(jls -j "${_jail}" path)
+
     echo -e "${COLOR_GREEN}[${_jail}]:${COLOR_RESET}"
 
+    ## TARGET
+    if [ -s "${bastille_template_TARGET}" ]; then
+        if [ $(grep -E "(^|\b)\!${_jail}($|\b)" ${bastille_template_TARGET}) ]; then
+            echo -e "${COLOR_GREEN}TARGET: !${_jail}.${COLOR_RESET}"
+	    echo
+            continue
+        fi
+	if [ ! $(grep -E "(^|\b)(${_jail}|ALL)($|\b)" ${bastille_template_TARGET}) ]; then
+            echo -e "${COLOR_GREEN}TARGET: ?${_jail}.${COLOR_RESET}"
+	    echo
+            continue
+        fi
+    fi
+
+    ## INCLUDE
+    if [ -s "${bastille_template_INCLUDE}" ]; then
+        echo -e "${COLOR_GREEN}Detected INCLUDE.${COLOR_RESET}"
+        while read _include; do
+            echo -e "${COLOR_GREEN}${_include}${COLOR_RESET}"
+        done < "${bastille_template_INCLUDE}"
+    fi
+
     ## pre
-    if [ -s "${bastille_template}/PRE" ]; then
+    if [ -s "${bastille_template_PRE}" ]; then
         echo -e "${COLOR_GREEN}Executing PRE-command(s).${COLOR_RESET}"
-        bastille_templatepre=$(cat "${bastille_template}/PRE")
+        jexec -l ${_jail} /bin/sh < "${bastille_template_PRE}"
-        jexec -l "${_jail}" /bin/sh "${bastille_templatepre}"
     fi
 
     ## config
-    if [ -s "${bastille_template}/CONFIG" ]; then
+    if [ -s "${bastille_template_CONFIG}" ]; then
         echo -e "${COLOR_GREEN}Copying files...${COLOR_RESET}"
-        for _dir in $(cat "${bastille_template}/CONFIG"); do
+        while read _dir; do
-            cp -a "${bastille_template}/${_dir}" "${bastille_jailsdir}/${_jail}/root"
+            cp -a "${bastille_template}/${_dir}" "${bastille_jail_path}"
-        done
+        done < ${bastille_template_CONFIG}
         echo -e "${COLOR_GREEN}Copy complete.${COLOR_RESET}"
     fi
 
     ## fstab
-    if [ -s "${bastille_template}/FSTAB" ]; then
+    if [ -s "${bastille_template_FSTAB}" ]; then
-        bastille_templatefstab=$(cat "${bastille_template}/FSTAB")
+        bastille_templatefstab=$(cat "${bastille_template_FSTAB}")
         echo -e "${COLOR_GREEN}Updating fstab.${COLOR_RESET}"
+        echo -e "${COLOR_GREEN}NOT YET IMPLEMENTED.${COLOR_RESET}"
     fi
 
     ## pf
-    if [ -s "${bastille_template}/PF" ]; then
+    if [ -s "${bastille_template_PF}" ]; then
-        bastille_templatepf=$(cat "${bastille_template}/PF")
+        bastille_templatepf=$(cat "${bastille_template_PF}")
         echo -e "${COLOR_GREEN}Generating PF profile.${COLOR_RESET}"
+        echo -e "${COLOR_GREEN}NOT YET IMPLEMENTED.${COLOR_RESET}"
     fi
 
     ## pkg (bootstrap + pkg)
-    if [ -s "${bastille_template}/PKG" ]; then
+    if [ -s "${bastille_template_PKG}" ]; then
-        bastille_templatepkg=$(cat "${bastille_template}/PKG")
         echo -e "${COLOR_GREEN}Installing packages.${COLOR_RESET}"
-        jexec -l ${_jail} env ASSUME_ALWAYS_YES="YES" /usr/sbin/pkg bootstrap
+        jexec -l "${_jail}" env ASSUME_ALWAYS_YES=YES /usr/sbin/pkg bootstrap
-        jexec -l ${_jail} env ASSUME_ALWAYS_YES="YES" /usr/sbin/pkg audit -F
+        jexec -l "${_jail}" env ASSUME_ALWAYS_YES=YES /usr/sbin/pkg audit -F
-        jexec -l ${_jail} env ASSUME_ALWAYS_YES="YES" /usr/sbin/pkg install -y ${bastille_templatepkg}
+        jexec -l "${_jail}" env ASSUME_ALWAYS_YES=YES /usr/sbin/pkg install $(cat ${bastille_template_PKG})
     fi
 
     ## sysrc
-    if [ -s "${bastille_template}/SYSRC" ]; then
+    if [ -s "${bastille_template_SYSRC}" ]; then
-        bastille_templatesys=$(cat "${bastille_template}/SYSRC")
         echo -e "${COLOR_GREEN}Updating services.${COLOR_RESET}"
-        jexec -l ${_jail} /usr/sbin/sysrc ${bastille_templatesys}
+        while read _sysrc; do
+            jexec -l ${_jail} /usr/sbin/sysrc "${_sysrc}"
+        done < "${bastille_template_SYSRC}"
     fi
 
     ## cmd
-    if [ -s "${bastille_template}/CMD" ]; then
+    if [ -s "${bastille_template_CMD}" ]; then
-        bastille_templatecmd=$(cat "${bastille_template}/CMD")
         echo -e "${COLOR_GREEN}Executing final command(s).${COLOR_RESET}"
-        jexec -l ${_jail} ${bastille_templatecmd}
+        jexec -l ${_jail} /bin/sh < "${bastille_template_CMD}"
     fi
     echo -e "${COLOR_GREEN}Template Complete.${COLOR_RESET}"
     echo
-    echo
 done

usr/local/share/bastille/top.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -47,11 +47,11 @@ if [ $# -gt 1 ] || [ $# -lt 1 ]; then
 fi
 
 if [ "$1" = 'ALL' ]; then
-    JAILS=$(jls -N name)
+    JAILS=$(jls name)
 fi
 
 if [ "$1" != 'ALL' ]; then
-    JAILS=$(jls -N name | grep "$1")
+    JAILS=$(jls name | grep -E "(^|\b)${1}($|\b)")
 fi
 
 for _jail in ${JAILS}; do
@@ -59,5 +59,3 @@ for _jail in ${JAILS}; do
     jexec -l ${_jail} /usr/bin/top
     echo -e "${COLOR_RESET}"
 done
-
-TERM=${SAVED_TERM}

usr/local/share/bastille/update.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -49,9 +49,11 @@ fi
 
 RELEASE=$1
 
-echo -e "${COLOR_RED}Targeting specified release.${COLOR_RESET}"
+if [ ! -z "$(freebsd-version | grep -i HBSD)" ]; then
-echo -e "${RELEASE}"
+    echo -e "${COLOR_RED}Not yet supported on HardenedBSD.${COLOR_RESET}"
-echo
+    exit 1
+fi
+
 if [ -d "${bastille_releasesdir}/${RELEASE}" ]; then
     freebsd-update -b "${bastille_releasesdir}/${RELEASE}" fetch install --currently-running ${RELEASE}
 else

usr/local/share/bastille/upgrade.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -50,9 +50,12 @@ fi
 RELEASE=$1
 NEWRELEASE=$2
 
-echo -e "${COLOR_RED}Targeting specified release.${COLOR_RESET}"
+if [ ! -z "$(freebsd-version | grep -i HBSD)" ]; then
-echo -e "${RELEASE} => ${NEWRELEASE}"
+    echo -e "${COLOR_RED}Not yet supported on HardenedBSD.${COLOR_RESET}"
-echo
+    exit 1
+fi
+
+
 if [ -d "${bastille_releasesdir}/${RELEASE}" ]; then
     freebsd-update -b "${bastille_releasesdir}/${RELEASE}" -r ${NEWRELEASE} upgrade
 else

usr/local/share/bastille/verify.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 # 
-# Copyright (c) 2018, Christer Edwards <christer.edwards@gmail.com>
+# Copyright (c) 2018-2019, Christer Edwards <christer.edwards@gmail.com>
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without
@@ -49,9 +49,11 @@ fi
 
 RELEASE=$1
 
-echo -e "${COLOR_RED}Targeting specified release.${COLOR_RESET}"
+if [ ! -z "$(freebsd-version | grep -i HBSD)" ]; then
-echo -e "${RELEASE}"
+    echo -e "${COLOR_RED}Not yet supported on HardenedBSD.${COLOR_RESET}"
-echo
+    exit 1
+fi
+
 if [ -d "${bastille_releasesdir}/${RELEASE}" ]; then
     freebsd-update -b "${bastille_releasesdir}/${RELEASE}" IDS
 else