diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..d59ecc0
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,2 @@
+# Set line endings to LF
+* text eol=lf
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
new file mode 100644
index 0000000..3e8e289
--- /dev/null
+++ b/.github/workflows/build.yml
@@ -0,0 +1,55 @@
+name: Docker CI
+on:
+ push:
+ branches: [ main ]
+ paths-ignore:
+ - '.gitignore'
+ - 'README.md'
+ schedule:
+ - cron: '15 0 * * 0'
+env:
+ BETA_CHANNEL: 24.04
+ STABLE_CHANNEL: 22.04
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - name: Configure Docker
+ env:
+ DOCKER_USER: ${{secrets.DOCKER_USER}}
+ DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}}
+ run: |
+ docker login -u $DOCKER_USER -p $DOCKER_TOKEN
+ - name: Build 22.04
+ run: |
+ docker build . --pull --build-arg OS_VERSION=${{env.STABLE_CHANNEL}} --tag bshp/ocie:latest --no-cache
+ - name: Push 22.04
+ run: |
+ docker tag bshp/ocie:latest bshp/ocie:${{env.STABLE_CHANNEL}}
+ docker push bshp/ocie:latest
+ docker push bshp/ocie:${{env.STABLE_CHANNEL}}
+ - name: Build 24.04
+ run: |
+ docker build . --pull --build-arg OS_VERSION=${{env.BETA_CHANNEL}} --tag bshp/ocie:beta --no-cache
+ - name: Push 24.04
+ run: |
+ docker tag bshp/ocie:beta bshp/ocie:${{env.BETA_CHANNEL}}
+ docker push bshp/ocie:beta
+ docker push bshp/ocie:${{env.BETA_CHANNEL}}
+ - name: Build Apache Base
+ run: |
+ curl -L -X POST \
+ -H "Accept: application/vnd.github+json" \
+ -H "Authorization: ${{secrets.WF_TOKEN}}" \
+ -H "X-GitHub-Api-Version: 2022-11-28" \
+ https://api.github.com/repos/bshp/apache2/actions/workflows/build.yml/dispatches \
+ -d '{"ref":"master"}'
+ - name: Build Mantis
+ run: |
+ curl -L -X POST \
+ -H "Accept: application/vnd.github+json" \
+ -H "Authorization: ${{secrets.WF_TOKEN}}" \
+ -H "X-GitHub-Api-Version: 2022-11-28" \
+ https://api.github.com/repos/bshp/mantis/actions/workflows/build.yml/dispatches \
+ -d '{"ref":"main"}'
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..7b6255a
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,4 @@
+*.log
+.build
+*.tar
+*.tar.gz
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000..8240562
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,46 @@
+# syntax=docker/dockerfile-upstream:master
+
+# Ubuntu Version, e.g 22.04 unquoted
+ARG OS_VERSION
+
+# Optional: Change Timezone
+ARG TZ=America/North_Dakota/Center
+
+FROM ubuntu:$OS_VERSION
+
+LABEL org.opencontainers.image.authors="jason.everling@gmail.com"
+
+ARG OS_VERSION
+ARG TZ
+
+ENV OCIE_HOME=/etc/ocie
+ENV OCIE_LIB=/usr/lib/ocie
+ENV OCIE_TYPES=${OCIE_LIB}/types
+
+# Add Ocie
+COPY --chown=root:root --chmod=0755 ./src/ ./
+
+RUN <<-"EOD" bash
+ set -eu;
+ echo "Ocie: Setting up environment";
+ echo "OCIE_BIN=/usr/sbin" >> /etc/environment;
+ echo "OCIE_HOME=${OCIE_HOME}" >> /etc/environment;
+ echo "OCIE_LIB=${OCIE_LIB}" >> /etc/environment;
+ echo "OCIE_TYPES=${OCIE_TYPES}" >> /etc/environment;
+ echo "OS_BASE=${OS_VERSION}" >> /etc/environment;
+ echo "OS_CODENAME=$(grep -o 'VERSION_CODENAME=.*' > /etc/environment;
+ echo "OS_IMAGE=ubuntu:${OS_VERSION}" >> /etc/environment;
+ echo "OS_TIMEZONE=${TZ}" >> /etc/environment;
+ echo "OS_VERSION=${OS_VERSION//.}" >> /etc/environment;
+ echo ". /etc/environment" >> /etc/bash.bashrc;
+ echo "Ocie: Setting up system";
+ echo "Ocie: Creating container account, [ ocie ]";
+ mkdir -p ${OCIE_HOME}/conf;
+ useradd -d ${OCIE_HOME} -r -s /bin/bash ocie;
+ install -d -m 0775 -o ocie -g ocie ${OCIE_HOME};
+ # Install base packages, timezone
+ ocie --pkg "-base -upgrade" --timezone "-set ${TZ}" --clean "-base" --print;
+ echo "Ocie: System setup complete";
+EOD
+
+CMD ["/bin/bash"]
diff --git a/Environment.md b/Environment.md
new file mode 100644
index 0000000..9035426
--- /dev/null
+++ b/Environment.md
@@ -0,0 +1,703 @@
+```json
+{
+ "CA_AUTO_UPDATE": {
+ "type": "boolean",
+ "default": 0,
+ "description": "Auto update CA Certs",
+ "containers": "all",
+ "usage": {
+ "cacerts": {
+ "required": true
+ }
+ }
+ },
+ "CA_UPDATE_JVM": {
+ "type": "boolean",
+ "default": 0,
+ "description": "Update the JVM",
+ "containers": "all",
+ "usage": {
+ "cacerts": {
+ "required": true
+ }
+ }
+ },
+ "CERT_UPDATE_KEYS": {
+ "type": "boolean",
+ "default": 0,
+ "description": "Update server cert/key pair and DHE Params",
+ "containers": "all",
+ "usage": {
+ "keys": {
+ "required": true
+ }
+ }
+ },
+ "CA_UPDATE_OS": {
+ "type": "boolean",
+ "default": 1,
+ "description": "Update the OS Store",
+ "containers": "all",
+ "usage": {
+ "cacerts": {
+ "required": true
+ }
+ }
+ },
+ "DH_PARAM_SIZE": {
+ "type": "integer",
+ "default": 2048,
+ "description": "DH Size to generate",
+ "containers": "all",
+ "usage": {
+ "dhparams": {
+ "required": true
+ }
+ }
+ },
+ "OCIE_TYPES": {
+ "type": "path:multi",
+ "default": "${OCIE_LIB}/types",
+ "description": "Path to definition type",
+ "containers": "all",
+ "usage": {
+ "ociectl": {
+ "required": true
+ }
+ }
+ },
+ "CA_PATH": {
+ "type": "path:single",
+ "default": "",
+ "description": "Path to where CA Certs are, must have .crt extension",
+ "containers": "all",
+ "usage": {
+ "cacerts": {
+ "required": true
+ }
+ }
+ },
+ "CERT_PATH": {
+ "type": "path:single",
+ "default": "/etc/ssl",
+ "description": "Path to where keypair should be store",
+ "containers": "all",
+ "usage": {
+ "keys": {
+ "required": false
+ }
+ }
+ },
+ "CA_FILTER": {
+ "type": "string",
+ "default": "*_CA.crt",
+ "description": "Filter to apply onto CA_PATH",
+ "containers": "all",
+ "usage": {
+ "cacerts": {
+ "required": true
+ }
+ }
+ },
+ "CERT_SUBJECT": {
+ "type": "string",
+ "default": "localhost",
+ "description": "Subject of certificate",
+ "containers": "all",
+ "usage": {
+ "keys": {
+ "required": false
+ }
+ }
+ },
+ "OCIE_BIN": {
+ "type": "system",
+ "default": "/usr/sbin",
+ "description": "Ocie Bin Files",
+ "containers": "all",
+ "usage": {
+ "self": {
+ "required": true
+ },
+ "children": {
+ "required": true
+ }
+ }
+ },
+ "OCIE_HOME": {
+ "type": "system",
+ "default": "/etc/ocie",
+ "description": "Ocie Home",
+ "containers": "all",
+ "usage": {
+ "self": {
+ "required": true
+ },
+ "children": {
+ "required": true
+ }
+ }
+ },
+ "OCIE_LIB": {
+ "type": "system",
+ "default": "/usr/lib/ocie",
+ "description": "Path to Ocie Scripts",
+ "containers": "all",
+ "usage": {
+ "self": {
+ "required": true
+ },
+ "children": {
+ "required": true
+ }
+ }
+ },
+ "OS_BASE": {
+ "type": "system",
+ "default": "${OS_BASE}",
+ "description": "Image version e.g 22.04",
+ "containers": "all",
+ "usage": {
+ "self": {
+ "required": true
+ },
+ "children": {
+ "required": false
+ }
+ }
+ },
+ "OS_CODENAME": {
+ "type": "system",
+ "default": "${OS_CODENAME}",
+ "description": "Codename of image e.g 'jammy'",
+ "containers": "all",
+ "usage": {
+ "self": {
+ "required": true
+ },
+ "children": {
+ "required": true
+ }
+ }
+ },
+ "OS_IMAGE": {
+ "type": "system",
+ "default": "${OS_IMAGE}",
+ "description": "Image FQDN e.g ubuntu:22.04",
+ "containers": "all",
+ "usage": {
+ "self": {
+ "required": true
+ },
+ "children": {
+ "required": false
+ }
+ }
+ },
+ "OS_TIMEZONE": {
+ "type": "system",
+ "default": "${OS_TIMEZONE}",
+ "description": "System Timezone",
+ "containers": "all",
+ "usage": {
+ "self": {
+ "required": true
+ },
+ "children": {
+ "required": false
+ }
+ }
+ },
+ "OS_VERSION": {
+ "type": "system",
+ "default": "${OS_VERSION}",
+ "description": "Version without dot notation e.g 2204",
+ "containers": "all",
+ "usage": {
+ "self": {
+ "required": true
+ },
+ "children": {
+ "required": true
+ }
+ }
+ },
+ "APP_UPDATE_AUTO": {
+ "type": "boolean",
+ "default": 1,
+ "description": "Auto update app from APP_UPDATE_PATH",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "APP_UPDATE_FAIL": {
+ "type": "boolean",
+ "default": 0,
+ "description": "If app cannot update, should we fail to start",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "ENABLE_CORS": {
+ "type": "boolean",
+ "default": 0,
+ "description": "Enable CORS Headers",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "ENABLE_XFRAME": {
+ "type": "boolean",
+ "default": 0,
+ "description": "Enable Xframe Headers",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "REWRITE_CORS": {
+ "type": "boolean",
+ "default": 0,
+ "description": "Rewrite cors headers",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "REWRITE_DEFAULT": {
+ "type": "boolean",
+ "default": 0,
+ "description": "Use default rules, http to https",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "REWRITE_SKIP": {
+ "type": "boolean",
+ "default": 1,
+ "description": "Skip rewrite rules",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "APACHE_CONF": {
+ "type": "path:single",
+ "default": "/etc/apache2/conf-include",
+ "description": "Include additional config files",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "APACHE_LOG": {
+ "type": "path:single",
+ "default": "/var/log/apache2",
+ "description": "Path where apache should write logs",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "APACHE_MODS": {
+ "type": "path:single",
+ "default": "/etc/apache2/mods-include",
+ "description": "Include additional mod files",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "APACHE_SITES": {
+ "type": "path:single",
+ "default": "/etc/apache2/sites-enabled",
+ "description": "Path to site definitions",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "APP_CACHE": {
+ "type": "path:single",
+ "default": "/var/cache",
+ "description": "Path to store cache",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "APP_DATA": {
+ "type": "path:single",
+ "default": "/var/www/data",
+ "description": "Path where the app should write data",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "APP_UPDATE_PATH": {
+ "type": "path:single",
+ "default": "",
+ "description": "Path to where app updates are stored",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "APP_GROUP": {
+ "type": "string",
+ "default": "www-data",
+ "description": "Owner, uid",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "APP_NAME": {
+ "type": "string",
+ "default": "",
+ "description": "App name",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": true
+ },
+ "ociectl": {
+ "required": true
+ }
+ }
+ },
+ "APP_OWNER": {
+ "type": "string",
+ "default": "www-data",
+ "description": "Group, gid",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": true
+ },
+ "ociectl": {
+ "required": true
+ }
+ }
+ },
+ "APP_TYPE": {
+ "type": "string",
+ "default": "apache2",
+ "description": "Ocie app type definition",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": true
+ },
+ "ociectl": {
+ "required": true
+ }
+ }
+ },
+ "REWRITE_EXCLUDE": {
+ "type": "string",
+ "default": "",
+ "description": "Exclude from rewrite rules, regex/pattern",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "REWRITE_EXT": {
+ "type": "string",
+ "default": "",
+ "description": "Rewrite file extensions",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "REWRITE_INDEX": {
+ "type": "string",
+ "default": "",
+ "description": "Set framework rewrite e.g index.php",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "VADC_IP_ADDRESS": {
+ "type": "string",
+ "default": "10.0.0.0/8 172.16.0.0/12 192.168.0.0/16",
+ "description": "Use address rules, http to https",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "VADC_IP_HEADER": {
+ "type": "string",
+ "default": "X-Forwarded-For",
+ "description": "Path va vadc ip hea",
+ "containers": "apache2:firefly:walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "CATALINA_HOME": {
+ "type": "path:single",
+ "default": "/opt/tomcat",
+ "description": "Path to tomcat base",
+ "containers": "firefly",
+ "usage": {
+ "build-arg": {
+ "required": true
+ },
+ "ociectl": {
+ "required": true
+ }
+ }
+ },
+ "JAVA_HOME": {
+ "type": "path:single",
+ "default": "/opt/java",
+ "description": "Path to java base",
+ "containers": "firefly",
+ "usage": {
+ "build-arg": {
+ "required": true
+ },
+ "ociectl": {
+ "required": true
+ }
+ }
+ },
+ "APP_PARAMS": {
+ "type": "string",
+ "default": "",
+ "description": "Additional params to pass",
+ "containers": "firefly",
+ "usage": {
+ "ociectl": {
+ "required": true
+ }
+ }
+ },
+ "LD_LIBRARY_PATH": {
+ "type": "system",
+ "default": "${LD_LIBRARY_PATH:+$LD_LIBRARY_PATH:}$TOMCAT_NATIVE_LIBDIR",
+ "description": "Path to tomcat native lib",
+ "containers": "firefly",
+ "usage": {
+ "build-arg": {
+ "required": true
+ }
+ }
+ },
+ "TOMCAT_NATIVE_LIBDIR": {
+ "type": "system",
+ "default": "${CATALINA_HOME}/native-jni-lib",
+ "description": "Path to tomcat native lib",
+ "containers": "firefly",
+ "usage": {
+ "build-arg": {
+ "required": true
+ }
+ }
+ },
+ "TOMCAT_VERSION": {
+ "type": "system",
+ "default": "${TOMCAT_VERSION}",
+ "description": "Tomcat Version",
+ "containers": "firefly",
+ "usage": {
+ "build-arg": {
+ "required": true
+ }
+ }
+ },
+ "INTERNAL_DOMAIN": {
+ "type": "string",
+ "default": "",
+ "description": "Internal domain e.g example.local to be replaced in mail header",
+ "containers": "mantis",
+ "usage": {
+ "ociectl": {
+ "required": true
+ }
+ }
+ },
+ "MAIL_DOMAIN": {
+ "type": "string",
+ "default": "",
+ "description": "Domain e.g example.com",
+ "containers": "mantis",
+ "usage": {
+ "ociectl": {
+ "required": true
+ }
+ }
+ },
+ "RELAY_CLIENTS": {
+ "type": "string",
+ "default": "127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128",
+ "description": "Space seperated list of ip address allowed to relay",
+ "containers": "mantis",
+ "usage": {
+ "ociectl": {
+ "required": true
+ }
+ }
+ },
+ "RELAY_HOST": {
+ "type": "string",
+ "default": "",
+ "description": "The host where postfix should relay through e.g smtp.gmail.com",
+ "containers": "mantis",
+ "usage": {
+ "ociectl": {
+ "required": true
+ }
+ }
+ },
+ "PHP_MAX_EXECUTION_TIME": {
+ "type": "integer",
+ "default": 60,
+ "description": "PHP Max Execution time",
+ "containers": "walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "PHP_MAX_INPUT_TIME": {
+ "type": "integer",
+ "default": 60,
+ "description": "PHP Max Input time",
+ "containers": "walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "PHP_ERROR_LOG": {
+ "type": "string",
+ "default": "${APACHE_LOG}/php_error.log",
+ "description": "PHP Error log file",
+ "containers": "walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "PHP_MEMORY_LIMIT": {
+ "type": "string",
+ "default": "128M",
+ "description": "PHP Memory limit",
+ "containers": "walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "PHP_POST_MAX_SIZE": {
+ "type": "string",
+ "default": "8M",
+ "description": "PHP Post Max size",
+ "containers": "walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "PHP_TIMEZONE": {
+ "type": "string",
+ "default": "${OS_TIMEZONE}",
+ "description": "PHP Timezone",
+ "containers": "walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "PHP_UPLOAD_MAX_FILESIZE": {
+ "type": "string",
+ "default": "8M",
+ "description": "PHP Upload Max filesize",
+ "containers": "walrus",
+ "usage": {
+ "config": {
+ "required": false
+ }
+ }
+ },
+ "PHP_VERSION": {
+ "type": "string",
+ "default": "${PHP_VERSION}",
+ "description": "PHP Version",
+ "containers": "walrus",
+ "usage": {
+ "build-arg": {
+ "required": true
+ }
+ }
+ },
+ "SQL_VERSION": {
+ "type": "string",
+ "default": "${SQL_VERSION}",
+ "description": "SQL Driver Version",
+ "containers": "walrus",
+ "usage": {
+ "build-arg": {
+ "required": true
+ }
+ }
+ }
+}
+```
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..f288702
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bbb3236
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+#### Docker Ocie Image
+Base image we use for our containers
+
+Note: no support provided, released on github for automated builds and registry publishing :D
+
+#### Includes:
+'ocie' - makes it simple to setup a container without a ton of lines in a Dockerfile
+'ociectl' - run/start/stop/reload the application without having to write entrypoint scripts, a standardized entrpoint for all your containers, e.g
+````
+ENTRYPOINT ["/usr/sbin/ociectl", "run"]
+````
+Info:
+[https://github.com/bshp/ocie/tree/main/src](https://github.com/bshp/ocie/tree/main/src)
+
+#### Base OS:
+Ubuntu Server LTS
+
+#### Packages:
+Updated weekly from the official upstream Ubuntu LTS image, OS and Packages
+
+Ocie keeps an updated package manifest in json format, under ``/etc/ocie/package_manifest.json``
+
+````
+ca-certificates
+curl
+gnupg
+jq
+openssl
+tzdata
+unzip
+wget
+zip
+````
+
+#### Tags
+[Docker Hub](https://hub.docker.com/r/bshp/ocie/tags)
+
+#### Build Args
+OS_VERSION: - https://hub.docker.com/_/ubuntu/tags
+TZ: - https://manpages.ubuntu.com/manpages/man3/DateTime::TimeZone::Catalog.3pm.html
+
+#### Required Args
+````
+--build-arg OS_VERSION
+````
+#### Build
+Always use --pull so that it gets updated
+````
+docker build . --pull --build-arg OS_VERSION=22.04 --tag YOUR_TAG --no-cache
+````
diff --git a/src/usr/lib/ocie/cacerts b/src/usr/lib/ocie/cacerts
new file mode 100644
index 0000000..aa03875
--- /dev/null
+++ b/src/usr/lib/ocie/cacerts
@@ -0,0 +1,127 @@
+#!/bin/bash
+
+IMPORT_AUTO="${CA_AUTO_UPDATE:-1}";
+IMPORT_OS="${CA_UPDATE_OS:-0}";
+IMPORT_JVM="${CA_UPDATE_JVM:-0}";
+IMPORT_PATH="";
+IMPORT_FILTER="*_CA.crt";
+CA_PATH="${IMPORT_PATH:-${CA_PATH}}";
+CA_FILTER="${IMPORT_FILTER:-${CA_FILTER}}";
+PATH_TYPE="${CA_PATH%%:*}";
+CA_PATH="${CA_PATH#*:}";
+JAVA_HOME="${JAVA_HOME:-}";
+
+function show_help()
+{
+ echo "Update CA Certificate Stores"
+ echo
+ echo "Syntax: cacerts --os --jvm --path 'https://certs.example.com/'";
+ echo " If neither of --os, --jvm are defined, importer will attempt both."
+ echo
+ echo "Required:"
+ echo " --path Path to import CA Certs from, prefixed with either [ url: | file:file ],";
+ echo " e.g file:/opt/certs OR url:https://certs.example.com";
+ echo
+ echo "Optional:";
+ echo " --os Import into operating system store, /etc/ssl";
+ echo " --jvm Import into java store, cacerts";
+ echo " --filter Filter to find CA cert files by, default: *_CA.crt";
+}
+function auto_update()
+{
+ update_os;
+ update_jvm;
+}
+
+function update_jvm()
+{
+ if [[ "${JAVA_HOME}" != "" ]];then
+ for CA_CRT in /usr/local/share/ca-certificates/*.crt; do
+ CA_NAME=$(openssl x509 -noout -subject -nameopt multiline -in $CA_CRT | sed -n 's/ *commonName *= //p');
+ CA_EXISTS=$(${JAVA_HOME}/bin/keytool -list -cacerts -storepass changeit -alias "$CA_NAME" | echo $?);
+ if [ "$CA_EXISTS" -eq 0 ];then
+ ${JAVA_HOME}/bin/keytool -import -trustcacerts -cacerts \
+ -storepass changeit -noprompt -alias "$CA_NAME" -file $CA_CRT >/dev/null 2>&1 \
+ | echo "Ocie: CA Import: Added certificate to cacert, $CA_CRT";
+ else
+ echo "Ocie: CA Import: Certificate ${CA_NAME} already exists, not adding";
+ fi;
+ done;
+ else
+ echo "Ocie: CA Import: JAVA_HOME is undefined in environment, nothing to import";
+ fi;
+}
+
+function update_os()
+{
+ certs=$(ls /usr/local/share/ca-certificates/*.crt 2> /dev/null | wc -l);
+ if [ "${certs}" -ne 0 ];then
+ update-ca-certificates;
+ else
+ echo "Ocie: CA Import: No certificates were found to import";
+ fi;
+}
+
+function get_certs()
+{
+ cd /usr/local/share/ca-certificates;
+ if [[ "${PATH_TYPE}" == "url" ]];then
+ wget -q -r -nH -A ${CA_FILTER} "${CA_PATH}";
+ else
+ if [ -d "${CA_PATH}" ];then
+ cp -R ${CA_PATH}/${CA_FILTER} /usr/local/share/ca-certificates/;
+ else
+ echo "Ocie: CA Import: Unable to read ${CA_PATH} or it is not a valid directory";
+ fi;
+ fi;
+}
+
+function cleanup()
+{
+ cd /usr/local/share/ca-certificates;
+ rm -rf /usr/local/share/ca-certificates/*;
+}
+
+for cmds in "$@";do
+ shift;
+ case "$cmds" in
+ '--help')
+ show_help;;
+ '--os')
+ IMPORT_OS=1;;
+ '--jvm')
+ IMPORT_JVM=1;;
+ '--path')
+ IMPORT_PATH="$1";;
+ '--filter')
+ IMPORT_FILTER="$1";;
+ *);;
+ esac;
+done;
+
+#Run
+if [[ ${CA_PATH} != "" ]];then
+ if [[ ! "${PATH_TYPE}" == "file" ]] && [[ ! "${PATH_TYPE}" == "url" ]];then
+ echo "Ocie: CA Import: Unable to determine CA_PATH type, ${PATH_TYPE}, only file: or url: are valid";
+ else
+ echo "Ocie: CA Import: Starting";
+ get_certs;
+ if [[ ${IMPORT_AUTO} == 1 ]];then
+ echo "Ocie: CA Import: Auto Update is enabled";
+ auto_update;
+ else
+ if [[ ${IMPORT_OS} == 1 ]];then
+ echo "Ocie: CA Import: Updating OS CA Store";
+ update_os;
+ fi;
+ if [[ ${IMPORT_JVM} == 1 ]];then
+ echo "Ocie: CA Import: Updating JVM CA Store";
+ update_jvm;
+ fi;
+ fi;
+ cleanup;
+ echo "Ocie: CA Import: Finished";
+ fi;
+else
+ echo "Ocie: CA Import: --path | env CA_PATH is not defined, nothing to do";
+fi;
diff --git a/src/usr/lib/ocie/clean b/src/usr/lib/ocie/clean
new file mode 100644
index 0000000..703a75d
--- /dev/null
+++ b/src/usr/lib/ocie/clean
@@ -0,0 +1,87 @@
+#!/bin/bash
+
+FIND_BASE=0;
+FIND_PATH="";
+FIND_PATTERN="";
+RM_DIRS="";
+RM_MULTI="";
+WHAT_IF=0;
+
+function show_help()
+{
+ echo "Cleanup files from base setup";
+ echo
+ echo "Syntax: clean -base -path '/var/log' -pattern '*.log'";
+ echo
+ echo "Options:";
+ echo " --base Cleanup image, default: false";
+ echo " --path Path to search, default: /var/log";
+ echo " --pattern Comma seperated list of patterns to search, default: '*.log*,*.log.xz'";
+ echo " --dirs Comma seperated list of directories to forcefully delete";
+ echo " --multi Comma seperated list, colon delimited, formatted with '/path/to/search:pattern_to_use1,/path/to/search2:pattern_to_use2'";
+ echo " --whatif Don't actually delete anything, just show a what if scenario";
+}
+
+function deleteAny()
+{
+ for i in ${FIND_PATTERN//,/ };do
+ echo "Ocie: Removing any, directory or file in: $FIND_PATH, matching pattern: $i";
+ find "$FIND_PATH" -name "$i" -exec /bin/rm {} \;
+ done;
+}
+
+function deleteFiles()
+{
+ for i in ${FIND_PATTERN//,/ };do
+ echo "Ocie: Removing files in: $FIND_PATH, matching pattern: $i";
+ find "$FIND_PATH" -type f -name "$i" -exec /bin/rm {} \;
+ done;
+}
+
+for cmds in "$@";do
+ shift
+ case "$cmds" in
+ '--help')
+ show_help;;
+ '--base')
+ FIND_BASE=1;;
+ '--path')
+ FIND_PATH="$1";;
+ '--pattern')
+ FIND_PATTERN=$(echo "$1" | tr -d ' ');;
+ '--dirs')
+ RM_DIRS=$(echo "$1" | tr -d ' ');;
+ '--multi')
+ RM_MULTI=$(echo "$1" | tr -d ' ');;
+ '--whatif')
+ WHAT_IF=1;;
+ *);;
+ esac;
+done;
+
+if [[ $FIND_BASE == 1 ]];then
+ echo "Ocie: Removing files in: /var/log/*.log*, /var/lib/apt/lists/*";
+ rm -rf /var/lib/apt/lists/*;
+ rm -rf /var/log/*.log*;
+fi;
+
+if [[ ! -z "$FIND_PATH" ]];then
+ deleteFiles "$FIND_PATH" "$FIND_PATTERN";
+fi;
+
+# Remove directories, recursive, eeeek..
+if [[ ! -z "${RM_DIRS}" ]];then
+ for d in ${RM_DIRS//,/ };do
+ echo "Ocie: Removing directory: $d";
+ rm -rf "$d";
+ done;
+fi;
+
+if [[ ! -z "${RM_MULTI}" ]];then
+ if [[ "${RM_MULTI}" == *":"* ]];then
+ for m in ${RM_MULTI//,/ };do
+ MULTI=${m//:/ };
+ deleteFiles ${m//:/ };
+ done;
+ fi;
+fi;
diff --git a/src/usr/lib/ocie/config b/src/usr/lib/ocie/config
new file mode 100644
index 0000000..9e84ce2
--- /dev/null
+++ b/src/usr/lib/ocie/config
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+echo "Ocie Config: Imaging using outdated configurator";
diff --git a/src/usr/lib/ocie/dhparams b/src/usr/lib/ocie/dhparams
new file mode 100644
index 0000000..ee59de2
--- /dev/null
+++ b/src/usr/lib/ocie/dhparams
@@ -0,0 +1,45 @@
+#!/bin/bash
+
+DH_SIZE=2048;
+DH_NAME=dhparams.pem;
+DH_PATH=/etc/ssl;
+OPENSSL_BIN=$(openssl version 2>&1 | grep -i -o 'Library: OpenSSL');
+
+if [[ -z "${OPENSSL_BIN}" ]];then
+ echo "Ocie: Unable to generate dhparams, openssl not found";
+ exit;
+fi;
+
+function show_help()
+{
+ echo "Creates new dhparams, writes to /etc/ssl/dhparams.pem"
+ echo
+ echo "Syntax: dhparams -size 2048";
+ echo
+ echo "Requires: The enviroment variable name";
+ echo
+ echo "Options:";
+ echo " --size The size for dharam, default: 2048";
+ echo " --name The name of the file to write, include the extension if needed, default: dhparams.pem";
+ echo " --path Path to write dhparams to, default: /etc/ssl/";
+ exit 0;
+}
+
+for cmds in "$@";do
+ shift;
+ case "$cmds" in
+ '--help')
+ show_help;;
+ '--size')
+ DH_SIZE="$1";;
+ '--name')
+ DH_NAME="$1";;
+ '--path')
+ DH_PATH="$1";;
+ *);;
+ esac;
+done;
+
+echo "Ocie: Generating new DHE Params";
+openssl dhparam -out ${DH_PATH}/${DH_NAME} ${DH_SIZE} &>/dev/null
+echo "Ocie: Finished generating new DHE params: file:${DH_PATH}/${DH_NAME}";
diff --git a/src/usr/lib/ocie/include/config/apache b/src/usr/lib/ocie/include/config/apache
new file mode 100644
index 0000000..3ecf941
--- /dev/null
+++ b/src/usr/lib/ocie/include/config/apache
@@ -0,0 +1,113 @@
+#!/bin/bash
+
+function add_default()
+{
+ cp "${APACHE_MODS}/rewrite_default.conf.dist" "${APACHE_MODS}/rewrite.conf";
+}
+
+function add_framework()
+{
+ cp "${APACHE_MODS}/rewrite_framework.conf.dist" "${APACHE_MODS}/rewrite.conf";
+ sed -i "s/#FRAMEWORK/${REWRITE_INDEX}/g" "${APACHE_MODS}/rewrite.conf";
+}
+
+function add_exclude()
+{
+ sed -i "s@#REWRITE_EXCLUDE@$(printf %q " RewriteRule ${REWRITE_EXCLUDE} - [L]")@g" "${APACHE_MODS}/rewrite.conf";
+}
+
+function add_extension()
+{
+ cp "${APACHE_MODS}/rewrite_extensions.conf.dist" "${APACHE_MODS}/rewrite.conf";
+ sed -i "s/#EXTENSION/${REWRITE_EXT}/g" "${APACHE_MODS}/rewrite.conf";
+}
+
+function add_cors()
+{
+ cp "${APACHE_MODS}/headers_cors_json.conf.dist" "${APACHE_MODS}/headers.conf";
+}
+
+function reset_config()
+{
+ SITE_TEMPLATE=/etc/apache2/sites-available;
+
+ if [[ -f "${APACHE_MODS}/rewrite.conf" ]];then
+ mv -f "${APACHE_MODS}/rewrite.conf" ./rewrite.conf.previous;
+ fi;
+ if [[ -f "${APACHE_MODS}/headers.conf" ]];then
+ mv -f "${APACHE_MODS}/headers.conf" ./headers.conf.previous;
+ fi;
+ if [[ -f "${APACHE_MODS}/jk.conf" ]];then
+ mv -f "${APACHE_MODS}/jk.conf" ./jk.conf.previous;
+ fi;
+ if [[ -f "${APACHE_MODS}/jk.load" ]];then
+ mv -f "${APACHE_MODS}/jk.load" ./jk.load.previous;
+ fi;
+ if [[ -f "${APACHE_SITES}/000-default.conf" ]];then
+ mv -f "${APACHE_SITES}/000-default.conf" ./000-default.conf.previous;
+ cp -f "${SITE_TEMPLATE}/000-default.conf.dist" "${APACHE_SITES}/000-default.conf";
+ fi;
+ if [[ -f "${APACHE_SITES}/default-ssl.conf" ]];then
+ mv -f "${APACHE_SITES}/default-ssl.conf" ./default-ssl.conf.previous;
+ cp -f "${SITE_TEMPLATE}/default-ssl.conf.dist" "${APACHE_SITES}/default-ssl.conf";
+ fi;
+}
+
+#Run
+export APP_RUNAS="www-data";
+
+if [[ -f "${OCIE_HOME}/conf/ocie-apache.init" ]];then
+ reset_config;
+fi;
+
+if [[ "${REWRITE_SKIP}" == 1 ]];then
+ echo "Ocie Config: Using default site without rewrite, [ REWRITE_SKIP ] is defined";
+else
+ #Enable Rewrite Engine
+ sed -i "s/#REWRITE/RewriteEngine On/g" "${APACHE_SITES}/000-default.conf";
+ sed -i "s/#REWRITE/RewriteEngine On/g" "${APACHE_SITES}/default-ssl.conf";
+
+ if [[ "${REWRITE_DEFAULT}" == 1 ]];then
+ echo "Ocie Config: Rewriting all requests to: [ https ]";
+ add_default;
+ fi;
+ if [[ "${REWRITE_INDEX}" != "" ]];then
+ echo "Ocie Config: Rewriting all requests to: [ ${REWRITE_INDEX} ]";
+ add_framework;
+ fi;
+ if [[ "${REWRITE_CORS}" == 1 ]];then
+ echo "Ocie Config: Adding CORS config for JSON to enabled site";
+ add_cors;
+ fi;
+ if [[ "${REWRITE_EXT}" != "" ]];then
+ if [[ "${REWRITE_INDEX}" != "" ]];then
+ echo "Ocie Config: Cannot configure both [ REWRITE_INDEX ] and [ REWRITE_EXT ], using [ REWRITE_INDEX ], value ${REWRITE_INDEX}";
+ else
+ echo "Ocie Config: Rewriting all requests with the following extensions: [ ${REWRITE_EXT} ]";
+ add_extension;
+ fi;
+ fi;
+ if [[ "${REWRITE_EXCLUDE}" != "" ]];then
+ echo "Ocie Config: Ecluding the following pattern from rewrite: [ ${REWRITE_EXCLUDE} ]";
+ add_exclude;
+ fi;
+fi;
+
+# Test config and print results
+echo "Ocie Config: Data directory for application is ${APP_DATA}";
+HTTPD_CFG=$(ociectl --test);
+if [[ ! -z "${HTTPD_CFG}" ]];then
+ echo "Ocie Config: Test FAILED, reverting changes";
+ echo "Ocie Config: Result: ${HTTPD_CFG}";
+ reset_config;
+ exit 1;
+fi;
+
+# Tomcat sources this config, only print if apache
+if [[ ! "${APP_TYPE}" == "tomcat" ]];then
+ echo "#Apache Initialized" > ${OCIE_HOME}/conf/ocie-apache.init;
+ echo "Ocie Config: Apache Config Test PASSED, using updated configuration";
+ echo "Ocie Config: Apache2 remoteip configured with [address: ${VADC_IP_ADDRESS}, header: ${VADC_IP_HEADER}]";
+ echo "Ocie Config: Initialization complete"
+ echo "Ocie Config: You can run the app as [ ${APP_RUNAS} ] OR risk it for the biscuit and run as root";
+fi;
diff --git a/src/usr/lib/ocie/include/config/tomcat b/src/usr/lib/ocie/include/config/tomcat
new file mode 100644
index 0000000..526b0fc
--- /dev/null
+++ b/src/usr/lib/ocie/include/config/tomcat
@@ -0,0 +1,30 @@
+#!/bin/bash
+
+# Tomcat specific
+if [[ -f "${OCIE_HOME}/conf/ocie-tomcat.init" ]];then
+ reset_config;
+fi;
+
+APP_RUNAS="tomcat";
+IP_REGEX="${VADC_IP_ADDRESS// /|}";
+APP_PROXIES="${IP_REGEX//./\\.}";
+APP_OPTS=$(echo 'export JAVA_OPTS="'$JAVA_OPTS $APP_PARAMS'"');
+echo ${APP_OPTS} > ${CATALINA_HOME}/bin/setenv.sh;
+echo "export VADC_IP_REG=${APP_PROXIES}" >> ${CATALINA_HOME}/bin/setenv.sh;
+chmod -R 0755 "${CATALINA_HOME}/bin/setenv.sh";
+cp "${APACHE_MODS}/jk.conf.dist" "${APACHE_MODS}/jk.conf";
+cp "${APACHE_MODS}/jk.load.dist" "${APACHE_MODS}/jk.load";
+CATALINA_CFG=$(ociectl --test);
+if [[ ! -z "${CATALINA_CFG}" ]];then
+ echo "Ocie Config: Tomcat config test FAILED, reverting changes";
+ echo "Ocie Config: Result: ${CATALINA_CFG}";
+ reset_config;
+ exit 1;
+fi;
+export APP_RUNAS="${APP_RUNAS}";
+echo "#Tomcat Initialized" > ${OCIE_HOME}/conf/ocie-tomcat.init;
+echo "Ocie Config: Tomcat Config Test PASSED, using updated configuration";
+echo "Ocie Config: Tomcat RemoteIpValve configured with [internalProxies: ${APP_PROXIES}, remoteIpHeader: ${VADC_IP_HEADER}]";
+echo "Ocie Config: Configured JAVA_OPTS with ${APP_OPTS}";
+echo "Ocie Config: Initialization complete";
+echo "Ocie Config: You can run the app as [ ${APP_RUNAS} ] OR risk it for the biscuit and run as root";
diff --git a/src/usr/lib/ocie/keys b/src/usr/lib/ocie/keys
new file mode 100644
index 0000000..7fec2c2
--- /dev/null
+++ b/src/usr/lib/ocie/keys
@@ -0,0 +1,75 @@
+#!/bin/bash
+
+RSA_SIZE=2048;
+RSA_NAME=server;
+RSA_PATH=/etc/ssl;
+RSA_CN=localhost;
+RSA_VALID=3650;
+RSA_TAG=0;
+OPENSSL_BIN=$(openssl version 2>&1 | grep -i -o 'Library: OpenSSL');
+
+if [[ -z "${OPENSSL_BIN}" ]];then
+ echo "Ocie: Unable to generate new keys, openssl not found";
+ exit;
+fi;
+
+function show_help()
+{
+ echo "Creates new ssl private key and public certificate"
+ echo
+ echo "Syntax: keys --size 2048";
+ echo
+ echo "Options:";
+ echo " --size The size for rsa, default: 2048";
+ echo " --name The name of the key/cert, .key/.pem will be added, default: server";
+ echo " --path Path to write to, default: /etc/ssl/";
+ echo " --subject Common Name/Subject for certificate, default: localhost";
+ echo " --valid Validity length in days, default: 3650";
+ echo " --tag Create a flag file identifier, create in same directory as --path";
+}
+
+function get_signature()
+{
+ CERT=$1;
+ TYPE='sha1,sha256';
+ #if [[ ! -z "$2" ]];then
+ # if [[ ! "$2" == "sha1" ]] && [[ ! "$2" == "sha256" ]];then
+ # echo "Ocie: Invalid signature type, use one of [ sha1 | sha256 ], both will be generated";
+ # else
+ # TYPE="$2"
+ # fi;
+ #fi;
+ TYPE=$(echo "${TYPE,,}" | tr -d ' ');
+ for SIG in ${TYPE//,/ };do
+ echo "Ocie: ${SIG^^} Thumbprint:$(openssl x509 -noout -fingerprint -${SIG} -in ${CERT} | cut -f2 -d'=' | sed 's/://g' | awk '{print tolower($0)}')";
+ done;
+}
+
+for cmds in "$@";do
+ shift;
+ case "$cmds" in
+ '--help')
+ show_help;;
+ '--size')
+ RSA_SIZE="$1";;
+ '--name')
+ RSA_NAME="$1";;
+ '--path')
+ RSA_PATH="$1";;
+ '--subject')
+ RSA_CN="$1";;
+ '--valid')
+ RSA_VALID="$1";;
+ '--tag')
+ RSA_TAG="$1";;
+ *);;
+ esac;
+done;
+
+echo "Ocie: Generating new key pair";
+openssl req -newkey rsa:${RSA_SIZE} -x509 -nodes -keyout ${RSA_PATH}/${RSA_NAME}.key -new -out ${RSA_PATH}/${RSA_NAME}.pem -subj /CN=${RSA_CN} -sha256 -days ${RSA_VALID} &>/dev/null;
+if [[ ! "${RSA_TAG}" == 0 ]];then
+ touch ${RSA_PATH}/${RSA_TAG};
+fi;
+echo "Ocie: Keygen finished";
+get_signature "${RSA_PATH}/${RSA_NAME}.pem"
diff --git a/src/usr/lib/ocie/pkg b/src/usr/lib/ocie/pkg
new file mode 100644
index 0000000..3a743f4
--- /dev/null
+++ b/src/usr/lib/ocie/pkg
@@ -0,0 +1,109 @@
+#!/bin/bash
+
+BASE_PKG=('ca-certificates' 'curl' 'gnupg' 'jq' 'openssl' 'tzdata' 'unzip' 'wget' 'zip');
+BASE_INSTALL=0;
+ADD_PKG='';
+REMOVE_PKG='';
+PKG_LIST='';
+PKG_PRINT=0;
+PKG_UPGRADE=0;
+
+# Runners
+function show_help()
+{
+ echo "Ocie Package Manager";
+ echo
+ echo "Default packages:"
+ echo "${DEFAULT_PKG[*]}";
+ echo
+ echo "Syntax: pkg --add 'apache2, tomcat' --remove 'unzip, wget' --print";
+ echo
+ echo "Options:";
+ echo " --base Add base packages: ${BASE_PKG[*]}";
+ echo " --add Add packages, comma seperated list";
+ echo " --remove Remove packages, comma seperated list";
+ echo " --upgrade Upgrade packages";
+ echo " --print Print package manifest";
+}
+
+function set_manifest()
+{
+ if [[ -f /bin/jq ]];then
+ DB="$(mktemp -d)";
+ cp /var/lib/dpkg/status $DB/ >/dev/null 2>&1;
+ sed -i 's/"//g' $DB/status >/dev/null 2>&1;
+ DPKG_FORMAT='\{\"name\"\:\"${binary:Package}\"\,\"version\"\:\"${Version}\"\,\"summary\"\:\"${binary:Summary}\"\,\"maintainer\"\:\"${Maintainer}\"\}\,';
+ DPKG_LIST=$(dpkg-query -W --admindir=$DB -f=$DPKG_FORMAT);
+ PKG_INSTALLED=$(echo "["${DPKG_LIST::-1}"]");
+ echo "${PKG_INSTALLED}" | jq > "${OCIE_HOME}/package_manifest.json";
+ rm -rf "$DB" >/dev/null 2>&1;
+ fi;
+}
+
+function get_manifest()
+{
+ [[ ! -f ${OCIE_HOME}/package_manifest.json ]] && set_manifest;
+ [[ -f /bin/jq ]] && jq . ${OCIE_HOME}/package_manifest.json;
+}
+
+for cmds in "$@"; do
+ shift
+ case "$cmds" in
+ '--help')
+ show_help;;
+ '--base')
+ BASE_INSTALL=1;;
+ '--add')
+ ADD_PKG=$(echo $1 | tr -d ' ');;
+ '--remove')
+ REMOVE_PKG=$(echo $1 | tr -d ' ');;
+ '--upgrade')
+ PKG_UPGRADE=1;;
+ '--print')
+ PKG_PRINT=1;;
+ *);;
+ esac
+done
+
+# Add
+if [[ ! "$ADD_PKG" == "" ]];then
+ for i in ${ADD_PKG//,/ };do
+ BASE_PKG+=("$i");
+ done;
+fi;
+
+# Remove
+if [[ ! "$REMOVE_PKG" == "" ]];then
+ for d in ${REMOVE_PKG//,/ };do
+ if [[ ${BASE_PKG[@]} =~ $d ]];then
+ BASE_PKG=("${BASE_PKG[@]/$d}");
+ fi;
+ done;
+fi;
+
+# Add/Remove Packages
+if [[ "$BASE_INSTALL" == 1 ]] || [[ ! "$ADD_PKG" == "" ]] || [[ ! "$REMOVE_PKG" == "" ]];then
+ PKG_LIST=$(echo "${BASE_PKG[*]}");
+ echo "Ocie: Package Manager: To be installed:";
+ echo " Add: $PKG_LIST";
+ apt-get -qq update >/dev/null;
+ DEBIAN_FRONTEND=noninteractive ACCEPT_EULA=Y apt-get -qq install -y --no-install-recommends $PKG_LIST >/dev/null;
+ #apt-get -qq purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false;
+ set_manifest;
+ echo "Ocie: Package Manager: Finished";
+ echo "Ocie: Package Manager: Manifest updated, file: ${OCIE_HOME}/package_manifest.json";
+fi;
+
+if [[ "$PKG_UPGRADE" == 1 ]];then
+ echo "Ocie: Package Manager: Update starting";
+ apt-get -qq update >/dev/null;
+ DEBIAN_FRONTEND=noninteractive ACCEPT_EULA=Y apt-get upgrade -y --no-install-recommends;
+ set_manifest;
+ echo "Ocie: Package Manager: Update finished";
+ echo "Ocie: Package Manager: Manifest updated, file: ${OCIE_HOME}/package_manifest.json";
+fi;
+
+# Wants package list printed
+if [[ $PKG_PRINT == 1 ]];then
+ get_manifest;
+fi;
diff --git a/src/usr/lib/ocie/timezone b/src/usr/lib/ocie/timezone
new file mode 100644
index 0000000..d536eae
--- /dev/null
+++ b/src/usr/lib/ocie/timezone
@@ -0,0 +1,49 @@
+#!/bin/bash
+
+function show_help()
+{
+ echo "Set system timezone"
+ echo
+ echo "Syntax: timezone [ --set | --print ]";
+ echo
+ echo "Options:";
+ echo " --set A valid timezone definition from zoneinfo";
+ echo " --print Print configured timezone";
+ echo " --help Print this help info";
+}
+
+function add_zone()
+{
+ ZONES=$(echo $(awk '/^Z/ { print $2 }; /^L/ { print $3 }' /usr/share/zoneinfo/tzdata.zi) | tr ' ' ',');
+ INVALID=$(echo "$ZONES" | grep -o "$1");
+ #INVALID=$(ocie --validate "-test $ZONES -expect $1");
+ if [[ -z "$INVALID" ]];then
+ echo "Ocie: Invalid Timezone [ $1 ]";
+ echo "Ocie: Timezones available:";
+ echo "${ZONES}";
+ else
+ sed -i '/^OS_TIMEZONE\=.*$/I d' /etc/environment
+ ln -snf /usr/share/zoneinfo/$TZ /etc/localtime;
+ echo "$TZ" > /etc/timezone;
+ echo "OS_TIMEZONE=$TZ" >> /etc/environment;
+ echo "Ocie: Timezone updated to [ $1 ]";
+ fi;
+}
+
+function print_zone()
+{
+ echo $(cat /etc/environment | grep -o 'OS_TIMEZONE=.*' | cut -f2 -d'=');
+}
+
+for cmds in "$@";do
+ shift;
+ case "$cmds" in
+ '--help')
+ show_help;;
+ '--set')
+ add_zone "$1";;
+ '--print')
+ print_zone;;
+ *);;
+ esac;
+done;
diff --git a/src/usr/lib/ocie/types/README.md b/src/usr/lib/ocie/types/README.md
new file mode 100644
index 0000000..9c69242
--- /dev/null
+++ b/src/usr/lib/ocie/types/README.md
@@ -0,0 +1,46 @@
+#### Ocie Types
+To utilize ociectl, create a new config.ocie definition in your container somewhere using the functions below.
+Customize the definition however you want, then set the environment OCIE_TYPES=${OCIE_TYPES}:/etc/myapp/path_to_definition
+#### Required
+````
+#!/bin/bash
+
+function app_shutdown()
+{
+ /path/to/your/app --stop
+}
+
+function app_reload()
+{
+ /path/to/your/app --reload
+}
+
+function app_start()
+{
+ /path/to/your/app --start
+}
+````
+
+#### Optional
+````
+function app_certs()
+{
+ ${OCIE_LIB}/cacerts;
+}
+
+function app_config()
+{
+ ${OCIE_LIB}/config;
+}
+
+function app_update()
+{
+ ${OCIE_LIB}/update;
+}
+
+function app_test()
+{
+ echo $(/some/app/run checkcfg)
+}
+````
+
diff --git a/src/usr/lib/ocie/types/apache.ocie b/src/usr/lib/ocie/types/apache.ocie
new file mode 100644
index 0000000..b56feec
--- /dev/null
+++ b/src/usr/lib/ocie/types/apache.ocie
@@ -0,0 +1,27 @@
+#!/bin/bash
+
+function app_shutdown()
+{
+ /usr/sbin/apachectl -k stop;
+}
+
+function app_reload()
+{
+
+ /usr/sbin/apachectl -k graceful;
+}
+
+function app_start()
+{
+ /usr/sbin/apachectl -k start -D FOREGROUND;
+}
+
+function app_test()
+{
+ CFG_TEST=$(apachectl configtest 2>&1);
+ CFG_PASS="Syntax OK";
+ CFG_RESULT=$(echo "$CFG_TEST" | grep "$CFG_PASS");
+ if [[ -z "$CFG_RESULT" ]];then
+ echo "$CFG_RESULT";
+ fi;
+}
diff --git a/src/usr/lib/ocie/types/itsm.ocie b/src/usr/lib/ocie/types/itsm.ocie
new file mode 100644
index 0000000..38e72d0
--- /dev/null
+++ b/src/usr/lib/ocie/types/itsm.ocie
@@ -0,0 +1,39 @@
+#!/bin/bash
+
+function app_shutdown()
+{
+ su jetbrains -c "${YOUTRACK_HOME}/bin/youtrack.sh stop";
+}
+
+function app_reload()
+{
+ su jetbrains -c "${YOUTRACK_HOME}/bin/youtrack.sh restart";
+}
+
+function app_start()
+{
+ su jetbrains -c "${YOUTRACK_HOME}/bin/youtrack.sh run $@";
+}
+
+function app_certs()
+{
+ ${OCIE_LIB}/cacerts;
+}
+
+function app_config()
+{
+ CUSTOM_CSS=${YOUTRACK_HOME}/conf/custom.css;
+ STATIC_DIR=${YOUTRACK_HOME}/apps/youtrack/web/static/simplified;
+ if [[ -f "${CUSTOM_CSS}" ]];then
+ #Get generated css
+ cd ${STATIC_DIR};
+ STYLE_CSS=$(find ~+ -name 'styles.*.css');
+ STYLE_LNK=$(basename "${STYLE_CSS}");
+ cp ${STYLE_CSS} ${YOUTRACK_HOME}/conf/;
+
+ #Add custom css to styles
+ cat ${CUSTOM_CSS} >> ${YOUTRACK_HOME}/conf/${STYLE_LNK};
+ cp ${YOUTRACK_HOME}/conf/${STYLE_LNK} ${STATIC_DIR}/;
+ cd /;
+ fi;
+}
diff --git a/src/usr/lib/ocie/types/postfix.ocie b/src/usr/lib/ocie/types/postfix.ocie
new file mode 100644
index 0000000..1eeac95
--- /dev/null
+++ b/src/usr/lib/ocie/types/postfix.ocie
@@ -0,0 +1,23 @@
+#!/bin/bash
+
+function app_shutdown()
+{
+ /usr/sbin/postfix stop;
+}
+
+function app_reload()
+{
+ app_shutdown;
+ app_start;
+}
+
+function app_start()
+{
+ #Start Foreground
+ /usr/sbin/postfix -c /etc/postfix start-fg;
+}
+
+function app_test()
+{
+ echo $(/usr/sbin/postfix check)
+}
diff --git a/src/usr/lib/ocie/types/tomcat.ocie b/src/usr/lib/ocie/types/tomcat.ocie
new file mode 100644
index 0000000..04bfb28
--- /dev/null
+++ b/src/usr/lib/ocie/types/tomcat.ocie
@@ -0,0 +1,30 @@
+#!/bin/bash
+
+function app_shutdown()
+{
+ /usr/sbin/apachectl -k stop;
+ ${CATALINA_HOME}/bin/catalina.sh stop;
+}
+
+function app_reload()
+{
+ app_shutdown;
+ app_start;
+}
+
+function app_start()
+{
+ /usr/sbin/apachectl -k start;
+ su ${APP_RUNAS} -c "${CATALINA_HOME}/bin/catalina.sh run";
+}
+
+function app_test()
+{
+ TC_TEST=$(/opt/tomcat/bin/catalina.sh configtest 2>&1);
+ CFG_TEST=$(echo "$TC_TEST" | grep 'Apache Tomcat Native' | sort -u);
+ CFG_PASS='INFO: Loaded( APR based)? Apache Tomcat Native library';
+ CFG_RESULT=$(echo "$CFG_TEST" | grep -E "$CFG_PASS");
+ if [[ -z "$CFG_RESULT" ]];then
+ echo "$TC_TEST";
+ fi;
+}
diff --git a/src/usr/lib/ocie/update b/src/usr/lib/ocie/update
new file mode 100644
index 0000000..00fbd2a
--- /dev/null
+++ b/src/usr/lib/ocie/update
@@ -0,0 +1,116 @@
+#!/bin/bash
+
+function get_signature()
+{
+ option="$1";
+ object="$2";
+ if [[ -d "${object}" ]];then
+ set_metadata "${option}" "${object}";
+ echo "$(sha1sum ${APP_CACHE}/${APP_NAME}.${option}.metadata | awk '{print $1}')";
+ elif [[ -f "${object}" ]];then
+ echo "$(sha1sum ${object} | awk '{print $1}')";
+ else
+ echo "0";
+ fi;
+}
+
+function set_metadata()
+{
+ option="$1";
+ object="$2";
+ if [[ -f "${APP_CACHE}/${APP_NAME}.${option}.metadata" ]];then
+ rm "${APP_CACHE}/${APP_NAME}.${option}.metadata";
+ fi;
+ (
+ cd "${object}";
+ for i in *;do
+ sha1sum "$i";
+ done;
+ ) >> "${APP_CACHE}/${APP_NAME}.${option}.metadata";
+ cd /opt;
+}
+
+function deploy_app()
+{
+ if [[ -d "${APP_LATEST}" ]];then
+ cp -R ${APP_LATEST}/* ${APP_HOME};
+ else
+ cp -R ${APP_LATEST} ${APP_HOME};
+ fi;
+}
+
+function update_app()
+{
+ if [[ "${SIG_LOCAL}" == "${SIG_UPDATE}" ]];then
+ echo "Ocie Updater: Update is not needed, deployed: ${SIG_LOCAL}, latest: ${SIG_UPDATE}";
+ fi;
+ if [[ "${APP_UPDATE_AUTO}" == 1 ]];then
+ deploy_app;
+ fi;
+}
+
+#Run
+
+if [[ "${APP_UPDATE_PATH}" == "" ]];then
+ echo "Ocie Updater: Nothing to do";
+else
+ if [[ "${APP_TYPE}" == "" ]];then
+ echo "Ocie Updater: Required APP_TYPE is not set";
+ exit 22;
+ elif [[ "${APP_NAME}" == "" ]];then
+ echo "Ocie Updater: Required APP_NAME is not set";
+ exit 22;
+ else
+ echo "Ocie Updater: Checking if deployment or update needed";
+ fi;
+
+ echo "Ocie Updater: APP_TYPE is ${APP_TYPE}";
+
+ if [[ "${APP_TYPE}" == "apache" ]];then
+ APP_HOME="/var/www/html";
+ APP_DEPLOY="/var/www/html";
+ APP_LATEST="${APP_UPDATE_PATH}/${APP_NAME}";
+ fi;
+
+ if [[ "${APP_TYPE}" == "tomcat" ]];then
+ APP_HOME="${CATALINA_HOME}/webapps/";
+ APP_DEPLOY="${APP_HOME}${APP_NAME}.war";
+ APP_LATEST="${APP_UPDATE_PATH}/${APP_NAME}.war";
+ if [[ "${APP_DATA}" == "/var/www/html" ]];then
+ APP_DATA="/etc/${APP_NAME}";
+ echo "Ocie Updater: APP_DATA is set to /var/www, changing to ${APP_DATA}";
+ fi;
+ if [[ "${APP_OWNER}" == "www-data" ]];then
+ APP_OWNER="root";
+ echo "Ocie Updater: APP_OWNER is set to www-data, changing to ${APP_OWNER}";
+ fi;
+ if [[ "${APP_GROUP}" == "www-data" ]];then
+ APP_GROUP="tomcat";
+ echo "Ocie Updater: APP_GROUP is set to www-data, changing to ${APP_GROUP}";
+ fi;
+ fi;
+
+ if [[ ! -d "${APP_DATA}" ]]; then
+ echo "Ocie Updater: Data directory for application does not exist, creating ${APP_DATA}";
+ install -d -m 0770 -o ${APP_OWNER} -g ${APP_GROUP} ${APP_DATA};
+ fi
+
+ SIG_LOCAL=$(get_signature "local" "${APP_DEPLOY}");
+ SIG_UPDATE=$(get_signature "update" "${APP_LATEST}");
+
+ if [[ "${SIG_LOCAL}" == "0" ]] && [[ "${SIG_UPDATE}" == "0" ]];then
+ echo "Ocie Updater: Application has not been deployed and was not found in ${APP_UPDATE_PATH}";
+ exit 2;
+ elif [[ "${SIG_LOCAL}" == "0" ]] && [[ "${SIG_UPDATE}" != "0" ]];then
+ echo "Ocie Updater: Application has not been deployed, deploying from ${APP_UPDATE_PATH}";
+ deploy_app;
+ elif [[ "${SIG_LOCAL}" != "0" ]] && [[ "${SIG_UPDATE}" == "0" ]];then
+ echo "Ocie Updater: Application is deployed but update is empty, failure enabled: ${APP_UPDATE_FAIL}";
+ if [[ "${APP_UPDATE_FAIL}" == 1 ]];then
+ exit 2;
+ fi;
+ else
+ echo "Ocie Updater: Auto-update is enabled: ${APP_UPDATE_AUTO}, deployed: ${SIG_LOCAL}, latest: ${SIG_UPDATE}";
+ update_app;
+ fi;
+fi;
diff --git a/src/usr/sbin/ocie b/src/usr/sbin/ocie
new file mode 100644
index 0000000..b49ad12
--- /dev/null
+++ b/src/usr/sbin/ocie
@@ -0,0 +1,110 @@
+#!/bin/bash
+set -euf;
+
+function show_help()
+{
+ echo "OCIE System Config";
+ echo
+ echo "Syntax: ocie [--keys -size 2048 -subject localhost] [--dhparams -size 3072] [--timezone America] [--print]";
+ echo
+ echo "Parameters:";
+ echo
+ echo "--cacerts Update CA Certificate Stores, certificates must have the .crt extension";
+ echo " Required:"
+ echo " -path Path to import CA Certs from, prefixed with either [ url: | file:file ], default: env CERT_PATH";
+ echo " Optional:";
+ echo " -os Import into operating system store, /etc/ssl, default: env CERT_UPDATE_OS";
+ echo " -jvm Import into java store, default: env CERT_UPDATE_JVM";
+ echo " -filter Filter to find CA cert files by, default: env CERT_FILTER";
+ echo
+ echo "--dhparams Generate new dhparams";
+ echo " Optional:"
+ echo " -size , default: env DH_PARAM_SIZE";
+ echo " -name , default: dhparams";
+ echo " -path , default: /etc/ssl";
+ echo
+ echo "--keys Creates new ssl private key and public certificate"
+ echo " Optional:"
+ echo " -size , default: 2048";
+ echo " -name , default: server";
+ echo " -path , default: /etc/ssl";
+ echo " -subject , default: localhost";
+ echo " -valid , default: 365";
+ echo " -tag , default: default.keys";
+ echo
+ echo "--pkg Add/Remove packages"
+ echo " Optional:"
+ echo " -base Add default packages";
+ echo " -upgrade Update all packages";
+ echo " -add Add packages, comma seperated list";
+ echo " -remove Remove packages, comma seperated list";
+ echo
+ echo "--timezone Set system timezone";
+ echo " Required:"
+ echo " -set A valid timezone definition from zoneinfo";
+ echo " Optional:"
+ echo " -print Print system timezone";
+ echo
+ echo "--clean Remove directories/files";
+ echo " Optional:"
+ echo " -base Cleanup base image, default: false";
+ echo " -path Path to search, default: /var/log";
+ echo " -pattern Comma seperated list of patterns to search, default: *.log* *.log.xz";
+ echo " -dirs Comma seperated list of directories to forcefully delete";
+ echo
+ echo "--print Print system config";
+}
+
+function get_environment()
+{
+ echo "Ocie: Environment";
+ printf "%s" "$(