launchpad-reviewers team mailing list archive
-
launchpad-reviewers team
-
Mailing list archive
-
Message #27507
[Merge] ~cjwatson/rutabaga:in-tree-charms into rutabaga:master
Colin Watson has proposed merging ~cjwatson/rutabaga:in-tree-charms into rutabaga:master.
Commit message:
Add reactive charms
Requested reviews:
Launchpad code reviewers (launchpad-reviewers)
For more details, see:
https://code.launchpad.net/~cjwatson/rutabaga/+git/rutabaga/+merge/408430
This is very loosely based on https://code.launchpad.net/~canonical-launchpad-branches/charms/trusty/rutabaga/devel, but rewritten to use the reactive pattern, to work on xenial and above, to work with `squid-reverseproxy`, and to use a separate `rutabaga-auth-helper` charm so that `rutabaga` and `squid-reverseproxy` don't have to be colocated.
This requires https://code.launchpad.net/~cjwatson/squid-reverseproxy-charm/+git/squid-reverseproxy-charm/+merge/407896, and shouldn't be merged until that interface is agreed.
Dependencies MP: https://code.launchpad.net/~cjwatson/rutabaga/+git/dependencies/+merge/408428
--
Your team Launchpad code reviewers is requested to review the proposed merge of ~cjwatson/rutabaga:in-tree-charms into rutabaga:master.
diff --git a/Makefile b/Makefile
index 8c1d51e..d0938e4 100644
--- a/Makefile
+++ b/Makefile
@@ -103,6 +103,7 @@ build-tarball:
tar -czf $(TARBALL_BUILD_PATH) \
--exclude-vcs \
--exclude build \
+ --exclude charm \
--exclude dist \
--exclude env \
./
diff --git a/charm/.gitignore b/charm/.gitignore
new file mode 100644
index 0000000..80d9ebb
--- /dev/null
+++ b/charm/.gitignore
@@ -0,0 +1,4 @@
+bundle.yaml
+dist
+interface/*/codetree-collect-info.yaml
+tmp
diff --git a/charm/Makefile b/charm/Makefile
new file mode 100644
index 0000000..bb02854
--- /dev/null
+++ b/charm/Makefile
@@ -0,0 +1,85 @@
+APP_NAME := rutabaga
+
+BUILDDIR := $(CURDIR)/dist
+TMPDIR := $(CURDIR)/tmp
+export CHARM_LAYERS_DIR := $(TMPDIR)/deps/layer
+export CHARM_INTERFACES_DIR := $(TMPDIR)/deps/interface
+CHARM_WHEELS_DIR := $(TMPDIR)/deps/charm-wheels
+
+BUILD_LABEL = $(shell git rev-parse HEAD)
+TARBALL = $(APP_NAME).tar.gz
+ASSET = ../build/$(BUILD_LABEL)/$(TARBALL)
+
+CHARMS := \
+ rutabaga \
+ rutabaga-auth-helper
+
+all: build lint
+
+$(BUILDDIR) $(TMPDIR):
+ @mkdir -p $@
+
+CHARM_DEPS := $(CHARM_LAYERS_DIR)/.done $(CHARM_INTERFACES_DIR)/.done
+$(CHARM_DEPS): $(CURDIR)/dependencies.txt | $(TMPDIR)
+ @echo "Fetching dependencies..."
+ @mkdir -p $(TMPDIR)/deps
+ @cd $(TMPDIR)/deps && codetree $<
+ @touch $(CHARM_DEPS)
+
+build: $(foreach charm,$(CHARMS),build-$(charm))
+
+build-rutabaga: dist/.built-rutabaga
+build-rutabaga-auth-helper: dist/.built-rutabaga-auth-helper
+
+dist/.built-%: $(CHARM_DEPS) | $(BUILDDIR)
+ @echo "Building $*..."
+ @cd $* && \
+ PIP_NO_INDEX=true PIP_FIND_LINKS=$(CHARM_WHEELS_DIR) \
+ charm build -o $(BUILDDIR)
+ @touch $@
+
+clean-%:
+ @echo "Cleaning $*..."
+ @rm -rf dist/.built-$* dist/$*
+
+tmp/admin-api-secret: | $(TMPDIR)
+ python3 -c '\
+ import random, string; \
+ rnd = random.SystemRandom(); \
+ print("".join( \
+ rnd.choice(string.ascii_letters + string.digits) \
+ for _ in range(16)))' \
+ >$@
+
+bundle.yaml: bundle.yaml.in tmp/admin-api-secret
+ sed \
+ -e 's/%BUILD_LABEL%/$(BUILD_LABEL)/g' \
+ -e "s/%ADMIN_API_SECRET%/$$(cat tmp/admin-api-secret)/g" \
+ bundle.yaml.in >bundle.yaml
+
+deploy: build payload bundle.yaml
+ @echo "Deploying $(APP_NAME)..."
+ @juju deploy ./bundle.yaml
+
+payload: $(ASSET)
+$(ASSET):
+ @echo "Building asset for $(BUILD_LABEL)..."
+ @$(MAKE) -C .. build-tarball
+
+clean:
+ @find . -name \*.pyc -delete
+ @find . -depth -name '__pycache__' -exec rm -rf '{}' \;
+ @rm -f bundle.yaml
+ @rm -f interface/*/codetree-collect-info.yaml
+ @rm -rf $(BUILDDIR) $(TMPDIR)
+
+lint: build
+ @echo "Linting charm..."
+ @set -e; for charm in $(CHARMS); do \
+ charm proof dist/$$charm; \
+ done
+ @echo "Linting python sources..."
+ @flake8 interface $(CHARMS)
+
+.PHONY: build-rutabaga
+.PHONY: all build clean deploy lint payload
diff --git a/charm/bundle.yaml.in b/charm/bundle.yaml.in
new file mode 100644
index 0000000..dbe2664
--- /dev/null
+++ b/charm/bundle.yaml.in
@@ -0,0 +1,43 @@
+series: focal
+description: "Rutabaga development bundle"
+applications:
+ # "Reverse" proxy because that's the only supported Squid charm nowadays,
+ # but we're really running it in forward proxying mode.
+ squid-reverseproxy:
+ charm: cs:squid-reverseproxy
+ num_units: 1
+ options:
+ auth_list: |
+ [
+ # Deny requests to ports other than 80, 443, 9418
+ {"!port": [80, 443, 9418], http_access: deny},
+ # Only allow certain HTTP methods.
+ {"!method": [GET, POST, CONNECT, OPTIONS, PROPFIND, REPORT],
+ http_access: deny},
+ # Only allow authenticated requests.
+ {"!proxy_auth": [REQUIRED], http_access: deny},
+ # Allow anything else.
+ {port: [80, 443, 9418],
+ method: [GET, POST, CONNECT, OPTIONS, PROPFIND, REPORT],
+ http_access: allow},
+ ]
+ dns_v4_first: true
+ nagios_context: lp-devel-builder-proxy
+ port_options: ""
+ wait_for_auth_helper: true
+ rutabaga:
+ charm: ./dist/rutabaga
+ num_units: 1
+ options:
+ admin_api_username: launchpad.test
+ admin_api_secret: "%ADMIN_API_SECRET%"
+ build_label: "%BUILD_LABEL%"
+ nagios_context: lp-devel-builder-proxy
+ resources:
+ rutabaga: "../build/%BUILD_LABEL%/rutabaga.tar.gz"
+ rutabaga-auth-helper:
+ charm: ./dist/rutabaga-auth-helper
+relations:
+ - ["rutabaga", "rutabaga-auth-helper"]
+ - ["rutabaga-auth-helper:squid-auth-helper", "squid-reverseproxy:auth-helper"]
+ - ["rutabaga:squid", "squid-reverseproxy"]
diff --git a/charm/dependencies.txt b/charm/dependencies.txt
new file mode 100644
index 0000000..064ad8b
--- /dev/null
+++ b/charm/dependencies.txt
@@ -0,0 +1,12 @@
+interface @
+interface/http git+https://github.com/juju-solutions/interface-http;revno=632131b1
+interface/nrpe-external-master git+https://github.com/cmars/nrpe-external-master-interface;revno=2e0e1fde
+interface/squid-auth-helper ../../../interface/squid-auth-helper;method=link
+
+layer @
+layer/apt git+https://git.launchpad.net/layer-apt;revno=3caa4a89
+layer/basic git+https://github.com/juju-solutions/layer-basic;revno=a3ff62c3
+layer/options git+https://github.com/juju-solutions/layer-options;revno=fcdcea4e
+layer/status git+https://github.com/juju-solutions/layer-status;revno=a7d7b642
+
+charm-wheels git+https://git.launchpad.net/~canonical-launchpad-branches/rutabaga/+git/dependencies
diff --git a/charm/interface/squid-auth-helper/interface.yaml b/charm/interface/squid-auth-helper/interface.yaml
new file mode 100644
index 0000000..80b57fa
--- /dev/null
+++ b/charm/interface/squid-auth-helper/interface.yaml
@@ -0,0 +1,4 @@
+name: squid-auth-helper
+summary: Squid authentication helper interface
+version: 1
+repo: https://git.launchpad.net/rutabaga
diff --git a/charm/interface/squid-auth-helper/requires.py b/charm/interface/squid-auth-helper/requires.py
new file mode 100644
index 0000000..c0cb870
--- /dev/null
+++ b/charm/interface/squid-auth-helper/requires.py
@@ -0,0 +1,39 @@
+# Copyright 2021 Canonical Ltd. This software is licensed under the
+# GNU Library General Public License version 3 (see the file LICENSE).
+
+from charms.reactive import (
+ clear_flag,
+ Endpoint,
+ set_flag,
+ when,
+ when_not,
+ )
+
+
+class SquidAuthHelperRequires(Endpoint):
+
+ @when('endpoint.{endpoint_name}.joined')
+ def joined(self):
+ set_flag(self.expand_name('{endpoint_name}.available'))
+
+ @when_not('endpoint.{endpoint_name}.joined')
+ def broken(self):
+ clear_flag(self.expand_name('{endpoint_name}.available'))
+
+ def configure(self, auth_params):
+ """Configure authentication parameters.
+
+ For example:
+
+ endpoint.configure([
+ {"scheme": "basic", "program": "path_to_basic_helper",
+ "children": {"number": 0, "startup": 0, "idle": 1},
+ "realm": "Squid proxy-caching web server"},
+ {"scheme": "digest", "program": "path_to_digest_helper",
+ "children": 2, "nonce_max_duration": 5, "utf8": "on"},
+ ])
+ """
+ for relation in self.relations:
+ relation.to_publish_raw.update({
+ 'auth-params': auth_params,
+ })
diff --git a/charm/rutabaga-auth-helper/config.yaml b/charm/rutabaga-auth-helper/config.yaml
new file mode 100644
index 0000000..4719fe9
--- /dev/null
+++ b/charm/rutabaga-auth-helper/config.yaml
@@ -0,0 +1,5 @@
+options:
+ credentials_ttl_seconds:
+ type: int
+ default: 1
+ description: Number of seconds for which credentials are valid.
diff --git a/charm/rutabaga-auth-helper/copyright b/charm/rutabaga-auth-helper/copyright
new file mode 120000
index 0000000..7dd368c
--- /dev/null
+++ b/charm/rutabaga-auth-helper/copyright
@@ -0,0 +1 @@
+../rutabaga/copyright
\ No newline at end of file
diff --git a/charm/rutabaga-auth-helper/icon.svg b/charm/rutabaga-auth-helper/icon.svg
new file mode 120000
index 0000000..f2b8fe0
--- /dev/null
+++ b/charm/rutabaga-auth-helper/icon.svg
@@ -0,0 +1 @@
+../rutabaga/icon.svg
\ No newline at end of file
diff --git a/charm/rutabaga-auth-helper/layer.yaml b/charm/rutabaga-auth-helper/layer.yaml
new file mode 100644
index 0000000..1d931ee
--- /dev/null
+++ b/charm/rutabaga-auth-helper/layer.yaml
@@ -0,0 +1,13 @@
+includes:
+ - layer:basic
+ - layer:apt
+ - layer:status
+ - interface:http
+ - interface:squid-auth-helper
+repo: https://git.launchpad.net/rutabaga
+options:
+ basic:
+ use_venv: true
+ apt:
+ packages:
+ - python3-requests
diff --git a/charm/rutabaga-auth-helper/metadata.yaml b/charm/rutabaga-auth-helper/metadata.yaml
new file mode 100644
index 0000000..e2b2a22
--- /dev/null
+++ b/charm/rutabaga-auth-helper/metadata.yaml
@@ -0,0 +1,23 @@
+name: rutabaga-auth-helper
+display-name: Rutabaga authentication helper for Squid
+summary: Squid helper to authenticate requests against Rutabaga
+maintainer: Colin Watson <cjwatson@xxxxxxxxxxxxx>
+description: >
+ Rutabaga is a microservice for creating and revoking time-limited
+ authentication tokens in Squid. This authentication helper hooks into
+ Squid to authenticate requests against Rutabaga.
+tags:
+ # https://docs.jujucharms.com/devel/en/authors-charm-metadata#charm-store-fields
+ - network
+ - web_server
+series:
+ - focal
+ - bionic
+ - xenial
+subordinate: true
+requires:
+ squid-auth-helper:
+ interface: squid-auth-helper
+ scope: container
+ rutabaga:
+ interface: http
diff --git a/charm/rutabaga-auth-helper/reactive/rutabaga_auth_helper.py b/charm/rutabaga-auth-helper/reactive/rutabaga_auth_helper.py
new file mode 100644
index 0000000..30e9e64
--- /dev/null
+++ b/charm/rutabaga-auth-helper/reactive/rutabaga_auth_helper.py
@@ -0,0 +1,70 @@
+# Copyright 2021 Canonical Ltd. This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+import os.path
+
+from charmhelpers.core import hookenv
+from charms.layer import status
+from charms.reactive import (
+ clear_flag,
+ endpoint_from_flag,
+ set_flag,
+ when,
+ when_not,
+ when_not_all,
+ )
+
+
+@when('rutabaga.available')
+@when_not('rutabaga-auth-helper.configured')
+def rutabaga_available():
+ rutabaga = endpoint_from_flag('rutabaga.available')
+ config = hookenv.config()
+ for service in rutabaga.services():
+ if service['service_name'] == 'rutabaga':
+ config['rutabaga_host'] = service['hosts'][0]['private-address']
+ config['rutabaga_port'] = service['hosts'][0]['port']
+ set_flag('rutabaga-auth-helper.configured')
+ break
+ else:
+ clear_flag('rutabaga-auth-helper.configured')
+ status.blocked(
+ 'rutabaga-auth-helper must be related to the http interface')
+
+
+@when('rutabaga-auth-helper.configured')
+@when_not('rutabaga.available')
+def rutabaga_unavailable():
+ clear_flag('rutabaga-auth-helper.configured')
+ status.blocked(
+ 'rutabaga-auth-helper must be related to the http interface')
+
+
+@when('rutabaga-auth-helper.configured', 'squid-auth-helper.available')
+@when_not('rutabaga-auth-helper.squid-configured')
+def configure_auth_helper():
+ endpoint = endpoint_from_flag('squid-auth-helper.available')
+ config = hookenv.config()
+ credentials_ttl_seconds = config['credentials_ttl_seconds']
+ endpoint.configure([{
+ 'scheme': 'basic',
+ 'program': '{} http://{}:{}/validate'.format(
+ os.path.join(
+ hookenv.charm_dir(), 'scripts', 'rutabaga_auth_helper.py'),
+ config['rutabaga_host'], config['rutabaga_port']),
+ 'credentialsttl': '{} {}'.format(
+ credentials_ttl_seconds,
+ 'second' if credentials_ttl_seconds == 1 else 'seconds'),
+ 'casesensitive': 'on',
+ }])
+ set_flag('rutabaga-auth-helper.squid-configured')
+ status.active('Ready')
+
+
+@when('rutabaga-auth-helper.squid-configured')
+@when_not_all('rutabaga-auth-helper.configured', 'squid-auth-helper.available')
+def deconfigure_auth_helper():
+ endpoint = endpoint_from_flag('squid-auth-helper.available')
+ if endpoint is not None:
+ endpoint.configure([])
+ clear_flag('rutabaga-auth-helper.squid-configured')
diff --git a/rutabaga/scripts/rutabaga_auth_helper.py b/charm/rutabaga-auth-helper/scripts/rutabaga_auth_helper.py
similarity index 83%
rename from rutabaga/scripts/rutabaga_auth_helper.py
rename to charm/rutabaga-auth-helper/scripts/rutabaga_auth_helper.py
index e7e5b9c..2f2fd9f 100755
--- a/rutabaga/scripts/rutabaga_auth_helper.py
+++ b/charm/rutabaga-auth-helper/scripts/rutabaga_auth_helper.py
@@ -1,8 +1,9 @@
-#!/srv/rutabaga/code/env/bin/python3
+#! /usr/bin/python3
#
-# Copyright 2016 Canonical Ltd. This software is licensed under the
+# Copyright 2016-2021 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
+from argparse import ArgumentParser
import sys
from requests import (
@@ -16,18 +17,16 @@ from requests.exceptions import (
)
-AUTH_WS_URL = 'http://localhost:8080/validate'
-
# squid 'debug_options ALL,1 82,9 84,9' can be potentially
# useful for debugging this
-def validate(username, secret):
+def validate(auth_ws_url, username, secret):
s = Session()
s.mount('http://', HTTPAdapter(max_retries=5))
try:
- r = s.post(AUTH_WS_URL, json={'secret': secret, 'username': username})
+ r = s.post(auth_ws_url, json={'secret': secret, 'username': username})
if r.status_code == codes.ok and r.json()['username'] == username:
return True
else:
@@ -40,6 +39,11 @@ def validate(username, secret):
def main():
+ parser = ArgumentParser()
+ parser.add_argument(
+ 'auth_ws_url', default='http://localhost:8080/validate')
+ args = parser.parse_args()
+
while True:
data = sys.stdin.readline().split()
if len(data) != 2:
@@ -50,7 +54,7 @@ def main():
username = data[0]
secret = data[1]
- if validate(username, secret):
+ if validate(args.auth_ws_url, username, secret):
sys.stdout.write('OK\n')
else:
sys.stdout.write('ERR\n')
diff --git a/charm/rutabaga/README.md b/charm/rutabaga/README.md
new file mode 100644
index 0000000..287b18f
--- /dev/null
+++ b/charm/rutabaga/README.md
@@ -0,0 +1,17 @@
+# Overview
+
+This charm provides a microservice for creating and revoking time-limited
+authentication tokens in Squid.
+
+# Usage
+
+ $ juju add-model rutabaga
+ $ make deploy PIP_SOURCE_DIR=/path/to/dependencies
+
+... where `/path/to/dependencies` is the path to a clone of
+https://git.launchpad.net/~canonical-launchpad-branches/rutabaga/+git/dependencies.
+
+# Contact Information
+
+Colin Watson <cjwatson@xxxxxxxxxxxxx>
+https://launchpad.net/~cjwatson
diff --git a/charm/rutabaga/config.yaml b/charm/rutabaga/config.yaml
new file mode 100644
index 0000000..e215d78
--- /dev/null
+++ b/charm/rutabaga/config.yaml
@@ -0,0 +1,119 @@
+options:
+ build_label:
+ type: string
+ default: ""
+ description: Build label to run.
+ nagios_context:
+ default: "juju"
+ type: string
+ description: |
+ Used by the nrpe-external-master subordinate charm.
+ A string that will be prepended to instance name to set the host name
+ in nagios. So for instance the hostname would be something like -
+ juju-rutabaga-0
+ If you're running multiple environments with the same services in them
+ this allows you to differentiate between them.
+ base_dir:
+ type: string
+ default: '/srv/rutabaga'
+ description: Root checkout/srv directory.
+ user:
+ type: string
+ default: rutabaga
+ description: The service will run as this user.
+ group:
+ type: string
+ default: rutabaga
+ description: The service will run under this group.
+ log_hosts_allow:
+ type: string
+ default: ""
+ description: Hosts that should be allowed to rsync logs.
+ swift_username:
+ type: string
+ default: ""
+ description: Username to use when accessing Swift.
+ swift_password:
+ type: string
+ default: ""
+ description: Password to use when accessing Swift.
+ swift_auth_url:
+ type: string
+ default: ""
+ description: URL for authenticating against Keystone.
+ swift_storage_url:
+ type: string
+ default: ""
+ description: URL for fetching from Swift (for anonymous access).
+ swift_region_name:
+ type: string
+ default: ""
+ description: Swift region.
+ swift_tenant_name:
+ type: string
+ default: ""
+ description: Entity that owns resources.
+ swift_container_name:
+ type: string
+ default: ""
+ description: Container to put objects in.
+ token_purge_minutes:
+ type: int
+ default: 20
+ description: Period of token-purging cron job.
+ admin_api_username_prefix:
+ type: string
+ default: "admin-"
+ description: Admin account username prefix.
+ admin_api_username:
+ type: string
+ default: "launchpad.dev"
+ description: Admin account username.
+ admin_api_secret:
+ type: string
+ default: ""
+ description: Admin API secret.
+ token_ttl_minutes:
+ type: int
+ default: 15
+ description: Token lifetime in minutes.
+ port_api:
+ type: int
+ default: 8080
+ description: API port.
+ wsgi_workers:
+ type: int
+ default: 0
+ description: >
+ The number of worker processes for handling requests. The default (0)
+ indicates the number of CPUs plus 1.
+ wsgi_backlog:
+ type: int
+ default: 2048
+ description: The maximum number of pending connections.
+ wsgi_timeout:
+ type: int
+ default: 30
+ description: Timeout of a request in seconds.
+ wsgi_keep_alive:
+ type: int
+ default: 2
+ description: Keep-alive time in seconds.
+ wsgi_max_requests:
+ type: int
+ default: 0
+ description: >
+ Maximum requests for a worker to serve before restarting. The default
+ (0) disables automatic worker restarts.
+ wsgi_access_log_format:
+ type: string
+ default: ""
+ description: >
+ The access log format (see the Gunicorn documentation). Leave this
+ blank to use Gunicorn's default.
+ wsgi_error_log_level:
+ type: string
+ default: info
+ description: >
+ The granularity of error log entries (valid values are debug, info,
+ warning, error, and critical).
diff --git a/charm/rutabaga/copyright b/charm/rutabaga/copyright
new file mode 100644
index 0000000..48fee39
--- /dev/null
+++ b/charm/rutabaga/copyright
@@ -0,0 +1,676 @@
+rutabaga is Copyright 2015-2018 Canonical Ltd.
+
+Canonical Ltd ("Canonical") distributes the rutabaga source code
+under the GNU Affero General Public License, version 3 ("AGPLv3").
+The full text of this licence is given below.
+
+Third-party copyright in this distribution is noted where applicable.
+
+All rights not expressly granted are reserved.
+
+=========================================================================
+
+ GNU AFFERO GENERAL PUBLIC LICENSE
+ Version 3, 19 November 2007
+ (http://www.gnu.org/licenses/agpl.html)
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+our General Public Licenses are 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.
+
+ 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.
+
+ Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+ A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate. Many developers of free software are heartened and
+encouraged by the resulting cooperation. However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+ The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community. It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server. Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+ An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals. This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+ 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
+
+ Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software. This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+ 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 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 work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero 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 Affero 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 Affero 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 Affero 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.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source. For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code. There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+ 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 AGPL, see
+<http://www.gnu.org/licenses/>.
+
+=========================================================================
diff --git a/charm/rutabaga/icon.svg b/charm/rutabaga/icon.svg
new file mode 100644
index 0000000..b7920cc
--- /dev/null
+++ b/charm/rutabaga/icon.svg
@@ -0,0 +1,159 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns:dc="http://purl.org/dc/elements/1.1/";
+ xmlns:cc="http://creativecommons.org/ns#";
+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#";
+ xmlns:svg="http://www.w3.org/2000/svg";
+ xmlns="http://www.w3.org/2000/svg";
+ xmlns:xlink="http://www.w3.org/1999/xlink";
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd";
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape";
+ width="100px"
+ height="100px"
+ viewBox="0 0 100 100"
+ version="1.1"
+ id="svg18"
+ sodipodi:docname="lp-charm-icon.svg"
+ inkscape:version="0.92.3 (2405546, 2018-03-11)">
+ <metadata
+ id="metadata22">
+ <rdf:RDF>
+ <cc:Work
+ rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type
+ rdf:resource="http://purl.org/dc/dcmitype/StillImage"; />
+ <dc:title>eclispe-che</dc:title>
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <sodipodi:namedview
+ pagecolor="#ffffff"
+ bordercolor="#666666"
+ borderopacity="1"
+ objecttolerance="10"
+ gridtolerance="10"
+ guidetolerance="10"
+ inkscape:pageopacity="0"
+ inkscape:pageshadow="2"
+ inkscape:window-width="1920"
+ inkscape:window-height="1016"
+ id="namedview20"
+ showgrid="false"
+ inkscape:pagecheckerboard="true"
+ inkscape:zoom="1.668772"
+ inkscape:cx="29.156684"
+ inkscape:cy="41.621867"
+ inkscape:window-x="0"
+ inkscape:window-y="27"
+ inkscape:window-maximized="1"
+ inkscape:current-layer="layer2"
+ inkscape:snap-bbox="false"
+ inkscape:snap-bbox-midpoints="true"
+ inkscape:snap-object-midpoints="true" />
+ <!-- Generator: Sketch 45.2 (43514) - http://www.bohemiancoding.com/sketch -->
+ <title
+ id="title2">eclispe-che</title>
+ <desc
+ id="desc4">Created with Sketch.</desc>
+ <defs
+ id="defs7">
+ <path
+ d="M50.0004412,4.04252804e-14 C22.3871247,4.04252804e-14 0,22.3848726 0,49.9995588 C0,77.6133626 22.3871247,100 50.0004412,100 C77.6137577,100 100,77.6133626 100,49.9995588 C100,22.3848726 77.6128753,3.55271368e-14 50.0004412,4.04252804e-14 Z"
+ id="path-1" />
+ <style
+ id="style6"
+ type="text/css">
+
+ .fil0 {fill:#F8C300}
+ .fil6 {fill:#3895BD}
+ .fil3 {fill:#3941BF}
+ .fil1 {fill:#8FB635}
+ .fil4 {fill:#A02C35}
+ .fil7 {fill:#BB3A84}
+ .fil5 {fill:#D18C3B}
+ .fil8 {fill:#72706F;fill-rule:nonzero}
+ .fil9 {fill:#F8C300;fill-rule:nonzero}
+ .fil2 {fill:white;fill-rule:nonzero}
+
+ </style>
+ </defs>
+ <g
+ inkscape:groupmode="layer"
+ id="layer1"
+ inkscape:label="BACKGROUND">
+ <g
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:1;stroke-opacity:1"
+ id="Page-1">
+ <g
+ id="eclispe-che"
+ style="fill:#ffffff;fill-opacity:1;stroke:none;stroke-opacity:1">
+ <g
+ id="path3023-path"
+ style="fill:#ffffff;fill-opacity:1;stroke:none;stroke-opacity:1">
+ <use
+ xlink:href="#path-1"
+ id="use9"
+ style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-opacity:1"
+ x="0"
+ y="0"
+ width="100%"
+ height="100%" />
+ <path
+ d="M 50.000441,0.5 C 22.662621,0.5 0.5,22.661661 0.5,49.999559 0.5,77.337051 22.663098,99.5 50.000441,99.5 77.337613,99.5 99.5,77.337222 99.5,49.999559 99.5,22.661796 77.337514,0.5 50.000441,0.5 Z"
+ id="path11"
+ style="fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1;stroke-opacity:1"
+ inkscape:connector-curvature="0" />
+ </g>
+ </g>
+ </g>
+ </g>
+ <g
+ inkscape:groupmode="layer"
+ id="layer2"
+ inkscape:label="PLACE LOGO HERE">
+ <g
+ style="fill-rule:evenodd"
+ id="g3473"
+ transform="matrix(3.2292607,0,0,3.2292607,-486.24769,-600.53027)">
+ <g
+ id="g3489">
+ <path
+ inkscape:connector-curvature="0"
+ style="fill:#3895bd;fill-opacity:1;fill-rule:evenodd"
+ d="m 165.22326,188.53265 -9.92868,5.72521 4.76477,2.75658 5.15144,-2.96862 z"
+ id="path3475" />
+ <path
+ inkscape:connector-curvature="0"
+ style="fill:#8fb635;fill-opacity:1;fill-rule:evenodd"
+ d="m 166.90714,188.53265 v 5.51317 l 5.15144,2.96862 4.77724,-2.75658 z"
+ id="path3477" />
+ <path
+ inkscape:connector-curvature="0"
+ style="fill:#f8c300;fill-rule:evenodd"
+ d="m 166.05897,195.50518 -5.15144,2.96863 v 5.96219 l 5.15144,2.95616 5.15143,-2.95616 v -5.96219 z"
+ id="path3479" />
+ <path
+ inkscape:connector-curvature="0"
+ style="fill:#d18c3b;fill-opacity:1;fill-rule:evenodd"
+ d="m 177.67153,195.71723 -4.77724,2.76905 v 5.93725 l 4.77724,2.75658 z"
+ id="path3481" />
+ <path
+ inkscape:connector-curvature="0"
+ style="fill:#3941bf;fill-opacity:1;fill-rule:evenodd"
+ d="m 154.4464,195.7297 v 11.45041 l 4.77724,-2.75658 v -5.94972 z"
+ id="path3483" />
+ <path
+ inkscape:connector-curvature="0"
+ style="fill:#bb3a84;fill-opacity:1;fill-rule:evenodd"
+ d="m 160.05935,205.8829 -4.76477,2.75658 9.91621,5.73768 V 208.864 l -5.13897,-2.9811 z"
+ id="path3485" />
+ <path
+ inkscape:connector-curvature="0"
+ style="fill:#a02c35;fill-opacity:1;fill-rule:evenodd"
+ d="m 172.05858,205.89537 -5.15144,2.96863 v 5.51316 l 9.91621,-5.73768 z"
+ id="path3487" />
+ </g>
+ </g>
+ </g>
+</svg>
diff --git a/charm/rutabaga/layer.yaml b/charm/rutabaga/layer.yaml
new file mode 100644
index 0000000..c8247cb
--- /dev/null
+++ b/charm/rutabaga/layer.yaml
@@ -0,0 +1,15 @@
+includes:
+ - layer:basic
+ - layer:apt
+ - layer:status
+ - interface:http
+ - interface:nrpe-external-master
+repo: https://git.launchpad.net/rutabaga
+options:
+ basic:
+ use_venv: true
+ apt:
+ packages:
+ - make
+ - python3-virtualenv
+ - sqlite3
diff --git a/charm/rutabaga/lib/charms/rutabaga.py b/charm/rutabaga/lib/charms/rutabaga.py
new file mode 100644
index 0000000..6c175b7
--- /dev/null
+++ b/charm/rutabaga/lib/charms/rutabaga.py
@@ -0,0 +1,338 @@
+# Copyright 2018 Canonical Ltd. This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+import errno
+from multiprocessing import cpu_count
+import os.path
+import shutil
+import subprocess
+
+from charmhelpers.core import (
+ hookenv,
+ host,
+ templating,
+ )
+from charmhelpers.fetch import apt_install
+from charmhelpers.payload import archive
+import yaml
+
+
+def base_dir():
+ return hookenv.config()['base_dir']
+
+
+def payloads_dir():
+ return os.path.join(base_dir(), hookenv.application_name(), 'payloads')
+
+
+def code_dir():
+ return os.path.join(base_dir(), hookenv.application_name(), 'code')
+
+
+def db_dir():
+ return os.path.join(base_dir(), 'db')
+
+
+def venv_dir():
+ return os.path.join(code_dir(), 'env')
+
+
+def logs_dir():
+ return os.path.join(base_dir(), 'logs')
+
+
+def nrpe_dir():
+ return os.path.join(base_dir(), hookenv.application_name(), 'nrpe')
+
+
+def user():
+ return hookenv.config()['user']
+
+
+def group():
+ return hookenv.config()['group']
+
+
+def ensure_user(username, groupname):
+ if not host.user_exists(username):
+ hookenv.log('Creating {} user and group'.format(username))
+ password = host.pwgen()
+ if not host.group_exists(groupname):
+ host.add_group(groupname)
+ host.adduser(username, password, primary_group=groupname)
+
+
+def ensure_directories():
+ for dir in (base_dir(), payloads_dir()):
+ host.mkdir(dir, perms=0o755)
+ for dir in (logs_dir(), db_dir()):
+ host.mkdir(dir, owner=user(), group=group(), perms=0o755)
+
+
+def get_swift_creds(config):
+ return {
+ 'user': config['swift_username'],
+ 'project': config['swift_tenant_name'],
+ 'password': config['swift_password'],
+ 'authurl': config['swift_auth_url'],
+ 'region': config['swift_region_name'],
+ 'storageurl': config['swift_storage_url'],
+ }
+
+
+def swift_base_cmd(**swift_creds):
+ return [
+ 'swift',
+ '--os-username=' + swift_creds['user'],
+ '--os-tenant-name=' + swift_creds['project'],
+ '--os-password=' + swift_creds['password'],
+ '--os-auth-url=' + swift_creds['authurl'],
+ '--os-region-name=' + swift_creds['region'],
+ ]
+
+
+def swift_fetch(source, target, container=None, **swift_creds):
+ if swift_creds['user']:
+ cmd = swift_base_cmd(**swift_creds) + [
+ 'download', '--output=' + target, container, source]
+ else:
+ storage_url = swift_creds['storageurl']
+ assert storage_url
+ cmd = [
+ 'wget', '-O', target,
+ '%s/%s/%s' % (storage_url, container, source)]
+ subprocess.check_call(cmd)
+
+
+def unlink_force(path):
+ """Unlink path, without worrying about whether it exists."""
+ try:
+ os.unlink(path)
+ except OSError as e:
+ if e.errno != errno.ENOENT:
+ raise
+
+
+def symlink_force(source, link_name):
+ """Create symlink link_name -> source, even if link_name exists."""
+ unlink_force(link_name)
+ os.symlink(source, link_name)
+
+
+def install_packages():
+ if hookenv.config()['swift_username']:
+ apt_install('python-swiftclient', fatal=True)
+
+
+def install_python_packages(target_dir):
+ hookenv.log('Installing Python dependencies')
+ subprocess.check_call(
+ ['sudo', 'make', '-C', target_dir, 'build',
+ 'PIP_SOURCE_DIR=%s' % os.path.join(target_dir, 'pip-cache')])
+
+
+def prune_payloads(keep):
+ for entry in os.listdir(payloads_dir()):
+ if entry in keep:
+ continue
+ entry_path = os.path.join(payloads_dir(), entry)
+ if os.path.isdir(entry_path):
+ hookenv.log('Purging old build in {}'.format(entry_path))
+ shutil.rmtree(entry_path)
+
+
+def migrate_db(payload_dir):
+ hookenv.log('Migrating database')
+ with open(os.path.join(payload_dir, 'db', 'rutabaga.schema')) as schema:
+ subprocess.check_call(
+ ['sudo', '-u', user(),
+ 'sqlite3', os.path.join(db_dir(), 'rutabaga.db')],
+ stdin=schema)
+
+
+class PayloadError(Exception):
+ pass
+
+
+def install_payload():
+ config = hookenv.config()
+ current_build_label = None
+ if os.path.islink(code_dir()):
+ current_build_label = os.path.basename(os.path.realpath(code_dir()))
+ desired_build_label = config['build_label']
+ if not desired_build_label:
+ raise PayloadError('Build label unset, so cannot deploy code')
+ if current_build_label == desired_build_label:
+ hookenv.log('Build {} already deployed'.format(desired_build_label))
+ return
+ hookenv.log('Deploying build {}...'.format(desired_build_label))
+
+ # Copy source archive
+ archive_path = os.path.join(
+ payloads_dir(), desired_build_label + '.tar.gz')
+ object_name = os.path.join(desired_build_label, 'rutabaga.tar.gz')
+
+ try:
+ if config['swift_container_name']:
+ swift_creds = get_swift_creds(config)
+ swift_container = config['swift_container_name']
+ series = host.lsb_release['DISTRIB_CODENAME']
+ swift_fetch(
+ os.path.join('rutabaga-builds-{}'.format(series), object_name),
+ archive_path, container=swift_container, **swift_creds)
+ else:
+ resource_path = hookenv.resource_get('rutabaga')
+ if resource_path and os.path.getsize(resource_path):
+ with open(resource_path, 'rb') as resource:
+ host.write_file(archive_path, resource.read(), perms=0o644)
+ else:
+ raise PayloadError('No build available, so cannot deploy code')
+
+ # Unpack source
+ target_dir = os.path.join(payloads_dir(), desired_build_label)
+ if os.path.isdir(target_dir):
+ shutil.rmtree(target_dir)
+ archive.extract_tarfile(archive_path, target_dir)
+ os.chown(target_dir, 0, 0)
+ host.lchownr(target_dir, 'root', 'root')
+
+ install_python_packages(target_dir)
+
+ migrate_db(target_dir)
+
+ symlink_force(
+ os.path.relpath(target_dir, os.path.dirname(code_dir())),
+ code_dir())
+ prune_payloads([desired_build_label, current_build_label])
+ finally:
+ unlink_force(archive_path)
+
+
+def install_services():
+ install_payload()
+ version_info_path = os.path.join(code_dir(), 'rutabaga', 'version_info.py')
+ if os.path.exists(version_info_path):
+ version_info_locals = {}
+ with open(version_info_path) as version_info_file:
+ exec(version_info_file.read(), {}, version_info_locals)
+ revision_id = version_info_locals.get('version_info', {}).get(
+ 'revision_id')
+ if revision_id is not None:
+ hookenv.application_version_set(revision_id)
+
+
+def configure_wsgi():
+ hookenv.log('Writing WSGI service configuration.')
+ config = hookenv.config()
+ context = dict(config)
+ context.update({
+ 'code_dir': code_dir(),
+ 'config_file': os.path.join(code_dir(), 'gunicorn-rutabaga.py'),
+ 'db_dir': db_dir(),
+ 'logs_dir': logs_dir(),
+ 'venv_dir': venv_dir(),
+ })
+ if context['wsgi_workers'] == 0:
+ context['wsgi_workers'] = cpu_count() * 2 + 1
+ templating.render(
+ 'gunicorn-rutabaga.py.j2', context['config_file'], context,
+ perms=0o644)
+ templating.render(
+ 'admin-secret.j2', os.path.join(base_dir(), '.admin-secret'),
+ context, owner=user(), group=group(), perms=0o440)
+ templating.render(
+ 'rutabaga-api.service.j2', '/lib/systemd/system/rutabaga-api.service',
+ context, perms=0o644)
+ subprocess.check_call(['systemctl', 'daemon-reload'])
+ if host.service_running('rutabaga-api'):
+ host.service_stop('rutabaga-api')
+ if not host.service_resume('rutabaga-api'):
+ raise RuntimeError('Failed to restart rutabaga-api')
+ hookenv.open_port(config['port_api'])
+
+
+def configure_logrotate():
+ hookenv.log('Writing logrotate configuration.')
+ config = hookenv.config()
+ templating.render(
+ 'logrotate.conf.j2', '/etc/logrotate.d/rutabaga', config, perms=0o644)
+
+
+def configure_rsync():
+ config = hookenv.config()
+ rsync_path = '/etc/rsync-juju.d/010-rutabaga.conf'
+ if config['log_hosts_allow']:
+ hookenv.log('Writing rsync configuration.')
+ templating.render('rsync.j2', rsync_path, config, perms=0o644)
+ elif os.path.exists(rsync_path):
+ hookenv.log('Removing rsync configuration.')
+ os.unlink(rsync_path)
+ if not host.service_restart('rsync'):
+ raise RuntimeError('Failed to restart rsync')
+
+
+def configure_cron():
+ hookenv.log('Writing crontab.')
+ config = hookenv.config()
+ templating.render(
+ 'crontab.j2', '/etc/cron.d/rutabaga', config, perms=0o644)
+
+
+def add_nagios_proxy_check(nagios, squid):
+ config = hookenv.config()
+ src = os.path.join(hookenv.charm_dir(), 'scripts', 'nrpe')
+ dst = nrpe_dir()
+ if not os.path.exists(dst):
+ os.makedirs(dst)
+ shutil.copy2(
+ os.path.join(src, 'check_rutabaga_proxy'),
+ os.path.join(dst, 'check_rutabaga_proxy'))
+ admin_secret_path = os.path.join(base_dir(), '.nagios-admin-secret')
+ templating.render(
+ 'admin-secret.j2', admin_secret_path,
+ config, owner='nagios', group='nagios', perms=0o440)
+ check_cmd = [
+ os.path.join(dst, 'check_rutabaga_proxy'),
+ '--username',
+ config['admin_api_username_prefix'] + config['admin_api_username'],
+ '--secret-file', admin_secret_path,
+ ]
+ for service in squid.services():
+ for service_host in service['hosts']:
+ check_cmd.extend([
+ '--proxy-url',
+ 'http://{}:{}/'.format(
+ service_host['hostname'], service_host['port']),
+ ])
+ nagios.add_check(
+ check_cmd,
+ name='check_rutabaga_proxy',
+ description='Rutabaga proxy check',
+ context=config['nagios_context'])
+
+
+def publish_website(website, name, port, add_options=None):
+ server_name = hookenv.local_unit().replace('/', '-')
+ server_ip = str(hookenv.unit_private_ip())
+ base_options = ['mode http', 'balance leastconn', 'option httplog']
+ options = list(base_options)
+ if add_options is not None:
+ options.extend(add_options)
+ haproxy_services = [{
+ 'service_name': name,
+ 'service_host': '0.0.0.0',
+ 'service_port': port,
+ 'service_options': options,
+ 'servers': [[server_name, server_ip, port, 'check']],
+ }]
+ haproxy_services_yaml = yaml.dump(haproxy_services)
+ for relation in website.relations:
+ ingress_address = website.get_ingress_address(relation.relation_id)
+ relation.to_publish_raw.update({
+ 'hostname': ingress_address,
+ 'private-address': ingress_address,
+ 'port': str(port),
+ 'services': haproxy_services_yaml,
+ })
diff --git a/charm/rutabaga/metadata.yaml b/charm/rutabaga/metadata.yaml
new file mode 100644
index 0000000..3f316f9
--- /dev/null
+++ b/charm/rutabaga/metadata.yaml
@@ -0,0 +1,30 @@
+name: rutabaga
+display-name: Rutabaga
+summary: Microservice for managing authentication tokens in Squid
+maintainer: Colin Watson <cjwatson@xxxxxxxxxxxxx>
+description: >
+ Rutabaga is a microservice for creating and revoking time-limited
+ authentication tokens in Squid.
+tags:
+ # https://docs.jujucharms.com/devel/en/authors-charm-metadata#charm-store-fields
+ - network
+ - web_server
+series:
+ - focal
+ - bionic
+ - xenial
+subordinate: false
+provides:
+ website:
+ interface: http
+ nrpe-external-master:
+ interface: nrpe-external-master
+ scope: container
+requires:
+ squid:
+ interface: http
+resources:
+ rutabaga:
+ type: file
+ filename: rutabaga.tar.gz
+ description: Rutabaga code
diff --git a/charm/rutabaga/reactive/rutabaga.py b/charm/rutabaga/reactive/rutabaga.py
new file mode 100644
index 0000000..d355728
--- /dev/null
+++ b/charm/rutabaga/reactive/rutabaga.py
@@ -0,0 +1,134 @@
+# Copyright 2018 Canonical Ltd. This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+from charmhelpers.core import hookenv
+from charms.layer import status
+from charms.reactive import (
+ clear_flag,
+ endpoint_from_flag,
+ hook,
+ set_flag,
+ when,
+ when_not,
+ when_not_all,
+ )
+
+from charms.rutabaga import (
+ add_nagios_proxy_check,
+ configure_cron,
+ configure_logrotate,
+ configure_rsync,
+ configure_wsgi,
+ ensure_directories,
+ ensure_user,
+ group,
+ install_services,
+ PayloadError,
+ publish_website,
+ user,
+ )
+
+
+@when_not('rutabaga.created_user')
+def install():
+ ensure_user(user(), group())
+ ensure_directories()
+ set_flag('rutabaga.created_user')
+
+
+@when('apt.installed.make')
+@when('apt.installed.python3-virtualenv')
+@when('apt.installed.sqlite3')
+@when('rutabaga.created_user')
+@when_not('rutabaga.installed')
+def install_rutabaga():
+ try:
+ install_services()
+ except PayloadError as e:
+ status.blocked(str(e))
+ return
+ set_flag('rutabaga.installed')
+ clear_flag('rutabaga.configured')
+ status.maintenance('Service installed, but not configured')
+
+
+@when('rutabaga.installed')
+@when_not('rutabaga.configured')
+def configure_rutabaga():
+ configure_wsgi()
+ configure_logrotate()
+ configure_rsync()
+ configure_cron()
+ set_flag('rutabaga.configured')
+ clear_flag('rutabaga.nrpe-external-master.published')
+ status.active('Ready')
+
+
+@hook('upgrade-charm')
+def upgrade_charm():
+ clear_flag('rutabaga.installed')
+
+
+@when('config.changed.build_label')
+def build_label_changed():
+ clear_flag('rutabaga.installed')
+
+
+@when('config.changed')
+def config_changed():
+ clear_flag('rutabaga.configured')
+
+
+@when('nrpe-external-master.available', 'rutabaga.configured')
+@when_not('rutabaga.nrpe-api-check.published')
+def nrpe_available():
+ nagios = endpoint_from_flag('nrpe-external-master.available')
+ config = hookenv.config()
+ nagios.add_check(
+ ['/usr/lib/nagios/plugins/check_http', '-H', 'localhost',
+ '-p', str(config['port_api']), '-u', '/'],
+ name='check_api',
+ description='Rutabaga API check',
+ context=config['nagios_context'])
+ set_flag('rutabaga.nrpe-api-check.published')
+
+
+@when('rutabaga.nrpe-api-check.published')
+@when_not('nrpe-external-master.available')
+def nrpe_unavailable():
+ clear_flag('rutabaga.nrpe-api-check.published')
+
+
+@when(
+ 'nrpe-external-master.available',
+ 'rutabaga.configured',
+ 'squid.available')
+@when_not('rutabaga.nrpe-proxy-check.published')
+def nrpe_and_squid_available():
+ nagios = endpoint_from_flag('nrpe-external-master.available')
+ squid = endpoint_from_flag('squid.available')
+ add_nagios_proxy_check(nagios, squid)
+
+
+@when('rutabaga.nrpe-proxy-check.published')
+@when_not_all('nrpe-external-master.available', 'squid.available')
+def nrpe_or_squid_unavailable():
+ clear_flag('rutabaga.nrpe-proxy-check.published')
+
+
+@when('website.available', 'rutabaga.configured')
+@when_not('rutabaga.website.published')
+def rutabaga_available():
+ rutabaga = endpoint_from_flag('website.available')
+ publish_website(
+ rutabaga, 'rutabaga', hookenv.config()['port_api'],
+ add_options=['option httpchk /'])
+ set_flag('rutabaga.website.published')
+
+
+@when('rutabaga.website.published')
+@when_not('website.available')
+def rutabaga_unavailable():
+ clear_flag('rutabaga.website.published')
diff --git a/charm/rutabaga/scripts/nrpe/check_rutabaga_proxy b/charm/rutabaga/scripts/nrpe/check_rutabaga_proxy
new file mode 100755
index 0000000..158d270
--- /dev/null
+++ b/charm/rutabaga/scripts/nrpe/check_rutabaga_proxy
@@ -0,0 +1,107 @@
+#! /usr/bin/python3
+
+import argparse
+import json
+from pathlib import Path
+from random import randint
+import sys
+from urllib.parse import urlparse
+from time import sleep
+
+import requests
+
+
+def create_token(username, admin_username, admin_secret, api_url):
+ token_endpoint = f'{api_url}/tokens'
+ payload = json.dumps({'username': username})
+ r = requests.post(
+ token_endpoint, data=payload, auth=(admin_username, admin_secret))
+ if r.status_code != 200:
+ print(f'CRITICAL: Unable to create token: HTTP status {r.status_code}')
+ sys.exit(2)
+ token = r.json()
+ if token['username'] != username:
+ print(
+ f'CRITICAL: Created token with username {username} but got '
+ f'{token["username"]}')
+ sys.exit(2)
+ return token
+
+
+def revoke_token(token, admin_username, admin_secret, api_url):
+ token_endpoint = f'{api_url}/tokens/{token["username"]}'
+ r = requests.delete(token_endpoint, auth=(admin_username, admin_secret))
+ return r.status_code == 200
+
+
+def check_proxy(token, check_url, proxy_url):
+ username = token['username']
+ secret = token['secret']
+ parsed_proxy_url = urlparse(proxy_url)
+ auth_proxy_url = (
+ f'{parsed_proxy_url.scheme}://'
+ f'{username}:{secret}@{parsed_proxy_url.netloc}')
+ proxies = {'http': auth_proxy_url, 'https': auth_proxy_url}
+ return requests.get(check_url, proxies=proxies)
+
+
+def main():
+ parser = argparse.ArgumentParser(
+ description='Check Proxy Auth Integration')
+ parser.add_argument(
+ '--username', dest='username', required=True,
+ help='admin api username prefix + admin api username')
+ parser.add_argument(
+ '--secret-file', dest='secret_file', type=Path, required=True,
+ help='path to file containing admin api secret')
+ parser.add_argument(
+ '--check-url', dest='check_url',
+ default='http://launchpadlibrarian.net/',
+ help='URL for checking proxy passthrough.')
+ parser.add_argument('--proxy-url', dest='proxy_urls', action='append')
+ parser.add_argument(
+ '--api-url', dest='api_url', default='http://localhost:8080/')
+ args = parser.parse_args()
+
+ if not args.proxy_urls:
+ args.proxy_urls = ['http://localhost:3128/']
+
+ admin_secret = args.secret_file.read_text().rstrip()
+ check_url = args.check_url
+
+ token = create_token(
+ f'NAGIOS-{randint(100000, 999999)}',
+ args.username, admin_secret, args.api_url)
+ try:
+ for proxy_url in args.proxy_urls:
+ try:
+ r = check_proxy(token, check_url, proxy_url)
+ if r.status_code != 200:
+ print(
+ f'CRITICAL: Proxy request for {check_url} failed: '
+ f'HTTP status {r.status_code}')
+ sys.exit(2)
+ except requests.exceptions.RequestException as e:
+ print(
+ f'CRITICAL: Proxy request to {proxy_url} for {check_url} '
+ f'failed: {e}')
+ sys.exit(2)
+ finally:
+ if not revoke_token(token, args.username, admin_secret, args.api_url):
+ print('CRITICAL: Failed to revoke proxy token')
+ sys.exit(2)
+
+ sleep(2) # assumes auth_param credentialsttl == 1 second
+ for proxy_url in args.proxy_urls:
+ if check_proxy(token, check_url, proxy_url).status_code == 200:
+ print(
+ f'CRITICAL: Proxy request to {proxy_url} for {check_url} with '
+ f'revoked token succeeded')
+ sys.exit(2)
+
+ print(f'OK: Proxy request for {check_url} succeeded')
+ sys.exit(0)
+
+
+if __name__ == '__main__':
+ main()
diff --git a/charm/rutabaga/templates/admin-secret.j2 b/charm/rutabaga/templates/admin-secret.j2
new file mode 100644
index 0000000..bc61f72
--- /dev/null
+++ b/charm/rutabaga/templates/admin-secret.j2
@@ -0,0 +1,2 @@
+{{ admin_api_secret }}
+
diff --git a/charm/rutabaga/templates/crontab.j2 b/charm/rutabaga/templates/crontab.j2
new file mode 100644
index 0000000..6a969ee
--- /dev/null
+++ b/charm/rutabaga/templates/crontab.j2
@@ -0,0 +1,2 @@
+*/{{ token_purge_minutes }} * * * * root DATABASE={{ database }} TOKEN_TTL_MINUTES={{ token_ttl_minutes }} {{ venv_dir }}/bin/python3 {{ code_dir }}/rutabaga/scripts/purge.py >>{{ logs_dir }}/rutabaga-purge.log 2>&1
+
diff --git a/charm/rutabaga/templates/gunicorn-rutabaga.py.j2 b/charm/rutabaga/templates/gunicorn-rutabaga.py.j2
new file mode 100644
index 0000000..1641b18
--- /dev/null
+++ b/charm/rutabaga/templates/gunicorn-rutabaga.py.j2
@@ -0,0 +1,15 @@
+name = "rutabaga"
+workers = {{ wsgi_workers }}
+worker_class = "sync"
+max_requests = {{ wsgi_max_requests }}
+backlog = {{ wsgi_backlog }}
+timeout = {{ wsgi_timeout }}
+keep_alive = {{ wsgi_keep_alive }}
+bind = ['0.0.0.0:{{ port_api }}']
+accesslog = "{{ logs_dir }}/rutabaga-access.log"
+{% if wsgi_access_log_format -%}
+access_log_format = "{{ wsgi_access_log_format }}"
+{% endif -%}
+errorlog = "{{ logs_dir }}/rutabaga-error.log"
+log_level = "{{ wsgi_error_log_level }}"
+
diff --git a/charm/rutabaga/templates/logrotate.conf.j2 b/charm/rutabaga/templates/logrotate.conf.j2
new file mode 100644
index 0000000..711c01e
--- /dev/null
+++ b/charm/rutabaga/templates/logrotate.conf.j2
@@ -0,0 +1,23 @@
+{{ logs_dir }}/rutabaga-access.log {{ logs_dir }}/rutabaga-error.log {
+ rotate 90
+ daily
+ dateext
+ delaycompress
+ compress
+ missingok
+ create 0644 {{ user }} {{ group }}
+ postrotate
+ systemctl restart rutabaga-api.service
+ endscript
+}
+
+{{ logs_dir }}/rutabaga-purge.log {
+ rotate 90
+ daily
+ dateext
+ delaycompress
+ compress
+ missingok
+ create 0644 {{ user }} {{ group }}
+}
+
diff --git a/charm/rutabaga/templates/rsync.j2 b/charm/rutabaga/templates/rsync.j2
new file mode 100644
index 0000000..9df1486
--- /dev/null
+++ b/charm/rutabaga/templates/rsync.j2
@@ -0,0 +1,8 @@
+
+[rutabaga-logs]
+ path = {{ base_dir }}/logs
+ comment = Rutabaga Logs
+ list = false
+ read only = true
+ hosts allow = {{ log_hosts_allow }}
+
diff --git a/charm/rutabaga/templates/rutabaga-api.service.j2 b/charm/rutabaga/templates/rutabaga-api.service.j2
new file mode 100644
index 0000000..194e5b4
--- /dev/null
+++ b/charm/rutabaga/templates/rutabaga-api.service.j2
@@ -0,0 +1,21 @@
+[Unit]
+Description=Rutabaga API server
+After=network.target
+
+[Service]
+User={{ user }}
+Group={{ group }}
+WorkingDirectory={{ code_dir }}
+Environment=PATH={{ venv_dir }}/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
+Environment=ADMIN_API_USERNAME_PREFIX={{ admin_api_username_prefix }}
+Environment=ADMIN_API_USERNAME={{ admin_api_username }}
+Environment=DATABASE={{ db_dir }}/rutabaga.db
+Environment=TOKEN_TTL_MINUTES={{ token_ttl_minutes }}
+ExecStart={{ venv_dir }}/bin/gunicorn --config {{ config_file }} --paste rutabaga.ini
+ExecReload=/bin/kill -s HUP $MAINPID
+ExecStop=/bin/kill -s TERM $MAINPID
+PrivateTmp=true
+
+[Install]
+WantedBy=multi-user.target
+
diff --git a/charm/rutabaga/wheelhouse.txt b/charm/rutabaga/wheelhouse.txt
new file mode 100644
index 0000000..5500f00
--- /dev/null
+++ b/charm/rutabaga/wheelhouse.txt
@@ -0,0 +1 @@
+PyYAML
diff --git a/docs/index.rst b/docs/index.rst
index b2dfd97..80c28df 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -23,7 +23,7 @@ a data payload, or software dependencies.
Squid Addon Helper
##################
-Rutabaga's `squid helper <https://git.launchpad.net/rutabaga/tree/rutabaga/scripts/rutabaga_auth_helper.py>`_ conforms to the squid addon helper `basic auth protocol
+Rutabaga's `squid helper <https://git.launchpad.net/rutabaga/tree/charm/rutabaga-auth-helper/scripts/rutabaga_auth_helper.py>`_ conforms to the squid addon helper `basic auth protocol
<http://wiki.squid-cache.org/Features/AddonHelpers#Basic_Scheme>`_.
Search
