diff --git a/.dockerignore b/.dockerignore
new file mode 100644
index 0000000..629ad03
--- /dev/null
+++ b/.dockerignore
@@ -0,0 +1,8 @@
+
+.git
+
+**/*~
+**/target/
+**/nb-configuration.xml
+guacamole/customs.json
+
diff --git a/.drone.yml b/.drone.yml
new file mode 100644
index 0000000..91ff66f
--- /dev/null
+++ b/.drone.yml
@@ -0,0 +1,32 @@
+kind: pipeline
+type: kubernetes
+name: default
+
+node_selector:
+ physical-node: dev1
+
+trigger:
+ event:
+ - push
+workspace:
+ path: /drone/src
+
+steps:
+ - name: pull image to dockerhub
+ image: docker.io/owncloudci/drone-docker-buildx:4
+ privileged: true
+ settings:
+ cache-from: [ "safebox/guacamole-tomcat" ]
+ repo: safebox/guacamole-tomcat
+ dockerfile: Dockerfile.alpine
+ tags: latest
+ username:
+ from_secret: dockerhub-username
+ password:
+ from_secret: dockerhub-password
+ platforms:
+ - linux/amd64
+ - linux/arm64
+ when:
+ event:
+ - push
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..bcc52fe
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+*~
+target/
diff --git a/.ratignore b/.ratignore
new file mode 100644
index 0000000..eac248a
--- /dev/null
+++ b/.ratignore
@@ -0,0 +1,5 @@
+.github/**
+CONTRIBUTING
+doc/licenses/*/**/*
+doc/**/html/*.html
+guacamole-docker/*.pref
diff --git a/CONTRIBUTING b/CONTRIBUTING
new file mode 100644
index 0000000..9f005cd
--- /dev/null
+++ b/CONTRIBUTING
@@ -0,0 +1,52 @@
+
+------------------------------------------------------------
+ Contributing to Apache Guacamole
+------------------------------------------------------------
+
+Thank you for contributing to the Apache Guacamole project!
+
+There are certain procedures that must be followed for all contributions. These
+procedures are necessary to allow us to allocate resources for reviewing and
+testing your contribution, as well as communicate effectively with you during
+the review process.
+
+1) Create an issue in our JIRA
+
+ All changes to Guacamole must have corresponding issues in JIRA so the
+ change can be properly tracked:
+
+ https://issues.apache.org/jira/browse/GUACAMOLE/
+
+ If you do not already have an account on the Apache Software Foundation's
+ JIRA, you will need to create one before creating your new issue.
+
+2) Make and test your changes locally
+
+ The Guacamole source is maintained in git repositories hosted on GitHub:
+
+ https://github.com/apache/guacamole-client
+ https://github.com/apache/guacamole-manual
+ https://github.com/apache/guacamole-server
+ https://github.com/apache/guacamole-website
+
+ To make your changes, fork the applicable repositories and make commits
+ to a topic branch in your fork. Commits should be made in logical units
+ and must reference the JIRA issue number:
+
+ $ git commit -m "GUACAMOLE-123: High-level message describing the changes."
+
+ Avoid commits which cover multiple, distinct goals that could (and should)
+ be handled separately.
+
+ If you do not already have an account on GitHub, you will need to create
+ one before making your changes.
+
+3) Submit your changes via a pull request on GitHub
+
+ Once your changes are ready, submit them by creating a pull request for
+ the corresponding topic branch you created when you began working on your
+ changes.
+
+ The Guacamole team will then review your changes and, if they pass review,
+ your changes will be merged.
+
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000..991f918
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,106 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+#
+# Dockerfile for guacamole-client
+#
+
+# Use args for Tomcat image label to allow image builder to choose alternatives
+# such as `--build-arg TOMCAT_JRE=jre8-alpine`
+#
+ARG TOMCAT_VERSION=9
+ARG TOMCAT_JRE=jdk21
+
+# Use official maven image for the build
+FROM maven:3-eclipse-temurin-21 AS builder
+
+# Use Mozilla's Firefox PPA (newer Ubuntu lacks a "firefox-esr" package and
+# provides only a transitional "firefox" package that actually requires Snap
+# and thus can't be used within Docker)
+RUN apt-get update \
+ && apt-get upgrade -y \
+ && apt-get install -y software-properties-common \
+ && add-apt-repository -y ppa:mozillateam/ppa
+
+# Explicitly prefer packages from the Firefox PPA
+COPY guacamole-docker/mozilla-firefox.pref /etc/apt/preferences.d/
+
+# Install firefox browser for sake of JavaScript unit tests
+RUN apt-get update && apt-get install -y firefox
+
+# Arbitrary arguments that can be passed to the maven build. By default, an
+# argument will be provided to explicitly unskip any skipped tests. To, for
+# example, allow the building of the RADIUS auth extension, pass a build profile
+# as well: `--build-arg MAVEN_ARGUMENTS="-P lgpl-extensions -DskipTests=false"`.
+ARG MAVEN_ARGUMENTS="-DskipTests=false"
+
+# Versions of JDBC drivers to bundle within image
+ARG MSSQL_JDBC_VERSION=9.4.1
+ARG MYSQL_JDBC_VERSION=8.3.0
+ARG PGSQL_JDBC_VERSION=42.7.2
+
+# Build environment variables
+ENV \
+ BUILD_DIR=/tmp/guacamole-docker-BUILD
+
+# Add configuration scripts
+COPY guacamole-docker/bin/ /opt/guacamole/bin/
+COPY guacamole-docker/build.d/ /opt/guacamole/build.d/
+COPY guacamole-docker/entrypoint.d/ /opt/guacamole/entrypoint.d/
+COPY guacamole-docker/environment/ /opt/guacamole/environment/
+
+# Copy source to container for sake of build
+COPY . "$BUILD_DIR"
+
+# Run the build itself
+RUN /opt/guacamole/bin/build-guacamole.sh "$BUILD_DIR" /opt/guacamole
+
+RUN rm -rf /opt/guacamole/build.d /opt/guacamole/bin/build-guacamole.sh
+
+# For the runtime image, we start with the official Tomcat distribution
+FROM tomcat:${TOMCAT_VERSION}-${TOMCAT_JRE}
+
+# Install XMLStarlet for server.xml alterations
+RUN apt-get update -qq \
+ && apt-get install -y xmlstarlet \
+ && rm -rf /var/lib/apt/lists/*
+
+# This is where the build artifacts go in the runtime image
+WORKDIR /opt/guacamole
+
+# Copy artifacts from builder image into this image
+COPY --from=builder /opt/guacamole/ .
+
+# Create a new user guacamole
+ARG UID=1001
+ARG GID=1001
+RUN groupadd --gid $GID guacamole
+RUN useradd --system --create-home --shell /usr/sbin/nologin --uid $UID --gid $GID guacamole
+
+# Run with user guacamole
+USER guacamole
+
+# Environment variable defaults
+ENV BAN_ENABLED=true \
+ ENABLE_FILE_ENVIRONMENT_PROPERTIES=true \
+ GUACAMOLE_HOME=/etc/guacamole
+
+# Start Guacamole under Tomcat, listening on 0.0.0.0:8080
+EXPOSE 8080
+CMD ["/opt/guacamole/bin/entrypoint.sh" ]
diff --git a/Dockerfile.alpine b/Dockerfile.alpine
new file mode 100644
index 0000000..d506c53
--- /dev/null
+++ b/Dockerfile.alpine
@@ -0,0 +1,122 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+#
+# Dockerfile for guacamole-client
+#
+
+# Use args for Tomcat image label to allow image builder to choose alternatives
+# such as `--build-arg TOMCAT_JRE=jre8-alpine`
+#
+ARG TOMCAT_VERSION=9
+ARG TOMCAT_JRE=jdk21
+
+# Use official maven image for the build
+FROM maven:3-eclipse-temurin-21 AS builder
+
+# Use Mozilla's Firefox PPA (newer Ubuntu lacks a "firefox-esr" package and
+# provides only a transitional "firefox" package that actually requires Snap
+# and thus can't be used within Docker)
+RUN apt-get update \
+ && apt-get upgrade -y \
+ && apt-get install -y software-properties-common \
+ && add-apt-repository -y ppa:mozillateam/ppa
+
+# Explicitly prefer packages from the Firefox PPA
+COPY guacamole-docker/mozilla-firefox.pref /etc/apt/preferences.d/
+
+# Install firefox browser for sake of JavaScript unit tests
+RUN apt-get update && apt-get install -y firefox
+
+# Arbitrary arguments that can be passed to the maven build. By default, an
+# argument will be provided to explicitly unskip any skipped tests. To, for
+# example, allow the building of the RADIUS auth extension, pass a build profile
+# as well: `--build-arg MAVEN_ARGUMENTS="-P lgpl-extensions -DskipTests=false"`.
+ARG MAVEN_ARGUMENTS="-DskipTests=false"
+
+# Versions of JDBC drivers to bundle within image
+ARG MSSQL_JDBC_VERSION=9.4.1
+ARG MYSQL_JDBC_VERSION=8.3.0
+ARG PGSQL_JDBC_VERSION=42.7.2
+
+# Build environment variables
+ENV \
+ BUILD_DIR=/tmp/guacamole-docker-BUILD
+
+# Add configuration scripts
+COPY guacamole-docker/bin/ /opt/guacamole/bin/
+COPY guacamole-docker/build.d/ /opt/guacamole/build.d/
+COPY guacamole-docker/entrypoint.d/ /opt/guacamole/entrypoint.d/
+COPY guacamole-docker/environment/ /opt/guacamole/environment/
+
+# Copy source to container for sake of build
+COPY . "$BUILD_DIR"
+
+# Run the build itself
+RUN /opt/guacamole/bin/build-guacamole.sh "$BUILD_DIR" /opt/guacamole
+
+RUN rm -rf /opt/guacamole/build.d /opt/guacamole/bin/build-guacamole.sh
+
+# For the runtime image, we start with the official Tomcat distribution
+
+RUN ls -al /opt/guacamole/
+
+FROM alpine
+
+COPY --from=builder /opt/guacamole /opt/guacamole
+
+RUN ls -al /
+
+ENV TOMCAT_MAJOR=9 \
+ TOMCAT_VERSION=9.0.78 \
+ CATALINA_HOME=/opt/guacamole
+
+RUN \
+ apk add --update --no-cache \
+ openjdk8-jre curl mariadb-client bash openssl && \
+ curl -jkSL -o /tmp/apache-tomcat.tar.gz \
+ http://archive.apache.org/dist/tomcat/tomcat-${TOMCAT_MAJOR}/v${TOMCAT_VERSION}/bin/apache-tomcat-${TOMCAT_VERSION}.tar.gz && \
+ gunzip /tmp/apache-tomcat.tar.gz && \
+ tar -C /opt -xf /tmp/apache-tomcat.tar && \
+ ln -s /opt/apache-tomcat-$TOMCAT_VERSION /usr/local/tomcat && \
+ chmod -R a+rx /usr/local/tomcat/
+
+# cleanup
+RUN apk del curl && \
+ rm -rf /tmp/* /var/cache/apk/* /usr/local/tomcat/webapps/*
+
+
+# Create a new user guacamole
+COPY /start.sh /opt/guacamole/bin/
+RUN chmod a+x /opt/guacamole/bin/start.sh
+ARG UID=1001
+ARG GID=1001
+RUN addgroup -g $GID guacamole
+RUN adduser -S -D -s /usr/sbin/nologin -u $UID guacamole --ingroup guacamole
+
+# Run with user guacamole
+USER guacamole
+
+EXPOSE 8080
+
+WORKDIR $CATALINA_HOME
+
+# Start Guacamole under Tomcat, listening on 0.0.0.0:8080
+EXPOSE 8080
+CMD ["/opt/guacamole/bin/start.sh"]
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..3fa304c
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,293 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+
+==============================================================================
+
+APACHE GUACAMOLE SUBCOMPONENTS
+
+Apache Guacamole includes a number of subcomponents with separate copyright
+notices and license terms. Your use of these subcomponents is subject to the
+terms and conditions of the following licenses.
+
+
+Carlito (http://code.google.com/p/chromium/issues/detail?id=280557)
+-------------------------------------------------------------------
+
+ Version: N/A
+ From: 'tyPoland Lukasz Dziedzic' (http://www.lukaszdziedzic.eu/)
+ License(s):
+ SIL Open Font (guacamole/src/licenses/bundled/carlito/LICENSE)
+
+
+DuoWeb Java SDK (https://github.com/duosecurity/duo_java)
+---------------------------------------------------------
+
+ Verson: commit 56570d18a1f98642500e6c1158a3f41e448963ff
+ From: `Duo Security, Inc.' (https://duo.com/)
+ License(s):
+ BSD 3-clause (extensions/guacamole-auth-duo/src/licenses/bundled/duo-java-56570d1/LICENSE)
+
+Copyright (c) 2011, Duo Security, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+3. The name of the author may not be used to endorse or promote products
+ derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+TOTP Reference Implementation (https://tools.ietf.org/id/draft-mraihi-totp-timebased-07.html#Section-Reference-Impl)
+-------------------------------------------------------------------------------
+
+ Verson: 07
+ From: 'IETF Trust' (http://trustee.ietf.org/license-info)
+ License(s):
+ BSD 3-clause (extensions/guacamole-auth-duo/src/licenses/bundled/totp-reference-impl-07/license.txt)
+
+Copyright (c) 2011 IETF Trust and the persons identified as authors
+of the code. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ - Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+ - Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ - Neither the name of Internet Society, IETF or IETF Trust, nor the names
+ of specific contributors, may be used to endorse or promote products
+ derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS”
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
diff --git a/NOTICE b/NOTICE
new file mode 100644
index 0000000..b0fa030
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,5 @@
+Apache Guacamole
+Copyright 2020 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (https://www.apache.org/).
diff --git a/doc/guacamole-branding-example/README b/doc/guacamole-branding-example/README
new file mode 100644
index 0000000..8e78242
--- /dev/null
+++ b/doc/guacamole-branding-example/README
@@ -0,0 +1,18 @@
+This directory structure provides an example of how to apply custom branding
+and HTML extension to the Guacamole Client web application. This makes use
+of the guac-manifest.json file to specify the resources that are being provided,
+and provides examples of changing colors, fonts, and the login screen logo for
+the application.
+
+To use this, you need only to zip the file up into a JAR file, place it in the
+GUACAMOLE_HOME/extensions folder, and reload the web application. For example:
+
+zip -r /tmp/guacamole-branding-example.jar ./
+mv /tmp/guacamole-branding-example.jar /etc/guacamole/extensions/
+touch /var/lib/tomcat/webapps/guacamole.war
+
+These commands assume that your current working directory is this example
+directory, that your GUACAMOLE_HOME is located at /etc/guacamole, and that your
+the Guacamole Client web application is deployed in the /var/lib/tomcat/webapps
+directory with the name "guacamole.war". You should adjust the commands to fit
+your installation and environment.
\ No newline at end of file
diff --git a/doc/guacamole-branding-example/css/0-font-raleway.css b/doc/guacamole-branding-example/css/0-font-raleway.css
new file mode 100644
index 0000000..aed6c4e
--- /dev/null
+++ b/doc/guacamole-branding-example/css/0-font-raleway.css
@@ -0,0 +1,54 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+@font-face {
+ font-family: 'Raleway';
+ font-weight: normal;
+ font-style: normal;
+ src: url('app/ext/guacamole-branding-example/resources/fonts/raleway/Raleway-Regular.woff') format('woff'),
+ url('app/ext/guacamole-branding-example/resources/fonts/raleway/Raleway-Regular.otf') format('opentype'),
+ url('app/ext/guacamole-branding-example/resources/fonts/raleway/Raleway-Regular.ttf') format('ttf');
+}
+
+@font-face {
+ font-family: 'Raleway';
+ font-weight: bold;
+ font-style: normal;
+ src: url('app/ext/guacamole-branding-example/resources/fonts/raleway/Raleway-Bold.woff') format('woff'),
+ url('app/ext/guacamole-branding-example/resources/fonts/raleway/Raleway-Bold.otf') format('opentype'),
+ url('app/ext/guacamole-branding-example/resources/fonts/raleway/Raleway-Bold.ttf') format('ttf');
+}
+
+@font-face {
+ font-family: 'Raleway';
+ font-weight: normal;
+ font-style: italic;
+ src: url('app/ext/guacamole-branding-example/resources/fonts/raleway/Raleway-Italic.woff') format('woff'),
+ url('app/ext/guacamole-branding-example/resources/fonts/raleway/Raleway-Italic.otf') format('opentype'),
+ url('app/ext/guacamole-branding-example/resources/fonts/raleway/Raleway-Italic.ttf') format('ttf');
+}
+
+@font-face {
+ font-family: 'Raleway';
+ font-weight: bold;
+ font-style: italic;
+ src: url('app/ext/guacamole-branding-example/resources/fonts/raleway/Raleway-BoldItalic.woff') format('woff'),
+ url('app/ext/guacamole-branding-example/resources/fonts/raleway/Raleway-BoldItalic.otf') format('opentype'),
+ url('app/ext/guacamole-branding-example/resources/fonts/raleway/Raleway-BoldItalic.ttf') format('ttf');
+}
diff --git a/doc/guacamole-branding-example/css/example.css b/doc/guacamole-branding-example/css/example.css
new file mode 100644
index 0000000..a3f0cba
--- /dev/null
+++ b/doc/guacamole-branding-example/css/example.css
@@ -0,0 +1,118 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * Changes the font of the login dialog to prefer Raleway, with some fallbacks.
+ */
+.login-ui .login-dialog .login-fields input {
+ font-family: Raleway, FreeSans, Helvetica, Arial, sans-serif;
+}
+
+/**
+ * Set up the logo used at the top of the login dialog box, including sizing it
+ * appropriately and pulling in the custom image.
+ */
+.login-ui .login-dialog .logo {
+ width: 5em;
+ height: 3em;
+ background-size: 5em 3em;
+ -moz-background-size: 5em 3em;
+ -webkit-background-size: 5em 3em;
+ -khtml-background-size: 5em 3em;
+ background-image: url('app/ext/guacamole-branding-example/resources/images/saturn/saturn.png');
+}
+
+/*
+ * For our custom warning code, specify the font order, as well as the italic
+ * style, and size it down a little.
+ */
+.login-ui .login-dialog .warning {
+ font-family: Raleway, FreeSans, Arial;
+ font-style: italic;
+ font-size: 0.75em;
+}
+
+/*
+ * Sets up the custom coloring around the header elements.
+ */
+.header {
+ border-bottom: 1px solid rgba(0,0,0,1.0);
+ box-shadow: rgba(0,0,0,0.75);
+ background: rgba(0,0,0,1.0);
+ color: rgba(255,255,255,1.0);
+}
+
+/*
+ * Changes the default color and fonts of the submit buttons, along with font
+ * size and weight.
+ */
+input[type="submit"], button, a.button {
+ background-color: rgba(0,145,255,1.0);
+ border: 1px solid rgba(0,255,145,1.1);
+ font-size: 1em;
+ font-weight: bold;
+ font-family: Raleway, FreeSans, Helvetica, Arial, sans-serif;
+}
+
+/*
+ * Changes the coloring on the submit-styled buttons when you hover over them.
+ */
+input[type="submit"]:hover, button:hover, a.button:hover {
+ background-color: rgba(0,255,145,1.0);
+ border: 1px solid rgba(0,145,255,1.0);
+}
+
+/*
+ * Changes the coloring on the submit-styled buttons when you click on them.
+ */
+input[type="submit"]:active, button:active, a.button:active {
+ background-color: rgba(0,145,255,1.0);
+ border: 1px solid rgba(255,95,0,1.0);
+}
+
+/*
+ * Provide a custom color scheme for danger-styled buttons.
+ */
+button.danger, a.button.danger {
+ background: rgba(255,95,0,1.0);
+ border: 1px solid rgba(255,0,0,1.0);
+}
+
+/*
+ * Provide a cusotm color scheme for hovering over danger-styled buttons.
+ */
+button.danger:hover, a.button.danger:hover {
+ background: rgba(255,0,0,0.75);
+ border: 1px solid rgba(255,95,0,1.0);
+}
+
+/*
+ * Provide a custom color scheme for danger-styled buttons when clicked.
+ */
+button.danger:active, a.button.danger:active {
+ background: rgba(255,0,170,1.0);
+ border: 1px solid rgba(255,95,0,1.0);
+}
+
+/*
+ * Change the default font order of preference across the entire interface.
+ */
+body {
+ font-family: Raleway, FreeSans, Helvetica, Arial, sans-serif;
+}
\ No newline at end of file
diff --git a/doc/guacamole-branding-example/guac-manifest.json b/doc/guacamole-branding-example/guac-manifest.json
new file mode 100644
index 0000000..78192d3
--- /dev/null
+++ b/doc/guacamole-branding-example/guac-manifest.json
@@ -0,0 +1,34 @@
+{
+ "guacamoleVersion" : "*",
+ "name" : "Guacamole Branding Example",
+ "namespace" : "guacamole-branding-example",
+
+ "css" : [
+ "css/0-font-raleway.css",
+ "css/example.css"
+ ],
+
+ "html" : [
+ "html/warning.html"
+ ],
+
+ "resources" : {
+ "resources/fonts/raleway/Raleway-Bold.otf" : "application/x-font-opentype",
+ "resources/fonts/raleway/Raleway-Bold.ttf" : "application/x-font-TrueType",
+ "resources/fonts/raleway/Raleway-Bold.woff" : "application/font-woff",
+ "resources/fonts/raleway/Raleway-BoldItalic.otf" : "application/x-font-opentype",
+ "resources/fonts/raleway/Raleway-BoldItalic.ttf" : "application/x-font-TrueType",
+ "resources/fonts/raleway/Raleway-BoldItalic.woff" : "application/font-woff",
+ "resources/fonts/raleway/Raleway-Italic.otf" : "application/x-font-opentype",
+ "resources/fonts/raleway/Raleway-Italic.ttf" : "application/x-font-TrueType",
+ "resources/fonts/raleway/Raleway-Italic.woff" : "application/font-woff",
+ "resources/fonts/raleway/Raleway-Regular.otf" : "application/x-font-opentype",
+ "resources/fonts/raleway/Raleway-Regular.ttf" : "application/x-font-TrueType",
+ "resources/fonts/raleway/Raleway-Regular.woff" : "application/font-woff",
+ "resources/images/saturn/saturn.png" : "image/png"
+ },
+
+ "translations" : [
+ "translations/en.json"
+ ]
+}
diff --git a/doc/guacamole-branding-example/html/warning.html b/doc/guacamole-branding-example/html/warning.html
new file mode 100644
index 0000000..b1b72b3
--- /dev/null
+++ b/doc/guacamole-branding-example/html/warning.html
@@ -0,0 +1,8 @@
+
+Beware of entering Saturn's gravitational field.
+ Few who enter it ever escape.
diff --git a/doc/guacamole-branding-example/licenses/LICENSE b/doc/guacamole-branding-example/licenses/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/doc/guacamole-branding-example/licenses/LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/doc/guacamole-branding-example/licenses/NOTICE b/doc/guacamole-branding-example/licenses/NOTICE
new file mode 100644
index 0000000..b0fa030
--- /dev/null
+++ b/doc/guacamole-branding-example/licenses/NOTICE
@@ -0,0 +1,5 @@
+Apache Guacamole
+Copyright 2020 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (https://www.apache.org/).
diff --git a/doc/guacamole-branding-example/resources/fonts/raleway/LICENSE b/doc/guacamole-branding-example/resources/fonts/raleway/LICENSE
new file mode 100644
index 0000000..3219811
--- /dev/null
+++ b/doc/guacamole-branding-example/resources/fonts/raleway/LICENSE
@@ -0,0 +1,95 @@
+Copyright (c) 2010, Matt McInerney (matt@pixelspread.com),
+Copyright (c) 2011, Pablo Impallari (www.impallari.com|impallari@gmail.com),
+Copyright (c) 2011, Rodrigo Fuenzalida (www.rfuenzalida.com|hello@rfuenzalida.com), with Reserved Font Name Raleway
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Bold.otf b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Bold.otf
new file mode 100644
index 0000000..b6c56b3
Binary files /dev/null and b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Bold.otf differ
diff --git a/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Bold.ttf b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Bold.ttf
new file mode 100644
index 0000000..156d4a1
Binary files /dev/null and b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Bold.ttf differ
diff --git a/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Bold.woff b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Bold.woff
new file mode 100644
index 0000000..39edd00
Binary files /dev/null and b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Bold.woff differ
diff --git a/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-BoldItalic.otf b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-BoldItalic.otf
new file mode 100644
index 0000000..27dd342
Binary files /dev/null and b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-BoldItalic.otf differ
diff --git a/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-BoldItalic.ttf b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-BoldItalic.ttf
new file mode 100644
index 0000000..d2db573
Binary files /dev/null and b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-BoldItalic.ttf differ
diff --git a/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-BoldItalic.woff b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-BoldItalic.woff
new file mode 100644
index 0000000..49fb336
Binary files /dev/null and b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-BoldItalic.woff differ
diff --git a/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Italic.otf b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Italic.otf
new file mode 100644
index 0000000..48186de
Binary files /dev/null and b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Italic.otf differ
diff --git a/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Italic.ttf b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Italic.ttf
new file mode 100644
index 0000000..a0157a5
Binary files /dev/null and b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Italic.ttf differ
diff --git a/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Italic.woff b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Italic.woff
new file mode 100644
index 0000000..48f8a74
Binary files /dev/null and b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Italic.woff differ
diff --git a/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Regular.otf b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Regular.otf
new file mode 100644
index 0000000..52cc33d
Binary files /dev/null and b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Regular.otf differ
diff --git a/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Regular.ttf b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Regular.ttf
new file mode 100644
index 0000000..746c242
Binary files /dev/null and b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Regular.ttf differ
diff --git a/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Regular.woff b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Regular.woff
new file mode 100644
index 0000000..8773be7
Binary files /dev/null and b/doc/guacamole-branding-example/resources/fonts/raleway/Raleway-Regular.woff differ
diff --git a/doc/guacamole-branding-example/resources/images/saturn/LICENSE b/doc/guacamole-branding-example/resources/images/saturn/LICENSE
new file mode 100644
index 0000000..56620b5
--- /dev/null
+++ b/doc/guacamole-branding-example/resources/images/saturn/LICENSE
@@ -0,0 +1,229 @@
+Credit: Erich Karkoschka (University of Arizona) and NASA
+
+THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS
+PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR
+OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS
+LICENSE OR COPYRIGHT LAW IS PROHIBITED.
+
+BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE
+BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED
+HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.
+
+1. Definitions
+
+a. "Collective Work" means a work, such as a periodical issue, anthology or
+encyclopedia, in which the Work in its entirety in unmodified form, along with a
+number of other contributions, constituting separate and independent works in
+themselves, are assembled into a collective whole. A work that constitutes a
+Collective Work will not be considered a Derivative Work (as defined below)
+for the purposes of this License.
+
+b. "Derivative Work" means a work based upon the Work or upon the Work and other
+pre-existing works, such as a translation, musical arrangement, dramatization,
+fictionalization, motion picture version, sound recording, art reproduction,
+abridgment, condensation, or any other form in which the Work may be recast,
+transformed, or adapted, except that a work that constitutes a Collective Work
+will not be considered a Derivative Work for the purpose of this License. For
+the avoidance of doubt, where the Work is a musical composition or sound
+recording, the synchronization of the Work in timed-relation with a moving image
+("synching") will be considered a Derivative Work for the purpose of this
+License.
+
+c. "Licensor" means the individual or entity that offers the Work under the
+terms of this License.
+
+d. "Original Author" means the individual or entity who created the Work.
+
+e. "Work" means the copyrightable work of authorship offered under the terms of
+this License.
+
+f. "You" means an individual or entity exercising rights under this License who
+has not previously violated the terms of this License with respect to the Work,
+or who has received express permission from the Licensor to exercise rights
+under this License despite a previous violation.
+
+g. "License Elements" means the following high-level license attributes as
+selected by Licensor and indicated in the title of this License: Attribution,
+Noncommercial, ShareAlike.
+
+2. Fair Use Rights. Nothing in this license is intended to reduce, limit, or
+restrict any rights arising from fair use, first sale or other limitations on
+the exclusive rights of the copyright owner under copyright law or other
+applicable laws.
+
+3. License Grant. Subject to the terms and conditions of this License, Licensor
+hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the
+duration of the applicable copyright) license to exercise the rights in the Work
+as stated below:
+
+a. to reproduce the Work, to incorporate the Work into one or more Collective
+Works, and to reproduce the Work as incorporated in the Collective Works;
+
+b. to create and reproduce Derivative Works;
+
+c. to distribute copies or phonorecords of, display publicly, perform publicly,
+and perform publicly by means of a digital audio transmission the Work including
+as incorporated in Collective Works;
+
+d. to distribute copies or phonorecords of, display publicly, perform publicly,
+and perform publicly by means of a digital audio transmission Derivative Works;
+
+The above rights may be exercised in all media and formats whether now known or
+hereafter devised. The above rights include the right to make such modifications
+as are technically necessary to exercise the rights in other media and formats.
+All rights not expressly granted by Licensor are hereby reserved, including but
+not limited to the rights set forth in Sections 4(e) and 4(f).
+
+4. Restrictions.The license granted in Section 3 above is expressly made subject
+to and limited by the following restrictions:
+
+a. You may distribute, publicly display, publicly perform, or publicly digitally
+perform the Work only under the terms of this License, and You must include a
+copy of, or the Uniform Resource Identifier for, this License with every copy or
+phonorecord of the Work You distribute, publicly display, publicly perform, or
+publicly digitally perform. You may not offer or impose any terms on the Work
+that alter or restrict the terms of this License or the recipients' exercise of
+the rights granted hereunder. You may not sublicense the Work. You must keep
+intact all notices that refer to this License and to the disclaimer of
+warranties. You may not distribute, publicly display, publicly perform, or
+publicly digitally perform the Work with any technological measures that control
+access or use of the Work in a manner inconsistent with the terms of this
+License Agreement. The above applies to the Work as incorporated in a Collective
+Work, but this does not require the Collective Work apart from the Work itself
+to be made subject to the terms of this License. If You create a Collective
+Work, upon notice from any Licensor You must, to the extent practicable, remove
+from the Collective Work any reference to such Licensor or the Original Author,
+as requested. If You create a Derivative Work, upon notice from any Licensor You
+must, to the extent practicable, remove from the Derivative Work any reference
+to such Licensor or the Original Author, as requested.
+
+b. You may distribute, publicly display, publicly perform, or publicly digitally
+perform a Derivative Work only under the terms of this License, a later version
+of this License with the same License Elements as this License, or a Creative
+Commons iCommons license that contains the same License Elements as this License
+(e.g. Attribution-NonCommercial-ShareAlike 2.0 Japan). You must include a copy
+of, or the Uniform Resource Identifier for, this License or other license
+specified in the previous sentence with every copy or phonorecord of each
+Derivative Work You distribute, publicly display, publicly perform, or publicly
+digitally perform. You may not offer or impose any terms on the Derivative Works
+that alter or restrict the terms of this License or the recipients' exercise of
+the rights granted hereunder, and You must keep intact all notices that refer to
+this License and to the disclaimer of warranties. You may not distribute,
+publicly display, publicly perform, or publicly digitally perform the Derivative
+Work with any technological measures that control access or use of the Work in a
+manner inconsistent with the terms of this License Agreement. The above applies
+to the Derivative Work as incorporated in a Collective Work, but this does not
+require the Collective Work apart from the Derivative Work itself to be made
+subject to the terms of this License.
+
+c. You may not exercise any of the rights granted to You in Section 3 above in
+any manner that is primarily intended for or directed toward commercial
+advantage or private monetary compensation. The exchange of the Work for other
+copyrighted works by means of digital file-sharing or otherwise shall not be
+considered to be intended for or directed toward commercial advantage or private
+monetary compensation, provided there is no payment of any monetary compensation
+in connection with the exchange of copyrighted works.
+
+d. If you distribute, publicly display, publicly perform, or publicly digitally
+perform the Work or any Derivative Works or Collective Works, You must keep
+intact all copyright notices for the Work and give the Original Author credit
+reasonable to the medium or means You are utilizing by conveying the name (or
+pseudonym if applicable) of the Original Author if supplied; the title of the
+Work if supplied; to the extent reasonably practicable, the Uniform Resource
+Identifier, if any, that Licensor specifies to be associated with the Work,
+unless such URI does not refer to the copyright notice or licensing information
+for the Work; and in the case of a Derivative Work, a credit identifying the use
+of the Work in the Derivative Work (e.g., "French translation of the Work by
+Original Author," or "Screenplay based on original Work by Original Author").
+Such credit may be implemented in any reasonable manner; provided, however, that
+in the case of a Derivative Work or Collective Work, at a minimum such credit
+will appear where any other comparable authorship credit appears and in a manner
+at least as prominent as such other comparable authorship credit.
+
+e. For the avoidance of doubt, where the Work is a musical composition:
+
+i. Performance Royalties Under Blanket Licenses. Licensor reserves the exclusive
+right to collect, whether individually or via a performance rights society
+(e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital
+performance (e.g. webcast) of the Work if that performance is primarily intended
+for or directed toward commercial advantage or private monetary compensation.
+
+ii. Mechanical Rights and Statutory Royalties. Licensor reserves the exclusive
+right to collect, whether individually or via a music rights agency or
+designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You
+create from the Work ("cover version") and distribute, subject to the compulsory
+license created by 17 USC Section 115 of the US Copyright Act (or the equivalent
+in other jurisdictions), if Your distribution of such cover version is primarily
+intended for or directed toward commercial advantage or private monetary
+compensation.
+
+f. Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where
+the Work is a sound recording, Licensor reserves the exclusive right to collect,
+whether individually or via a performance-rights society (e.g. SoundExchange),
+royalties for the public digital performance (e.g. webcast) of the Work, subject
+to the compulsory license created by 17 USC Section 114 of the US Copyright Act
+(or the equivalent in other jurisdictions), if Your public digital performance
+is primarily intended for or directed toward commercial advantage or private
+monetary compensation.
+
+5. Representations, Warranties and Disclaimer
+
+UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS
+THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING
+THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT
+LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR
+PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY,
+OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME
+JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH
+EXCLUSION MAY NOT APPLY TO YOU.
+
+6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN
+NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL,
+INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS
+LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+7. Termination
+
+a. This License and the rights granted hereunder will terminate automatically
+upon any breach by You of the terms of this License. Individuals or entities who
+have received Derivative Works or Collective Works from You under this License,
+however, will not have their licenses terminated provided such individuals or
+entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7,
+and 8 will survive any termination of this License.
+
+b. Subject to the above terms and conditions, the license granted here is
+perpetual (for the duration of the applicable copyright in the Work).
+Notwithstanding the above, Licensor reserves the right to release the Work under
+different license terms or to stop distributing the Work at any time; provided,
+however that any such election will not serve to withdraw this License (or any
+other license that has been, or is required to be, granted under the terms of
+this License), and this License will continue in full force and effect unless
+terminated as stated above.
+
+8. Miscellaneous
+
+a. Each time You distribute or publicly digitally perform the Work or a
+Collective Work, the Licensor offers to the recipient a license to the Work on
+the same terms and conditions as the license granted to You under this License.
+
+b. Each time You distribute or publicly digitally perform a Derivative Work,
+Licensor offers to the recipient a license to the original Work on the same
+terms and conditions as the license granted to You under this License.
+
+c. If any provision of this License is invalid or unenforceable under applicable
+law, it shall not affect the validity or enforceability of the remainder of the
+terms of this License, and without further action by the parties to this
+agreement, such provision shall be reformed to the minimum extent necessary to
+make such provision valid and enforceable.
+
+d. No term or provision of this License shall be deemed waived and no breach
+consented to unless such waiver or consent shall be in writing and signed by the
+party to be charged with such waiver or consent.
+
+e. This License constitutes the entire agreement between the parties with respect
+to the Work licensed here. There are no understandings, agreements or
+representations with respect to the Work not specified here. Licensor shall not
+be bound by any additional provisions that may appear in any communication from
+You. This License may not be modified without the mutual written agreement of
+the Licensor and You.
\ No newline at end of file
diff --git a/doc/guacamole-branding-example/resources/images/saturn/saturn.png b/doc/guacamole-branding-example/resources/images/saturn/saturn.png
new file mode 100644
index 0000000..2bf7f5a
Binary files /dev/null and b/doc/guacamole-branding-example/resources/images/saturn/saturn.png differ
diff --git a/doc/guacamole-branding-example/translations/en.json b/doc/guacamole-branding-example/translations/en.json
new file mode 100644
index 0000000..8ffc8e7
--- /dev/null
+++ b/doc/guacamole-branding-example/translations/en.json
@@ -0,0 +1,5 @@
+{
+ "APP": {
+ "NAME" : "Gateway to Saturn"
+ }
+}
diff --git a/doc/guacamole-example/.gitignore b/doc/guacamole-example/.gitignore
new file mode 100644
index 0000000..c352b37
--- /dev/null
+++ b/doc/guacamole-example/.gitignore
@@ -0,0 +1,3 @@
+src/main/webapp/META-INF/
+target/
+*~
diff --git a/doc/guacamole-example/pom.xml b/doc/guacamole-example/pom.xml
new file mode 100644
index 0000000..e4a4f1c
--- /dev/null
+++ b/doc/guacamole-example/pom.xml
@@ -0,0 +1,131 @@
+
+
+
+
+ 4.0.0
+ org.apache.guacamole
+ guacamole-example
+ war
+ 1.6.0
+ guacamole-example
+ http://guacamole.apache.org/
+
+
+ UTF-8
+
+
+
+
+
+
+
+ org.apache.maven.plugins
+ maven-compiler-plugin
+ 3.8.1
+
+ 1.8
+ 1.8
+
+ -Xlint:all
+ -Werror
+
+ true
+
+
+
+
+
+ org.apache.maven.plugins
+ maven-war-plugin
+ 3.3.1
+
+
+
+ org.apache.guacamole
+ guacamole-common-js
+ zip
+
+
+
+
+
+
+
+ org.apache.rat
+ apache-rat-plugin
+ 0.13
+
+
+
+
+ validate
+ validate
+
+ check
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ javax.servlet
+ servlet-api
+ 2.5
+ provided
+
+
+
+
+ org.apache.guacamole
+ guacamole-common
+ 1.6.0
+ compile
+
+
+
+
+ org.apache.guacamole
+ guacamole-common-js
+ 1.6.0
+ zip
+ runtime
+
+
+
+ org.slf4j
+ slf4j-simple
+ 2.0.13
+
+
+
+
+
+
diff --git a/doc/guacamole-example/src/main/java/org/apache/guacamole/net/example/DummyGuacamoleTunnelServlet.java b/doc/guacamole-example/src/main/java/org/apache/guacamole/net/example/DummyGuacamoleTunnelServlet.java
new file mode 100644
index 0000000..8bcfee0
--- /dev/null
+++ b/doc/guacamole-example/src/main/java/org/apache/guacamole/net/example/DummyGuacamoleTunnelServlet.java
@@ -0,0 +1,63 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.net.example;
+
+import javax.servlet.http.HttpServletRequest;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.net.GuacamoleSocket;
+import org.apache.guacamole.net.GuacamoleTunnel;
+import org.apache.guacamole.net.InetGuacamoleSocket;
+import org.apache.guacamole.net.SimpleGuacamoleTunnel;
+import org.apache.guacamole.protocol.ConfiguredGuacamoleSocket;
+import org.apache.guacamole.protocol.GuacamoleConfiguration;
+import org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet;
+
+/**
+ * Simple tunnel example with hard-coded configuration parameters.
+ */
+public class DummyGuacamoleTunnelServlet extends GuacamoleHTTPTunnelServlet {
+
+ @Override
+ protected GuacamoleTunnel doConnect(HttpServletRequest request) throws GuacamoleException {
+
+ // guacd connection information
+ String hostname = "localhost";
+ int port = 4822;
+
+ // VNC connection information
+ GuacamoleConfiguration config = new GuacamoleConfiguration();
+ config.setProtocol("vnc");
+ config.setParameter("hostname", "localhost");
+ config.setParameter("port", "5901");
+ config.setParameter("password", "potato");
+
+ // Connect to guacd, proxying a connection to the VNC server above
+ GuacamoleSocket socket = new ConfiguredGuacamoleSocket(
+ new InetGuacamoleSocket(hostname, port),
+ config
+ );
+
+ // Create tunnel from now-configured socket
+ GuacamoleTunnel tunnel = new SimpleGuacamoleTunnel(socket);
+ return tunnel;
+
+ }
+
+}
diff --git a/doc/guacamole-example/src/main/webapp/WEB-INF/web.xml b/doc/guacamole-example/src/main/webapp/WEB-INF/web.xml
new file mode 100644
index 0000000..54d7089
--- /dev/null
+++ b/doc/guacamole-example/src/main/webapp/WEB-INF/web.xml
@@ -0,0 +1,46 @@
+
+
+
+
+
+
+ index.html
+
+
+
+ 30
+
+
+
+
+
+ Tunnel servlet.
+ Tunnel
+ org.apache.guacamole.net.example.DummyGuacamoleTunnelServlet
+
+
+ Tunnel
+ /tunnel
+
+
+
+
diff --git a/doc/guacamole-example/src/main/webapp/dot.gif b/doc/guacamole-example/src/main/webapp/dot.gif
new file mode 100644
index 0000000..9ac8a00
Binary files /dev/null and b/doc/guacamole-example/src/main/webapp/dot.gif differ
diff --git a/doc/guacamole-example/src/main/webapp/guacamole.css b/doc/guacamole-example/src/main/webapp/guacamole.css
new file mode 100644
index 0000000..e92bbc8
--- /dev/null
+++ b/doc/guacamole-example/src/main/webapp/guacamole.css
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+.guac-hide-cursor {
+ cursor: url('dot.gif'),default;
+}
+
diff --git a/doc/guacamole-example/src/main/webapp/index.html b/doc/guacamole-example/src/main/webapp/index.html
new file mode 100644
index 0000000..c47bbc4
--- /dev/null
+++ b/doc/guacamole-example/src/main/webapp/index.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+ Guacamole (EXAMPLE)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/guacamole-playback-example/.gitignore b/doc/guacamole-playback-example/.gitignore
new file mode 100644
index 0000000..c352b37
--- /dev/null
+++ b/doc/guacamole-playback-example/.gitignore
@@ -0,0 +1,3 @@
+src/main/webapp/META-INF/
+target/
+*~
diff --git a/doc/guacamole-playback-example/pom.xml b/doc/guacamole-playback-example/pom.xml
new file mode 100644
index 0000000..8563e07
--- /dev/null
+++ b/doc/guacamole-playback-example/pom.xml
@@ -0,0 +1,98 @@
+
+
+
+
+ 4.0.0
+ org.apache.guacamole
+ guacamole-playback-example
+ war
+ 1.6.0
+ guacamole-playback-example
+ http://guacamole.apache.org/
+
+
+ UTF-8
+
+
+
+
+
+
+
+ org.apache.maven.plugins
+ maven-war-plugin
+ 3.3.1
+
+
+
+ org.apache.guacamole
+ guacamole-common-js
+ zip
+
+
+
+
+
+
+
+ org.apache.rat
+ apache-rat-plugin
+ 0.13
+
+
+
+ src/main/webapp/recording.guac
+
+
+
+
+
+
+ validate
+ validate
+
+ check
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ org.apache.guacamole
+ guacamole-common-js
+ 1.6.0
+ zip
+ runtime
+
+
+
+
+
diff --git a/doc/guacamole-playback-example/src/main/webapp/WEB-INF/web.xml b/doc/guacamole-playback-example/src/main/webapp/WEB-INF/web.xml
new file mode 100644
index 0000000..9db9bb0
--- /dev/null
+++ b/doc/guacamole-playback-example/src/main/webapp/WEB-INF/web.xml
@@ -0,0 +1,30 @@
+
+
+
+
+
+
+ index.html
+
+
+
diff --git a/doc/guacamole-playback-example/src/main/webapp/index.html b/doc/guacamole-playback-example/src/main/webapp/index.html
new file mode 100644
index 0000000..5b21551
--- /dev/null
+++ b/doc/guacamole-playback-example/src/main/webapp/index.html
@@ -0,0 +1,65 @@
+
+
+
+
+
+ Guacamole Recording Playback (EXAMPLE)
+
+
+
+
+
+
+
+ Seek in progress...
+ Cancel
+
+
+
+
+
+
+
+ Play
+ 00:00
+ /
+ 00:00
+
+
+
project in the ISIS Programme.
+
+This product contains software that is
+copyright (c) 2021, Oracle and/or its affiliates.
diff --git a/doc/licenses/apache-santuario-2.2.6/README b/doc/licenses/apache-santuario-2.2.6/README
new file mode 100644
index 0000000..8ccae43
--- /dev/null
+++ b/doc/licenses/apache-santuario-2.2.6/README
@@ -0,0 +1,7 @@
+Apache Santuario (https://santuario.apache.org/)
+-------------------------------------------------
+
+ Version: 2.2.6
+ From: 'Apache Software Foundation' (https://www.apache.org/)
+ License(s):
+ Apache v2.0
diff --git a/doc/licenses/apache-santuario-2.2.6/dep-coordinates.txt b/doc/licenses/apache-santuario-2.2.6/dep-coordinates.txt
new file mode 100644
index 0000000..0a6929d
--- /dev/null
+++ b/doc/licenses/apache-santuario-2.2.6/dep-coordinates.txt
@@ -0,0 +1 @@
+org.apache.santuario:xmlsec:jar:2.2.6
diff --git a/doc/licenses/assert-1.5.0/LICENSE b/doc/licenses/assert-1.5.0/LICENSE
new file mode 100644
index 0000000..e3d4e69
--- /dev/null
+++ b/doc/licenses/assert-1.5.0/LICENSE
@@ -0,0 +1,18 @@
+Copyright Joyent, Inc. and other Node contributors. All rights reserved.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
diff --git a/doc/licenses/assert-1.5.0/README b/doc/licenses/assert-1.5.0/README
new file mode 100644
index 0000000..9b986ae
--- /dev/null
+++ b/doc/licenses/assert-1.5.0/README
@@ -0,0 +1,8 @@
+assert (https://github.com/browserify/commonjs-assert/)
+-------------------------------------------------------
+
+ Version: 1.5.0
+ From: 'Joyent, Inc. and other Node contributors'
+ License(s):
+ MIT (bundled/assert-1.5.0/LICENSE)
+
diff --git a/doc/licenses/assert-1.5.0/dep-coordinates.txt b/doc/licenses/assert-1.5.0/dep-coordinates.txt
new file mode 100644
index 0000000..d0bf923
--- /dev/null
+++ b/doc/licenses/assert-1.5.0/dep-coordinates.txt
@@ -0,0 +1 @@
+assert:1.5.0
diff --git a/doc/licenses/base64-js-1.5.1/LICENSE b/doc/licenses/base64-js-1.5.1/LICENSE
new file mode 100644
index 0000000..9143d4c
--- /dev/null
+++ b/doc/licenses/base64-js-1.5.1/LICENSE
@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Jameson Little
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+Footer
diff --git a/doc/licenses/base64-js-1.5.1/README b/doc/licenses/base64-js-1.5.1/README
new file mode 100644
index 0000000..6cacd8f
--- /dev/null
+++ b/doc/licenses/base64-js-1.5.1/README
@@ -0,0 +1,8 @@
+base64-js (https://github.com/beatgammit/base64-js)
+---------------------------------------------
+
+ Version: 1.5.1
+ From: 'Jameson Little' (https://github.com/beatgammit/)
+ License(s):
+ MIT (bundled/base640-js-1.5.1/LICENSE)
+
diff --git a/doc/licenses/base64-js-1.5.1/dep-coordinates.txt b/doc/licenses/base64-js-1.5.1/dep-coordinates.txt
new file mode 100644
index 0000000..1d66ee8
--- /dev/null
+++ b/doc/licenses/base64-js-1.5.1/dep-coordinates.txt
@@ -0,0 +1 @@
+base64-js:1.5.1
diff --git a/doc/licenses/blob-polyfill-9.0.20240710/LICENSE.md b/doc/licenses/blob-polyfill-9.0.20240710/LICENSE.md
new file mode 100644
index 0000000..daae0b0
--- /dev/null
+++ b/doc/licenses/blob-polyfill-9.0.20240710/LICENSE.md
@@ -0,0 +1,25 @@
+Copyright © 2014 [Eli Grey][1].
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+
+ [1]: http://eligrey.com
diff --git a/doc/licenses/blob-polyfill-9.0.20240710/README b/doc/licenses/blob-polyfill-9.0.20240710/README
new file mode 100644
index 0000000..e2f565e
--- /dev/null
+++ b/doc/licenses/blob-polyfill-9.0.20240710/README
@@ -0,0 +1,7 @@
+Blob.js (https://github.com/eligrey/Blob.js/)
+---------------------------------------------
+
+ Version: 9.0.20240710
+ From: 'Eli Grey' (https://github.com/eligrey)
+ License(s):
+ MIT (bundled/blob-polyfill-9.0.20240710/LICENSE.md)
diff --git a/doc/licenses/blob-polyfill-9.0.20240710/dep-coordinates.txt b/doc/licenses/blob-polyfill-9.0.20240710/dep-coordinates.txt
new file mode 100644
index 0000000..c4a3b1b
--- /dev/null
+++ b/doc/licenses/blob-polyfill-9.0.20240710/dep-coordinates.txt
@@ -0,0 +1 @@
+blob-polyfill:9.0.20240710
diff --git a/doc/licenses/bouncycastle-1.44/LICENSE b/doc/licenses/bouncycastle-1.44/LICENSE
new file mode 100644
index 0000000..15c29d9
--- /dev/null
+++ b/doc/licenses/bouncycastle-1.44/LICENSE
@@ -0,0 +1,7 @@
+Copyright (c) 2000 - 2016 The Legion of the Bouncy Castle Inc. (https://www.bouncycastle.org)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/doc/licenses/bouncycastle-1.44/README b/doc/licenses/bouncycastle-1.44/README
new file mode 100644
index 0000000..277ab21
--- /dev/null
+++ b/doc/licenses/bouncycastle-1.44/README
@@ -0,0 +1,8 @@
+BouncyCastle Crypto (https://www.bouncycastle.org/java.html)
+------------------------------------------------------------
+
+ Version: 1.44
+ From: 'The Legion of Bouncy Castle' (https://www.bouncycastle.org)
+ License(s):
+ MIT (bundled/bouncycastle-1.44/LICENSE
+
diff --git a/doc/licenses/bouncycastle-1.44/dep-coordinates.txt b/doc/licenses/bouncycastle-1.44/dep-coordinates.txt
new file mode 100644
index 0000000..707d6d9
--- /dev/null
+++ b/doc/licenses/bouncycastle-1.44/dep-coordinates.txt
@@ -0,0 +1 @@
+org.bouncycastle:bcprov-jdk15:jar:1.44
diff --git a/doc/licenses/bouncycastle-1.80/LICENSE b/doc/licenses/bouncycastle-1.80/LICENSE
new file mode 100644
index 0000000..fe843e9
--- /dev/null
+++ b/doc/licenses/bouncycastle-1.80/LICENSE
@@ -0,0 +1,18 @@
+Copyright (c) 2000-2024 The Legion of the Bouncy Castle Inc. (https://www.bouncycastle.org).
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sub license, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions: The above copyright
+notice and this permission notice shall be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/doc/licenses/bouncycastle-1.80/README b/doc/licenses/bouncycastle-1.80/README
new file mode 100644
index 0000000..6e9a57a
--- /dev/null
+++ b/doc/licenses/bouncycastle-1.80/README
@@ -0,0 +1,7 @@
+BouncyCastle Crypto (https://www.bouncycastle.org/java.html)
+------------------------------------------------------------
+
+ Version: 1.80
+ From: 'The Legion of Bouncy Castle' (https://www.bouncycastle.org)
+ License(s):
+ MIT (bundled/bouncycastle-1.80/LICENSE)
diff --git a/doc/licenses/bouncycastle-1.80/dep-coordinates.txt b/doc/licenses/bouncycastle-1.80/dep-coordinates.txt
new file mode 100644
index 0000000..9c1d76e
--- /dev/null
+++ b/doc/licenses/bouncycastle-1.80/dep-coordinates.txt
@@ -0,0 +1,3 @@
+org.bouncycastle:bcpkix-jdk15to18:jar:1.80
+org.bouncycastle:bcprov-jdk15to18:jar:1.80
+org.bouncycastle:bcutil-jdk15to18:jar:1.80
diff --git a/doc/licenses/bouncycastle-fips-2.1.0/LICENSE b/doc/licenses/bouncycastle-fips-2.1.0/LICENSE
new file mode 100644
index 0000000..6130142
--- /dev/null
+++ b/doc/licenses/bouncycastle-fips-2.1.0/LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2000 - 2023 The Legion of the Bouncy Castle Inc.
+(https://www.bouncycastle.org)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/doc/licenses/bouncycastle-fips-2.1.0/README b/doc/licenses/bouncycastle-fips-2.1.0/README
new file mode 100644
index 0000000..0067750
--- /dev/null
+++ b/doc/licenses/bouncycastle-fips-2.1.0/README
@@ -0,0 +1,7 @@
+BouncyCastle FIPS Distribution (https://www.bouncycastle.org/fips-java)
+-----------------------------------------------------------------------
+
+ Version: 2.1.0
+ From: 'The Legion of Bouncy Castle' (https://www.bouncycastle.org)
+ License(s):
+ MIT (bundled/bouncycastle-fips-2.1.0/LICENSE)
diff --git a/doc/licenses/bouncycastle-fips-2.1.0/dep-coordinates.txt b/doc/licenses/bouncycastle-fips-2.1.0/dep-coordinates.txt
new file mode 100644
index 0000000..4481ae6
--- /dev/null
+++ b/doc/licenses/bouncycastle-fips-2.1.0/dep-coordinates.txt
@@ -0,0 +1 @@
+org.bouncycastle:bc-fips:jar:2.1.0
diff --git a/doc/licenses/bouncycastle-pkix-fips-2.1.9/LICENSE b/doc/licenses/bouncycastle-pkix-fips-2.1.9/LICENSE
new file mode 100644
index 0000000..a02bc17
--- /dev/null
+++ b/doc/licenses/bouncycastle-pkix-fips-2.1.9/LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2000 - 2021 The Legion of the Bouncy Castle Inc.
+(https://www.bouncycastle.org)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/doc/licenses/bouncycastle-pkix-fips-2.1.9/README b/doc/licenses/bouncycastle-pkix-fips-2.1.9/README
new file mode 100644
index 0000000..aec5036
--- /dev/null
+++ b/doc/licenses/bouncycastle-pkix-fips-2.1.9/README
@@ -0,0 +1,7 @@
+BouncyCastle PKIX APIs, FIPS Distribution (https://www.bouncycastle.org/fips-java)
+-----------------------------------------------------------------------
+
+ Version: 2.1.9
+ From: 'The Legion of Bouncy Castle' (https://www.bouncycastle.org)
+ License(s):
+ MIT (bundled/bouncycastle-pkix-fips-2.1.9/LICENSE)
diff --git a/doc/licenses/bouncycastle-pkix-fips-2.1.9/dep-coordinates.txt b/doc/licenses/bouncycastle-pkix-fips-2.1.9/dep-coordinates.txt
new file mode 100644
index 0000000..1dcbd9d
--- /dev/null
+++ b/doc/licenses/bouncycastle-pkix-fips-2.1.9/dep-coordinates.txt
@@ -0,0 +1 @@
+org.bouncycastle:bcpkix-fips:jar:2.1.9
diff --git a/doc/licenses/bouncycastle-util-fips-2.1.4/LICENSE b/doc/licenses/bouncycastle-util-fips-2.1.4/LICENSE
new file mode 100644
index 0000000..6130142
--- /dev/null
+++ b/doc/licenses/bouncycastle-util-fips-2.1.4/LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2000 - 2023 The Legion of the Bouncy Castle Inc.
+(https://www.bouncycastle.org)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/doc/licenses/bouncycastle-util-fips-2.1.4/README b/doc/licenses/bouncycastle-util-fips-2.1.4/README
new file mode 100644
index 0000000..a4ed209
--- /dev/null
+++ b/doc/licenses/bouncycastle-util-fips-2.1.4/README
@@ -0,0 +1,7 @@
+Bouncy Castle ASN.1 Extension and Utility APIs (https://www.bouncycastle.org/fips-java)
+-----------------------------------------------------------------------
+
+ Version: 2.1.4
+ From: 'The Legion of Bouncy Castle' (https://www.bouncycastle.org)
+ License(s):
+ MIT (bundled/bouncycastle-fips-2.1.4/LICENSE)
diff --git a/doc/licenses/bouncycastle-util-fips-2.1.4/dep-coordinates.txt b/doc/licenses/bouncycastle-util-fips-2.1.4/dep-coordinates.txt
new file mode 100644
index 0000000..a7704c1
--- /dev/null
+++ b/doc/licenses/bouncycastle-util-fips-2.1.4/dep-coordinates.txt
@@ -0,0 +1 @@
+org.bouncycastle:bcutil-fips:jar:2.1.4
diff --git a/doc/licenses/buffer-4.9.2/LICENSE b/doc/licenses/buffer-4.9.2/LICENSE
new file mode 100644
index 0000000..d6bf75d
--- /dev/null
+++ b/doc/licenses/buffer-4.9.2/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Feross Aboukhadijeh, and other contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/doc/licenses/buffer-4.9.2/README b/doc/licenses/buffer-4.9.2/README
new file mode 100644
index 0000000..7caad56
--- /dev/null
+++ b/doc/licenses/buffer-4.9.2/README
@@ -0,0 +1,7 @@
+buffer (https://github.com/feross/buffer)
+---------------------------------------------
+
+ Version: 4.9.2
+ From: 'Feross Aboukhadijeh' (https://github.com/feross)
+ License(s):
+ MIT (bundled/buffer-4.9.2/LICENSE)
diff --git a/doc/licenses/buffer-4.9.2/dep-coordinates.txt b/doc/licenses/buffer-4.9.2/dep-coordinates.txt
new file mode 100644
index 0000000..30f193d
--- /dev/null
+++ b/doc/licenses/buffer-4.9.2/dep-coordinates.txt
@@ -0,0 +1 @@
+buffer:4.9.2
diff --git a/doc/licenses/byte-buddy-1.15.4/NOTICE b/doc/licenses/byte-buddy-1.15.4/NOTICE
new file mode 100644
index 0000000..929cbc6
--- /dev/null
+++ b/doc/licenses/byte-buddy-1.15.4/NOTICE
@@ -0,0 +1,13 @@
+Copyright 2014 - Present Rafael Winterhalter
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/doc/licenses/byte-buddy-1.15.4/README b/doc/licenses/byte-buddy-1.15.4/README
new file mode 100644
index 0000000..dd349a4
--- /dev/null
+++ b/doc/licenses/byte-buddy-1.15.4/README
@@ -0,0 +1,8 @@
+Byte Buddy (https://bytebuddy.net/)
+-----------------------------------
+
+ Version: 1.15.4
+ From: 'Rafael Winterhalter' (https://github.com/raphw)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/byte-buddy-1.15.4/dep-coordinates.txt b/doc/licenses/byte-buddy-1.15.4/dep-coordinates.txt
new file mode 100644
index 0000000..968d744
--- /dev/null
+++ b/doc/licenses/byte-buddy-1.15.4/dep-coordinates.txt
@@ -0,0 +1 @@
+net.bytebuddy:byte-buddy:jar:1.15.4
diff --git a/doc/licenses/caffeine-2.9.3/README b/doc/licenses/caffeine-2.9.3/README
new file mode 100644
index 0000000..5336c72
--- /dev/null
+++ b/doc/licenses/caffeine-2.9.3/README
@@ -0,0 +1,7 @@
+Caffeine (https://github.com/ben-manes/caffeine)
+------------------------------------------------
+
+ Version: 2.9.3
+ From: 'Ben Manes' (https://github.com/ben-manes)
+ License(s):
+ Apache v2.0
diff --git a/doc/licenses/caffeine-2.9.3/dep-coordinates.txt b/doc/licenses/caffeine-2.9.3/dep-coordinates.txt
new file mode 100644
index 0000000..feda8aa
--- /dev/null
+++ b/doc/licenses/caffeine-2.9.3/dep-coordinates.txt
@@ -0,0 +1 @@
+com.github.ben-manes.caffeine:caffeine:jar:2.9.3
diff --git a/doc/licenses/cas-client-3.6.4/NOTICE b/doc/licenses/cas-client-3.6.4/NOTICE
new file mode 100644
index 0000000..a699597
--- /dev/null
+++ b/doc/licenses/cas-client-3.6.4/NOTICE
@@ -0,0 +1,2 @@
+This project includes:
+ Jasig CAS Client for Java - Core under Apache License Version 2.0
diff --git a/doc/licenses/cas-client-3.6.4/README b/doc/licenses/cas-client-3.6.4/README
new file mode 100644
index 0000000..d89fe50
--- /dev/null
+++ b/doc/licenses/cas-client-3.6.4/README
@@ -0,0 +1,8 @@
+Java Apereo CAS Client (https://www.apereo.org/projects/cas)
+------------------------------------------------------------
+
+ Version: 3.6.4
+ From: 'Apereo Foundation' (https://www.apereo.org/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/cas-client-3.6.4/dep-coordinates.txt b/doc/licenses/cas-client-3.6.4/dep-coordinates.txt
new file mode 100644
index 0000000..24e2e6d
--- /dev/null
+++ b/doc/licenses/cas-client-3.6.4/dep-coordinates.txt
@@ -0,0 +1 @@
+org.jasig.cas.client:cas-client-core:jar:3.6.4
diff --git a/doc/licenses/checker-qual-3.19.0/LICENSE.txt b/doc/licenses/checker-qual-3.19.0/LICENSE.txt
new file mode 100644
index 0000000..9837c6b
--- /dev/null
+++ b/doc/licenses/checker-qual-3.19.0/LICENSE.txt
@@ -0,0 +1,22 @@
+Checker Framework qualifiers
+Copyright 2004-present by the Checker Framework developers
+
+MIT License:
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/doc/licenses/checker-qual-3.19.0/README b/doc/licenses/checker-qual-3.19.0/README
new file mode 100644
index 0000000..4a00db7
--- /dev/null
+++ b/doc/licenses/checker-qual-3.19.0/README
@@ -0,0 +1,8 @@
+Checker Framework qualifiers (https://checkerframework.org/)
+------------------------------------------------------------
+
+ Version: 3.19.0
+ From: 'Checker Framework developers' (https://checkerframework.org/)
+ License(s):
+ MIT (bundled/checker-qual-3.19.0/LICENSE.txt)
+
diff --git a/doc/licenses/checker-qual-3.19.0/dep-coordinates.txt b/doc/licenses/checker-qual-3.19.0/dep-coordinates.txt
new file mode 100644
index 0000000..322f395
--- /dev/null
+++ b/doc/licenses/checker-qual-3.19.0/dep-coordinates.txt
@@ -0,0 +1 @@
+org.checkerframework:checker-qual:jar:3.19.0
diff --git a/doc/licenses/checker-qual-3.37.0/LICENSE.txt b/doc/licenses/checker-qual-3.37.0/LICENSE.txt
new file mode 100644
index 0000000..9837c6b
--- /dev/null
+++ b/doc/licenses/checker-qual-3.37.0/LICENSE.txt
@@ -0,0 +1,22 @@
+Checker Framework qualifiers
+Copyright 2004-present by the Checker Framework developers
+
+MIT License:
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/doc/licenses/checker-qual-3.37.0/README b/doc/licenses/checker-qual-3.37.0/README
new file mode 100644
index 0000000..1b4bd80
--- /dev/null
+++ b/doc/licenses/checker-qual-3.37.0/README
@@ -0,0 +1,8 @@
+Checker Framework qualifiers (https://checkerframework.org/)
+------------------------------------------------------------
+
+ Version: 3.37.0
+ From: 'Checker Framework developers' (https://checkerframework.org/)
+ License(s):
+ MIT (bundled/checker-qual-3.37.0/LICENSE.txt)
+
diff --git a/doc/licenses/checker-qual-3.37.0/dep-coordinates.txt b/doc/licenses/checker-qual-3.37.0/dep-coordinates.txt
new file mode 100644
index 0000000..e6b1b4e
--- /dev/null
+++ b/doc/licenses/checker-qual-3.37.0/dep-coordinates.txt
@@ -0,0 +1 @@
+org.checkerframework:checker-qual:jar:3.37.0
diff --git a/doc/licenses/core-util-is-1.0.3/LICENSE b/doc/licenses/core-util-is-1.0.3/LICENSE
new file mode 100644
index 0000000..d8d7f94
--- /dev/null
+++ b/doc/licenses/core-util-is-1.0.3/LICENSE
@@ -0,0 +1,19 @@
+Copyright Node.js contributors. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
diff --git a/doc/licenses/core-util-is-1.0.3/README b/doc/licenses/core-util-is-1.0.3/README
new file mode 100644
index 0000000..7db6591
--- /dev/null
+++ b/doc/licenses/core-util-is-1.0.3/README
@@ -0,0 +1,7 @@
+core-util-is (https://github.com/isaacs/core-util-is)
+---------------------------------------------
+
+ Version: 1.0.3
+ From: 'Node.js contributors'
+ License(s):
+ MIT (bundled/core-util-is-1.0.3/LICENSE)
diff --git a/doc/licenses/core-util-is-1.0.3/dep-coordinates.txt b/doc/licenses/core-util-is-1.0.3/dep-coordinates.txt
new file mode 100644
index 0000000..f4b1c7a
--- /dev/null
+++ b/doc/licenses/core-util-is-1.0.3/dep-coordinates.txt
@@ -0,0 +1 @@
+core-util-is:1.0.3
diff --git a/doc/licenses/css-loader-5.2.7/LICENSE b/doc/licenses/css-loader-5.2.7/LICENSE
new file mode 100644
index 0000000..8c11fc7
--- /dev/null
+++ b/doc/licenses/css-loader-5.2.7/LICENSE
@@ -0,0 +1,20 @@
+Copyright JS Foundation and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/doc/licenses/css-loader-5.2.7/README b/doc/licenses/css-loader-5.2.7/README
new file mode 100644
index 0000000..bcbec19
--- /dev/null
+++ b/doc/licenses/css-loader-5.2.7/README
@@ -0,0 +1,8 @@
+css-loader (https://github.com/webpack-contrib/css-loader)
+----------------------------------------------------------
+
+ Version: 5.2.7
+ From: 'JS Foundation and other contributors'
+ License(s):
+ MIT (bundled/css-loader-5.2.7/LICENSE)
+
diff --git a/doc/licenses/css-loader-5.2.7/dep-coordinates.txt b/doc/licenses/css-loader-5.2.7/dep-coordinates.txt
new file mode 100644
index 0000000..73a6894
--- /dev/null
+++ b/doc/licenses/css-loader-5.2.7/dep-coordinates.txt
@@ -0,0 +1 @@
+css-loader:5.2.7
diff --git a/doc/licenses/csv-6.3.9/LICENSE b/doc/licenses/csv-6.3.9/LICENSE
new file mode 100644
index 0000000..918eaf0
--- /dev/null
+++ b/doc/licenses/csv-6.3.9/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2010 Adaltas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/doc/licenses/csv-6.3.9/README b/doc/licenses/csv-6.3.9/README
new file mode 100644
index 0000000..691f87f
--- /dev/null
+++ b/doc/licenses/csv-6.3.9/README
@@ -0,0 +1,7 @@
+node-csv (https://github.com/adaltas/node-csv)
+---------------------------------------------
+
+ Version: 6.3.9
+ From: 'Adaltas' (https://github.com/adaltas)
+ License(s):
+ MIT (bundled/csv-6.3.9/LICENSE)
diff --git a/doc/licenses/csv-6.3.9/dep-coordinates.txt b/doc/licenses/csv-6.3.9/dep-coordinates.txt
new file mode 100644
index 0000000..53c4367
--- /dev/null
+++ b/doc/licenses/csv-6.3.9/dep-coordinates.txt
@@ -0,0 +1,2 @@
+csv:6.3.9
+csv-parse:5.5.6
diff --git a/doc/licenses/d3-path-3.1.0/LICENSE b/doc/licenses/d3-path-3.1.0/LICENSE
new file mode 100644
index 0000000..ed25746
--- /dev/null
+++ b/doc/licenses/d3-path-3.1.0/LICENSE
@@ -0,0 +1,13 @@
+Copyright 2015-2022 Mike Bostock
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.
diff --git a/doc/licenses/d3-path-3.1.0/README b/doc/licenses/d3-path-3.1.0/README
new file mode 100644
index 0000000..5bbf02a
--- /dev/null
+++ b/doc/licenses/d3-path-3.1.0/README
@@ -0,0 +1,8 @@
+d3-path (https://github.com/d3/d3-path)
+----------------------------------------------------------
+
+ Version: 3.1.0
+ From: 'Mike Bostock'
+ License(s):
+ BSD 0-clause (bundled/d3-path-3.1.0/LICENSE)
+
diff --git a/doc/licenses/d3-path-3.1.0/dep-coordinates.txt b/doc/licenses/d3-path-3.1.0/dep-coordinates.txt
new file mode 100644
index 0000000..5159b4e
--- /dev/null
+++ b/doc/licenses/d3-path-3.1.0/dep-coordinates.txt
@@ -0,0 +1 @@
+d3-path:3.1.0
diff --git a/doc/licenses/d3-shape-3.2.0/LICENSE b/doc/licenses/d3-shape-3.2.0/LICENSE
new file mode 100644
index 0000000..fbe44bd
--- /dev/null
+++ b/doc/licenses/d3-shape-3.2.0/LICENSE
@@ -0,0 +1,13 @@
+Copyright 2010-2022 Mike Bostock
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.
diff --git a/doc/licenses/d3-shape-3.2.0/README b/doc/licenses/d3-shape-3.2.0/README
new file mode 100644
index 0000000..f0adda5
--- /dev/null
+++ b/doc/licenses/d3-shape-3.2.0/README
@@ -0,0 +1,8 @@
+d3-path (https://github.com/d3/d3-shape)
+----------------------------------------------------------
+
+ Version: 3.2.0
+ From: 'Mike Bostock'
+ License(s):
+ BSD 0-clause (bundled/d3-shape-3.2.0/LICENSE)
+
diff --git a/doc/licenses/d3-shape-3.2.0/dep-coordinates.txt b/doc/licenses/d3-shape-3.2.0/dep-coordinates.txt
new file mode 100644
index 0000000..10973f4
--- /dev/null
+++ b/doc/licenses/d3-shape-3.2.0/dep-coordinates.txt
@@ -0,0 +1 @@
+d3-shape:3.2.0
diff --git a/doc/licenses/datalist-polyfill-1.25.1/LICENSE b/doc/licenses/datalist-polyfill-1.25.1/LICENSE
new file mode 100644
index 0000000..8864d4a
--- /dev/null
+++ b/doc/licenses/datalist-polyfill-1.25.1/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/doc/licenses/datalist-polyfill-1.25.1/README b/doc/licenses/datalist-polyfill-1.25.1/README
new file mode 100644
index 0000000..c26d45d
--- /dev/null
+++ b/doc/licenses/datalist-polyfill-1.25.1/README
@@ -0,0 +1,8 @@
+datalist-polyfill (https://github.com/mfranzke/datalist-polyfill)
+-----------------------------------------------------------------
+
+ Version: 1.25.1
+ From: 'Maximilian Franzke' (https://github.com/mfranzke)
+ License(s):
+ MIT (bundled/datalist-polyfill-1.25.1/LICENSE)
+
diff --git a/doc/licenses/datalist-polyfill-1.25.1/dep-coordinates.txt b/doc/licenses/datalist-polyfill-1.25.1/dep-coordinates.txt
new file mode 100644
index 0000000..40b1114
--- /dev/null
+++ b/doc/licenses/datalist-polyfill-1.25.1/dep-coordinates.txt
@@ -0,0 +1 @@
+datalist-polyfill:1.25.1
diff --git a/doc/licenses/directory-api-2.1.7/NOTICE b/doc/licenses/directory-api-2.1.7/NOTICE
new file mode 100644
index 0000000..676a182
--- /dev/null
+++ b/doc/licenses/directory-api-2.1.7/NOTICE
@@ -0,0 +1,5 @@
+Apache Directory LDAP API
+Copyright 2003-2023 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (https://www.apache.org/).
diff --git a/doc/licenses/directory-api-2.1.7/README b/doc/licenses/directory-api-2.1.7/README
new file mode 100644
index 0000000..172f0bf
--- /dev/null
+++ b/doc/licenses/directory-api-2.1.7/README
@@ -0,0 +1,7 @@
+Apache Directory LDAP API (http://directory.apache.org)
+-------------------------------------------------------
+
+ Version: 2.1.6
+ From: 'Apache Software Foundation' (https://www.apache.org/)
+ License(s):
+ Apache v2.0
diff --git a/doc/licenses/directory-api-2.1.7/dep-coordinates.txt b/doc/licenses/directory-api-2.1.7/dep-coordinates.txt
new file mode 100644
index 0000000..170ac1f
--- /dev/null
+++ b/doc/licenses/directory-api-2.1.7/dep-coordinates.txt
@@ -0,0 +1 @@
+org.apache.directory.api:api-all:jar:2.1.7
diff --git a/doc/licenses/dom4j-2.1.4/LICENSE b/doc/licenses/dom4j-2.1.4/LICENSE
new file mode 100644
index 0000000..1a02acb
--- /dev/null
+++ b/doc/licenses/dom4j-2.1.4/LICENSE
@@ -0,0 +1,39 @@
+Copyright 2001-2023 © MetaStuff, Ltd. and DOM4J contributors. All Rights Reserved.
+
+Redistribution and use of this software and associated documentation
+("Software"), with or without modification, are permitted provided
+that the following conditions are met:
+
+1. Redistributions of source code must retain copyright
+ statements and notices. Redistributions must also contain a
+ copy of this document.
+
+2. Redistributions in binary form must reproduce the
+ above copyright notice, this list of conditions and the
+ following disclaimer in the documentation and/or other
+ materials provided with the distribution.
+
+3. The name "DOM4J" must not be used to endorse or promote
+ products derived from this Software without prior written
+ permission of MetaStuff, Ltd. For written permission,
+ please contact dom4j-info@metastuff.com.
+
+4. Products derived from this Software may not be called "DOM4J"
+ nor may "DOM4J" appear in their names without prior written
+ permission of MetaStuff, Ltd. DOM4J is a registered
+ trademark of MetaStuff, Ltd.
+
+5. Due credit should be given to the DOM4J Project - https://dom4j.github.io/
+
+THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS
+``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
+NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+METASTUFF, LTD. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/doc/licenses/dom4j-2.1.4/README b/doc/licenses/dom4j-2.1.4/README
new file mode 100644
index 0000000..15651d0
--- /dev/null
+++ b/doc/licenses/dom4j-2.1.4/README
@@ -0,0 +1,8 @@
+DOM4J (https://dom4j.github.io/)
+--------------------------------
+
+ Version: 2.1.4
+ From: 'MetaStuff, Ltd. and DOM4J contributors'
+ License(s):
+ DOM4J License (bundled/dom4j-2.1.4/LICENSE)
+
diff --git a/doc/licenses/dom4j-2.1.4/dep-coordinates.txt b/doc/licenses/dom4j-2.1.4/dep-coordinates.txt
new file mode 100644
index 0000000..100eff3
--- /dev/null
+++ b/doc/licenses/dom4j-2.1.4/dep-coordinates.txt
@@ -0,0 +1 @@
+org.apache.servicemix.bundles:org.apache.servicemix.bundles.dom4j:jar:2.1.4_1
diff --git a/doc/licenses/duo-universal-sdk-1.2.0/LICENSE b/doc/licenses/duo-universal-sdk-1.2.0/LICENSE
new file mode 100644
index 0000000..369fbf8
--- /dev/null
+++ b/doc/licenses/duo-universal-sdk-1.2.0/LICENSE
@@ -0,0 +1,25 @@
+Copyright (c) 2022 Cisco Systems, Inc. and/or its affiliates
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+3. The name of the author may not be used to endorse or promote products
+ derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
diff --git a/doc/licenses/duo-universal-sdk-1.2.0/README b/doc/licenses/duo-universal-sdk-1.2.0/README
new file mode 100644
index 0000000..6cdc784
--- /dev/null
+++ b/doc/licenses/duo-universal-sdk-1.2.0/README
@@ -0,0 +1,8 @@
+Duo Universal SDK for Java (https://duo.com/docs/duoweb)
+--------------------------------------------------------
+
+ Version: 1.2.0
+ From: 'Cisco Systems'
+ License(s):
+ Duo License (bundled/duo-universal-sdk-1.2.0/LICENSE)
+
diff --git a/doc/licenses/duo-universal-sdk-1.2.0/dep-coordinates.txt b/doc/licenses/duo-universal-sdk-1.2.0/dep-coordinates.txt
new file mode 100644
index 0000000..70795a7
--- /dev/null
+++ b/doc/licenses/duo-universal-sdk-1.2.0/dep-coordinates.txt
@@ -0,0 +1 @@
+com.duosecurity:duo-universal-sdk:jar:1.2.0
diff --git a/doc/licenses/ehcache-2.4.0/README b/doc/licenses/ehcache-2.4.0/README
new file mode 100644
index 0000000..fe82e17
--- /dev/null
+++ b/doc/licenses/ehcache-2.4.0/README
@@ -0,0 +1,8 @@
+Ehcache (https://www.ehcache.org/)
+----------------------------------
+
+ Version: 2.4.0
+ From: 'Terracotta, Inc.' (https://www.terracotta.org/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/ehcache-2.4.0/dep-coordinates.txt b/doc/licenses/ehcache-2.4.0/dep-coordinates.txt
new file mode 100644
index 0000000..2807940
--- /dev/null
+++ b/doc/licenses/ehcache-2.4.0/dep-coordinates.txt
@@ -0,0 +1 @@
+net.sf.ehcache:ehcache-core:jar:2.4.0
diff --git a/doc/licenses/error-prone-2.10.0/README b/doc/licenses/error-prone-2.10.0/README
new file mode 100644
index 0000000..f286aed
--- /dev/null
+++ b/doc/licenses/error-prone-2.10.0/README
@@ -0,0 +1,8 @@
+Error Prone (https://errorprone.info/)
+--------------------------------------
+
+ Version: 2.10.0
+ From: 'Google Inc.' (http://www.google.com/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/error-prone-2.10.0/dep-coordinates.txt b/doc/licenses/error-prone-2.10.0/dep-coordinates.txt
new file mode 100644
index 0000000..9473dfc
--- /dev/null
+++ b/doc/licenses/error-prone-2.10.0/dep-coordinates.txt
@@ -0,0 +1 @@
+com.google.errorprone:error_prone_annotations:jar:2.10.0
diff --git a/doc/licenses/error-prone-2.21.1/README b/doc/licenses/error-prone-2.21.1/README
new file mode 100644
index 0000000..8e1df59
--- /dev/null
+++ b/doc/licenses/error-prone-2.21.1/README
@@ -0,0 +1,8 @@
+Error Prone (https://errorprone.info/)
+--------------------------------------
+
+ Version: 2.21.1
+ From: 'Google Inc.' (http://www.google.com/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/error-prone-2.21.1/dep-coordinates.txt b/doc/licenses/error-prone-2.21.1/dep-coordinates.txt
new file mode 100644
index 0000000..d1e82c9
--- /dev/null
+++ b/doc/licenses/error-prone-2.21.1/dep-coordinates.txt
@@ -0,0 +1 @@
+com.google.errorprone:error_prone_annotations:jar:2.21.1
diff --git a/doc/licenses/events-3.3.0/LICENSE b/doc/licenses/events-3.3.0/LICENSE
new file mode 100644
index 0000000..52ed3b0
--- /dev/null
+++ b/doc/licenses/events-3.3.0/LICENSE
@@ -0,0 +1,22 @@
+MIT
+
+Copyright Joyent, Inc. and other Node contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/doc/licenses/events-3.3.0/README b/doc/licenses/events-3.3.0/README
new file mode 100644
index 0000000..b53924d
--- /dev/null
+++ b/doc/licenses/events-3.3.0/README
@@ -0,0 +1,7 @@
+events (https://github.com/browserify/events)
+---------------------------------------------
+
+ Version: 3.3.0
+ From: 'Node.js contributors, Joyent, Inc., and other Node contributors'
+ License(s):
+ MIT (bundled/events-3.3.0/LICENSE)
diff --git a/doc/licenses/events-3.3.0/dep-coordinates.txt b/doc/licenses/events-3.3.0/dep-coordinates.txt
new file mode 100644
index 0000000..f644fcc
--- /dev/null
+++ b/doc/licenses/events-3.3.0/dep-coordinates.txt
@@ -0,0 +1 @@
+events:3.3.0
diff --git a/doc/licenses/file-saver-2.0.5/LICENSE.md b/doc/licenses/file-saver-2.0.5/LICENSE.md
new file mode 100644
index 0000000..32ef3ca
--- /dev/null
+++ b/doc/licenses/file-saver-2.0.5/LICENSE.md
@@ -0,0 +1,11 @@
+The MIT License
+
+Copyright © 2016 [Eli Grey][1].
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+ [1]: http://eligrey.com
diff --git a/doc/licenses/file-saver-2.0.5/README b/doc/licenses/file-saver-2.0.5/README
new file mode 100644
index 0000000..0d93345
--- /dev/null
+++ b/doc/licenses/file-saver-2.0.5/README
@@ -0,0 +1,8 @@
+FileSaver.js (https://github.com/eligrey/FileSaver.js)
+------------------------------------------------------
+
+ Version: 2.0.5
+ From: 'Eli Grey' (https://github.com/eligrey)
+ License(s):
+ MIT (bundled/file-saver-2.0.5/LICENSE.md)
+
diff --git a/doc/licenses/file-saver-2.0.5/dep-coordinates.txt b/doc/licenses/file-saver-2.0.5/dep-coordinates.txt
new file mode 100644
index 0000000..c0c2b2f
--- /dev/null
+++ b/doc/licenses/file-saver-2.0.5/dep-coordinates.txt
@@ -0,0 +1 @@
+file-saver:2.0.5
diff --git a/doc/licenses/findbugs-jsr305-3.0.2/LICENSE b/doc/licenses/findbugs-jsr305-3.0.2/LICENSE
new file mode 100644
index 0000000..6736681
--- /dev/null
+++ b/doc/licenses/findbugs-jsr305-3.0.2/LICENSE
@@ -0,0 +1,28 @@
+Copyright (c) 2007-2009, JSR305 expert group
+All rights reserved.
+
+http://www.opensource.org/licenses/bsd-license.php
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+ * Neither the name of the JSR305 expert group nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
diff --git a/doc/licenses/findbugs-jsr305-3.0.2/README b/doc/licenses/findbugs-jsr305-3.0.2/README
new file mode 100644
index 0000000..d9e2f0a
--- /dev/null
+++ b/doc/licenses/findbugs-jsr305-3.0.2/README
@@ -0,0 +1,8 @@
+JSR-305 Reference Implementation (http://code.google.com/p/jsr-305/)
+--------------------------------------------------------------------
+
+ Version: 3.0.2 (originally 0.1-SNAPSHOT, redistributed by FindBugs 3.0.2)
+ From: 'JSR305 expert group' (https://code.google.com/archive/p/jsr-305/)
+ License(s):
+ BSD 3-clause (bundled/findbugs-jsr305-3.0.2/LICENSE)
+
diff --git a/doc/licenses/findbugs-jsr305-3.0.2/dep-coordinates.txt b/doc/licenses/findbugs-jsr305-3.0.2/dep-coordinates.txt
new file mode 100644
index 0000000..2b53583
--- /dev/null
+++ b/doc/licenses/findbugs-jsr305-3.0.2/dep-coordinates.txt
@@ -0,0 +1 @@
+com.google.code.findbugs:jsr305:jar:3.0.2
diff --git a/doc/licenses/fuzzysort-3.0.2/LICENSE b/doc/licenses/fuzzysort-3.0.2/LICENSE
new file mode 100644
index 0000000..a3b9d9d
--- /dev/null
+++ b/doc/licenses/fuzzysort-3.0.2/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Stephen Kamenar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/doc/licenses/fuzzysort-3.0.2/README b/doc/licenses/fuzzysort-3.0.2/README
new file mode 100644
index 0000000..d1f8f28
--- /dev/null
+++ b/doc/licenses/fuzzysort-3.0.2/README
@@ -0,0 +1,7 @@
+fuzzysort (https://github.com/farzher/fuzzysort/tree/master)
+---------------------------------------------
+
+ Version: 3.0.2
+ From: 'Stephen Kamenar' (https://github.com/farzher)
+ License(s):
+ MIT (bundled/fuzzysort-3.0.2/LICENSE)
diff --git a/doc/licenses/fuzzysort-3.0.2/dep-coordinates.txt b/doc/licenses/fuzzysort-3.0.2/dep-coordinates.txt
new file mode 100644
index 0000000..0a8c3a0
--- /dev/null
+++ b/doc/licenses/fuzzysort-3.0.2/dep-coordinates.txt
@@ -0,0 +1 @@
+fuzzysort:3.0.2
diff --git a/doc/licenses/generate-license-files.sh b/doc/licenses/generate-license-files.sh
new file mode 100755
index 0000000..76f8296
--- /dev/null
+++ b/doc/licenses/generate-license-files.sh
@@ -0,0 +1,383 @@
+#!/bin/sh
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# NOTE: Parts of this file (Makefile.am) are automatically transcluded verbatim
+# into Makefile.in. Though the build system (GNU Autotools) automatically adds
+# its own license boilerplate to the generated Makefile.in, that boilerplate
+# does not apply to the transcluded portions of Makefile.am which are licensed
+# to you by the ASF under the Apache License, Version 2.0, as described above.
+#
+
+#
+# generate-license-files.sh
+# -------------------------
+#
+# Automatically iterates through the provided runtime dependencies of the
+# project in the current directory, creating new LICENSE and NOTICE files which
+# contain all the license information of bundled dependencies, as well as any
+# required notices.
+#
+# This script is expected to be invoked as part of the build process of the
+# various guacamole-client subprojects.
+#
+# USAGE:
+#
+# path/to/generate-license-files.sh DEPENDENCY_LIST OUTPUT_DIRECTORY
+#
+# where DEPENDENCY_LIST is the list of dependencies to consider when generating
+# LICENSE and NOTICE (as produced by "mvn dependency:list" or our
+# DependencyListPlugin for Webpack) and OUTPUT_DIRECTORY is the directory in
+# which the LICENSE and NOTICE files should be written.
+#
+# If DEPENDENCY_LIST is a directory, all normal files within the directory will
+# be concatenated to produce the list.
+#
+# Ignoring license errors
+# -----------------------
+#
+# By default, this script will exit with a non-zero exit code if any license
+# errors are encountered, failing the build. If this is undesirable (dependency
+# changes are being tested, a full list of all license errors across all
+# projects is needed, etc.), set the IGNORE_LICENSE_ERRORS environment variable
+# to "true".
+#
+# Structure of license information
+# --------------------------------
+#
+# The LICENSE and NOTICE files of the guacamole-client project are used as the
+# basis for the generated LICENSE and NOTICE files. It is expected that the
+# guacamole-client LICENSE will may contain license information for
+# subcomponents that had to be copied verbatim into the source tree, with that
+# information following a human-readable preamble that begins with a solid line
+# of "=" characters. This line of "=" characters MUST BE INCLUDED when such
+# dependencies are present, as it is specifically searched for by this script
+# when determining what parts of the main LICENSE file should be copied over.
+#
+# License information for the bundled runtime dependencies of all subprojects
+# is included in the subdirectories of the "doc/licenses/" directory of the
+# main guacamole-client source tree. Each subdirectory is associated with a
+# single, logical dependency, with the coordinates of that dependency listed in
+# the "dep-coordinates.txt" file within that subdirectory. There may be
+# multiple coordinates associated with a dependency, in which case each
+# relevant set of coordinates should be listed on its own line.
+#
+# For dependencies that are not associated with coordinates that can be
+# automatically deteremined, the licenses of those dependencies should instead
+# be documented within subdirectories of the "src/licenses/bundled/" directory
+# of the relevant subproject.
+#
+# Regardless of whether a dependency is documented within the top-level
+# guacamole-client project or within the relevant subproject, the subdirectory
+# for each dependency must contain a "README" file describing the dependency,
+# the version used, the copyright holder(s), and the license. Examples of the
+# formatting expected for these README files can be found within the existing
+# dependency license directories.
+#
+# Files that contain the word "notice", regardless of case, are considered by
+# this script to be the notice file mentioned within the Apache License, and
+# will be copied verbatim into the generated NOTICE file.
+#
+# Files that that are not recognized as any other type of file are considered
+# by this script to be the license and will be included verbatim within the
+# generated LICENSE if they are less than 50 lines.
+#
+
+##
+## The filename of the file containing whether any errors have been logged. The
+## contents of this file will be set to "1" if at least one error occurred. A
+## file is used here instead of a simple environment variable to allow error()
+## to be called from within pipelines and still be detectable.
+##
+HAS_ERRORS="`mktemp`"
+trap 'rm -f "$HAS_ERRORS"' EXIT
+
+##
+## The maximum size of a license that may be included verbatim within the
+## generated LICENSE file. Larger licenses will only be included separately.
+##
+LICENSE_COPY_LIMIT=50
+
+##
+## The directory containing this script and all license information. This
+## should be "doc/licenses/" within the guacamole-client source tree.
+##
+LICENSES_DIR="`dirname "$0"`"
+
+##
+## The base directory of the guacamole-client source tree.
+##
+BASEDIR="$LICENSES_DIR/../.."
+
+##
+## The file containing all relevant runtime dependencies, as generated by
+## "mvn dependency:list".
+##
+DEPENDENCY_LIST="$1"
+
+##
+## The output directory in which the generated LICENSE, NOTICE, etc. files
+## should be placed.
+##
+OUTPUT_DIR="$2"
+
+##
+## Lists the license information directories (subdirectories of the
+## "doc/licenses/" directory in the main guacamole-client source tree) that
+## apply to the list of runtime dependencies provided via STDIN. If any runtime
+## dependencies are not described by license information included in the
+## guacamole-client source tree, a error is printed to STDERR.
+##
+## The license information directories for dependencies that are not pulled in
+## automatically (subdirectories of the "src/licenses/bundled/" directory
+## within the current project) will also be included, if any.
+##
+list_dependency_license_info() {
+
+ # List the license directories of all runtime dependencies, as dictated by
+ # the "dep-coordinates.txt" files included within those directories
+ sed 's/^[[:space:]]\+//' | grep -o '^[^: ]\+\(:[^: ]*\)\{1,3\}' | while read DEPENDENCY; do
+
+ if ! grep -l "$DEPENDENCY[[:space:]]*$" "$LICENSES_DIR"/*/dep-coordinates.txt; then
+ error "License information missing for $DEPENDENCY"
+ fi
+
+ done | sort -u | while read LICENSE_INFO_COORDS_FILE; do
+ dirname "$LICENSE_INFO_COORDS_FILE"
+ done
+
+ # Include license directories for all dependencies not pulled in automatically
+ if [ -d ./src/licenses/bundled/ ]; then
+ find src/licenses/bundled/ -mindepth 1 -maxdepth 1 -type d
+ fi
+
+}
+
+##
+## Sorts the given list of license information directories by the name of the
+## dependency, as determined by the header line within that dependency's
+## README. The list of directories is read from STDIN, and the sorted result is
+## written to STDOUT. Each directory must be on its own line.
+##
+sort_dependency_license_info() {
+ while read LICENSE_INFO; do
+
+ if [ ! -e "$LICENSE_INFO/README" ]; then
+ error "Missing license README in $LICENSE_INFO"
+ continue
+ fi
+
+ NAME="`grep . < "$LICENSE_INFO/README" | head -n1`"
+ printf "%s\t%s\n" "$NAME" "$LICENSE_INFO"
+
+ done | sort -f | cut -f2
+}
+
+##
+## Prints the given informational message to STDERR.
+##
+## @param ...
+## The message to print.
+##
+info() {
+ echo "$@" >&2
+}
+
+##
+## Prints the given error message to STDERR, updating HAS_ERRORS
+## appropriately.
+##
+## @param ...
+## The message to print.
+##
+error() {
+ echo "ERROR: $@" >&2
+ echo "1" > "$HAS_ERRORS"
+}
+
+##
+## Prints the first line from STDIN. If more than one line is provided,
+## those lines are omitted, and an error exit code is returned.
+##
+## @return
+## Zero (success) if no more than one line was provided on STDIN,
+## non-zero (failure) otherwise.
+##
+single_result() {
+ read RESULT && echo "$RESULT"
+ ! read DUMMY
+}
+
+##
+## Searches the given directory for a license file, prints the path to the
+## license file found. If multiple files are found, only the first file is
+## printed, and an error is logged to STDERR.
+##
+## @param DIR
+## The directory to search.
+##
+license_file() {
+ DIR="$1"
+ find "$DIR" -mindepth 1 \
+ -a \! -iname "*notice*" \
+ -a \! -name "dep-coordinates.txt" \
+ -a \! -name "README" \
+ | if ! single_result; then
+ error "Multiple license files found within $DIR"
+ fi
+}
+
+##
+## Searches the given directory for a notice file, prints the path to the
+## notice file found. If multiple files are found, only the first file is
+## printed, and a error is logged to STDERR.
+##
+## @param DIR
+## The directory to search.
+##
+notice_file() {
+ DIR="$1"
+ find "$DIR" -iname "*notice*" \
+ | if ! single_result; then
+ error "Multiple notice files found within $DIR"
+ fi
+}
+
+##
+## Prints the contents of the given file, excluding any blank lines at the
+## beginning and end of the file.
+##
+## @param FILENAME
+## The file to print.
+##
+trim_file() {
+
+ FILENAME="$1"
+
+ # Find line number of first and last non-blank lines
+ FIRST_LINE="`awk '/[^\t ]/ {print NR; exit}' "$FILENAME"`"
+ LAST_LINE="`awk '/[^\t ]/ {last=NR} END {print last}' "$FILENAME"`"
+
+ # Print the contents of the file between those lines, inclusive
+ awk "NR==$FIRST_LINE,NR==$LAST_LINE" "$FILENAME"
+
+}
+
+# Verify that an output directory was provided
+if [ -z "$DEPENDENCY_LIST" -o -z "$OUTPUT_DIR" ]; then
+ error "USAGE: $0 DEPENDENCY_LIST OUTPUT_DIRECTORY"
+ exit 1
+fi
+
+# Verify input file actually exists
+if [ ! -r "$DEPENDENCY_LIST" ]; then
+ error "$DEPENDENCY_LIST cannot be read."
+ exit 1
+fi
+
+#
+# Autogenerate base LICENSE and NOTICE
+#
+
+info "Processing runtime dependencies to produce LICENSE and NOTICE. Output will be within \"$OUTPUT_DIR\"."
+mkdir -p "$OUTPUT_DIR"
+
+# Copy overall license up to but not including its subcomponent preamble (the
+# section that starts after a line made up entirely of "=" characters)
+awk 'NR==1 {flag=1}; /^[=]{10,}$/ {flag=0}; flag;' "$BASEDIR/LICENSE" > "$OUTPUT_DIR/LICENSE"
+
+# Copy base NOTICE verbatim
+cp "$BASEDIR/NOTICE" "$OUTPUT_DIR/"
+
+#
+# Autogenerate LICENSE and NOTICE information from dependencies
+#
+
+PREAMBLE_ADDED=0
+find "$DEPENDENCY_LIST" -type f -exec cat '{}' + | \
+ list_dependency_license_info | sort_dependency_license_info | \
+ while read LICENSE_INFO_DIR; do
+
+ # Add subcomponent license preamble if not already added
+ if [ "$PREAMBLE_ADDED" = 0 ]; then
+ cat >> "$OUTPUT_DIR/LICENSE" <> "$OUTPUT_DIR/LICENSE"
+ trim_file "$LICENSE_INFO_DIR/README" >> "$OUTPUT_DIR/LICENSE"
+
+ # Append verbatim copy of license if small enough
+ if [ -n "$LICENSE_FILE" ]; then
+ if [ "`wc -l < "$LICENSE_FILE"`" -le "$LICENSE_COPY_LIMIT" ]; then
+ echo >> "$OUTPUT_DIR/LICENSE"
+ trim_file "$LICENSE_FILE" >> "$OUTPUT_DIR/LICENSE"
+ fi
+ fi
+
+ # Copy NOTICE, if provided
+ if [ -n "$NOTICE_FILE" ]; then
+ printf '\n======== NOTICE for "%s" ========\n\n' "$COMPONENT_NAME" >> "$OUTPUT_DIR/NOTICE"
+ trim_file "$NOTICE_FILE" >> "$OUTPUT_DIR/NOTICE"
+ fi
+
+ # Include verbatim copy of license information
+ mkdir -p "$OUTPUT_DIR/bundled/"
+ cp -Lr "$LICENSE_INFO_DIR" "$OUTPUT_DIR/bundled/"
+
+ # Add README describing nature of the "bundled/" directory
+ cat > "$OUTPUT_DIR/bundled/README" <
+
+ 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 2 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, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA
+
+ Also add information on how to contact you by electronic and paper mail.
+
+ If the program is interactive, make it output a short notice like this
+ when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision 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, the commands
+ you use may be called something other than `show w' and `show c'; they
+ could even be mouse-clicks or menu items--whatever suits your program.
+
+ You should also get your employer (if you work as a programmer) or your
+ school, if any, to sign a "copyright disclaimer" for the program, if
+ necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ program `Gnomovision' (which makes passes at compilers) written by
+ James Hacker.
+
+ signature of Ty Coon, 1 April 1989
+ Ty Coon, President of Vice
+
+ This 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 Library
+ General Public License instead of this License.
+
+---
+
+## CLASSPATH EXCEPTION
+
+ Linking this library statically or dynamically with other modules is
+ making a combined work based on this library. Thus, the terms and
+ conditions of the GNU General Public License version 2 cover the whole
+ combination.
+
+ As a special exception, the copyright holders of this library give you
+ permission to link this library with independent modules to produce an
+ executable, regardless of the license terms of these independent
+ modules, and to copy and distribute the resulting executable under
+ terms of your choice, provided that you also meet, for each linked
+ independent module, the terms and conditions of the license of that
+ module. An independent module is a module which is not derived from or
+ based on this library. If you modify this library, you may extend this
+ exception to your version of the library, but you are not obligated to
+ do so. If you do not wish to do so, delete this exception statement
+ from your version.
diff --git a/doc/licenses/glassfish-hk2-2.6.1/README b/doc/licenses/glassfish-hk2-2.6.1/README
new file mode 100644
index 0000000..00b42cb
--- /dev/null
+++ b/doc/licenses/glassfish-hk2-2.6.1/README
@@ -0,0 +1,8 @@
+GlassFish HK2 (https://eclipse-ee4j.github.io/glassfish-hk2/)
+-------------------------------------------------------------
+
+ Version: 2.6.1
+ From: 'Eclipse Foundation' (https://www.eclipse.org/)
+ License(s):
+ EPL v2.0 (bundled/glassfish-hk2-2.6.1/LICENSE.md)
+
diff --git a/doc/licenses/glassfish-hk2-2.6.1/dep-coordinates.txt b/doc/licenses/glassfish-hk2-2.6.1/dep-coordinates.txt
new file mode 100644
index 0000000..8558a57
--- /dev/null
+++ b/doc/licenses/glassfish-hk2-2.6.1/dep-coordinates.txt
@@ -0,0 +1,6 @@
+org.glassfish.hk2.external:aopalliance-repackaged:jar:2.6.1
+org.glassfish.hk2.external:jakarta.inject:jar:2.6.1
+org.glassfish.hk2:guice-bridge:jar:2.6.1
+org.glassfish.hk2:hk2-api:jar:2.6.1
+org.glassfish.hk2:hk2-locator:jar:2.6.1
+org.glassfish.hk2:hk2-utils:jar:2.6.1
diff --git a/doc/licenses/guava-32.1.3-jre/README b/doc/licenses/guava-32.1.3-jre/README
new file mode 100644
index 0000000..a7ee36e
--- /dev/null
+++ b/doc/licenses/guava-32.1.3-jre/README
@@ -0,0 +1,8 @@
+Guava: Google Core Libraries for Java (https://github.com/google/guava)
+-----------------------------------------------------------------------
+
+ Version: 32.1.3-jre
+ From: 'Google Inc.' (http://www.google.com/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/guava-32.1.3-jre/dep-coordinates.txt b/doc/licenses/guava-32.1.3-jre/dep-coordinates.txt
new file mode 100644
index 0000000..a89f87a
--- /dev/null
+++ b/doc/licenses/guava-32.1.3-jre/dep-coordinates.txt
@@ -0,0 +1,3 @@
+com.google.guava:failureaccess:jar:1.0.1
+com.google.guava:guava:jar:32.1.3-jre
+com.google.guava:listenablefuture:jar:9999.0-empty-to-avoid-conflict-with-guava
diff --git a/doc/licenses/guice-5.1.0/README b/doc/licenses/guice-5.1.0/README
new file mode 100644
index 0000000..6ba456c
--- /dev/null
+++ b/doc/licenses/guice-5.1.0/README
@@ -0,0 +1,8 @@
+Google Guice (https://github.com/google/guice)
+----------------------------------------------
+
+ Version: 5.1.0
+ From: 'Google Inc.' (http://www.google.com/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/guice-5.1.0/dep-coordinates.txt b/doc/licenses/guice-5.1.0/dep-coordinates.txt
new file mode 100644
index 0000000..f338d37
--- /dev/null
+++ b/doc/licenses/guice-5.1.0/dep-coordinates.txt
@@ -0,0 +1,3 @@
+com.google.inject:guice:jar:5.1.0
+com.google.inject.extensions:guice-assistedinject:jar:5.1.0
+com.google.inject.extensions:guice-servlet:jar:5.1.0
diff --git a/doc/licenses/ieee754-1.2.1/LICENSE b/doc/licenses/ieee754-1.2.1/LICENSE
new file mode 100644
index 0000000..5aac82c
--- /dev/null
+++ b/doc/licenses/ieee754-1.2.1/LICENSE
@@ -0,0 +1,11 @@
+Copyright 2008 Fair Oaks Labs, Inc.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/doc/licenses/ieee754-1.2.1/README b/doc/licenses/ieee754-1.2.1/README
new file mode 100644
index 0000000..f15f632
--- /dev/null
+++ b/doc/licenses/ieee754-1.2.1/README
@@ -0,0 +1,7 @@
+ieee754 (https://github.com/feross/ieee754)
+---------------------------------------------
+
+ Version: 1.2.1
+ From: 'Fair Oaks Labs, Inc'
+ License(s):
+ MIT (bundled/ieee754-1.2.1/LICENSE)
diff --git a/doc/licenses/ieee754-1.2.1/dep-coordinates.txt b/doc/licenses/ieee754-1.2.1/dep-coordinates.txt
new file mode 100644
index 0000000..4fb7d77
--- /dev/null
+++ b/doc/licenses/ieee754-1.2.1/dep-coordinates.txt
@@ -0,0 +1 @@
+ieee754:1.2.1
diff --git a/doc/licenses/inherits-2.0.3/LICENSE b/doc/licenses/inherits-2.0.3/LICENSE
new file mode 100644
index 0000000..052085c
--- /dev/null
+++ b/doc/licenses/inherits-2.0.3/LICENSE
@@ -0,0 +1,15 @@
+The ISC License
+
+Copyright (c) Isaac Z. Schlueter
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
diff --git a/doc/licenses/inherits-2.0.3/README b/doc/licenses/inherits-2.0.3/README
new file mode 100644
index 0000000..e2afbf5
--- /dev/null
+++ b/doc/licenses/inherits-2.0.3/README
@@ -0,0 +1,8 @@
+inherits (https://github.com/isaacs/inherits)
+---------------------------------------------
+
+ Version: 2.0.3
+ From: 'Isaac Z. Schlueter' (https://github.com/isaacs)
+ License(s):
+ ISC (bundled/inherits-2.0.3/LICENSE)
+
diff --git a/doc/licenses/inherits-2.0.3/dep-coordinates.txt b/doc/licenses/inherits-2.0.3/dep-coordinates.txt
new file mode 100644
index 0000000..e03ab47
--- /dev/null
+++ b/doc/licenses/inherits-2.0.3/dep-coordinates.txt
@@ -0,0 +1 @@
+inherits:2.0.3
diff --git a/doc/licenses/inherits-2.0.4/LICENSE b/doc/licenses/inherits-2.0.4/LICENSE
new file mode 100644
index 0000000..052085c
--- /dev/null
+++ b/doc/licenses/inherits-2.0.4/LICENSE
@@ -0,0 +1,15 @@
+The ISC License
+
+Copyright (c) Isaac Z. Schlueter
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
diff --git a/doc/licenses/inherits-2.0.4/README b/doc/licenses/inherits-2.0.4/README
new file mode 100644
index 0000000..9d0b401
--- /dev/null
+++ b/doc/licenses/inherits-2.0.4/README
@@ -0,0 +1,8 @@
+inherits (https://github.com/isaacs/inherits)
+---------------------------------------------
+
+ Version: 2.0.4
+ From: 'Isaac Z. Schlueter' (https://github.com/isaacs)
+ License(s):
+ ISC (bundled/inherits-2.0.4/LICENSE)
+
diff --git a/doc/licenses/inherits-2.0.4/dep-coordinates.txt b/doc/licenses/inherits-2.0.4/dep-coordinates.txt
new file mode 100644
index 0000000..4a17c13
--- /dev/null
+++ b/doc/licenses/inherits-2.0.4/dep-coordinates.txt
@@ -0,0 +1 @@
+inherits:2.0.4
diff --git a/doc/licenses/ipaddress-5.5.1/README b/doc/licenses/ipaddress-5.5.1/README
new file mode 100644
index 0000000..cf40738
--- /dev/null
+++ b/doc/licenses/ipaddress-5.5.1/README
@@ -0,0 +1,8 @@
+IPAddress (https://seancfoley.github.io/IPAddress/)
+---------------------------------------------------
+
+ Version: 5.5.1
+ From: 'Sean C Foley' (https://seancfoley.github.io/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/ipaddress-5.5.1/dep-coordinates.txt b/doc/licenses/ipaddress-5.5.1/dep-coordinates.txt
new file mode 100644
index 0000000..3ddc5be
--- /dev/null
+++ b/doc/licenses/ipaddress-5.5.1/dep-coordinates.txt
@@ -0,0 +1 @@
+com.github.seancfoley:ipaddress:jar:5.5.1
diff --git a/doc/licenses/isarray-1.0.0/LICENSE b/doc/licenses/isarray-1.0.0/LICENSE
new file mode 100644
index 0000000..de32266
--- /dev/null
+++ b/doc/licenses/isarray-1.0.0/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013 Julian Gruber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/doc/licenses/isarray-1.0.0/README b/doc/licenses/isarray-1.0.0/README
new file mode 100644
index 0000000..3fde38c
--- /dev/null
+++ b/doc/licenses/isarray-1.0.0/README
@@ -0,0 +1,8 @@
+isarray (https://github.com/juliangruber/isarray)
+---------------------------------------------
+
+ Version: 1.0.0
+ From: 'Julian Gruber' (https://github.com/juliangruber)
+ License(s):
+ MIT (bundled/isarray-1.0.0/LICENSE)
+
diff --git a/doc/licenses/isarray-1.0.0/dep-coordinates.txt b/doc/licenses/isarray-1.0.0/dep-coordinates.txt
new file mode 100644
index 0000000..d444bdb
--- /dev/null
+++ b/doc/licenses/isarray-1.0.0/dep-coordinates.txt
@@ -0,0 +1 @@
+isarray:1.0.0
diff --git a/doc/licenses/j2objc-annotations-2.8/README b/doc/licenses/j2objc-annotations-2.8/README
new file mode 100644
index 0000000..4df8c7a
--- /dev/null
+++ b/doc/licenses/j2objc-annotations-2.8/README
@@ -0,0 +1,8 @@
+Java to Objective-C Annotations (https://github.com/google/j2objc)
+------------------------------------------------------------------
+
+ Version: 2.8
+ From: 'Google Inc.' (http://www.google.com/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/j2objc-annotations-2.8/dep-coordinates.txt b/doc/licenses/j2objc-annotations-2.8/dep-coordinates.txt
new file mode 100644
index 0000000..9e961e7
--- /dev/null
+++ b/doc/licenses/j2objc-annotations-2.8/dep-coordinates.txt
@@ -0,0 +1 @@
+com.google.j2objc:j2objc-annotations:jar:2.8
diff --git a/doc/licenses/jackson-2.18.3/NOTICE b/doc/licenses/jackson-2.18.3/NOTICE
new file mode 100644
index 0000000..e0b3fa0
--- /dev/null
+++ b/doc/licenses/jackson-2.18.3/NOTICE
@@ -0,0 +1,4 @@
+Jackson is a high-performance, Free/Open Source JSON processing library.
+It was originally written by Tatu Saloranta (tatu.saloranta@iki.fi), and has
+been in development since 2007.
+It is currently developed by a community of developers.
diff --git a/doc/licenses/jackson-2.18.3/README b/doc/licenses/jackson-2.18.3/README
new file mode 100644
index 0000000..d9a72f4
--- /dev/null
+++ b/doc/licenses/jackson-2.18.3/README
@@ -0,0 +1,8 @@
+Jackson (https://github.com/FasterXML/jackson)
+----------------------------------------------
+
+ Version: 2.18.2
+ From: 'FasterXML, LLC' (https://github.com/FasterXML)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/jackson-2.18.3/dep-coordinates.txt b/doc/licenses/jackson-2.18.3/dep-coordinates.txt
new file mode 100644
index 0000000..61aece5
--- /dev/null
+++ b/doc/licenses/jackson-2.18.3/dep-coordinates.txt
@@ -0,0 +1,4 @@
+com.fasterxml.jackson.core:jackson-core:jar:2.18.3
+com.fasterxml.jackson.core:jackson-annotations:jar:2.18.3
+com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:jar:2.18.3
+com.fasterxml.jackson.module:jackson-module-jaxb-annotations:jar:2.18.3
diff --git a/doc/licenses/jackson-databind-2.18.3/NOTICE b/doc/licenses/jackson-databind-2.18.3/NOTICE
new file mode 100644
index 0000000..e0b3fa0
--- /dev/null
+++ b/doc/licenses/jackson-databind-2.18.3/NOTICE
@@ -0,0 +1,4 @@
+Jackson is a high-performance, Free/Open Source JSON processing library.
+It was originally written by Tatu Saloranta (tatu.saloranta@iki.fi), and has
+been in development since 2007.
+It is currently developed by a community of developers.
diff --git a/doc/licenses/jackson-databind-2.18.3/README b/doc/licenses/jackson-databind-2.18.3/README
new file mode 100644
index 0000000..59e4aa9
--- /dev/null
+++ b/doc/licenses/jackson-databind-2.18.3/README
@@ -0,0 +1,8 @@
+Jackson-databind (https://github.com/FasterXML/jackson-databind)
+----------------------------------------------
+
+ Version: 2.18.3
+ From: 'FasterXML, LLC' (https://github.com/FasterXML)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/jackson-databind-2.18.3/dep-coordinates.txt b/doc/licenses/jackson-databind-2.18.3/dep-coordinates.txt
new file mode 100644
index 0000000..0eec594
--- /dev/null
+++ b/doc/licenses/jackson-databind-2.18.3/dep-coordinates.txt
@@ -0,0 +1 @@
+com.fasterxml.jackson.core:jackson-databind:jar:2.18.3
diff --git a/doc/licenses/jai-imageio-core-1.4.0/LICENSE.txt b/doc/licenses/jai-imageio-core-1.4.0/LICENSE.txt
new file mode 100644
index 0000000..88e09e0
--- /dev/null
+++ b/doc/licenses/jai-imageio-core-1.4.0/LICENSE.txt
@@ -0,0 +1,39 @@
+Copyright (c) 2005 Sun Microsystems, Inc.
+Copyright © 2010-2014 University of Manchester
+Copyright © 2010-2015 Stian Soiland-Reyes
+Copyright © 2015 Peter Hull
+All Rights Reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+- Redistribution of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+
+- Redistribution in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in
+ the documentation and/or other materials provided with the
+ distribution.
+
+Neither the name of Sun Microsystems, Inc. or the names of
+contributors may be used to endorse or promote products derived
+from this software without specific prior written permission.
+
+This software is provided "AS IS," without a warranty of any
+kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND
+WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
+EXCLUDED. SUN MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL
+NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF
+USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
+DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR
+ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
+CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
+REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
+INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+You acknowledge that this software is not designed or intended for
+use in the design, construction, operation or maintenance of any
+nuclear facility.
diff --git a/doc/licenses/jai-imageio-core-1.4.0/README b/doc/licenses/jai-imageio-core-1.4.0/README
new file mode 100644
index 0000000..6b0c701
--- /dev/null
+++ b/doc/licenses/jai-imageio-core-1.4.0/README
@@ -0,0 +1,12 @@
+Java Advanced Imaging Image I/O (https://github.com/jai-imageio/jai-imageio-core)
+---------------------------------------------------------------------------------
+
+ Version: 1.4.0
+ From:
+ 'Sun Microsystems, Inc.' (https://www.oracle.com/)
+ 'University of Manchester' (https://www.manchester.ac.uk/)
+ 'Stian Soiland-Reyes' (https://github.com/stain)
+ 'Peter Hull'
+ License(s):
+ BSD 3-clause (bundled/jai-imageio-core-1.4.0/LICENSE.txt)
+
diff --git a/doc/licenses/jai-imageio-core-1.4.0/dep-coordinates.txt b/doc/licenses/jai-imageio-core-1.4.0/dep-coordinates.txt
new file mode 100644
index 0000000..b62dccd
--- /dev/null
+++ b/doc/licenses/jai-imageio-core-1.4.0/dep-coordinates.txt
@@ -0,0 +1 @@
+com.github.jai-imageio:jai-imageio-core:jar:1.4.0
diff --git a/doc/licenses/jakarta-activation-1.2.1/LICENSE.md b/doc/licenses/jakarta-activation-1.2.1/LICENSE.md
new file mode 100644
index 0000000..e0358f9
--- /dev/null
+++ b/doc/licenses/jakarta-activation-1.2.1/LICENSE.md
@@ -0,0 +1,29 @@
+
+ Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+
+ - Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+
+ - Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ - Neither the name of the Eclipse Foundation, Inc. nor the names of its
+ contributors may be used to endorse or promote products derived
+ from this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/doc/licenses/jakarta-activation-1.2.1/README b/doc/licenses/jakarta-activation-1.2.1/README
new file mode 100644
index 0000000..5541989
--- /dev/null
+++ b/doc/licenses/jakarta-activation-1.2.1/README
@@ -0,0 +1,8 @@
+Jakarta Activation (https://eclipse-ee4j.github.io/jaf/)
+--------------------------------------------------------
+
+ Version: 1.2.1
+ From: 'Oracle Corporation' (http://www.oracle.com/)
+ License(s):
+ BSD 3-clause (bundled/jakarta-activation-1.2.1/LICENSE.md)
+
diff --git a/doc/licenses/jakarta-activation-1.2.1/dep-coordinates.txt b/doc/licenses/jakarta-activation-1.2.1/dep-coordinates.txt
new file mode 100644
index 0000000..7eff799
--- /dev/null
+++ b/doc/licenses/jakarta-activation-1.2.1/dep-coordinates.txt
@@ -0,0 +1 @@
+jakarta.activation:jakarta.activation-api:jar:1.2.1
diff --git a/doc/licenses/jakarta-activation-1.2.2/LICENSE.md b/doc/licenses/jakarta-activation-1.2.2/LICENSE.md
new file mode 100644
index 0000000..e0358f9
--- /dev/null
+++ b/doc/licenses/jakarta-activation-1.2.2/LICENSE.md
@@ -0,0 +1,29 @@
+
+ Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+
+ - Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+
+ - Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ - Neither the name of the Eclipse Foundation, Inc. nor the names of its
+ contributors may be used to endorse or promote products derived
+ from this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/doc/licenses/jakarta-activation-1.2.2/README b/doc/licenses/jakarta-activation-1.2.2/README
new file mode 100644
index 0000000..0320bc7
--- /dev/null
+++ b/doc/licenses/jakarta-activation-1.2.2/README
@@ -0,0 +1,8 @@
+Jakarta Activation (https://eclipse-ee4j.github.io/jaf/)
+--------------------------------------------------------
+
+ Version: 1.2.2
+ From: 'Oracle Corporation' (http://www.oracle.com/)
+ License(s):
+ BSD 3-clause (bundled/jakarta-activation-1.2.2/LICENSE.md)
+
diff --git a/doc/licenses/jakarta-activation-1.2.2/dep-coordinates.txt b/doc/licenses/jakarta-activation-1.2.2/dep-coordinates.txt
new file mode 100644
index 0000000..aabbe33
--- /dev/null
+++ b/doc/licenses/jakarta-activation-1.2.2/dep-coordinates.txt
@@ -0,0 +1 @@
+jakarta.activation:jakarta.activation-api:jar:1.2.2
diff --git a/doc/licenses/jakarta-annotation-api-1.3.5/LICENSE.md b/doc/licenses/jakarta-annotation-api-1.3.5/LICENSE.md
new file mode 100644
index 0000000..5de3d1b
--- /dev/null
+++ b/doc/licenses/jakarta-annotation-api-1.3.5/LICENSE.md
@@ -0,0 +1,637 @@
+# Eclipse Public License - v 2.0
+
+ THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
+ PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
+ OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
+
+ 1. DEFINITIONS
+
+ "Contribution" means:
+
+ a) in the case of the initial Contributor, the initial content
+ Distributed under this Agreement, and
+
+ b) in the case of each subsequent Contributor:
+ i) changes to the Program, and
+ ii) additions to the Program;
+ where such changes and/or additions to the Program originate from
+ and are Distributed by that particular Contributor. A Contribution
+ "originates" from a Contributor if it was added to the Program by
+ such Contributor itself or anyone acting on such Contributor's behalf.
+ Contributions do not include changes or additions to the Program that
+ are not Modified Works.
+
+ "Contributor" means any person or entity that Distributes the Program.
+
+ "Licensed Patents" mean patent claims licensable by a Contributor which
+ are necessarily infringed by the use or sale of its Contribution alone
+ or when combined with the Program.
+
+ "Program" means the Contributions Distributed in accordance with this
+ Agreement.
+
+ "Recipient" means anyone who receives the Program under this Agreement
+ or any Secondary License (as applicable), including Contributors.
+
+ "Derivative Works" shall mean any work, whether in Source Code or other
+ form, that is based on (or derived from) the Program and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship.
+
+ "Modified Works" shall mean any work in Source Code or other form that
+ results from an addition to, deletion from, or modification of the
+ contents of the Program, including, for purposes of clarity any new file
+ in Source Code form that contains any contents of the Program. Modified
+ Works shall not include works that contain only declarations,
+ interfaces, types, classes, structures, or files of the Program solely
+ in each case in order to link to, bind by name, or subclass the Program
+ or Modified Works thereof.
+
+ "Distribute" means the acts of a) distributing or b) making available
+ in any manner that enables the transfer of a copy.
+
+ "Source Code" means the form of a Program preferred for making
+ modifications, including but not limited to software source code,
+ documentation source, and configuration files.
+
+ "Secondary License" means either the GNU General Public License,
+ Version 2.0, or any later versions of that license, including any
+ exceptions or additional permissions as identified by the initial
+ Contributor.
+
+ 2. GRANT OF RIGHTS
+
+ a) Subject to the terms of this Agreement, each Contributor hereby
+ grants Recipient a non-exclusive, worldwide, royalty-free copyright
+ license to reproduce, prepare Derivative Works of, publicly display,
+ publicly perform, Distribute and sublicense the Contribution of such
+ Contributor, if any, and such Derivative Works.
+
+ b) Subject to the terms of this Agreement, each Contributor hereby
+ grants Recipient a non-exclusive, worldwide, royalty-free patent
+ license under Licensed Patents to make, use, sell, offer to sell,
+ import and otherwise transfer the Contribution of such Contributor,
+ if any, in Source Code or other form. This patent license shall
+ apply to the combination of the Contribution and the Program if, at
+ the time the Contribution is added by the Contributor, such addition
+ of the Contribution causes such combination to be covered by the
+ Licensed Patents. The patent license shall not apply to any other
+ combinations which include the Contribution. No hardware per se is
+ licensed hereunder.
+
+ c) Recipient understands that although each Contributor grants the
+ licenses to its Contributions set forth herein, no assurances are
+ provided by any Contributor that the Program does not infringe the
+ patent or other intellectual property rights of any other entity.
+ Each Contributor disclaims any liability to Recipient for claims
+ brought by any other entity based on infringement of intellectual
+ property rights or otherwise. As a condition to exercising the
+ rights and licenses granted hereunder, each Recipient hereby
+ assumes sole responsibility to secure any other intellectual
+ property rights needed, if any. For example, if a third party
+ patent license is required to allow Recipient to Distribute the
+ Program, it is Recipient's responsibility to acquire that license
+ before distributing the Program.
+
+ d) Each Contributor represents that to its knowledge it has
+ sufficient copyright rights in its Contribution, if any, to grant
+ the copyright license set forth in this Agreement.
+
+ e) Notwithstanding the terms of any Secondary License, no
+ Contributor makes additional grants to any Recipient (other than
+ those set forth in this Agreement) as a result of such Recipient's
+ receipt of the Program under the terms of a Secondary License
+ (if permitted under the terms of Section 3).
+
+ 3. REQUIREMENTS
+
+ 3.1 If a Contributor Distributes the Program in any form, then:
+
+ a) the Program must also be made available as Source Code, in
+ accordance with section 3.2, and the Contributor must accompany
+ the Program with a statement that the Source Code for the Program
+ is available under this Agreement, and informs Recipients how to
+ obtain it in a reasonable manner on or through a medium customarily
+ used for software exchange; and
+
+ b) the Contributor may Distribute the Program under a license
+ different than this Agreement, provided that such license:
+ i) effectively disclaims on behalf of all other Contributors all
+ warranties and conditions, express and implied, including
+ warranties or conditions of title and non-infringement, and
+ implied warranties or conditions of merchantability and fitness
+ for a particular purpose;
+
+ ii) effectively excludes on behalf of all other Contributors all
+ liability for damages, including direct, indirect, special,
+ incidental and consequential damages, such as lost profits;
+
+ iii) does not attempt to limit or alter the recipients' rights
+ in the Source Code under section 3.2; and
+
+ iv) requires any subsequent distribution of the Program by any
+ party to be under a license that satisfies the requirements
+ of this section 3.
+
+ 3.2 When the Program is Distributed as Source Code:
+
+ a) it must be made available under this Agreement, or if the
+ Program (i) is combined with other material in a separate file or
+ files made available under a Secondary License, and (ii) the initial
+ Contributor attached to the Source Code the notice described in
+ Exhibit A of this Agreement, then the Program may be made available
+ under the terms of such Secondary Licenses, and
+
+ b) a copy of this Agreement must be included with each copy of
+ the Program.
+
+ 3.3 Contributors may not remove or alter any copyright, patent,
+ trademark, attribution notices, disclaimers of warranty, or limitations
+ of liability ("notices") contained within the Program from any copy of
+ the Program which they Distribute, provided that Contributors may add
+ their own appropriate notices.
+
+ 4. COMMERCIAL DISTRIBUTION
+
+ Commercial distributors of software may accept certain responsibilities
+ with respect to end users, business partners and the like. While this
+ license is intended to facilitate the commercial use of the Program,
+ the Contributor who includes the Program in a commercial product
+ offering should do so in a manner which does not create potential
+ liability for other Contributors. Therefore, if a Contributor includes
+ the Program in a commercial product offering, such Contributor
+ ("Commercial Contributor") hereby agrees to defend and indemnify every
+ other Contributor ("Indemnified Contributor") against any losses,
+ damages and costs (collectively "Losses") arising from claims, lawsuits
+ and other legal actions brought by a third party against the Indemnified
+ Contributor to the extent caused by the acts or omissions of such
+ Commercial Contributor in connection with its distribution of the Program
+ in a commercial product offering. The obligations in this section do not
+ apply to any claims or Losses relating to any actual or alleged
+ intellectual property infringement. In order to qualify, an Indemnified
+ Contributor must: a) promptly notify the Commercial Contributor in
+ writing of such claim, and b) allow the Commercial Contributor to control,
+ and cooperate with the Commercial Contributor in, the defense and any
+ related settlement negotiations. The Indemnified Contributor may
+ participate in any such claim at its own expense.
+
+ For example, a Contributor might include the Program in a commercial
+ product offering, Product X. That Contributor is then a Commercial
+ Contributor. If that Commercial Contributor then makes performance
+ claims, or offers warranties related to Product X, those performance
+ claims and warranties are such Commercial Contributor's responsibility
+ alone. Under this section, the Commercial Contributor would have to
+ defend claims against the other Contributors related to those performance
+ claims and warranties, and if a court requires any other Contributor to
+ pay any damages as a result, the Commercial Contributor must pay
+ those damages.
+
+ 5. NO WARRANTY
+
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
+ PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
+ BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
+ IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
+ TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
+ PURPOSE. Each Recipient is solely responsible for determining the
+ appropriateness of using and distributing the Program and assumes all
+ risks associated with its exercise of rights under this Agreement,
+ including but not limited to the risks and costs of program errors,
+ compliance with applicable laws, damage to or loss of data, programs
+ or equipment, and unavailability or interruption of operations.
+
+ 6. DISCLAIMER OF LIABILITY
+
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
+ PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
+ SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
+ PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
+ EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGES.
+
+ 7. GENERAL
+
+ If any provision of this Agreement is invalid or unenforceable under
+ applicable law, it shall not affect the validity or enforceability of
+ the remainder of the terms of this Agreement, and without further
+ action by the parties hereto, such provision shall be reformed to the
+ minimum extent necessary to make such provision valid and enforceable.
+
+ If Recipient institutes patent litigation against any entity
+ (including a cross-claim or counterclaim in a lawsuit) alleging that the
+ Program itself (excluding combinations of the Program with other software
+ or hardware) infringes such Recipient's patent(s), then such Recipient's
+ rights granted under Section 2(b) shall terminate as of the date such
+ litigation is filed.
+
+ All Recipient's rights under this Agreement shall terminate if it
+ fails to comply with any of the material terms or conditions of this
+ Agreement and does not cure such failure in a reasonable period of
+ time after becoming aware of such noncompliance. If all Recipient's
+ rights under this Agreement terminate, Recipient agrees to cease use
+ and distribution of the Program as soon as reasonably practicable.
+ However, Recipient's obligations under this Agreement and any licenses
+ granted by Recipient relating to the Program shall continue and survive.
+
+ Everyone is permitted to copy and distribute copies of this Agreement,
+ but in order to avoid inconsistency the Agreement is copyrighted and
+ may only be modified in the following manner. The Agreement Steward
+ reserves the right to publish new versions (including revisions) of
+ this Agreement from time to time. No one other than the Agreement
+ Steward has the right to modify this Agreement. The Eclipse Foundation
+ is the initial Agreement Steward. The Eclipse Foundation may assign the
+ responsibility to serve as the Agreement Steward to a suitable separate
+ entity. Each new version of the Agreement will be given a distinguishing
+ version number. The Program (including Contributions) may always be
+ Distributed subject to the version of the Agreement under which it was
+ received. In addition, after a new version of the Agreement is published,
+ Contributor may elect to Distribute the Program (including its
+ Contributions) under the new version.
+
+ Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
+ receives no rights or licenses to the intellectual property of any
+ Contributor under this Agreement, whether expressly, by implication,
+ estoppel or otherwise. All rights in the Program not expressly granted
+ under this Agreement are reserved. Nothing in this Agreement is intended
+ to be enforceable by any entity that is not a Contributor or Recipient.
+ No third-party beneficiary rights are created under this Agreement.
+
+ Exhibit A - Form of Secondary Licenses Notice
+
+ "This Source Code may also be made available under the following
+ Secondary Licenses when the conditions for such availability set forth
+ in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
+ version(s), and exceptions or additional permissions here}."
+
+ Simply including a copy of this Agreement, including this Exhibit A
+ is not sufficient to license the Source Code under Secondary Licenses.
+
+ If it is not possible or desirable to put the notice in a particular
+ file, then You may include the notice in a location (such as a LICENSE
+ file in a relevant directory) where a recipient would be likely to
+ look for such a notice.
+
+ You may add additional accurate notices of copyright ownership.
+
+---
+
+## The GNU General Public License (GPL) Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor
+ Boston, MA 02110-1335
+ USA
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your freedom to
+ share and change it. By contrast, the GNU General Public License is
+ intended to guarantee your freedom to share and change free software--to
+ make sure the software is free for all its users. This General Public
+ License applies to most of the Free Software Foundation's software and
+ to any other program whose authors commit to using it. (Some other Free
+ Software Foundation software is covered by the GNU Library General
+ Public License instead.) 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 this
+ service 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 make restrictions that forbid anyone
+ to deny you these rights or to ask you to surrender the rights. These
+ restrictions translate to certain responsibilities for you if you
+ distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether gratis
+ or for a fee, you must give the recipients all the rights that you have.
+ 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.
+
+ We protect your rights with two steps: (1) copyright the software, and
+ (2) offer you this license which gives you legal permission to copy,
+ distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+ that everyone understands that there is no warranty for this free
+ software. If the software is modified by someone else and passed on, we
+ want its recipients to know that what they have is not the original, so
+ that any problems introduced by others will not reflect on the original
+ authors' reputations.
+
+ Finally, any free program is threatened constantly by software patents.
+ We wish to avoid the danger that redistributors of a free program will
+ individually obtain patent licenses, in effect making the program
+ proprietary. To prevent this, we have made it clear that any patent must
+ be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+ modification follow.
+
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains a
+ notice placed by the copyright holder saying it may be distributed under
+ the terms of this General Public License. The "Program", below, refers
+ to any such program or work, and a "work based on the Program" means
+ either the Program or any derivative work under copyright law: that is
+ to say, a work containing the Program or a portion of it, either
+ verbatim or with modifications and/or translated into another language.
+ (Hereinafter, translation is included without limitation in the term
+ "modification".) Each licensee is addressed as "you".
+
+ Activities other than copying, distribution and modification are not
+ covered by this License; they are outside its scope. The act of running
+ the Program is not restricted, and the output from the Program is
+ covered only if its contents constitute a work based on the Program
+ (independent of having been made by running the Program). Whether that
+ is true depends on what the Program does.
+
+ 1. You may copy and distribute 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
+ and disclaimer of warranty; keep intact all the notices that refer to
+ this License and to the absence of any warranty; and give any other
+ recipients of the Program a copy of this License along with the Program.
+
+ You may charge a fee for the physical act of transferring a copy, and
+ you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion of
+ it, thus forming a work based on the Program, and copy and distribute
+ such modifications or work under the terms of Section 1 above, provided
+ that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any part
+ thereof, to be licensed as a whole at no charge to all third parties
+ under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a notice
+ that there is no warranty (or else, saying that you provide a
+ warranty) and that users may redistribute the program under these
+ conditions, and telling the user how to view a copy of this License.
+ (Exception: if the Program itself is interactive but does not
+ normally print such an announcement, your work based on the Program
+ is not required to print an announcement.)
+
+ These requirements apply to the modified work as a whole. If
+ identifiable sections of that work are not derived from the Program, and
+ can be reasonably considered independent and separate works in
+ themselves, then this License, and its terms, do not apply to those
+ sections when you distribute them as separate works. But when you
+ distribute the same sections as part of a whole which is a work based on
+ the Program, the distribution of the whole must be on the terms of this
+ License, whose permissions for other licensees extend to the entire
+ whole, and thus to each and every part regardless of who wrote it.
+
+ Thus, it is not the intent of this section to claim rights or contest
+ your rights to work written entirely by you; rather, the intent is to
+ exercise the right to control the distribution of derivative or
+ collective works based on the Program.
+
+ In addition, mere aggregation of another work not based on the Program
+ with the Program (or with a work based on the Program) on a volume of a
+ storage or distribution medium does not bring the other work under the
+ scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+ under Section 2) in object code or executable form under the terms of
+ Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections 1
+ and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your cost
+ of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer to
+ distribute corresponding source code. (This alternative is allowed
+ only for noncommercial distribution and only if you received the
+ program in object code or executable form with such an offer, in
+ accord with Subsection b above.)
+
+ The source code for a work means the preferred form of the work for
+ making modifications to it. For an executable work, complete source code
+ means all the source code for all modules it contains, plus any
+ associated interface definition files, plus the scripts used to control
+ compilation and installation of the executable. However, as a special
+ exception, the source code distributed need not include anything that is
+ normally distributed (in either source or binary form) with the major
+ components (compiler, kernel, and so on) of the operating system on
+ which the executable runs, unless that component itself accompanies the
+ executable.
+
+ If distribution of executable or object code is made by offering access
+ to copy from a designated place, then offering equivalent access to copy
+ the source code from the same place counts as distribution of the source
+ code, even though third parties are not compelled to copy the source
+ along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+ except as expressly provided under this License. Any attempt otherwise
+ to copy, modify, sublicense or distribute the Program is void, and will
+ automatically terminate your rights under this License. However, parties
+ who have received copies, or rights, from you under this License will
+ not have their licenses terminated so long as such parties remain in
+ full compliance.
+
+ 5. You are not required to accept this License, since you have not
+ signed it. However, nothing else grants you permission to modify or
+ distribute the Program or its derivative works. These actions are
+ prohibited by law if you do not accept this License. Therefore, by
+ modifying or distributing the Program (or any work based on the
+ Program), you indicate your acceptance of this License to do so, and all
+ its terms and conditions for copying, distributing or modifying the
+ Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+ Program), the recipient automatically receives a license from the
+ original licensor to copy, distribute or modify the Program subject to
+ these terms and conditions. You may not impose any further restrictions
+ on the recipients' exercise of the rights granted herein. You are not
+ responsible for enforcing compliance by third parties to this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+ infringement or for any other reason (not limited to patent issues),
+ 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 distribute
+ so as to satisfy simultaneously your obligations under this License and
+ any other pertinent obligations, then as a consequence you may not
+ distribute the Program at all. For example, if a patent license would
+ not permit royalty-free redistribution of the Program by all those who
+ receive copies directly or indirectly through you, then the only way you
+ could satisfy both it and this License would be to refrain entirely from
+ distribution of the Program.
+
+ If any portion of this section is held invalid or unenforceable under
+ any particular circumstance, the balance of the section is intended to
+ apply and the section as a whole is intended to apply in other
+ circumstances.
+
+ It is not the purpose of this section to induce you to infringe any
+ patents or other property right claims or to contest validity of any
+ such claims; this section has the sole purpose of protecting the
+ integrity of the free software distribution system, which is implemented
+ by public license practices. Many people have made generous
+ contributions to the wide range of software distributed through that
+ system in reliance on consistent application of that system; it is up to
+ the author/donor to decide if he or she is willing to distribute
+ software through any other system and a licensee cannot impose that choice.
+
+ This section is intended to make thoroughly clear what is believed to be
+ a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+ certain countries either by patents or by copyrighted interfaces, the
+ original copyright holder who places the Program under this License may
+ add an explicit geographical distribution limitation excluding those
+ countries, so that distribution is permitted only in or among countries
+ not thus excluded. In such case, this License incorporates the
+ limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new
+ versions of the 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 a version number of this License which applies to it and "any
+ later version", you have the option of following the terms and
+ conditions either of that version or of any later version published by
+ the Free Software Foundation. If the Program does not specify a version
+ number of this License, you may choose any version ever published by the
+ Free Software Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+ programs whose distribution conditions are different, write to the
+ author to ask for permission. For software which is copyrighted by the
+ Free Software Foundation, write to the Free Software Foundation; we
+ sometimes make exceptions for this. Our decision will be guided by the
+ two goals of preserving the free status of all derivatives of our free
+ software and of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+ WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+ AND/OR REDISTRIBUTE 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.
+
+ 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 convey
+ 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)
+
+ 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 2 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, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA
+
+ Also add information on how to contact you by electronic and paper mail.
+
+ If the program is interactive, make it output a short notice like this
+ when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision 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, the commands
+ you use may be called something other than `show w' and `show c'; they
+ could even be mouse-clicks or menu items--whatever suits your program.
+
+ You should also get your employer (if you work as a programmer) or your
+ school, if any, to sign a "copyright disclaimer" for the program, if
+ necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ program `Gnomovision' (which makes passes at compilers) written by
+ James Hacker.
+
+ signature of Ty Coon, 1 April 1989
+ Ty Coon, President of Vice
+
+ This 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 Library
+ General Public License instead of this License.
+
+---
+
+## CLASSPATH EXCEPTION
+
+ Linking this library statically or dynamically with other modules is
+ making a combined work based on this library. Thus, the terms and
+ conditions of the GNU General Public License version 2 cover the whole
+ combination.
+
+ As a special exception, the copyright holders of this library give you
+ permission to link this library with independent modules to produce an
+ executable, regardless of the license terms of these independent
+ modules, and to copy and distribute the resulting executable under
+ terms of your choice, provided that you also meet, for each linked
+ independent module, the terms and conditions of the license of that
+ module. An independent module is a module which is not derived from or
+ based on this library. If you modify this library, you may extend this
+ exception to your version of the library, but you are not obligated to
+ do so. If you do not wish to do so, delete this exception statement
+ from your version.
diff --git a/doc/licenses/jakarta-annotation-api-1.3.5/README b/doc/licenses/jakarta-annotation-api-1.3.5/README
new file mode 100644
index 0000000..0f83cf6
--- /dev/null
+++ b/doc/licenses/jakarta-annotation-api-1.3.5/README
@@ -0,0 +1,8 @@
+Jakarta Annotations (https://eclipse-ee4j.github.io/common-annotations-api/)
+----------------------------------------------------------------------------
+
+ Version: 1.3.5
+ From: 'Oracle Corporation' (http://www.oracle.com/)
+ License(s):
+ EPL v2.0 (bundled/jakarta-annotation-api-1.3.5/LICENSE.md)
+
diff --git a/doc/licenses/jakarta-annotation-api-1.3.5/dep-coordinates.txt b/doc/licenses/jakarta-annotation-api-1.3.5/dep-coordinates.txt
new file mode 100644
index 0000000..7e5e0d3
--- /dev/null
+++ b/doc/licenses/jakarta-annotation-api-1.3.5/dep-coordinates.txt
@@ -0,0 +1 @@
+jakarta.annotation:jakarta.annotation-api:jar:1.3.5
diff --git a/doc/licenses/jakarta-jaxb-2.3.2/LICENSE.md b/doc/licenses/jakarta-jaxb-2.3.2/LICENSE.md
new file mode 100644
index 0000000..da1c1ce
--- /dev/null
+++ b/doc/licenses/jakarta-jaxb-2.3.2/LICENSE.md
@@ -0,0 +1,28 @@
+Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+ - Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+
+ - Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ - Neither the name of the Eclipse Foundation, Inc. nor the names of its
+ contributors may be used to endorse or promote products derived
+ from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
diff --git a/doc/licenses/jakarta-jaxb-2.3.2/README b/doc/licenses/jakarta-jaxb-2.3.2/README
new file mode 100644
index 0000000..8208511
--- /dev/null
+++ b/doc/licenses/jakarta-jaxb-2.3.2/README
@@ -0,0 +1,8 @@
+Jakarta XML Binding (https://eclipse-ee4j.github.io/jaxb-ri/)
+-------------------------------------------------------------
+
+ Version: 2.3.2
+ From: 'Oracle Corporation' (http://www.oracle.com/)
+ License(s):
+ BSD 3-clause (bundled/jakarta-jaxb-2.3.2/LICENSE.md)
+
diff --git a/doc/licenses/jakarta-jaxb-2.3.2/dep-coordinates.txt b/doc/licenses/jakarta-jaxb-2.3.2/dep-coordinates.txt
new file mode 100644
index 0000000..e129ed3
--- /dev/null
+++ b/doc/licenses/jakarta-jaxb-2.3.2/dep-coordinates.txt
@@ -0,0 +1,3 @@
+jakarta.xml.bind:jakarta.xml.bind-api:jar:2.3.2
+org.glassfish.jaxb:jaxb-runtime:jar:2.3.2
+org.glassfish.jaxb:txw2:jar:2.3.2
diff --git a/doc/licenses/jakarta-jaxb-2.3.3/LICENSE.md b/doc/licenses/jakarta-jaxb-2.3.3/LICENSE.md
new file mode 100644
index 0000000..da1c1ce
--- /dev/null
+++ b/doc/licenses/jakarta-jaxb-2.3.3/LICENSE.md
@@ -0,0 +1,28 @@
+Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+ - Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+
+ - Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ - Neither the name of the Eclipse Foundation, Inc. nor the names of its
+ contributors may be used to endorse or promote products derived
+ from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
diff --git a/doc/licenses/jakarta-jaxb-2.3.3/README b/doc/licenses/jakarta-jaxb-2.3.3/README
new file mode 100644
index 0000000..b0d753d
--- /dev/null
+++ b/doc/licenses/jakarta-jaxb-2.3.3/README
@@ -0,0 +1,8 @@
+Jakarta XML Binding (https://eclipse-ee4j.github.io/jaxb-ri/)
+-------------------------------------------------------------
+
+ Version: 2.3.3
+ From: 'Oracle Corporation' (http://www.oracle.com/)
+ License(s):
+ BSD 3-clause (bundled/jakarta-jaxb-2.3.3/LICENSE.md)
+
diff --git a/doc/licenses/jakarta-jaxb-2.3.3/dep-coordinates.txt b/doc/licenses/jakarta-jaxb-2.3.3/dep-coordinates.txt
new file mode 100644
index 0000000..4880a45
--- /dev/null
+++ b/doc/licenses/jakarta-jaxb-2.3.3/dep-coordinates.txt
@@ -0,0 +1,3 @@
+jakarta.xml.bind:jakarta.xml.bind-api:jar:2.3.3
+org.glassfish.jaxb:jaxb-runtime:jar:2.3.3
+org.glassfish.jaxb:txw2:jar:2.3.3
diff --git a/doc/licenses/jakarta-validation-api-2.0.2/NOTICE b/doc/licenses/jakarta-validation-api-2.0.2/NOTICE
new file mode 100644
index 0000000..2046822
--- /dev/null
+++ b/doc/licenses/jakarta-validation-api-2.0.2/NOTICE
@@ -0,0 +1,11 @@
+# Notices for Eclipse Jakarta Bean Validation
+
+This content is produced and maintained by the Eclipse Jakarta Bean Validation
+project.
+
+* Project home: https://projects.eclipse.org/projects/ee4j.bean-validation
+
+## Trademarks
+
+ Jakarta Bean Validation is a trademark of the Eclipse Foundation.
+
diff --git a/doc/licenses/jakarta-validation-api-2.0.2/README b/doc/licenses/jakarta-validation-api-2.0.2/README
new file mode 100644
index 0000000..51bf9fd
--- /dev/null
+++ b/doc/licenses/jakarta-validation-api-2.0.2/README
@@ -0,0 +1,8 @@
+Jakarta Bean Validation API (https://beanvalidation.org/)
+---------------------------------------------------------
+
+ Version: 2.0.2
+ From: 'Red Hat Inc.' (https://www.redhat.com/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/jakarta-validation-api-2.0.2/dep-coordinates.txt b/doc/licenses/jakarta-validation-api-2.0.2/dep-coordinates.txt
new file mode 100644
index 0000000..f615ecf
--- /dev/null
+++ b/doc/licenses/jakarta-validation-api-2.0.2/dep-coordinates.txt
@@ -0,0 +1 @@
+jakarta.validation:jakarta.validation-api:jar:2.0.2
diff --git a/doc/licenses/jakarta-validation-api-2.1.3/NOTICE b/doc/licenses/jakarta-validation-api-2.1.3/NOTICE
new file mode 100644
index 0000000..2046822
--- /dev/null
+++ b/doc/licenses/jakarta-validation-api-2.1.3/NOTICE
@@ -0,0 +1,11 @@
+# Notices for Eclipse Jakarta Bean Validation
+
+This content is produced and maintained by the Eclipse Jakarta Bean Validation
+project.
+
+* Project home: https://projects.eclipse.org/projects/ee4j.bean-validation
+
+## Trademarks
+
+ Jakarta Bean Validation is a trademark of the Eclipse Foundation.
+
diff --git a/doc/licenses/jakarta-validation-api-2.1.3/README b/doc/licenses/jakarta-validation-api-2.1.3/README
new file mode 100644
index 0000000..ed6d5b9
--- /dev/null
+++ b/doc/licenses/jakarta-validation-api-2.1.3/README
@@ -0,0 +1,8 @@
+Jakarta Bean Validation API (https://beanvalidation.org/)
+---------------------------------------------------------
+
+ Version: 2.1.3
+ From: 'Red Hat Inc.' (https://www.redhat.com/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/jakarta-validation-api-2.1.3/dep-coordinates.txt b/doc/licenses/jakarta-validation-api-2.1.3/dep-coordinates.txt
new file mode 100644
index 0000000..b112b9d
--- /dev/null
+++ b/doc/licenses/jakarta-validation-api-2.1.3/dep-coordinates.txt
@@ -0,0 +1 @@
+jakarta.validation:jakarta.validation-api:jar:2.1.3
diff --git a/doc/licenses/jakarta-ws-rs-api-2.1.6/LICENSE.md b/doc/licenses/jakarta-ws-rs-api-2.1.6/LICENSE.md
new file mode 100644
index 0000000..5de3d1b
--- /dev/null
+++ b/doc/licenses/jakarta-ws-rs-api-2.1.6/LICENSE.md
@@ -0,0 +1,637 @@
+# Eclipse Public License - v 2.0
+
+ THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
+ PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
+ OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
+
+ 1. DEFINITIONS
+
+ "Contribution" means:
+
+ a) in the case of the initial Contributor, the initial content
+ Distributed under this Agreement, and
+
+ b) in the case of each subsequent Contributor:
+ i) changes to the Program, and
+ ii) additions to the Program;
+ where such changes and/or additions to the Program originate from
+ and are Distributed by that particular Contributor. A Contribution
+ "originates" from a Contributor if it was added to the Program by
+ such Contributor itself or anyone acting on such Contributor's behalf.
+ Contributions do not include changes or additions to the Program that
+ are not Modified Works.
+
+ "Contributor" means any person or entity that Distributes the Program.
+
+ "Licensed Patents" mean patent claims licensable by a Contributor which
+ are necessarily infringed by the use or sale of its Contribution alone
+ or when combined with the Program.
+
+ "Program" means the Contributions Distributed in accordance with this
+ Agreement.
+
+ "Recipient" means anyone who receives the Program under this Agreement
+ or any Secondary License (as applicable), including Contributors.
+
+ "Derivative Works" shall mean any work, whether in Source Code or other
+ form, that is based on (or derived from) the Program and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship.
+
+ "Modified Works" shall mean any work in Source Code or other form that
+ results from an addition to, deletion from, or modification of the
+ contents of the Program, including, for purposes of clarity any new file
+ in Source Code form that contains any contents of the Program. Modified
+ Works shall not include works that contain only declarations,
+ interfaces, types, classes, structures, or files of the Program solely
+ in each case in order to link to, bind by name, or subclass the Program
+ or Modified Works thereof.
+
+ "Distribute" means the acts of a) distributing or b) making available
+ in any manner that enables the transfer of a copy.
+
+ "Source Code" means the form of a Program preferred for making
+ modifications, including but not limited to software source code,
+ documentation source, and configuration files.
+
+ "Secondary License" means either the GNU General Public License,
+ Version 2.0, or any later versions of that license, including any
+ exceptions or additional permissions as identified by the initial
+ Contributor.
+
+ 2. GRANT OF RIGHTS
+
+ a) Subject to the terms of this Agreement, each Contributor hereby
+ grants Recipient a non-exclusive, worldwide, royalty-free copyright
+ license to reproduce, prepare Derivative Works of, publicly display,
+ publicly perform, Distribute and sublicense the Contribution of such
+ Contributor, if any, and such Derivative Works.
+
+ b) Subject to the terms of this Agreement, each Contributor hereby
+ grants Recipient a non-exclusive, worldwide, royalty-free patent
+ license under Licensed Patents to make, use, sell, offer to sell,
+ import and otherwise transfer the Contribution of such Contributor,
+ if any, in Source Code or other form. This patent license shall
+ apply to the combination of the Contribution and the Program if, at
+ the time the Contribution is added by the Contributor, such addition
+ of the Contribution causes such combination to be covered by the
+ Licensed Patents. The patent license shall not apply to any other
+ combinations which include the Contribution. No hardware per se is
+ licensed hereunder.
+
+ c) Recipient understands that although each Contributor grants the
+ licenses to its Contributions set forth herein, no assurances are
+ provided by any Contributor that the Program does not infringe the
+ patent or other intellectual property rights of any other entity.
+ Each Contributor disclaims any liability to Recipient for claims
+ brought by any other entity based on infringement of intellectual
+ property rights or otherwise. As a condition to exercising the
+ rights and licenses granted hereunder, each Recipient hereby
+ assumes sole responsibility to secure any other intellectual
+ property rights needed, if any. For example, if a third party
+ patent license is required to allow Recipient to Distribute the
+ Program, it is Recipient's responsibility to acquire that license
+ before distributing the Program.
+
+ d) Each Contributor represents that to its knowledge it has
+ sufficient copyright rights in its Contribution, if any, to grant
+ the copyright license set forth in this Agreement.
+
+ e) Notwithstanding the terms of any Secondary License, no
+ Contributor makes additional grants to any Recipient (other than
+ those set forth in this Agreement) as a result of such Recipient's
+ receipt of the Program under the terms of a Secondary License
+ (if permitted under the terms of Section 3).
+
+ 3. REQUIREMENTS
+
+ 3.1 If a Contributor Distributes the Program in any form, then:
+
+ a) the Program must also be made available as Source Code, in
+ accordance with section 3.2, and the Contributor must accompany
+ the Program with a statement that the Source Code for the Program
+ is available under this Agreement, and informs Recipients how to
+ obtain it in a reasonable manner on or through a medium customarily
+ used for software exchange; and
+
+ b) the Contributor may Distribute the Program under a license
+ different than this Agreement, provided that such license:
+ i) effectively disclaims on behalf of all other Contributors all
+ warranties and conditions, express and implied, including
+ warranties or conditions of title and non-infringement, and
+ implied warranties or conditions of merchantability and fitness
+ for a particular purpose;
+
+ ii) effectively excludes on behalf of all other Contributors all
+ liability for damages, including direct, indirect, special,
+ incidental and consequential damages, such as lost profits;
+
+ iii) does not attempt to limit or alter the recipients' rights
+ in the Source Code under section 3.2; and
+
+ iv) requires any subsequent distribution of the Program by any
+ party to be under a license that satisfies the requirements
+ of this section 3.
+
+ 3.2 When the Program is Distributed as Source Code:
+
+ a) it must be made available under this Agreement, or if the
+ Program (i) is combined with other material in a separate file or
+ files made available under a Secondary License, and (ii) the initial
+ Contributor attached to the Source Code the notice described in
+ Exhibit A of this Agreement, then the Program may be made available
+ under the terms of such Secondary Licenses, and
+
+ b) a copy of this Agreement must be included with each copy of
+ the Program.
+
+ 3.3 Contributors may not remove or alter any copyright, patent,
+ trademark, attribution notices, disclaimers of warranty, or limitations
+ of liability ("notices") contained within the Program from any copy of
+ the Program which they Distribute, provided that Contributors may add
+ their own appropriate notices.
+
+ 4. COMMERCIAL DISTRIBUTION
+
+ Commercial distributors of software may accept certain responsibilities
+ with respect to end users, business partners and the like. While this
+ license is intended to facilitate the commercial use of the Program,
+ the Contributor who includes the Program in a commercial product
+ offering should do so in a manner which does not create potential
+ liability for other Contributors. Therefore, if a Contributor includes
+ the Program in a commercial product offering, such Contributor
+ ("Commercial Contributor") hereby agrees to defend and indemnify every
+ other Contributor ("Indemnified Contributor") against any losses,
+ damages and costs (collectively "Losses") arising from claims, lawsuits
+ and other legal actions brought by a third party against the Indemnified
+ Contributor to the extent caused by the acts or omissions of such
+ Commercial Contributor in connection with its distribution of the Program
+ in a commercial product offering. The obligations in this section do not
+ apply to any claims or Losses relating to any actual or alleged
+ intellectual property infringement. In order to qualify, an Indemnified
+ Contributor must: a) promptly notify the Commercial Contributor in
+ writing of such claim, and b) allow the Commercial Contributor to control,
+ and cooperate with the Commercial Contributor in, the defense and any
+ related settlement negotiations. The Indemnified Contributor may
+ participate in any such claim at its own expense.
+
+ For example, a Contributor might include the Program in a commercial
+ product offering, Product X. That Contributor is then a Commercial
+ Contributor. If that Commercial Contributor then makes performance
+ claims, or offers warranties related to Product X, those performance
+ claims and warranties are such Commercial Contributor's responsibility
+ alone. Under this section, the Commercial Contributor would have to
+ defend claims against the other Contributors related to those performance
+ claims and warranties, and if a court requires any other Contributor to
+ pay any damages as a result, the Commercial Contributor must pay
+ those damages.
+
+ 5. NO WARRANTY
+
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
+ PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
+ BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
+ IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
+ TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
+ PURPOSE. Each Recipient is solely responsible for determining the
+ appropriateness of using and distributing the Program and assumes all
+ risks associated with its exercise of rights under this Agreement,
+ including but not limited to the risks and costs of program errors,
+ compliance with applicable laws, damage to or loss of data, programs
+ or equipment, and unavailability or interruption of operations.
+
+ 6. DISCLAIMER OF LIABILITY
+
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
+ PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
+ SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
+ PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
+ EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGES.
+
+ 7. GENERAL
+
+ If any provision of this Agreement is invalid or unenforceable under
+ applicable law, it shall not affect the validity or enforceability of
+ the remainder of the terms of this Agreement, and without further
+ action by the parties hereto, such provision shall be reformed to the
+ minimum extent necessary to make such provision valid and enforceable.
+
+ If Recipient institutes patent litigation against any entity
+ (including a cross-claim or counterclaim in a lawsuit) alleging that the
+ Program itself (excluding combinations of the Program with other software
+ or hardware) infringes such Recipient's patent(s), then such Recipient's
+ rights granted under Section 2(b) shall terminate as of the date such
+ litigation is filed.
+
+ All Recipient's rights under this Agreement shall terminate if it
+ fails to comply with any of the material terms or conditions of this
+ Agreement and does not cure such failure in a reasonable period of
+ time after becoming aware of such noncompliance. If all Recipient's
+ rights under this Agreement terminate, Recipient agrees to cease use
+ and distribution of the Program as soon as reasonably practicable.
+ However, Recipient's obligations under this Agreement and any licenses
+ granted by Recipient relating to the Program shall continue and survive.
+
+ Everyone is permitted to copy and distribute copies of this Agreement,
+ but in order to avoid inconsistency the Agreement is copyrighted and
+ may only be modified in the following manner. The Agreement Steward
+ reserves the right to publish new versions (including revisions) of
+ this Agreement from time to time. No one other than the Agreement
+ Steward has the right to modify this Agreement. The Eclipse Foundation
+ is the initial Agreement Steward. The Eclipse Foundation may assign the
+ responsibility to serve as the Agreement Steward to a suitable separate
+ entity. Each new version of the Agreement will be given a distinguishing
+ version number. The Program (including Contributions) may always be
+ Distributed subject to the version of the Agreement under which it was
+ received. In addition, after a new version of the Agreement is published,
+ Contributor may elect to Distribute the Program (including its
+ Contributions) under the new version.
+
+ Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
+ receives no rights or licenses to the intellectual property of any
+ Contributor under this Agreement, whether expressly, by implication,
+ estoppel or otherwise. All rights in the Program not expressly granted
+ under this Agreement are reserved. Nothing in this Agreement is intended
+ to be enforceable by any entity that is not a Contributor or Recipient.
+ No third-party beneficiary rights are created under this Agreement.
+
+ Exhibit A - Form of Secondary Licenses Notice
+
+ "This Source Code may also be made available under the following
+ Secondary Licenses when the conditions for such availability set forth
+ in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
+ version(s), and exceptions or additional permissions here}."
+
+ Simply including a copy of this Agreement, including this Exhibit A
+ is not sufficient to license the Source Code under Secondary Licenses.
+
+ If it is not possible or desirable to put the notice in a particular
+ file, then You may include the notice in a location (such as a LICENSE
+ file in a relevant directory) where a recipient would be likely to
+ look for such a notice.
+
+ You may add additional accurate notices of copyright ownership.
+
+---
+
+## The GNU General Public License (GPL) Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor
+ Boston, MA 02110-1335
+ USA
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your freedom to
+ share and change it. By contrast, the GNU General Public License is
+ intended to guarantee your freedom to share and change free software--to
+ make sure the software is free for all its users. This General Public
+ License applies to most of the Free Software Foundation's software and
+ to any other program whose authors commit to using it. (Some other Free
+ Software Foundation software is covered by the GNU Library General
+ Public License instead.) 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 this
+ service 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 make restrictions that forbid anyone
+ to deny you these rights or to ask you to surrender the rights. These
+ restrictions translate to certain responsibilities for you if you
+ distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether gratis
+ or for a fee, you must give the recipients all the rights that you have.
+ 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.
+
+ We protect your rights with two steps: (1) copyright the software, and
+ (2) offer you this license which gives you legal permission to copy,
+ distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+ that everyone understands that there is no warranty for this free
+ software. If the software is modified by someone else and passed on, we
+ want its recipients to know that what they have is not the original, so
+ that any problems introduced by others will not reflect on the original
+ authors' reputations.
+
+ Finally, any free program is threatened constantly by software patents.
+ We wish to avoid the danger that redistributors of a free program will
+ individually obtain patent licenses, in effect making the program
+ proprietary. To prevent this, we have made it clear that any patent must
+ be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+ modification follow.
+
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains a
+ notice placed by the copyright holder saying it may be distributed under
+ the terms of this General Public License. The "Program", below, refers
+ to any such program or work, and a "work based on the Program" means
+ either the Program or any derivative work under copyright law: that is
+ to say, a work containing the Program or a portion of it, either
+ verbatim or with modifications and/or translated into another language.
+ (Hereinafter, translation is included without limitation in the term
+ "modification".) Each licensee is addressed as "you".
+
+ Activities other than copying, distribution and modification are not
+ covered by this License; they are outside its scope. The act of running
+ the Program is not restricted, and the output from the Program is
+ covered only if its contents constitute a work based on the Program
+ (independent of having been made by running the Program). Whether that
+ is true depends on what the Program does.
+
+ 1. You may copy and distribute 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
+ and disclaimer of warranty; keep intact all the notices that refer to
+ this License and to the absence of any warranty; and give any other
+ recipients of the Program a copy of this License along with the Program.
+
+ You may charge a fee for the physical act of transferring a copy, and
+ you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion of
+ it, thus forming a work based on the Program, and copy and distribute
+ such modifications or work under the terms of Section 1 above, provided
+ that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any part
+ thereof, to be licensed as a whole at no charge to all third parties
+ under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a notice
+ that there is no warranty (or else, saying that you provide a
+ warranty) and that users may redistribute the program under these
+ conditions, and telling the user how to view a copy of this License.
+ (Exception: if the Program itself is interactive but does not
+ normally print such an announcement, your work based on the Program
+ is not required to print an announcement.)
+
+ These requirements apply to the modified work as a whole. If
+ identifiable sections of that work are not derived from the Program, and
+ can be reasonably considered independent and separate works in
+ themselves, then this License, and its terms, do not apply to those
+ sections when you distribute them as separate works. But when you
+ distribute the same sections as part of a whole which is a work based on
+ the Program, the distribution of the whole must be on the terms of this
+ License, whose permissions for other licensees extend to the entire
+ whole, and thus to each and every part regardless of who wrote it.
+
+ Thus, it is not the intent of this section to claim rights or contest
+ your rights to work written entirely by you; rather, the intent is to
+ exercise the right to control the distribution of derivative or
+ collective works based on the Program.
+
+ In addition, mere aggregation of another work not based on the Program
+ with the Program (or with a work based on the Program) on a volume of a
+ storage or distribution medium does not bring the other work under the
+ scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+ under Section 2) in object code or executable form under the terms of
+ Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections 1
+ and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your cost
+ of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer to
+ distribute corresponding source code. (This alternative is allowed
+ only for noncommercial distribution and only if you received the
+ program in object code or executable form with such an offer, in
+ accord with Subsection b above.)
+
+ The source code for a work means the preferred form of the work for
+ making modifications to it. For an executable work, complete source code
+ means all the source code for all modules it contains, plus any
+ associated interface definition files, plus the scripts used to control
+ compilation and installation of the executable. However, as a special
+ exception, the source code distributed need not include anything that is
+ normally distributed (in either source or binary form) with the major
+ components (compiler, kernel, and so on) of the operating system on
+ which the executable runs, unless that component itself accompanies the
+ executable.
+
+ If distribution of executable or object code is made by offering access
+ to copy from a designated place, then offering equivalent access to copy
+ the source code from the same place counts as distribution of the source
+ code, even though third parties are not compelled to copy the source
+ along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+ except as expressly provided under this License. Any attempt otherwise
+ to copy, modify, sublicense or distribute the Program is void, and will
+ automatically terminate your rights under this License. However, parties
+ who have received copies, or rights, from you under this License will
+ not have their licenses terminated so long as such parties remain in
+ full compliance.
+
+ 5. You are not required to accept this License, since you have not
+ signed it. However, nothing else grants you permission to modify or
+ distribute the Program or its derivative works. These actions are
+ prohibited by law if you do not accept this License. Therefore, by
+ modifying or distributing the Program (or any work based on the
+ Program), you indicate your acceptance of this License to do so, and all
+ its terms and conditions for copying, distributing or modifying the
+ Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+ Program), the recipient automatically receives a license from the
+ original licensor to copy, distribute or modify the Program subject to
+ these terms and conditions. You may not impose any further restrictions
+ on the recipients' exercise of the rights granted herein. You are not
+ responsible for enforcing compliance by third parties to this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+ infringement or for any other reason (not limited to patent issues),
+ 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 distribute
+ so as to satisfy simultaneously your obligations under this License and
+ any other pertinent obligations, then as a consequence you may not
+ distribute the Program at all. For example, if a patent license would
+ not permit royalty-free redistribution of the Program by all those who
+ receive copies directly or indirectly through you, then the only way you
+ could satisfy both it and this License would be to refrain entirely from
+ distribution of the Program.
+
+ If any portion of this section is held invalid or unenforceable under
+ any particular circumstance, the balance of the section is intended to
+ apply and the section as a whole is intended to apply in other
+ circumstances.
+
+ It is not the purpose of this section to induce you to infringe any
+ patents or other property right claims or to contest validity of any
+ such claims; this section has the sole purpose of protecting the
+ integrity of the free software distribution system, which is implemented
+ by public license practices. Many people have made generous
+ contributions to the wide range of software distributed through that
+ system in reliance on consistent application of that system; it is up to
+ the author/donor to decide if he or she is willing to distribute
+ software through any other system and a licensee cannot impose that choice.
+
+ This section is intended to make thoroughly clear what is believed to be
+ a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+ certain countries either by patents or by copyrighted interfaces, the
+ original copyright holder who places the Program under this License may
+ add an explicit geographical distribution limitation excluding those
+ countries, so that distribution is permitted only in or among countries
+ not thus excluded. In such case, this License incorporates the
+ limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new
+ versions of the 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 a version number of this License which applies to it and "any
+ later version", you have the option of following the terms and
+ conditions either of that version or of any later version published by
+ the Free Software Foundation. If the Program does not specify a version
+ number of this License, you may choose any version ever published by the
+ Free Software Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+ programs whose distribution conditions are different, write to the
+ author to ask for permission. For software which is copyrighted by the
+ Free Software Foundation, write to the Free Software Foundation; we
+ sometimes make exceptions for this. Our decision will be guided by the
+ two goals of preserving the free status of all derivatives of our free
+ software and of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+ WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+ AND/OR REDISTRIBUTE 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.
+
+ 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 convey
+ 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)
+
+ 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 2 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, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA
+
+ Also add information on how to contact you by electronic and paper mail.
+
+ If the program is interactive, make it output a short notice like this
+ when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision 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, the commands
+ you use may be called something other than `show w' and `show c'; they
+ could even be mouse-clicks or menu items--whatever suits your program.
+
+ You should also get your employer (if you work as a programmer) or your
+ school, if any, to sign a "copyright disclaimer" for the program, if
+ necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ program `Gnomovision' (which makes passes at compilers) written by
+ James Hacker.
+
+ signature of Ty Coon, 1 April 1989
+ Ty Coon, President of Vice
+
+ This 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 Library
+ General Public License instead of this License.
+
+---
+
+## CLASSPATH EXCEPTION
+
+ Linking this library statically or dynamically with other modules is
+ making a combined work based on this library. Thus, the terms and
+ conditions of the GNU General Public License version 2 cover the whole
+ combination.
+
+ As a special exception, the copyright holders of this library give you
+ permission to link this library with independent modules to produce an
+ executable, regardless of the license terms of these independent
+ modules, and to copy and distribute the resulting executable under
+ terms of your choice, provided that you also meet, for each linked
+ independent module, the terms and conditions of the license of that
+ module. An independent module is a module which is not derived from or
+ based on this library. If you modify this library, you may extend this
+ exception to your version of the library, but you are not obligated to
+ do so. If you do not wish to do so, delete this exception statement
+ from your version.
diff --git a/doc/licenses/jakarta-ws-rs-api-2.1.6/README b/doc/licenses/jakarta-ws-rs-api-2.1.6/README
new file mode 100644
index 0000000..6abf8c4
--- /dev/null
+++ b/doc/licenses/jakarta-ws-rs-api-2.1.6/README
@@ -0,0 +1,8 @@
+Jakarta RESTful Web Services (https://github.com/eclipse-ee4j/jaxrs-api/)
+-------------------------------------------------------------------------
+
+ Version: 2.1.6
+ From: 'Oracle Corporation' (http://www.oracle.com/)
+ License(s):
+ EPL v2.0 (bundled/jakarta-ws-rs-api-2.1.6/LICENSE.md)
+
diff --git a/doc/licenses/jakarta-ws-rs-api-2.1.6/dep-coordinates.txt b/doc/licenses/jakarta-ws-rs-api-2.1.6/dep-coordinates.txt
new file mode 100644
index 0000000..595b485
--- /dev/null
+++ b/doc/licenses/jakarta-ws-rs-api-2.1.6/dep-coordinates.txt
@@ -0,0 +1 @@
+jakarta.ws.rs:jakarta.ws.rs-api:jar:2.1.6
diff --git a/doc/licenses/java-jwt-4.0.0/LICENSE b/doc/licenses/java-jwt-4.0.0/LICENSE
new file mode 100644
index 0000000..4a7a13a
--- /dev/null
+++ b/doc/licenses/java-jwt-4.0.0/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Auth0, Inc. (http://auth0.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
\ No newline at end of file
diff --git a/doc/licenses/java-jwt-4.0.0/README b/doc/licenses/java-jwt-4.0.0/README
new file mode 100644
index 0000000..4e76b4b
--- /dev/null
+++ b/doc/licenses/java-jwt-4.0.0/README
@@ -0,0 +1,8 @@
+Java JWT (https://github.com/auth0/java-jwt)
+--------------------------------------------
+
+ Version: 4.0.0
+ From: 'Auth0 by Okta' (https://www.auth0.com)
+ License(s):
+ MIT (bundled/java-jwt-4.0.0/LICENSE)
+
diff --git a/doc/licenses/java-jwt-4.0.0/dep-coordinates.txt b/doc/licenses/java-jwt-4.0.0/dep-coordinates.txt
new file mode 100644
index 0000000..9f6f9c1
--- /dev/null
+++ b/doc/licenses/java-jwt-4.0.0/dep-coordinates.txt
@@ -0,0 +1 @@
+com.auth0:java-jwt:jar:4.0.0
diff --git a/doc/licenses/java-saml-2.9.0/LICENSE b/doc/licenses/java-saml-2.9.0/LICENSE
new file mode 100644
index 0000000..578413f
--- /dev/null
+++ b/doc/licenses/java-saml-2.9.0/LICENSE
@@ -0,0 +1,22 @@
+Copyright (c) 2010-2016 OneLogin, Inc.
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
diff --git a/doc/licenses/java-saml-2.9.0/README b/doc/licenses/java-saml-2.9.0/README
new file mode 100644
index 0000000..bd815ac
--- /dev/null
+++ b/doc/licenses/java-saml-2.9.0/README
@@ -0,0 +1,8 @@
+Onelogin Java SAML Client (https://github.com/onelogin/java-saml)
+------------------------------------------------------------------------
+
+ Version: 2.9.0
+ From: 'OneLogin' (https://www.onelogin.com)
+ License(s):
+ MIT License (bundled/java-saml-2.9.0/LICENSE)
+
diff --git a/doc/licenses/java-saml-2.9.0/dep-coordinates.txt b/doc/licenses/java-saml-2.9.0/dep-coordinates.txt
new file mode 100644
index 0000000..2442587
--- /dev/null
+++ b/doc/licenses/java-saml-2.9.0/dep-coordinates.txt
@@ -0,0 +1,2 @@
+com.onelogin:java-saml-core:jar:2.9.0
+com.onelogin:java-saml:jar:2.9.0
diff --git a/doc/licenses/javaee-activation-1.2.0/LICENSE.txt b/doc/licenses/javaee-activation-1.2.0/LICENSE.txt
new file mode 100644
index 0000000..5ad62c4
--- /dev/null
+++ b/doc/licenses/javaee-activation-1.2.0/LICENSE.txt
@@ -0,0 +1,759 @@
+COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.1
+
+1. Definitions.
+
+ 1.1. "Contributor" means each individual or entity that creates or
+ contributes to the creation of Modifications.
+
+ 1.2. "Contributor Version" means the combination of the Original
+ Software, prior Modifications used by a Contributor (if any), and
+ the Modifications made by that particular Contributor.
+
+ 1.3. "Covered Software" means (a) the Original Software, or (b)
+ Modifications, or (c) the combination of files containing Original
+ Software with files containing Modifications, in each case including
+ portions thereof.
+
+ 1.4. "Executable" means the Covered Software in any form other than
+ Source Code.
+
+ 1.5. "Initial Developer" means the individual or entity that first
+ makes Original Software available under this License.
+
+ 1.6. "Larger Work" means a work which combines Covered Software or
+ portions thereof with code not governed by the terms of this License.
+
+ 1.7. "License" means this document.
+
+ 1.8. "Licensable" means having the right to grant, to the maximum
+ extent possible, whether at the time of the initial grant or
+ subsequently acquired, any and all of the rights conveyed herein.
+
+ 1.9. "Modifications" means the Source Code and Executable form of
+ any of the following:
+
+ A. Any file that results from an addition to, deletion from or
+ modification of the contents of a file containing Original Software
+ or previous Modifications;
+
+ B. Any new file that contains any part of the Original Software or
+ previous Modification; or
+
+ C. Any new file that is contributed or otherwise made available
+ under the terms of this License.
+
+ 1.10. "Original Software" means the Source Code and Executable form
+ of computer software code that is originally released under this
+ License.
+
+ 1.11. "Patent Claims" means any patent claim(s), now owned or
+ hereafter acquired, including without limitation, method, process,
+ and apparatus claims, in any patent Licensable by grantor.
+
+ 1.12. "Source Code" means (a) the common form of computer software
+ code in which modifications are made and (b) associated
+ documentation included in or with such code.
+
+ 1.13. "You" (or "Your") means an individual or a legal entity
+ exercising rights under, and complying with all of the terms of,
+ this License. For legal entities, "You" includes any entity which
+ controls, is controlled by, or is under common control with You. For
+ purposes of this definition, "control" means (a) the power, direct
+ or indirect, to cause the direction or management of such entity,
+ whether by contract or otherwise, or (b) ownership of more than
+ fifty percent (50%) of the outstanding shares or beneficial
+ ownership of such entity.
+
+2. License Grants.
+
+ 2.1. The Initial Developer Grant.
+
+ Conditioned upon Your compliance with Section 3.1 below and subject
+ to third party intellectual property claims, the Initial Developer
+ hereby grants You a world-wide, royalty-free, non-exclusive license:
+
+ (a) under intellectual property rights (other than patent or
+ trademark) Licensable by Initial Developer, to use, reproduce,
+ modify, display, perform, sublicense and distribute the Original
+ Software (or portions thereof), with or without Modifications,
+ and/or as part of a Larger Work; and
+
+ (b) under Patent Claims infringed by the making, using or selling of
+ Original Software, to make, have made, use, practice, sell, and
+ offer for sale, and/or otherwise dispose of the Original Software
+ (or portions thereof).
+
+ (c) The licenses granted in Sections 2.1(a) and (b) are effective on
+ the date Initial Developer first distributes or otherwise makes the
+ Original Software available to a third party under the terms of this
+ License.
+
+ (d) Notwithstanding Section 2.1(b) above, no patent license is
+ granted: (1) for code that You delete from the Original Software, or
+ (2) for infringements caused by: (i) the modification of the
+ Original Software, or (ii) the combination of the Original Software
+ with other software or devices.
+
+ 2.2. Contributor Grant.
+
+ Conditioned upon Your compliance with Section 3.1 below and subject
+ to third party intellectual property claims, each Contributor hereby
+ grants You a world-wide, royalty-free, non-exclusive license:
+
+ (a) under intellectual property rights (other than patent or
+ trademark) Licensable by Contributor to use, reproduce, modify,
+ display, perform, sublicense and distribute the Modifications
+ created by such Contributor (or portions thereof), either on an
+ unmodified basis, with other Modifications, as Covered Software
+ and/or as part of a Larger Work; and
+
+ (b) under Patent Claims infringed by the making, using, or selling
+ of Modifications made by that Contributor either alone and/or in
+ combination with its Contributor Version (or portions of such
+ combination), to make, use, sell, offer for sale, have made, and/or
+ otherwise dispose of: (1) Modifications made by that Contributor (or
+ portions thereof); and (2) the combination of Modifications made by
+ that Contributor with its Contributor Version (or portions of such
+ combination).
+
+ (c) The licenses granted in Sections 2.2(a) and 2.2(b) are effective
+ on the date Contributor first distributes or otherwise makes the
+ Modifications available to a third party.
+
+ (d) Notwithstanding Section 2.2(b) above, no patent license is
+ granted: (1) for any code that Contributor has deleted from the
+ Contributor Version; (2) for infringements caused by: (i) third
+ party modifications of Contributor Version, or (ii) the combination
+ of Modifications made by that Contributor with other software
+ (except as part of the Contributor Version) or other devices; or (3)
+ under Patent Claims infringed by Covered Software in the absence of
+ Modifications made by that Contributor.
+
+3. Distribution Obligations.
+
+ 3.1. Availability of Source Code.
+
+ Any Covered Software that You distribute or otherwise make available
+ in Executable form must also be made available in Source Code form
+ and that Source Code form must be distributed only under the terms
+ of this License. You must include a copy of this License with every
+ copy of the Source Code form of the Covered Software You distribute
+ or otherwise make available. You must inform recipients of any such
+ Covered Software in Executable form as to how they can obtain such
+ Covered Software in Source Code form in a reasonable manner on or
+ through a medium customarily used for software exchange.
+
+ 3.2. Modifications.
+
+ The Modifications that You create or to which You contribute are
+ governed by the terms of this License. You represent that You
+ believe Your Modifications are Your original creation(s) and/or You
+ have sufficient rights to grant the rights conveyed by this License.
+
+ 3.3. Required Notices.
+
+ You must include a notice in each of Your Modifications that
+ identifies You as the Contributor of the Modification. You may not
+ remove or alter any copyright, patent or trademark notices contained
+ within the Covered Software, or any notices of licensing or any
+ descriptive text giving attribution to any Contributor or the
+ Initial Developer.
+
+ 3.4. Application of Additional Terms.
+
+ You may not offer or impose any terms on any Covered Software in
+ Source Code form that alters or restricts the applicable version of
+ this License or the recipients' rights hereunder. You may choose to
+ offer, and to charge a fee for, warranty, support, indemnity or
+ liability obligations to one or more recipients of Covered Software.
+ However, you may do so only on Your own behalf, and not on behalf of
+ the Initial Developer or any Contributor. You must make it
+ absolutely clear that any such warranty, support, indemnity or
+ liability obligation is offered by You alone, and You hereby agree
+ to indemnify the Initial Developer and every Contributor for any
+ liability incurred by the Initial Developer or such Contributor as a
+ result of warranty, support, indemnity or liability terms You offer.
+
+ 3.5. Distribution of Executable Versions.
+
+ You may distribute the Executable form of the Covered Software under
+ the terms of this License or under the terms of a license of Your
+ choice, which may contain terms different from this License,
+ provided that You are in compliance with the terms of this License
+ and that the license for the Executable form does not attempt to
+ limit or alter the recipient's rights in the Source Code form from
+ the rights set forth in this License. If You distribute the Covered
+ Software in Executable form under a different license, You must make
+ it absolutely clear that any terms which differ from this License
+ are offered by You alone, not by the Initial Developer or
+ Contributor. You hereby agree to indemnify the Initial Developer and
+ every Contributor for any liability incurred by the Initial
+ Developer or such Contributor as a result of any such terms You offer.
+
+ 3.6. Larger Works.
+
+ You may create a Larger Work by combining Covered Software with
+ other code not governed by the terms of this License and distribute
+ the Larger Work as a single product. In such a case, You must make
+ sure the requirements of this License are fulfilled for the Covered
+ Software.
+
+4. Versions of the License.
+
+ 4.1. New Versions.
+
+ Oracle is the initial license steward and may publish revised and/or
+ new versions of this License from time to time. Each version will be
+ given a distinguishing version number. Except as provided in Section
+ 4.3, no one other than the license steward has the right to modify
+ this License.
+
+ 4.2. Effect of New Versions.
+
+ You may always continue to use, distribute or otherwise make the
+ Covered Software available under the terms of the version of the
+ License under which You originally received the Covered Software. If
+ the Initial Developer includes a notice in the Original Software
+ prohibiting it from being distributed or otherwise made available
+ under any subsequent version of the License, You must distribute and
+ make the Covered Software available under the terms of the version
+ of the License under which You originally received the Covered
+ Software. Otherwise, You may also choose to use, distribute or
+ otherwise make the Covered Software available under the terms of any
+ subsequent version of the License published by the license steward.
+
+ 4.3. Modified Versions.
+
+ When You are an Initial Developer and You want to create a new
+ license for Your Original Software, You may create and use a
+ modified version of this License if You: (a) rename the license and
+ remove any references to the name of the license steward (except to
+ note that the license differs from this License); and (b) otherwise
+ make it clear that the license contains terms which differ from this
+ License.
+
+5. DISCLAIMER OF WARRANTY.
+
+ COVERED SOFTWARE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
+ INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE COVERED SOFTWARE
+ IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR
+ NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF
+ THE COVERED SOFTWARE IS WITH YOU. SHOULD ANY COVERED SOFTWARE PROVE
+ DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL DEVELOPER OR ANY
+ OTHER CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING,
+ REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN
+ ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY COVERED SOFTWARE IS
+ AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER.
+
+6. TERMINATION.
+
+ 6.1. This License and the rights granted hereunder will terminate
+ automatically if You fail to comply with terms herein and fail to
+ cure such breach within 30 days of becoming aware of the breach.
+ Provisions which, by their nature, must remain in effect beyond the
+ termination of this License shall survive.
+
+ 6.2. If You assert a patent infringement claim (excluding
+ declaratory judgment actions) against Initial Developer or a
+ Contributor (the Initial Developer or Contributor against whom You
+ assert such claim is referred to as "Participant") alleging that the
+ Participant Software (meaning the Contributor Version where the
+ Participant is a Contributor or the Original Software where the
+ Participant is the Initial Developer) directly or indirectly
+ infringes any patent, then any and all rights granted directly or
+ indirectly to You by such Participant, the Initial Developer (if the
+ Initial Developer is not the Participant) and all Contributors under
+ Sections 2.1 and/or 2.2 of this License shall, upon 60 days notice
+ from Participant terminate prospectively and automatically at the
+ expiration of such 60 day notice period, unless if within such 60
+ day period You withdraw Your claim with respect to the Participant
+ Software against such Participant either unilaterally or pursuant to
+ a written agreement with Participant.
+
+ 6.3. If You assert a patent infringement claim against Participant
+ alleging that the Participant Software directly or indirectly
+ infringes any patent where such claim is resolved (such as by
+ license or settlement) prior to the initiation of patent
+ infringement litigation, then the reasonable value of the licenses
+ granted by such Participant under Sections 2.1 or 2.2 shall be taken
+ into account in determining the amount or value of any payment or
+ license.
+
+ 6.4. In the event of termination under Sections 6.1 or 6.2 above,
+ all end user licenses that have been validly granted by You or any
+ distributor hereunder prior to termination (excluding licenses
+ granted to You by any distributor) shall survive termination.
+
+7. LIMITATION OF LIABILITY.
+
+ UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT
+ (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL YOU, THE
+ INITIAL DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF
+ COVERED SOFTWARE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE
+ TO ANY PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR
+ CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT
+ LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER
+ FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR
+ LOSSES, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE
+ POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF LIABILITY SHALL NOT
+ APPLY TO LIABILITY FOR DEATH OR PERSONAL INJURY RESULTING FROM SUCH
+ PARTY'S NEGLIGENCE TO THE EXTENT APPLICABLE LAW PROHIBITS SUCH
+ LIMITATION. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR
+ LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION
+ AND LIMITATION MAY NOT APPLY TO YOU.
+
+8. U.S. GOVERNMENT END USERS.
+
+ The Covered Software is a "commercial item," as that term is defined
+ in 48 C.F.R. 2.101 (Oct. 1995), consisting of "commercial computer
+ software" (as that term is defined at 48 C.F.R.
+ 252.227-7014(a)(1)) and "commercial computer software documentation"
+ as such terms are used in 48 C.F.R. 12.212 (Sept. 1995). Consistent
+ with 48 C.F.R. 12.212 and 48 C.F.R. 227.7202-1 through 227.7202-4
+ (June 1995), all U.S. Government End Users acquire Covered Software
+ with only those rights set forth herein. This U.S. Government Rights
+ clause is in lieu of, and supersedes, any other FAR, DFAR, or other
+ clause or provision that addresses Government rights in computer
+ software under this License.
+
+9. MISCELLANEOUS.
+
+ This License represents the complete agreement concerning subject
+ matter hereof. If any provision of this License is held to be
+ unenforceable, such provision shall be reformed only to the extent
+ necessary to make it enforceable. This License shall be governed by
+ the law of the jurisdiction specified in a notice contained within
+ the Original Software (except to the extent applicable law, if any,
+ provides otherwise), excluding such jurisdiction's conflict-of-law
+ provisions. Any litigation relating to this License shall be subject
+ to the jurisdiction of the courts located in the jurisdiction and
+ venue specified in a notice contained within the Original Software,
+ with the losing party responsible for costs, including, without
+ limitation, court costs and reasonable attorneys' fees and expenses.
+ The application of the United Nations Convention on Contracts for
+ the International Sale of Goods is expressly excluded. Any law or
+ regulation which provides that the language of a contract shall be
+ construed against the drafter shall not apply to this License. You
+ agree that You alone are responsible for compliance with the United
+ States export administration regulations (and the export control
+ laws and regulation of any other countries) when You use, distribute
+ or otherwise make available any Covered Software.
+
+10. RESPONSIBILITY FOR CLAIMS.
+
+ As between Initial Developer and the Contributors, each party is
+ responsible for claims and damages arising, directly or indirectly,
+ out of its utilization of rights under this License and You agree to
+ work with Initial Developer and Contributors to distribute such
+ responsibility on an equitable basis. Nothing herein is intended or
+ shall be deemed to constitute any admission of liability.
+
+------------------------------------------------------------------------
+
+NOTICE PURSUANT TO SECTION 9 OF THE COMMON DEVELOPMENT AND DISTRIBUTION
+LICENSE (CDDL)
+
+The code released under the CDDL shall be governed by the laws of the
+State of California (excluding conflict-of-law provisions). Any
+litigation relating to this License shall be subject to the jurisdiction
+of the Federal Courts of the Northern District of California and the
+state courts of the State of California, with venue lying in Santa Clara
+County, California.
+
+
+
+ The GNU General Public License (GPL) Version 2, June 1991
+
+Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+51 Franklin Street, Fifth Floor
+Boston, MA 02110-1335
+USA
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+Preamble
+
+The licenses for most software are designed to take away your freedom to
+share and change it. By contrast, the GNU General Public License is
+intended to guarantee your freedom to share and change free software--to
+make sure the software is free for all its users. This General Public
+License applies to most of the Free Software Foundation's software and
+to any other program whose authors commit to using it. (Some other Free
+Software Foundation software is covered by the GNU Library General
+Public License instead.) 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 this
+service 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 make restrictions that forbid anyone
+to deny you these rights or to ask you to surrender the rights. These
+restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether gratis
+or for a fee, you must give the recipients all the rights that you have.
+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.
+
+We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+Finally, any free program is threatened constantly by software patents.
+We wish to avoid the danger that redistributors of a free program will
+individually obtain patent licenses, in effect making the program
+proprietary. To prevent this, we have made it clear that any patent must
+be licensed for everyone's free use or not licensed at all.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+0. This License applies to any program or other work which contains a
+notice placed by the copyright holder saying it may be distributed under
+the terms of this General Public License. The "Program", below, refers
+to any such program or work, and a "work based on the Program" means
+either the Program or any derivative work under copyright law: that is
+to say, a work containing the Program or a portion of it, either
+verbatim or with modifications and/or translated into another language.
+(Hereinafter, translation is included without limitation in the term
+"modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of running
+the Program is not restricted, and the output from the Program is
+covered only if its contents constitute a work based on the Program
+(independent of having been made by running the Program). Whether that
+is true depends on what the Program does.
+
+1. You may copy and distribute 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
+and disclaimer of warranty; keep intact all the notices that refer to
+this License and to the absence of any warranty; and give any other
+recipients of the Program a copy of this License along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+2. You may modify your copy or copies of the Program or any portion of
+it, thus forming a work based on the Program, and copy and distribute
+such modifications or work under the terms of Section 1 above, provided
+that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any part
+ thereof, to be licensed as a whole at no charge to all third parties
+ under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a notice
+ that there is no warranty (or else, saying that you provide a
+ warranty) and that users may redistribute the program under these
+ conditions, and telling the user how to view a copy of this License.
+ (Exception: if the Program itself is interactive but does not
+ normally print such an announcement, your work based on the Program
+ is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program, and
+can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based on
+the Program, the distribution of the whole must be on the terms of this
+License, whose permissions for other licensees extend to the entire
+whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of a
+storage or distribution medium does not bring the other work under the
+scope of this License.
+
+3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections 1
+ and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your cost
+ of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer to
+ distribute corresponding source code. (This alternative is allowed
+ only for noncommercial distribution and only if you received the
+ program in object code or executable form with such an offer, in
+ accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source code
+means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to control
+compilation and installation of the executable. However, as a special
+exception, the source code distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies the
+executable.
+
+If distribution of executable or object code is made by offering access
+to copy from a designated place, then offering equivalent access to copy
+the source code from the same place counts as distribution of the source
+code, even though third parties are not compelled to copy the source
+along with the object code.
+
+4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt otherwise
+to copy, modify, sublicense or distribute the Program is void, and will
+automatically terminate your rights under this License. However, parties
+who have received copies, or rights, from you under this License will
+not have their licenses terminated so long as such parties remain in
+full compliance.
+
+5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and all
+its terms and conditions for copying, distributing or modifying the
+Program or works based on it.
+
+6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further restrictions
+on the recipients' exercise of the rights granted herein. You are not
+responsible for enforcing compliance by third parties to this License.
+
+7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+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 distribute
+so as to satisfy simultaneously your obligations under this License and
+any other pertinent obligations, then as a consequence you may not
+distribute the Program at all. For example, if a patent license would
+not permit royalty-free redistribution of the Program by all those who
+receive copies directly or indirectly through you, then the only way you
+could satisfy both it and this License would be to refrain entirely from
+distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is implemented
+by public license practices. Many people have made generous
+contributions to the wide range of software distributed through that
+system in reliance on consistent application of that system; it is up to
+the author/donor to decide if he or she is willing to distribute
+software through any other system and a licensee cannot impose that choice.
+
+This section is intended to make thoroughly clear what is believed to be
+a consequence of the rest of this License.
+
+8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License may
+add an explicit geographical distribution limitation excluding those
+countries, so that distribution is permitted only in or among countries
+not thus excluded. In such case, this License incorporates the
+limitation as if written in the body of this License.
+
+9. The Free Software Foundation may publish revised and/or new
+versions of the 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 a version number of this License which applies to it and "any
+later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation. If the Program does not specify a version
+number of this License, you may choose any version ever published by the
+Free Software Foundation.
+
+10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the
+author to ask for permission. For software which is copyrighted by the
+Free Software Foundation, write to the Free Software Foundation; we
+sometimes make exceptions for this. Our decision will be guided by the
+two goals of preserving the free status of all derivatives of our free
+software and of promoting the sharing and reuse of software generally.
+
+NO WARRANTY
+
+11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
+
+12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE 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.
+
+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 convey
+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)
+
+ 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 2 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, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision 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, the commands
+you use may be called something other than `show w' and `show c'; they
+could even be mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ program `Gnomovision' (which makes passes at compilers) written by
+ James Hacker.
+
+ signature of Ty Coon, 1 April 1989
+ Ty Coon, President of Vice
+
+This 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 Library
+General Public License instead of this License.
+
+#
+
+Certain source files distributed by Oracle America, Inc. and/or its
+affiliates are subject to the following clarification and special
+exception to the GPLv2, based on the GNU Project exception for its
+Classpath libraries, known as the GNU Classpath Exception, but only
+where Oracle has expressly included in the particular source file's
+header the words "Oracle designates this particular file as subject to
+the "Classpath" exception as provided by Oracle in the LICENSE file
+that accompanied this code."
+
+You should also note that Oracle includes multiple, independent
+programs in this software package. Some of those programs are provided
+under licenses deemed incompatible with the GPLv2 by the Free Software
+Foundation and others. For example, the package includes programs
+licensed under the Apache License, Version 2.0. Such programs are
+licensed to you under their original licenses.
+
+Oracle facilitates your further distribution of this package by adding
+the Classpath Exception to the necessary parts of its GPLv2 code, which
+permits you to use that code in combination with other independent
+modules not licensed under the GPLv2. However, note that this would
+not permit you to commingle code under an incompatible license with
+Oracle's GPLv2 licensed code by, for example, cutting and pasting such
+code into a file also containing Oracle's GPLv2 licensed code and then
+distributing the result. Additionally, if you were to remove the
+Classpath Exception from any of the files to which it applies and
+distribute the result, you would likely be required to license some or
+all of the other code in that distribution under the GPLv2 as well, and
+since the GPLv2 is incompatible with the license terms of some items
+included in the distribution by Oracle, removing the Classpath
+Exception could therefore effectively compromise your ability to
+further distribute the package.
+
+Proceed with caution and we recommend that you obtain the advice of a
+lawyer skilled in open source matters before removing the Classpath
+Exception or making modifications to this package which may
+subsequently be redistributed and/or involve the use of third party
+software.
+
+CLASSPATH EXCEPTION
+Linking this library statically or dynamically with other modules is
+making a combined work based on this library. Thus, the terms and
+conditions of the GNU General Public License version 2 cover the whole
+combination.
+
+As a special exception, the copyright holders of this library give you
+permission to link this library with independent modules to produce an
+executable, regardless of the license terms of these independent
+modules, and to copy and distribute the resulting executable under
+terms of your choice, provided that you also meet, for each linked
+independent module, the terms and conditions of the license of that
+module. An independent module is a module which is not derived from or
+based on this library. If you modify this library, you may extend this
+exception to your version of the library, but you are not obligated to
+do so. If you do not wish to do so, delete this exception statement
+from your version.
diff --git a/doc/licenses/javaee-activation-1.2.0/README b/doc/licenses/javaee-activation-1.2.0/README
new file mode 100644
index 0000000..996821f
--- /dev/null
+++ b/doc/licenses/javaee-activation-1.2.0/README
@@ -0,0 +1,8 @@
+JavaBeans Activation Framework (https://github.com/javaee/activation)
+------------------------------u--------------------------------------
+
+ Version: 1.2.0
+ From: 'Oracle and/or its affiliates'
+ License(s):
+ CDDL v1.1 (bundled/javaee-activation-1.2.0/LICENSE.txt)
+
diff --git a/doc/licenses/javaee-activation-1.2.0/dep-coordinates.txt b/doc/licenses/javaee-activation-1.2.0/dep-coordinates.txt
new file mode 100644
index 0000000..fc9dd22
--- /dev/null
+++ b/doc/licenses/javaee-activation-1.2.0/dep-coordinates.txt
@@ -0,0 +1 @@
+javax.activation:javax.activation-api:jar:1.2.0
diff --git a/doc/licenses/javassist-3.30.2-ga/README b/doc/licenses/javassist-3.30.2-ga/README
new file mode 100644
index 0000000..ace93d9
--- /dev/null
+++ b/doc/licenses/javassist-3.30.2-ga/README
@@ -0,0 +1,8 @@
+Javassist (https://www.javassist.org/)
+--------------------------------------
+
+ Version: 3.30.2-GA
+ From: 'Shigeru Chiba' (https://github.com/chibash)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/javassist-3.30.2-ga/dep-coordinates.txt b/doc/licenses/javassist-3.30.2-ga/dep-coordinates.txt
new file mode 100644
index 0000000..eaeede2
--- /dev/null
+++ b/doc/licenses/javassist-3.30.2-ga/dep-coordinates.txt
@@ -0,0 +1 @@
+org.javassist:javassist:jar:3.30.2-GA
diff --git a/doc/licenses/javax.inject-1/README b/doc/licenses/javax.inject-1/README
new file mode 100644
index 0000000..716a58e
--- /dev/null
+++ b/doc/licenses/javax.inject-1/README
@@ -0,0 +1,8 @@
+JSR-330 / Dependency Injection for Java (http://code.google.com/p/atinject/)
+----------------------------------------------------------------------------
+
+ Version: 1
+ From: 'JSR-330 Expert Group' (https://jcp.org/en/jsr/detail?id=330)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/javax.inject-1/dep-coordinates.txt b/doc/licenses/javax.inject-1/dep-coordinates.txt
new file mode 100644
index 0000000..e99938e
--- /dev/null
+++ b/doc/licenses/javax.inject-1/dep-coordinates.txt
@@ -0,0 +1 @@
+javax.inject:javax.inject:jar:1
diff --git a/doc/licenses/jaxb-api-2.2.12/LICENSE.txt b/doc/licenses/jaxb-api-2.2.12/LICENSE.txt
new file mode 100644
index 0000000..833a843
--- /dev/null
+++ b/doc/licenses/jaxb-api-2.2.12/LICENSE.txt
@@ -0,0 +1,274 @@
+COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL)Version 1.1
+
+1. Definitions.
+
+ 1.1. "Contributor" means each individual or entity that creates or contributes to the creation of Modifications.
+
+ 1.2. "Contributor Version" means the combination of the Original Software, prior Modifications used by a Contributor (if any), and the Modifications made by that particular Contributor.
+
+ 1.3. "Covered Software" means (a) the Original Software, or (b) Modifications, or (c) the combination of files containing Original Software with files containing Modifications, in each case including portions thereof.
+
+ 1.4. "Executable" means the Covered Software in any form other than Source Code.
+
+ 1.5. "Initial Developer" means the individual or entity that first makes Original Software available under this License.
+
+ 1.6. "Larger Work" means a work which combines Covered Software or portions thereof with code not governed by the terms of this License.
+
+ 1.7. "License" means this document.
+
+ 1.8. "Licensable" means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently acquired, any and all of the rights conveyed herein.
+
+ 1.9. "Modifications" means the Source Code and Executable form of any of the following:
+
+ A. Any file that results from an addition to, deletion from or modification of the contents of a file containing Original Software or previous Modifications;
+
+ B. Any new file that contains any part of the Original Software or previous Modification; or
+
+ C. Any new file that is contributed or otherwise made available under the terms of this License.
+
+ 1.10. "Original Software" means the Source Code and Executable form of computer software code that is originally released under this License.
+
+ 1.11. "Patent Claims" means any patent claim(s), now owned or hereafter acquired, including without limitation, method, process, and apparatus claims, in any patent Licensable by grantor.
+
+ 1.12. "Source Code" means (a) the common form of computer software code in which modifications are made and (b) associated documentation included in or with such code.
+
+ 1.13. "You" (or "Your") means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License. For legal entities, "You" includes any entity which controls, is controlled by, or is under common control with You. For purposes of this definition, "control" means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity.
+
+2. License Grants.
+
+ 2.1. The Initial Developer Grant.
+
+ Conditioned upon Your compliance with Section 3.1 below and subject to third party intellectual property claims, the Initial Developer hereby grants You a world-wide, royalty-free, non-exclusive license:
+
+ (a) under intellectual property rights (other than patent or trademark) Licensable by Initial Developer, to use, reproduce, modify, display, perform, sublicense and distribute the Original Software (or portions thereof), with or without Modifications, and/or as part of a Larger Work; and
+
+ (b) under Patent Claims infringed by the making, using or selling of Original Software, to make, have made, use, practice, sell, and offer for sale, and/or otherwise dispose of the Original Software (or portions thereof).
+
+ (c) The licenses granted in Sections 2.1(a) and (b) are effective on the date Initial Developer first distributes or otherwise makes the Original Software available to a third party under the terms of this License.
+
+ (d) Notwithstanding Section 2.1(b) above, no patent license is granted: (1) for code that You delete from the Original Software, or (2) for infringements caused by: (i) the modification of the Original Software, or (ii) the combination of the Original Software with other software or devices.
+
+ 2.2. Contributor Grant.
+
+ Conditioned upon Your compliance with Section 3.1 below and subject to third party intellectual property claims, each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license:
+
+ (a) under intellectual property rights (other than patent or trademark) Licensable by Contributor to use, reproduce, modify, display, perform, sublicense and distribute the Modifications created by such Contributor (or portions thereof), either on an unmodified basis, with other Modifications, as Covered Software and/or as part of a Larger Work; and
+
+ (b) under Patent Claims infringed by the making, using, or selling of Modifications made by that Contributor either alone and/or in combination with its Contributor Version (or portions of such combination), to make, use, sell, offer for sale, have made, and/or otherwise dispose of: (1) Modifications made by that Contributor (or portions thereof); and (2) the combination of Modifications made by that Contributor with its Contributor Version (or portions of such combination).
+
+ (c) The licenses granted in Sections 2.2(a) and 2.2(b) are effective on the date Contributor first distributes or otherwise makes the Modifications available to a third party.
+
+ (d) Notwithstanding Section 2.2(b) above, no patent license is granted: (1) for any code that Contributor has deleted from the Contributor Version; (2) for infringements caused by: (i) third party modifications of Contributor Version, or (ii) the combination of Modifications made by that Contributor with other software (except as part of the Contributor Version) or other devices; or (3) under Patent Claims infringed by Covered Software in the absence of Modifications made by that Contributor.
+
+3. Distribution Obligations.
+
+ 3.1. Availability of Source Code.
+
+ Any Covered Software that You distribute or otherwise make available in Executable form must also be made available in Source Code form and that Source Code form must be distributed only under the terms of this License. You must include a copy of this License with every copy of the Source Code form of the Covered Software You distribute or otherwise make available. You must inform recipients of any such Covered Software in Executable form as to how they can obtain such Covered Software in Source Code form in a reasonable manner on or through a medium customarily used for software exchange.
+
+ 3.2. Modifications.
+
+ The Modifications that You create or to which You contribute are governed by the terms of this License. You represent that You believe Your Modifications are Your original creation(s) and/or You have sufficient rights to grant the rights conveyed by this License.
+
+ 3.3. Required Notices.
+
+ You must include a notice in each of Your Modifications that identifies You as the Contributor of the Modification. You may not remove or alter any copyright, patent or trademark notices contained within the Covered Software, or any notices of licensing or any descriptive text giving attribution to any Contributor or the Initial Developer.
+
+ 3.4. Application of Additional Terms.
+
+ You may not offer or impose any terms on any Covered Software in Source Code form that alters or restricts the applicable version of this License or the recipients' rights hereunder. You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, you may do so only on Your own behalf, and not on behalf of the Initial Developer or any Contributor. You must make it absolutely clear that any such warranty, support, indemnity or liability obligation is offered by You alone, and You hereby agree to indemnify the Initial Developer and every Contributor for any liability incurred by the Initial Developer or such Contributor as a result of warranty, support, indemnity or liability terms You offer.
+
+ 3.5. Distribution of Executable Versions.
+
+ You may distribute the Executable form of the Covered Software under the terms of this License or under the terms of a license of Your choice, which may contain terms different from this License, provided that You are in compliance with the terms of this License and that the license for the Executable form does not attempt to limit or alter the recipient's rights in the Source Code form from the rights set forth in this License. If You distribute the Covered Software in Executable form under a different license, You must make it absolutely clear that any terms which differ from this License are offered by You alone, not by the Initial Developer or Contributor. You hereby agree to indemnify the Initial Developer and every Contributor for any liability incurred by the Initial Developer or such Contributor as a result of any such terms You offer.
+
+ 3.6. Larger Works.
+
+ You may create a Larger Work by combining Covered Software with other code not governed by the terms of this License and distribute the Larger Work as a single product. In such a case, You must make sure the requirements of this License are fulfilled for the Covered Software.
+
+4. Versions of the License.
+
+ 4.1. New Versions.
+
+ Oracle is the initial license steward and may publish revised and/or new versions of this License from time to time. Each version will be given a distinguishing version number. Except as provided in Section 4.3, no one other than the license steward has the right to modify this License.
+
+ 4.2. Effect of New Versions.
+
+ You may always continue to use, distribute or otherwise make the Covered Software available under the terms of the version of the License under which You originally received the Covered Software. If the Initial Developer includes a notice in the Original Software prohibiting it from being distributed or otherwise made available under any subsequent version of the License, You must distribute and make the Covered Software available under the terms of the version of the License under which You originally received the Covered Software. Otherwise, You may also choose to use, distribute or otherwise make the Covered Software available under the terms of any subsequent version of the License published by the license steward.
+
+ 4.3. Modified Versions.
+
+ When You are an Initial Developer and You want to create a new license for Your Original Software, You may create and use a modified version of this License if You: (a) rename the license and remove any references to the name of the license steward (except to note that the license differs from this License); and (b) otherwise make it clear that the license contains terms which differ from this License.
+
+5. DISCLAIMER OF WARRANTY.
+
+ COVERED SOFTWARE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE COVERED SOFTWARE IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE COVERED SOFTWARE IS WITH YOU. SHOULD ANY COVERED SOFTWARE PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY COVERED SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER.
+
+6. TERMINATION.
+
+ 6.1. This License and the rights granted hereunder will terminate automatically if You fail to comply with terms herein and fail to cure such breach within 30 days of becoming aware of the breach. Provisions which, by their nature, must remain in effect beyond the termination of this License shall survive.
+
+ 6.2. If You assert a patent infringement claim (excluding declaratory judgment actions) against Initial Developer or a Contributor (the Initial Developer or Contributor against whom You assert such claim is referred to as "Participant") alleging that the Participant Software (meaning the Contributor Version where the Participant is a Contributor or the Original Software where the Participant is the Initial Developer) directly or indirectly infringes any patent, then any and all rights granted directly or indirectly to You by such Participant, the Initial Developer (if the Initial Developer is not the Participant) and all Contributors under Sections 2.1 and/or 2.2 of this License shall, upon 60 days notice from Participant terminate prospectively and automatically at the expiration of such 60 day notice period, unless if within such 60 day period You withdraw Your claim with respect to the Participant Software against such Participant either unilaterally or pursuant to a written agreement with Participant.
+
+ 6.3. If You assert a patent infringement claim against Participant alleging that the Participant Software directly or indirectly infringes any patent where such claim is resolved (such as by license or settlement) prior to the initiation of patent infringement litigation, then the reasonable value of the licenses granted by such Participant under Sections 2.1 or 2.2 shall be taken into account in determining the amount or value of any payment or license.
+
+ 6.4. In the event of termination under Sections 6.1 or 6.2 above, all end user licenses that have been validly granted by You or any distributor hereunder prior to termination (excluding licenses granted to You by any distributor) shall survive termination.
+
+7. LIMITATION OF LIABILITY.
+
+ UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL YOU, THE INITIAL DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF COVERED SOFTWARE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF LIABILITY SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL INJURY RESULTING FROM SUCH PARTY'S NEGLIGENCE TO THE EXTENT APPLICABLE LAW PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION AND LIMITATION MAY NOT APPLY TO YOU.
+
+8. U.S. GOVERNMENT END USERS.
+
+ The Covered Software is a "commercial item," as that term is defined in 48 C.F.R. 2.101 (Oct. 1995), consisting of "commercial computer software" (as that term is defined at 48 C.F.R. ? 252.227-7014(a)(1)) and "commercial computer software documentation" as such terms are used in 48 C.F.R. 12.212 (Sept. 1995). Consistent with 48 C.F.R. 12.212 and 48 C.F.R. 227.7202-1 through 227.7202-4 (June 1995), all U.S. Government End Users acquire Covered Software with only those rights set forth herein. This U.S. Government Rights clause is in lieu of, and supersedes, any other FAR, DFAR, or other clause or provision that addresses Government rights in computer software under this License.
+
+9. MISCELLANEOUS.
+
+ This License represents the complete agreement concerning subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. This License shall be governed by the law of the jurisdiction specified in a notice contained within the Original Software (except to the extent applicable law, if any, provides otherwise), excluding such jurisdiction's conflict-of-law provisions. Any litigation relating to this License shall be subject to the jurisdiction of the courts located in the jurisdiction and venue specified in a notice contained within the Original Software, with the losing party responsible for costs, including, without limitation, court costs and reasonable attorneys' fees and expenses. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not apply to this License. You agree that You alone are responsible for compliance with the United States export administration regulations (and the export control laws and regulation of any other countries) when You use, distribute or otherwise make available any Covered Software.
+
+10. RESPONSIBILITY FOR CLAIMS.
+
+ As between Initial Developer and the Contributors, each party is responsible for claims and damages arising, directly or indirectly, out of its utilization of rights under this License and You agree to work with Initial Developer and Contributors to distribute such responsibility on an equitable basis. Nothing herein is intended or shall be deemed to constitute any admission of liability.
+
+----------
+NOTICE PURSUANT TO SECTION 9 OF THE COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL)
+The code released under the CDDL shall be governed by the laws of the State of California (excluding conflict-of-law provisions). Any litigation relating to this License shall be subject to the jurisdiction of the Federal Courts of the Northern District of California and the state courts of the State of California, with venue lying in Santa Clara County, California.
+
+
+
+
+The GNU General Public License (GPL) Version 2, June 1991
+
+
+Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+
+Preamble
+
+The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) 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 this service 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 make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. 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.
+
+We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.
+
+Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.
+
+Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.
+
+The precise terms and conditions for copying, distribution and modification follow.
+
+
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
+
+1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
+
+2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
+
+3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
+
+If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
+
+4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
+
+5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
+
+6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.
+
+7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), 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 distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
+
+This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
+
+8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.
+
+9. The Free Software Foundation may publish revised and/or new versions of the 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 a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
+
+10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
+
+NO WARRANTY
+
+11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
+
+12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE 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.
+
+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 convey 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)
+
+ 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 2 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, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision 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, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ signature of Ty Coon, 1 April 1989
+ Ty Coon, President of Vice
+
+This 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 Library General Public License instead of this License.
+
+
+"CLASSPATH" EXCEPTION TO THE GPL VERSION 2
+
+Certain source files distributed by Oracle are subject to the following clarification and special exception to the GPL Version 2, but only where Oracle has expressly included in the particular source file's header the words "Oracle designates this particular file as subject to the "Classpath" exception as provided by Oracle in the License file that accompanied this code."
+
+Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License Version 2 cover the whole combination.
+
+As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.
diff --git a/doc/licenses/jaxb-api-2.2.12/README b/doc/licenses/jaxb-api-2.2.12/README
new file mode 100644
index 0000000..3344842
--- /dev/null
+++ b/doc/licenses/jaxb-api-2.2.12/README
@@ -0,0 +1,8 @@
+JAXB API / XML Processing (https://github.com/javaee/jaxb-spec)
+---------------------------------------------------------------
+
+ Version: 2.2.12
+ From: 'Oracle' (http://www.oracle.com)
+ License(s):
+ CDDL v1.1 (bundled/jaxb-api-2.2.12/LICENSE.txt)
+
diff --git a/doc/licenses/jaxb-api-2.2.12/dep-coordinates.txt b/doc/licenses/jaxb-api-2.2.12/dep-coordinates.txt
new file mode 100644
index 0000000..0abdb03
--- /dev/null
+++ b/doc/licenses/jaxb-api-2.2.12/dep-coordinates.txt
@@ -0,0 +1 @@
+javax.xml.bind:jaxb-api:jar:2.2.12
diff --git a/doc/licenses/jaxb-api-2.3.1/LICENSE.txt b/doc/licenses/jaxb-api-2.3.1/LICENSE.txt
new file mode 100644
index 0000000..833a843
--- /dev/null
+++ b/doc/licenses/jaxb-api-2.3.1/LICENSE.txt
@@ -0,0 +1,274 @@
+COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL)Version 1.1
+
+1. Definitions.
+
+ 1.1. "Contributor" means each individual or entity that creates or contributes to the creation of Modifications.
+
+ 1.2. "Contributor Version" means the combination of the Original Software, prior Modifications used by a Contributor (if any), and the Modifications made by that particular Contributor.
+
+ 1.3. "Covered Software" means (a) the Original Software, or (b) Modifications, or (c) the combination of files containing Original Software with files containing Modifications, in each case including portions thereof.
+
+ 1.4. "Executable" means the Covered Software in any form other than Source Code.
+
+ 1.5. "Initial Developer" means the individual or entity that first makes Original Software available under this License.
+
+ 1.6. "Larger Work" means a work which combines Covered Software or portions thereof with code not governed by the terms of this License.
+
+ 1.7. "License" means this document.
+
+ 1.8. "Licensable" means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently acquired, any and all of the rights conveyed herein.
+
+ 1.9. "Modifications" means the Source Code and Executable form of any of the following:
+
+ A. Any file that results from an addition to, deletion from or modification of the contents of a file containing Original Software or previous Modifications;
+
+ B. Any new file that contains any part of the Original Software or previous Modification; or
+
+ C. Any new file that is contributed or otherwise made available under the terms of this License.
+
+ 1.10. "Original Software" means the Source Code and Executable form of computer software code that is originally released under this License.
+
+ 1.11. "Patent Claims" means any patent claim(s), now owned or hereafter acquired, including without limitation, method, process, and apparatus claims, in any patent Licensable by grantor.
+
+ 1.12. "Source Code" means (a) the common form of computer software code in which modifications are made and (b) associated documentation included in or with such code.
+
+ 1.13. "You" (or "Your") means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License. For legal entities, "You" includes any entity which controls, is controlled by, or is under common control with You. For purposes of this definition, "control" means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity.
+
+2. License Grants.
+
+ 2.1. The Initial Developer Grant.
+
+ Conditioned upon Your compliance with Section 3.1 below and subject to third party intellectual property claims, the Initial Developer hereby grants You a world-wide, royalty-free, non-exclusive license:
+
+ (a) under intellectual property rights (other than patent or trademark) Licensable by Initial Developer, to use, reproduce, modify, display, perform, sublicense and distribute the Original Software (or portions thereof), with or without Modifications, and/or as part of a Larger Work; and
+
+ (b) under Patent Claims infringed by the making, using or selling of Original Software, to make, have made, use, practice, sell, and offer for sale, and/or otherwise dispose of the Original Software (or portions thereof).
+
+ (c) The licenses granted in Sections 2.1(a) and (b) are effective on the date Initial Developer first distributes or otherwise makes the Original Software available to a third party under the terms of this License.
+
+ (d) Notwithstanding Section 2.1(b) above, no patent license is granted: (1) for code that You delete from the Original Software, or (2) for infringements caused by: (i) the modification of the Original Software, or (ii) the combination of the Original Software with other software or devices.
+
+ 2.2. Contributor Grant.
+
+ Conditioned upon Your compliance with Section 3.1 below and subject to third party intellectual property claims, each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license:
+
+ (a) under intellectual property rights (other than patent or trademark) Licensable by Contributor to use, reproduce, modify, display, perform, sublicense and distribute the Modifications created by such Contributor (or portions thereof), either on an unmodified basis, with other Modifications, as Covered Software and/or as part of a Larger Work; and
+
+ (b) under Patent Claims infringed by the making, using, or selling of Modifications made by that Contributor either alone and/or in combination with its Contributor Version (or portions of such combination), to make, use, sell, offer for sale, have made, and/or otherwise dispose of: (1) Modifications made by that Contributor (or portions thereof); and (2) the combination of Modifications made by that Contributor with its Contributor Version (or portions of such combination).
+
+ (c) The licenses granted in Sections 2.2(a) and 2.2(b) are effective on the date Contributor first distributes or otherwise makes the Modifications available to a third party.
+
+ (d) Notwithstanding Section 2.2(b) above, no patent license is granted: (1) for any code that Contributor has deleted from the Contributor Version; (2) for infringements caused by: (i) third party modifications of Contributor Version, or (ii) the combination of Modifications made by that Contributor with other software (except as part of the Contributor Version) or other devices; or (3) under Patent Claims infringed by Covered Software in the absence of Modifications made by that Contributor.
+
+3. Distribution Obligations.
+
+ 3.1. Availability of Source Code.
+
+ Any Covered Software that You distribute or otherwise make available in Executable form must also be made available in Source Code form and that Source Code form must be distributed only under the terms of this License. You must include a copy of this License with every copy of the Source Code form of the Covered Software You distribute or otherwise make available. You must inform recipients of any such Covered Software in Executable form as to how they can obtain such Covered Software in Source Code form in a reasonable manner on or through a medium customarily used for software exchange.
+
+ 3.2. Modifications.
+
+ The Modifications that You create or to which You contribute are governed by the terms of this License. You represent that You believe Your Modifications are Your original creation(s) and/or You have sufficient rights to grant the rights conveyed by this License.
+
+ 3.3. Required Notices.
+
+ You must include a notice in each of Your Modifications that identifies You as the Contributor of the Modification. You may not remove or alter any copyright, patent or trademark notices contained within the Covered Software, or any notices of licensing or any descriptive text giving attribution to any Contributor or the Initial Developer.
+
+ 3.4. Application of Additional Terms.
+
+ You may not offer or impose any terms on any Covered Software in Source Code form that alters or restricts the applicable version of this License or the recipients' rights hereunder. You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, you may do so only on Your own behalf, and not on behalf of the Initial Developer or any Contributor. You must make it absolutely clear that any such warranty, support, indemnity or liability obligation is offered by You alone, and You hereby agree to indemnify the Initial Developer and every Contributor for any liability incurred by the Initial Developer or such Contributor as a result of warranty, support, indemnity or liability terms You offer.
+
+ 3.5. Distribution of Executable Versions.
+
+ You may distribute the Executable form of the Covered Software under the terms of this License or under the terms of a license of Your choice, which may contain terms different from this License, provided that You are in compliance with the terms of this License and that the license for the Executable form does not attempt to limit or alter the recipient's rights in the Source Code form from the rights set forth in this License. If You distribute the Covered Software in Executable form under a different license, You must make it absolutely clear that any terms which differ from this License are offered by You alone, not by the Initial Developer or Contributor. You hereby agree to indemnify the Initial Developer and every Contributor for any liability incurred by the Initial Developer or such Contributor as a result of any such terms You offer.
+
+ 3.6. Larger Works.
+
+ You may create a Larger Work by combining Covered Software with other code not governed by the terms of this License and distribute the Larger Work as a single product. In such a case, You must make sure the requirements of this License are fulfilled for the Covered Software.
+
+4. Versions of the License.
+
+ 4.1. New Versions.
+
+ Oracle is the initial license steward and may publish revised and/or new versions of this License from time to time. Each version will be given a distinguishing version number. Except as provided in Section 4.3, no one other than the license steward has the right to modify this License.
+
+ 4.2. Effect of New Versions.
+
+ You may always continue to use, distribute or otherwise make the Covered Software available under the terms of the version of the License under which You originally received the Covered Software. If the Initial Developer includes a notice in the Original Software prohibiting it from being distributed or otherwise made available under any subsequent version of the License, You must distribute and make the Covered Software available under the terms of the version of the License under which You originally received the Covered Software. Otherwise, You may also choose to use, distribute or otherwise make the Covered Software available under the terms of any subsequent version of the License published by the license steward.
+
+ 4.3. Modified Versions.
+
+ When You are an Initial Developer and You want to create a new license for Your Original Software, You may create and use a modified version of this License if You: (a) rename the license and remove any references to the name of the license steward (except to note that the license differs from this License); and (b) otherwise make it clear that the license contains terms which differ from this License.
+
+5. DISCLAIMER OF WARRANTY.
+
+ COVERED SOFTWARE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE COVERED SOFTWARE IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE COVERED SOFTWARE IS WITH YOU. SHOULD ANY COVERED SOFTWARE PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY COVERED SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER.
+
+6. TERMINATION.
+
+ 6.1. This License and the rights granted hereunder will terminate automatically if You fail to comply with terms herein and fail to cure such breach within 30 days of becoming aware of the breach. Provisions which, by their nature, must remain in effect beyond the termination of this License shall survive.
+
+ 6.2. If You assert a patent infringement claim (excluding declaratory judgment actions) against Initial Developer or a Contributor (the Initial Developer or Contributor against whom You assert such claim is referred to as "Participant") alleging that the Participant Software (meaning the Contributor Version where the Participant is a Contributor or the Original Software where the Participant is the Initial Developer) directly or indirectly infringes any patent, then any and all rights granted directly or indirectly to You by such Participant, the Initial Developer (if the Initial Developer is not the Participant) and all Contributors under Sections 2.1 and/or 2.2 of this License shall, upon 60 days notice from Participant terminate prospectively and automatically at the expiration of such 60 day notice period, unless if within such 60 day period You withdraw Your claim with respect to the Participant Software against such Participant either unilaterally or pursuant to a written agreement with Participant.
+
+ 6.3. If You assert a patent infringement claim against Participant alleging that the Participant Software directly or indirectly infringes any patent where such claim is resolved (such as by license or settlement) prior to the initiation of patent infringement litigation, then the reasonable value of the licenses granted by such Participant under Sections 2.1 or 2.2 shall be taken into account in determining the amount or value of any payment or license.
+
+ 6.4. In the event of termination under Sections 6.1 or 6.2 above, all end user licenses that have been validly granted by You or any distributor hereunder prior to termination (excluding licenses granted to You by any distributor) shall survive termination.
+
+7. LIMITATION OF LIABILITY.
+
+ UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL YOU, THE INITIAL DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF COVERED SOFTWARE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF LIABILITY SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL INJURY RESULTING FROM SUCH PARTY'S NEGLIGENCE TO THE EXTENT APPLICABLE LAW PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION AND LIMITATION MAY NOT APPLY TO YOU.
+
+8. U.S. GOVERNMENT END USERS.
+
+ The Covered Software is a "commercial item," as that term is defined in 48 C.F.R. 2.101 (Oct. 1995), consisting of "commercial computer software" (as that term is defined at 48 C.F.R. ? 252.227-7014(a)(1)) and "commercial computer software documentation" as such terms are used in 48 C.F.R. 12.212 (Sept. 1995). Consistent with 48 C.F.R. 12.212 and 48 C.F.R. 227.7202-1 through 227.7202-4 (June 1995), all U.S. Government End Users acquire Covered Software with only those rights set forth herein. This U.S. Government Rights clause is in lieu of, and supersedes, any other FAR, DFAR, or other clause or provision that addresses Government rights in computer software under this License.
+
+9. MISCELLANEOUS.
+
+ This License represents the complete agreement concerning subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. This License shall be governed by the law of the jurisdiction specified in a notice contained within the Original Software (except to the extent applicable law, if any, provides otherwise), excluding such jurisdiction's conflict-of-law provisions. Any litigation relating to this License shall be subject to the jurisdiction of the courts located in the jurisdiction and venue specified in a notice contained within the Original Software, with the losing party responsible for costs, including, without limitation, court costs and reasonable attorneys' fees and expenses. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not apply to this License. You agree that You alone are responsible for compliance with the United States export administration regulations (and the export control laws and regulation of any other countries) when You use, distribute or otherwise make available any Covered Software.
+
+10. RESPONSIBILITY FOR CLAIMS.
+
+ As between Initial Developer and the Contributors, each party is responsible for claims and damages arising, directly or indirectly, out of its utilization of rights under this License and You agree to work with Initial Developer and Contributors to distribute such responsibility on an equitable basis. Nothing herein is intended or shall be deemed to constitute any admission of liability.
+
+----------
+NOTICE PURSUANT TO SECTION 9 OF THE COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL)
+The code released under the CDDL shall be governed by the laws of the State of California (excluding conflict-of-law provisions). Any litigation relating to this License shall be subject to the jurisdiction of the Federal Courts of the Northern District of California and the state courts of the State of California, with venue lying in Santa Clara County, California.
+
+
+
+
+The GNU General Public License (GPL) Version 2, June 1991
+
+
+Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+
+Preamble
+
+The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) 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 this service 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 make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. 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.
+
+We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.
+
+Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.
+
+Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.
+
+The precise terms and conditions for copying, distribution and modification follow.
+
+
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
+
+1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
+
+2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
+
+3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
+
+If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
+
+4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
+
+5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
+
+6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.
+
+7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), 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 distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
+
+This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
+
+8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.
+
+9. The Free Software Foundation may publish revised and/or new versions of the 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 a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
+
+10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
+
+NO WARRANTY
+
+11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
+
+12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE 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.
+
+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 convey 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)
+
+ 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 2 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, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision 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, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ signature of Ty Coon, 1 April 1989
+ Ty Coon, President of Vice
+
+This 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 Library General Public License instead of this License.
+
+
+"CLASSPATH" EXCEPTION TO THE GPL VERSION 2
+
+Certain source files distributed by Oracle are subject to the following clarification and special exception to the GPL Version 2, but only where Oracle has expressly included in the particular source file's header the words "Oracle designates this particular file as subject to the "Classpath" exception as provided by Oracle in the License file that accompanied this code."
+
+Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License Version 2 cover the whole combination.
+
+As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.
diff --git a/doc/licenses/jaxb-api-2.3.1/README b/doc/licenses/jaxb-api-2.3.1/README
new file mode 100644
index 0000000..2836aa8
--- /dev/null
+++ b/doc/licenses/jaxb-api-2.3.1/README
@@ -0,0 +1,8 @@
+JAXB API / XML Processing (https://github.com/javaee/jaxb-spec)
+---------------------------------------------------------------
+
+ Version: 2.3.1
+ From: 'Oracle' (http://www.oracle.com)
+ License(s):
+ CDDL v1.1 (bundled/jaxb-api-2.3.1/LICENSE.txt)
+
diff --git a/doc/licenses/jaxb-api-2.3.1/dep-coordinates.txt b/doc/licenses/jaxb-api-2.3.1/dep-coordinates.txt
new file mode 100644
index 0000000..2c23cad
--- /dev/null
+++ b/doc/licenses/jaxb-api-2.3.1/dep-coordinates.txt
@@ -0,0 +1 @@
+javax.xml.bind:jaxb-api:jar:2.3.1
diff --git a/doc/licenses/jcommander-1.82/NOTICE b/doc/licenses/jcommander-1.82/NOTICE
new file mode 100644
index 0000000..c4d1f51
--- /dev/null
+++ b/doc/licenses/jcommander-1.82/NOTICE
@@ -0,0 +1 @@
+Copyright 2010 Cedric Beust
diff --git a/doc/licenses/jcommander-1.82/README b/doc/licenses/jcommander-1.82/README
new file mode 100644
index 0000000..ca37529
--- /dev/null
+++ b/doc/licenses/jcommander-1.82/README
@@ -0,0 +1,8 @@
+JCommander (https://jcommander.org/)
+------------------------------------
+
+ Version: 1.82
+ From: 'Cédric Beust' (https://github.com/cbeust)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/jcommander-1.82/dep-coordinates.txt b/doc/licenses/jcommander-1.82/dep-coordinates.txt
new file mode 100644
index 0000000..c10c9b7
--- /dev/null
+++ b/doc/licenses/jcommander-1.82/dep-coordinates.txt
@@ -0,0 +1 @@
+com.beust:jcommander:jar:1.82
diff --git a/doc/licenses/jersey-2.46/LICENSE.md b/doc/licenses/jersey-2.46/LICENSE.md
new file mode 100644
index 0000000..345fc37
--- /dev/null
+++ b/doc/licenses/jersey-2.46/LICENSE.md
@@ -0,0 +1,637 @@
+# Eclipse Public License - v 2.0
+
+ THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
+ PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
+ OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
+
+ 1. DEFINITIONS
+
+ "Contribution" means:
+
+ a) in the case of the initial Contributor, the initial content
+ Distributed under this Agreement, and
+
+ b) in the case of each subsequent Contributor:
+ i) changes to the Program, and
+ ii) additions to the Program;
+ where such changes and/or additions to the Program originate from
+ and are Distributed by that particular Contributor. A Contribution
+ "originates" from a Contributor if it was added to the Program by
+ such Contributor itself or anyone acting on such Contributor's behalf.
+ Contributions do not include changes or additions to the Program that
+ are not Modified Works.
+
+ "Contributor" means any person or entity that Distributes the Program.
+
+ "Licensed Patents" mean patent claims licensable by a Contributor which
+ are necessarily infringed by the use or sale of its Contribution alone
+ or when combined with the Program.
+
+ "Program" means the Contributions Distributed in accordance with this
+ Agreement.
+
+ "Recipient" means anyone who receives the Program under this Agreement
+ or any Secondary License (as applicable), including Contributors.
+
+ "Derivative Works" shall mean any work, whether in Source Code or other
+ form, that is based on (or derived from) the Program and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship.
+
+ "Modified Works" shall mean any work in Source Code or other form that
+ results from an addition to, deletion from, or modification of the
+ contents of the Program, including, for purposes of clarity any new file
+ in Source Code form that contains any contents of the Program. Modified
+ Works shall not include works that contain only declarations,
+ interfaces, types, classes, structures, or files of the Program solely
+ in each case in order to link to, bind by name, or subclass the Program
+ or Modified Works thereof.
+
+ "Distribute" means the acts of a) distributing or b) making available
+ in any manner that enables the transfer of a copy.
+
+ "Source Code" means the form of a Program preferred for making
+ modifications, including but not limited to software source code,
+ documentation source, and configuration files.
+
+ "Secondary License" means either the GNU General Public License,
+ Version 2.0, or any later versions of that license, including any
+ exceptions or additional permissions as identified by the initial
+ Contributor.
+
+ 2. GRANT OF RIGHTS
+
+ a) Subject to the terms of this Agreement, each Contributor hereby
+ grants Recipient a non-exclusive, worldwide, royalty-free copyright
+ license to reproduce, prepare Derivative Works of, publicly display,
+ publicly perform, Distribute and sublicense the Contribution of such
+ Contributor, if any, and such Derivative Works.
+
+ b) Subject to the terms of this Agreement, each Contributor hereby
+ grants Recipient a non-exclusive, worldwide, royalty-free patent
+ license under Licensed Patents to make, use, sell, offer to sell,
+ import and otherwise transfer the Contribution of such Contributor,
+ if any, in Source Code or other form. This patent license shall
+ apply to the combination of the Contribution and the Program if, at
+ the time the Contribution is added by the Contributor, such addition
+ of the Contribution causes such combination to be covered by the
+ Licensed Patents. The patent license shall not apply to any other
+ combinations which include the Contribution. No hardware per se is
+ licensed hereunder.
+
+ c) Recipient understands that although each Contributor grants the
+ licenses to its Contributions set forth herein, no assurances are
+ provided by any Contributor that the Program does not infringe the
+ patent or other intellectual property rights of any other entity.
+ Each Contributor disclaims any liability to Recipient for claims
+ brought by any other entity based on infringement of intellectual
+ property rights or otherwise. As a condition to exercising the
+ rights and licenses granted hereunder, each Recipient hereby
+ assumes sole responsibility to secure any other intellectual
+ property rights needed, if any. For example, if a third party
+ patent license is required to allow Recipient to Distribute the
+ Program, it is Recipient's responsibility to acquire that license
+ before distributing the Program.
+
+ d) Each Contributor represents that to its knowledge it has
+ sufficient copyright rights in its Contribution, if any, to grant
+ the copyright license set forth in this Agreement.
+
+ e) Notwithstanding the terms of any Secondary License, no
+ Contributor makes additional grants to any Recipient (other than
+ those set forth in this Agreement) as a result of such Recipient's
+ receipt of the Program under the terms of a Secondary License
+ (if permitted under the terms of Section 3).
+
+ 3. REQUIREMENTS
+
+ 3.1 If a Contributor Distributes the Program in any form, then:
+
+ a) the Program must also be made available as Source Code, in
+ accordance with section 3.2, and the Contributor must accompany
+ the Program with a statement that the Source Code for the Program
+ is available under this Agreement, and informs Recipients how to
+ obtain it in a reasonable manner on or through a medium customarily
+ used for software exchange; and
+
+ b) the Contributor may Distribute the Program under a license
+ different than this Agreement, provided that such license:
+ i) effectively disclaims on behalf of all other Contributors all
+ warranties and conditions, express and implied, including
+ warranties or conditions of title and non-infringement, and
+ implied warranties or conditions of merchantability and fitness
+ for a particular purpose;
+
+ ii) effectively excludes on behalf of all other Contributors all
+ liability for damages, including direct, indirect, special,
+ incidental and consequential damages, such as lost profits;
+
+ iii) does not attempt to limit or alter the recipients' rights
+ in the Source Code under section 3.2; and
+
+ iv) requires any subsequent distribution of the Program by any
+ party to be under a license that satisfies the requirements
+ of this section 3.
+
+ 3.2 When the Program is Distributed as Source Code:
+
+ a) it must be made available under this Agreement, or if the
+ Program (i) is combined with other material in a separate file or
+ files made available under a Secondary License, and (ii) the initial
+ Contributor attached to the Source Code the notice described in
+ Exhibit A of this Agreement, then the Program may be made available
+ under the terms of such Secondary Licenses, and
+
+ b) a copy of this Agreement must be included with each copy of
+ the Program.
+
+ 3.3 Contributors may not remove or alter any copyright, patent,
+ trademark, attribution notices, disclaimers of warranty, or limitations
+ of liability ("notices") contained within the Program from any copy of
+ the Program which they Distribute, provided that Contributors may add
+ their own appropriate notices.
+
+ 4. COMMERCIAL DISTRIBUTION
+
+ Commercial distributors of software may accept certain responsibilities
+ with respect to end users, business partners and the like. While this
+ license is intended to facilitate the commercial use of the Program,
+ the Contributor who includes the Program in a commercial product
+ offering should do so in a manner which does not create potential
+ liability for other Contributors. Therefore, if a Contributor includes
+ the Program in a commercial product offering, such Contributor
+ ("Commercial Contributor") hereby agrees to defend and indemnify every
+ other Contributor ("Indemnified Contributor") against any losses,
+ damages and costs (collectively "Losses") arising from claims, lawsuits
+ and other legal actions brought by a third party against the Indemnified
+ Contributor to the extent caused by the acts or omissions of such
+ Commercial Contributor in connection with its distribution of the Program
+ in a commercial product offering. The obligations in this section do not
+ apply to any claims or Losses relating to any actual or alleged
+ intellectual property infringement. In order to qualify, an Indemnified
+ Contributor must: a) promptly notify the Commercial Contributor in
+ writing of such claim, and b) allow the Commercial Contributor to control,
+ and cooperate with the Commercial Contributor in, the defense and any
+ related settlement negotiations. The Indemnified Contributor may
+ participate in any such claim at its own expense.
+
+ For example, a Contributor might include the Program in a commercial
+ product offering, Product X. That Contributor is then a Commercial
+ Contributor. If that Commercial Contributor then makes performance
+ claims, or offers warranties related to Product X, those performance
+ claims and warranties are such Commercial Contributor's responsibility
+ alone. Under this section, the Commercial Contributor would have to
+ defend claims against the other Contributors related to those performance
+ claims and warranties, and if a court requires any other Contributor to
+ pay any damages as a result, the Commercial Contributor must pay
+ those damages.
+
+ 5. NO WARRANTY
+
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
+ PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
+ BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
+ IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
+ TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
+ PURPOSE. Each Recipient is solely responsible for determining the
+ appropriateness of using and distributing the Program and assumes all
+ risks associated with its exercise of rights under this Agreement,
+ including but not limited to the risks and costs of program errors,
+ compliance with applicable laws, damage to or loss of data, programs
+ or equipment, and unavailability or interruption of operations.
+
+ 6. DISCLAIMER OF LIABILITY
+
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
+ PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
+ SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
+ PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
+ EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGES.
+
+ 7. GENERAL
+
+ If any provision of this Agreement is invalid or unenforceable under
+ applicable law, it shall not affect the validity or enforceability of
+ the remainder of the terms of this Agreement, and without further
+ action by the parties hereto, such provision shall be reformed to the
+ minimum extent necessary to make such provision valid and enforceable.
+
+ If Recipient institutes patent litigation against any entity
+ (including a cross-claim or counterclaim in a lawsuit) alleging that the
+ Program itself (excluding combinations of the Program with other software
+ or hardware) infringes such Recipient's patent(s), then such Recipient's
+ rights granted under Section 2(b) shall terminate as of the date such
+ litigation is filed.
+
+ All Recipient's rights under this Agreement shall terminate if it
+ fails to comply with any of the material terms or conditions of this
+ Agreement and does not cure such failure in a reasonable period of
+ time after becoming aware of such noncompliance. If all Recipient's
+ rights under this Agreement terminate, Recipient agrees to cease use
+ and distribution of the Program as soon as reasonably practicable.
+ However, Recipient's obligations under this Agreement and any licenses
+ granted by Recipient relating to the Program shall continue and survive.
+
+ Everyone is permitted to copy and distribute copies of this Agreement,
+ but in order to avoid inconsistency the Agreement is copyrighted and
+ may only be modified in the following manner. The Agreement Steward
+ reserves the right to publish new versions (including revisions) of
+ this Agreement from time to time. No one other than the Agreement
+ Steward has the right to modify this Agreement. The Eclipse Foundation
+ is the initial Agreement Steward. The Eclipse Foundation may assign the
+ responsibility to serve as the Agreement Steward to a suitable separate
+ entity. Each new version of the Agreement will be given a distinguishing
+ version number. The Program (including Contributions) may always be
+ Distributed subject to the version of the Agreement under which it was
+ received. In addition, after a new version of the Agreement is published,
+ Contributor may elect to Distribute the Program (including its
+ Contributions) under the new version.
+
+ Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
+ receives no rights or licenses to the intellectual property of any
+ Contributor under this Agreement, whether expressly, by implication,
+ estoppel or otherwise. All rights in the Program not expressly granted
+ under this Agreement are reserved. Nothing in this Agreement is intended
+ to be enforceable by any entity that is not a Contributor or Recipient.
+ No third-party beneficiary rights are created under this Agreement.
+
+ Exhibit A - Form of Secondary Licenses Notice
+
+ "This Source Code may also be made available under the following
+ Secondary Licenses when the conditions for such availability set forth
+ in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
+ version(s), and exceptions or additional permissions here}."
+
+ Simply including a copy of this Agreement, including this Exhibit A
+ is not sufficient to license the Source Code under Secondary Licenses.
+
+ If it is not possible or desirable to put the notice in a particular
+ file, then You may include the notice in a location (such as a LICENSE
+ file in a relevant directory) where a recipient would be likely to
+ look for such a notice.
+
+ You may add additional accurate notices of copyright ownership.
+
+---
+
+## The GNU General Public License (GPL) Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor
+ Boston, MA 02110-1335
+ USA
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your freedom to
+ share and change it. By contrast, the GNU General Public License is
+ intended to guarantee your freedom to share and change free software--to
+ make sure the software is free for all its users. This General Public
+ License applies to most of the Free Software Foundation's software and
+ to any other program whose authors commit to using it. (Some other Free
+ Software Foundation software is covered by the GNU Library General
+ Public License instead.) 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 this
+ service 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 make restrictions that forbid anyone
+ to deny you these rights or to ask you to surrender the rights. These
+ restrictions translate to certain responsibilities for you if you
+ distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether gratis
+ or for a fee, you must give the recipients all the rights that you have.
+ 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.
+
+ We protect your rights with two steps: (1) copyright the software, and
+ (2) offer you this license which gives you legal permission to copy,
+ distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+ that everyone understands that there is no warranty for this free
+ software. If the software is modified by someone else and passed on, we
+ want its recipients to know that what they have is not the original, so
+ that any problems introduced by others will not reflect on the original
+ authors' reputations.
+
+ Finally, any free program is threatened constantly by software patents.
+ We wish to avoid the danger that redistributors of a free program will
+ individually obtain patent licenses, in effect making the program
+ proprietary. To prevent this, we have made it clear that any patent must
+ be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+ modification follow.
+
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains a
+ notice placed by the copyright holder saying it may be distributed under
+ the terms of this General Public License. The "Program", below, refers
+ to any such program or work, and a "work based on the Program" means
+ either the Program or any derivative work under copyright law: that is
+ to say, a work containing the Program or a portion of it, either
+ verbatim or with modifications and/or translated into another language.
+ (Hereinafter, translation is included without limitation in the term
+ "modification".) Each licensee is addressed as "you".
+
+ Activities other than copying, distribution and modification are not
+ covered by this License; they are outside its scope. The act of running
+ the Program is not restricted, and the output from the Program is
+ covered only if its contents constitute a work based on the Program
+ (independent of having been made by running the Program). Whether that
+ is true depends on what the Program does.
+
+ 1. You may copy and distribute 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
+ and disclaimer of warranty; keep intact all the notices that refer to
+ this License and to the absence of any warranty; and give any other
+ recipients of the Program a copy of this License along with the Program.
+
+ You may charge a fee for the physical act of transferring a copy, and
+ you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion of
+ it, thus forming a work based on the Program, and copy and distribute
+ such modifications or work under the terms of Section 1 above, provided
+ that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any part
+ thereof, to be licensed as a whole at no charge to all third parties
+ under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a notice
+ that there is no warranty (or else, saying that you provide a
+ warranty) and that users may redistribute the program under these
+ conditions, and telling the user how to view a copy of this License.
+ (Exception: if the Program itself is interactive but does not
+ normally print such an announcement, your work based on the Program
+ is not required to print an announcement.)
+
+ These requirements apply to the modified work as a whole. If
+ identifiable sections of that work are not derived from the Program, and
+ can be reasonably considered independent and separate works in
+ themselves, then this License, and its terms, do not apply to those
+ sections when you distribute them as separate works. But when you
+ distribute the same sections as part of a whole which is a work based on
+ the Program, the distribution of the whole must be on the terms of this
+ License, whose permissions for other licensees extend to the entire
+ whole, and thus to each and every part regardless of who wrote it.
+
+ Thus, it is not the intent of this section to claim rights or contest
+ your rights to work written entirely by you; rather, the intent is to
+ exercise the right to control the distribution of derivative or
+ collective works based on the Program.
+
+ In addition, mere aggregation of another work not based on the Program
+ with the Program (or with a work based on the Program) on a volume of a
+ storage or distribution medium does not bring the other work under the
+ scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+ under Section 2) in object code or executable form under the terms of
+ Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections 1
+ and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your cost
+ of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer to
+ distribute corresponding source code. (This alternative is allowed
+ only for noncommercial distribution and only if you received the
+ program in object code or executable form with such an offer, in
+ accord with Subsection b above.)
+
+ The source code for a work means the preferred form of the work for
+ making modifications to it. For an executable work, complete source code
+ means all the source code for all modules it contains, plus any
+ associated interface definition files, plus the scripts used to control
+ compilation and installation of the executable. However, as a special
+ exception, the source code distributed need not include anything that is
+ normally distributed (in either source or binary form) with the major
+ components (compiler, kernel, and so on) of the operating system on
+ which the executable runs, unless that component itself accompanies the
+ executable.
+
+ If distribution of executable or object code is made by offering access
+ to copy from a designated place, then offering equivalent access to copy
+ the source code from the same place counts as distribution of the source
+ code, even though third parties are not compelled to copy the source
+ along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+ except as expressly provided under this License. Any attempt otherwise
+ to copy, modify, sublicense or distribute the Program is void, and will
+ automatically terminate your rights under this License. However, parties
+ who have received copies, or rights, from you under this License will
+ not have their licenses terminated so long as such parties remain in
+ full compliance.
+
+ 5. You are not required to accept this License, since you have not
+ signed it. However, nothing else grants you permission to modify or
+ distribute the Program or its derivative works. These actions are
+ prohibited by law if you do not accept this License. Therefore, by
+ modifying or distributing the Program (or any work based on the
+ Program), you indicate your acceptance of this License to do so, and all
+ its terms and conditions for copying, distributing or modifying the
+ Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+ Program), the recipient automatically receives a license from the
+ original licensor to copy, distribute or modify the Program subject to
+ these terms and conditions. You may not impose any further restrictions
+ on the recipients' exercise of the rights granted herein. You are not
+ responsible for enforcing compliance by third parties to this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+ infringement or for any other reason (not limited to patent issues),
+ 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 distribute
+ so as to satisfy simultaneously your obligations under this License and
+ any other pertinent obligations, then as a consequence you may not
+ distribute the Program at all. For example, if a patent license would
+ not permit royalty-free redistribution of the Program by all those who
+ receive copies directly or indirectly through you, then the only way you
+ could satisfy both it and this License would be to refrain entirely from
+ distribution of the Program.
+
+ If any portion of this section is held invalid or unenforceable under
+ any particular circumstance, the balance of the section is intended to
+ apply and the section as a whole is intended to apply in other
+ circumstances.
+
+ It is not the purpose of this section to induce you to infringe any
+ patents or other property right claims or to contest validity of any
+ such claims; this section has the sole purpose of protecting the
+ integrity of the free software distribution system, which is implemented
+ by public license practices. Many people have made generous
+ contributions to the wide range of software distributed through that
+ system in reliance on consistent application of that system; it is up to
+ the author/donor to decide if he or she is willing to distribute
+ software through any other system and a licensee cannot impose that choice.
+
+ This section is intended to make thoroughly clear what is believed to be
+ a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+ certain countries either by patents or by copyrighted interfaces, the
+ original copyright holder who places the Program under this License may
+ add an explicit geographical distribution limitation excluding those
+ countries, so that distribution is permitted only in or among countries
+ not thus excluded. In such case, this License incorporates the
+ limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new
+ versions of the 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 a version number of this License which applies to it and "any
+ later version", you have the option of following the terms and
+ conditions either of that version or of any later version published by
+ the Free Software Foundation. If the Program does not specify a version
+ number of this License, you may choose any version ever published by the
+ Free Software Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+ programs whose distribution conditions are different, write to the
+ author to ask for permission. For software which is copyrighted by the
+ Free Software Foundation, write to the Free Software Foundation; we
+ sometimes make exceptions for this. Our decision will be guided by the
+ two goals of preserving the free status of all derivatives of our free
+ software and of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+ WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+ AND/OR REDISTRIBUTE 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.
+
+ 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 convey
+ 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)
+
+ 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 2 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, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA
+
+ Also add information on how to contact you by electronic and paper mail.
+
+ If the program is interactive, make it output a short notice like this
+ when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision 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, the commands
+ you use may be called something other than `show w' and `show c'; they
+ could even be mouse-clicks or menu items--whatever suits your program.
+
+ You should also get your employer (if you work as a programmer) or your
+ school, if any, to sign a "copyright disclaimer" for the program, if
+ necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ program `Gnomovision' (which makes passes at compilers) written by
+ James Hacker.
+
+ signature of Ty Coon, 1 April 1989
+ Ty Coon, President of Vice
+
+ This 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 Library
+ General Public License instead of this License.
+
+---
+
+## CLASSPATH EXCEPTION
+
+ Linking this library statically or dynamically with other modules is
+ making a combined work based on this library. Thus, the terms and
+ conditions of the GNU General Public License version 2 cover the whole
+ combination.
+
+ As a special exception, the copyright holders of this library give you
+ permission to link this library with independent modules to produce an
+ executable, regardless of the license terms of these independent
+ modules, and to copy and distribute the resulting executable under
+ terms of your choice, provided that you also meet, for each linked
+ independent module, the terms and conditions of the license of that
+ module. An independent module is a module which is not derived from or
+ based on this library. If you modify this library, you may extend this
+ exception to your version of the library, but you are not obligated to
+ do so. If you do not wish to do so, delete this exception statement
+ from your version.
diff --git a/doc/licenses/jersey-2.46/README b/doc/licenses/jersey-2.46/README
new file mode 100644
index 0000000..b42a5db
--- /dev/null
+++ b/doc/licenses/jersey-2.46/README
@@ -0,0 +1,8 @@
+Jersey (https://jersey.java.net/)
+---------------------------------
+
+ Version: 2.46
+ From: 'Eclipse Foundation' (https://www.eclipse.org/)
+ License(s):
+ EPL v2.0 (bundled/jersey-2.46/LICENSE.md)
+
diff --git a/doc/licenses/jersey-2.46/dep-coordinates.txt b/doc/licenses/jersey-2.46/dep-coordinates.txt
new file mode 100644
index 0000000..67aecd0
--- /dev/null
+++ b/doc/licenses/jersey-2.46/dep-coordinates.txt
@@ -0,0 +1,7 @@
+org.glassfish.jersey.containers:jersey-container-servlet-core:jar:2.46
+org.glassfish.jersey.core:jersey-common:jar:2.46
+org.glassfish.jersey.core:jersey-server:jar:2.46
+org.glassfish.jersey.core:jersey-client:jar:2.46
+org.glassfish.jersey.inject:jersey-hk2:jar:2.46
+org.glassfish.jersey.media:jersey-media-json-jackson:jar:2.46
+org.glassfish.jersey.ext:jersey-entity-filtering:jar:2.46
diff --git a/doc/licenses/jetbrains-annotations-13.0/README b/doc/licenses/jetbrains-annotations-13.0/README
new file mode 100644
index 0000000..e09618c
--- /dev/null
+++ b/doc/licenses/jetbrains-annotations-13.0/README
@@ -0,0 +1,9 @@
+Annotations for JVM-based languages
+(https://github.com/JetBrains/java-annotations)
+-----------------------------------------------
+
+ Version: 13.0
+ From: 'JetBrains s.r.o.' (http://www.jetbrains.com)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/jetbrains-annotations-13.0/dep-coordinates.txt b/doc/licenses/jetbrains-annotations-13.0/dep-coordinates.txt
new file mode 100644
index 0000000..bb558cd
--- /dev/null
+++ b/doc/licenses/jetbrains-annotations-13.0/dep-coordinates.txt
@@ -0,0 +1 @@
+org.jetbrains:annotations:jar:13.0
diff --git a/doc/licenses/joda-time-2.10.6/NOTICE b/doc/licenses/joda-time-2.10.6/NOTICE
new file mode 100644
index 0000000..b8f54d7
--- /dev/null
+++ b/doc/licenses/joda-time-2.10.6/NOTICE
@@ -0,0 +1,2 @@
+This product includes software developed by
+Joda.org (https://www.joda.org/).
diff --git a/doc/licenses/joda-time-2.10.6/README b/doc/licenses/joda-time-2.10.6/README
new file mode 100644
index 0000000..a10eaf6
--- /dev/null
+++ b/doc/licenses/joda-time-2.10.6/README
@@ -0,0 +1,8 @@
+Joda-Time (https://www.joda.org/joda-time/)
+----------------------------------------------
+
+ Version: 2.10.6
+ From: 'Joda.org' (https://www.joda.org/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/joda-time-2.10.6/dep-coordinates.txt b/doc/licenses/joda-time-2.10.6/dep-coordinates.txt
new file mode 100644
index 0000000..a210c5c
--- /dev/null
+++ b/doc/licenses/joda-time-2.10.6/dep-coordinates.txt
@@ -0,0 +1 @@
+joda-time:joda-time:jar:2.10.6
diff --git a/doc/licenses/jose4j-0.9.6/NOTICE b/doc/licenses/jose4j-0.9.6/NOTICE
new file mode 100644
index 0000000..57e9303
--- /dev/null
+++ b/doc/licenses/jose4j-0.9.6/NOTICE
@@ -0,0 +1,14 @@
+jose4j
+Copyright 2012-2024 Brian Campbell
+
+EcdsaUsingShaAlgorithm contains code for converting the concatenated
+R & S values of the signature to and from DER, which was originally
+derived from the Apache Santuario XML Security library's SignatureECDSA
+implementation. http://santuario.apache.org/
+
+The Base64 implementation in this software was derived from the
+Apache Commons Codec project. http://commons.apache.org/proper/commons-codec/
+
+JSON processing in this software was derived from the JSON.simple toolkit.
+https://code.google.com/p/json-simple/
+
diff --git a/doc/licenses/jose4j-0.9.6/README b/doc/licenses/jose4j-0.9.6/README
new file mode 100644
index 0000000..d3e549c
--- /dev/null
+++ b/doc/licenses/jose4j-0.9.6/README
@@ -0,0 +1,8 @@
+jose.4.j (https://bitbucket.org/b_c/jose4j/)
+--------------------------------------------
+
+ Version: 0.9.6
+ From: 'Brian Campbell' (https://bitbucket.org/b_c/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/jose4j-0.9.6/dep-coordinates.txt b/doc/licenses/jose4j-0.9.6/dep-coordinates.txt
new file mode 100644
index 0000000..eca1c8a
--- /dev/null
+++ b/doc/licenses/jose4j-0.9.6/dep-coordinates.txt
@@ -0,0 +1 @@
+org.bitbucket.b_c:jose4j:jar:0.9.6
diff --git a/doc/licenses/jquery-3.7.1/LICENSE.txt b/doc/licenses/jquery-3.7.1/LICENSE.txt
new file mode 100644
index 0000000..f642c3f
--- /dev/null
+++ b/doc/licenses/jquery-3.7.1/LICENSE.txt
@@ -0,0 +1,20 @@
+Copyright OpenJS Foundation and other contributors, https://openjsf.org/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/doc/licenses/jquery-3.7.1/README b/doc/licenses/jquery-3.7.1/README
new file mode 100644
index 0000000..5e5cec4
--- /dev/null
+++ b/doc/licenses/jquery-3.7.1/README
@@ -0,0 +1,8 @@
+jQuery (http://jquery.com/)
+---------------------------
+
+ Version: 3.7.1
+ From: 'OpenJS Foundation' (https://openjsf.org/)
+ License(s):
+ MIT (bundled/jquery-3.7.1/LICENSE.txt)
+
diff --git a/doc/licenses/jquery-3.7.1/dep-coordinates.txt b/doc/licenses/jquery-3.7.1/dep-coordinates.txt
new file mode 100644
index 0000000..12b56f7
--- /dev/null
+++ b/doc/licenses/jquery-3.7.1/dep-coordinates.txt
@@ -0,0 +1 @@
+jquery:3.7.1
diff --git a/doc/licenses/jradius-1.1.5/LICENSE b/doc/licenses/jradius-1.1.5/LICENSE
new file mode 100644
index 0000000..ff1be90
--- /dev/null
+++ b/doc/licenses/jradius-1.1.5/LICENSE
@@ -0,0 +1,545 @@
+==========================================================================
+
+Coova JRadius License:
+
+The Coova JRadius core libraries are licensed under the The GNU
+Library or "Lesser" General Public License (LGPL), while stand-alone
+applications within in the JRadius project, listed below, are released
+under the standard The GNU General Public License (GPL). For details,
+visit http://www.coova.org/JRadius. See source files for details
+regarding stand-alone applications contained herein which are
+released under the GPL.
+
+Copyright 2006-2010 Coova Technologies, LLC. All rights reserved.
+
+See doc/GPL-LICENSE, doc/LGPL-LICENSE, and source files for details.
+
+==========================================================================
+
+Original JRadius License:
+
+The JRadius core library is licensed under the The GNU Library or "Lesser"
+General Public License (LGPL), while stand-alone applications within in the
+JRadius project, listed below, are released under the standard The GNU
+General Public License (GPL). For details, visit http://jradius.net/
+
+This software is OSI Certified Open Source Software. OSI Certified is a
+certification mark of the Open Source Initiative.
+
+Stand-alone JRadius Applications:
+
+ * JRadiusSimulator
+ * JRadiusWiFiClient
+ * RadClient
+ * RadBench
+ * RadiusDictionary
+
+Copyright 2004-2006 PicoPoint, B.V.
+Copyright 2006-2008 David Bird
+
+See doc/GPL-LICENSE, doc/LGPL-LICENSE, and source files for details.
+
+==========================================================================
+
+GNU LESSER GENERAL PUBLIC LICENSE
+ Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+(This is the first released version of the Lesser GPL. It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.)
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+ This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it. You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+ When we speak of free software, we are referring to freedom of use,
+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 this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+ To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights. These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+ For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you. You must make sure that they, too, receive or can get the source
+code. If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it. And you must show them these terms so they know their rights.
+
+ We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+ To protect each distributor, we want to make it very clear that
+there is no warranty for the free library. Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+ Finally, software patents pose a constant threat to the existence of
+any free program. We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder. Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+ Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License. This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License. We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+ When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library. The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom. The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+ We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License. It also provides other free software developers Less
+of an advantage over competing non-free programs. These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries. However, the Lesser license provides advantages in certain
+special circumstances.
+
+ For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard. To achieve this, non-free programs must be
+allowed to use the library. A more frequent case is that a free
+library does the same job as widely used non-free libraries. In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+ In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software. For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+ Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+ The precise terms and conditions for copying, distribution and
+modification follow. Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library". The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+ GNU LESSER GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+ A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+ The "Library", below, refers to any such software library or work
+which has been distributed under these terms. A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language. (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+ "Source code" for a work means the preferred form of the work for
+making modifications to it. For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+ Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it). Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+ 1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+ You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+ 2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) The modified work must itself be a software library.
+
+ b) You must cause the files modified to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ c) You must cause the whole of the work to be licensed at no
+ charge to all third parties under the terms of this License.
+
+ d) If a facility in the modified Library refers to a function or a
+ table of data to be supplied by an application program that uses
+ the facility, other than as an argument passed when the facility
+ is invoked, then you must make a good faith effort to ensure that,
+ in the event an application does not supply such function or
+ table, the facility still operates, and performs whatever part of
+ its purpose remains meaningful.
+
+ (For example, a function in a library to compute square roots has
+ a purpose that is entirely well-defined independent of the
+ application. Therefore, Subsection 2d requires that any
+ application-supplied function or table used by this function must
+ be optional: if the application does not supply it, the square
+ root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library. To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License. (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.) Do not make any other change in
+these notices.
+
+ Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+ This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+ 4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+ If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library". Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+ However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library". The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+ When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library. The
+threshold for this to be true is not precisely defined by law.
+
+ If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work. (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+ Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+ 6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+ You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License. You must supply a copy of this License. If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License. Also, you must do one
+of these things:
+
+ a) Accompany the work with the complete corresponding
+ machine-readable source code for the Library including whatever
+ changes were used in the work (which must be distributed under
+ Sections 1 and 2 above); and, if the work is an executable linked
+ with the Library, with the complete machine-readable "work that
+ uses the Library", as object code and/or source code, so that the
+ user can modify the Library and then relink to produce a modified
+ executable containing the modified Library. (It is understood
+ that the user who changes the contents of definitions files in the
+ Library will not necessarily be able to recompile the application
+ to use the modified definitions.)
+
+ b) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (1) uses at run time a
+ copy of the library already present on the user's computer system,
+ rather than copying library functions into the executable, and (2)
+ will operate properly with a modified version of the library, if
+ the user installs one, as long as the modified version is
+ interface-compatible with the version that the work was made with.
+
+ c) Accompany the work with a written offer, valid for at
+ least three years, to give the same user the materials
+ specified in Subsection 6a, above, for a charge no more
+ than the cost of performing this distribution.
+
+ d) If distribution of the work is made by offering access to copy
+ from a designated place, offer equivalent access to copy the above
+ specified materials from the same place.
+
+ e) Verify that the user has already received a copy of these
+ materials or that you have already sent this user a copy.
+
+ For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it. However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+ It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system. Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+ 7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+ a) Accompany the combined library with a copy of the same work
+ based on the Library, uncombined with any other library
+ facilities. This must be distributed under the terms of the
+ Sections above.
+
+ b) Give prominent notice with the combined library of the fact
+ that part of it is a work based on the Library, and explaining
+ where to find the accompanying uncombined form of the same work.
+
+ 8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License. Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License. However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+ 9. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Library or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+ 10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+ 11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+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
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all. For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded. In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+ 13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser 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 Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation. If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+ 14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission. For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this. Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+ NO WARRANTY
+
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "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
+LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY 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
+LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Libraries
+
+ If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change. You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+ To apply these terms, attach the following notices to the library. It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+ {description}
+ Copyright (C) {year} {fullname}
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library 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
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ library `Frob' (a library for tweaking knobs) written by James Random Hacker.
+
+ {signature of Ty Coon}, 1 April 1990
+ Ty Coon, President of Vice
+
+That's all there is to it!
diff --git a/doc/licenses/jradius-1.1.5/README b/doc/licenses/jradius-1.1.5/README
new file mode 100644
index 0000000..4d52096
--- /dev/null
+++ b/doc/licenses/jradius-1.1.5/README
@@ -0,0 +1,8 @@
+JRadius (https://github.com/coova/jradius)
+------------------------------------------
+
+ Version: 1.1.5
+ From: 'Coova Technologies, LLC' (https://coova.github.io)
+ License(s):
+ LGPL-2.1 (bundled/jradius-1.1.5/LICENSE)
+
diff --git a/doc/licenses/jradius-1.1.5/dep-coordinates.txt b/doc/licenses/jradius-1.1.5/dep-coordinates.txt
new file mode 100644
index 0000000..8beebb1
--- /dev/null
+++ b/doc/licenses/jradius-1.1.5/dep-coordinates.txt
@@ -0,0 +1,3 @@
+net.jradius:jradius-core:jar:1.1.5
+net.jradius:jradius-dictionary:jar:1.1.5
+net.jradius:jradius-extended:jar:1.1.5
diff --git a/doc/licenses/jsr250-api-1.0/CDDLv1.0.txt b/doc/licenses/jsr250-api-1.0/CDDLv1.0.txt
new file mode 100644
index 0000000..5f3844e
--- /dev/null
+++ b/doc/licenses/jsr250-api-1.0/CDDLv1.0.txt
@@ -0,0 +1,119 @@
+COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0
+
+1. Definitions.
+
+1.1. Contributor means each individual or entity that creates or contributes to the creation of Modifications.
+
+1.2. Contributor Version means the combination of the Original Software, prior Modifications used by a Contributor (if any), and the Modifications made by that particular Contributor.
+
+1.3. Covered Software means (a) the Original Software, or (b) Modifications, or (c) the combination of files containing Original Software with files containing Modifications, in each case including portions thereof.
+
+1.4. Executable means the Covered Software in any form other than Source Code.
+
+1.5. Initial Developer means the individual or entity that first makes Original Software available under this License.
+
+1.6. Larger Work means a work which combines Covered Software or portions thereof with code not governed by the terms of this License.
+
+1.7. License means this document.
+
+1.8. Licensable means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently acquired, any and all of the rights conveyed herein.
+
+1.9. Modifications means the Source Code and Executable form of any of the following:
+
+A. Any file that results from an addition to, deletion from or modification of the contents of a file containing Original Software or previous Modifications;
+
+B. Any new file that contains any part of the Original Software or previous Modification; or
+
+C. Any new file that is contributed or otherwise made available under the terms of this License.
+
+1.10. Original Software means the Source Code and Executable form of computer software code that is originally released under this License.
+
+1.11. Patent Claims means any patent claim(s), now owned or hereafter acquired, including without limitation, method, process, and apparatus claims, in any patent Licensable by grantor.
+
+1.12. Source Code means (a) the common form of computer software code in which modifications are made and (b) associated documentation included in or with such code.
+
+1.13. You (or Your) means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License. For legal entities, You includes any entity which controls, is controlled by, or is under common control with You. For purposes of this definition, control means (a)the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b)ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity.
+
+2. License Grants.
+
+2.1. The Initial Developer Grant.
+Conditioned upon Your compliance with Section 3.1 below and subject to third party intellectual property claims, the Initial Developer hereby grants You a world-wide, royalty-free, non-exclusive license:
+(a) under intellectual property rights (other than patent or trademark) Licensable by Initial Developer, to use, reproduce, modify, display, perform, sublicense and distribute the Original Software (or portions thereof), with or without Modifications, and/or as part of a Larger Work; and
+(b) under Patent Claims infringed by the making, using or selling of Original Software, to make, have made, use, practice, sell, and offer for sale, and/or otherwise dispose of the Original Software (or portions thereof).
+(c) The licenses granted in Sections2.1(a) and (b) are effective on the date Initial Developer first distributes or otherwise makes the Original Software available to a third party under the terms of this License.
+(d) Notwithstanding Section2.1(b) above, no patent license is granted: (1)for code that You delete from the Original Software, or (2)for infringements caused by: (i)the modification of the Original Software, or (ii)the combination of the Original Software with other software or devices.
+
+2.2. Contributor Grant.
+Conditioned upon Your compliance with Section 3.1 below and subject to third party intellectual property claims, each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license:
+(a) under intellectual property rights (other than patent or trademark) Licensable by Contributor to use, reproduce, modify, display, perform, sublicense and distribute the Modifications created by such Contributor (or portions thereof), either on an unmodified basis, with other Modifications, as Covered Software and/or as part of a Larger Work; and
+(b) under Patent Claims infringed by the making, using, or selling of Modifications made by that Contributor either alone and/or in combination with its Contributor Version (or portions of such combination), to make, use, sell, offer for sale, have made, and/or otherwise dispose of: (1)Modifications made by that Contributor (or portions thereof); and (2)the combination of Modifications made by that Contributor with its Contributor Version (or portions of such combination).
+(c) The licenses granted in Sections2.2(a) and 2.2(b) are effective on the date Contributor first distributes or otherwise makes the Modifications available to a third party.
+(d) Notwithstanding Section2.2(b) above, no patent license is granted: (1)for any code that Contributor has deleted from the Contributor Version; (2)for infringements caused by: (i)third party modifications of Contributor Version, or (ii)the combination of Modifications made by that Contributor with other software (except as part of the Contributor Version) or other devices; or (3)under Patent Claims infringed by Covered Software in the absence of Modifications made by that Contributor.
+
+3. Distribution Obligations.
+
+3.1. Availability of Source Code.
+
+Any Covered Software that You distribute or otherwise make available in Executable form must also be made available in Source Code form and that Source Code form must be distributed only under the terms of this License. You must include a copy of this License with every copy of the Source Code form of the Covered Software You distribute or otherwise make available. You must inform recipients of any such Covered Software in Executable form as to how they can obtain such Covered Software in Source Code form in a reasonable manner on or through a medium customarily used for software exchange.
+
+3.2. Modifications.
+
+The Modifications that You create or to which You contribute are governed by the terms of this License. You represent that You believe Your Modifications are Your original creation(s) and/or You have sufficient rights to grant the rights conveyed by this License.
+
+3.3. Required Notices.
+You must include a notice in each of Your Modifications that identifies You as the Contributor of the Modification. You may not remove or alter any copyright, patent or trademark notices contained within the Covered Software, or any notices of licensing or any descriptive text giving attribution to any Contributor or the Initial Developer.
+
+3.4. Application of Additional Terms.
+You may not offer or impose any terms on any Covered Software in Source Code form that alters or restricts the applicable version of this License or the recipients rights hereunder. You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, you may do so only on Your own behalf, and not on behalf of the Initial Developer or any Contributor. You must make it absolutely clear that any such warranty, support, indemnity or liability obligation is offered by You alone, and You hereby agree to indemnify the Initial Developer and every Contributor for any liability incurred by the Initial Developer or such Contributor as a result of warranty, support, indemnity or liability terms You offer.
+
+3.5. Distribution of Executable Versions.
+You may distribute the Executable form of the Covered Software under the terms of this License or under the terms of a license of Your choice, which may contain terms different from this License, provided that You are in compliance with the terms of this License and that the license for the Executable form does not attempt to limit or alter the recipients rights in the Source Code form from the rights set forth in this License. If You distribute the Covered Software in Executable form under a different license, You must make it absolutely clear that any terms which differ from this License are offered by You alone, not by the Initial Developer or Contributor. You hereby agree to indemnify the Initial Developer and every Contributor for any liability incurred by the Initial Developer or such Contributor as a result of any such terms You offer.
+
+3.6. Larger Works.
+You may create a Larger Work by combining Covered Software with other code not governed by the terms of this License and distribute the Larger Work as a single product. In such a case, You must make sure the requirements of this License are fulfilled for the Covered Software.
+
+4. Versions of the License.
+
+4.1. New Versions.
+Sun Microsystems, Inc. is the initial license steward and may publish revised and/or new versions of this License from time to time. Each version will be given a distinguishing version number. Except as provided in Section 4.3, no one other than the license steward has the right to modify this License.
+
+4.2. Effect of New Versions.
+
+You may always continue to use, distribute or otherwise make the Covered Software available under the terms of the version of the License under which You originally received the Covered Software. If the Initial Developer includes a notice in the Original Software prohibiting it from being distributed or otherwise made available under any subsequent version of the License, You must distribute and make the Covered Software available under the terms of the version of the License under which You originally received the Covered Software. Otherwise, You may also choose to use, distribute or otherwise make the Covered Software available under the terms of any subsequent version of the License published by the license steward.
+4.3. Modified Versions.
+
+When You are an Initial Developer and You want to create a new license for Your Original Software, You may create and use a modified version of this License if You: (a)rename the license and remove any references to the name of the license steward (except to note that the license differs from this License); and (b)otherwise make it clear that the license contains terms which differ from this License.
+
+5. DISCLAIMER OF WARRANTY.
+
+COVERED SOFTWARE IS PROVIDED UNDER THIS LICENSE ON AN AS IS BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE COVERED SOFTWARE IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE COVERED SOFTWARE IS WITH YOU. SHOULD ANY COVERED SOFTWARE PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY COVERED SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER.
+
+6. TERMINATION.
+
+6.1. This License and the rights granted hereunder will terminate automatically if You fail to comply with terms herein and fail to cure such breach within 30 days of becoming aware of the breach. Provisions which, by their nature, must remain in effect beyond the termination of this License shall survive.
+
+6.2. If You assert a patent infringement claim (excluding declaratory judgment actions) against Initial Developer or a Contributor (the Initial Developer or Contributor against whom You assert such claim is referred to as Participant) alleging that the Participant Software (meaning the Contributor Version where the Participant is a Contributor or the Original Software where the Participant is the Initial Developer) directly or indirectly infringes any patent, then any and all rights granted directly or indirectly to You by such Participant, the Initial Developer (if the Initial Developer is not the Participant) and all Contributors under Sections2.1 and/or 2.2 of this License shall, upon 60 days notice from Participant terminate prospectively and automatically at the expiration of such 60 day notice period, unless if within such 60 day period You withdraw Your claim with respect to the Participant Software against such Participant either unilaterally or pursuant to a written agreement with Participant.
+
+6.3. In the event of termination under Sections6.1 or 6.2 above, all end user licenses that have been validly granted by You or any distributor hereunder prior to termination (excluding licenses granted to You by any distributor) shall survive termination.
+
+7. LIMITATION OF LIABILITY.
+
+UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL YOU, THE INITIAL DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF COVERED SOFTWARE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOST PROFITS, LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF LIABILITY SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL INJURY RESULTING FROM SUCH PARTYS NEGLIGENCE TO THE EXTENT APPLICABLE LAW PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION AND LIMITATION MAY NOT APPLY TO YOU.
+
+8. U.S. GOVERNMENT END USERS.
+
+The Covered Software is a commercial item, as that term is defined in 48C.F.R.2.101 (Oct. 1995), consisting of commercial computer software (as that term is defined at 48 C.F.R. 252.227-7014(a)(1)) and commercial computer software documentation as such terms are used in 48C.F.R.12.212 (Sept. 1995). Consistent with 48 C.F.R. 12.212 and 48 C.F.R. 227.7202-1 through 227.7202-4 (June 1995), all U.S. Government End Users acquire Covered Software with only those rights set forth herein. This U.S. Government Rights clause is in lieu of, and supersedes, any other FAR, DFAR, or other clause or provision that addresses Government rights in computer software under this License.
+
+9. MISCELLANEOUS.
+
+This License represents the complete agreement concerning subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. This License shall be governed by the law of the jurisdiction specified in a notice contained within the Original Software (except to the extent applicable law, if any, provides otherwise), excluding such jurisdictions conflict-of-law provisions. Any litigation relating to this License shall be subject to the jurisdiction of the courts located in the jurisdiction and venue specified in a notice contained within the Original Software, with the losing party responsible for costs, including, without limitation, court costs and reasonable attorneys fees and expenses. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not apply to this License. You agree that You alone are responsible for compliance with the United States export administration regulations (and the export control laws and regulation of any other countries) when You use, distribute or otherwise make available any Covered Software.
+
+10. RESPONSIBILITY FOR CLAIMS.
+
+As between Initial Developer and the Contributors, each party is responsible for claims and damages arising, directly or indirectly, out of its utilization of rights under this License and You agree to work with Initial Developer and Contributors to distribute such responsibility on an equitable basis. Nothing herein is intended or shall be deemed to constitute any admission of liability.
+
+NOTICE PURSUANT TO SECTION 9 OF THE COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL)
+The GlassFish code released under the CDDL shall be governed by the laws of the State of California (excluding conflict-of-law provisions). Any litigation relating to this License shall be subject to the jurisdiction of the Federal Courts of the Northern District of California and the state courts of the State of California, with venue lying in Santa Clara County, California.
+
+
+
diff --git a/doc/licenses/jsr250-api-1.0/README b/doc/licenses/jsr250-api-1.0/README
new file mode 100644
index 0000000..a939af5
--- /dev/null
+++ b/doc/licenses/jsr250-api-1.0/README
@@ -0,0 +1,9 @@
+JSR-250 Reference Implementation
+(https://jcp.org/aboutJava/communityprocess/final/jsr250/index.html)
+--------------------------------------------------------------------
+
+ Version: 1.0
+ From: 'Oracle Corporation' (http://www.oracle.com/)
+ License(s):
+ CDDL v1.0 (bundled/jsr250-api-1.0/CDDLv1.0.txt)
+
diff --git a/doc/licenses/jsr250-api-1.0/dep-coordinates.txt b/doc/licenses/jsr250-api-1.0/dep-coordinates.txt
new file mode 100644
index 0000000..0fce8f9
--- /dev/null
+++ b/doc/licenses/jsr250-api-1.0/dep-coordinates.txt
@@ -0,0 +1 @@
+javax.annotation:jsr250-api:jar:1.0
diff --git a/doc/licenses/jstz-2.1.1/LICENSE b/doc/licenses/jstz-2.1.1/LICENSE
new file mode 100644
index 0000000..c48af16
--- /dev/null
+++ b/doc/licenses/jstz-2.1.1/LICENSE
@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2012 Jon Nylander, project maintained at
+https://bitbucket.org/pellepim/jstimezonedetect
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to
+do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
\ No newline at end of file
diff --git a/doc/licenses/jstz-2.1.1/README b/doc/licenses/jstz-2.1.1/README
new file mode 100644
index 0000000..09acbde
--- /dev/null
+++ b/doc/licenses/jstz-2.1.1/README
@@ -0,0 +1,8 @@
+JSTZ (https://github.com/iansinnott/jstz)
+-----------------------------------------
+
+ Version: 2.1.1
+ From: 'Jon Nylander' (https://github.com/pellepim)
+ License(s):
+ MIT (bundled/jstz-2.1.1/LICENSE)
+
diff --git a/doc/licenses/jstz-2.1.1/dep-coordinates.txt b/doc/licenses/jstz-2.1.1/dep-coordinates.txt
new file mode 100644
index 0000000..2770176
--- /dev/null
+++ b/doc/licenses/jstz-2.1.1/dep-coordinates.txt
@@ -0,0 +1 @@
+jstz:2.1.1
diff --git a/doc/licenses/kotlin-1.4.10/NOTICE.txt b/doc/licenses/kotlin-1.4.10/NOTICE.txt
new file mode 100644
index 0000000..0f3e7c2
--- /dev/null
+++ b/doc/licenses/kotlin-1.4.10/NOTICE.txt
@@ -0,0 +1,2 @@
+Kotlin Compiler
+Copyright 2010-2023 JetBrains s.r.o and respective authors and developers
diff --git a/doc/licenses/kotlin-1.4.10/README b/doc/licenses/kotlin-1.4.10/README
new file mode 100644
index 0000000..a89a5ce
--- /dev/null
+++ b/doc/licenses/kotlin-1.4.10/README
@@ -0,0 +1,8 @@
+Kotlin (https://kotlinlang.org/)
+--------------------------------
+
+ Version: 1.4.10
+ From: 'JetBrains s.r.o and respective authors and developers'
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/kotlin-1.4.10/dep-coordinates.txt b/doc/licenses/kotlin-1.4.10/dep-coordinates.txt
new file mode 100644
index 0000000..9eedc33
--- /dev/null
+++ b/doc/licenses/kotlin-1.4.10/dep-coordinates.txt
@@ -0,0 +1,5 @@
+org.jetbrains.kotlin:kotlin-reflect:jar:1.4.10
+org.jetbrains.kotlin:kotlin-stdlib:jar:1.4.10
+org.jetbrains.kotlin:kotlin-stdlib-common:jar:1.4.10
+org.jetbrains.kotlin:kotlin-stdlib-jdk8:jar:1.4.10
+org.jetbrains.kotlin:kotlin-stdlib-jdk7:jar:1.4.10
diff --git a/doc/licenses/kotlin-1.9.25/NOTICE.txt b/doc/licenses/kotlin-1.9.25/NOTICE.txt
new file mode 100644
index 0000000..0f3e7c2
--- /dev/null
+++ b/doc/licenses/kotlin-1.9.25/NOTICE.txt
@@ -0,0 +1,2 @@
+Kotlin Compiler
+Copyright 2010-2023 JetBrains s.r.o and respective authors and developers
diff --git a/doc/licenses/kotlin-1.9.25/README b/doc/licenses/kotlin-1.9.25/README
new file mode 100644
index 0000000..53a448a
--- /dev/null
+++ b/doc/licenses/kotlin-1.9.25/README
@@ -0,0 +1,8 @@
+Kotlin (https://kotlinlang.org/)
+--------------------------------
+
+ Version: 1.9.25
+ From: 'JetBrains s.r.o and respective authors and developers'
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/kotlin-1.9.25/dep-coordinates.txt b/doc/licenses/kotlin-1.9.25/dep-coordinates.txt
new file mode 100644
index 0000000..d8221f9
--- /dev/null
+++ b/doc/licenses/kotlin-1.9.25/dep-coordinates.txt
@@ -0,0 +1,5 @@
+org.jetbrains.kotlin:kotlin-reflect:jar:1.9.25
+org.jetbrains.kotlin:kotlin-stdlib:jar:1.9.25
+org.jetbrains.kotlin:kotlin-stdlib-common:jar:1.9.25
+org.jetbrains.kotlin:kotlin-stdlib-jdk8:jar:1.9.25
+org.jetbrains.kotlin:kotlin-stdlib-jdk7:jar:1.9.25
diff --git a/doc/licenses/kotlinx-serialization-1.7.2/NOTICE.txt b/doc/licenses/kotlinx-serialization-1.7.2/NOTICE.txt
new file mode 100644
index 0000000..4560ea0
--- /dev/null
+++ b/doc/licenses/kotlinx-serialization-1.7.2/NOTICE.txt
@@ -0,0 +1,2 @@
+kotlinx.serialization library.
+Copyright 2017-2023 JetBrains s.r.o and respective authors and developers
diff --git a/doc/licenses/kotlinx-serialization-1.7.2/README b/doc/licenses/kotlinx-serialization-1.7.2/README
new file mode 100644
index 0000000..31687c5
--- /dev/null
+++ b/doc/licenses/kotlinx-serialization-1.7.2/README
@@ -0,0 +1,8 @@
+Kotlin Serialization (https://github.com/Kotlin/kotlinx.serialization)
+----------------------------------------------------------------------
+
+ Version: 1.7.2
+ From: 'JetBrains s.r.o and respective authors and developers'
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/kotlinx-serialization-1.7.2/dep-coordinates.txt b/doc/licenses/kotlinx-serialization-1.7.2/dep-coordinates.txt
new file mode 100644
index 0000000..e5f1528
--- /dev/null
+++ b/doc/licenses/kotlinx-serialization-1.7.2/dep-coordinates.txt
@@ -0,0 +1,2 @@
+org.jetbrains.kotlinx:kotlinx-serialization-json-jvm:jar:1.7.2
+org.jetbrains.kotlinx:kotlinx-serialization-core-jvm:jar:1.7.2
diff --git a/doc/licenses/ksm-sdk-17.0.0/LICENSE b/doc/licenses/ksm-sdk-17.0.0/LICENSE
new file mode 100644
index 0000000..b63322a
--- /dev/null
+++ b/doc/licenses/ksm-sdk-17.0.0/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Keeper Security
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/doc/licenses/ksm-sdk-17.0.0/README b/doc/licenses/ksm-sdk-17.0.0/README
new file mode 100644
index 0000000..e84f099
--- /dev/null
+++ b/doc/licenses/ksm-sdk-17.0.0/README
@@ -0,0 +1,9 @@
+Keeper Secrets Manager Java SDK
+(https://github.com/Keeper-Security/secrets-manager)
+----------------------------------------------------
+
+ Version: 17.0.0
+ From: 'Keeper Security' (https://www.keepersecurity.com/)
+ License(s):
+ MIT (bundled/ksm-sdk-17.0.0/LICENSE)
+
diff --git a/doc/licenses/ksm-sdk-17.0.0/dep-coordinates.txt b/doc/licenses/ksm-sdk-17.0.0/dep-coordinates.txt
new file mode 100644
index 0000000..bf11a8f
--- /dev/null
+++ b/doc/licenses/ksm-sdk-17.0.0/dep-coordinates.txt
@@ -0,0 +1 @@
+com.keepersecurity.secrets-manager:core:jar:17.0.0
diff --git a/doc/licenses/lodash-4.17.21/LICENSE b/doc/licenses/lodash-4.17.21/LICENSE
new file mode 100644
index 0000000..77c42f1
--- /dev/null
+++ b/doc/licenses/lodash-4.17.21/LICENSE
@@ -0,0 +1,47 @@
+Copyright OpenJS Foundation and other contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/doc/licenses/make-plural-3.0.6/README b/doc/licenses/make-plural-3.0.6/README
new file mode 100644
index 0000000..a4ddda5
--- /dev/null
+++ b/doc/licenses/make-plural-3.0.6/README
@@ -0,0 +1,8 @@
+make-plural (https://github.com/eemeli/make-plural)
+---------------------------------------------------
+
+ Version: 3.0.6
+ From: 'Eemeli Aro' (https://github.com/eemeli)
+ License(s):
+ ISC (bundled/make-plural-3.0.6/LICENSE)
+
diff --git a/doc/licenses/make-plural-3.0.6/dep-coordinates.txt b/doc/licenses/make-plural-3.0.6/dep-coordinates.txt
new file mode 100644
index 0000000..6005650
--- /dev/null
+++ b/doc/licenses/make-plural-3.0.6/dep-coordinates.txt
@@ -0,0 +1 @@
+make-plural:3.0.6
diff --git a/doc/licenses/messageformat-1.0.2/LICENSE b/doc/licenses/messageformat-1.0.2/LICENSE
new file mode 100644
index 0000000..6b9ea5b
--- /dev/null
+++ b/doc/licenses/messageformat-1.0.2/LICENSE
@@ -0,0 +1,20 @@
+Copyright 2012-2016 Alex Sexton, Eemeli Aro, and Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/doc/licenses/messageformat-1.0.2/README b/doc/licenses/messageformat-1.0.2/README
new file mode 100644
index 0000000..9a9653f
--- /dev/null
+++ b/doc/licenses/messageformat-1.0.2/README
@@ -0,0 +1,8 @@
+messageformat ( (https://messageformat.github.io/)
+--------------------------------------------------
+
+ Version: 1.0.2
+ From: 'Alex Sexton, Eemeli Aro, and Contributors'
+ License(s):
+ MIT (bundled/messageformat-1.0.2/LICENSE)
+
diff --git a/doc/licenses/messageformat-1.0.2/dep-coordinates.txt b/doc/licenses/messageformat-1.0.2/dep-coordinates.txt
new file mode 100644
index 0000000..09367ea
--- /dev/null
+++ b/doc/licenses/messageformat-1.0.2/dep-coordinates.txt
@@ -0,0 +1 @@
+messageformat:1.0.2
diff --git a/doc/licenses/messageformat-parser-1.1.0/LICENSE b/doc/licenses/messageformat-parser-1.1.0/LICENSE
new file mode 100644
index 0000000..6b9ea5b
--- /dev/null
+++ b/doc/licenses/messageformat-parser-1.1.0/LICENSE
@@ -0,0 +1,20 @@
+Copyright 2012-2016 Alex Sexton, Eemeli Aro, and Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/doc/licenses/messageformat-parser-1.1.0/README b/doc/licenses/messageformat-parser-1.1.0/README
new file mode 100644
index 0000000..bc9d129
--- /dev/null
+++ b/doc/licenses/messageformat-parser-1.1.0/README
@@ -0,0 +1,8 @@
+messageformat-parser (https://messageformat.github.io/)
+-------------------------------------------------------
+
+ Version: 1.1.0
+ From: 'Alex Sexton, Eemeli Aro, and Contributors'
+ License(s):
+ MIT (bundled/messageformat-parser-1.1.0/LICENSE)
+
diff --git a/doc/licenses/messageformat-parser-1.1.0/dep-coordinates.txt b/doc/licenses/messageformat-parser-1.1.0/dep-coordinates.txt
new file mode 100644
index 0000000..c323029
--- /dev/null
+++ b/doc/licenses/messageformat-parser-1.1.0/dep-coordinates.txt
@@ -0,0 +1 @@
+messageformat-parser:1.1.0
diff --git a/doc/licenses/mybatis-3.5.19/NOTICE b/doc/licenses/mybatis-3.5.19/NOTICE
new file mode 100644
index 0000000..35d17fd
--- /dev/null
+++ b/doc/licenses/mybatis-3.5.19/NOTICE
@@ -0,0 +1,45 @@
+iBATIS
+ This product includes software developed by
+ The Apache Software Foundation (http://www.apache.org/).
+
+ Copyright 2010 The Apache Software Foundation
+
+OGNL
+//--------------------------------------------------------------------------
+// Copyright (c) 2004, Drew Davidson and Luke Blanshard
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+// Redistributions of source code must retain the above copyright notice,
+// this list of conditions and the following disclaimer.
+// Redistributions in binary form must reproduce the above copyright
+// notice, this list of conditions and the following disclaimer in the
+// documentation and/or other materials provided with the distribution.
+// Neither the name of the Drew Davidson nor the names of its contributors
+// may be used to endorse or promote products derived from this software
+// without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+// COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+// OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+// AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+// DAMAGE.
+//--------------------------------------------------------------------------
+
+Refactored SqlBuilder class (SQL, AbstractSQL)
+
+ This product includes software developed by
+ Adam Gent (https://gist.github.com/3650165)
+
+ Copyright 2010 Adam Gent
+
diff --git a/doc/licenses/mybatis-3.5.19/README b/doc/licenses/mybatis-3.5.19/README
new file mode 100644
index 0000000..e40f1f3
--- /dev/null
+++ b/doc/licenses/mybatis-3.5.19/README
@@ -0,0 +1,8 @@
+MyBatis (http://www.mybatis.org/mybatis-3/)
+-------------------------------------------
+
+ Version: 3.5.19
+ From: 'MyBatis' (http://www.mybatis.org/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/mybatis-3.5.19/dep-coordinates.txt b/doc/licenses/mybatis-3.5.19/dep-coordinates.txt
new file mode 100644
index 0000000..9606604
--- /dev/null
+++ b/doc/licenses/mybatis-3.5.19/dep-coordinates.txt
@@ -0,0 +1 @@
+org.mybatis:mybatis:jar:3.5.19
diff --git a/doc/licenses/mybatis-guice-3.18/NOTICE b/doc/licenses/mybatis-guice-3.18/NOTICE
new file mode 100644
index 0000000..328bb03
--- /dev/null
+++ b/doc/licenses/mybatis-guice-3.18/NOTICE
@@ -0,0 +1,15 @@
+MyBatis-Guice
+Copyright 2010-2013
+
+This product includes software developed by
+The MyBatis Team (http://www.mybatis.org/).
+
+iBATIS
+ This product includes software developed by
+ The Apache Software Foundation (http://www.apache.org/).
+
+ Copyright 2010 The Apache Software Foundation
+
+Google Guice
+ Copyright 2010 The Apache Software Foundation
+
diff --git a/doc/licenses/mybatis-guice-3.18/README b/doc/licenses/mybatis-guice-3.18/README
new file mode 100644
index 0000000..9cc0c0a
--- /dev/null
+++ b/doc/licenses/mybatis-guice-3.18/README
@@ -0,0 +1,8 @@
+MyBatis-Guice (http://www.mybatis.org/guice/)
+---------------------------------------------
+
+ Version: 3.18
+ From: 'MyBatis' (http://www.mybatis.org/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/mybatis-guice-3.18/dep-coordinates.txt b/doc/licenses/mybatis-guice-3.18/dep-coordinates.txt
new file mode 100644
index 0000000..dbe9193
--- /dev/null
+++ b/doc/licenses/mybatis-guice-3.18/dep-coordinates.txt
@@ -0,0 +1 @@
+org.mybatis:mybatis-guice:jar:3.18
diff --git a/doc/licenses/object-assign-4.1.1/LICENSE b/doc/licenses/object-assign-4.1.1/LICENSE
new file mode 100644
index 0000000..654d0bf
--- /dev/null
+++ b/doc/licenses/object-assign-4.1.1/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Sindre Sorhus (sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/doc/licenses/object-assign-4.1.1/README b/doc/licenses/object-assign-4.1.1/README
new file mode 100644
index 0000000..1ec09f6
--- /dev/null
+++ b/doc/licenses/object-assign-4.1.1/README
@@ -0,0 +1,8 @@
+object-assign (https://github.com/sindresorhus/object-assign/)
+--------------------------------------------------------------
+
+ Version: 4.1.1
+ From: 'Sindre Sorhus' (https://github.com/sindresorhus)
+ License(s):
+ MIT (bundled/open-assign-4.1.1/LICENSE)
+
diff --git a/doc/licenses/object-assign-4.1.1/dep-coordinates.txt b/doc/licenses/object-assign-4.1.1/dep-coordinates.txt
new file mode 100644
index 0000000..4924590
--- /dev/null
+++ b/doc/licenses/object-assign-4.1.1/dep-coordinates.txt
@@ -0,0 +1 @@
+object-assign:4.1.1
diff --git a/doc/licenses/okhttp-4.12.0/NOTICE b/doc/licenses/okhttp-4.12.0/NOTICE
new file mode 100644
index 0000000..7ab6fba
--- /dev/null
+++ b/doc/licenses/okhttp-4.12.0/NOTICE
@@ -0,0 +1,13 @@
+Copyright 2021 Square, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/doc/licenses/okhttp-4.12.0/README b/doc/licenses/okhttp-4.12.0/README
new file mode 100644
index 0000000..54aee25
--- /dev/null
+++ b/doc/licenses/okhttp-4.12.0/README
@@ -0,0 +1,8 @@
+OkHttp (https://square.github.io/okhttp/)
+-----------------------------------------
+
+ Version: 4.12.0
+ From: 'Square Inc'
+ License(s):
+ Apache 2.0
+
diff --git a/doc/licenses/okhttp-4.12.0/dep-coordinates.txt b/doc/licenses/okhttp-4.12.0/dep-coordinates.txt
new file mode 100644
index 0000000..8aeb660
--- /dev/null
+++ b/doc/licenses/okhttp-4.12.0/dep-coordinates.txt
@@ -0,0 +1,2 @@
+com.squareup.okhttp3:okhttp:jar:4.12.0
+com.squareup.okhttp3:logging-interceptor:jar:4.12.0
diff --git a/doc/licenses/okio-3.6.0/NOTICE b/doc/licenses/okio-3.6.0/NOTICE
new file mode 100644
index 0000000..9004e5d
--- /dev/null
+++ b/doc/licenses/okio-3.6.0/NOTICE
@@ -0,0 +1,13 @@
+Copyright 2020 Square, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/doc/licenses/okio-3.6.0/README b/doc/licenses/okio-3.6.0/README
new file mode 100644
index 0000000..23b5197
--- /dev/null
+++ b/doc/licenses/okio-3.6.0/README
@@ -0,0 +1,8 @@
+Okio (https://square.github.io/okio/)
+-------------------------------------
+
+ Version: 3.6.0
+ From: 'Square Inc'
+ License(s):
+ Apache 2.0
+
diff --git a/doc/licenses/okio-3.6.0/dep-coordinates.txt b/doc/licenses/okio-3.6.0/dep-coordinates.txt
new file mode 100644
index 0000000..b785b26
--- /dev/null
+++ b/doc/licenses/okio-3.6.0/dep-coordinates.txt
@@ -0,0 +1,2 @@
+com.squareup.okio:okio:jar:3.6.0
+com.squareup.okio:okio-jvm:jar:3.6.0
diff --git a/doc/licenses/osgi-resource-locator-1.0.3/LICENSE.md b/doc/licenses/osgi-resource-locator-1.0.3/LICENSE.md
new file mode 100644
index 0000000..4f38d09
--- /dev/null
+++ b/doc/licenses/osgi-resource-locator-1.0.3/LICENSE.md
@@ -0,0 +1,637 @@
+# Eclipse Public License - v 2.0
+
+ THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
+ PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
+ OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
+
+ 1. DEFINITIONS
+
+ "Contribution" means:
+
+ a) in the case of the initial Contributor, the initial content
+ Distributed under this Agreement, and
+
+ b) in the case of each subsequent Contributor:
+ i) changes to the Program, and
+ ii) additions to the Program;
+ where such changes and/or additions to the Program originate from
+ and are Distributed by that particular Contributor. A Contribution
+ "originates" from a Contributor if it was added to the Program by
+ such Contributor itself or anyone acting on such Contributor's behalf.
+ Contributions do not include changes or additions to the Program that
+ are not Modified Works.
+
+ "Contributor" means any person or entity that Distributes the Program.
+
+ "Licensed Patents" mean patent claims licensable by a Contributor which
+ are necessarily infringed by the use or sale of its Contribution alone
+ or when combined with the Program.
+
+ "Program" means the Contributions Distributed in accordance with this
+ Agreement.
+
+ "Recipient" means anyone who receives the Program under this Agreement
+ or any Secondary License (as applicable), including Contributors.
+
+ "Derivative Works" shall mean any work, whether in Source Code or other
+ form, that is based on (or derived from) the Program and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship.
+
+ "Modified Works" shall mean any work in Source Code or other form that
+ results from an addition to, deletion from, or modification of the
+ contents of the Program, including, for purposes of clarity any new file
+ in Source Code form that contains any contents of the Program. Modified
+ Works shall not include works that contain only declarations,
+ interfaces, types, classes, structures, or files of the Program solely
+ in each case in order to link to, bind by name, or subclass the Program
+ or Modified Works thereof.
+
+ "Distribute" means the acts of a) distributing or b) making available
+ in any manner that enables the transfer of a copy.
+
+ "Source Code" means the form of a Program preferred for making
+ modifications, including but not limited to software source code,
+ documentation source, and configuration files.
+
+ "Secondary License" means either the GNU General Public License,
+ Version 2.0, or any later versions of that license, including any
+ exceptions or additional permissions as identified by the initial
+ Contributor.
+
+ 2. GRANT OF RIGHTS
+
+ a) Subject to the terms of this Agreement, each Contributor hereby
+ grants Recipient a non-exclusive, worldwide, royalty-free copyright
+ license to reproduce, prepare Derivative Works of, publicly display,
+ publicly perform, Distribute and sublicense the Contribution of such
+ Contributor, if any, and such Derivative Works.
+
+ b) Subject to the terms of this Agreement, each Contributor hereby
+ grants Recipient a non-exclusive, worldwide, royalty-free patent
+ license under Licensed Patents to make, use, sell, offer to sell,
+ import and otherwise transfer the Contribution of such Contributor,
+ if any, in Source Code or other form. This patent license shall
+ apply to the combination of the Contribution and the Program if, at
+ the time the Contribution is added by the Contributor, such addition
+ of the Contribution causes such combination to be covered by the
+ Licensed Patents. The patent license shall not apply to any other
+ combinations which include the Contribution. No hardware per se is
+ licensed hereunder.
+
+ c) Recipient understands that although each Contributor grants the
+ licenses to its Contributions set forth herein, no assurances are
+ provided by any Contributor that the Program does not infringe the
+ patent or other intellectual property rights of any other entity.
+ Each Contributor disclaims any liability to Recipient for claims
+ brought by any other entity based on infringement of intellectual
+ property rights or otherwise. As a condition to exercising the
+ rights and licenses granted hereunder, each Recipient hereby
+ assumes sole responsibility to secure any other intellectual
+ property rights needed, if any. For example, if a third party
+ patent license is required to allow Recipient to Distribute the
+ Program, it is Recipient's responsibility to acquire that license
+ before distributing the Program.
+
+ d) Each Contributor represents that to its knowledge it has
+ sufficient copyright rights in its Contribution, if any, to grant
+ the copyright license set forth in this Agreement.
+
+ e) Notwithstanding the terms of any Secondary License, no
+ Contributor makes additional grants to any Recipient (other than
+ those set forth in this Agreement) as a result of such Recipient's
+ receipt of the Program under the terms of a Secondary License
+ (if permitted under the terms of Section 3).
+
+ 3. REQUIREMENTS
+
+ 3.1 If a Contributor Distributes the Program in any form, then:
+
+ a) the Program must also be made available as Source Code, in
+ accordance with section 3.2, and the Contributor must accompany
+ the Program with a statement that the Source Code for the Program
+ is available under this Agreement, and informs Recipients how to
+ obtain it in a reasonable manner on or through a medium customarily
+ used for software exchange; and
+
+ b) the Contributor may Distribute the Program under a license
+ different than this Agreement, provided that such license:
+ i) effectively disclaims on behalf of all other Contributors all
+ warranties and conditions, express and implied, including
+ warranties or conditions of title and non-infringement, and
+ implied warranties or conditions of merchantability and fitness
+ for a particular purpose;
+
+ ii) effectively excludes on behalf of all other Contributors all
+ liability for damages, including direct, indirect, special,
+ incidental and consequential damages, such as lost profits;
+
+ iii) does not attempt to limit or alter the recipients' rights
+ in the Source Code under section 3.2; and
+
+ iv) requires any subsequent distribution of the Program by any
+ party to be under a license that satisfies the requirements
+ of this section 3.
+
+ 3.2 When the Program is Distributed as Source Code:
+
+ a) it must be made available under this Agreement, or if the
+ Program (i) is combined with other material in a separate file or
+ files made available under a Secondary License, and (ii) the initial
+ Contributor attached to the Source Code the notice described in
+ Exhibit A of this Agreement, then the Program may be made available
+ under the terms of such Secondary Licenses, and
+
+ b) a copy of this Agreement must be included with each copy of
+ the Program.
+
+ 3.3 Contributors may not remove or alter any copyright, patent,
+ trademark, attribution notices, disclaimers of warranty, or limitations
+ of liability ("notices") contained within the Program from any copy of
+ the Program which they Distribute, provided that Contributors may add
+ their own appropriate notices.
+
+ 4. COMMERCIAL DISTRIBUTION
+
+ Commercial distributors of software may accept certain responsibilities
+ with respect to end users, business partners and the like. While this
+ license is intended to facilitate the commercial use of the Program,
+ the Contributor who includes the Program in a commercial product
+ offering should do so in a manner which does not create potential
+ liability for other Contributors. Therefore, if a Contributor includes
+ the Program in a commercial product offering, such Contributor
+ ("Commercial Contributor") hereby agrees to defend and indemnify every
+ other Contributor ("Indemnified Contributor") against any losses,
+ damages and costs (collectively "Losses") arising from claims, lawsuits
+ and other legal actions brought by a third party against the Indemnified
+ Contributor to the extent caused by the acts or omissions of such
+ Commercial Contributor in connection with its distribution of the Program
+ in a commercial product offering. The obligations in this section do not
+ apply to any claims or Losses relating to any actual or alleged
+ intellectual property infringement. In order to qualify, an Indemnified
+ Contributor must: a) promptly notify the Commercial Contributor in
+ writing of such claim, and b) allow the Commercial Contributor to control,
+ and cooperate with the Commercial Contributor in, the defense and any
+ related settlement negotiations. The Indemnified Contributor may
+ participate in any such claim at its own expense.
+
+ For example, a Contributor might include the Program in a commercial
+ product offering, Product X. That Contributor is then a Commercial
+ Contributor. If that Commercial Contributor then makes performance
+ claims, or offers warranties related to Product X, those performance
+ claims and warranties are such Commercial Contributor's responsibility
+ alone. Under this section, the Commercial Contributor would have to
+ defend claims against the other Contributors related to those performance
+ claims and warranties, and if a court requires any other Contributor to
+ pay any damages as a result, the Commercial Contributor must pay
+ those damages.
+
+ 5. NO WARRANTY
+
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
+ PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
+ BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
+ IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
+ TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
+ PURPOSE. Each Recipient is solely responsible for determining the
+ appropriateness of using and distributing the Program and assumes all
+ risks associated with its exercise of rights under this Agreement,
+ including but not limited to the risks and costs of program errors,
+ compliance with applicable laws, damage to or loss of data, programs
+ or equipment, and unavailability or interruption of operations.
+
+ 6. DISCLAIMER OF LIABILITY
+
+ EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
+ PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
+ SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
+ PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
+ EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGES.
+
+ 7. GENERAL
+
+ If any provision of this Agreement is invalid or unenforceable under
+ applicable law, it shall not affect the validity or enforceability of
+ the remainder of the terms of this Agreement, and without further
+ action by the parties hereto, such provision shall be reformed to the
+ minimum extent necessary to make such provision valid and enforceable.
+
+ If Recipient institutes patent litigation against any entity
+ (including a cross-claim or counterclaim in a lawsuit) alleging that the
+ Program itself (excluding combinations of the Program with other software
+ or hardware) infringes such Recipient's patent(s), then such Recipient's
+ rights granted under Section 2(b) shall terminate as of the date such
+ litigation is filed.
+
+ All Recipient's rights under this Agreement shall terminate if it
+ fails to comply with any of the material terms or conditions of this
+ Agreement and does not cure such failure in a reasonable period of
+ time after becoming aware of such noncompliance. If all Recipient's
+ rights under this Agreement terminate, Recipient agrees to cease use
+ and distribution of the Program as soon as reasonably practicable.
+ However, Recipient's obligations under this Agreement and any licenses
+ granted by Recipient relating to the Program shall continue and survive.
+
+ Everyone is permitted to copy and distribute copies of this Agreement,
+ but in order to avoid inconsistency the Agreement is copyrighted and
+ may only be modified in the following manner. The Agreement Steward
+ reserves the right to publish new versions (including revisions) of
+ this Agreement from time to time. No one other than the Agreement
+ Steward has the right to modify this Agreement. The Eclipse Foundation
+ is the initial Agreement Steward. The Eclipse Foundation may assign the
+ responsibility to serve as the Agreement Steward to a suitable separate
+ entity. Each new version of the Agreement will be given a distinguishing
+ version number. The Program (including Contributions) may always be
+ Distributed subject to the version of the Agreement under which it was
+ received. In addition, after a new version of the Agreement is published,
+ Contributor may elect to Distribute the Program (including its
+ Contributions) under the new version.
+
+ Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
+ receives no rights or licenses to the intellectual property of any
+ Contributor under this Agreement, whether expressly, by implication,
+ estoppel or otherwise. All rights in the Program not expressly granted
+ under this Agreement are reserved. Nothing in this Agreement is intended
+ to be enforceable by any entity that is not a Contributor or Recipient.
+ No third-party beneficiary rights are created under this Agreement.
+
+ Exhibit A - Form of Secondary Licenses Notice
+
+ "This Source Code may also be made available under the following
+ Secondary Licenses when the conditions for such availability set forth
+ in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
+ version(s), and exceptions or additional permissions here}."
+
+ Simply including a copy of this Agreement, including this Exhibit A
+ is not sufficient to license the Source Code under Secondary Licenses.
+
+ If it is not possible or desirable to put the notice in a particular
+ file, then You may include the notice in a location (such as a LICENSE
+ file in a relevant directory) where a recipient would be likely to
+ look for such a notice.
+
+ You may add additional accurate notices of copyright ownership.
+
+---
+
+## The GNU General Public License (GPL) Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor
+ Boston, MA 02110-1335
+ USA
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your freedom to
+ share and change it. By contrast, the GNU General Public License is
+ intended to guarantee your freedom to share and change free software--to
+ make sure the software is free for all its users. This General Public
+ License applies to most of the Free Software Foundation's software and
+ to any other program whose authors commit to using it. (Some other Free
+ Software Foundation software is covered by the GNU Library General
+ Public License instead.) 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 this
+ service 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 make restrictions that forbid anyone
+ to deny you these rights or to ask you to surrender the rights. These
+ restrictions translate to certain responsibilities for you if you
+ distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether gratis
+ or for a fee, you must give the recipients all the rights that you have.
+ 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.
+
+ We protect your rights with two steps: (1) copyright the software, and
+ (2) offer you this license which gives you legal permission to copy,
+ distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+ that everyone understands that there is no warranty for this free
+ software. If the software is modified by someone else and passed on, we
+ want its recipients to know that what they have is not the original, so
+ that any problems introduced by others will not reflect on the original
+ authors' reputations.
+
+ Finally, any free program is threatened constantly by software patents.
+ We wish to avoid the danger that redistributors of a free program will
+ individually obtain patent licenses, in effect making the program
+ proprietary. To prevent this, we have made it clear that any patent must
+ be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+ modification follow.
+
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains a
+ notice placed by the copyright holder saying it may be distributed under
+ the terms of this General Public License. The "Program", below, refers
+ to any such program or work, and a "work based on the Program" means
+ either the Program or any derivative work under copyright law: that is
+ to say, a work containing the Program or a portion of it, either
+ verbatim or with modifications and/or translated into another language.
+ (Hereinafter, translation is included without limitation in the term
+ "modification".) Each licensee is addressed as "you".
+
+ Activities other than copying, distribution and modification are not
+ covered by this License; they are outside its scope. The act of running
+ the Program is not restricted, and the output from the Program is
+ covered only if its contents constitute a work based on the Program
+ (independent of having been made by running the Program). Whether that
+ is true depends on what the Program does.
+
+ 1. You may copy and distribute 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
+ and disclaimer of warranty; keep intact all the notices that refer to
+ this License and to the absence of any warranty; and give any other
+ recipients of the Program a copy of this License along with the Program.
+
+ You may charge a fee for the physical act of transferring a copy, and
+ you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion of
+ it, thus forming a work based on the Program, and copy and distribute
+ such modifications or work under the terms of Section 1 above, provided
+ that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any part
+ thereof, to be licensed as a whole at no charge to all third parties
+ under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a notice
+ that there is no warranty (or else, saying that you provide a
+ warranty) and that users may redistribute the program under these
+ conditions, and telling the user how to view a copy of this License.
+ (Exception: if the Program itself is interactive but does not
+ normally print such an announcement, your work based on the Program
+ is not required to print an announcement.)
+
+ These requirements apply to the modified work as a whole. If
+ identifiable sections of that work are not derived from the Program, and
+ can be reasonably considered independent and separate works in
+ themselves, then this License, and its terms, do not apply to those
+ sections when you distribute them as separate works. But when you
+ distribute the same sections as part of a whole which is a work based on
+ the Program, the distribution of the whole must be on the terms of this
+ License, whose permissions for other licensees extend to the entire
+ whole, and thus to each and every part regardless of who wrote it.
+
+ Thus, it is not the intent of this section to claim rights or contest
+ your rights to work written entirely by you; rather, the intent is to
+ exercise the right to control the distribution of derivative or
+ collective works based on the Program.
+
+ In addition, mere aggregation of another work not based on the Program
+ with the Program (or with a work based on the Program) on a volume of a
+ storage or distribution medium does not bring the other work under the
+ scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+ under Section 2) in object code or executable form under the terms of
+ Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections 1
+ and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your cost
+ of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer to
+ distribute corresponding source code. (This alternative is allowed
+ only for noncommercial distribution and only if you received the
+ program in object code or executable form with such an offer, in
+ accord with Subsection b above.)
+
+ The source code for a work means the preferred form of the work for
+ making modifications to it. For an executable work, complete source code
+ means all the source code for all modules it contains, plus any
+ associated interface definition files, plus the scripts used to control
+ compilation and installation of the executable. However, as a special
+ exception, the source code distributed need not include anything that is
+ normally distributed (in either source or binary form) with the major
+ components (compiler, kernel, and so on) of the operating system on
+ which the executable runs, unless that component itself accompanies the
+ executable.
+
+ If distribution of executable or object code is made by offering access
+ to copy from a designated place, then offering equivalent access to copy
+ the source code from the same place counts as distribution of the source
+ code, even though third parties are not compelled to copy the source
+ along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+ except as expressly provided under this License. Any attempt otherwise
+ to copy, modify, sublicense or distribute the Program is void, and will
+ automatically terminate your rights under this License. However, parties
+ who have received copies, or rights, from you under this License will
+ not have their licenses terminated so long as such parties remain in
+ full compliance.
+
+ 5. You are not required to accept this License, since you have not
+ signed it. However, nothing else grants you permission to modify or
+ distribute the Program or its derivative works. These actions are
+ prohibited by law if you do not accept this License. Therefore, by
+ modifying or distributing the Program (or any work based on the
+ Program), you indicate your acceptance of this License to do so, and all
+ its terms and conditions for copying, distributing or modifying the
+ Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+ Program), the recipient automatically receives a license from the
+ original licensor to copy, distribute or modify the Program subject to
+ these terms and conditions. You may not impose any further restrictions
+ on the recipients' exercise of the rights granted herein. You are not
+ responsible for enforcing compliance by third parties to this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+ infringement or for any other reason (not limited to patent issues),
+ 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 distribute
+ so as to satisfy simultaneously your obligations under this License and
+ any other pertinent obligations, then as a consequence you may not
+ distribute the Program at all. For example, if a patent license would
+ not permit royalty-free redistribution of the Program by all those who
+ receive copies directly or indirectly through you, then the only way you
+ could satisfy both it and this License would be to refrain entirely from
+ distribution of the Program.
+
+ If any portion of this section is held invalid or unenforceable under
+ any particular circumstance, the balance of the section is intended to
+ apply and the section as a whole is intended to apply in other
+ circumstances.
+
+ It is not the purpose of this section to induce you to infringe any
+ patents or other property right claims or to contest validity of any
+ such claims; this section has the sole purpose of protecting the
+ integrity of the free software distribution system, which is implemented
+ by public license practices. Many people have made generous
+ contributions to the wide range of software distributed through that
+ system in reliance on consistent application of that system; it is up to
+ the author/donor to decide if he or she is willing to distribute
+ software through any other system and a licensee cannot impose that choice.
+
+ This section is intended to make thoroughly clear what is believed to be
+ a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+ certain countries either by patents or by copyrighted interfaces, the
+ original copyright holder who places the Program under this License may
+ add an explicit geographical distribution limitation excluding those
+ countries, so that distribution is permitted only in or among countries
+ not thus excluded. In such case, this License incorporates the
+ limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new
+ versions of the 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 a version number of this License which applies to it and "any
+ later version", you have the option of following the terms and
+ conditions either of that version or of any later version published by
+ the Free Software Foundation. If the Program does not specify a version
+ number of this License, you may choose any version ever published by the
+ Free Software Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+ programs whose distribution conditions are different, write to the
+ author to ask for permission. For software which is copyrighted by the
+ Free Software Foundation, write to the Free Software Foundation; we
+ sometimes make exceptions for this. Our decision will be guided by the
+ two goals of preserving the free status of all derivatives of our free
+ software and of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+ WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+ AND/OR REDISTRIBUTE 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.
+
+ 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 convey
+ 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)
+
+ 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 2 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, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA
+
+ Also add information on how to contact you by electronic and paper mail.
+
+ If the program is interactive, make it output a short notice like this
+ when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision 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, the commands
+ you use may be called something other than `show w' and `show c'; they
+ could even be mouse-clicks or menu items--whatever suits your program.
+
+ You should also get your employer (if you work as a programmer) or your
+ school, if any, to sign a "copyright disclaimer" for the program, if
+ necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ program `Gnomovision' (which makes passes at compilers) written by
+ James Hacker.
+
+ signature of Ty Coon, 1 April 1989
+ Ty Coon, President of Vice
+
+ This 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 Library
+ General Public License instead of this License.
+
+---
+
+## CLASSPATH EXCEPTION
+
+ Linking this library statically or dynamically with other modules is
+ making a combined work based on this library. Thus, the terms and
+ conditions of the GNU General Public License version 2 cover the whole
+ combination.
+
+ As a special exception, the copyright holders of this library give you
+ permission to link this library with independent modules to produce an
+ executable, regardless of the license terms of these independent
+ modules, and to copy and distribute the resulting executable under
+ terms of your choice, provided that you also meet, for each linked
+ independent module, the terms and conditions of the license of that
+ module. An independent module is a module which is not derived from or
+ based on this library. If you modify this library, you may extend this
+ exception to your version of the library, but you are not obligated to
+ do so. If you do not wish to do so, delete this exception statement
+ from your version.
diff --git a/doc/licenses/osgi-resource-locator-1.0.3/README b/doc/licenses/osgi-resource-locator-1.0.3/README
new file mode 100644
index 0000000..f4e2694
--- /dev/null
+++ b/doc/licenses/osgi-resource-locator-1.0.3/README
@@ -0,0 +1,8 @@
+HK2 OSGi resource locator (https://github.com/eclipse-ee4j/glassfish-hk2-extra)
+-------------------------------------------------------------------------------
+
+ Version: 1.0.3
+ From: 'Oracle Corporation' (http://www.oracle.com/)
+ License(s):
+ EPL v2.0 (bundled/osgi-resource-locator-1.0.3/LICENSE.md)
+
diff --git a/doc/licenses/osgi-resource-locator-1.0.3/dep-coordinates.txt b/doc/licenses/osgi-resource-locator-1.0.3/dep-coordinates.txt
new file mode 100644
index 0000000..b8a60a5
--- /dev/null
+++ b/doc/licenses/osgi-resource-locator-1.0.3/dep-coordinates.txt
@@ -0,0 +1 @@
+org.glassfish.hk2:osgi-resource-locator:jar:1.0.3
diff --git a/doc/licenses/pickr-1.8.2/LICENSE b/doc/licenses/pickr-1.8.2/LICENSE
new file mode 100644
index 0000000..0f97438
--- /dev/null
+++ b/doc/licenses/pickr-1.8.2/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 - 2021 Simon Reinisch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/doc/licenses/pickr-1.8.2/README b/doc/licenses/pickr-1.8.2/README
new file mode 100644
index 0000000..009387d
--- /dev/null
+++ b/doc/licenses/pickr-1.8.2/README
@@ -0,0 +1,8 @@
+Pickr (https://simonwep.github.io/pickr/)
+-----------------------------------------
+
+ Version: 1.8.2
+ From: 'Simon Reinisch' (https://github.com/Simonwep/)
+ License(s):
+ MIT (bundled/pickr-1.8.2/LICENSE)
+
diff --git a/doc/licenses/pickr-1.8.2/dep-coordinates.txt b/doc/licenses/pickr-1.8.2/dep-coordinates.txt
new file mode 100644
index 0000000..aea9a77
--- /dev/null
+++ b/doc/licenses/pickr-1.8.2/dep-coordinates.txt
@@ -0,0 +1 @@
+@simonwep/pickr:1.8.2
diff --git a/doc/licenses/process-0.11.10/LICENSE b/doc/licenses/process-0.11.10/LICENSE
new file mode 100644
index 0000000..b8c1246
--- /dev/null
+++ b/doc/licenses/process-0.11.10/LICENSE
@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2013 Roman Shtylman
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/doc/licenses/process-0.11.10/README b/doc/licenses/process-0.11.10/README
new file mode 100644
index 0000000..450a924
--- /dev/null
+++ b/doc/licenses/process-0.11.10/README
@@ -0,0 +1,8 @@
+process (https://github.com/defunctzombie/node-process/)
+--------------------------------------------------------
+
+ Version: 0.11.10
+ From: 'Roman Shtylman' (https://github.com/defunctzombie)
+ License(s):
+ MIT (bundled/process-0.11.10/LICENSE)
+
diff --git a/doc/licenses/process-0.11.10/dep-coordinates.txt b/doc/licenses/process-0.11.10/dep-coordinates.txt
new file mode 100644
index 0000000..0fff967
--- /dev/null
+++ b/doc/licenses/process-0.11.10/dep-coordinates.txt
@@ -0,0 +1 @@
+process:0.11.10
diff --git a/doc/licenses/process-nextick-args-2.0.1/README b/doc/licenses/process-nextick-args-2.0.1/README
new file mode 100644
index 0000000..84417dc
--- /dev/null
+++ b/doc/licenses/process-nextick-args-2.0.1/README
@@ -0,0 +1,8 @@
+process-nextick-args (https://github.com/calvinmetcalf/process-nextick-args)
+---------------------------------------------
+
+ Version: 2.0.1
+ From: 'Calvin Metcalf' (https://github.com/calvinmetcalf)
+ License(s):
+ MIT (bundled/process-nextick-args-2.0.1/license.md)
+
diff --git a/doc/licenses/process-nextick-args-2.0.1/dep-coordinates.txt b/doc/licenses/process-nextick-args-2.0.1/dep-coordinates.txt
new file mode 100644
index 0000000..7c68c4b
--- /dev/null
+++ b/doc/licenses/process-nextick-args-2.0.1/dep-coordinates.txt
@@ -0,0 +1 @@
+process-nextick-args:2.0.1
diff --git a/doc/licenses/process-nextick-args-2.0.1/license.md b/doc/licenses/process-nextick-args-2.0.1/license.md
new file mode 100644
index 0000000..c67e353
--- /dev/null
+++ b/doc/licenses/process-nextick-args-2.0.1/license.md
@@ -0,0 +1,19 @@
+# Copyright (c) 2015 Calvin Metcalf
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+**THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.**
diff --git a/doc/licenses/readable-stream-2.3.7/LICENSE b/doc/licenses/readable-stream-2.3.7/LICENSE
new file mode 100644
index 0000000..2873b3b
--- /dev/null
+++ b/doc/licenses/readable-stream-2.3.7/LICENSE
@@ -0,0 +1,47 @@
+Node.js is licensed for use as follows:
+
+"""
+Copyright Node.js contributors. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
+"""
+
+This license applies to parts of Node.js originating from the
+https://github.com/joyent/node repository:
+
+"""
+Copyright Joyent, Inc. and other Node contributors. All rights reserved.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
+"""
diff --git a/doc/licenses/readable-stream-2.3.7/README b/doc/licenses/readable-stream-2.3.7/README
new file mode 100644
index 0000000..6e09569
--- /dev/null
+++ b/doc/licenses/readable-stream-2.3.7/README
@@ -0,0 +1,8 @@
+readable-stream (https://github.com/nodejs/readable-stream)
+---------------------------------------------
+
+ Version: 2.3.7
+ From: 'Node.js contributors, Joyent, Inc., and other Node contributors'
+ License(s):
+ MIT (bundled/readable-stream-2.3.7/LICENSE)
+
diff --git a/doc/licenses/readable-stream-2.3.7/dep-coordinates.txt b/doc/licenses/readable-stream-2.3.7/dep-coordinates.txt
new file mode 100644
index 0000000..f645a21
--- /dev/null
+++ b/doc/licenses/readable-stream-2.3.7/dep-coordinates.txt
@@ -0,0 +1 @@
+readable-stream:2.3.7
diff --git a/doc/licenses/reserved-words-0.1.2/LICENSE b/doc/licenses/reserved-words-0.1.2/LICENSE
new file mode 100644
index 0000000..dcf4fc8
--- /dev/null
+++ b/doc/licenses/reserved-words-0.1.2/LICENSE
@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright 2015 Alexej Yaroshevich and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/doc/licenses/reserved-words-0.1.2/README b/doc/licenses/reserved-words-0.1.2/README
new file mode 100644
index 0000000..34eb13d
--- /dev/null
+++ b/doc/licenses/reserved-words-0.1.2/README
@@ -0,0 +1,8 @@
+reserved-words (https://github.com/qfox/reserved-words/)
+--------------------------------------------------------
+
+ Version: 0.1.2
+ From: 'Alexej Yaroshevich and other contributors'
+ License(s):
+ MIT (bundled/reserved-words-0.1.2/LICENSE)
+
diff --git a/doc/licenses/reserved-words-0.1.2/dep-coordinates.txt b/doc/licenses/reserved-words-0.1.2/dep-coordinates.txt
new file mode 100644
index 0000000..aa36d49
--- /dev/null
+++ b/doc/licenses/reserved-words-0.1.2/dep-coordinates.txt
@@ -0,0 +1 @@
+reserved-words:0.1.2
diff --git a/doc/licenses/retrofit-2.11.0/NOTICE b/doc/licenses/retrofit-2.11.0/NOTICE
new file mode 100644
index 0000000..0bf6b9f
--- /dev/null
+++ b/doc/licenses/retrofit-2.11.0/NOTICE
@@ -0,0 +1,13 @@
+Copyright 2013 Square, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/doc/licenses/retrofit-2.11.0/README b/doc/licenses/retrofit-2.11.0/README
new file mode 100644
index 0000000..f677937
--- /dev/null
+++ b/doc/licenses/retrofit-2.11.0/README
@@ -0,0 +1,8 @@
+Retrofit (https://square.github.io/retrofit/)
+---------------------------------------------
+
+ Version: 2.11.0
+ From: 'Square Inc'
+ License(s):
+ Apache 2.0
+
diff --git a/doc/licenses/retrofit-2.11.0/dep-coordinates.txt b/doc/licenses/retrofit-2.11.0/dep-coordinates.txt
new file mode 100644
index 0000000..b638d74
--- /dev/null
+++ b/doc/licenses/retrofit-2.11.0/dep-coordinates.txt
@@ -0,0 +1,2 @@
+com.squareup.retrofit2:retrofit:jar:2.11.0
+com.squareup.retrofit2:converter-jackson:jar:2.11.0
diff --git a/doc/licenses/safe-buffer-5.1.2/LICENSE b/doc/licenses/safe-buffer-5.1.2/LICENSE
new file mode 100644
index 0000000..0c068ce
--- /dev/null
+++ b/doc/licenses/safe-buffer-5.1.2/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Feross Aboukhadijeh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/doc/licenses/safe-buffer-5.1.2/README b/doc/licenses/safe-buffer-5.1.2/README
new file mode 100644
index 0000000..26cf5dc
--- /dev/null
+++ b/doc/licenses/safe-buffer-5.1.2/README
@@ -0,0 +1,8 @@
+safe-buffer (https://github.com/feross/safe-buffer)
+---------------------------------------------
+
+ Version: 5.1.2
+ From: 'Feross Aboukhadijeh' (https://github.com/feross)
+ License(s):
+ MIT (bundled/safe-buffer-5.1.2/LICENSE)
+
diff --git a/doc/licenses/safe-buffer-5.1.2/dep-coordinates.txt b/doc/licenses/safe-buffer-5.1.2/dep-coordinates.txt
new file mode 100644
index 0000000..594ab08
--- /dev/null
+++ b/doc/licenses/safe-buffer-5.1.2/dep-coordinates.txt
@@ -0,0 +1 @@
+safe-buffer:5.1.2
diff --git a/doc/licenses/setimmediate-1.0.5/LICENSE.txt b/doc/licenses/setimmediate-1.0.5/LICENSE.txt
new file mode 100644
index 0000000..32b20de
--- /dev/null
+++ b/doc/licenses/setimmediate-1.0.5/LICENSE.txt
@@ -0,0 +1,20 @@
+Copyright (c) 2012 Barnesandnoble.com, llc, Donavon West, and Domenic Denicola
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/doc/licenses/setimmediate-1.0.5/README b/doc/licenses/setimmediate-1.0.5/README
new file mode 100644
index 0000000..8bd3389
--- /dev/null
+++ b/doc/licenses/setimmediate-1.0.5/README
@@ -0,0 +1,8 @@
+setImmediate.js (https://github.com/YuzuJS/setImmediate)
+---------------------------------------------
+
+ Version: 1.0.5
+ From: 'Yuzu (by Barnes & Noble Education)' (https://github.com/YuzuJS)
+ License(s):
+ MIT (bundled/setimmediate-1.0.5/LICENSE.txt)
+
diff --git a/doc/licenses/setimmediate-1.0.5/dep-coordinates.txt b/doc/licenses/setimmediate-1.0.5/dep-coordinates.txt
new file mode 100644
index 0000000..d2111b4
--- /dev/null
+++ b/doc/licenses/setimmediate-1.0.5/dep-coordinates.txt
@@ -0,0 +1 @@
+setimmediate:1.0.5
diff --git a/doc/licenses/slf4j-api-2.0.17/LICENSE.txt b/doc/licenses/slf4j-api-2.0.17/LICENSE.txt
new file mode 100644
index 0000000..a4b1bf9
--- /dev/null
+++ b/doc/licenses/slf4j-api-2.0.17/LICENSE.txt
@@ -0,0 +1,21 @@
+Copyright (c) 2004-2024 QOS.ch Sarl (Switzerland)
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/doc/licenses/slf4j-api-2.0.17/README b/doc/licenses/slf4j-api-2.0.17/README
new file mode 100644
index 0000000..db26059
--- /dev/null
+++ b/doc/licenses/slf4j-api-2.0.17/README
@@ -0,0 +1,8 @@
+Simple Logging Facade for Java (http://slf4j.org/)
+--------------------------------------------------
+
+ Version: 2.0.17
+ From: 'QOS.ch Sàrl' (http://qos.ch/)
+ License(s):
+ MIT (bundled/slf4j-api-2.0.17/LICENSE.txt)
+
diff --git a/doc/licenses/slf4j-api-2.0.17/dep-coordinates.txt b/doc/licenses/slf4j-api-2.0.17/dep-coordinates.txt
new file mode 100644
index 0000000..cc3ad97
--- /dev/null
+++ b/doc/licenses/slf4j-api-2.0.17/dep-coordinates.txt
@@ -0,0 +1,2 @@
+org.slf4j:jul-to-slf4j:jar:2.0.17
+org.slf4j:slf4j-api:jar:2.0.17
diff --git a/doc/licenses/snakeyaml-2.3/README b/doc/licenses/snakeyaml-2.3/README
new file mode 100644
index 0000000..9bd4a5c
--- /dev/null
+++ b/doc/licenses/snakeyaml-2.3/README
@@ -0,0 +1,8 @@
+SnakeYAML (https://bitbucket.org/snakeyaml/snakeyaml/
+-----------------------------------------------------
+
+ Version: 2.3
+ From: 'Andrey Somov' (https://bitbucket.org/asomov/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/snakeyaml-2.3/dep-coordinates.txt b/doc/licenses/snakeyaml-2.3/dep-coordinates.txt
new file mode 100644
index 0000000..8377e0b
--- /dev/null
+++ b/doc/licenses/snakeyaml-2.3/dep-coordinates.txt
@@ -0,0 +1 @@
+org.yaml:snakeyaml:jar:2.3
diff --git a/doc/licenses/spring-framework-3.0.5/README b/doc/licenses/spring-framework-3.0.5/README
new file mode 100644
index 0000000..a7c1847
--- /dev/null
+++ b/doc/licenses/spring-framework-3.0.5/README
@@ -0,0 +1,8 @@
+Spring Framework (https://spring.io/projects/spring-framework)
+--------------------------------------------------------------
+
+ Version: 3.0.5
+ From: 'Spring' (https://spring.io/)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/spring-framework-3.0.5/dep-coordinates.txt b/doc/licenses/spring-framework-3.0.5/dep-coordinates.txt
new file mode 100644
index 0000000..51b29f1
--- /dev/null
+++ b/doc/licenses/spring-framework-3.0.5/dep-coordinates.txt
@@ -0,0 +1,6 @@
+org.springframework:spring-aop:jar:3.0.5.RELEASE
+org.springframework:spring-asm:jar:3.0.5.RELEASE
+org.springframework:spring-beans:jar:3.0.5.RELEASE
+org.springframework:spring-context:jar:3.0.5.RELEASE
+org.springframework:spring-core:jar:3.0.5.RELEASE
+org.springframework:spring-expression:jar:3.0.5.RELEASE
diff --git a/doc/licenses/stream-browserify-2.0.2/LICENSE b/doc/licenses/stream-browserify-2.0.2/LICENSE
new file mode 100644
index 0000000..3e7d0c0
--- /dev/null
+++ b/doc/licenses/stream-browserify-2.0.2/LICENSE
@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) James Halliday
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/doc/licenses/stream-browserify-2.0.2/README b/doc/licenses/stream-browserify-2.0.2/README
new file mode 100644
index 0000000..4116876
--- /dev/null
+++ b/doc/licenses/stream-browserify-2.0.2/README
@@ -0,0 +1,8 @@
+stream-browserify (https://github.com/browserify/stream-browserify)
+---------------------------------------------
+
+ Version: 2.0.2
+ From: 'James Halliday'
+ License(s):
+ MIT (bundled/stream-browserify-2.0.2/LICENSE)
+
diff --git a/doc/licenses/stream-browserify-2.0.2/dep-coordinates.txt b/doc/licenses/stream-browserify-2.0.2/dep-coordinates.txt
new file mode 100644
index 0000000..7bc88e9
--- /dev/null
+++ b/doc/licenses/stream-browserify-2.0.2/dep-coordinates.txt
@@ -0,0 +1 @@
+stream-browserify:2.0.2
diff --git a/doc/licenses/string_decoder-1.1.1/LICENSE b/doc/licenses/string_decoder-1.1.1/LICENSE
new file mode 100644
index 0000000..2873b3b
--- /dev/null
+++ b/doc/licenses/string_decoder-1.1.1/LICENSE
@@ -0,0 +1,47 @@
+Node.js is licensed for use as follows:
+
+"""
+Copyright Node.js contributors. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
+"""
+
+This license applies to parts of Node.js originating from the
+https://github.com/joyent/node repository:
+
+"""
+Copyright Joyent, Inc. and other Node contributors. All rights reserved.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
+"""
diff --git a/doc/licenses/string_decoder-1.1.1/README b/doc/licenses/string_decoder-1.1.1/README
new file mode 100644
index 0000000..48ee14c
--- /dev/null
+++ b/doc/licenses/string_decoder-1.1.1/README
@@ -0,0 +1,8 @@
+string_decoder (https://github.com/nodejs/string_decoder)
+---------------------------------------------
+
+ Version: 1.1.1
+ From: 'Node.js contributors, Joyent, Inc., and other Node contributors'
+ License(s):
+ MIT (bundled/string_decoder-1.1.1/LICENSE)
+
diff --git a/doc/licenses/string_decoder-1.1.1/dep-coordinates.txt b/doc/licenses/string_decoder-1.1.1/dep-coordinates.txt
new file mode 100644
index 0000000..bbdc75d
--- /dev/null
+++ b/doc/licenses/string_decoder-1.1.1/dep-coordinates.txt
@@ -0,0 +1 @@
+string_decoder:1.1.1
diff --git a/doc/licenses/timers-browserify-2.0.12/LICENSE.md b/doc/licenses/timers-browserify-2.0.12/LICENSE.md
new file mode 100644
index 0000000..f2bdf52
--- /dev/null
+++ b/doc/licenses/timers-browserify-2.0.12/LICENSE.md
@@ -0,0 +1,23 @@
+# timers-browserify
+
+This project uses the [MIT](http://jryans.mit-license.org/) license:
+
+ Copyright © 2012 J. Ryan Stinnett
+
+ Permission is hereby granted, free of charge, to any person obtaining a
+ copy of this software and associated documentation files (the “Software”),
+ to deal in the Software without restriction, including without limitation
+ the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ and/or sell copies of the Software, and to permit persons to whom the
+ Software is furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ DEALINGS IN THE SOFTWARE.
diff --git a/doc/licenses/timers-browserify-2.0.12/README b/doc/licenses/timers-browserify-2.0.12/README
new file mode 100644
index 0000000..9ed3898
--- /dev/null
+++ b/doc/licenses/timers-browserify-2.0.12/README
@@ -0,0 +1,8 @@
+timers-browserify (https://github.com/browserify/timers-browserify)
+---------------------------------------------
+
+ Version: 2.0.12
+ From: 'J. Ryan Stinnett' (https://github.com/jryans)
+ License(s):
+ MIT (bundled/timers-browserify-2.0.12/LICENSE.md)
+
diff --git a/doc/licenses/timers-browserify-2.0.12/dep-coordinates.txt b/doc/licenses/timers-browserify-2.0.12/dep-coordinates.txt
new file mode 100644
index 0000000..b1dfbee
--- /dev/null
+++ b/doc/licenses/timers-browserify-2.0.12/dep-coordinates.txt
@@ -0,0 +1 @@
+timers-browserify:2.0.12
diff --git a/doc/licenses/util-0.11.1/LICENSE b/doc/licenses/util-0.11.1/LICENSE
new file mode 100644
index 0000000..e3d4e69
--- /dev/null
+++ b/doc/licenses/util-0.11.1/LICENSE
@@ -0,0 +1,18 @@
+Copyright Joyent, Inc. and other Node contributors. All rights reserved.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
diff --git a/doc/licenses/util-0.11.1/README b/doc/licenses/util-0.11.1/README
new file mode 100644
index 0000000..be82159
--- /dev/null
+++ b/doc/licenses/util-0.11.1/README
@@ -0,0 +1,8 @@
+util (https://github.com/browserify/node-util)
+----------------------------------------------
+
+ Version: 0.11.1
+ From: 'Joyent, Inc. and other Node contributors'
+ License(s):
+ MIT (bundled/util-0.11.1/LICENSE)
+
diff --git a/doc/licenses/util-0.11.1/dep-coordinates.txt b/doc/licenses/util-0.11.1/dep-coordinates.txt
new file mode 100644
index 0000000..376908f
--- /dev/null
+++ b/doc/licenses/util-0.11.1/dep-coordinates.txt
@@ -0,0 +1 @@
+util:0.11.1
diff --git a/doc/licenses/util-deprecate-1.0.2/LICENSE b/doc/licenses/util-deprecate-1.0.2/LICENSE
new file mode 100644
index 0000000..6a60e8c
--- /dev/null
+++ b/doc/licenses/util-deprecate-1.0.2/LICENSE
@@ -0,0 +1,24 @@
+(The MIT License)
+
+Copyright (c) 2014 Nathan Rajlich
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
diff --git a/doc/licenses/util-deprecate-1.0.2/README b/doc/licenses/util-deprecate-1.0.2/README
new file mode 100644
index 0000000..9384470
--- /dev/null
+++ b/doc/licenses/util-deprecate-1.0.2/README
@@ -0,0 +1,8 @@
+util-deprecate (https://github.com/TooTallNate/util-deprecate)
+---------------------------------------------
+
+ Version: 1.0.2
+ From: 'Nathan Rajlich' (https://github.com/TooTallNate)
+ License(s):
+ MIT (bundled/util-deprecate-1.0.2/LICENSE)
+
diff --git a/doc/licenses/util-deprecate-1.0.2/dep-coordinates.txt b/doc/licenses/util-deprecate-1.0.2/dep-coordinates.txt
new file mode 100644
index 0000000..f8c3024
--- /dev/null
+++ b/doc/licenses/util-deprecate-1.0.2/dep-coordinates.txt
@@ -0,0 +1 @@
+util-deprecate:1.0.2
diff --git a/doc/licenses/webpack-4.47.0/LICENSE b/doc/licenses/webpack-4.47.0/LICENSE
new file mode 100644
index 0000000..8c11fc7
--- /dev/null
+++ b/doc/licenses/webpack-4.47.0/LICENSE
@@ -0,0 +1,20 @@
+Copyright JS Foundation and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/doc/licenses/webpack-4.47.0/README b/doc/licenses/webpack-4.47.0/README
new file mode 100644
index 0000000..1420e33
--- /dev/null
+++ b/doc/licenses/webpack-4.47.0/README
@@ -0,0 +1,8 @@
+Webpack (https://webpack.js.org/)
+---------------------------------
+
+ Version: 4.47.0
+ From: 'JS Foundation and other contributors'
+ License(s):
+ MIT (bundled/webpack-4.47.0/LICENSE)
+
diff --git a/doc/licenses/webpack-4.47.0/dep-coordinates.txt b/doc/licenses/webpack-4.47.0/dep-coordinates.txt
new file mode 100644
index 0000000..59c0515
--- /dev/null
+++ b/doc/licenses/webpack-4.47.0/dep-coordinates.txt
@@ -0,0 +1 @@
+webpack:4.47.0
diff --git a/doc/licenses/woodstox-core-5.4.0/README b/doc/licenses/woodstox-core-5.4.0/README
new file mode 100644
index 0000000..ad07e98
--- /dev/null
+++ b/doc/licenses/woodstox-core-5.4.0/README
@@ -0,0 +1,7 @@
+Woodstox Core (https://github.com/FasterXML/woodstox)
+------------------------------------------------------
+
+ Version: 5.4.0
+ From: 'FasterXML, LLC' (http://fasterxml.com/)
+ License(s):
+ Apache v2.0
diff --git a/doc/licenses/woodstox-core-5.4.0/dep-coordinates.txt b/doc/licenses/woodstox-core-5.4.0/dep-coordinates.txt
new file mode 100644
index 0000000..e879f95
--- /dev/null
+++ b/doc/licenses/woodstox-core-5.4.0/dep-coordinates.txt
@@ -0,0 +1 @@
+com.fasterxml.woodstox:woodstox-core:jar:5.4.0
diff --git a/doc/licenses/woodstox-stax2-api-4.2/LICENSE b/doc/licenses/woodstox-stax2-api-4.2/LICENSE
new file mode 100644
index 0000000..c7a901a
--- /dev/null
+++ b/doc/licenses/woodstox-stax2-api-4.2/LICENSE
@@ -0,0 +1,22 @@
+Copyright 2010 FasterXML, LLC
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/doc/licenses/woodstox-stax2-api-4.2/README b/doc/licenses/woodstox-stax2-api-4.2/README
new file mode 100644
index 0000000..b2936e3
--- /dev/null
+++ b/doc/licenses/woodstox-stax2-api-4.2/README
@@ -0,0 +1,7 @@
+Woodstox Stax2-API (https://github.com/FasterXML/stax2-api)
+------------------------------------------------------------
+
+ Version: 4.2
+ From: 'FasterXML, LLC' (http://fasterxml.com/)
+ License(s):
+ BSD Simplified (bundled/woodstox-stax2-api-4.2/LICENSE)
diff --git a/doc/licenses/woodstox-stax2-api-4.2/dep-coordinates.txt b/doc/licenses/woodstox-stax2-api-4.2/dep-coordinates.txt
new file mode 100644
index 0000000..c7bbc76
--- /dev/null
+++ b/doc/licenses/woodstox-stax2-api-4.2/dep-coordinates.txt
@@ -0,0 +1 @@
+org.codehaus.woodstox:stax2-api:jar:4.2
diff --git a/doc/licenses/xpp3-1.1.4c/LICENSE.txt b/doc/licenses/xpp3-1.1.4c/LICENSE.txt
new file mode 100644
index 0000000..d84c14b
--- /dev/null
+++ b/doc/licenses/xpp3-1.1.4c/LICENSE.txt
@@ -0,0 +1,46 @@
+Indiana University Extreme! Lab Software License
+
+Version 1.1.1
+
+Copyright (c) 2002 Extreme! Lab, Indiana University. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in
+ the documentation and/or other materials provided with the distribution.
+
+3. The end-user documentation included with the redistribution, if any,
+ must include the following acknowledgment:
+
+ "This product includes software developed by the Indiana University
+ Extreme! Lab (http://www.extreme.indiana.edu/)."
+
+Alternately, this acknowledgment may appear in the software itself,
+if and wherever such third-party acknowledgments normally appear.
+
+4. The names "Indiana Univeristy" and "Indiana Univeristy Extreme! Lab"
+must not be used to endorse or promote products derived from this
+software without prior written permission. For written permission,
+please contact http://www.extreme.indiana.edu/.
+
+5. Products derived from this software may not use "Indiana Univeristy"
+name nor may "Indiana Univeristy" appear in their name, without prior
+written permission of the Indiana University.
+
+THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE AUTHORS, COPYRIGHT HOLDERS OR ITS CONTRIBUTORS
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/doc/licenses/xpp3-1.1.4c/NOTICE b/doc/licenses/xpp3-1.1.4c/NOTICE
new file mode 100644
index 0000000..467f8d9
--- /dev/null
+++ b/doc/licenses/xpp3-1.1.4c/NOTICE
@@ -0,0 +1,2 @@
+This product includes software developed by the Indiana University
+Extreme! Lab (http://www.extreme.indiana.edu/).
diff --git a/doc/licenses/xpp3-1.1.4c/README b/doc/licenses/xpp3-1.1.4c/README
new file mode 100644
index 0000000..96b7725
--- /dev/null
+++ b/doc/licenses/xpp3-1.1.4c/README
@@ -0,0 +1,9 @@
+Xml Pull Parser 3rd Edition
+(http://www.extreme.indiana.edu/xgws/xsoap/xpp/mxp1/index.html)
+---------------------------------------------------------------
+
+ Version: 1.1.4c
+ From: 'Indiana University Extreme! Lab' (http://www.extreme.indiana.edu/)
+ License(s):
+ Indiana University Extreme! Lab License (bundled/xpp3-1.1.4c/LICENSE.txt)
+
diff --git a/doc/licenses/xpp3-1.1.4c/dep-coordinates.txt b/doc/licenses/xpp3-1.1.4c/dep-coordinates.txt
new file mode 100644
index 0000000..8e1237c
--- /dev/null
+++ b/doc/licenses/xpp3-1.1.4c/dep-coordinates.txt
@@ -0,0 +1 @@
+org.apache.servicemix.bundles:org.apache.servicemix.bundles.xpp3:jar:1.1.4c_7
diff --git a/doc/licenses/zxing-3.5.3/AUTHORS b/doc/licenses/zxing-3.5.3/AUTHORS
new file mode 100644
index 0000000..85099eb
--- /dev/null
+++ b/doc/licenses/zxing-3.5.3/AUTHORS
@@ -0,0 +1,135 @@
+This project consists of contributions from several people, recognized here for convenience,
+in alphabetical order.
+
+Agustín Delgado (Servinform S.A.)
+Aitor Almeida (University of Deusto)
+Alasdair Mackintosh (Google)
+Alex Dupre
+Alexander Martin (Haase & Martin GmbH)
+Alexander Schmidt
+Anders Borg
+Andreas Pillath
+Andrew Walbran (Google)
+Andrey Sitnik
+Androida.hu / http://www.androida.hu/
+Antonio Manuel Benjumea (Servinform S.A.)
+Asier Iturralde
+Asmuri Anwar
+atereshchuk
+Betaminos
+Brian Brown (Google)
+Bruce Allen
+Chang Hyun Park
+Christian Brunschen (Google)
+Christoph Schulz (creatale GmbH)
+crowdin.net
+Daisuke Makiuchi
+Daniel Switkin (Google)
+Dave MacLachlan (Google)
+David Phillip Oster (Google)
+David Albert (Bug Labs)
+David Olivier
+David Walker (Google)
+Diego Pierotto
+Dion Hardy
+drejc83
+Eduardo Castillejo (University of Deusto)
+Emanuele Aina
+Eric Kobrin (Velocitude)
+evansepdx
+Erik Barbara
+Facundo Farias
+fakhri626
+fics.danmark
+Francois B. (Google)
+Frank Yellin
+Fred Lin (Anobiit)
+gcstang
+Guenther Grau
+Guillaume Cottenceau
+Guillaume Le Biller
+Hannes Erven
+Hartmut Neubauer (Schweers Informationstechnologie GmbH)
+hosigumayuugi
+hypest (Barcorama project)
+Ian W. Davis
+Isaac Potoczny-Jones
+Ivan Poliakov
+Jacob Haynes (Google)
+Jeff Breidenbach (Google)
+jjYBdx4IL
+Joan Montané (Softcatalà.cat)
+John Connolly (Bug Labs)
+Jonas Petersson (Prisjakt)
+Joseph Wain (Google)
+Juha Kuitunen
+Juho Mikkonen
+Jukka Nurmi
+jwicks
+Kamil Kaczmarczyk
+Kazuki Nishiura
+Kevin O'Sullivan (SITA)
+Kevin Xue (NetDragon Websoft Inc., China)
+Lachezar Dobrev
+Loránt Gerencsér
+Luiz Silva
+Luka Finžgar
+Łukasz Stefaniak
+Malte Starostik
+Manuel Kasten
+Marcelo
+Marcin Górny
+Markus Helm
+Mateusz Jędrasik
+Matthew Schulkind (Google)
+Matt York (LifeMarks)
+MicheleMas
+mike32767
+mikej06 / micjahn
+Mike Kicinski
+Mohamad Fairol
+Morgan Courbet
+Nikolaos Ftylitakis
+Nikolaus Huber
+Olexandr Nesterenko
+Olli
+Pablo Orduña (University of Deusto)
+Paul Hackenberger
+perennialmind
+Radu Silaghi
+Ralf Kistner
+Randy Shen (Acer)
+Rasmus Schrøder Sørensen
+Richard Hřivňák
+Romain Pechayre
+Roman Nurik (Google)
+Rustam Abdullaev
+Ryan Alford
+Sanford Squires
+Satoshi Kametaya
+Shachar Shemesh
+Sean Owen (Google)
+Shiyuan Guo / 郭世元
+ShumovichY
+Simon Flannery (Ericsson)
+slepmog
+Stephen Furlani
+Steven Parkes
+stoty74
+Suraj Supekar
+Sven Klinkhamer
+taku0
+techinstantdx
+tgibson11
+Thanapon Namjittrong
+Thomas Gerbet
+Thomas Weißschuh
+Tim Gernat
+v.anestis
+Vince Francis (LifeMarks)
+Wolfgang Jung
+Yahoe001
+Yakov Okshtein (Google)
+Yao Wei
+Younes CHTIOUI
+Yunhao Tian
diff --git a/doc/licenses/zxing-3.5.3/NOTICE b/doc/licenses/zxing-3.5.3/NOTICE
new file mode 100644
index 0000000..0a372e3
--- /dev/null
+++ b/doc/licenses/zxing-3.5.3/NOTICE
@@ -0,0 +1,7 @@
+Barcode4J
+Copyright 2002-2010 Jeremias Märki
+Copyright 2005-2006 Dietmar Bürkle
+
+Portions of this software were contributed under section 5 of the
+Apache License. Contributors are listed under:
+http://barcode4j.sourceforge.net/contributors.html
diff --git a/doc/licenses/zxing-3.5.3/README b/doc/licenses/zxing-3.5.3/README
new file mode 100644
index 0000000..87a0bbc
--- /dev/null
+++ b/doc/licenses/zxing-3.5.3/README
@@ -0,0 +1,8 @@
+ZXing Barcode Scanning Library (https://github.com/zxing/zxing/)
+----------------------------------------------------------------
+
+ Version: 3.5.3
+ From: 'ZXing authors' (https://github.com/zxing/zxing/blob/zxing-3.5.2/AUTHORS)
+ License(s):
+ Apache v2.0
+
diff --git a/doc/licenses/zxing-3.5.3/dep-coordinates.txt b/doc/licenses/zxing-3.5.3/dep-coordinates.txt
new file mode 100644
index 0000000..48d52b1
--- /dev/null
+++ b/doc/licenses/zxing-3.5.3/dep-coordinates.txt
@@ -0,0 +1,2 @@
+com.google.zxing:core:jar:3.5.3
+com.google.zxing:javase:jar:3.5.3
diff --git a/extensions/.ratignore b/extensions/.ratignore
new file mode 100644
index 0000000..366f628
--- /dev/null
+++ b/extensions/.ratignore
@@ -0,0 +1 @@
+guacamole-auth-radius/**/*
diff --git a/extensions/guacamole-auth-ban/.ratignore b/extensions/guacamole-auth-ban/.ratignore
new file mode 100644
index 0000000..e69de29
diff --git a/extensions/guacamole-auth-ban/pom.xml b/extensions/guacamole-auth-ban/pom.xml
new file mode 100644
index 0000000..a9e8dfe
--- /dev/null
+++ b/extensions/guacamole-auth-ban/pom.xml
@@ -0,0 +1,81 @@
+
+
+
+
+ 4.0.0
+ org.apache.guacamole
+ guacamole-auth-ban
+ jar
+ 1.6.0
+ guacamole-auth-ban
+ http://guacamole.apache.org/
+
+
+ org.apache.guacamole
+ extensions
+ 1.6.0
+ ../
+
+
+
+
+
+
+ javax.servlet
+ servlet-api
+ 2.5
+ provided
+
+
+
+
+ org.apache.guacamole
+ guacamole-ext
+ 1.6.0
+ provided
+
+
+
+
+ org.checkerframework
+ checker-qual
+
+
+ com.google.errorprone
+ error_prone_annotations
+
+
+
+
+
+
+
+ com.github.ben-manes.caffeine
+ caffeine
+ 2.9.3
+
+
+
+
+
diff --git a/extensions/guacamole-auth-ban/src/main/assembly/dist.xml b/extensions/guacamole-auth-ban/src/main/assembly/dist.xml
new file mode 100644
index 0000000..d046ae6
--- /dev/null
+++ b/extensions/guacamole-auth-ban/src/main/assembly/dist.xml
@@ -0,0 +1,54 @@
+
+
+
+
+ dist
+ ${project.artifactId}-${project.version}
+
+
+
+ tar.gz
+
+
+
+
+
+
+
+ target/licenses
+
+
+
+
+ target
+
+ *.jar
+
+
+
+
+
+
diff --git a/extensions/guacamole-auth-ban/src/main/java/org/apache/guacamole/auth/ban/BanningAuthenticationListener.java b/extensions/guacamole-auth-ban/src/main/java/org/apache/guacamole/auth/ban/BanningAuthenticationListener.java
new file mode 100644
index 0000000..c1ba8a5
--- /dev/null
+++ b/extensions/guacamole-auth-ban/src/main/java/org/apache/guacamole/auth/ban/BanningAuthenticationListener.java
@@ -0,0 +1,200 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.ban;
+
+import org.apache.guacamole.auth.ban.status.AuthenticationFailureTracker;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.auth.ban.status.InMemoryAuthenticationFailureTracker;
+import org.apache.guacamole.auth.ban.status.NullAuthenticationFailureTracker;
+import org.apache.guacamole.environment.Environment;
+import org.apache.guacamole.environment.LocalEnvironment;
+import org.apache.guacamole.net.auth.credentials.GuacamoleInsufficientCredentialsException;
+import org.apache.guacamole.net.event.AuthenticationFailureEvent;
+import org.apache.guacamole.net.event.AuthenticationSuccessEvent;
+import org.apache.guacamole.net.event.listener.Listener;
+import org.apache.guacamole.net.event.AuthenticationRequestReceivedEvent;
+import org.apache.guacamole.properties.IntegerGuacamoleProperty;
+import org.apache.guacamole.properties.LongGuacamoleProperty;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Listener implementation which automatically tracks authentication failures
+ * such that further authentication attempts may be automatically blocked if
+ * they match configured criteria.
+ */
+public class BanningAuthenticationListener implements Listener {
+
+ /**
+ * Logger for this class.
+ */
+ private static final Logger logger = LoggerFactory.getLogger(BanningAuthenticationListener.class);
+
+ /**
+ * The maximum number of failed authentication attempts allowed before an
+ * address is temporarily banned.
+ */
+ private static final IntegerGuacamoleProperty MAX_ATTEMPTS = new IntegerGuacamoleProperty() {
+
+ @Override
+ public String getName() {
+ return "ban-max-invalid-attempts";
+ }
+
+ };
+
+ /**
+ * The length of time that each address should be banned after reaching the
+ * maximum number of failed authentication attempts, in seconds.
+ */
+ private static final IntegerGuacamoleProperty IP_BAN_DURATION = new IntegerGuacamoleProperty() {
+
+ @Override
+ public String getName() {
+ return "ban-address-duration";
+ }
+
+ };
+
+ /**
+ * The maximum number of failed authentication attempts tracked at any
+ * given time. Once this number of addresses is exceeded, the oldest
+ * authentication attempts are rotated off on an LRU basis.
+ */
+ private static final LongGuacamoleProperty MAX_ADDRESSES = new LongGuacamoleProperty() {
+
+ @Override
+ public String getName() {
+ return "ban-max-addresses";
+ }
+
+ };
+
+ /**
+ * The default maximum number of failed authentication attempts allowed
+ * before an address is temporarily banned.
+ */
+ private static final int DEFAULT_MAX_ATTEMPTS = 5;
+
+ /**
+ * The default length of time that each address should be banned after
+ * reaching the maximum number of failed authentication attempts, in
+ * seconds.
+ */
+ private static final int DEFAULT_IP_BAN_DURATION = 300;
+
+ /**
+ * The maximum number of failed authentication attempts tracked at any
+ * given time. Once this number of addresses is exceeded, the oldest
+ * authentication attempts are rotated off on an LRU basis.
+ */
+ private static final long DEFAULT_MAX_ADDRESSES = 10485760;
+
+ /**
+ * Tracker of addresses that have repeatedly failed authentication.
+ */
+ private final AuthenticationFailureTracker tracker;
+
+ /**
+ * Creates a new BanningAuthenticationListener which automatically bans
+ * further authentication attempts from addresses that have repeatedly
+ * failed to authenticate. The ban duration and maximum number of failed
+ * attempts allowed before banning are configured within
+ * guacamole.properties.
+ *
+ * @throws GuacamoleException
+ * If an error occurs parsing the configuration properties used by this
+ * extension.
+ */
+ public BanningAuthenticationListener() throws GuacamoleException {
+
+ Environment environment = LocalEnvironment.getInstance();
+ int maxAttempts = environment.getProperty(MAX_ATTEMPTS, DEFAULT_MAX_ATTEMPTS);
+ int banDuration = environment.getProperty(IP_BAN_DURATION, DEFAULT_IP_BAN_DURATION);
+ long maxAddresses = environment.getProperty(MAX_ADDRESSES, DEFAULT_MAX_ADDRESSES);
+
+ // Configure auth failure tracking behavior and inform administrator of
+ // ultimate result
+ if (maxAttempts <= 0) {
+ this.tracker = new NullAuthenticationFailureTracker();
+ logger.info("Maximum failed authentication attempts has been set "
+ + "to {}. Automatic banning of brute-force authentication "
+ + "attempts will be disabled.", maxAttempts);
+ }
+ else if (banDuration <= 0) {
+ this.tracker = new NullAuthenticationFailureTracker();
+ logger.info("Ban duration for addresses that repeatedly fail "
+ + "authentication has been set to {}. Automatic banning "
+ + "of brute-force authentication attempts will be "
+ + "disabled.", banDuration);
+ }
+ else if (maxAddresses <= 0) {
+ this.tracker = new NullAuthenticationFailureTracker();
+ logger.info("Maximum number of tracked addresses has been set to "
+ + "{}. Automatic banning of brute-force authentication "
+ + "attempts will be disabled.", maxAddresses);
+ }
+ else {
+ this.tracker = new InMemoryAuthenticationFailureTracker(maxAttempts, banDuration, maxAddresses);
+ logger.info("Addresses will be automatically banned for {} "
+ + "seconds after {} failed authentication attempts. Up "
+ + "to {} unique addresses will be tracked/banned at any "
+ + "given time.", banDuration, maxAttempts, maxAddresses);
+ }
+
+ }
+
+ @Override
+ public void handleEvent(Object event) throws GuacamoleException {
+
+ // Notify auth tracker of each request received BEFORE the request is
+ // processed ...
+ if (event instanceof AuthenticationRequestReceivedEvent) {
+ AuthenticationRequestReceivedEvent request = (AuthenticationRequestReceivedEvent) event;
+ tracker.notifyAuthenticationRequestReceived(request.getCredentials());
+ }
+
+ // ... as well as every explicit failure ...
+ else if (event instanceof AuthenticationFailureEvent) {
+
+ AuthenticationFailureEvent failure = (AuthenticationFailureEvent) event;
+
+ // Requests for additional credentials are not failures per se,
+ // but continuations of a multi-request authentication attempt that
+ // has not yet succeeded OR failed
+ if (failure.getFailure() instanceof GuacamoleInsufficientCredentialsException) {
+ tracker.notifyAuthenticationRequestReceived(failure.getCredentials());
+ return;
+ }
+
+ // Consider all other errors to be failed auth attempts
+ tracker.notifyAuthenticationFailed(failure.getCredentials());
+
+ }
+
+ // ... and explicit success.
+ else if (event instanceof AuthenticationSuccessEvent) {
+ AuthenticationSuccessEvent success = (AuthenticationSuccessEvent) event;
+ tracker.notifyAuthenticationSuccess(success.getCredentials());
+ }
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-ban/src/main/java/org/apache/guacamole/auth/ban/status/AuthenticationFailureStatus.java b/extensions/guacamole-auth-ban/src/main/java/org/apache/guacamole/auth/ban/status/AuthenticationFailureStatus.java
new file mode 100644
index 0000000..3292d11
--- /dev/null
+++ b/extensions/guacamole-auth-ban/src/main/java/org/apache/guacamole/auth/ban/status/AuthenticationFailureStatus.java
@@ -0,0 +1,123 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.ban.status;
+
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicInteger;
+
+/**
+ * The current status of an authentication failure, including the number of
+ * times the failure has occurred.
+ */
+public class AuthenticationFailureStatus {
+
+ /**
+ * The timestamp of the last authentication failure, as returned by
+ * System.nanoTime().
+ */
+ private long lastFailure;
+
+ /**
+ * The number of failures that have occurred.
+ */
+ private final AtomicInteger failureCount;
+
+ /**
+ * The maximum number of failures that may occur before the user/address
+ * causing the failures is blocked.
+ */
+ private final int maxAttempts;
+
+ /**
+ * The amount of time that a user/address must remain blocked after they
+ * have reached the maximum number of failures. Unlike the value provided
+ * at construction time, this value is maintained in nanoseconds.
+ */
+ private final long duration;
+
+ /**
+ * Creates an AuthenticationFailureStatus that is initialized to zero
+ * failures and is subject to the given restrictions. Additional failures
+ * may be flagged after creation with {@link #notifyFailed()}.
+ *
+ * @param maxAttempts
+ * The maximum number of failures that may occur before the
+ * user/address causing the failures is blocked.
+ *
+ * @param duration
+ * The amount of time, in seconds, that a user/address must remain
+ * blocked after they have reached the maximum number of failures.
+ */
+ public AuthenticationFailureStatus(int maxAttempts, int duration) {
+ this.lastFailure = System.nanoTime();
+ this.failureCount = new AtomicInteger(0);
+ this.maxAttempts = maxAttempts;
+ this.duration = TimeUnit.SECONDS.toNanos(duration);
+ }
+
+ /**
+ * Updates this authentication failure, noting that the failure it
+ * represents has recurred.
+ */
+ public void notifyFailed() {
+ lastFailure = System.nanoTime();
+ failureCount.incrementAndGet();
+ }
+
+ /**
+ * Returns whether this authentication failure is recent enough that it
+ * should still be tracked. This function will return false for
+ * authentication failures that have not recurred for at least the duration
+ * provided at construction time.
+ *
+ * @return
+ * true if this authentication failure is recent enough that it should
+ * still be tracked, false otherwise.
+ */
+ public boolean isValid() {
+ return System.nanoTime() - lastFailure <= duration;
+ }
+
+ /**
+ * Returns whether the user/address causing this authentication failure
+ * should be blocked based on the restrictions provided at construction
+ * time.
+ *
+ * @return
+ * true if the user/address causing this failure should be blocked,
+ * false otherwise.
+ */
+ public boolean isBlocked() {
+ return isValid() && failureCount.get() >= maxAttempts;
+ }
+
+ /**
+ * Returns the total number of authentication failures that have been
+ * recorded through creating this object and invoking
+ * {@link #notifyFailed()}.
+ *
+ * @return
+ * The total number of failures that have occurred.
+ */
+ public int getFailures() {
+ return failureCount.get();
+ }
+
+}
diff --git a/extensions/guacamole-auth-ban/src/main/java/org/apache/guacamole/auth/ban/status/AuthenticationFailureTracker.java b/extensions/guacamole-auth-ban/src/main/java/org/apache/guacamole/auth/ban/status/AuthenticationFailureTracker.java
new file mode 100644
index 0000000..9ea7f2c
--- /dev/null
+++ b/extensions/guacamole-auth-ban/src/main/java/org/apache/guacamole/auth/ban/status/AuthenticationFailureTracker.java
@@ -0,0 +1,78 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.ban.status;
+
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.net.auth.Credentials;
+
+/**
+ * Tracks past authentication results, automatically blocking the IP addresses
+ * of machines that repeatedly fail to authenticate.
+ */
+public interface AuthenticationFailureTracker {
+
+ /**
+ * Reports that an authentication request has been received, but it is
+ * either not yet known whether the request has succeeded or failed. If the
+ * associated address is currently being blocked, an exception will be
+ * thrown.
+ *
+ * @param credentials
+ * The credentials associated with the authentication request.
+ *
+ * @throws GuacamoleException
+ * If the authentication request is being blocked due to brute force
+ * prevention rules.
+ */
+ void notifyAuthenticationRequestReceived(Credentials credentials)
+ throws GuacamoleException;
+
+ /**
+ * Reports that an authentication request has been received and has
+ * succeeded. If the associated address is currently being blocked, an
+ * exception will be thrown.
+ *
+ * @param credentials
+ * The credentials associated with the successful authentication
+ * request.
+ *
+ * @throws GuacamoleException
+ * If the authentication request is being blocked due to brute force
+ * prevention rules.
+ */
+ void notifyAuthenticationSuccess(Credentials credentials)
+ throws GuacamoleException;
+
+ /**
+ * Reports that an authentication request has been received and has
+ * failed. If the associated address is currently being blocked, an
+ * exception will be thrown.
+ *
+ * @param credentials
+ * The credentials associated with the failed authentication request.
+ *
+ * @throws GuacamoleException
+ * If the authentication request is being blocked due to brute force
+ * prevention rules.
+ */
+ void notifyAuthenticationFailed(Credentials credentials)
+ throws GuacamoleException;
+
+}
diff --git a/extensions/guacamole-auth-ban/src/main/java/org/apache/guacamole/auth/ban/status/InMemoryAuthenticationFailureTracker.java b/extensions/guacamole-auth-ban/src/main/java/org/apache/guacamole/auth/ban/status/InMemoryAuthenticationFailureTracker.java
new file mode 100644
index 0000000..58ed4e0
--- /dev/null
+++ b/extensions/guacamole-auth-ban/src/main/java/org/apache/guacamole/auth/ban/status/InMemoryAuthenticationFailureTracker.java
@@ -0,0 +1,196 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.ban.status;
+
+import com.github.benmanes.caffeine.cache.Cache;
+import com.github.benmanes.caffeine.cache.Caffeine;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.GuacamoleServerException;
+import org.apache.guacamole.language.TranslatableGuacamoleClientTooManyException;
+import org.apache.guacamole.net.auth.Credentials;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * AuthenticationFailureTracker implementation that tracks the failure status
+ * of each IP address in memory. The maximum amount of memory consumed is
+ * bounded by the configured maximum number of addresses tracked.
+ */
+public class InMemoryAuthenticationFailureTracker implements AuthenticationFailureTracker {
+
+ /**
+ * Logger for this class.
+ */
+ private static final Logger logger = LoggerFactory.getLogger(InMemoryAuthenticationFailureTracker.class);
+
+ /**
+ * All authentication failures currently being tracked, stored by the
+ * associated IP address.
+ */
+ private final Cache failures;
+
+ /**
+ * The maximum number of failed authentication attempts allowed before an
+ * address is temporarily banned.
+ */
+ private final int maxAttempts;
+
+ /**
+ * The length of time that each address should be banned after reaching the
+ * maximum number of failed authentication attempts, in seconds.
+ */
+ private final int banDuration;
+
+ /**
+ * Creates a new AuthenticationFailureTracker that automatically blocks
+ * authentication attempts based on the provided blocking criteria.
+ *
+ * @param maxAttempts
+ * The maximum number of failed authentication attempts allowed before
+ * an address is temporarily banned.
+ *
+ * @param banDuration
+ * The length of time that each address should be banned after reaching
+ * the maximum number of failed authentication attempts, in seconds.
+ *
+ * @param maxAddresses
+ * The maximum number of unique IP addresses that should be tracked
+ * before discarding older tracked failures.
+ */
+ public InMemoryAuthenticationFailureTracker(int maxAttempts, int banDuration,
+ long maxAddresses) {
+
+ this.maxAttempts = maxAttempts;
+ this.banDuration = banDuration;
+
+ // Limit maximum number of tracked addresses to configured upper bound
+ this.failures = Caffeine.newBuilder()
+ .maximumSize(maxAddresses)
+ .build();
+
+ }
+
+ /**
+ * Reports that the given address has just failed to authenticate and
+ * returns the AuthenticationFailureStatus that represents that failure. If
+ * the address isn't already being tracked, it will begin being tracked as
+ * of this call. If the address is already tracked, the returned
+ * AuthenticationFailureStatus will represent past authentication failures,
+ * as well.
+ *
+ * @param address
+ * The address that has failed to authenticate.
+ *
+ * @return
+ * An AuthenticationFailureStatus that represents this latest
+ * authentication failure for the given address, as well as any past
+ * failures.
+ */
+ private AuthenticationFailureStatus getAuthenticationFailure(String address) {
+
+ AuthenticationFailureStatus status = failures.get(address,
+ (addr) -> new AuthenticationFailureStatus(maxAttempts, banDuration));
+
+ status.notifyFailed();
+ return status;
+
+ }
+
+ /**
+ * Reports that an authentication request has been received, as well as
+ * whether that request is known to have failed. If the associated address
+ * is currently being blocked, an exception will be thrown.
+ *
+ * @param credentials
+ * The credentials associated with the authentication request.
+ *
+ * @param failed
+ * Whether the request is known to have failed. If the status of the
+ * request is not yet known, this should be false.
+ *
+ * @throws GuacamoleException
+ * If the authentication request is being blocked due to brute force
+ * prevention rules.
+ */
+ private void notifyAuthenticationStatus(Credentials credentials,
+ boolean failed) throws GuacamoleException {
+
+ // Ignore requests that do not contain explicit parameters of any kind
+ if (credentials.isEmpty())
+ return;
+
+ // Determine originating address of the authentication request
+ String address = credentials.getRemoteAddress();
+ if (address == null)
+ throw new GuacamoleServerException("Source address cannot be determined.");
+
+ // Get current failure status for the address associated with the
+ // authentication request, adding/updating that status if the request
+ // was itself a failure
+ AuthenticationFailureStatus status;
+ if (failed) {
+ status = getAuthenticationFailure(address);
+ logger.info("Authentication has failed for address \"{}\" (current total failures: {}/{}).",
+ address, status.getFailures(), maxAttempts);
+ }
+ else
+ status = failures.getIfPresent(address);
+
+ if (status != null) {
+
+ // Explicitly block further processing of authentication/authorization
+ // if too many failures have occurred
+ if (status.isBlocked()) {
+ logger.warn("Blocking authentication attempt from address \"{}\" due to number of authentication failures.", address);
+ throw new TranslatableGuacamoleClientTooManyException("Too "
+ + "many failed authentication attempts.",
+ "LOGIN.ERROR_TOO_MANY_ATTEMPTS");
+ }
+
+ // Clean up tracking of failures if the address is no longer
+ // relevant (all failures are sufficiently old)
+ else if (!status.isValid()) {
+ logger.debug("Removing address \"{}\" from tracking as there are no recent authentication failures.", address);
+ failures.invalidate(address);
+ }
+
+ }
+
+ }
+
+ @Override
+ public void notifyAuthenticationRequestReceived(Credentials credentials)
+ throws GuacamoleException {
+ notifyAuthenticationStatus(credentials, false);
+ }
+
+ @Override
+ public void notifyAuthenticationSuccess(Credentials credentials)
+ throws GuacamoleException {
+ notifyAuthenticationStatus(credentials, false);
+ }
+
+ @Override
+ public void notifyAuthenticationFailed(Credentials credentials)
+ throws GuacamoleException {
+ notifyAuthenticationStatus(credentials, true);
+ }
+
+}
diff --git a/extensions/guacamole-auth-ban/src/main/java/org/apache/guacamole/auth/ban/status/NullAuthenticationFailureTracker.java b/extensions/guacamole-auth-ban/src/main/java/org/apache/guacamole/auth/ban/status/NullAuthenticationFailureTracker.java
new file mode 100644
index 0000000..9b50a30
--- /dev/null
+++ b/extensions/guacamole-auth-ban/src/main/java/org/apache/guacamole/auth/ban/status/NullAuthenticationFailureTracker.java
@@ -0,0 +1,49 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.ban.status;
+
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.net.auth.Credentials;
+
+/**
+ * AuthenticationFailureTracker implementation that does nothing. All requests
+ * are ignored, regardless of status, and no tracking is performed.
+ */
+public class NullAuthenticationFailureTracker implements AuthenticationFailureTracker {
+
+ @Override
+ public void notifyAuthenticationRequestReceived(Credentials credentials)
+ throws GuacamoleException {
+ // Do nothing
+ }
+
+ @Override
+ public void notifyAuthenticationSuccess(Credentials credentials)
+ throws GuacamoleException {
+ // Do nothing
+ }
+
+ @Override
+ public void notifyAuthenticationFailed(Credentials credentials)
+ throws GuacamoleException {
+ // Do nothing
+ }
+
+}
diff --git a/extensions/guacamole-auth-ban/src/main/resources/guac-manifest.json b/extensions/guacamole-auth-ban/src/main/resources/guac-manifest.json
new file mode 100644
index 0000000..46a54ba
--- /dev/null
+++ b/extensions/guacamole-auth-ban/src/main/resources/guac-manifest.json
@@ -0,0 +1,17 @@
+{
+
+ "guacamoleVersion" : "1.6.0",
+
+ "name" : "Brute-force Authentication Detection/Prevention",
+ "namespace" : "ban",
+
+ "listeners" : [
+ "org.apache.guacamole.auth.ban.BanningAuthenticationListener"
+ ],
+
+ "translations" : [
+ "translations/en.json",
+ "translations/pl.json"
+ ]
+
+}
diff --git a/extensions/guacamole-auth-ban/src/main/resources/translations/en.json b/extensions/guacamole-auth-ban/src/main/resources/translations/en.json
new file mode 100644
index 0000000..2ef8a37
--- /dev/null
+++ b/extensions/guacamole-auth-ban/src/main/resources/translations/en.json
@@ -0,0 +1,5 @@
+{
+ "LOGIN": {
+ "ERROR_TOO_MANY_ATTEMPTS" : "Too many failed authentication attempts. Please try again later."
+ }
+}
diff --git a/extensions/guacamole-auth-ban/src/main/resources/translations/pl.json b/extensions/guacamole-auth-ban/src/main/resources/translations/pl.json
new file mode 100644
index 0000000..0ba1f80
--- /dev/null
+++ b/extensions/guacamole-auth-ban/src/main/resources/translations/pl.json
@@ -0,0 +1,5 @@
+{
+ "LOGIN": {
+ "ERROR_TOO_MANY_ATTEMPTS" : "Zbyt wiele nieudanych prób logowania. Spróbuj ponownie później."
+ }
+}
diff --git a/extensions/guacamole-auth-duo/.gitignore b/extensions/guacamole-auth-duo/.gitignore
new file mode 100644
index 0000000..1de9633
--- /dev/null
+++ b/extensions/guacamole-auth-duo/.gitignore
@@ -0,0 +1,3 @@
+src/main/resources/generated/
+target/
+*~
diff --git a/extensions/guacamole-auth-duo/.ratignore b/extensions/guacamole-auth-duo/.ratignore
new file mode 100644
index 0000000..4cbee99
--- /dev/null
+++ b/extensions/guacamole-auth-duo/.ratignore
@@ -0,0 +1,2 @@
+src/main/resources/lib/DuoWeb/**/*
+src/main/java/com/duosecurity/duoweb/**/*
diff --git a/extensions/guacamole-auth-duo/pom.xml b/extensions/guacamole-auth-duo/pom.xml
new file mode 100644
index 0000000..afbb564
--- /dev/null
+++ b/extensions/guacamole-auth-duo/pom.xml
@@ -0,0 +1,142 @@
+
+
+
+
+ 4.0.0
+ org.apache.guacamole
+ guacamole-auth-duo
+ jar
+ 1.6.0
+ guacamole-auth-duo
+ http://guacamole.apache.org/
+
+
+ org.apache.guacamole
+ extensions
+ 1.6.0
+ ../
+
+
+
+ UTF-8
+ 4.12.0
+ 1.9.25
+
+
+
+
+
+
+ org.apache.guacamole
+ guacamole-ext
+ 1.6.0
+ provided
+
+
+
+
+ com.google.guava
+ guava
+
+
+
+
+ com.google.inject
+ guice
+
+
+
+
+ javax.servlet
+ servlet-api
+ 2.5
+ provided
+
+
+
+
+ com.duosecurity
+ duo-universal-sdk
+ 1.2.0
+
+
+ com.squareup.okhttp3
+ okhttp
+
+
+ com.squareup.okhttp3
+ logging-interceptor
+
+
+
+
+
+
+ com.squareup.okhttp3
+ okhttp
+ ${okhttp.version}
+
+
+ org.jetbrains.kotlin
+ kotlin-stdlib-common
+
+
+ org.jetbrains.kotlin
+ kotlin-stdlib-jdk8
+
+
+
+
+ com.squareup.okhttp3
+ logging-interceptor
+ ${okhttp.version}
+
+
+ org.jetbrains.kotlin
+ kotlin-stdlib-jdk8
+
+
+
+
+
+
+ org.jetbrains.kotlin
+ kotlin-stdlib-common
+ ${kotlin.version}
+
+
+ org.jetbrains.kotlin
+ kotlin-stdlib-jdk8
+ ${kotlin.version}
+
+
+
+
+ com.github.seancfoley
+ ipaddress
+ provided
+
+
+
+
+
diff --git a/extensions/guacamole-auth-duo/src/main/assembly/dist.xml b/extensions/guacamole-auth-duo/src/main/assembly/dist.xml
new file mode 100644
index 0000000..0b16a71
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/assembly/dist.xml
@@ -0,0 +1,53 @@
+
+
+
+
+ dist
+ ${project.artifactId}-${project.version}
+
+
+
+ tar.gz
+
+
+
+
+
+
+
+ target/licenses
+
+
+
+
+ target
+
+ *.jar
+
+
+
+
+
+
diff --git a/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationProvider.java b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationProvider.java
new file mode 100644
index 0000000..580dbf9
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationProvider.java
@@ -0,0 +1,123 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.duo;
+
+import com.google.inject.Guice;
+import com.google.inject.Injector;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.net.auth.AbstractAuthenticationProvider;
+import org.apache.guacamole.net.auth.AuthenticatedUser;
+import org.apache.guacamole.net.auth.Credentials;
+import org.apache.guacamole.net.auth.UserContext;
+
+/**
+ * AuthenticationProvider implementation which uses Duo as an additional
+ * authentication factor for users which have already been authenticated by
+ * some other AuthenticationProvider.
+ */
+public class DuoAuthenticationProvider extends AbstractAuthenticationProvider {
+
+ /**
+ * The unique identifier for this authentication provider. This is used in
+ * various parts of the Guacamole client to distinguish this provider from
+ * others, particularly when multiple authentication providers are used.
+ */
+ public static String PROVIDER_IDENTIFER = "duo";
+
+ /**
+ * Service for verifying the identity of users that Guacamole has otherwise
+ * already authenticated.
+ */
+ private final UserVerificationService verificationService;
+
+ /**
+ * Session manager for storing/retrieving the state of a user's
+ * authentication attempt while they are redirected to the Duo service.
+ */
+ private final DuoAuthenticationSessionManager sessionManager;
+
+ /**
+ * Creates a new DuoAuthenticationProvider that verifies users
+ * using the Duo authentication service
+ *
+ * @throws GuacamoleException
+ * If a required property is missing, or an error occurs while parsing
+ * a property.
+ */
+ public DuoAuthenticationProvider() throws GuacamoleException {
+
+ // Set up Guice injector.
+ Injector injector = Guice.createInjector(
+ new DuoAuthenticationProviderModule(this)
+ );
+
+ sessionManager = injector.getInstance(DuoAuthenticationSessionManager.class);
+ verificationService = injector.getInstance(UserVerificationService.class);
+
+ }
+
+ @Override
+ public String getIdentifier() {
+ return PROVIDER_IDENTIFER;
+ }
+
+ @Override
+ public Credentials updateCredentials(Credentials credentials)
+ throws GuacamoleException {
+
+ // Ignore requests with no corresponding authentication session ID, as
+ // there are no credentials to reconstitute if the user has not yet
+ // attempted to authenticate
+ String duoState = credentials.getParameter(UserVerificationService.DUO_STATE_PARAMETER_NAME);
+ if (duoState == null)
+ return credentials;
+
+ // Ignore requests with invalid/expired authentication session IDs
+ DuoAuthenticationSession session = sessionManager.resume(duoState);
+ if (session == null)
+ return credentials;
+
+ // Reconstitute the originally-provided credentials from the users
+ // authentication attempt prior to being redirected to Duo
+ Credentials previousCredentials = session.getCredentials();
+ previousCredentials.setRequestDetails(credentials.getRequestDetails());
+ return previousCredentials;
+
+ }
+
+ @Override
+ public UserContext getUserContext(AuthenticatedUser authenticatedUser)
+ throws GuacamoleException {
+
+ // Verify user against Duo service
+ verificationService.verifyAuthenticatedUser(authenticatedUser);
+
+ // User has been verified, and authentication should be allowed to
+ // continue
+ return null;
+
+ }
+
+ @Override
+ public void shutdown() {
+ sessionManager.shutdown();
+ }
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationProviderModule.java b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationProviderModule.java
new file mode 100644
index 0000000..372bbcc
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationProviderModule.java
@@ -0,0 +1,78 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.duo;
+
+import com.google.inject.AbstractModule;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.auth.duo.conf.ConfigurationService;
+import org.apache.guacamole.environment.Environment;
+import org.apache.guacamole.environment.LocalEnvironment;
+import org.apache.guacamole.net.auth.AuthenticationProvider;
+
+/**
+ * Guice module which configures Duo-specific injections.
+ */
+public class DuoAuthenticationProviderModule extends AbstractModule {
+
+ /**
+ * Guacamole server environment.
+ */
+ private final Environment environment;
+
+ /**
+ * A reference to the DuoAuthenticationProvider on behalf of which this
+ * module has configured injection.
+ */
+ private final AuthenticationProvider authProvider;
+
+ /**
+ * Creates a new Duo authentication provider module which configures
+ * injection for the DuoAuthenticationProvider.
+ *
+ * @param authProvider
+ * The AuthenticationProvider for which injection is being configured.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while retrieving the Guacamole server
+ * environment.
+ */
+ public DuoAuthenticationProviderModule(AuthenticationProvider authProvider)
+ throws GuacamoleException {
+
+ // Get local environment
+ this.environment = LocalEnvironment.getInstance();
+
+ // Store associated auth provider
+ this.authProvider = authProvider;
+ }
+
+ @Override
+ protected void configure() {
+
+ // Bind core implementations of guacamole-ext classes
+ bind(AuthenticationProvider.class).toInstance(authProvider);
+ bind(Environment.class).toInstance(environment);
+
+ // Bind Duo-specific services
+ bind(ConfigurationService.class);
+ bind(UserVerificationService.class);
+ }
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationSession.java b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationSession.java
new file mode 100644
index 0000000..6876cad
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationSession.java
@@ -0,0 +1,65 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.duo;
+
+import org.apache.guacamole.net.auth.AuthenticationSession;
+import org.apache.guacamole.net.auth.Credentials;
+
+/**
+ * Representation of an in-progress Duo authentication attempt.
+ */
+public class DuoAuthenticationSession extends AuthenticationSession {
+
+ /**
+ * The credentials that the user originally provided to Guacamole prior to
+ * being redirected to the Duo service.
+ */
+ private final Credentials credentials;
+
+ /**
+ * Creates a new AuthenticationSession representing an in-progress Duo
+ * authentication attempt.
+ *
+ * @param credentials
+ * The credentials that the user originally provided to Guacamole prior
+ * to being redirected to the Duo service.
+ *
+ * @param expires
+ * The number of milliseconds that may elapse before this session must
+ * be considered invalid.
+ */
+ public DuoAuthenticationSession(Credentials credentials, long expires) {
+ super(expires);
+ this.credentials = credentials;
+ }
+
+ /**
+ * Returns the credentials that the user originally provided to Guacamole
+ * prior to being redirected to the Duo service.
+ *
+ * @return
+ * The credentials that the user originally provided to Guacamole prior
+ * to being redirected to the Duo service.
+ */
+ public Credentials getCredentials() {
+ return credentials;
+ }
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationSessionManager.java b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationSessionManager.java
new file mode 100644
index 0000000..f2f39da
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationSessionManager.java
@@ -0,0 +1,36 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.duo;
+
+import com.google.inject.Singleton;
+import org.apache.guacamole.net.auth.AuthenticationSessionManager;
+
+/**
+ * Manager service that temporarily stores authentication attempts while
+ * the Duo authentication flow is underway.
+ */
+@Singleton
+public class DuoAuthenticationSessionManager
+ extends AuthenticationSessionManager {
+
+ // Intentionally empty (the default functions inherited from the
+ // AuthenticationSessionManager base class are sufficient for our needs)
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/UserVerificationService.java b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/UserVerificationService.java
new file mode 100644
index 0000000..557427d
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/UserVerificationService.java
@@ -0,0 +1,276 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.duo;
+
+import com.duosecurity.Client;
+import com.duosecurity.exception.DuoException;
+import com.duosecurity.model.Token;
+import com.google.inject.Inject;
+import inet.ipaddr.IPAddress;
+import inet.ipaddr.IPAddressString;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.Collections;
+import java.util.concurrent.TimeUnit;
+import java.util.List;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.GuacamoleServerException;
+import org.apache.guacamole.auth.duo.conf.ConfigurationService;
+import org.apache.guacamole.form.RedirectField;
+import org.apache.guacamole.language.TranslatableGuacamoleInsufficientCredentialsException;
+import org.apache.guacamole.language.TranslatableMessage;
+import org.apache.guacamole.net.auth.AuthenticatedUser;
+import org.apache.guacamole.net.auth.Credentials;
+import org.apache.guacamole.net.auth.credentials.CredentialsInfo;
+import org.apache.guacamole.properties.IPAddressListProperty;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Service for verifying the identity of a user against Duo.
+ */
+public class UserVerificationService {
+
+ /**
+ * Logger for this class.
+ */
+ private static final Logger logger = LoggerFactory.getLogger(UserVerificationService.class);
+
+ /**
+ * The name of the HTTP parameter that Duo will use to communicate the
+ * result of the user's attempt to authenticate with their service. This
+ * parameter is provided in the GET request received when Duo redirects the
+ * user back to Guacamole.
+ */
+ public static final String DUO_CODE_PARAMETER_NAME = "duo_code";
+
+ /**
+ * The name of the HTTP parameter that we will be using to hold the opaque
+ * authentication session ID. This session ID is transmitted to Duo during
+ * the initial redirect and received back from Duo via this parameter in
+ * the GET request received when Duo redirects the user back to Guacamole.
+ * The session ID is ultimately used to reconstitute the original
+ * credentials received from the user by Guacamole such that parameter
+ * tokens like GUAC_USERNAME and GUAC_PASSWORD can continue to work as
+ * expected.
+ */
+ public static final String DUO_STATE_PARAMETER_NAME = "state";
+
+ /**
+ * The value that will be returned in the token if Duo authentication
+ * was successful.
+ */
+ private static final String DUO_TOKEN_SUCCESS_VALUE = "allow";
+
+ /**
+ * Session manager for storing/retrieving the state of a user's
+ * authentication attempt while they are redirected to the Duo service.
+ */
+ @Inject
+ private DuoAuthenticationSessionManager sessionManager;
+
+ /**
+ * Service for retrieving Duo configuration information.
+ */
+ @Inject
+ private ConfigurationService confService;
+
+ /**
+ * Verifies the identity of the given user via the Duo multi-factor
+ * authentication service. If a signed response from Duo has not already
+ * been provided, a signed response from Duo is requested in the
+ * form of additional expected credentials. Any provided signed response
+ * is cryptographically verified. If no signed response is present, or the
+ * signed response is invalid, an exception is thrown.
+ *
+ * @param authenticatedUser
+ * The user whose identity should be verified against Duo.
+ *
+ * @throws GuacamoleException
+ * If required Duo-specific configuration options are missing or
+ * malformed, or if the user's identity cannot be verified.
+ */
+ public void verifyAuthenticatedUser(AuthenticatedUser authenticatedUser)
+ throws GuacamoleException {
+
+ // Pull the original HTTP request used to authenticate
+ Credentials credentials = authenticatedUser.getCredentials();
+ IPAddress clientAddr = new IPAddressString(credentials.getRemoteAddress()).getAddress();
+
+ // Ignore anonymous users
+ String username = authenticatedUser.getIdentifier();
+ if (username == null || username.equals(AuthenticatedUser.ANONYMOUS_IDENTIFIER))
+ return;
+
+ // Pull address lists to check from configuration. Note that the enforce
+ // list will override the bypass list, which means that, if the client
+ // address happens to be in both lists, Duo MFA will be enforced.
+ List bypassAddresses = confService.getBypassHosts();
+ List enforceAddresses = confService.getEnforceHosts();
+
+ // Check if the bypass list contains the client address, and set the
+ // enforce flag to the opposite.
+ boolean enforceHost = !(IPAddressListProperty.addressListContains(bypassAddresses, clientAddr));
+
+ // Only continue processing if the list is not empty
+ if (!enforceAddresses.isEmpty()) {
+
+ // If client address is not available or invalid, MFA will
+ // be enforced.
+ if (clientAddr == null || !clientAddr.isIPAddress())
+ enforceHost = true;
+
+ // Check the enforce list for the client address and set enforcement flag.
+ else
+ enforceHost = IPAddressListProperty.addressListContains(enforceAddresses, clientAddr);
+ }
+
+ // If the enforce flag is not true, bypass Duo MFA.
+ if (!enforceHost)
+ return;
+
+ // Obtain a Duo client for redirecting the user to the Duo service and
+ // verifying any received authentication code
+ Client duoClient;
+ try {
+ duoClient = new Client.Builder(
+ confService.getClientId(),
+ confService.getClientSecret(),
+ confService.getAPIHostname(),
+ confService.getRedirectUri().toString())
+ .build();
+ }
+ catch (DuoException e) {
+ throw new GuacamoleServerException("Client for communicating with "
+ + "the Duo authentication service could not be created.", e);
+ }
+
+ // Verify that the Duo service is healthy and available
+ try {
+ duoClient.healthCheck();
+ }
+ catch (DuoException e) {
+ throw new GuacamoleServerException("Duo authentication service is "
+ + "not currently available (failed health check).", e);
+ }
+
+ // Retrieve signed Duo authentication code and session state from the
+ // request (these will be absent if this is an initial authentication
+ // attempt and not a redirect back from Duo)
+ String duoCode = credentials.getParameter(DUO_CODE_PARAMETER_NAME);
+ String duoState = credentials.getParameter(DUO_STATE_PARAMETER_NAME);
+
+ // Redirect to Duo to obtain an authentication code if that redirect
+ // has not yet occurred
+ if (duoCode != null && duoState != null) {
+
+ // Validate that the user has successfully verified their identify with
+ // the Duo service
+ try {
+
+ // Note unexpected behavior (Duo is expected to always return
+ // a token)
+ Token token = duoClient.exchangeAuthorizationCodeFor2FAResult(duoCode, username);
+ if (token == null) {
+ logger.warn("Duo did not return an authentication result "
+ + "at all for the authentication attempt by user "
+ + "\"{}\". This is unexpected behavior and may be "
+ + "a bug in the Duo service or the Duo SDK. "
+ + "Guacamole will attempt to automatically work "
+ + "around the issue by making a fresh Duo "
+ + "authentication request.", username);
+ }
+
+ // Warn if Duo explicitly denies authentication
+ else if (token.getAuth_result() == null || !DUO_TOKEN_SUCCESS_VALUE.equals(token.getAuth_result().getStatus())) {
+ logger.warn("Duo did not return an explicitly successful "
+ + "authentication result for the authentication "
+ + "attempt by user \"{}\". The user will now be "
+ + "redirected back to the Duo service to reattempt"
+ + "authentication.", username);
+ }
+
+ // Allow user to continue authenticating with Guacamole only if
+ // Duo has validated their identity
+ else
+ return;
+
+ }
+ catch (DuoException e) {
+ logger.debug("The Duo client failed internally while "
+ + "attempting to validate the identity of user "
+ + "\"{}\". This is commonly caused by stale query "
+ + "parameters from an older Duo request remaining "
+ + "present in the Guacamole URL. The user will now be "
+ + "redirected back to the Duo service to reattempt "
+ + "authentication.", e);
+ }
+
+ }
+
+ // Store received credentials for later retrieval leveraging Duo's
+ // opaque session state identifier (we need to maintain these
+ // credentials so that things like the GUAC_USERNAME and
+ // GUAC_PASSWORD tokens continue to work as expected despite the
+ // redirect to/from the external Duo service)
+ duoState = duoClient.generateState();
+ long expiresAfter = TimeUnit.MINUTES.toMillis(confService.getAuthenticationTimeout());
+ sessionManager.defer(new DuoAuthenticationSession(credentials, expiresAfter), duoState);
+
+ // Obtain authentication URL from Duo client
+ String duoAuthUrlString;
+ try {
+ duoAuthUrlString = duoClient.createAuthUrl(username, duoState);
+ }
+ catch (DuoException e) {
+ throw new GuacamoleServerException("Duo client failed to "
+ + "generate the authentication URL necessary to "
+ + "redirect the authenticating user to the Duo "
+ + "service.", e);
+ }
+
+ // Parse and validate URL obtained from Duo client
+ URI duoAuthUrl;
+ try {
+ duoAuthUrl = new URI(duoAuthUrlString);
+ }
+ catch (URISyntaxException e) {
+ throw new GuacamoleServerException("Authentication URL "
+ + "generated by the Duo client is not actually a "
+ + "valid URL and cannot be used to redirect the "
+ + "authenticating user to the Duo service.", e);
+ }
+
+ // Request that user be redirected to the Duo service to obtain
+ // a Duo authentication code
+ throw new TranslatableGuacamoleInsufficientCredentialsException(
+ "Verification using Duo is required before authentication "
+ + "can continue.", "LOGIN.INFO_DUO_AUTH_REQUIRED",
+ new CredentialsInfo(Collections.singletonList(
+ new RedirectField(
+ DUO_CODE_PARAMETER_NAME, duoAuthUrl,
+ new TranslatableMessage("LOGIN.INFO_DUO_REDIRECT_PENDING")
+ )
+ ))
+ );
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/conf/ConfigurationService.java b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/conf/ConfigurationService.java
new file mode 100644
index 0000000..43a2d98
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/conf/ConfigurationService.java
@@ -0,0 +1,268 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.duo.conf;
+
+import com.google.inject.Inject;
+import inet.ipaddr.IPAddress;
+import java.net.URI;
+import java.util.Collections;
+import java.util.List;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.environment.Environment;
+import org.apache.guacamole.properties.IntegerGuacamoleProperty;
+import org.apache.guacamole.properties.IPAddressListProperty;
+import org.apache.guacamole.properties.StringGuacamoleProperty;
+import org.apache.guacamole.properties.URIGuacamoleProperty;
+
+/**
+ * Service for retrieving configuration information regarding the Duo
+ * authentication extension.
+ */
+public class ConfigurationService {
+
+ /**
+ * The Guacamole server environment.
+ */
+ @Inject
+ private Environment environment;
+
+ /**
+ * The property within guacamole.properties which defines the hostname
+ * of the Duo API endpoint to be used to verify user identities. This will
+ * usually be in the form "api-XXXXXXXX.duosecurity.com", where "XXXXXXXX"
+ * is some arbitrary alphanumeric value assigned by Duo and specific to
+ * your organization.
+ */
+ private static final StringGuacamoleProperty DUO_API_HOSTNAME =
+ new StringGuacamoleProperty() {
+
+ @Override
+ public String getName() { return "duo-api-hostname"; }
+
+ };
+
+ /**
+ * The property within guacamole.properties which defines the client id
+ * received from Duo for verifying Guacamole users. This value MUST be
+ * exactly 20 characters.
+ */
+ private static final StringGuacamoleProperty DUO_CLIENT_ID =
+ new StringGuacamoleProperty() {
+
+ @Override
+ public String getName() { return "duo-client-id"; }
+
+ };
+
+ /**
+ * The property within guacamole.properties which defines the secret key
+ * received from Duo for verifying Guacamole users. This value MUST be
+ * exactly 40 characters.
+ */
+ private static final StringGuacamoleProperty DUO_CLIENT_SECRET =
+ new StringGuacamoleProperty() {
+
+ @Override
+ public String getName() { return "duo-client-secret"; }
+
+ };
+
+ /**
+ * The property within guacamole.properties which defines the redirect URI
+ * that Duo will call after the second factor has been completed. This
+ * should be the URI used to access Guacamole.
+ */
+ private static final URIGuacamoleProperty DUO_REDIRECT_URI =
+ new URIGuacamoleProperty() {
+
+ @Override
+ public String getName() { return "duo-redirect-uri"; }
+
+ };
+
+ /**
+ * The property that configures the timeout, in minutes, of in-progress
+ * Duo authentication attempts. Authentication attempts that take longer
+ * than this period of time will be invalidated.
+ */
+ private static final IntegerGuacamoleProperty DUO_AUTH_TIMEOUT =
+ new IntegerGuacamoleProperty() {
+
+ @Override
+ public String getName() { return "duo-auth-timeout"; }
+
+ };
+
+ /**
+ * The optional property that contains a comma-separated list of IP addresses
+ * or CIDRs for which the MFA requirement should be bypassed. If the Duo
+ * extension is installed, any/all users authenticating from clients that
+ * match this list will be able to successfully log in without fulfilling
+ * the MFA requirement. If this option is omitted or is empty, and the
+ * Duo module is installed, all users from all hosts will have Duo MFA
+ * enforced.
+ */
+ private static final IPAddressListProperty DUO_BYPASS_HOSTS =
+ new IPAddressListProperty() {
+
+ @Override
+ public String getName() { return "duo-bypass-hosts"; }
+
+ };
+
+ /**
+ * The optional property that contains a comma-separated list of IP addresses
+ * or CIDRs for which the MFA requirement should be explicitly enforced. If
+ * the Duo module is enabled and this property is specified, users that log
+ * in from hosts that match the items in this list will have Duo MFA required,
+ * and all users from hosts that do not match this list will be able to log
+ * in without the MFA requirement. If this option is missing or empty and
+ * the Duo module is installed, MFA will be enforced for all users.
+ */
+ private static final IPAddressListProperty DUO_ENFORCE_HOSTS =
+ new IPAddressListProperty() {
+
+ @Override
+ public String getName() { return "duo-enforce-hosts"; }
+
+ };
+
+ /**
+ * Returns the hostname of the Duo API endpoint to be used to verify user
+ * identities, as defined in guacamole.properties by the "duo-api-hostname"
+ * property. This will usually be in the form
+ * "api-XXXXXXXX.duosecurity.com", where "XXXXXXXX" is some arbitrary
+ * alphanumeric value assigned by Duo and specific to your organization.
+ *
+ * @return
+ * The hostname of the Duo API endpoint to be used to verify user
+ * identities.
+ *
+ * @throws GuacamoleException
+ * If the associated property within guacamole.properties is missing.
+ */
+ public String getAPIHostname() throws GuacamoleException {
+ return environment.getRequiredProperty(DUO_API_HOSTNAME);
+ }
+
+ /**
+ * Returns the Duo client id received from Duo for verifying Guacamole
+ * users, as defined in guacamole.properties by the "duo-client-id"
+ * property. This value MUST be exactly 20 characters.
+ *
+ * @return
+ * The client id received from Duo for verifying Guacamole users.
+ *
+ * @throws GuacamoleException
+ * If the associated property within guacamole.properties is missing.
+ */
+ public String getClientId() throws GuacamoleException {
+ return environment.getRequiredProperty(DUO_CLIENT_ID);
+ }
+
+ /**
+ * Returns the client secret received from Duo for verifying Guacamole users,
+ * as defined in guacamole.properties by the "duo-client-secret" property.
+ * This value MUST be exactly 20 characters.
+ *
+ * @return
+ * The client secret received from Duo for verifying Guacamole users.
+ *
+ * @throws GuacamoleException
+ * If the associated property within guacamole.properties is missing.
+ */
+ public String getClientSecret() throws GuacamoleException {
+ return environment.getRequiredProperty(DUO_CLIENT_SECRET);
+ }
+
+ /**
+ * Return the callback URI that will be called by Duo after authentication
+ * with Duo has been completed. This should be the URI to return the user
+ * to the Guacamole interface, and will be a full URI.
+ *
+ * @return
+ * The URL for Duo to use to callback to the Guacamole interface after
+ * authentication has been completed.
+ *
+ * @throws GuacamoleException
+ * If guacamole.properties cannot be read, or if the property is not
+ * defined.
+ */
+ public URI getRedirectUri() throws GuacamoleException {
+ return environment.getRequiredProperty(DUO_REDIRECT_URI);
+ }
+
+
+ /**
+ * Returns the maximum amount of time to allow for an in-progress Duo
+ * authentication attempt to be completed, in minutes. A user that takes
+ * longer than this amount of time to complete authentication with Duo
+ * will need to try again.
+ *
+ * @return
+ * The maximum amount of time to allow for an in-progress Duo
+ * authentication attempt to be completed, in minutes.
+ *
+ * @throws GuacamoleException
+ * If the authentication timeout cannot be parsed.
+ */
+ public int getAuthenticationTimeout() throws GuacamoleException {
+ return environment.getProperty(DUO_AUTH_TIMEOUT, 5);
+ }
+
+ /**
+ * Returns the list of IP addresses and subnets defined in guacamole.properties
+ * for which Duo MFA should _not_ be enforced. Users logging in from hosts
+ * contained in this list will be logged in without the MFA requirement.
+ *
+ * @return
+ * A list of IP addresses and subnets for which Duo MFA should not be
+ * enforced.
+ *
+ * @throws GuacamoleException
+ * If guacamole.properties cannot be parsed, or if an invalid IP address
+ * or subnet is specified.
+ */
+ public List getBypassHosts() throws GuacamoleException {
+ return environment.getProperty(DUO_BYPASS_HOSTS, Collections.emptyList());
+ }
+
+ /**
+ * Returns the list of IP addresses and subnets defined in guacamole.properties
+ * for which Duo MFA should explicitly be enforced, while logins from all
+ * other hosts should not enforce MFA. Users logging in from hosts
+ * contained in this list will be required to complete the Duo MFA authentication,
+ * while users from all other hosts will be logged in without the MFA requirement.
+ *
+ * @return
+ * A list of IP addresses and subnets for which Duo MFA should be
+ * explicitly enforced.
+ *
+ * @throws GuacamoleException
+ * If guacamole.properties cannot be parsed, or if an invalid IP address
+ * or subnet is specified.
+ */
+ public List getEnforceHosts() throws GuacamoleException {
+ return environment.getProperty(DUO_ENFORCE_HOSTS, Collections.emptyList());
+ }
+
+
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/resources/guac-manifest.json b/extensions/guacamole-auth-duo/src/main/resources/guac-manifest.json
new file mode 100644
index 0000000..5c305ed
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/resources/guac-manifest.json
@@ -0,0 +1,25 @@
+{
+
+ "guacamoleVersion" : "1.6.0",
+
+ "name" : "Duo TFA Authentication Backend",
+ "namespace" : "duo",
+
+ "authProviders" : [
+ "org.apache.guacamole.auth.duo.DuoAuthenticationProvider"
+ ],
+
+ "translations" : [
+ "translations/ca.json",
+ "translations/de.json",
+ "translations/en.json",
+ "translations/fr.json",
+ "translations/ja.json",
+ "translations/ko.json",
+ "translations/pl.json",
+ "translations/pt.json",
+ "translations/ru.json",
+ "translations/zh.json"
+ ]
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/resources/translations/ca.json b/extensions/guacamole-auth-duo/src/main/resources/translations/ca.json
new file mode 100644
index 0000000..c154ae6
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/resources/translations/ca.json
@@ -0,0 +1,13 @@
+{
+
+ "DATA_SOURCE_DUO" : {
+ "NAME" : "Duo TFA Backend"
+ },
+
+ "LOGIN" : {
+ "FIELD_HEADER_GUAC_DUO_SIGNED_RESPONSE" : "",
+ "INFO_DUO_VALIDATION_CODE_INCORRECT" : "El codi de validació duo és incorrecte.",
+ "INFO_DUO_AUTH_REQUIRED" : "Si us plau, autentiqueu amb Duo per continuar."
+ }
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/resources/translations/de.json b/extensions/guacamole-auth-duo/src/main/resources/translations/de.json
new file mode 100644
index 0000000..9642f1a
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/resources/translations/de.json
@@ -0,0 +1,13 @@
+{
+
+ "DATA_SOURCE_DUO" : {
+ "NAME" : "Duo TFA Backend"
+ },
+
+ "LOGIN" : {
+ "FIELD_HEADER_GUAC_DUO_SIGNED_RESPONSE" : "",
+ "INFO_DUO_VALIDATION_CODE_INCORRECT" : "Duo Validierungscode nicht korrekt.",
+ "INFO_DUO_AUTH_REQUIRED" : "Bitte melden Sie sich mit Duo an, um fortzufahren."
+ }
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/resources/translations/en.json b/extensions/guacamole-auth-duo/src/main/resources/translations/en.json
new file mode 100644
index 0000000..877f538
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/resources/translations/en.json
@@ -0,0 +1,14 @@
+{
+
+ "DATA_SOURCE_DUO" : {
+ "NAME" : "Duo TFA Backend"
+ },
+
+ "LOGIN" : {
+ "FIELD_HEADER_GUAC_DUO_SIGNED_RESPONSE" : "",
+ "INFO_DUO_VALIDATION_CODE_INCORRECT" : "Duo validation code incorrect.",
+ "INFO_DUO_AUTH_REQUIRED" : "Please authenticate with Duo to continue.",
+ "INFO_DUO_REDIRECT_PENDING" : "Please wait, redirecting to Duo..."
+ }
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/resources/translations/fr.json b/extensions/guacamole-auth-duo/src/main/resources/translations/fr.json
new file mode 100644
index 0000000..b7dfcb7
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/resources/translations/fr.json
@@ -0,0 +1,14 @@
+{
+
+ "DATA_SOURCE_DUO" : {
+ "NAME" : "Duo TFA Backend"
+ },
+
+ "LOGIN" : {
+ "FIELD_HEADER_GUAC_DUO_SIGNED_RESPONSE" : "",
+ "INFO_DUO_VALIDATION_CODE_INCORRECT" : "Code de validation Duo incorrect.",
+ "INFO_DUO_AUTH_REQUIRED" : "Veuillez vous authentifier avec Duo pour continuer.",
+ "INFO_DUO_REDIRECT_PENDING" : "Veuillez patienter, redirection vers Duo..."
+ }
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/resources/translations/it.json b/extensions/guacamole-auth-duo/src/main/resources/translations/it.json
new file mode 100644
index 0000000..d7bb5a7
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/resources/translations/it.json
@@ -0,0 +1,8 @@
+{
+
+ "LOGIN" : {
+ "INFO_DUO_VALIDATION_CODE_INCORRECT" : "Codice di convalida Duo errato.",
+ "INFO_DUO_AUTH_REQUIRED" : "Si prega di autenticarsi con Duo per continuare."
+ }
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/resources/translations/ja.json b/extensions/guacamole-auth-duo/src/main/resources/translations/ja.json
new file mode 100644
index 0000000..d3acef8
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/resources/translations/ja.json
@@ -0,0 +1,9 @@
+{
+
+ "LOGIN" : {
+ "INFO_DUO_VALIDATION_CODE_INCORRECT" : "Duoの認証コードが間違っています。",
+ "INFO_DUO_AUTH_REQUIRED" : "Duoで認証してください。",
+ "INFO_DUO_REDIRECT_PENDING" : "Duoへリダイレクトしています。"
+ }
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/resources/translations/ko.json b/extensions/guacamole-auth-duo/src/main/resources/translations/ko.json
new file mode 100644
index 0000000..64cd2cd
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/resources/translations/ko.json
@@ -0,0 +1,8 @@
+{
+
+ "LOGIN" : {
+ "INFO_DUO_VALIDATION_CODE_INCORRECT" : "Duo 유효성 검사 코드가 잘못되었습니다.",
+ "INFO_DUO_AUTH_REQUIRED" : "계속하려면 Duo로 인증하세요."
+ }
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/resources/translations/pl.json b/extensions/guacamole-auth-duo/src/main/resources/translations/pl.json
new file mode 100644
index 0000000..dd4d3b8
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/resources/translations/pl.json
@@ -0,0 +1,13 @@
+{
+
+ "DATA_SOURCE_DUO" : {
+ "NAME" : "Duo TFA Backend"
+ },
+
+ "LOGIN" : {
+ "FIELD_HEADER_GUAC_DUO_SIGNED_RESPONSE" : "",
+ "INFO_DUO_VALIDATION_CODE_INCORRECT" : "Nieprawidłowy kod weryfikacyjny Duo.",
+ "INFO_DUO_AUTH_REQUIRED" : "Aby kontynuować uwierzytelnij się w Duo."
+ }
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/resources/translations/pt.json b/extensions/guacamole-auth-duo/src/main/resources/translations/pt.json
new file mode 100644
index 0000000..73de5c6
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/resources/translations/pt.json
@@ -0,0 +1,13 @@
+{
+
+ "DATA_SOURCE_DUO" : {
+ "NAME" : "Duo TFA Backend"
+ },
+
+ "LOGIN" : {
+ "FIELD_HEADER_GUAC_DUO_SIGNED_RESPONSE" : "",
+ "INFO_DUO_VALIDATION_CODE_INCORRECT" : "Código de validação Duo incorreto.",
+ "INFO_DUO_AUTH_REQUIRED" : "Por favor autentique com Duo para continuar."
+ }
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/resources/translations/ru.json b/extensions/guacamole-auth-duo/src/main/resources/translations/ru.json
new file mode 100644
index 0000000..5e7deb5
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/resources/translations/ru.json
@@ -0,0 +1,12 @@
+{
+
+ "DATA_SOURCE_DUO" : {
+ "NAME" : "Бэкенд Duo TFA"
+ },
+
+ "LOGIN" : {
+ "INFO_DUO_VALIDATION_CODE_INCORRECT" : "Неверный код валидации Duo.",
+ "INFO_DUO_AUTH_REQUIRED" : "Пожалуйста, аутентифицируйтесь в Duo для продолжения."
+ }
+
+}
diff --git a/extensions/guacamole-auth-duo/src/main/resources/translations/zh.json b/extensions/guacamole-auth-duo/src/main/resources/translations/zh.json
new file mode 100644
index 0000000..8bee1e2
--- /dev/null
+++ b/extensions/guacamole-auth-duo/src/main/resources/translations/zh.json
@@ -0,0 +1,13 @@
+{
+
+ "DATA_SOURCE_DUO" : {
+ "NAME" : "Duo TFA后端"
+ },
+
+ "LOGIN" : {
+ "FIELD_HEADER_GUAC_DUO_SIGNED_RESPONSE" : "",
+ "INFO_DUO_VALIDATION_CODE_INCORRECT" : "Duo验证码不正确。",
+ "INFO_DUO_AUTH_REQUIRED" : "请先使用Duo进行身份验证。"
+ }
+
+}
diff --git a/extensions/guacamole-auth-header/.gitignore b/extensions/guacamole-auth-header/.gitignore
new file mode 100644
index 0000000..42f4a1a
--- /dev/null
+++ b/extensions/guacamole-auth-header/.gitignore
@@ -0,0 +1,2 @@
+target/
+*~
diff --git a/extensions/guacamole-auth-header/.ratignore b/extensions/guacamole-auth-header/.ratignore
new file mode 100644
index 0000000..e69de29
diff --git a/extensions/guacamole-auth-header/pom.xml b/extensions/guacamole-auth-header/pom.xml
new file mode 100644
index 0000000..017ea64
--- /dev/null
+++ b/extensions/guacamole-auth-header/pom.xml
@@ -0,0 +1,67 @@
+
+
+
+
+ 4.0.0
+ org.apache.guacamole
+ guacamole-auth-header
+ jar
+ 1.6.0
+ guacamole-auth-header
+ http://guacamole.apache.org/
+
+
+ org.apache.guacamole
+ extensions
+ 1.6.0
+ ../
+
+
+
+
+
+
+ org.apache.guacamole
+ guacamole-ext
+ 1.6.0
+ provided
+
+
+
+
+ com.google.inject
+ guice
+
+
+
+
+ javax.servlet
+ servlet-api
+ 2.5
+ provided
+
+
+
+
+
+
diff --git a/extensions/guacamole-auth-header/src/main/assembly/dist.xml b/extensions/guacamole-auth-header/src/main/assembly/dist.xml
new file mode 100644
index 0000000..0b16a71
--- /dev/null
+++ b/extensions/guacamole-auth-header/src/main/assembly/dist.xml
@@ -0,0 +1,53 @@
+
+
+
+
+ dist
+ ${project.artifactId}-${project.version}
+
+
+
+ tar.gz
+
+
+
+
+
+
+
+ target/licenses
+
+
+
+
+ target
+
+ *.jar
+
+
+
+
+
+
diff --git a/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/AuthenticationProviderService.java b/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/AuthenticationProviderService.java
new file mode 100644
index 0000000..e3117d3
--- /dev/null
+++ b/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/AuthenticationProviderService.java
@@ -0,0 +1,85 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.header;
+
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.net.auth.Credentials;
+import org.apache.guacamole.net.auth.credentials.CredentialsInfo;
+import org.apache.guacamole.net.auth.credentials.GuacamoleInvalidCredentialsException;
+import org.apache.guacamole.auth.header.user.AuthenticatedUser;
+
+/**
+ * Service providing convenience functions for the HTTP Header
+ * AuthenticationProvider implementation.
+ */
+public class AuthenticationProviderService {
+
+ /**
+ * Service for retrieving header configuration information.
+ */
+ @Inject
+ private ConfigurationService confService;
+
+ /**
+ * Provider for AuthenticatedUser objects.
+ */
+ @Inject
+ private Provider authenticatedUserProvider;
+
+ /**
+ * Returns an AuthenticatedUser representing the user authenticated by the
+ * given credentials.
+ *
+ * @param credentials
+ * The credentials to use for authentication.
+ *
+ * @return
+ * An AuthenticatedUser representing the user authenticated by the
+ * given credentials.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while authenticating the user, or if access is
+ * denied.
+ */
+ public AuthenticatedUser authenticateUser(Credentials credentials)
+ throws GuacamoleException {
+
+ // Get the username from the header configured in guacamole.properties
+ String username = credentials.getHeader(confService.getHttpAuthHeader());
+ if (username != null) {
+
+ // Update credentials with username provided via header for sake of
+ // ${GUAC_USERNAME} token
+ credentials.setUsername(username);
+
+ AuthenticatedUser authenticatedUser = authenticatedUserProvider.get();
+ authenticatedUser.init(username, credentials);
+ return authenticatedUser;
+
+ }
+
+ // Authentication not provided via header, yet, so we request it.
+ throw new GuacamoleInvalidCredentialsException("Invalid login.", CredentialsInfo.USERNAME_PASSWORD);
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/ConfigurationService.java b/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/ConfigurationService.java
new file mode 100644
index 0000000..2ab1350
--- /dev/null
+++ b/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/ConfigurationService.java
@@ -0,0 +1,57 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.header;
+
+import com.google.inject.Inject;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.environment.Environment;
+
+/**
+ * Service for retrieving configuration information for HTTP header-based
+ * authentication.
+ */
+public class ConfigurationService {
+
+ /**
+ * The Guacamole server environment.
+ */
+ @Inject
+ private Environment environment;
+
+ /**
+ * Returns the header of the HTTP server as configured with
+ * guacamole.properties used for HTTP authentication.
+ * By default, this will be "REMOTE_USER".
+ *
+ * @return
+ * The header used for HTTP authentication, as configured with
+ * guacamole.properties.
+ *
+ * @throws GuacamoleException
+ * If guacamole.properties cannot be parsed.
+ */
+ public String getHttpAuthHeader() throws GuacamoleException {
+ return environment.getProperty(
+ HTTPHeaderGuacamoleProperties.HTTP_AUTH_HEADER,
+ "REMOTE_USER"
+ );
+ }
+
+}
diff --git a/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/HTTPHeaderAuthenticationProvider.java b/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/HTTPHeaderAuthenticationProvider.java
new file mode 100644
index 0000000..5478ea5
--- /dev/null
+++ b/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/HTTPHeaderAuthenticationProvider.java
@@ -0,0 +1,75 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.header;
+
+import com.google.inject.Guice;
+import com.google.inject.Injector;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.net.auth.AbstractAuthenticationProvider;
+import org.apache.guacamole.net.auth.AuthenticatedUser;
+import org.apache.guacamole.net.auth.Credentials;
+
+/**
+ * Guacamole authentication backend which authenticates users using an
+ * arbitrary external HTTP header. No storage for connections is
+ * provided - only authentication. Storage must be provided by some other
+ * extension.
+ */
+public class HTTPHeaderAuthenticationProvider extends AbstractAuthenticationProvider {
+
+ /**
+ * Injector which will manage the object graph of this authentication
+ * provider.
+ */
+ private final Injector injector;
+
+ /**
+ * Creates a new HTTPHeaderAuthenticationProvider that authenticates users
+ * using HTTP headers.
+ *
+ * @throws GuacamoleException
+ * If a required property is missing, or an error occurs while parsing
+ * a property.
+ */
+ public HTTPHeaderAuthenticationProvider() throws GuacamoleException {
+
+ // Set up Guice injector.
+ injector = Guice.createInjector(
+ new HTTPHeaderAuthenticationProviderModule(this)
+ );
+
+ }
+
+ @Override
+ public String getIdentifier() {
+ return "header";
+ }
+
+ @Override
+ public AuthenticatedUser authenticateUser(Credentials credentials)
+ throws GuacamoleException {
+
+ // Pass credentials to authentication service.
+ AuthenticationProviderService authProviderService = injector.getInstance(AuthenticationProviderService.class);
+ return authProviderService.authenticateUser(credentials);
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/HTTPHeaderAuthenticationProviderModule.java b/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/HTTPHeaderAuthenticationProviderModule.java
new file mode 100644
index 0000000..a31d633
--- /dev/null
+++ b/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/HTTPHeaderAuthenticationProviderModule.java
@@ -0,0 +1,78 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.header;
+
+import com.google.inject.AbstractModule;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.environment.Environment;
+import org.apache.guacamole.environment.LocalEnvironment;
+import org.apache.guacamole.net.auth.AuthenticationProvider;
+
+/**
+ * Guice module which configures HTTP header-specific injections.
+ */
+public class HTTPHeaderAuthenticationProviderModule extends AbstractModule {
+
+ /**
+ * Guacamole server environment.
+ */
+ private final Environment environment;
+
+ /**
+ * A reference to the HTTPHeaderAuthenticationProvider on behalf of which this
+ * module has configured injection.
+ */
+ private final AuthenticationProvider authProvider;
+
+ /**
+ * Creates a new HTTP header authentication provider module which configures
+ * injection for the HTTPHeaderAuthenticationProvider.
+ *
+ * @param authProvider
+ * The AuthenticationProvider for which injection is being configured.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while retrieving the Guacamole server
+ * environment.
+ */
+ public HTTPHeaderAuthenticationProviderModule(AuthenticationProvider authProvider)
+ throws GuacamoleException {
+
+ // Get local environment
+ this.environment = LocalEnvironment.getInstance();
+
+ // Store associated auth provider
+ this.authProvider = authProvider;
+
+ }
+
+ @Override
+ protected void configure() {
+
+ // Bind core implementations of guacamole-ext classes
+ bind(AuthenticationProvider.class).toInstance(authProvider);
+ bind(Environment.class).toInstance(environment);
+
+ // Bind HTTPHeader-specific classes
+ bind(ConfigurationService.class);
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/HTTPHeaderGuacamoleProperties.java b/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/HTTPHeaderGuacamoleProperties.java
new file mode 100644
index 0000000..bdc3dfd
--- /dev/null
+++ b/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/HTTPHeaderGuacamoleProperties.java
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.header;
+
+import org.apache.guacamole.properties.StringGuacamoleProperty;
+
+
+/**
+ * Provides properties required for use of the HTTP header
+ * authentication provider. These properties will be read from
+ * guacamole.properties when the HTTP authentication provider is used.
+ */
+public class HTTPHeaderGuacamoleProperties {
+
+ /**
+ * This class should not be instantiated.
+ */
+ private HTTPHeaderGuacamoleProperties() {}
+
+ /**
+ * A property used to configure the header used for HTTP header authentication.
+ */
+ public static final StringGuacamoleProperty HTTP_AUTH_HEADER = new StringGuacamoleProperty() {
+
+ @Override
+ public String getName() { return "http-auth-header"; }
+
+ };
+
+}
diff --git a/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/user/AuthenticatedUser.java b/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/user/AuthenticatedUser.java
new file mode 100644
index 0000000..9686eac
--- /dev/null
+++ b/extensions/guacamole-auth-header/src/main/java/org/apache/guacamole/auth/header/user/AuthenticatedUser.java
@@ -0,0 +1,71 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.header.user;
+
+import com.google.inject.Inject;
+import org.apache.guacamole.net.auth.AbstractAuthenticatedUser;
+import org.apache.guacamole.net.auth.AuthenticationProvider;
+import org.apache.guacamole.net.auth.Credentials;
+
+/**
+ * An HTTP header implementation of AuthenticatedUser, associating a
+ * username and particular set of credentials with the HTTP authentication
+ * provider.
+ */
+public class AuthenticatedUser extends AbstractAuthenticatedUser {
+
+ /**
+ * Reference to the authentication provider associated with this
+ * authenticated user.
+ */
+ @Inject
+ private AuthenticationProvider authProvider;
+
+ /**
+ * The credentials provided when this user was authenticated.
+ */
+ private Credentials credentials;
+
+ /**
+ * Initializes this AuthenticatedUser using the given username and
+ * credentials.
+ *
+ * @param username
+ * The username of the user that was authenticated.
+ *
+ * @param credentials
+ * The credentials provided when this user was authenticated.
+ */
+ public void init(String username, Credentials credentials) {
+ this.credentials = credentials;
+ setIdentifier(username.toLowerCase());
+ }
+
+ @Override
+ public AuthenticationProvider getAuthenticationProvider() {
+ return authProvider;
+ }
+
+ @Override
+ public Credentials getCredentials() {
+ return credentials;
+ }
+
+}
diff --git a/extensions/guacamole-auth-header/src/main/resources/guac-manifest.json b/extensions/guacamole-auth-header/src/main/resources/guac-manifest.json
new file mode 100644
index 0000000..49015de
--- /dev/null
+++ b/extensions/guacamole-auth-header/src/main/resources/guac-manifest.json
@@ -0,0 +1,12 @@
+{
+
+ "guacamoleVersion" : "1.6.0",
+
+ "name" : "HTTP Header Authentication Extension",
+ "namespace" : "header",
+
+ "authProviders" : [
+ "org.apache.guacamole.auth.header.HTTPHeaderAuthenticationProvider"
+ ]
+
+}
diff --git a/extensions/guacamole-auth-jdbc/.ratignore b/extensions/guacamole-auth-jdbc/.ratignore
new file mode 100644
index 0000000..e69de29
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/.gitignore b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/.gitignore
new file mode 100644
index 0000000..42f4a1a
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/.gitignore
@@ -0,0 +1,2 @@
+target/
+*~
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/.ratignore b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/.ratignore
new file mode 100644
index 0000000..da318d1
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/.ratignore
@@ -0,0 +1 @@
+src/main/resources/html/*.html
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/pom.xml b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/pom.xml
new file mode 100644
index 0000000..93dc928
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/pom.xml
@@ -0,0 +1,105 @@
+
+
+
+
+ 4.0.0
+ org.apache.guacamole
+ guacamole-auth-jdbc-base
+ jar
+ guacamole-auth-jdbc-base
+ http://guacamole.apache.org/
+
+
+ org.apache.guacamole
+ guacamole-auth-jdbc
+ 1.6.0
+ ../../
+
+
+
+
+
+
+ javax.servlet
+ servlet-api
+ 2.5
+ provided
+
+
+
+
+ org.apache.guacamole
+ guacamole-ext
+ provided
+
+
+
+
+ org.mybatis
+ mybatis
+ 3.5.19
+
+
+
+
+ org.mybatis
+ mybatis-guice
+ 3.18
+
+
+
+
+ org.slf4j
+ jcl-over-slf4j
+
+
+
+
+ com.github.spotbugs
+ spotbugs-annotations
+
+
+
+
+
+
+
+ com.google.inject
+ guice
+
+
+
+
+ com.google.guava
+ guava
+
+
+
+
+
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/AuthenticationProviderService.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/AuthenticationProviderService.java
new file mode 100644
index 0000000..5fedd23
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/AuthenticationProviderService.java
@@ -0,0 +1,143 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc;
+
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.net.auth.AuthenticatedUser;
+import org.apache.guacamole.net.auth.AuthenticationProvider;
+import org.apache.guacamole.net.auth.Credentials;
+import org.apache.guacamole.net.auth.UserContext;
+
+/**
+ * Service which authenticates users based on credentials and provides for
+ * the creation of corresponding, new UserContext objects for authenticated
+ * users.
+ */
+public interface AuthenticationProviderService {
+
+ /**
+ * Authenticates the user having the given credentials, returning a new
+ * AuthenticatedUser instance only if the credentials are valid. If the
+ * credentials are invalid or expired, an appropriate GuacamoleException
+ * will be thrown.
+ *
+ * @param authenticationProvider
+ * The AuthenticationProvider on behalf of which the user is being
+ * authenticated.
+ *
+ * @param credentials
+ * The credentials to use to produce the AuthenticatedUser.
+ *
+ * @return
+ * A new AuthenticatedUser instance for the user identified by the
+ * given credentials.
+ *
+ * @throws GuacamoleException
+ * If an error occurs during authentication, or if the given
+ * credentials are invalid or expired.
+ */
+ public AuthenticatedUser authenticateUser(AuthenticationProvider authenticationProvider,
+ Credentials credentials) throws GuacamoleException;
+
+ /**
+ * Returning a new UserContext instance for the given already-authenticated
+ * user.
+ *
+ * @param authenticationProvider
+ * The AuthenticationProvider on behalf of which the UserContext is
+ * being produced.
+ *
+ * @param authenticatedUser
+ * The credentials to use to produce the UserContext.
+ *
+ * @return
+ * A new UserContext instance for the user identified by the given
+ * credentials, or null if no such user exists within the database.
+ *
+ * @throws GuacamoleException
+ * If an error occurs during authentication, or if the given
+ * credentials are invalid or expired.
+ */
+ public UserContext getUserContext(AuthenticationProvider authenticationProvider,
+ AuthenticatedUser authenticatedUser) throws GuacamoleException;
+
+ /**
+ * Returns an updated UserContext instance for the given
+ * already-authenticated user. If no changes need be made to the
+ * UserContext, the original UserContext will be returned.
+ *
+ * @param authenticationProvider
+ * The AuthenticationProvider on behalf of which the UserContext is
+ * being updated.
+ *
+ * @param context
+ * The UserContext to update.
+ *
+ * @param authenticatedUser
+ * The AuthenticatedUser associated with the UserContext being updated.
+ *
+ * @param credentials
+ * The credentials most recently submitted by the user. These
+ * credentials are not guaranteed to be the same as the credentials
+ * already associated with the AuthenticatedUser.
+ *
+ * @return
+ * A new UserContext instance for the user identified by the given
+ * credentials.
+ *
+ * @throws GuacamoleException
+ * If an error occurs during authentication, or if the given
+ * credentials are invalid or expired.
+ */
+ public UserContext updateUserContext(AuthenticationProvider authenticationProvider,
+ UserContext context, AuthenticatedUser authenticatedUser,
+ Credentials credentials) throws GuacamoleException;
+
+ /**
+ * Decorates a UserContext instance for the given already-authenticated user.
+ * If no decoration is required, the original UserContext will be returned.
+ *
+ * @param authenticationProvider
+ * The AuthenticationProvider on behalf of which the UserContext is
+ * being decorated.
+ *
+ * @param context
+ * The UserContext to decorate.
+ *
+ * @param authenticatedUser
+ * The AuthenticatedUser associated with the UserContext being decorated.
+ *
+ * @param credentials
+ * The credentials most recently submitted by the user. These
+ * credentials are not guaranteed to be the same as the credentials
+ * already associated with the AuthenticatedUser.
+ *
+ * @return
+ * A decorated UserContext instance for the user identified by the given
+ * credentials, or the original user context if no decoration is required.
+ *
+ * @throws GuacamoleException
+ * If the an error occurs during decoration of the UserContext.
+ */
+ public UserContext decorateUserContext(AuthenticationProvider authenticationProvider,
+ UserContext context, AuthenticatedUser authenticatedUser,
+ Credentials credentials) throws GuacamoleException;
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/DynamicallyAuthenticatedDataSource.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/DynamicallyAuthenticatedDataSource.java
new file mode 100644
index 0000000..4c8e3c0
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/DynamicallyAuthenticatedDataSource.java
@@ -0,0 +1,156 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc;
+
+import com.google.inject.Inject;
+import com.google.inject.Singleton;
+import com.google.inject.name.Named;
+import java.sql.Connection;
+import java.sql.SQLException;
+import java.util.Properties;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.ibatis.datasource.pooled.PooledDataSource;
+import org.apache.ibatis.datasource.unpooled.UnpooledDataSource;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Pooled DataSource implementation which dynamically retrieves the database
+ * username and password from the Guacamole server environment each time a
+ * new database connection is created.
+ */
+@Singleton
+public class DynamicallyAuthenticatedDataSource extends PooledDataSource {
+
+ /**
+ * Logger for this class.
+ */
+ private static final Logger logger = LoggerFactory.getLogger(DynamicallyAuthenticatedDataSource.class);
+
+ /**
+ * Creates a new DynamicallyAuthenticatedDataSource which dynamically
+ * retrieves database credentials from the given JDBCEnvironment each time
+ * a new database connection is needed.
+ *
+ * @param environment
+ * The JDBCEnvironment that should be used to retrieve database
+ * credentials.
+ *
+ * @param driverClassLoader
+ * @param driver
+ * @param url
+ */
+ @Inject
+ public DynamicallyAuthenticatedDataSource(JDBCEnvironment environment,
+ @Named(value="JDBC.driverClassLoader") ClassLoader driverClassLoader,
+ @Named(value="JDBC.driver") String driver,
+ @Named(value="JDBC.url") String url) {
+
+ // Wrap unpooled DataSource, overriding the connection process such
+ // that credentials are dynamically retrieved from the JDBCEnvironment
+ super(new UnpooledDataSource(driverClassLoader, driver, url, null, null) {
+
+ @Override
+ public Connection getConnection() throws SQLException {
+ try {
+ logger.debug("Creating new database connection for pool.");
+ return super.getConnection(environment.getUsername(), environment.getPassword());
+ }
+ catch (GuacamoleException e) {
+ throw new SQLException("Retrieval of database credentials failed.", e);
+ }
+ }
+
+ });
+
+ // Force recalculation of expectedConnectionTypeCode. The
+ // PooledDataSource constructor accepting a single UnpooledDataSource
+ // will otherwise leave this value uninitialized, resulting in all
+ // connections failing to pass sanity checks and never being returned
+ // to the pool.
+ super.forceCloseAll();
+
+ }
+
+ @Override
+ @Inject(optional=true)
+ public void setPoolPingConnectionsNotUsedFor(
+ @Named("mybatis.pooled.pingConnectionsNotUsedFor") int milliseconds) {
+ super.setPoolPingConnectionsNotUsedFor(milliseconds);
+ }
+
+ @Override
+ @Inject(optional=true)
+ public void setPoolPingEnabled(@Named("mybatis.pooled.pingEnabled") boolean poolPingEnabled) {
+ super.setPoolPingEnabled(poolPingEnabled);
+ }
+
+ @Override
+ @Inject(optional=true)
+ public void setPoolPingQuery(@Named("mybatis.pooled.pingQuery") String poolPingQuery) {
+ super.setPoolPingQuery(poolPingQuery);
+ }
+
+ @Override
+ @Inject(optional=true)
+ public void setPoolTimeToWait(@Named("mybatis.pooled.timeToWait") int poolTimeToWait) {
+ super.setPoolTimeToWait(poolTimeToWait);
+ }
+
+ @Override
+ @Inject(optional=true)
+ public void setPoolMaximumCheckoutTime(
+ @Named("mybatis.pooled.maximumCheckoutTime") int poolMaximumCheckoutTime) {
+ super.setPoolMaximumCheckoutTime(poolMaximumCheckoutTime);
+ }
+
+ @Override
+ @Inject(optional=true)
+ public void setPoolMaximumIdleConnections(
+ @Named("mybatis.pooled.maximumIdleConnections") int poolMaximumIdleConnections) {
+ super.setPoolMaximumIdleConnections(poolMaximumIdleConnections);
+ }
+
+ @Override
+ @Inject(optional=true)
+ public void setPoolMaximumActiveConnections(
+ @Named("mybatis.pooled.maximumActiveConnections") int poolMaximumActiveConnections) {
+ super.setPoolMaximumActiveConnections(poolMaximumActiveConnections);
+ }
+
+ @Override
+ @Inject(optional=true)
+ public void setDriverProperties(@Named("JDBC.driverProperties") Properties driverProps) {
+ super.setDriverProperties(driverProps);
+ }
+
+ @Override
+ @Inject(optional=true)
+ public void setDefaultAutoCommit(@Named("JDBC.autoCommit") boolean defaultAutoCommit) {
+ super.setDefaultAutoCommit(defaultAutoCommit);
+ }
+
+ @Override
+ @Inject(optional=true)
+ public void setLoginTimeout(@Named("JDBC.loginTimeout") int loginTimeout) {
+ super.setLoginTimeout(loginTimeout);
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/HistoryTrackingConnection.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/HistoryTrackingConnection.java
new file mode 100644
index 0000000..87de9eb
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/HistoryTrackingConnection.java
@@ -0,0 +1,132 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc;
+
+import com.google.inject.Inject;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.Map;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.auth.jdbc.connection.ConnectionRecordMapper;
+import org.apache.guacamole.auth.jdbc.connection.ConnectionRecordModel;
+import org.apache.guacamole.auth.jdbc.connection.ModeledConnectionRecord;
+import org.apache.guacamole.environment.Environment;
+import org.apache.guacamole.environment.LocalEnvironment;
+import org.apache.guacamole.net.GuacamoleTunnel;
+import org.apache.guacamole.net.auth.Connection;
+import org.apache.guacamole.net.auth.DelegatingConnection;
+import org.apache.guacamole.net.auth.User;
+import org.apache.guacamole.protocol.GuacamoleClientInformation;
+
+/**
+ * Connection implementation that creates a history record when the connection
+ * is established, and returns a HistoryTrackingTunnel to automatically set the
+ * end date when the connection is closed.
+ */
+public class HistoryTrackingConnection extends DelegatingConnection {
+
+ /**
+ * The current Guacamole user.
+ */
+ private final User currentUser;
+
+ /**
+ * The remote host that the user connected from.
+ */
+ private final String remoteHost;
+
+ /**
+ * The connection record mapper to use when writing history entries for
+ * established connections.
+ */
+ private final ConnectionRecordMapper connectionRecordMapper;
+
+ /**
+ * The environment in which Guacamole is running.
+ */
+ private final Environment environment = LocalEnvironment.getInstance();
+
+ /**
+ * Creates a new HistoryConnection that wraps the given connection,
+ * automatically creating a history record when the connection is
+ * established, and returning a HistoryTrackingTunnel to set the end
+ * date on the history entry when the connection is closed.
+ *
+ * @param currentUser
+ * The current Guacamole user.
+ *
+ * @param remoteHost
+ * The remote host that the user connected from.
+ *
+ * @param connection
+ * The connection to wrap.
+ *
+ * @param connectionRecordMapper
+ * The connection record mapper that will be used to write the connection history records.
+ */
+ public HistoryTrackingConnection(User currentUser, String remoteHost, Connection connection, ConnectionRecordMapper connectionRecordMapper) {
+ super(connection);
+
+ this.currentUser = currentUser;
+ this.remoteHost = remoteHost;
+ this.connectionRecordMapper = connectionRecordMapper;
+ }
+
+ @Override
+ public GuacamoleTunnel connect(GuacamoleClientInformation info,
+ Map tokens) throws GuacamoleException {
+
+ // Create a connection record model, starting at the current date/time
+ ConnectionRecordModel connectionRecordModel = new ConnectionRecordModel();
+ connectionRecordModel.setStartDate(new Date());
+
+ // Set the user information
+ connectionRecordModel.setUsername(this.currentUser.getIdentifier());
+ connectionRecordModel.setRemoteHost(this.remoteHost);
+
+ // Set the connection information
+ connectionRecordModel.setConnectionName(this.getDelegateConnection().getName());
+
+ // Insert the connection history record to mark the start of this connection
+ connectionRecordMapper.insert(connectionRecordModel,
+ environment.getCaseSensitivity());
+
+ // Include history record UUID as token
+ ModeledConnectionRecord modeledRecord = new ModeledConnectionRecord(connectionRecordModel);
+ Map updatedTokens = new HashMap<>(tokens);
+ updatedTokens.put("HISTORY_UUID", modeledRecord.getUUID().toString());
+
+ // Connect, and wrap the tunnel for return
+ GuacamoleTunnel tunnel = super.connect(info, updatedTokens);
+ return new HistoryTrackingTunnel(
+ tunnel, this.connectionRecordMapper, connectionRecordModel);
+ }
+
+ /**
+ * Get the Connection wrapped by this HistoryTrackingConnection.
+ *
+ * @return
+ * The wrapped Connection.
+ */
+ public Connection getWrappedConnection() {
+ return getDelegateConnection();
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/HistoryTrackingConnectionDirectory.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/HistoryTrackingConnectionDirectory.java
new file mode 100644
index 0000000..ddc3afb
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/HistoryTrackingConnectionDirectory.java
@@ -0,0 +1,96 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc;
+
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.auth.jdbc.connection.ConnectionRecordMapper;
+import org.apache.guacamole.net.auth.Connection;
+import org.apache.guacamole.net.auth.DecoratingDirectory;
+import org.apache.guacamole.net.auth.Directory;
+import org.apache.guacamole.net.auth.User;
+
+/**
+ * A connection directory that returns HistoryTrackingConnection-wrapped connections
+ * when queried.
+ */
+public class HistoryTrackingConnectionDirectory extends DecoratingDirectory {
+
+ /**
+ * The connection record mapper to use when writing history entries for
+ * established connections.
+ */
+ private final ConnectionRecordMapper connectionRecordMapper;
+
+ /**
+ * The user that directory operations are being performed for.
+ */
+ private final User user;
+
+ /**
+ * The remote host that the user connected from.
+ */
+ private final String remoteHost;
+
+ /**
+ * Create a new history tracking connection directory. Any connection retrieved from this
+ * directory will be wrapped in a HistoryTrackingConnection, enabling connection history
+ * records to be written with the provided connection record mapper.
+ *
+ * @param directory
+ * The connection directory to wrap.
+ *
+ * @param user
+ * The user associated with the connection directory.
+ *
+ * @param remoteHost
+ * The remote host that the user connected from.
+ *
+ * @param connectionRecordMapper
+ * The connection record mapper that will be used to write the connection history records.
+ */
+ public HistoryTrackingConnectionDirectory(Directory directory, User user, String remoteHost, ConnectionRecordMapper connectionRecordMapper) {
+ super(directory);
+
+ this.user = user;
+ this.remoteHost = remoteHost;
+ this.connectionRecordMapper = connectionRecordMapper;
+ }
+
+ @Override
+ protected Connection decorate(Connection connection) throws GuacamoleException {
+
+ // Wrap the connection in a history-tracking layer
+ return new HistoryTrackingConnection(
+ this.user, this.remoteHost, connection, this.connectionRecordMapper);
+ }
+
+ @Override
+ protected Connection undecorate(Connection connection) throws GuacamoleException {
+
+ // If the connection was wrapped, unwrap it
+ if (connection instanceof HistoryTrackingConnection) {
+ return ((HistoryTrackingConnection) connection).getWrappedConnection();
+ }
+
+ // Otherwise, return the unwrapped connection directly
+ return connection;
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/HistoryTrackingTunnel.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/HistoryTrackingTunnel.java
new file mode 100644
index 0000000..aeccc3a
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/HistoryTrackingTunnel.java
@@ -0,0 +1,81 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc;
+
+import java.util.Date;
+
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.auth.jdbc.connection.ConnectionRecordMapper;
+import org.apache.guacamole.auth.jdbc.connection.ConnectionRecordModel;
+import org.apache.guacamole.net.DelegatingGuacamoleTunnel;
+import org.apache.guacamole.net.GuacamoleTunnel;
+
+/**
+ * Tunnel implementation which automatically writes an end date for the
+ * provided connection history record model using the provided connection
+ * history mapper, when the tunnel is closed.
+ */
+public class HistoryTrackingTunnel extends DelegatingGuacamoleTunnel {
+
+ /**
+ * The connection for which this tunnel was established.
+ */
+ private final ConnectionRecordMapper connectionRecordMapper;
+
+ /**
+ * The user for which this tunnel was established.
+ */
+ private final ConnectionRecordModel connectionRecordModel;
+
+ /**
+ * Creates a new HistoryTrackingTunnel that wraps the given tunnel,
+ * automatically setting the end date for the provided connection history records,
+ * using the provided connection history record mapper.
+ *
+ * @param tunnel
+ * The tunnel to wrap.
+ *
+ * @param connectionRecordMapper
+ * The mapper to use when writing connection history records.
+ *
+ * @param connectionRecordModel
+ * The connection history record model representing the in-progress connection.
+ */
+ public HistoryTrackingTunnel(GuacamoleTunnel tunnel,
+ ConnectionRecordMapper connectionRecordMapper, ConnectionRecordModel connectionRecordModel) {
+
+ super(tunnel);
+
+ // Store the connection record mapper and model for history tracking
+ this.connectionRecordMapper = connectionRecordMapper;
+ this.connectionRecordModel = connectionRecordModel;
+ }
+
+ @Override
+ public void close() throws GuacamoleException {
+
+ // Set the end date to complete the connection history record
+ this.connectionRecordModel.setEndDate(new Date());
+ this.connectionRecordMapper.updateEndDate(this.connectionRecordModel);
+
+ super.close();
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/HistoryTrackingUserContext.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/HistoryTrackingUserContext.java
new file mode 100644
index 0000000..2c13a7e
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/HistoryTrackingUserContext.java
@@ -0,0 +1,75 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc;
+
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.auth.jdbc.connection.ConnectionRecordMapper;
+import org.apache.guacamole.net.auth.Connection;
+import org.apache.guacamole.net.auth.DelegatingUserContext;
+import org.apache.guacamole.net.auth.Directory;
+import org.apache.guacamole.net.auth.UserContext;
+
+/**
+ * DelegatingUserContext implementation which writes connection history records
+ * when connections are established and closed.
+ */
+public class HistoryTrackingUserContext extends DelegatingUserContext {
+
+ /**
+ * The remote host that the user associated with the user context
+ * connected from.
+ */
+ private final String remoteHost;
+
+ /**
+ * The connection record mapper to use when writing history entries for
+ * established connections.
+ */
+ private final ConnectionRecordMapper connectionRecordMapper;
+
+ /**
+ * Creates a new HistoryTrackingUserContext which wraps the given
+ * UserContext, allowing for tracking of connection history external to
+ * this authentication provider.
+ *
+ * @param userContext
+ * The UserContext to wrap.
+ *
+ * @param remoteHost
+ * The host that the user associated with the given user context connected from.
+ *
+ * @param connectionRecordMapper
+ * The mapper to use when writing connection history entries to the DB.
+ */
+ public HistoryTrackingUserContext(UserContext userContext, String remoteHost, ConnectionRecordMapper connectionRecordMapper) {
+ super(userContext);
+
+ this.remoteHost = remoteHost;
+ this.connectionRecordMapper = connectionRecordMapper;
+ }
+
+ @Override
+ public Directory getConnectionDirectory() throws GuacamoleException {
+ return new HistoryTrackingConnectionDirectory(
+ super.getConnectionDirectory(), self(),
+ this.remoteHost, this.connectionRecordMapper);
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/InjectedAuthenticationProvider.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/InjectedAuthenticationProvider.java
new file mode 100644
index 0000000..8ae2eea
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/InjectedAuthenticationProvider.java
@@ -0,0 +1,101 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc;
+
+import com.google.inject.Injector;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.net.auth.AbstractAuthenticationProvider;
+import org.apache.guacamole.net.auth.Credentials;
+import org.apache.guacamole.net.auth.UserContext;
+import org.apache.guacamole.net.auth.AuthenticatedUser;
+
+/**
+ * Provides a base implementation of an AuthenticationProvider which delegates
+ * the various function calls to an underlying AuthenticationProviderService
+ * implementation. As such a service is injectable by Guice, this provides a
+ * means for Guice to (effectively) apply dependency injection to an
+ * AuthenticationProvider, even though it is the AuthenticationProvider that
+ * serves as the entry point.
+ */
+public abstract class InjectedAuthenticationProvider extends AbstractAuthenticationProvider {
+
+ /**
+ * The AuthenticationProviderService to which all AuthenticationProvider
+ * calls will be delegated.
+ */
+ private final AuthenticationProviderService authProviderService;
+
+ /**
+ * Creates a new AuthenticationProvider that delegates all calls to an
+ * underlying AuthenticationProviderService. The behavior of the
+ * AuthenticationProvider is defined by the given
+ * AuthenticationProviderService implementation, which will be injected by
+ * the Guice Injector provided by the given JDBCInjectorProvider.
+ *
+ * @param injectorProvider
+ * A JDBCInjectorProvider instance which provides singleton instances
+ * of a Guice Injector, pre-configured to set up all injections and
+ * access to the underlying database via MyBatis.
+ *
+ * @param authProviderServiceClass
+ * The AuthenticationProviderService implementation which defines the
+ * behavior of this AuthenticationProvider.
+ *
+ * @throws GuacamoleException
+ * If the Injector cannot be created due to an error.
+ */
+ public InjectedAuthenticationProvider(JDBCInjectorProvider injectorProvider,
+ Class authProviderServiceClass)
+ throws GuacamoleException {
+
+ Injector injector = injectorProvider.get();
+ authProviderService = injector.getInstance(authProviderServiceClass);
+
+ }
+
+ @Override
+ public AuthenticatedUser authenticateUser(Credentials credentials)
+ throws GuacamoleException {
+ return authProviderService.authenticateUser(this, credentials);
+ }
+
+ @Override
+ public UserContext getUserContext(AuthenticatedUser authenticatedUser)
+ throws GuacamoleException {
+ return authProviderService.getUserContext(this, authenticatedUser);
+ }
+
+ @Override
+ public UserContext updateUserContext(UserContext context,
+ AuthenticatedUser authenticatedUser, Credentials credentials)
+ throws GuacamoleException {
+ return authProviderService.updateUserContext(this, context,
+ authenticatedUser, credentials);
+ }
+
+ @Override
+ public UserContext decorate(UserContext context,
+ AuthenticatedUser authenticatedUser, Credentials credentials)
+ throws GuacamoleException {
+ return authProviderService.decorateUserContext(this, context,
+ authenticatedUser, credentials);
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/JDBCAuthenticationProviderModule.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/JDBCAuthenticationProviderModule.java
new file mode 100644
index 0000000..1b361e5
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/JDBCAuthenticationProviderModule.java
@@ -0,0 +1,209 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc;
+
+import com.google.inject.Scopes;
+import javax.sql.DataSource;
+import org.apache.guacamole.auth.jdbc.user.ModeledUserContext;
+import org.apache.guacamole.auth.jdbc.connectiongroup.RootConnectionGroup;
+import org.apache.guacamole.auth.jdbc.connectiongroup.ModeledConnectionGroup;
+import org.apache.guacamole.auth.jdbc.connectiongroup.ConnectionGroupDirectory;
+import org.apache.guacamole.auth.jdbc.connection.ConnectionDirectory;
+import org.apache.guacamole.auth.jdbc.connection.ModeledGuacamoleConfiguration;
+import org.apache.guacamole.auth.jdbc.connection.ModeledConnection;
+import org.apache.guacamole.auth.jdbc.permission.SystemPermissionSet;
+import org.apache.guacamole.auth.jdbc.user.ModeledUser;
+import org.apache.guacamole.auth.jdbc.user.UserDirectory;
+import org.apache.guacamole.auth.jdbc.connectiongroup.ConnectionGroupMapper;
+import org.apache.guacamole.auth.jdbc.connection.ConnectionMapper;
+import org.apache.guacamole.auth.jdbc.connection.ConnectionRecordMapper;
+import org.apache.guacamole.auth.jdbc.permission.SystemPermissionMapper;
+import org.apache.guacamole.auth.jdbc.user.UserMapper;
+import org.apache.guacamole.auth.jdbc.connectiongroup.ConnectionGroupService;
+import org.apache.guacamole.auth.jdbc.connection.ConnectionService;
+import org.apache.guacamole.auth.jdbc.tunnel.GuacamoleTunnelService;
+import org.apache.guacamole.auth.jdbc.security.PasswordEncryptionService;
+import org.apache.guacamole.auth.jdbc.security.SHA256PasswordEncryptionService;
+import org.apache.guacamole.auth.jdbc.security.SaltService;
+import org.apache.guacamole.auth.jdbc.security.SecureRandomSaltService;
+import org.apache.guacamole.auth.jdbc.permission.SystemPermissionService;
+import org.apache.guacamole.auth.jdbc.user.UserService;
+import org.apache.ibatis.session.ExecutorType;
+import org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory;
+import org.apache.guacamole.auth.jdbc.permission.ConnectionGroupPermissionMapper;
+import org.apache.guacamole.auth.jdbc.permission.ConnectionGroupPermissionService;
+import org.apache.guacamole.auth.jdbc.permission.ConnectionGroupPermissionSet;
+import org.apache.guacamole.auth.jdbc.permission.ConnectionPermissionMapper;
+import org.apache.guacamole.auth.jdbc.permission.ConnectionPermissionService;
+import org.apache.guacamole.auth.jdbc.permission.ConnectionPermissionSet;
+import org.apache.guacamole.auth.jdbc.permission.UserPermissionMapper;
+import org.apache.guacamole.auth.jdbc.permission.UserPermissionService;
+import org.apache.guacamole.auth.jdbc.permission.UserPermissionSet;
+import org.apache.guacamole.auth.jdbc.activeconnection.ActiveConnectionDirectory;
+import org.apache.guacamole.auth.jdbc.activeconnection.ActiveConnectionPermissionService;
+import org.apache.guacamole.auth.jdbc.activeconnection.ActiveConnectionPermissionSet;
+import org.apache.guacamole.auth.jdbc.activeconnection.ActiveConnectionService;
+import org.apache.guacamole.auth.jdbc.activeconnection.TrackedActiveConnection;
+import org.apache.guacamole.auth.jdbc.base.EntityMapper;
+import org.apache.guacamole.auth.jdbc.base.EntityService;
+import org.apache.guacamole.auth.jdbc.connection.ConnectionParameterMapper;
+import org.apache.guacamole.auth.jdbc.permission.SharingProfilePermissionMapper;
+import org.apache.guacamole.auth.jdbc.permission.SharingProfilePermissionService;
+import org.apache.guacamole.auth.jdbc.permission.SharingProfilePermissionSet;
+import org.apache.guacamole.auth.jdbc.permission.UserGroupPermissionMapper;
+import org.apache.guacamole.auth.jdbc.permission.UserGroupPermissionService;
+import org.apache.guacamole.auth.jdbc.permission.UserGroupPermissionSet;
+import org.apache.guacamole.auth.jdbc.security.PasswordPolicyService;
+import org.apache.guacamole.auth.jdbc.sharing.ConnectionSharingService;
+import org.apache.guacamole.auth.jdbc.sharing.HashSharedConnectionMap;
+import org.apache.guacamole.auth.jdbc.sharing.SecureRandomShareKeyGenerator;
+import org.apache.guacamole.auth.jdbc.sharing.ShareKeyGenerator;
+import org.apache.guacamole.auth.jdbc.sharing.SharedConnectionMap;
+import org.apache.guacamole.auth.jdbc.sharingprofile.ModeledSharingProfile;
+import org.apache.guacamole.auth.jdbc.sharingprofile.SharingProfileDirectory;
+import org.apache.guacamole.auth.jdbc.sharingprofile.SharingProfileMapper;
+import org.apache.guacamole.auth.jdbc.sharingprofile.SharingProfileParameterMapper;
+import org.apache.guacamole.auth.jdbc.sharingprofile.SharingProfileService;
+import org.apache.guacamole.auth.jdbc.tunnel.RestrictedGuacamoleTunnelService;
+import org.apache.guacamole.auth.jdbc.user.PasswordRecordMapper;
+import org.apache.guacamole.auth.jdbc.user.UserRecordMapper;
+import org.apache.guacamole.auth.jdbc.usergroup.ModeledUserGroup;
+import org.apache.guacamole.auth.jdbc.usergroup.UserGroupDirectory;
+import org.apache.guacamole.auth.jdbc.usergroup.UserGroupMapper;
+import org.apache.guacamole.auth.jdbc.usergroup.UserGroupMemberUserGroupMapper;
+import org.apache.guacamole.auth.jdbc.usergroup.UserGroupMemberUserMapper;
+import org.apache.guacamole.auth.jdbc.usergroup.UserGroupParentUserGroupMapper;
+import org.apache.guacamole.auth.jdbc.usergroup.UserGroupService;
+import org.mybatis.guice.MyBatisModule;
+import org.apache.guacamole.auth.jdbc.user.UserParentUserGroupMapper;
+
+/**
+ * Guice module which configures the injections used by the JDBC authentication
+ * provider base. This module MUST be included in the Guice injector, or
+ * authentication providers based on JDBC will not function.
+ */
+public class JDBCAuthenticationProviderModule extends MyBatisModule {
+
+ /**
+ * The environment of the Guacamole server.
+ */
+ private final JDBCEnvironment environment;
+
+ /**
+ * Creates a new JDBC authentication provider module that configures the
+ * various injected base classes using the given environment, and provides
+ * connections using the given socket service.
+ *
+ * @param environment
+ * The environment to use to configure injected classes.
+ */
+ public JDBCAuthenticationProviderModule(JDBCEnvironment environment) {
+ this.environment = environment;
+ }
+
+ @Override
+ protected void initialize() {
+
+ // Datasource
+ bind(DataSource.class).to(DynamicallyAuthenticatedDataSource.class);
+
+ // Transaction factory
+ bindTransactionFactoryType(JdbcTransactionFactory.class);
+
+ // Set the JDBC Auth provider to use batch execution if enabled
+ if (environment.shouldUseBatchExecutor())
+ bindConfigurationSetting(configuration -> {
+ configuration.setDefaultExecutorType(ExecutorType.BATCH);
+ });
+
+ // Add MyBatis mappers
+ addMapperClass(ConnectionMapper.class);
+ addMapperClass(ConnectionGroupMapper.class);
+ addMapperClass(ConnectionGroupPermissionMapper.class);
+ addMapperClass(ConnectionPermissionMapper.class);
+ addMapperClass(ConnectionRecordMapper.class);
+ addMapperClass(ConnectionParameterMapper.class);
+ addMapperClass(EntityMapper.class);
+ addMapperClass(PasswordRecordMapper.class);
+ addMapperClass(SystemPermissionMapper.class);
+ addMapperClass(SharingProfileMapper.class);
+ addMapperClass(SharingProfileParameterMapper.class);
+ addMapperClass(SharingProfilePermissionMapper.class);
+ addMapperClass(UserGroupMapper.class);
+ addMapperClass(UserGroupMemberUserGroupMapper.class);
+ addMapperClass(UserGroupMemberUserMapper.class);
+ addMapperClass(UserGroupParentUserGroupMapper.class);
+ addMapperClass(UserGroupPermissionMapper.class);
+ addMapperClass(UserMapper.class);
+ addMapperClass(UserParentUserGroupMapper.class);
+ addMapperClass(UserPermissionMapper.class);
+ addMapperClass(UserRecordMapper.class);
+
+ // Bind core implementations of guacamole-ext classes
+ bind(ActiveConnectionDirectory.class);
+ bind(ActiveConnectionPermissionSet.class);
+ bind(JDBCEnvironment.class).toInstance(environment);
+ bind(ConnectionDirectory.class);
+ bind(ConnectionGroupDirectory.class);
+ bind(ConnectionGroupPermissionSet.class);
+ bind(ConnectionPermissionSet.class);
+ bind(ModeledConnection.class);
+ bind(ModeledConnectionGroup.class);
+ bind(ModeledGuacamoleConfiguration.class);
+ bind(ModeledSharingProfile.class);
+ bind(ModeledUser.class);
+ bind(ModeledUserContext.class);
+ bind(ModeledUserGroup.class);
+ bind(RootConnectionGroup.class);
+ bind(SharingProfileDirectory.class);
+ bind(SharingProfilePermissionSet.class);
+ bind(SystemPermissionSet.class);
+ bind(TrackedActiveConnection.class);
+ bind(UserDirectory.class);
+ bind(UserGroupDirectory.class);
+ bind(UserGroupPermissionSet.class);
+ bind(UserPermissionSet.class);
+
+ // Bind services
+ bind(ActiveConnectionService.class);
+ bind(ActiveConnectionPermissionService.class);
+ bind(ConnectionGroupPermissionService.class);
+ bind(ConnectionGroupService.class);
+ bind(ConnectionPermissionService.class);
+ bind(ConnectionSharingService.class);
+ bind(ConnectionService.class);
+ bind(EntityService.class);
+ bind(GuacamoleTunnelService.class).to(RestrictedGuacamoleTunnelService.class);
+ bind(PasswordEncryptionService.class).to(SHA256PasswordEncryptionService.class);
+ bind(PasswordPolicyService.class);
+ bind(SaltService.class).to(SecureRandomSaltService.class);
+ bind(SharedConnectionMap.class).to(HashSharedConnectionMap.class).in(Scopes.SINGLETON);
+ bind(ShareKeyGenerator.class).to(SecureRandomShareKeyGenerator.class).in(Scopes.SINGLETON);
+ bind(SharingProfilePermissionService.class);
+ bind(SharingProfileService.class);
+ bind(SystemPermissionService.class);
+ bind(UserGroupService.class);
+ bind(UserGroupPermissionService.class);
+ bind(UserPermissionService.class);
+ bind(UserService.class);
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/JDBCAuthenticationProviderService.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/JDBCAuthenticationProviderService.java
new file mode 100644
index 0000000..2b130b6
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/JDBCAuthenticationProviderService.java
@@ -0,0 +1,186 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc;
+
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.auth.jdbc.connection.ConnectionRecordMapper;
+import org.apache.guacamole.auth.jdbc.security.PasswordPolicyService;
+import org.apache.guacamole.auth.jdbc.sharing.user.SharedAuthenticatedUser;
+import org.apache.guacamole.auth.jdbc.user.ModeledAuthenticatedUser;
+import org.apache.guacamole.auth.jdbc.user.ModeledUser;
+import org.apache.guacamole.auth.jdbc.user.ModeledUserContext;
+import org.apache.guacamole.auth.jdbc.user.PrivilegedModeledAuthenticatedUser;
+import org.apache.guacamole.auth.jdbc.user.UserService;
+import org.apache.guacamole.language.TranslatableGuacamoleClientException;
+import org.apache.guacamole.net.auth.AuthenticatedUser;
+import org.apache.guacamole.net.auth.AuthenticationProvider;
+import org.apache.guacamole.net.auth.Credentials;
+import org.apache.guacamole.net.auth.UserContext;
+import org.apache.guacamole.net.auth.credentials.CredentialsInfo;
+import org.apache.guacamole.net.auth.credentials.GuacamoleInvalidCredentialsException;
+
+/**
+ * AuthenticationProviderService implementation which authenticates users with
+ * a username/password pair, producing new UserContext objects which are backed
+ * by an underlying, arbitrary database.
+ */
+public class JDBCAuthenticationProviderService implements AuthenticationProviderService {
+
+ /**
+ * The environment of the Guacamole server.
+ */
+ @Inject
+ private JDBCEnvironment environment;
+
+ /**
+ * Service for accessing users.
+ */
+ @Inject
+ private UserService userService;
+
+ /**
+ * Service for enforcing password complexity policies.
+ */
+ @Inject
+ private PasswordPolicyService passwordPolicyService;
+
+ /**
+ * Provider for retrieving UserContext instances.
+ */
+ @Inject
+ private Provider userContextProvider;
+
+ /**
+ * Mapper for writing connection history.
+ */
+ @Inject
+ private ConnectionRecordMapper connectionRecordMapper;
+
+ @Override
+ public AuthenticatedUser authenticateUser(AuthenticationProvider authenticationProvider,
+ Credentials credentials) throws GuacamoleException {
+
+ // Authenticate user
+ AuthenticatedUser user = userService.retrieveAuthenticatedUser(authenticationProvider, credentials);
+ if (user != null)
+ return user;
+
+ // Otherwise, unauthorized
+ throw new GuacamoleInvalidCredentialsException("Invalid login", CredentialsInfo.USERNAME_PASSWORD);
+
+ }
+
+ @Override
+ public ModeledUserContext getUserContext(AuthenticationProvider authenticationProvider,
+ AuthenticatedUser authenticatedUser) throws GuacamoleException {
+
+ // Always allow but provide no data for users authenticated via our own
+ // connection sharing links
+ if (authenticatedUser instanceof SharedAuthenticatedUser)
+ return null;
+
+ // Set semantic flags based on context
+ boolean databaseCredentialsUsed = (authenticatedUser instanceof ModeledAuthenticatedUser);
+ boolean databaseRestrictionsApplicable = (databaseCredentialsUsed || environment.isUserRequired());
+
+ // Retrieve user account for already-authenticated user
+ ModeledUser user = userService.retrieveUser(authenticationProvider, authenticatedUser);
+ ModeledUserContext context = userContextProvider.get();
+ if (user != null && !user.isDisabled()) {
+
+ // Enforce applicable account restrictions
+ if (databaseRestrictionsApplicable) {
+
+ // Verify user account is still valid as of today
+ if (!user.isAccountValid())
+ throw new TranslatableGuacamoleClientException("User "
+ + "account is no longer valid.",
+ "LOGIN.ERROR_NOT_VALID");
+
+ // Verify user account is allowed to be used at the current time
+ if (!user.isAccountAccessible())
+ throw new TranslatableGuacamoleClientException("User "
+ + "account may not be used at this time.",
+ "LOGIN.ERROR_NOT_ACCESSIBLE");
+
+ }
+
+ // Update password if password is expired AND the password was
+ // actually involved in the authentication process
+ if (databaseCredentialsUsed) {
+ if (user.isExpired() || passwordPolicyService.isPasswordExpired(user))
+ userService.resetExpiredPassword(user, authenticatedUser.getCredentials());
+ }
+
+ }
+
+ // If no user account is found, and database-specific account
+ // restrictions do not apply, get a skeleton user.
+ else if (!databaseRestrictionsApplicable) {
+ user = userService.retrieveSkeletonUser(authenticationProvider, authenticatedUser);
+
+ // If auto account creation is enabled, add user to DB.
+ if (environment.autoCreateAbsentAccounts()) {
+ ModeledUser createdUser = userService.createObject(new PrivilegedModeledAuthenticatedUser(user.getCurrentUser()), user);
+ user.setModel(createdUser.getModel());
+ }
+
+ }
+
+ // Veto authentication result only if database-specific account
+ // restrictions apply in this situation
+ else
+ throw new GuacamoleInvalidCredentialsException("Invalid login",
+ CredentialsInfo.USERNAME_PASSWORD);
+
+ // Initialize the UserContext with the user account and return it.
+ context.init(user.getCurrentUser());
+ context.recordUserLogin();
+ return context;
+
+ }
+
+ @Override
+ public UserContext updateUserContext(AuthenticationProvider authenticationProvider,
+ UserContext context, AuthenticatedUser authenticatedUser,
+ Credentials credentials) throws GuacamoleException {
+
+ // Refresh the user context
+ return getUserContext(authenticationProvider, authenticatedUser);
+
+ }
+
+ @Override
+ public UserContext decorateUserContext(AuthenticationProvider authenticationProvider,
+ UserContext context, AuthenticatedUser authenticatedUser,
+ Credentials credentials) throws GuacamoleException {
+
+ // Track connection history only for external connections, and only if enabled in the config
+ if (environment.trackExternalConnectionHistory() && context.getAuthenticationProvider() != authenticationProvider) {
+ return new HistoryTrackingUserContext(context, credentials.getRemoteHostname(), connectionRecordMapper);
+ }
+
+ return context;
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/JDBCEnvironment.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/JDBCEnvironment.java
new file mode 100644
index 0000000..27f3d05
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/JDBCEnvironment.java
@@ -0,0 +1,275 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc;
+
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.auth.jdbc.security.PasswordPolicy;
+import org.apache.guacamole.environment.DelegatingEnvironment;
+import org.apache.guacamole.environment.LocalEnvironment;
+import org.apache.ibatis.session.SqlSession;
+
+/**
+ * A JDBC-specific implementation of Environment that defines generic properties
+ * intended for use within JDBC based authentication providers.
+ */
+public abstract class JDBCEnvironment extends DelegatingEnvironment {
+
+ /**
+ * Constructs a new JDBCEnvironment using an underlying LocalEnviroment to
+ * read properties from the file system.
+ */
+ public JDBCEnvironment() {
+ super(LocalEnvironment.getInstance());
+ }
+
+ /**
+ * Returns whether a database user account is required for authentication to
+ * succeed, even if another authentication provider has already
+ * authenticated the user.
+ *
+ * @return
+ * true if database user accounts are required for absolutely all
+ * authentication attempts, false otherwise.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while retrieving the property.
+ */
+ public abstract boolean isUserRequired() throws GuacamoleException;
+
+ /**
+ * Returns the maximum number of concurrent connections to allow overall.
+ * As this limit applies globally (independent of which connection is in
+ * use or which user is using it), this setting cannot be overridden at the
+ * connection level. Zero denotes unlimited.
+ *
+ * @return
+ * The maximum allowable number of concurrent connections.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while retrieving the property.
+ */
+ public abstract int getAbsoluteMaxConnections() throws GuacamoleException;
+
+ /**
+ * Returns the maximum number of identifiers/parameters to be
+ * included in a single batch when executing SQL statements.
+ *
+ * @return
+ * The maximum number of identifiers/parameters to be included
+ * in a single batch.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while retrieving the property.
+ */
+ public abstract int getBatchSize() throws GuacamoleException;
+
+ /**
+ * Returns the default maximum number of concurrent connections to allow to
+ * any one connection, unless specified differently on an individual
+ * connection. Zero denotes unlimited.
+ *
+ * @return
+ * The default maximum allowable number of concurrent connections
+ * to any connection.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while retrieving the property.
+ */
+ public abstract int getDefaultMaxConnections() throws GuacamoleException;
+
+ /**
+ * Returns the default maximum number of concurrent connections to allow to
+ * any one connection group, unless specified differently on an individual
+ * connection group. Zero denotes unlimited.
+ *
+ * @return
+ * The default maximum allowable number of concurrent connections
+ * to any connection group.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while retrieving the property.
+ */
+ public abstract int getDefaultMaxGroupConnections()
+ throws GuacamoleException;
+
+ /**
+ * Returns the default maximum number of concurrent connections to allow to
+ * any one connection by an individual user, unless specified differently on
+ * an individual connection. Zero denotes unlimited.
+ *
+ * @return
+ * The default maximum allowable number of concurrent connections to
+ * any connection by an individual user.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while retrieving the property.
+ */
+ public abstract int getDefaultMaxConnectionsPerUser()
+ throws GuacamoleException;
+
+ /**
+ * Returns the default maximum number of concurrent connections to allow to
+ * any one connection group by an individual user, unless specified
+ * differently on an individual connection group. Zero denotes unlimited.
+ *
+ * @return
+ * The default maximum allowable number of concurrent connections to
+ * any connection group by an individual user.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while retrieving the property.
+ */
+ public abstract int getDefaultMaxGroupConnectionsPerUser()
+ throws GuacamoleException;
+
+ /**
+ * Returns the policy which applies to newly-set passwords. Passwords which
+ * apply to Guacamole user accounts will be required to conform to this
+ * policy.
+ *
+ * @return
+ * The password policy which applies to Guacamole user accounts.
+ */
+ public abstract PasswordPolicy getPasswordPolicy();
+
+ /**
+ * Returns whether the database supports recursive queries. Many database
+ * engines support recursive queries through CTEs. If recursive queries are
+ * not supported, queries that are intended to be recursive may need to be
+ * invoked multiple times to retrieve the same data.
+ *
+ * @param session
+ * The SqlSession provided by MyBatis for the current transaction.
+ *
+ * @return
+ * true if the database supports recursive queries, false otherwise.
+ */
+ public abstract boolean isRecursiveQuerySupported(SqlSession session);
+
+ /**
+ * Returns a boolean value representing whether or not the JDBC module
+ * should automatically create accounts within the database for users that
+ * are successfully authenticated via other extensions. Returns true if
+ * accounts should be auto-created, otherwise returns false.
+ *
+ * @return
+ * true if user accounts should be automatically created within the
+ * database when authentication succeeds from another extension;
+ * otherwise false.
+ *
+ * @throws GuacamoleException
+ * If guacamole.properties cannot be parsed.
+ */
+ public abstract boolean autoCreateAbsentAccounts() throws GuacamoleException;
+
+ /**
+ * Returns the username that should be used when authenticating with the
+ * database containing the Guacamole authentication tables.
+ *
+ * @return
+ * The username for the database.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while retrieving the property value, or if the
+ * value was not set, as this property is required.
+ */
+ public abstract String getUsername() throws GuacamoleException;
+
+ /**
+ * Returns the password that should be used authenticating with the
+ * database containing the Guacamole authentication tables.
+ *
+ * @return
+ * The password for the database.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while retrieving the property value, or if the
+ * value was not set, as this property is required.
+ */
+ public abstract String getPassword() throws GuacamoleException;
+
+ /**
+ * Returns whether the given Java class is defined within the classpath.
+ *
+ * @param classname
+ * The name of the Java class to check.
+ *
+ * @return
+ * true if the given Java class is present within the classpath, false
+ * otherwise.
+ */
+ public static boolean isClassDefined(String classname) {
+ try {
+ Class.forName(classname, false, JDBCEnvironment.class.getClassLoader());
+ return true;
+ }
+ catch (ClassNotFoundException e) {
+ return false;
+ }
+ }
+
+ /**
+ * Returns a boolean value representing whether or not the JDBC module
+ * should automatically track connection history for external connections,
+ * i.e. connections not originated from within the JDBC auth provider
+ * itself.
+ *
+ * @return
+ * true if connection history should be tracked for connections that
+ * do not originate from within this JDBC auth provider, false otherwise.
+ *
+ * @throws GuacamoleException
+ * If guacamole.properties cannot be parsed.
+ */
+ public abstract boolean trackExternalConnectionHistory() throws GuacamoleException;
+
+ /**
+ * Returns a boolean value representing whether access time windows should
+ * be enforced for active connections - i.e. whether a currently-connected
+ * user should be disconnected upon the closure of an access window.
+ *
+ * @return
+ * true if a connected user should be disconnected upon an access time
+ * window closing, false otherwise.
+ *
+ * @throws GuacamoleException
+ * If guacamole.properties cannot be parsed.
+ */
+ public abstract boolean enforceAccessWindowsForActiveSessions() throws GuacamoleException;
+
+ /**
+ * Returns true if the JDBC batch executor should be used by default, false
+ * otherwise. The batch executor allows repeated updates to be batched
+ * together for improved performance.
+ * See https://mybatis.org/mybatis-3/java-api.html#sqlSessions
+ *
+ * @return
+ * true if the batch executor should be used by default, false otherwise.
+ */
+ public boolean shouldUseBatchExecutor() {
+
+ // Unless otherwise overwritten due to implementation-specific problems,
+ // all JDBC extensions should use the batch executor if possible to
+ // ensure the best performance for repetitive queries
+ return true;
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/JDBCInjectorProvider.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/JDBCInjectorProvider.java
new file mode 100644
index 0000000..ea005b3
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/JDBCInjectorProvider.java
@@ -0,0 +1,88 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc;
+
+import com.google.inject.Injector;
+import java.util.concurrent.atomic.AtomicReference;
+import org.apache.guacamole.GuacamoleException;
+
+/**
+ * A caching provider of singleton Guice Injector instances. The first call to
+ * get() will return a new instance of the Guice Injector, while all subsequent
+ * calls will return that same instance. It is up to implementations of this
+ * class to define how the Guice Injector will be created through defining the
+ * create() function.
+ *
+ * IMPORTANT: Because the Injector returned by get() is cached statically, only
+ * ONE implementation of this class may be used within any individual
+ * classloader. Within the context of the JDBC extension, as long as each built
+ * extension only provides one subclass of this class, things should work
+ * properly, as each extension is given its own classloader by Guacamole.
+ */
+public abstract class JDBCInjectorProvider {
+
+ /**
+ * An AtomicReference wrapping the cached Guice Injector. If the Injector
+ * has not yet been created, null will be wrapped instead.
+ */
+ private static final AtomicReference injector = new AtomicReference(null);
+
+ /**
+ * Creates a new instance of the Guice Injector which should be used
+ * across the entire JDBC authentication extension. This function will
+ * generally only be called once, but multiple invocations are possible if
+ * get() is invoked several times concurrently prior to the Injector being
+ * cached.
+ *
+ * @return
+ * @throws GuacamoleException
+ */
+ protected abstract Injector create() throws GuacamoleException;
+
+ /**
+ * Returns a common, singleton instance of a Guice Injector, configured for
+ * the injections required by the JDBC authentication extension. The result
+ * of the first call to this function will be cached statically within this
+ * class, and will be returned for all subsequent calls.
+ *
+ * @return
+ * A singleton instance of the Guice Injector used across the entire
+ * JDBC authentication extension.
+ *
+ * @throws GuacamoleException
+ * If the Injector cannot be created due to an error.
+ */
+ public Injector get() throws GuacamoleException {
+
+ // Return existing Injector if already created
+ Injector value = injector.get();
+ if (value != null)
+ return value;
+
+ // Explicitly create and store new Injector only if necessary
+ injector.compareAndSet(null, create());
+
+ // Consistently return the same Injector, even if two create operations
+ // happen concurrently
+ return injector.get();
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/ActiveConnectionDirectory.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/ActiveConnectionDirectory.java
new file mode 100644
index 0000000..28510b7
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/ActiveConnectionDirectory.java
@@ -0,0 +1,76 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.activeconnection;
+
+
+import com.google.inject.Inject;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Set;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.auth.jdbc.base.JDBCDirectory;
+import org.apache.guacamole.net.auth.ActiveConnection;
+
+/**
+ * Implementation of a Directory which contains all currently-active
+ * connections.
+ */
+public class ActiveConnectionDirectory extends JDBCDirectory {
+
+ /**
+ * Service for retrieving and manipulating active connections.
+ */
+ @Inject
+ private ActiveConnectionService activeConnectionService;
+
+ @Override
+ public ActiveConnection get(String identifier) throws GuacamoleException {
+ return activeConnectionService.retrieveObject(getCurrentUser(), identifier);
+ }
+
+ @Override
+ public Collection getAll(Collection identifiers)
+ throws GuacamoleException {
+ Collection objects = activeConnectionService.retrieveObjects(getCurrentUser(), identifiers);
+ return Collections.unmodifiableCollection(objects);
+ }
+
+ @Override
+ public Set getIdentifiers() throws GuacamoleException {
+ return activeConnectionService.getIdentifiers(getCurrentUser());
+ }
+
+ @Override
+ public void add(ActiveConnection object) throws GuacamoleException {
+ activeConnectionService.createObject(getCurrentUser(), object);
+ }
+
+ @Override
+ public void update(ActiveConnection object) throws GuacamoleException {
+ TrackedActiveConnection connection = (TrackedActiveConnection) object;
+ activeConnectionService.updateObject(getCurrentUser(), connection);
+ }
+
+ @Override
+ public void remove(String identifier) throws GuacamoleException {
+ activeConnectionService.deleteObject(getCurrentUser(), identifier);
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/ActiveConnectionPermissionService.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/ActiveConnectionPermissionService.java
new file mode 100644
index 0000000..2a4cd9e
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/ActiveConnectionPermissionService.java
@@ -0,0 +1,178 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.activeconnection;
+
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.Set;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.GuacamoleSecurityException;
+import org.apache.guacamole.auth.jdbc.base.EntityModel;
+import org.apache.guacamole.auth.jdbc.base.ModeledPermissions;
+import org.apache.guacamole.auth.jdbc.permission.AbstractPermissionService;
+import org.apache.guacamole.auth.jdbc.permission.ObjectPermissionService;
+import org.apache.guacamole.auth.jdbc.tunnel.ActiveConnectionRecord;
+import org.apache.guacamole.auth.jdbc.tunnel.GuacamoleTunnelService;
+import org.apache.guacamole.auth.jdbc.user.ModeledAuthenticatedUser;
+import org.apache.guacamole.net.auth.permission.ObjectPermission;
+import org.apache.guacamole.net.auth.permission.ObjectPermissionSet;
+
+/**
+ * Service which provides convenience methods for creating, retrieving, and
+ * manipulating active connections.
+ */
+public class ActiveConnectionPermissionService
+ extends AbstractPermissionService
+ implements ObjectPermissionService {
+
+ /**
+ * Service for creating and tracking tunnels.
+ */
+ @Inject
+ private GuacamoleTunnelService tunnelService;
+
+ /**
+ * Provider for active connection permission sets.
+ */
+ @Inject
+ private Provider activeConnectionPermissionSetProvider;
+
+ @Override
+ public boolean hasPermission(ModeledAuthenticatedUser user,
+ ModeledPermissions targetEntity,
+ ObjectPermission.Type type, String identifier,
+ Set effectiveGroups) throws GuacamoleException {
+
+ // Retrieve permissions
+ Set permissions = retrievePermissions(user,
+ targetEntity, effectiveGroups);
+
+ // Permission is granted if retrieved permissions contains the
+ // requested permission
+ ObjectPermission permission = new ObjectPermission(type, identifier);
+ return permissions.contains(permission);
+
+ }
+
+ @Override
+ public Set retrievePermissions(ModeledAuthenticatedUser user,
+ ModeledPermissions targetEntity,
+ Set effectiveGroups) throws GuacamoleException {
+
+ // Retrieve permissions only if allowed
+ if (canReadPermissions(user, targetEntity)) {
+
+ // Privileged accounts (such as administrators or UserContexts
+ // returned by getPrivileged()) may always access active connections
+ boolean isPrivileged = targetEntity.isPrivileged();
+
+ // Get all active connections
+ Collection records = tunnelService.getActiveConnections(user);
+
+ // We have READ, and possibly DELETE, on all active connections
+ Set permissions = new HashSet<>();
+ for (ActiveConnectionRecord record : records) {
+
+ // Add implicit READ
+ String identifier = record.getUUID().toString();
+ permissions.add(new ObjectPermission(ObjectPermission.Type.READ, identifier));
+
+ // If the target user is privileged, or the connection belongs
+ // to the target user, then they can DELETE
+ if (isPrivileged || targetEntity.isUser(record.getUsername()))
+ permissions.add(new ObjectPermission(ObjectPermission.Type.DELETE, identifier));
+
+ }
+
+ return permissions;
+
+ }
+
+ throw new GuacamoleSecurityException("Permission denied.");
+
+ }
+
+ @Override
+ public Collection retrieveAccessibleIdentifiers(ModeledAuthenticatedUser user,
+ ModeledPermissions targetEntity,
+ Collection permissionTypes,
+ Collection identifiers, Set effectiveGroups)
+ throws GuacamoleException {
+
+ Set permissions = retrievePermissions(user, targetEntity, effectiveGroups);
+ Collection accessibleObjects = new ArrayList(permissions.size());
+
+ // For each identifier/permission combination
+ for (String identifier : identifiers) {
+ for (ObjectPermission.Type permissionType : permissionTypes) {
+
+ // Add identifier if at least one requested permission is granted
+ ObjectPermission permission = new ObjectPermission(permissionType, identifier);
+ if (permissions.contains(permission)) {
+ accessibleObjects.add(identifier);
+ break;
+ }
+
+ }
+ }
+
+ return accessibleObjects;
+
+ }
+
+ @Override
+ public ObjectPermissionSet getPermissionSet(ModeledAuthenticatedUser user,
+ ModeledPermissions targetEntity,
+ Set effectiveGroups) throws GuacamoleException {
+
+ // Create permission set for requested entity
+ ActiveConnectionPermissionSet permissionSet = activeConnectionPermissionSetProvider.get();
+ permissionSet.init(user, targetEntity, effectiveGroups);
+
+ return permissionSet;
+
+ }
+
+ @Override
+ public void createPermissions(ModeledAuthenticatedUser user,
+ ModeledPermissions targetEntity,
+ Collection permissions)
+ throws GuacamoleException {
+
+ // Creating active connection permissions is not implemented
+ throw new GuacamoleSecurityException("Permission denied.");
+
+ }
+
+ @Override
+ public void deletePermissions(ModeledAuthenticatedUser user,
+ ModeledPermissions targetEntity,
+ Collection permissions)
+ throws GuacamoleException {
+
+ // Deleting active connection permissions is not implemented
+ throw new GuacamoleSecurityException("Permission denied.");
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/ActiveConnectionPermissionSet.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/ActiveConnectionPermissionSet.java
new file mode 100644
index 0000000..5f5b9a4
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/ActiveConnectionPermissionSet.java
@@ -0,0 +1,43 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.activeconnection;
+
+import com.google.inject.Inject;
+import org.apache.guacamole.auth.jdbc.permission.ObjectPermissionService;
+import org.apache.guacamole.auth.jdbc.permission.ObjectPermissionSet;
+
+/**
+ * An implementation of ObjectPermissionSet which uses an injected service to
+ * query and manipulate the permissions associated with active connections.
+ */
+public class ActiveConnectionPermissionSet extends ObjectPermissionSet {
+
+ /**
+ * Service for querying and manipulating active connection permissions.
+ */
+ @Inject
+ private ActiveConnectionPermissionService activeConnectionPermissionService;
+
+ @Override
+ protected ObjectPermissionService getObjectPermissionService() {
+ return activeConnectionPermissionService;
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/ActiveConnectionService.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/ActiveConnectionService.java
new file mode 100644
index 0000000..046cee1
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/ActiveConnectionService.java
@@ -0,0 +1,219 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.activeconnection;
+
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Set;
+import org.apache.guacamole.auth.jdbc.user.ModeledAuthenticatedUser;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.GuacamoleSecurityException;
+import org.apache.guacamole.auth.jdbc.base.DirectoryObjectService;
+import org.apache.guacamole.auth.jdbc.tunnel.ActiveConnectionRecord;
+import org.apache.guacamole.auth.jdbc.tunnel.GuacamoleTunnelService;
+import org.apache.guacamole.net.GuacamoleTunnel;
+import org.apache.guacamole.net.auth.ActiveConnection;
+import org.apache.guacamole.net.auth.permission.ObjectPermission;
+import org.apache.guacamole.net.auth.permission.ObjectPermissionSet;
+
+/**
+ * Service which provides convenience methods for creating, retrieving, and
+ * manipulating active connections.
+ */
+public class ActiveConnectionService
+ implements DirectoryObjectService {
+
+ /**
+ * Service for creating and tracking tunnels.
+ */
+ @Inject
+ private GuacamoleTunnelService tunnelService;
+
+ /**
+ * Provider for active connections.
+ */
+ @Inject
+ private Provider trackedActiveConnectionProvider;
+
+ @Override
+ public TrackedActiveConnection retrieveObject(ModeledAuthenticatedUser user,
+ String identifier) throws GuacamoleException {
+
+ // Pull objects having given identifier
+ Collection objects = retrieveObjects(user, Collections.singleton(identifier));
+
+ // If no such object, return null
+ if (objects.isEmpty())
+ return null;
+
+ // The object collection will have exactly one element unless the
+ // database has seriously lost integrity
+ assert(objects.size() == 1);
+
+ // Return first and only object
+ return objects.iterator().next();
+
+ }
+
+ @Override
+ public Collection retrieveObjects(ModeledAuthenticatedUser user,
+ Collection identifiers) throws GuacamoleException {
+
+ String username = user.getIdentifier();
+ boolean isPrivileged = user.isPrivileged();
+ Set identifierSet = new HashSet(identifiers);
+
+ // Retrieve all visible connections (permissions enforced by tunnel service)
+ Collection records = tunnelService.getActiveConnections(user);
+
+ // Restrict to subset of records which match given identifiers
+ Collection activeConnections = new ArrayList(identifiers.size());
+ for (ActiveConnectionRecord record : records) {
+
+ // The current user should have access to sensitive information and
+ // be able to connect to (join) the active connection if they are
+ // the user that started the connection OR the user is an admin
+ boolean hasPrivilegedAccess =
+ isPrivileged || username.equals(record.getUsername());
+
+ // Add connection if within requested identifiers
+ if (identifierSet.contains(record.getUUID().toString())) {
+ TrackedActiveConnection activeConnection = trackedActiveConnectionProvider.get();
+ activeConnection.init(user, record, hasPrivilegedAccess, hasPrivilegedAccess);
+ activeConnections.add(activeConnection);
+ }
+
+ }
+
+ return activeConnections;
+
+ }
+
+ @Override
+ public void deleteObject(ModeledAuthenticatedUser user, String identifier)
+ throws GuacamoleException {
+
+ // Close connection, if it exists and we have permission
+ ActiveConnection activeConnection = retrieveObject(user, identifier);
+ if (activeConnection == null)
+ return;
+
+ if (hasObjectPermissions(user, identifier, ObjectPermission.Type.DELETE)) {
+
+ // Close connection if not already closed
+ GuacamoleTunnel tunnel = activeConnection.getTunnel();
+ if (tunnel != null && tunnel.isOpen())
+ tunnel.close();
+
+ }
+ else
+ throw new GuacamoleSecurityException("Permission denied.");
+
+ }
+
+ @Override
+ public Set getIdentifiers(ModeledAuthenticatedUser user)
+ throws GuacamoleException {
+
+ // Retrieve all visible connections (permissions enforced by tunnel service)
+ Collection records = tunnelService.getActiveConnections(user);
+
+ // Build list of identifiers
+ Set identifiers = new HashSet(records.size());
+ for (ActiveConnectionRecord record : records)
+ identifiers.add(record.getUUID().toString());
+
+ return identifiers;
+
+ }
+
+ @Override
+ public TrackedActiveConnection createObject(ModeledAuthenticatedUser user,
+ ActiveConnection object) throws GuacamoleException {
+
+ // Updating active connections is not implemented
+ throw new GuacamoleSecurityException("Permission denied.");
+
+ }
+
+ @Override
+ public void updateObject(ModeledAuthenticatedUser user, TrackedActiveConnection object)
+ throws GuacamoleException {
+
+ // Updating active connections is not implemented
+ throw new GuacamoleSecurityException("Permission denied.");
+
+ }
+
+ /**
+ * Retrieve the permission set for the specified user that relates
+ * to access to active connections.
+ *
+ * @param user
+ * The user for which to retrieve the permission set.
+ *
+ * @return
+ * A permission set associated with the given user that specifies
+ * the permissions available for active connection objects.
+ *
+ * @throws GuacamoleException
+ * If permission to read permissions for the user is denied.
+ */
+ private ObjectPermissionSet getPermissionSet(ModeledAuthenticatedUser user)
+ throws GuacamoleException {
+ return user.getUser().getActiveConnectionPermissions();
+ }
+
+ /**
+ * Return a boolean value representing whether or not a user has the given
+ * permission available to them on the active connection with the given
+ * identifier.
+ *
+ * @param user
+ * The user for which the permissions are being queried.
+ *
+ * @param identifier
+ * The identifier of the active connection we are wondering about.
+ *
+ * @param type
+ * The type of permission being requested.
+ *
+ * @return
+ * True if the user has the necessary permission; otherwise false.
+ *
+ * @throws GuacamoleException
+ * If the user does not have access to read permissions.
+ */
+ private boolean hasObjectPermissions(ModeledAuthenticatedUser user,
+ String identifier, ObjectPermission.Type type)
+ throws GuacamoleException {
+
+ ObjectPermissionSet permissionSet = getPermissionSet(user);
+
+ return user.isPrivileged()
+ || permissionSet.hasPermission(type, identifier);
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/TrackedActiveConnection.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/TrackedActiveConnection.java
new file mode 100644
index 0000000..cdbcc07
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/TrackedActiveConnection.java
@@ -0,0 +1,284 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.activeconnection;
+
+import com.google.inject.Inject;
+import java.util.Date;
+import java.util.Map;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.GuacamoleSecurityException;
+import org.apache.guacamole.auth.jdbc.base.RestrictedObject;
+import org.apache.guacamole.auth.jdbc.connection.ModeledConnection;
+import org.apache.guacamole.auth.jdbc.sharing.ConnectionSharingService;
+import org.apache.guacamole.auth.jdbc.sharing.connection.SharedConnectionDefinition;
+import org.apache.guacamole.auth.jdbc.tunnel.ActiveConnectionRecord;
+import org.apache.guacamole.auth.jdbc.tunnel.GuacamoleTunnelService;
+import org.apache.guacamole.auth.jdbc.user.ModeledAuthenticatedUser;
+import org.apache.guacamole.net.GuacamoleTunnel;
+import org.apache.guacamole.net.auth.ActiveConnection;
+import org.apache.guacamole.net.auth.credentials.UserCredentials;
+import org.apache.guacamole.protocol.GuacamoleClientInformation;
+
+/**
+ * An implementation of the ActiveConnection object which has an associated
+ * ActiveConnectionRecord.
+ */
+public class TrackedActiveConnection extends RestrictedObject implements ActiveConnection {
+
+ /**
+ * Service for managing shared connections.
+ */
+ @Inject
+ private ConnectionSharingService sharingService;
+
+ /**
+ * Service for creating and tracking tunnels.
+ */
+ @Inject
+ private GuacamoleTunnelService tunnelService;
+
+ /**
+ * The identifier of this active connection.
+ */
+ private String identifier;
+
+ /**
+ * The actual connection record from which this ActiveConnection derives its
+ * data.
+ */
+ private ActiveConnectionRecord connectionRecord;
+
+ /**
+ * The connection being actively used or shared.
+ */
+ private ModeledConnection connection;
+
+ /**
+ * The identifier of the associated sharing profile.
+ */
+ private String sharingProfileIdentifier;
+
+ /**
+ * The date and time this active connection began.
+ */
+ private Date startDate;
+
+ /**
+ * The remote host that initiated this connection.
+ */
+ private String remoteHost;
+
+ /**
+ * The username of the user that initiated this connection.
+ */
+ private String username;
+
+ /**
+ * The underlying GuacamoleTunnel.
+ */
+ private GuacamoleTunnel tunnel;
+
+ /**
+ * Whether connections to this TrackedActiveConnection are allowed.
+ */
+ private boolean connectable;
+
+ /**
+ * Initializes this TrackedActiveConnection, copying the data associated
+ * with the given active connection record. At a minimum, the identifier
+ * of this active connection will be set, the start date, and the
+ * identifier of the associated connection will be copied. If requested,
+ * sensitive information like the associated username will be copied, as
+ * well.
+ *
+ * @param currentUser
+ * The user that created or retrieved this object.
+ *
+ * @param activeConnectionRecord
+ * The active connection record to copy.
+ *
+ * @param includeSensitiveInformation
+ * Whether sensitive data should be copied from the connection record
+ * as well. This includes the remote host, associated tunnel, and
+ * username.
+ *
+ * @param connectable
+ * Whether the user that retrieved this object should be allowed to
+ * join the active connection.
+ */
+ public void init(ModeledAuthenticatedUser currentUser,
+ ActiveConnectionRecord activeConnectionRecord,
+ boolean includeSensitiveInformation,
+ boolean connectable) {
+
+ super.init(currentUser);
+ this.connectionRecord = activeConnectionRecord;
+ this.connectable = connectable;
+
+ // Copy all non-sensitive data from given record
+ this.connection = activeConnectionRecord.getConnection();
+ this.sharingProfileIdentifier = activeConnectionRecord.getSharingProfileIdentifier();
+ this.identifier = activeConnectionRecord.getUUID().toString();
+ this.startDate = activeConnectionRecord.getStartDate();
+
+ // Include sensitive data, too, if requested
+ if (includeSensitiveInformation) {
+ this.remoteHost = activeConnectionRecord.getRemoteHost();
+ this.tunnel = activeConnectionRecord.getTunnel();
+ this.username = activeConnectionRecord.getUsername();
+ }
+
+ }
+
+ @Override
+ public String getIdentifier() {
+ return identifier;
+ }
+
+ @Override
+ public void setIdentifier(String identifier) {
+ this.identifier = identifier;
+ }
+
+ /**
+ * Returns the connection being actively used. If this active connection is
+ * not the primary connection, this will be the connection being actively
+ * shared.
+ *
+ * @return
+ * The connection being actively used.
+ */
+ public ModeledConnection getConnection() {
+ return connection;
+ }
+
+ @Override
+ public String getConnectionIdentifier() {
+ return connection.getIdentifier();
+ }
+
+ @Override
+ public void setConnectionIdentifier(String connnectionIdentifier) {
+ throw new UnsupportedOperationException("The connection identifier of "
+ + "TrackedActiveConnection is inherited from the underlying "
+ + "connection.");
+ }
+
+ @Override
+ public String getSharingProfileIdentifier() {
+ return sharingProfileIdentifier;
+ }
+
+ @Override
+ public void setSharingProfileIdentifier(String sharingProfileIdentifier) {
+ this.sharingProfileIdentifier = sharingProfileIdentifier;
+ }
+
+ /**
+ * Shares this active connection with the user that retrieved it, returning
+ * a SharedConnectionDefinition that can be used to establish a tunnel to
+ * the shared connection. If provided, access within the shared connection
+ * will be restricted by the sharing profile with the given identifier.
+ *
+ * @param identifier
+ * The identifier of the sharing profile that defines the restrictions
+ * applying to the shared connection, or null if no such restrictions
+ * apply.
+ *
+ * @return
+ * A new SharedConnectionDefinition which can be used to establish a
+ * tunnel to the shared connection.
+ *
+ * @throws GuacamoleException
+ * If permission to share this active connection is denied.
+ */
+ private SharedConnectionDefinition share(String identifier) throws GuacamoleException {
+ return sharingService.shareConnection(getCurrentUser(), connectionRecord, identifier);
+ }
+
+ @Override
+ public UserCredentials getSharingCredentials(String identifier)
+ throws GuacamoleException {
+ return sharingService.getSharingCredentials(share(identifier));
+ }
+
+ @Override
+ public Date getStartDate() {
+ return startDate;
+ }
+
+ @Override
+ public void setStartDate(Date startDate) {
+ this.startDate = startDate;
+ }
+
+ @Override
+ public String getRemoteHost() {
+ return remoteHost;
+ }
+
+ @Override
+ public void setRemoteHost(String remoteHost) {
+ this.remoteHost = remoteHost;
+ }
+
+ @Override
+ public String getUsername() {
+ return username;
+ }
+
+ @Override
+ public void setUsername(String username) {
+ this.username = username;
+ }
+
+ @Override
+ public GuacamoleTunnel getTunnel() {
+ return tunnel;
+ }
+
+ @Override
+ public void setTunnel(GuacamoleTunnel tunnel) {
+ this.tunnel = tunnel;
+ }
+
+ @Override
+ public boolean isConnectable() {
+ return connectable;
+ }
+
+ @Override
+ public GuacamoleTunnel connect(GuacamoleClientInformation info,
+ Map tokens) throws GuacamoleException {
+
+ // Establish connection only if connecting is allowed
+ if (isConnectable())
+ return tunnelService.getGuacamoleTunnel(getCurrentUser(), share(null), info, tokens);
+
+ throw new GuacamoleSecurityException("Permission denied.");
+
+ }
+
+ @Override
+ public int getActiveConnections() {
+ return 0;
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/package-info.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/package-info.java
new file mode 100644
index 0000000..098b34e
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * Classes related to currently-active connections.
+ */
+package org.apache.guacamole.auth.jdbc.activeconnection;
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ActivityRecordMapper.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ActivityRecordMapper.java
new file mode 100644
index 0000000..a860949
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ActivityRecordMapper.java
@@ -0,0 +1,163 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import java.util.Collection;
+import java.util.List;
+import org.apache.guacamole.auth.jdbc.user.UserModel;
+import org.apache.guacamole.properties.CaseSensitivity;
+import org.apache.ibatis.annotations.Param;
+
+/**
+ * Common interface for mapping activity records.
+ *
+ * @param
+ * The type of model object representing the activity records mapped by
+ * this mapper.
+ */
+public interface ActivityRecordMapper {
+
+ /**
+ * Inserts the given activity record.
+ *
+ * @param record
+ * The activity record to insert.
+ *
+ * @param caseSensitivity
+ * The object that contains current configuration for case sensitivity
+ * for usernames and group names.
+ *
+ * @return
+ * The number of rows inserted.
+ */
+ int insert(@Param("record") ModelType record,
+ @Param("caseSensitivity") CaseSensitivity caseSensitivity);
+
+ /**
+ * Updates the given activity record in the database, assigning an end
+ * date. No column of the existing activity record is updated except for
+ * the end date. If the record does not actually exist, this operation has
+ * no effect.
+ *
+ * @param record
+ * The activity record to update.
+ *
+ * @return
+ * The number of rows updated.
+ */
+ int updateEndDate(@Param("record") ModelType record);
+
+ /**
+ * Searches for up to limit activity records that contain
+ * the given terms, sorted by the given predicates, regardless of whether
+ * the data they are associated with is readable by any particular user.
+ * This should only be called on behalf of a system administrator. If
+ * records are needed by a non-administrative user who must have explicit
+ * read rights, use {@link searchReadable()} instead.
+ *
+ * @param identifier
+ * The optional identifier of the object whose history is being
+ * retrieved, or null if records related to any such object should be
+ * retrieved.
+ *
+ * @param recordIdentifier
+ * The identifier of the specific history record to retrieve, if not
+ * all matching records. Search terms, etc. will still be applied to
+ * the single record.
+ *
+ * @param terms
+ * The search terms that must match the returned records.
+ *
+ * @param sortPredicates
+ * A list of predicates to sort the returned records by, in order of
+ * priority.
+ *
+ * @param limit
+ * The maximum number of records that should be returned.
+ *
+ * @param caseSensitivity
+ * The object that contains current configuration for case sensitivity
+ * for usernames and group names.
+ *
+ * @return
+ * The results of the search performed with the given parameters.
+ */
+ List search(@Param("identifier") String identifier,
+ @Param("recordIdentifier") String recordIdentifier,
+ @Param("terms") Collection terms,
+ @Param("sortPredicates") List sortPredicates,
+ @Param("limit") int limit,
+ @Param("caseSensitivity") CaseSensitivity caseSensitivity);
+
+ /**
+ * Searches for up to limit activity records that contain
+ * the given terms, sorted by the given predicates. Only records that are
+ * associated with data explicitly readable by the given user will be
+ * returned. If records are needed by a system administrator (who, by
+ * definition, does not need explicit read rights), use {@link search()}
+ * instead.
+ *
+ * @param identifier
+ * The optional identifier of the object whose history is being
+ * retrieved, or null if records related to any such object should be
+ * retrieved.
+ *
+ * @param user
+ * The user whose permissions should determine whether a record is
+ * returned.
+ *
+ * @param recordIdentifier
+ * The identifier of the specific history record to retrieve, if not
+ * all matching records. Search terms, etc. will still be applied to
+ * the single record.
+ *
+ * @param terms
+ * The search terms that must match the returned records.
+ *
+ * @param sortPredicates
+ * A list of predicates to sort the returned records by, in order of
+ * priority.
+ *
+ * @param limit
+ * The maximum number of records that should be returned.
+ *
+ * @param effectiveGroups
+ * The identifiers of all groups that should be taken into account
+ * when determining the permissions effectively granted to the user. If
+ * no groups are given, only permissions directly granted to the user
+ * will be used.
+ *
+ * @param caseSensitivity
+ * The object that contains current configuration for case sensitivity
+ * for usernames and group names.
+ *
+ * @return
+ * The results of the search performed with the given parameters.
+ */
+ List searchReadable(@Param("identifier") String identifier,
+ @Param("user") UserModel user,
+ @Param("recordIdentifier") String recordIdentifier,
+ @Param("terms") Collection terms,
+ @Param("sortPredicates") List sortPredicates,
+ @Param("limit") int limit,
+ @Param("effectiveGroups") Collection effectiveGroups,
+ @Param("caseSensitivity") CaseSensitivity caseSensitivity);
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ActivityRecordModel.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ActivityRecordModel.java
new file mode 100644
index 0000000..fbf6209
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ActivityRecordModel.java
@@ -0,0 +1,193 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import java.util.Date;
+
+/**
+ * A single activity record representing an arbitrary activity performed by a
+ * user.
+ */
+public class ActivityRecordModel {
+
+ /**
+ * The ID of this object in the database, if any.
+ */
+ private Integer recordID;
+
+ /**
+ * The database ID of the user associated with this activity record.
+ */
+ private Integer userID;
+
+ /**
+ * The username of the user that performed the activity.
+ */
+ private String username;
+
+ /**
+ * The remote host associated with the user that performed the activity.
+ */
+ private String remoteHost;
+
+ /**
+ * The time the activity was initiated by the associated user.
+ */
+ private Date startDate;
+
+ /**
+ * The time the activity ended, or null if the end time is not known or
+ * the activity is still in progress.
+ */
+ private Date endDate;
+
+ /**
+ * Returns the ID of this record in the database, if it exists.
+ *
+ * @return
+ * The ID of this record in the database, or null if this record was
+ * not retrieved from the database.
+ */
+ public Integer getRecordID() {
+ return recordID;
+ }
+
+ /**
+ * Sets the database ID of this record to the given value.
+ *
+ * @param recordID
+ * The ID to assign to this object.
+ */
+ public void setRecordID(Integer recordID) {
+ this.recordID = recordID;
+ }
+
+ /**
+ * Returns the database ID of the user associated with this activity
+ * record.
+ *
+ * @return
+ * The database ID of the user associated with this activity record.
+ */
+ public Integer getUserID() {
+ return userID;
+ }
+
+ /**
+ * Sets the database ID of the user associated with this activity record.
+ *
+ * @param userID
+ * The database ID of the user to associate with this activity
+ * record.
+ */
+ public void setUserID(Integer userID) {
+ this.userID = userID;
+ }
+
+ /**
+ * Returns the username of the user that performed the activity associated
+ * with this record.
+ *
+ * @return
+ * The username of the user that performed the activity associated with
+ * this record.
+ */
+ public String getUsername() {
+ return username;
+ }
+
+ /**
+ * Sets the username of the user that performed the activity associated
+ * with this record.
+ *
+ * @param username
+ * The username of the user that performed the activity associated with
+ * this record.
+ */
+ public void setUsername(String username) {
+ this.username = username;
+ }
+
+ /**
+ * Returns the remote host associated with the user that performed the
+ * activity.
+ *
+ * @return
+ * The remote host associated with the user that performed the activity.
+ */
+ public String getRemoteHost() {
+ return remoteHost;
+ }
+
+ /**
+ * Sets the remote host associated with the user that performed the
+ * activity.
+ *
+ * @param remoteHost
+ * The remote host associated with the user that performed the activity.
+ */
+ public void setRemoteHost(String remoteHost) {
+ this.remoteHost = remoteHost;
+ }
+
+ /**
+ * Returns the time the activity was initiated by the associated user.
+ *
+ * @return
+ * The time the activity was initiated by the associated user.
+ */
+ public Date getStartDate() {
+ return startDate;
+ }
+
+ /**
+ * Sets the time the activity was initiated by the associated user.
+ *
+ * @param startDate
+ * The time the activity was initiated by the associated user.
+ */
+ public void setStartDate(Date startDate) {
+ this.startDate = startDate;
+ }
+
+ /**
+ * Returns the time the activity ended, or null if the end time is not
+ * known or the activity is still in progress.
+ *
+ * @return
+ * The time the activity ended, or null if the end time is not known or
+ * the activity is still in progress.
+ */
+ public Date getEndDate() {
+ return endDate;
+ }
+
+ /**
+ * Sets the time the activity ended, if known.
+ *
+ * @param endDate
+ * The time the activity ended, or null if the end time is not known or
+ * the activity is still in progress.
+ */
+ public void setEndDate(Date endDate) {
+ this.endDate = endDate;
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ActivityRecordSearchTerm.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ActivityRecordSearchTerm.java
new file mode 100644
index 0000000..54af1a6
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ActivityRecordSearchTerm.java
@@ -0,0 +1,291 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import java.util.Calendar;
+import java.util.Date;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ * A search term for querying historical records of arbitrary activities. This
+ * will contain a the search term in string form and, if that string appears to
+ * be a date. a corresponding date range.
+ */
+public class ActivityRecordSearchTerm {
+
+ /**
+ * A pattern that can match a year, year and month, or year and month and
+ * day.
+ */
+ private static final Pattern DATE_PATTERN =
+ Pattern.compile("(\\d+)(?:-(\\d+)?(?:-(\\d+)?)?)?");
+
+ /**
+ * The index of the group within DATE_PATTERN containing the
+ * year number.
+ */
+ private static final int YEAR_GROUP = 1;
+
+ /**
+ * The index of the group within DATE_PATTERN containing the
+ * month number, if any.
+ */
+ private static final int MONTH_GROUP = 2;
+
+ /**
+ * The index of the group within DATE_PATTERN containing the
+ * day number, if any.
+ */
+ private static final int DAY_GROUP = 3;
+
+ /**
+ * The start of the date range for records that should be retrieved, if the
+ * provided search term appears to be a date.
+ */
+ private final Date startDate;
+
+ /**
+ * The end of the date range for records that should be retrieved, if the
+ * provided search term appears to be a date.
+ */
+ private final Date endDate;
+
+ /**
+ * The string that should be searched for.
+ */
+ private final String term;
+
+ /**
+ * Parse the given string as an integer, returning the provided default
+ * value if the string is null.
+ *
+ * @param str
+ * The string to parse as an integer.
+ *
+ * @param defaultValue
+ * The value to return if str is null.
+ *
+ * @return
+ * The parsed value, or the provided default value if str
+ * is null.
+ */
+ private static int parseInt(String str, int defaultValue) {
+
+ if (str == null)
+ return defaultValue;
+
+ return Integer.parseInt(str);
+
+ }
+
+ /**
+ * Returns a new calendar representing the last millisecond of the same
+ * year as calendar.
+ *
+ * @param calendar
+ * The calendar defining the year whose end (last millisecond) is to be
+ * returned.
+ *
+ * @return
+ * A new calendar representing the last millisecond of the same year as
+ * calendar.
+ */
+ private static Calendar getEndOfYear(Calendar calendar) {
+
+ // Get first day of next year
+ Calendar endOfYear = Calendar.getInstance();
+ endOfYear.clear();
+ endOfYear.set(Calendar.YEAR, calendar.get(Calendar.YEAR) + 1);
+
+ // Transform into the last millisecond of the given year
+ endOfYear.add(Calendar.MILLISECOND, -1);
+
+ return endOfYear;
+
+ }
+
+ /**
+ * Returns a new calendar representing the last millisecond of the same
+ * month and year as calendar.
+ *
+ * @param calendar
+ * The calendar defining the month and year whose end (last millisecond)
+ * is to be returned.
+ *
+ * @return
+ * A new calendar representing the last millisecond of the same month
+ * and year as calendar.
+ */
+ private static Calendar getEndOfMonth(Calendar calendar) {
+
+ // Copy given calender only up to given month
+ Calendar endOfMonth = Calendar.getInstance();
+ endOfMonth.clear();
+ endOfMonth.set(Calendar.YEAR, calendar.get(Calendar.YEAR));
+ endOfMonth.set(Calendar.MONTH, calendar.get(Calendar.MONTH));
+
+ // Advance to the last millisecond of the given month
+ endOfMonth.add(Calendar.MONTH, 1);
+ endOfMonth.add(Calendar.MILLISECOND, -1);
+
+ return endOfMonth;
+
+ }
+
+ /**
+ * Returns a new calendar representing the last millisecond of the same
+ * year, month, and day as calendar.
+ *
+ * @param calendar
+ * The calendar defining the year, month, and day whose end
+ * (last millisecond) is to be returned.
+ *
+ * @return
+ * A new calendar representing the last millisecond of the same year,
+ * month, and day as calendar.
+ */
+ private static Calendar getEndOfDay(Calendar calendar) {
+
+ // Copy given calender only up to given month
+ Calendar endOfMonth = Calendar.getInstance();
+ endOfMonth.clear();
+ endOfMonth.set(Calendar.YEAR, calendar.get(Calendar.YEAR));
+ endOfMonth.set(Calendar.MONTH, calendar.get(Calendar.MONTH));
+ endOfMonth.set(Calendar.DAY_OF_MONTH, calendar.get(Calendar.DAY_OF_MONTH));
+
+ // Advance to the last millisecond of the given day
+ endOfMonth.add(Calendar.DAY_OF_MONTH, 1);
+ endOfMonth.add(Calendar.MILLISECOND, -1);
+
+ return endOfMonth;
+
+ }
+
+ /**
+ * Creates a new ActivityRecordSearchTerm representing the given string.
+ * If the given string appears to be a date, the start and end dates of the
+ * implied date range will be automatically determined and made available
+ * via getStartDate() and getEndDate() respectively.
+ *
+ * @param term
+ * The string that should be searched for.
+ */
+ public ActivityRecordSearchTerm(String term) {
+
+ // Search terms absolutely must not be null
+ if (term == null)
+ throw new NullPointerException("Search terms may not be null");
+
+ this.term = term;
+
+ // Parse start/end of date range if term appears to be a date
+ Matcher matcher = DATE_PATTERN.matcher(term);
+ if (matcher.matches()) {
+
+ // Retrieve date components from term
+ String year = matcher.group(YEAR_GROUP);
+ String month = matcher.group(MONTH_GROUP);
+ String day = matcher.group(DAY_GROUP);
+
+ // Parse start date from term
+ Calendar startCalendar = Calendar.getInstance();
+ startCalendar.clear();
+ startCalendar.set(
+ Integer.parseInt(year),
+ parseInt(month, 1) - 1,
+ parseInt(day, 1)
+ );
+
+ Calendar endCalendar;
+
+ // Derive end date from start date
+ if (month == null) {
+ endCalendar = getEndOfYear(startCalendar);
+ }
+ else if (day == null) {
+ endCalendar = getEndOfMonth(startCalendar);
+ }
+ else {
+ endCalendar = getEndOfDay(startCalendar);
+ }
+
+ // Convert results back into dates
+ this.startDate = startCalendar.getTime();
+ this.endDate = endCalendar.getTime();
+
+ }
+
+ // The search term doesn't look like a date
+ else {
+ this.startDate = null;
+ this.endDate = null;
+ }
+
+ }
+
+ /**
+ * Returns the start of the date range for records that should be retrieved,
+ * if the provided search term appears to be a date.
+ *
+ * @return
+ * The start of the date range.
+ */
+ public Date getStartDate() {
+ return startDate;
+ }
+
+ /**
+ * Returns the end of the date range for records that should be retrieved,
+ * if the provided search term appears to be a date.
+ *
+ * @return
+ * The end of the date range.
+ */
+ public Date getEndDate() {
+ return endDate;
+ }
+
+ /**
+ * Returns the string that should be searched for.
+ *
+ * @return
+ * The search term.
+ */
+ public String getTerm() {
+ return term;
+ }
+
+ @Override
+ public int hashCode() {
+ return term.hashCode();
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+
+ if (obj == null || !(obj instanceof ActivityRecordSearchTerm))
+ return false;
+
+ return ((ActivityRecordSearchTerm) obj).getTerm().equals(getTerm());
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ActivityRecordSortPredicate.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ActivityRecordSortPredicate.java
new file mode 100644
index 0000000..ab0d3ce
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ActivityRecordSortPredicate.java
@@ -0,0 +1,77 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import org.apache.guacamole.net.auth.ActivityRecordSet;
+
+/**
+ * A sort predicate which species the property to use when sorting activity
+ * records, along with the sort order.
+ */
+public class ActivityRecordSortPredicate {
+
+ /**
+ * The property to use when sorting ActivityRecords.
+ */
+ private final ActivityRecordSet.SortableProperty property;
+
+ /**
+ * Whether the sort order is descending (true) or ascending (false).
+ */
+ private final boolean descending;
+
+ /**
+ * Creates a new ActivityRecordSortPredicate with the given sort property
+ * and sort order.
+ *
+ * @param property
+ * The property to use when sorting ActivityRecords.
+ *
+ * @param descending
+ * Whether the sort order is descending (true) or ascending (false).
+ */
+ public ActivityRecordSortPredicate(ActivityRecordSet.SortableProperty property,
+ boolean descending) {
+ this.property = property;
+ this.descending = descending;
+ }
+
+ /**
+ * Returns the property that should be used when sorting ActivityRecords.
+ *
+ * @return
+ * The property that should be used when sorting ActivityRecords.
+ */
+ public ActivityRecordSet.SortableProperty getProperty() {
+ return property;
+ }
+
+ /**
+ * Returns whether the sort order is descending.
+ *
+ * @return
+ * true if the sort order is descending, false if the sort order is
+ * ascending.
+ */
+ public boolean isDescending() {
+ return descending;
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ArbitraryAttributeMap.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ArbitraryAttributeMap.java
new file mode 100644
index 0000000..219abe8
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ArbitraryAttributeMap.java
@@ -0,0 +1,180 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import java.util.AbstractCollection;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+
+/**
+ * Map of arbitrary attribute name/value pairs which can alternatively be
+ * exposed as a collection of model objects.
+ */
+public class ArbitraryAttributeMap extends HashMap {
+
+ /**
+ * Creates a new ArbitraryAttributeMap containing the name/value pairs
+ * within the given collection of model objects.
+ *
+ * @param models
+ * The model objects of all attributes which should be stored in the
+ * new map as name/value pairs.
+ *
+ * @return
+ * A new ArbitraryAttributeMap containing the name/value pairs within
+ * the given collection of model objects.
+ */
+ public static ArbitraryAttributeMap fromModelCollection(Collection models) {
+
+ // Add all name/value pairs from the given collection to the map
+ ArbitraryAttributeMap map = new ArbitraryAttributeMap();
+ for (ArbitraryAttributeModel model : models)
+ map.put(model.getName(), model.getValue());
+
+ return map;
+
+ }
+
+ /**
+ * Returns a collection of model objects which mirrors the contents of this
+ * ArbitraryAttributeMap. Each name/value pair within the map is reflected
+ * by a corresponding model object within the returned collection. Removing
+ * a model object from the collection removes the corresponding name/value
+ * pair from the map. Adding a new model object to the collection adds a
+ * corresponding name/value pair to the map. Changes to a model object
+ * within the collection are NOT reflected on the map, however.
+ *
+ * @return
+ * A collection of model objects which mirrors the contents of this
+ * ArbitraryAttributeMap.
+ */
+ public Collection toModelCollection() {
+ return new AbstractCollection() {
+
+ @Override
+ public void clear() {
+ ArbitraryAttributeMap.this.clear();
+ }
+
+ @Override
+ public boolean remove(Object o) {
+
+ // The Collection view of an ArbitraryAttributeMap can contain
+ // only ArbitraryAttributeModel objects
+ if (!(o instanceof ArbitraryAttributeModel))
+ return false;
+
+ // Remove only if key is actually present
+ ArbitraryAttributeModel model = (ArbitraryAttributeModel) o;
+ if (!ArbitraryAttributeMap.this.containsKey(model.getName()))
+ return false;
+
+ // The attribute should be removed only if the value matches
+ String currentValue = ArbitraryAttributeMap.this.get(model.getName());
+ if (currentValue == null) {
+ if (model.getValue() != null)
+ return false;
+ }
+ else if (!currentValue.equals(model.getValue()))
+ return false;
+
+ ArbitraryAttributeMap.this.remove(model.getName());
+ return true;
+
+ }
+
+ @Override
+ public boolean add(ArbitraryAttributeModel e) {
+
+ String newValue = e.getValue();
+ String oldValue = put(e.getName(), newValue);
+
+ // If null value is being added, collection changed only if
+ // old value was non-null
+ if (newValue == null)
+ return oldValue != null;
+
+ // Collection changed if value changed
+ return !newValue.equals(oldValue);
+
+ }
+
+ @Override
+ public boolean contains(Object o) {
+
+ // The Collection view of an ArbitraryAttributeMap can contain
+ // only ArbitraryAttributeModel objects
+ if (!(o instanceof ArbitraryAttributeModel))
+ return false;
+
+ // No need to check the value of the attribute if the attribute
+ // is not even present
+ ArbitraryAttributeModel model = (ArbitraryAttributeModel) o;
+ String value = get(model.getName());
+ if (value == null)
+ return false;
+
+ // The name/value pair is present only if the value matches
+ return value.equals(model.getValue());
+
+ }
+
+ @Override
+ public Iterator iterator() {
+
+ // Get iterator over all string name/value entries
+ final Iterator> iterator = entrySet().iterator();
+
+ // Dynamically translate each string name/value entry into a
+ // corresponding attribute model object as iteration continues
+ return new Iterator() {
+
+ @Override
+ public boolean hasNext() {
+ return iterator.hasNext();
+ }
+
+ @Override
+ public ArbitraryAttributeModel next() {
+ Map.Entry entry = iterator.next();
+ return new ArbitraryAttributeModel(entry.getKey(),
+ entry.getValue());
+ }
+
+ @Override
+ public void remove() {
+ iterator.remove();
+ }
+
+ };
+
+ }
+
+ @Override
+ public int size() {
+ return ArbitraryAttributeMap.this.size();
+ }
+
+ };
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ArbitraryAttributeModel.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ArbitraryAttributeModel.java
new file mode 100644
index 0000000..b064b54
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ArbitraryAttributeModel.java
@@ -0,0 +1,104 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+/**
+ * A single attribute name/value pair belonging to a object which implements
+ * the Attributes interface, such as a Connection or User. Attributes stored
+ * as raw name/value pairs are the attributes which are given to the database
+ * authentication extension for storage by other extensions. Attributes which
+ * are directly supported by the database authentication extension have defined
+ * columns and properties with proper types, constraints, etc.
+ */
+public class ArbitraryAttributeModel {
+
+ /**
+ * The name of the attribute.
+ */
+ private String name;
+
+ /**
+ * The value the attribute is set to.
+ */
+ private String value;
+
+ /**
+ * Creates a new ArbitraryAttributeModel with its name and value both set
+ * to null.
+ */
+ public ArbitraryAttributeModel() {
+ }
+
+ /**
+ * Creates a new ArbitraryAttributeModel with its name and value
+ * initialized to the given values.
+ *
+ * @param name
+ * The name of the attribute.
+ *
+ * @param value
+ * The value the attribute is set to.
+ */
+ public ArbitraryAttributeModel(String name, String value) {
+ this.name = name;
+ this.value = value;
+ }
+
+ /**
+ * Returns the name of this attribute.
+ *
+ * @return
+ * The name of this attribute.
+ */
+ public String getName() {
+ return name;
+ }
+
+ /**
+ * Sets the name of this attribute.
+ *
+ * @param name
+ * The name of this attribute.
+ */
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ /**
+ * Returns the value of this attribute.
+ *
+ * @return
+ * The value of this attribute.
+ */
+ public String getValue() {
+ return value;
+ }
+
+ /**
+ * Sets the value of this attribute.
+ *
+ * @param value
+ * The value of this attribute.
+ */
+ public void setValue(String value) {
+ this.value = value;
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ChildObjectModel.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ChildObjectModel.java
new file mode 100644
index 0000000..1d18e59
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ChildObjectModel.java
@@ -0,0 +1,63 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+/**
+ * Object representation of a Guacamole object which can be the child of another
+ * object, such as a connection or sharing profile, as represented in the
+ * database.
+ */
+public abstract class ChildObjectModel extends ObjectModel {
+
+ /**
+ * The unique identifier which identifies the parent of this object.
+ */
+ private String parentIdentifier;
+
+ /**
+ * Creates a new, empty object.
+ */
+ public ChildObjectModel() {
+ }
+
+ /**
+ * Returns the identifier of the parent connection group, or null if the
+ * parent connection group is the root connection group.
+ *
+ * @return
+ * The identifier of the parent connection group, or null if the parent
+ * connection group is the root connection group.
+ */
+ public String getParentIdentifier() {
+ return parentIdentifier;
+ }
+
+ /**
+ * Sets the identifier of the parent connection group.
+ *
+ * @param parentIdentifier
+ * The identifier of the parent connection group, or null if the parent
+ * connection group is the root connection group.
+ */
+ public void setParentIdentifier(String parentIdentifier) {
+ this.parentIdentifier = parentIdentifier;
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/DirectoryObjectService.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/DirectoryObjectService.java
new file mode 100644
index 0000000..590e01e
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/DirectoryObjectService.java
@@ -0,0 +1,151 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import java.util.Collection;
+import java.util.Set;
+import org.apache.guacamole.auth.jdbc.user.ModeledAuthenticatedUser;
+import org.apache.guacamole.GuacamoleException;
+
+/**
+ * Service which provides convenience methods for creating, retrieving, and
+ * manipulating objects that have unique identifiers, such as the objects
+ * within directories. This service will automatically enforce the permissions
+ * of the current user.
+ *
+ * @param
+ * The specific internal implementation of the type of object this service
+ * provides access to.
+ *
+ * @param
+ * The external interface or implementation of the type of object this
+ * service provides access to, as defined by the guacamole-ext API.
+ */
+public interface DirectoryObjectService {
+
+ /**
+ * Retrieves the single object that has the given identifier, if it exists
+ * and the user has permission to read it.
+ *
+ * @param user
+ * The user retrieving the object.
+ *
+ * @param identifier
+ * The identifier of the object to retrieve.
+ *
+ * @return
+ * The object having the given identifier, or null if no such object
+ * exists.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while retrieving the requested object.
+ */
+ InternalType retrieveObject(ModeledAuthenticatedUser user, String identifier)
+ throws GuacamoleException;
+
+ /**
+ * Retrieves all objects that have the identifiers in the given collection.
+ * Only objects that the user has permission to read will be returned.
+ *
+ * @param user
+ * The user retrieving the objects.
+ *
+ * @param identifiers
+ * The identifiers of the objects to retrieve.
+ *
+ * @return
+ * The objects having the given identifiers.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while retrieving the requested objects.
+ */
+ Collection retrieveObjects(ModeledAuthenticatedUser user,
+ Collection identifiers) throws GuacamoleException;
+
+ /**
+ * Creates the given object. If the object already exists, an error will be
+ * thrown.
+ *
+ * @param user
+ * The user creating the object.
+ *
+ * @param object
+ * The object to create.
+ *
+ * @return
+ * The newly-created object.
+ *
+ * @throws GuacamoleException
+ * If the user lacks permission to create the object, or an error
+ * occurs while creating the object.
+ */
+ InternalType createObject(ModeledAuthenticatedUser user, ExternalType object)
+ throws GuacamoleException;
+
+ /**
+ * Deletes the object having the given identifier. If no such object
+ * exists, this function has no effect.
+ *
+ * @param user
+ * The user deleting the object.
+ *
+ * @param identifier
+ * The identifier of the object to delete.
+ *
+ * @throws GuacamoleException
+ * If the user lacks permission to delete the object, or an error
+ * occurs while deleting the object.
+ */
+ void deleteObject(ModeledAuthenticatedUser user, String identifier)
+ throws GuacamoleException;
+
+ /**
+ * Updates the given object, applying any changes that have been made. If
+ * no such object exists, this function has no effect.
+ *
+ * @param user
+ * The user updating the object.
+ *
+ * @param object
+ * The object to update.
+ *
+ * @throws GuacamoleException
+ * If the user lacks permission to update the object, or an error
+ * occurs while updating the object.
+ */
+ void updateObject(ModeledAuthenticatedUser user, InternalType object)
+ throws GuacamoleException;
+
+ /**
+ * Returns the set of all identifiers for all objects that the user has
+ * read access to.
+ *
+ * @param user
+ * The user retrieving the identifiers.
+ *
+ * @return
+ * The set of all identifiers for all objects.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while reading identifiers.
+ */
+ Set getIdentifiers(ModeledAuthenticatedUser user) throws GuacamoleException;
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/EntityMapper.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/EntityMapper.java
new file mode 100644
index 0000000..499171b
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/EntityMapper.java
@@ -0,0 +1,86 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import java.util.Collection;
+import java.util.Set;
+import org.apache.guacamole.properties.CaseSensitivity;
+import org.apache.ibatis.annotations.Param;
+
+/**
+ * Mapper for entities. An entity is the base concept behind a user or user
+ * group, and serves as a common point for granting permissions and defining
+ * group membership.
+ */
+public interface EntityMapper {
+
+ /**
+ * Inserts the given entity into the database. If the entity already
+ * exists, this will result in an error.
+ *
+ * @param entity
+ * The entity to insert.
+ *
+ * @return
+ * The number of rows inserted.
+ */
+ int insert(@Param("entity") EntityModel entity);
+
+ /**
+ * Returns the set of all group identifiers of which the given entity is a
+ * member, taking into account the given collection of known group
+ * memberships which are not necessarily defined within the database.
+ *
+ * NOTE: This query is expected to handle recursion through the membership
+ * graph on its own. If the database engine does not support recursive
+ * queries (isRecursiveQuerySupported() of JDBCEnvironment returns false),
+ * then this query will only return one level of depth past the effective
+ * groups given and will need to be invoked multiple times.
+ *
+ * @param entity
+ * The entity whose effective groups should be returned.
+ *
+ * @param effectiveGroups
+ * The identifiers of any known effective groups that should be taken
+ * into account, such as those defined externally to the database.
+ *
+ * @param recursive
+ * Whether the query should leverage database engine features to return
+ * absolutely all effective groups, including those inherited through
+ * group membership. If false, this query will return only one level of
+ * depth and may need to be executed multiple times. If it is known
+ * that the database engine in question will always support (or always
+ * not support) recursive queries, this parameter may be ignored.
+ *
+ * @param caseSensitivity
+ * The object that contains current configuration for case sensitivity
+ * for usernames and group names.
+ *
+ * @return
+ * The set of identifiers of all groups that the given entity is a
+ * member of, including those where membership is inherited through
+ * membership in other groups.
+ */
+ Set selectEffectiveGroupIdentifiers(@Param("entity") EntityModel entity,
+ @Param("effectiveGroups") Collection effectiveGroups,
+ @Param("recursive") boolean recursive,
+ @Param("caseSensitivity") CaseSensitivity caseSensitivity);
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/EntityModel.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/EntityModel.java
new file mode 100644
index 0000000..c42db16
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/EntityModel.java
@@ -0,0 +1,113 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+/**
+ * Base representation of a Guacamole object that can be granted permissions
+ * (an "entity"), such as a user or user group, as represented in the database.
+ * Each entity has three base properties:
+ *
+ * 1. The "entityID", which points to the common entry in the
+ * guacamole_entity table and is common to any type of entity.
+ *
+ * 2. The "objectID", which points to the type-specific entry for the object
+ * in question (ie: an entry in guacamole_user or guacamole_user_group).
+ *
+ * 3. The "identifier", which contains the unique "name" value defined for
+ * the entity within the guacamole_entity table.
+ */
+public abstract class EntityModel extends ObjectModel {
+
+ /**
+ * The ID of the entity entry which corresponds to this object in the
+ * database, if any. Note that this is distinct from the objectID,
+ * inherited from ObjectModel, which is specific to the actual type of
+ * object represented by the entity.
+ */
+ private Integer entityID;
+
+ /**
+ * The type of object represented by the entity (user or user group).
+ */
+ private EntityType type;
+
+ /**
+ * Creates a new, empty entity.
+ */
+ public EntityModel() {
+ }
+
+ /**
+ * Creates a new entity of the given type which is otherwise empty.
+ *
+ * @param type
+ * The type to assign to the new entity.
+ */
+ public EntityModel(EntityType type) {
+ this.type = type;
+ }
+
+ /**
+ * Returns the ID of the entity entry which corresponds to this object in
+ * the database, if it exists. Note that this is distinct from the objectID,
+ * inherited from ObjectModel, which is specific to the actual type of
+ * object represented by the entity.
+ *
+ * @return
+ * The ID of this entity in the database, or null if this entity was
+ * not retrieved from the database.
+ */
+ public Integer getEntityID() {
+ return entityID;
+ }
+
+ /**
+ * Sets the ID of this entity to the given value.
+ *
+ * @param entityID
+ * The ID to assign to this entity.
+ */
+ public void setEntityID(Integer entityID) {
+ this.entityID = entityID;
+ }
+
+ /**
+ * Returns the type of object represented by the entity. Each entity may be
+ * either a user or a user group.
+ *
+ * @return
+ * The type of object represented by the entity.
+ */
+ public EntityType getEntityType() {
+ return type;
+ }
+
+ /**
+ * Sets the type of object represented by the entity. Each entity may be
+ * either a user or a user group.
+ *
+ * @param type
+ * The type of object represented by the entity.
+ */
+ public void setEntityType(EntityType type) {
+ this.type = type;
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/EntityService.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/EntityService.java
new file mode 100644
index 0000000..2dcf54e
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/EntityService.java
@@ -0,0 +1,104 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import com.google.inject.Inject;
+import java.util.Collection;
+import java.util.Set;
+import org.apache.guacamole.auth.jdbc.JDBCEnvironment;
+import org.apache.guacamole.properties.CaseSensitivity;
+import org.apache.ibatis.session.SqlSession;
+import org.mybatis.guice.transactional.Transactional;
+
+/**
+ * Service which provides convenience methods for creating, retrieving, and
+ * manipulating entities.
+ */
+public class EntityService {
+
+ /**
+ * The Guacamole server environment.
+ */
+ @Inject
+ private JDBCEnvironment environment;
+
+ /**
+ * Mapper for Entity model objects.
+ */
+ @Inject
+ private EntityMapper entityMapper;
+
+ /**
+ * The current SQL session used by MyBatis.
+ */
+ @Inject
+ private SqlSession sqlSession;
+
+ /**
+ * Returns the set of all group identifiers of which the given entity is a
+ * member, taking into account the given collection of known group
+ * memberships which are not necessarily defined within the database.
+ *
+ * Note that group visibility with respect to the queried entity is NOT
+ * taken into account. If the entity is a member of a group, the identifier
+ * of that group will be included in the returned set even if the current
+ * user lacks "READ" permission for that group.
+ *
+ * @param entity
+ * The entity whose effective groups should be returned.
+ *
+ * @param effectiveGroups
+ * The identifiers of any known effective groups that should be taken
+ * into account, such as those defined externally to the database.
+ *
+ * @return
+ * The set of identifiers of all groups that the given entity is a
+ * member of, including those where membership is inherited through
+ * membership in other groups.
+ */
+ @Transactional
+ public Set retrieveEffectiveGroups(ModeledPermissions entity,
+ Collection effectiveGroups) {
+
+ CaseSensitivity caseSensitivity = environment.getCaseSensitivity();
+
+ // Retrieve the effective user groups of the given entity, recursively if possible
+ boolean recursive = environment.isRecursiveQuerySupported(sqlSession);
+ Set identifiers = entityMapper.selectEffectiveGroupIdentifiers(
+ entity.getModel(), effectiveGroups, recursive, caseSensitivity);
+
+ // If the set of user groups retrieved was not produced recursively,
+ // manually repeat the query to expand the set until all effective
+ // groups have been found
+ if (!recursive && !identifiers.isEmpty()) {
+ Set previousIdentifiers;
+ do {
+ previousIdentifiers = identifiers;
+ identifiers = entityMapper.selectEffectiveGroupIdentifiers(
+ entity.getModel(), previousIdentifiers, false,
+ caseSensitivity);
+ } while (identifiers.size() > previousIdentifiers.size());
+ }
+
+ return identifiers;
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/EntityType.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/EntityType.java
new file mode 100644
index 0000000..9b1f1ed
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/EntityType.java
@@ -0,0 +1,38 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+/**
+ * The type of object represented by an entity. Each entity may represent
+ * either a user or a user group.
+ */
+public enum EntityType {
+
+ /**
+ * An individual user.
+ */
+ USER,
+
+ /**
+ * A group of users and/or other groups.
+ */
+ USER_GROUP
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/JDBCDirectory.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/JDBCDirectory.java
new file mode 100644
index 0000000..3ed6d8a
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/JDBCDirectory.java
@@ -0,0 +1,45 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.net.auth.AtomicDirectoryOperation;
+import org.apache.guacamole.net.auth.Directory;
+import org.apache.guacamole.net.auth.Identifiable;
+import org.mybatis.guice.transactional.Transactional;
+
+/**
+ * An implementation of Directory that uses database transactions to guarantee
+ * atomicity for any operations supplied to tryAtomically().
+ */
+public abstract class JDBCDirectory
+ extends RestrictedObject implements Directory {
+
+ @Override
+ @Transactional
+ public void tryAtomically(AtomicDirectoryOperation operation)
+ throws GuacamoleException {
+
+ // Execute the operation atomically - the @Transactional annotation
+ // specifies that the entire operation will be performed in a transaction
+ operation.executeOperation(true, this);
+
+ }
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledActivityRecord.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledActivityRecord.java
new file mode 100644
index 0000000..5c2c328
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledActivityRecord.java
@@ -0,0 +1,130 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import java.nio.ByteBuffer;
+import java.util.Date;
+import java.util.UUID;
+import org.apache.guacamole.net.auth.ActivityRecord;
+
+/**
+ * An ActivityRecord which is backed by a database model.
+ */
+public class ModeledActivityRecord implements ActivityRecord {
+
+ /**
+ * The model object backing this activity record.
+ */
+ private final ActivityRecordModel model;
+
+ /**
+ * The UUID namespace of the type 3 name UUID to generate for the record.
+ * This namespace should correspond to the source of IDs for the model such
+ * that the combination of this namespace with the numeric record ID will
+ * always be unique and deterministic across all activity records,
+ * regardless of record type.
+ */
+ private final UUID namespace;
+
+ /**
+ * Creates a new ModeledActivityRecord backed by the given model object.
+ * Changes to this record will affect the backing model object, and changes
+ * to the backing model object will affect this record.
+ *
+ * @param namespace
+ * The UUID namespace of the type 3 name UUID to generate for the
+ * record. This namespace should correspond to the source of IDs for
+ * the model such that the combination of this namespace with the
+ * numeric record ID will always be unique and deterministic across all
+ * activity records, regardless of record type.
+ *
+ * @param model
+ * The model object to use to back this activity record.
+ */
+ public ModeledActivityRecord(UUID namespace, ActivityRecordModel model) {
+ this.model = model;
+ this.namespace = namespace;
+ }
+
+ /**
+ * Returns the backing model object. Changes to this record will affect the
+ * backing model object, and changes to the backing model object will
+ * affect this record.
+ *
+ * @return
+ * The backing model object.
+ */
+ public ActivityRecordModel getModel() {
+ return model;
+ }
+
+ @Override
+ public Date getStartDate() {
+ return model.getStartDate();
+ }
+
+ @Override
+ public Date getEndDate() {
+ return model.getEndDate();
+ }
+
+ @Override
+ public String getRemoteHost() {
+ return model.getRemoteHost();
+ }
+
+ @Override
+ public String getUsername() {
+ return model.getUsername();
+ }
+
+ @Override
+ public boolean isActive() {
+ return false;
+ }
+
+ @Override
+ public String getIdentifier() {
+
+ Integer id = model.getRecordID();
+ if (id == null)
+ return null;
+
+ return id.toString();
+
+ }
+
+ @Override
+ public UUID getUUID() {
+
+ Integer id = model.getRecordID();
+ if (id == null)
+ return null;
+
+ // Convert record ID to a name UUID in the given namespace
+ return UUID.nameUUIDFromBytes(ByteBuffer.allocate(24)
+ .putLong(namespace.getMostSignificantBits())
+ .putLong(namespace.getLeastSignificantBits())
+ .putLong(id)
+ .array());
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledActivityRecordSet.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledActivityRecordSet.java
new file mode 100644
index 0000000..79346f5
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledActivityRecordSet.java
@@ -0,0 +1,163 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.net.auth.ActivityRecord;
+import org.apache.guacamole.net.auth.ActivityRecordSet;
+import org.apache.guacamole.net.auth.ActivityRecordSet.SortableProperty;
+import org.apache.guacamole.net.auth.AuthenticatedUser;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * A JDBC implementation of ActivityRecordSet. Calls to asCollection() will
+ * query history records using an implementation-specific mechanism. Which
+ * records are returned will be determined by the values passed in earlier.
+ *
+ * @param
+ * The type of ActivityRecord contained within this set.
+ */
+public abstract class ModeledActivityRecordSet
+ extends RestrictedObject implements ActivityRecordSet {
+
+ /**
+ * Logger for this class.
+ */
+ private static final Logger logger = LoggerFactory.getLogger(ModeledActivityRecordSet.class);
+
+ /**
+ * The set of strings that each must occur somewhere within the returned
+ * records, whether within the associated username, an associated date, or
+ * other related data. If non-empty, any record not matching each of the
+ * strings within the collection will be excluded from the results.
+ */
+ private final Set requiredContents =
+ new HashSet<>();
+
+ /**
+ * The maximum number of history records that should be returned by a call
+ * to asCollection().
+ */
+ private int limit = Integer.MAX_VALUE;
+
+ /**
+ * A list of predicates to apply while sorting the resulting records,
+ * describing the properties involved and the sort order for those
+ * properties.
+ */
+ private final List sortPredicates =
+ new ArrayList<>();
+
+ /**
+ * Retrieves the history records matching the given criteria. Retrieves up
+ * to limit history records matching the given terms and sorted
+ * by the given predicates. Only history records associated with data that
+ * the given user can read are returned.
+ *
+ * @param user
+ * The user retrieving the history.
+ *
+ * @param recordIdentifier
+ * The identifier of the specific history record to retrieve, if not
+ * all matching records. Search terms, etc. will still be applied to
+ * the single record.
+ *
+ * @param requiredContents
+ * The search terms that must be contained somewhere within each of the
+ * returned records.
+ *
+ * @param sortPredicates
+ * A list of predicates to sort the returned records by, in order of
+ * priority.
+ *
+ * @param limit
+ * The maximum number of records that should be returned.
+ *
+ * @return
+ * A collection of all history records matching the given criteria.
+ *
+ * @throws GuacamoleException
+ * If permission to read the history records is denied.
+ */
+ protected abstract List retrieveHistory(
+ AuthenticatedUser user, String recordIdentifier,
+ Set requiredContents,
+ List sortPredicates,
+ int limit) throws GuacamoleException;
+
+ @Override
+ public RecordType get(String identifier) throws GuacamoleException {
+
+ List records = retrieveHistory(getCurrentUser(),
+ identifier, requiredContents, sortPredicates, limit);
+
+ if (records.isEmpty())
+ return null;
+
+ if (records.size() == 1)
+ return records.get(0);
+
+ logger.warn("Multiple history records match ID \"{}\"! This should "
+ + "not be possible and may indicate a bug or database "
+ + "corruption.", identifier);
+ return null;
+
+ }
+
+ @Override
+ public Collection asCollection()
+ throws GuacamoleException {
+ return retrieveHistory(getCurrentUser(), null, requiredContents,
+ sortPredicates, limit);
+ }
+
+ @Override
+ public ModeledActivityRecordSet contains(String value)
+ throws GuacamoleException {
+ requiredContents.add(new ActivityRecordSearchTerm(value));
+ return this;
+ }
+
+ @Override
+ public ModeledActivityRecordSet limit(int limit) throws GuacamoleException {
+ this.limit = Math.min(this.limit, limit);
+ return this;
+ }
+
+ @Override
+ public ModeledActivityRecordSet sort(SortableProperty property, boolean desc)
+ throws GuacamoleException {
+
+ sortPredicates.add(new ActivityRecordSortPredicate(
+ property,
+ desc
+ ));
+
+ return this;
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledChildDirectoryObject.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledChildDirectoryObject.java
new file mode 100644
index 0000000..124d45a
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledChildDirectoryObject.java
@@ -0,0 +1,74 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import org.apache.guacamole.auth.jdbc.connectiongroup.RootConnectionGroup;
+
+/**
+ * Common base class for objects that will ultimately be made available through
+ * the Directory class. All such objects will need the same base set of queries
+ * to fulfill the needs of the Directory class.
+ *
+ * @param
+ * The type of model object that corresponds to this object.
+ */
+public abstract class ModeledChildDirectoryObject
+ extends ModeledDirectoryObject {
+
+ /**
+ * Returns the identifier of the parent connection group, which cannot be
+ * null. If the parent is the root connection group, this will be
+ * RootConnectionGroup.IDENTIFIER.
+ *
+ * @return
+ * The identifier of the parent connection group.
+ */
+ public String getParentIdentifier() {
+
+ // Translate null parent to proper identifier
+ String parentIdentifier = getModel().getParentIdentifier();
+ if (parentIdentifier == null)
+ return RootConnectionGroup.IDENTIFIER;
+
+ return parentIdentifier;
+
+ }
+
+ /**
+ * Sets the identifier of the associated parent connection group. If the
+ * parent is the root connection group, this should be
+ * RootConnectionGroup.IDENTIFIER.
+ *
+ * @param parentIdentifier
+ * The identifier of the connection group to associate as this object's
+ * parent.
+ */
+ public void setParentIdentifier(String parentIdentifier) {
+
+ // Translate root identifier back into null
+ if (parentIdentifier != null
+ && parentIdentifier.equals(RootConnectionGroup.IDENTIFIER))
+ parentIdentifier = null;
+
+ getModel().setParentIdentifier(parentIdentifier);
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledChildDirectoryObjectService.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledChildDirectoryObjectService.java
new file mode 100644
index 0000000..7690313
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledChildDirectoryObjectService.java
@@ -0,0 +1,209 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.GuacamoleSecurityException;
+import org.apache.guacamole.auth.jdbc.user.ModeledAuthenticatedUser;
+import org.apache.guacamole.net.auth.Identifiable;
+import org.apache.guacamole.net.auth.permission.ObjectPermission;
+import org.apache.guacamole.net.auth.permission.ObjectPermissionSet;
+
+/**
+ * Service which provides convenience methods for creating, retrieving, and
+ * manipulating objects that can be children of other objects. This service will
+ * automatically enforce the permissions of the current user.
+ *
+ * @param
+ * The specific internal implementation of the type of object this service
+ * provides access to.
+ *
+ * @param
+ * The external interface or implementation of the type of object this
+ * service provides access to, as defined by the guacamole-ext API.
+ *
+ * @param
+ * The underlying model object used to represent InternalType in the
+ * database.
+ */
+public abstract class ModeledChildDirectoryObjectService,
+ ExternalType extends Identifiable, ModelType extends ChildObjectModel>
+ extends ModeledDirectoryObjectService {
+
+ /**
+ * Returns the permission set associated with the given user and related
+ * to the type of objects which can be parents of the child objects handled
+ * by this directory object service, taking into account permission
+ * inheritance via user groups.
+ *
+ * @param user
+ * The user whose permissions are being retrieved.
+ *
+ * @return
+ * A permission set which contains the permissions associated with the
+ * given user and related to the type of objects which can be parents
+ * of the child objects handled by this directory object service.
+ *
+ * @throws GuacamoleException
+ * If permission to read the user's permissions is denied.
+ */
+ protected abstract ObjectPermissionSet getParentEffectivePermissionSet(
+ ModeledAuthenticatedUser user) throws GuacamoleException;
+
+ /**
+ * Returns the set of parent objects that are modified by the given model
+ * object (by virtue of the object changing parents). If the model is not
+ * changing parents, the resulting collection will be empty.
+ *
+ * @param user
+ * The user making the given changes to the model.
+ *
+ * @param identifier
+ * The identifier of the object that has been modified, if it exists.
+ * If the object is being created, this will be null.
+ *
+ * @param model
+ * The model that has been modified, if any. If the object is being
+ * deleted, this will be null.
+ *
+ * @return
+ * A collection of the identifiers of all parents that will be affected
+ * (updated) by the change.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while determining which parents are affected.
+ */
+ protected Collection getModifiedParents(ModeledAuthenticatedUser user,
+ String identifier, ModelType model) throws GuacamoleException {
+
+ // Get old parent identifier
+ String oldParentIdentifier = null;
+ if (identifier != null) {
+ ModelType current = retrieveObject(user, identifier).getModel();
+ oldParentIdentifier = current.getParentIdentifier();
+ }
+
+ // Get new parent identifier
+ String parentIdentifier = null;
+ if (model != null) {
+
+ parentIdentifier = model.getParentIdentifier();
+
+ // If both parents have the same identifier, nothing has changed
+ if (parentIdentifier != null && parentIdentifier.equals(oldParentIdentifier))
+ return Collections.emptyList();
+
+ }
+
+ // Return collection of all non-root parents involved
+ Collection parents = new ArrayList(2);
+ if (oldParentIdentifier != null) parents.add(oldParentIdentifier);
+ if (parentIdentifier != null) parents.add(parentIdentifier);
+ return parents;
+
+ }
+
+ /**
+ * Returns whether the given user has permission to modify the parents
+ * affected by the modifications made to the given model object.
+ *
+ * @param user
+ * The user who changed the model object.
+ *
+ * @param identifier
+ * The identifier of the object that has been modified, if it exists.
+ * If the object is being created, this will be null.
+ *
+ * @param model
+ * The model that has been modified, if any. If the object is being
+ * deleted, this will be null.
+ *
+ * @return
+ * true if the user has update permission for all modified parents,
+ * false otherwise.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while determining which parents are affected.
+ */
+ protected boolean canUpdateModifiedParents(ModeledAuthenticatedUser user,
+ String identifier, ModelType model) throws GuacamoleException {
+
+ // If user is privileged, no need to check
+ if (user.isPrivileged())
+ return true;
+
+ // Verify that we have permission to modify any modified parents
+ Collection modifiedParents = getModifiedParents(user, identifier, model);
+ if (!modifiedParents.isEmpty()) {
+
+ ObjectPermissionSet permissionSet = getParentEffectivePermissionSet(user);
+ Collection updateableParents = permissionSet.getAccessibleObjects(
+ Collections.singleton(ObjectPermission.Type.UPDATE),
+ modifiedParents
+ );
+
+ return updateableParents.size() == modifiedParents.size();
+
+ }
+
+ return true;
+
+ }
+
+ @Override
+ protected void beforeCreate(ModeledAuthenticatedUser user,
+ ExternalType object, ModelType model) throws GuacamoleException {
+
+ super.beforeCreate(user, object, model);
+
+ // Validate that we can update all applicable parents
+ if (!canUpdateModifiedParents(user, null, model))
+ throw new GuacamoleSecurityException("Permission denied.");
+
+ }
+
+ @Override
+ protected void beforeUpdate(ModeledAuthenticatedUser user,
+ InternalType object, ModelType model) throws GuacamoleException {
+
+ super.beforeUpdate(user, object, model);
+
+ // Validate that we can update all applicable parents
+ if (!canUpdateModifiedParents(user, model.getIdentifier(), model))
+ throw new GuacamoleSecurityException("Permission denied.");
+
+ }
+
+ @Override
+ protected void beforeDelete(ModeledAuthenticatedUser user,
+ String identifier) throws GuacamoleException {
+
+ super.beforeDelete(user, identifier);
+
+ // Validate that we can update all applicable parents
+ if (!canUpdateModifiedParents(user, identifier, null))
+ throw new GuacamoleSecurityException("Permission denied.");
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledDirectoryObject.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledDirectoryObject.java
new file mode 100644
index 0000000..ddeda92
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledDirectoryObject.java
@@ -0,0 +1,98 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
+import org.apache.guacamole.net.auth.Attributes;
+import org.apache.guacamole.net.auth.Identifiable;
+
+/**
+ * Common base class for objects that will ultimately be made available through
+ * the Directory class and are persisted to an underlying database model. All
+ * such objects will need the same base set of queries to fulfill the needs of
+ * the Directory class.
+ *
+ * @param
+ * The type of model object that corresponds to this object.
+ */
+public abstract class ModeledDirectoryObject
+ extends ModeledObject implements Identifiable, Attributes {
+
+ @Override
+ public String getIdentifier() {
+ return getModel().getIdentifier();
+ }
+
+ @Override
+ public void setIdentifier(String identifier) {
+ getModel().setIdentifier(identifier);
+ }
+
+ /**
+ * Returns the names of all attributes explicitly supported by this object.
+ * Attributes named here have associated mappings within the backing model
+ * object, and thus should not be included in the arbitrary attribute
+ * storage. Any attributes set which do not match these names, such as those
+ * set via other extensions, will be added to arbitrary attribute storage.
+ *
+ * @return
+ * A read-only Set of the names of all attributes explicitly supported
+ * (mapped to a property of the backing model) by this object.
+ */
+ public Set getSupportedAttributeNames() {
+ return Collections.emptySet();
+ }
+
+ @Override
+ public Map getAttributes() {
+ return new HashMap(getModel().getArbitraryAttributeMap());
+ }
+
+ @Override
+ public void setAttributes(Map attributes) {
+
+ ArbitraryAttributeMap arbitraryAttributes = getModel().getArbitraryAttributeMap();
+
+ // Get set of all supported attribute names
+ Set supportedAttributes = getSupportedAttributeNames();
+
+ // Store remaining attributes only if not directly mapped to model
+ for (Map.Entry attribute : attributes.entrySet()) {
+
+ String name = attribute.getKey();
+ String value = attribute.getValue();
+
+ // Handle null attributes as explicit removal of that attribute,
+ // as the underlying model cannot store null attribute values
+ if (!supportedAttributes.contains(name)) {
+ if (value == null)
+ arbitraryAttributes.remove(name);
+ else
+ arbitraryAttributes.put(name, value);
+ }
+
+ }
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledDirectoryObjectMapper.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledDirectoryObjectMapper.java
new file mode 100644
index 0000000..971ae46
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledDirectoryObjectMapper.java
@@ -0,0 +1,190 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import java.util.Collection;
+import java.util.Set;
+import org.apache.guacamole.auth.jdbc.user.UserModel;
+import org.apache.guacamole.properties.CaseSensitivity;
+import org.apache.ibatis.annotations.Param;
+
+/**
+ * Common interface for objects that will ultimately be made available through
+ * the Directory class. All such objects will need the same base set of queries
+ * to fulfill the needs of the Directory class.
+ *
+ * @param
+ * The type of object contained within the directory whose objects are
+ * mapped by this mapper.
+ */
+public interface ModeledDirectoryObjectMapper {
+
+ /**
+ * Selects the identifiers of all objects, regardless of whether they
+ * are readable by any particular user. This should only be called on
+ * behalf of a system administrator. If identifiers are needed by a non-
+ * administrative user who must have explicit read rights, use
+ * selectReadableIdentifiers() instead.
+ *
+ * @return
+ * A Set containing all identifiers of all objects.
+ */
+ Set selectIdentifiers();
+
+ /**
+ * Selects the identifiers of all objects that are explicitly readable by
+ * the given user. If identifiers are needed by a system administrator
+ * (who, by definition, does not need explicit read rights), use
+ * selectIdentifiers() instead.
+ *
+ * @param user
+ * The user whose permissions should determine whether an identifier
+ * is returned.
+ *
+ * @param effectiveGroups
+ * The identifiers of any known effective groups that should be taken
+ * into account, such as those defined externally to the database.
+ *
+ * @param caseSensitivity
+ * The object that contains current configuration for case sensitivity
+ * for usernames and group names.
+ *
+ * @return
+ * A Set containing all identifiers of all readable objects.
+ */
+ Set selectReadableIdentifiers(@Param("user") UserModel user,
+ @Param("effectiveGroups") Collection effectiveGroups,
+ @Param("caseSensitivity") CaseSensitivity caseSensitivity);
+
+ /**
+ * Selects all objects which have the given identifiers. If an identifier
+ * has no corresponding object, it will be ignored. This should only be
+ * called on behalf of a system administrator. If objects are needed by a
+ * non-administrative user who must have explicit read rights, use
+ * selectReadable() instead.
+ *
+ * @param identifiers
+ * The identifiers of the objects to return.
+ *
+ * @param caseSensitivity
+ * The object that contains current configuration for case sensitivity
+ * for usernames and group names.
+ *
+ * @return
+ * A Collection of all objects having the given identifiers.
+ */
+ Collection select(@Param("identifiers") Collection identifiers,
+ @Param("caseSensitivity") CaseSensitivity caseSensitivity);
+
+ /**
+ * Selects all objects which have the given identifiers and are explicitly
+ * readably by the given user. If an identifier has no corresponding
+ * object, or the corresponding object is unreadable, it will be ignored.
+ * If objects are needed by a system administrator (who, by definition,
+ * does not need explicit read rights), use select() instead.
+ *
+ * @param user
+ * The user whose permissions should determine whether an object
+ * is returned.
+ *
+ * @param identifiers
+ * The identifiers of the objects to return.
+ *
+ * @param effectiveGroups
+ * The identifiers of any known effective groups that should be taken
+ * into account, such as those defined externally to the database.
+ *
+ * @param caseSensitivity
+ * The object that contains current configuration for case sensitivity
+ * for usernames and group names.
+ *
+ * @return
+ * A Collection of all objects having the given identifiers.
+ */
+ Collection selectReadable(@Param("user") UserModel user,
+ @Param("identifiers") Collection identifiers,
+ @Param("effectiveGroups") Collection effectiveGroups,
+ @Param("caseSensitivity") CaseSensitivity caseSensitivity);
+
+ /**
+ * Inserts the given object into the database. If the object already
+ * exists, this will result in an error.
+ *
+ * @param object
+ * The object to insert.
+ *
+ * @return
+ * The number of rows inserted.
+ */
+ int insert(@Param("object") ModelType object);
+
+ /**
+ * Deletes the given object into the database. If the object does not
+ * exist, this operation has no effect.
+ *
+ * @param identifier
+ * The identifier of the object to delete.
+ *
+ * @param caseSensitivity
+ * The case sensitivity configuration that contains information on
+ * whether usernames and/or group names will be treated as case-sensitive.
+ *
+ * @return
+ * The number of rows deleted.
+ */
+ int delete(@Param("identifier") String identifier,
+ @Param("caseSensitivity") CaseSensitivity caseSensitivity);
+
+ /**
+ * Updates the given existing object in the database. If the object does
+ * not actually exist, this operation has no effect.
+ *
+ * @param object
+ * The object to update.
+ *
+ * @return
+ * The number of rows updated.
+ */
+ int update(@Param("object") ModelType object);
+
+ /**
+ * Deletes any arbitrary attributes currently associated with the given
+ * object in the database.
+ *
+ * @param object
+ * The object whose arbitrary attributes should be deleted.
+ *
+ * @return
+ * The number of rows deleted.
+ */
+ int deleteAttributes(@Param("object") ModelType object);
+
+ /**
+ * Inserts all arbitrary attributes associated with the given object.
+ *
+ * @param object
+ * The object whose arbitrary attributes should be inserted.
+ *
+ * @return
+ * The number of rows inserted.
+ */
+ int insertAttributes(@Param("object") ModelType object);
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledDirectoryObjectService.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledDirectoryObjectService.java
new file mode 100644
index 0000000..0adcfbe
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledDirectoryObjectService.java
@@ -0,0 +1,574 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import com.google.common.collect.Lists;
+import com.google.inject.Inject;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.GuacamoleSecurityException;
+import org.apache.guacamole.auth.jdbc.user.ModeledAuthenticatedUser;
+import org.apache.guacamole.auth.jdbc.JDBCEnvironment;
+import org.apache.guacamole.auth.jdbc.permission.ObjectPermissionMapper;
+import org.apache.guacamole.auth.jdbc.permission.ObjectPermissionModel;
+import org.apache.guacamole.auth.jdbc.user.UserModel;
+import org.apache.guacamole.net.auth.Identifiable;
+import org.apache.guacamole.net.auth.permission.ObjectPermission;
+import org.apache.guacamole.net.auth.permission.ObjectPermissionSet;
+import org.apache.guacamole.properties.CaseSensitivity;
+import org.mybatis.guice.transactional.Transactional;
+
+/**
+ * Service which provides convenience methods for creating, retrieving, and
+ * manipulating objects within directories. This service will automatically
+ * enforce the permissions of the current user.
+ *
+ * @param
+ * The specific internal implementation of the type of object this service
+ * provides access to.
+ *
+ * @param
+ * The external interface or implementation of the type of object this
+ * service provides access to, as defined by the guacamole-ext API.
+ *
+ * @param
+ * The underlying model object used to represent InternalType in the
+ * database.
+ */
+public abstract class ModeledDirectoryObjectService,
+ ExternalType extends Identifiable, ModelType extends ObjectModel>
+ implements DirectoryObjectService {
+
+ /**
+ * All object permissions which are implicitly granted upon creation to the
+ * creator of the object.
+ */
+ private static final ObjectPermission.Type[] IMPLICIT_OBJECT_PERMISSIONS = {
+ ObjectPermission.Type.READ,
+ ObjectPermission.Type.UPDATE,
+ ObjectPermission.Type.DELETE,
+ ObjectPermission.Type.ADMINISTER
+ };
+
+ /**
+ * The environment of the Guacamole server.
+ */
+ @Inject
+ private JDBCEnvironment environment;
+
+ /**
+ * Returns an instance of a mapper for the type of object used by this
+ * service.
+ *
+ * @return
+ * A mapper which provides access to the model objects associated with
+ * the objects used by this service.
+ */
+ protected abstract ModeledDirectoryObjectMapper getObjectMapper();
+
+ /**
+ * Returns an instance of a mapper for the type of permissions that affect
+ * the type of object used by this service.
+ *
+ * @return
+ * A mapper which provides access to the model objects associated with
+ * the permissions that affect the objects used by this service.
+ */
+ protected abstract ObjectPermissionMapper getPermissionMapper();
+
+ /**
+ * Returns an instance of an object which is backed by the given model
+ * object.
+ *
+ * @param currentUser
+ * The user for whom this object is being created.
+ *
+ * @param model
+ * The model object to use to back the returned object.
+ *
+ * @return
+ * An object which is backed by the given model object.
+ *
+ * @throws GuacamoleException
+ * If the object instance cannot be created.
+ */
+ protected abstract InternalType getObjectInstance(ModeledAuthenticatedUser currentUser,
+ ModelType model) throws GuacamoleException;
+
+ /**
+ * Returns the case sensitivity configuration for this service, which will
+ * be used to determine whether usernames and/or group names will be treated
+ * as case-sensitive.
+ *
+ * @return
+ * The case sensitivity configuration for this service.
+ *
+ * @throws GuacamoleException
+ * If an error occurs retrieving relevant configuration information.
+ */
+ protected CaseSensitivity getCaseSensitivity() throws GuacamoleException {
+
+ // Retrieve the Guacamole setting.
+ return environment.getCaseSensitivity();
+
+ }
+
+ /**
+ * Returns an instance of a model object which is based on the given
+ * object.
+ *
+ * @param currentUser
+ * The user for whom this model object is being created.
+ *
+ * @param object
+ * The object to use to produce the returned model object.
+ *
+ * @return
+ * A model object which is based on the given object.
+ *
+ * @throws GuacamoleException
+ * If the model object instance cannot be created.
+ */
+ protected abstract ModelType getModelInstance(ModeledAuthenticatedUser currentUser,
+ ExternalType object) throws GuacamoleException;
+
+ /**
+ * Returns whether the given user has permission to create the type of
+ * objects that this directory object service manages, taking into account
+ * permission inheritance through user groups.
+ *
+ * @param user
+ * The user being checked.
+ *
+ * @return
+ * true if the user has object creation permission relevant to this
+ * directory object service, false otherwise.
+ *
+ * @throws GuacamoleException
+ * If permission to read the user's permissions is denied.
+ */
+ protected abstract boolean hasCreatePermission(ModeledAuthenticatedUser user)
+ throws GuacamoleException;
+
+ /**
+ * Returns whether the given user has permission to perform a certain
+ * action on a specific object managed by this directory object service,
+ * taking into account permission inheritance through user groups.
+ *
+ * @param user
+ * The user being checked.
+ *
+ * @param identifier
+ * The identifier of the object to check.
+ *
+ * @param type
+ * The type of action that will be performed.
+ *
+ * @return
+ * true if the user has object permission relevant described, false
+ * otherwise.
+ *
+ * @throws GuacamoleException
+ * If permission to read the user's permissions is denied.
+ */
+ protected boolean hasObjectPermission(ModeledAuthenticatedUser user,
+ String identifier, ObjectPermission.Type type)
+ throws GuacamoleException {
+
+ // Get object permissions
+ ObjectPermissionSet permissionSet = getEffectivePermissionSet(user);
+
+ // Return whether permission is granted
+ return user.isPrivileged()
+ || permissionSet.hasPermission(type, identifier);
+
+ }
+
+ /**
+ * Returns the permission set associated with the given user and related
+ * to the type of objects handled by this directory object service, taking
+ * into account permission inheritance via user groups.
+ *
+ * @param user
+ * The user whose permissions are being retrieved.
+ *
+ * @return
+ * A permission set which contains the permissions associated with the
+ * given user and related to the type of objects handled by this
+ * directory object service.
+ *
+ * @throws GuacamoleException
+ * If permission to read the user's permissions is denied.
+ */
+ protected abstract ObjectPermissionSet getEffectivePermissionSet(ModeledAuthenticatedUser user)
+ throws GuacamoleException;
+
+ /**
+ * Returns a collection of objects which are backed by the models in the
+ * given collection.
+ *
+ * @param currentUser
+ * The user for whom these objects are being created.
+ *
+ * @param models
+ * The model objects to use to back the objects within the returned
+ * collection.
+ *
+ * @return
+ * A collection of objects which are backed by the models in the given
+ * collection.
+ *
+ * @throws GuacamoleException
+ * If any of the object instances cannot be created.
+ */
+ protected Collection getObjectInstances(ModeledAuthenticatedUser currentUser,
+ Collection models) throws GuacamoleException {
+
+ // Create new collection of objects by manually converting each model
+ Collection objects = new ArrayList<>(models.size());
+ for (ModelType model : models)
+ objects.add(getObjectInstance(currentUser, model));
+
+ return objects;
+
+ }
+
+ /**
+ * Called before any object is created through this directory object
+ * service. This function serves as a final point of validation before
+ * the create operation occurs. In its default implementation,
+ * beforeCreate() performs basic permissions checks.
+ *
+ * @param user
+ * The user creating the object.
+ *
+ * @param object
+ * The object being created.
+ *
+ * @param model
+ * The model of the object being created.
+ *
+ * @throws GuacamoleException
+ * If the object is invalid, or an error prevents validating the given
+ * object.
+ */
+ protected void beforeCreate(ModeledAuthenticatedUser user,
+ ExternalType object, ModelType model) throws GuacamoleException {
+
+ // Verify permission to create objects
+ if (!user.isPrivileged() && !hasCreatePermission(user))
+ throw new GuacamoleSecurityException("Permission denied.");
+
+ }
+
+ /**
+ * Called before any object is updated through this directory object
+ * service. This function serves as a final point of validation before
+ * the update operation occurs. In its default implementation,
+ * beforeUpdate() performs basic permissions checks.
+ *
+ * @param user
+ * The user updating the existing object.
+ *
+ * @param object
+ * The object being updated.
+ *
+ * @param model
+ * The model of the object being updated.
+ *
+ * @throws GuacamoleException
+ * If the object is invalid, or an error prevents validating the given
+ * object.
+ */
+ protected void beforeUpdate(ModeledAuthenticatedUser user,
+ InternalType object, ModelType model) throws GuacamoleException {
+
+ // By default, do nothing.
+ if (!hasObjectPermission(user, model.getIdentifier(), ObjectPermission.Type.UPDATE))
+ throw new GuacamoleSecurityException("Permission denied.");
+
+ }
+
+ /**
+ * Called before any object is deleted through this directory object
+ * service. This function serves as a final point of validation before
+ * the delete operation occurs. In its default implementation,
+ * beforeDelete() performs basic permissions checks.
+ *
+ * @param user
+ * The user deleting the existing object.
+ *
+ * @param identifier
+ * The identifier of the object being deleted.
+ *
+ * @throws GuacamoleException
+ * If the object is invalid, or an error prevents validating the given
+ * object.
+ */
+ protected void beforeDelete(ModeledAuthenticatedUser user,
+ String identifier) throws GuacamoleException {
+
+ // Verify permission to delete objects
+ if (!hasObjectPermission(user, identifier, ObjectPermission.Type.DELETE))
+ throw new GuacamoleSecurityException("Permission denied.");
+
+ }
+
+ /**
+ * Returns whether the given string is a valid identifier within the JDBC
+ * authentication extension. Invalid identifiers may result in SQL errors
+ * from the underlying database when used in queries.
+ *
+ * @param identifier
+ * The string to check for validity.
+ *
+ * @return
+ * true if the given string is a valid identifier, false otherwise.
+ */
+ protected boolean isValidIdentifier(String identifier) {
+
+ // Empty identifiers are invalid
+ if (identifier.isEmpty())
+ return false;
+
+ // Identifier is invalid if any non-numeric characters are present
+ for (int i = 0; i < identifier.length(); i++) {
+ if (!Character.isDigit(identifier.charAt(i)))
+ return false;
+ }
+
+ // Identifier is valid - contains only numeric characters
+ return true;
+
+ }
+
+ /**
+ * Filters the given collection of strings, returning a new collection
+ * containing only those strings which are valid identifiers. If no strings
+ * within the collection are valid identifiers, the returned collection will
+ * simply be empty.
+ *
+ * @param identifiers
+ * The collection of strings to filter.
+ *
+ * @return
+ * A new collection containing only the strings within the provided
+ * collection which are valid identifiers.
+ */
+ protected List filterIdentifiers(Collection identifiers) {
+
+ // Obtain enough space for a full copy of the given identifiers
+ List validIdentifiers = new ArrayList<>(identifiers.size());
+
+ // Add only valid identifiers to the copy
+ for (String identifier : identifiers) {
+ if (isValidIdentifier(identifier))
+ validIdentifiers.add(identifier);
+ }
+
+ return validIdentifiers;
+
+ }
+
+ @Override
+ public InternalType retrieveObject(ModeledAuthenticatedUser user,
+ String identifier) throws GuacamoleException {
+
+ // Pull objects having given identifier
+ Collection objects = retrieveObjects(user, Collections.singleton(identifier));
+
+ // If no such object, return null
+ if (objects.isEmpty())
+ return null;
+
+ // The object collection will have exactly one element unless the
+ // database has seriously lost integrity
+ assert(objects.size() == 1);
+
+ // Return first and only object
+ return objects.iterator().next();
+
+ }
+
+ @Override
+ public Collection retrieveObjects(ModeledAuthenticatedUser user,
+ Collection identifiers) throws GuacamoleException {
+
+ // Ignore invalid identifiers
+ List filteredIdentifiers = filterIdentifiers(identifiers);
+
+ // Do not query if no identifiers given
+ if (filteredIdentifiers.isEmpty())
+ return Collections.emptyList();
+
+ int batchSize = environment.getBatchSize();
+
+ boolean userIsPrivileged = user.isPrivileged();
+
+ CaseSensitivity caseSensitivity = getCaseSensitivity();
+
+ // Process the filteredIdentifiers in batches using Lists.partition() and flatMap
+ Collection allObjects = Lists.partition(filteredIdentifiers, batchSize).stream()
+ .flatMap(chunk -> {
+ Collection objects;
+
+ // Bypass permission checks if the user is privileged
+ if (userIsPrivileged)
+ objects = getObjectMapper().select(chunk, caseSensitivity);
+
+ // Otherwise only return explicitly readable identifiers
+ else
+ objects = getObjectMapper().selectReadable(user.getUser().getModel(),
+ chunk, user.getEffectiveUserGroups(), caseSensitivity);
+
+ return objects.stream();
+ })
+ .collect(Collectors.toList());
+
+ // Return collection of requested objects
+ return getObjectInstances(user, allObjects);
+ }
+
+ /**
+ * Returns an immutable collection of permissions that should be granted due
+ * to the creation of the given object. These permissions need not be
+ * granted solely to the user creating the object.
+ *
+ * @param user
+ * The user creating the object.
+ *
+ * @param model
+ * The object being created.
+ *
+ * @return
+ * The collection of implicit permissions that should be granted due to
+ * the creation of the given object.
+ */
+ protected Collection getImplicitPermissions(ModeledAuthenticatedUser user,
+ ModelType model) {
+
+ // Check to see if the user granting permissions is a skeleton user,
+ // thus lacking database backing.
+ if (user.getUser().isSkeleton())
+ return Collections.emptyList();
+
+ // Build list of implicit permissions
+ Collection implicitPermissions =
+ new ArrayList<>(IMPLICIT_OBJECT_PERMISSIONS.length);
+
+
+ UserModel userModel = user.getUser().getModel();
+ for (ObjectPermission.Type permission : IMPLICIT_OBJECT_PERMISSIONS) {
+
+ // Create model which grants this permission to the current user
+ ObjectPermissionModel permissionModel = new ObjectPermissionModel();
+ permissionModel.setEntityID(userModel.getEntityID());
+ permissionModel.setType(permission);
+ permissionModel.setObjectIdentifier(model.getIdentifier());
+
+ // Add permission
+ implicitPermissions.add(permissionModel);
+
+ }
+
+ return Collections.unmodifiableCollection(implicitPermissions);
+
+ }
+
+ @Override
+ @Transactional
+ public InternalType createObject(ModeledAuthenticatedUser user, ExternalType object)
+ throws GuacamoleException {
+
+ ModelType model = getModelInstance(user, object);
+ beforeCreate(user, object, model);
+
+ // Create object
+ getObjectMapper().insert(model);
+
+ // Set identifier on original object
+ object.setIdentifier(model.getIdentifier());
+
+ // Add implicit permissions
+ Collection implicitPermissions = getImplicitPermissions(user, model);
+ if (!implicitPermissions.isEmpty())
+ getPermissionMapper().insert(implicitPermissions, getCaseSensitivity());
+
+ // Add any arbitrary attributes
+ if (model.hasArbitraryAttributes())
+ getObjectMapper().insertAttributes(model);
+
+ return getObjectInstance(user, model);
+
+ }
+
+ @Override
+ public void deleteObject(ModeledAuthenticatedUser user, String identifier)
+ throws GuacamoleException {
+
+ beforeDelete(user, identifier);
+
+ // Delete object
+ getObjectMapper().delete(identifier, getCaseSensitivity());
+
+ }
+
+ @Override
+ @Transactional
+ public void updateObject(ModeledAuthenticatedUser user, InternalType object)
+ throws GuacamoleException {
+
+ ModelType model = object.getModel();
+ beforeUpdate(user, object, model);
+
+ // Update object
+ getObjectMapper().update(model);
+
+ // Replace any existing arbitrary attributes
+ getObjectMapper().deleteAttributes(model);
+ if (model.hasArbitraryAttributes())
+ getObjectMapper().insertAttributes(model);
+
+ }
+
+ @Override
+ public Set getIdentifiers(ModeledAuthenticatedUser user)
+ throws GuacamoleException {
+
+ // Bypass permission checks if the user is privileged
+ if (user.isPrivileged())
+ return getObjectMapper().selectIdentifiers();
+
+ // Otherwise only return explicitly readable identifiers
+ else
+ return getObjectMapper().selectReadableIdentifiers(
+ user.getUser().getModel(),
+ user.getEffectiveUserGroups(),
+ getCaseSensitivity()
+ );
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledObject.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledObject.java
new file mode 100644
index 0000000..fa43c73
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledObject.java
@@ -0,0 +1,78 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import org.apache.guacamole.auth.jdbc.user.ModeledAuthenticatedUser;
+
+/**
+ * Common base class for objects have an underlying model. For the purposes of
+ * JDBC-driven authentication providers, all modeled objects are also
+ * restricted.
+ *
+ * @param
+ * The type of model object which corresponds to this object.
+ */
+public abstract class ModeledObject extends RestrictedObject {
+
+ /**
+ * The internal model object containing the values which represent this
+ * object in the database.
+ */
+ private ModelType model;
+
+ /**
+ * Initializes this object, associating it with the current authenticated
+ * user and populating it with data from the given model object
+ *
+ * @param currentUser
+ * The user that created or retrieved this object.
+ *
+ * @param model
+ * The backing model object.
+ */
+ public void init(ModeledAuthenticatedUser currentUser, ModelType model) {
+ super.init(currentUser);
+ setModel(model);
+ }
+
+ /**
+ * Returns the backing model object. Changes to the model object will
+ * affect this object, and changes to this object will affect the model
+ * object.
+ *
+ * @return
+ * The backing model object.
+ */
+ public ModelType getModel() {
+ return model;
+ }
+
+ /**
+ * Sets the backing model object. This will effectively replace all data
+ * contained within this object.
+ *
+ * @param model
+ * The backing model object.
+ */
+ public void setModel(ModelType model) {
+ this.model = model;
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledPermissions.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledPermissions.java
new file mode 100644
index 0000000..be5ac15
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledPermissions.java
@@ -0,0 +1,288 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import com.google.inject.Inject;
+import java.util.Collections;
+import java.util.Set;
+import org.apache.guacamole.auth.jdbc.permission.SystemPermissionService;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.auth.jdbc.activeconnection.ActiveConnectionPermissionService;
+import org.apache.guacamole.auth.jdbc.permission.ConnectionGroupPermissionService;
+import org.apache.guacamole.auth.jdbc.permission.ConnectionPermissionService;
+import org.apache.guacamole.auth.jdbc.permission.SharingProfilePermissionService;
+import org.apache.guacamole.auth.jdbc.permission.UserGroupPermissionService;
+import org.apache.guacamole.auth.jdbc.permission.UserPermissionService;
+import org.apache.guacamole.auth.jdbc.user.ModeledAuthenticatedUser;
+import org.apache.guacamole.net.auth.Permissions;
+import org.apache.guacamole.net.auth.permission.ObjectPermissionSet;
+import org.apache.guacamole.net.auth.permission.SystemPermission;
+import org.apache.guacamole.net.auth.permission.SystemPermissionSet;
+
+/**
+ * An implementation of the base Permissions interface which is common to both
+ * Users and UserGroups, backed by a database model.
+ *
+ * @param
+ * The type of model object that corresponds to this object.
+ */
+public abstract class ModeledPermissions
+ extends ModeledDirectoryObject implements Permissions {
+
+ /**
+ * Service for retrieving entity details.
+ */
+ @Inject
+ private EntityService entityService;
+
+ /**
+ * Service for retrieving system permissions.
+ */
+ @Inject
+ private SystemPermissionService systemPermissionService;
+
+ /**
+ * Service for retrieving connection permissions.
+ */
+ @Inject
+ private ConnectionPermissionService connectionPermissionService;
+
+ /**
+ * Service for retrieving connection group permissions.
+ */
+ @Inject
+ private ConnectionGroupPermissionService connectionGroupPermissionService;
+
+ /**
+ * Service for retrieving sharing profile permissions.
+ */
+ @Inject
+ private SharingProfilePermissionService sharingProfilePermissionService;
+
+ /**
+ * Service for retrieving active connection permissions.
+ */
+ @Inject
+ private ActiveConnectionPermissionService activeConnectionPermissionService;
+
+ /**
+ * Service for retrieving user permissions.
+ */
+ @Inject
+ private UserPermissionService userPermissionService;
+
+ /**
+ * Service for retrieving user group permissions.
+ */
+ @Inject
+ private UserGroupPermissionService userGroupPermissionService;
+
+ /**
+ * Returns whether the underlying entity is a user. Entities may be either
+ * users or user groups.
+ *
+ * @return
+ * true if the underlying entity is a user, false otherwise.
+ */
+ public boolean isUser() {
+ return getModel().getEntityType() == EntityType.USER;
+ }
+
+ /**
+ * Returns whether the underlying entity represents a specific user having
+ * the given username.
+ *
+ * @param username
+ * The username of a user.
+ *
+ * @return
+ * true if the underlying entity is a user that has the given username,
+ * false otherwise.
+ */
+ public boolean isUser(String username) {
+ return isUser() && getIdentifier().equals(username);
+ }
+
+ /**
+ * Returns whether the underlying entity is a user group. Entities may be
+ * either users or user groups.
+ *
+ * @return
+ * true if the underlying entity is a user group, false otherwise.
+ */
+ public boolean isUserGroup() {
+ return getModel().getEntityType() == EntityType.USER_GROUP;
+ }
+
+ /**
+ * Returns whether this entity is effectively unrestricted by permissions,
+ * such as a system administrator or an internal user operating via a
+ * privileged UserContext. Permission inheritance via user groups is taken
+ * into account.
+ *
+ * @return
+ * true if this entity should be unrestricted by permissions, false
+ * otherwise.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while determining whether permission restrictions
+ * apply to the entity.
+ */
+ public boolean isPrivileged() throws GuacamoleException {
+ SystemPermissionSet systemPermissionSet = getEffective().getSystemPermissions();
+ return systemPermissionSet.hasPermission(SystemPermission.Type.ADMINISTER);
+ }
+
+ @Override
+ public SystemPermissionSet getSystemPermissions()
+ throws GuacamoleException {
+ return systemPermissionService.getPermissionSet(getCurrentUser(), this,
+ Collections.emptySet());
+ }
+
+ @Override
+ public ObjectPermissionSet getConnectionPermissions()
+ throws GuacamoleException {
+ return connectionPermissionService.getPermissionSet(getCurrentUser(),
+ this, Collections.emptySet());
+ }
+
+ @Override
+ public ObjectPermissionSet getConnectionGroupPermissions()
+ throws GuacamoleException {
+ return connectionGroupPermissionService.getPermissionSet(
+ getCurrentUser(), this, Collections.emptySet());
+ }
+
+ @Override
+ public ObjectPermissionSet getSharingProfilePermissions()
+ throws GuacamoleException {
+ return sharingProfilePermissionService.getPermissionSet(
+ getCurrentUser(), this, Collections.emptySet());
+ }
+
+ @Override
+ public ObjectPermissionSet getActiveConnectionPermissions()
+ throws GuacamoleException {
+ return activeConnectionPermissionService.getPermissionSet(
+ getCurrentUser(), this, Collections.emptySet());
+ }
+
+ @Override
+ public ObjectPermissionSet getUserPermissions()
+ throws GuacamoleException {
+ return userPermissionService.getPermissionSet(getCurrentUser(), this,
+ Collections.emptySet());
+ }
+
+ @Override
+ public ObjectPermissionSet getUserGroupPermissions() throws GuacamoleException {
+ return userGroupPermissionService.getPermissionSet(getCurrentUser(),
+ this, Collections.emptySet());
+ }
+
+ /**
+ * Returns the identifiers of all user groups defined within the database
+ * which apply to this user, including any groups inherited through
+ * membership in yet more groups.
+ *
+ * @return
+ * The identifiers of all user groups defined within the database which
+ * apply to this user.
+ */
+ public Set getEffectiveUserGroups() {
+ return entityService.retrieveEffectiveGroups(this,
+ Collections.emptySet());
+ }
+
+ /**
+ * Returns a Permissions object which represents all permissions granted to
+ * this entity, including any permissions inherited through group
+ * membership.
+ *
+ * @return
+ * A Permissions object which represents all permissions granted to
+ * this entity.
+ */
+ public Permissions getEffective() {
+
+ final ModeledAuthenticatedUser authenticatedUser = getCurrentUser();
+ final Set effectiveGroups;
+
+ // If this user is the currently-authenticated user, include any
+ // additional effective groups declared by the authentication system
+ if (authenticatedUser.getIdentifier().equals(getIdentifier()))
+ effectiveGroups = entityService.retrieveEffectiveGroups(this,
+ authenticatedUser.getEffectiveUserGroups());
+
+ // Otherwise, just include effective groups from the database
+ else
+ effectiveGroups = getEffectiveUserGroups();
+
+ // Return a permissions object which describes all effective
+ // permissions, including any permissions inherited via user groups
+ return new Permissions() {
+
+ @Override
+ public ObjectPermissionSet getActiveConnectionPermissions()
+ throws GuacamoleException {
+ return activeConnectionPermissionService.getPermissionSet(authenticatedUser, ModeledPermissions.this, effectiveGroups);
+ }
+
+ @Override
+ public ObjectPermissionSet getConnectionGroupPermissions()
+ throws GuacamoleException {
+ return connectionGroupPermissionService.getPermissionSet(authenticatedUser, ModeledPermissions.this, effectiveGroups);
+ }
+
+ @Override
+ public ObjectPermissionSet getConnectionPermissions()
+ throws GuacamoleException {
+ return connectionPermissionService.getPermissionSet(authenticatedUser, ModeledPermissions.this, effectiveGroups);
+ }
+
+ @Override
+ public ObjectPermissionSet getSharingProfilePermissions()
+ throws GuacamoleException {
+ return sharingProfilePermissionService.getPermissionSet(authenticatedUser, ModeledPermissions.this, effectiveGroups);
+ }
+
+ @Override
+ public SystemPermissionSet getSystemPermissions()
+ throws GuacamoleException {
+ return systemPermissionService.getPermissionSet(authenticatedUser, ModeledPermissions.this, effectiveGroups);
+ }
+
+ @Override
+ public ObjectPermissionSet getUserPermissions()
+ throws GuacamoleException {
+ return userPermissionService.getPermissionSet(authenticatedUser, ModeledPermissions.this, effectiveGroups);
+ }
+
+ @Override
+ public ObjectPermissionSet getUserGroupPermissions()
+ throws GuacamoleException {
+ return userGroupPermissionService.getPermissionSet(getCurrentUser(), ModeledPermissions.this, effectiveGroups);
+ }
+
+ };
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ObjectModel.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ObjectModel.java
new file mode 100644
index 0000000..c3052b1
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ObjectModel.java
@@ -0,0 +1,149 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import java.util.Collection;
+
+/**
+ * Object representation of a Guacamole object, such as a user or connection,
+ * as represented in the database.
+ */
+public abstract class ObjectModel {
+
+ /**
+ * The ID of this object in the database, if any.
+ */
+ private Integer objectID;
+
+ /**
+ * The unique identifier which identifies this object.
+ */
+ private String identifier;
+
+ /**
+ * Map of all arbitrary attributes associated with this object but not
+ * directly mapped to a particular column.
+ */
+ private ArbitraryAttributeMap arbitraryAttributes =
+ new ArbitraryAttributeMap();
+
+ /**
+ * Creates a new, empty object.
+ */
+ public ObjectModel() {
+ }
+
+ /**
+ * Returns the identifier that uniquely identifies this object.
+ *
+ * @return
+ * The identifier that uniquely identifies this object.
+ */
+ public String getIdentifier() {
+ return identifier;
+ }
+
+ /**
+ * Sets the identifier that uniquely identifies this object.
+ *
+ * @param identifier
+ * The identifier that uniquely identifies this object.
+ */
+ public void setIdentifier(String identifier) {
+ this.identifier = identifier;
+ }
+
+ /**
+ * Returns the ID of this object in the database, if it exists.
+ *
+ * @return
+ * The ID of this object in the database, or null if this object was
+ * not retrieved from the database.
+ */
+ public Integer getObjectID() {
+ return objectID;
+ }
+
+ /**
+ * Sets the ID of this object to the given value.
+ *
+ * @param objectID
+ * The ID to assign to this object.
+ */
+ public void setObjectID(Integer objectID) {
+ this.objectID = objectID;
+ }
+
+ /**
+ * Returns a map of attribute name/value pairs for all attributes associated
+ * with this model which do not have explicit mappings to actual model
+ * properties. All other attributes (those which are explicitly supported
+ * by the model) should instead be mapped to properties with corresponding
+ * and properly-typed columns.
+ *
+ * @return
+ * A map of attribute name/value pairs for all attributes associated
+ * with this model which do not otherwise have explicit mappings to
+ * properties.
+ */
+ public ArbitraryAttributeMap getArbitraryAttributeMap() {
+ return arbitraryAttributes;
+ }
+
+ /**
+ * Returns whether at least one arbitrary attribute name/value pair has
+ * been associated with this object.
+ *
+ * @return
+ * true if this object has at least one arbitrary attribute set, false
+ * otherwise.
+ */
+ public boolean hasArbitraryAttributes() {
+ return !arbitraryAttributes.isEmpty();
+ }
+
+ /**
+ * Returns a Collection view of the equivalent attribute model objects
+ * which make up the map of arbitrary attribute name/value pairs returned
+ * by getArbitraryAttributeMap(). Additions and removals on the returned
+ * Collection directly affect the attribute map.
+ *
+ * @return
+ * A Collection view of the map returned by
+ * getArbitraryAttributeMap().
+ */
+ public Collection getArbitraryAttributes() {
+ return arbitraryAttributes.toModelCollection();
+ }
+
+ /**
+ * Replaces all arbitrary attributes associated with this object with the
+ * attribute name/value pairs within the given collection of model objects.
+ *
+ * @param arbitraryAttributes
+ * The Collection of model objects containing the attribute name/value
+ * pairs which should replace all currently-stored arbitrary attributes,
+ * if any.
+ */
+ public void setArbitraryAttributes(Collection arbitraryAttributes) {
+ this.arbitraryAttributes = ArbitraryAttributeMap.fromModelCollection(arbitraryAttributes);
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ObjectRelationMapper.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ObjectRelationMapper.java
new file mode 100644
index 0000000..a155f25
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ObjectRelationMapper.java
@@ -0,0 +1,142 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import java.util.Collection;
+import java.util.Set;
+import org.apache.guacamole.auth.jdbc.user.UserModel;
+import org.apache.guacamole.properties.CaseSensitivity;
+import org.apache.ibatis.annotations.Param;
+
+/**
+ * Mapper for the relations represented by a particular RelatedObjectSet
+ * implementation.
+ *
+ * @param
+ * The underlying database model of the object on the parent side of the
+ * one-to-many relationship represented by the RelatedObjectSet mapped by
+ * this ObjectRelationMapper.
+ */
+public interface ObjectRelationMapper {
+
+ /**
+ * Inserts rows as necessary to establish the one-to-many relationship
+ * represented by the RelatedObjectSet between the given parent and
+ * children. If the relation for any parent/child pair is already present,
+ * no attempt is made to insert a new row for that relation.
+ *
+ * @param parent
+ * The model of the object on the parent side of the one-to-many
+ * relationship represented by the RelatedObjectSet.
+ *
+ * @param children
+ * The identifiers of the objects on the child side of the one-to-many
+ * relationship represented by the RelatedObjectSet.
+ *
+ * @param caseSensitivity
+ * The case sensitivity configuration, used to determine whether
+ * usernames and/or group names will be treated as case-sensitive.
+ *
+ * @return
+ * The number of rows inserted.
+ */
+ int insert(@Param("parent") ParentModelType parent,
+ @Param("children") Collection children,
+ @Param("caseSensitivity") CaseSensitivity caseSensitivity);
+
+ /**
+ * Deletes rows as necessary to modify the one-to-many relationship
+ * represented by the RelatedObjectSet between the given parent and
+ * children. If the relation for any parent/child pair does not exist,
+ * that specific relation is ignored, and deletion proceeds with the
+ * remaining relations.
+ *
+ * @param parent
+ * The model of the object on the parent side of the one-to-many
+ * relationship represented by the RelatedObjectSet.
+ *
+ * @param children
+ * The identifiers of the objects on the child side of the one-to-many
+ * relationship represented by the RelatedObjectSet.
+ *
+ * @param caseSensitivity
+ * The case sensitivity configuration, used to determine whether
+ * usernames and/or group names will be treated as case-sensitive.
+ *
+ * @return
+ * The number of rows deleted.
+ */
+ int delete(@Param("parent") ParentModelType parent,
+ @Param("children") Collection children,
+ @Param("caseSensitivity") CaseSensitivity caseSensitivity);
+
+ /**
+ * Retrieves the identifiers of all objects on the child side of the
+ * one-to-many relationship represented by the RelatedObjectSet mapped by
+ * this ObjectRelationMapper. This should only be called on behalf of a
+ * system administrator. If identifiers are needed by a non-administrative
+ * user who must have explicit read rights, use
+ * selectReadableChildIdentifiers() instead.
+ *
+ * @param parent
+ * The model of the object on the parent side of the one-to-many
+ * relationship represented by the RelatedObjectSet.
+ *
+ * @return
+ * A Set containing the identifiers of all objects on the child side
+ * of the one-to-many relationship.
+ */
+ Set selectChildIdentifiers(@Param("parent") ParentModelType parent);
+
+ /**
+ * Retrieves the identifiers of all objects on the child side of the
+ * one-to-many relationship represented by the RelatedObjectSet mapped by
+ * this ObjectRelationMapper, including only those objects which are
+ * explicitly readable by the given user. If identifiers are needed by a
+ * system administrator (who, by definition, does not need explicit read
+ * rights), use selectChildIdentifiers() instead.
+
+ *
+ * @param user
+ * The user whose permissions should determine whether an identifier
+ * is returned.
+ *
+ * @param effectiveGroups
+ * The identifiers of any known effective groups that should be taken
+ * into account, such as those defined externally to the database.
+ *
+ * @param caseSensitivity
+ * The object that contains current configuration for case sensitivity
+ * for usernames and group names.
+ *
+ * @param parent
+ * The model of the object on the parent side of the one-to-many
+ * relationship represented by the RelatedObjectSet.
+ *
+ * @return
+ * A Set containing the identifiers of all readable objects on the
+ * child side of the one-to-many relationship.
+ */
+ Set selectReadableChildIdentifiers(@Param("user") UserModel user,
+ @Param("effectiveGroups") Collection effectiveGroups,
+ @Param("caseSensitivity") CaseSensitivity caseSensitivity,
+ @Param("parent") ParentModelType parent);
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/RelatedObjectSet.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/RelatedObjectSet.java
new file mode 100644
index 0000000..541afc7
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/RelatedObjectSet.java
@@ -0,0 +1,234 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Set;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.GuacamoleSecurityException;
+import org.apache.guacamole.auth.jdbc.user.ModeledAuthenticatedUser;
+import org.apache.guacamole.net.auth.permission.ObjectPermission;
+import org.apache.guacamole.net.auth.permission.ObjectPermissionSet;
+import org.apache.guacamole.properties.CaseSensitivity;
+
+/**
+ * A database implementation of RelatedObjectSet which provides access to a
+ * parent object and corresponding set of objects related to the parent, subject
+ * to object-level permissions. Though the parent and child objects have
+ * specific types, only the parent object's type is enforced through type
+ * parameters, as child objects are represented by identifiers only.
+ *
+ * @param
+ * The type of object that represents the parent side of the relation.
+ *
+ * @param
+ * The underlying database model of the parent object.
+ */
+public abstract class RelatedObjectSet, ParentModelType extends ObjectModel>
+ extends RestrictedObject implements org.apache.guacamole.net.auth.RelatedObjectSet {
+
+ /**
+ * The parent object which shares some arbitrary relation with the objects
+ * within this set.
+ */
+ private ParentObjectType parent;
+
+ /**
+ * Creates a new RelatedObjectSet. The resulting object set must still be
+ * initialized by a call to init().
+ */
+ public RelatedObjectSet() {
+ }
+
+ /**
+ * Initializes this RelatedObjectSet with the current user and the single
+ * object on the parent side of the one-to-many relation represented by the
+ * set.
+ *
+ * @param currentUser
+ * The user who queried this RelatedObjectSet, and whose permissions
+ * dictate the access level of all operations performed on this set.
+ *
+ * @param parent
+ * The parent object which shares some arbitrary relation with the
+ * objects within this set.
+ */
+ public void init(ModeledAuthenticatedUser currentUser, ParentObjectType parent) {
+ super.init(currentUser);
+ this.parent = parent;
+ }
+
+ /**
+ * Return the current case sensitivity setting, which can be used to
+ * determine whether or not certain identifiers should be treated as
+ * case-sensitive.
+ *
+ * @return
+ * The current case sensitivity setting.
+ *
+ * @throws GuacamoleException
+ * If an error occurs retrieving configuration information on
+ * case sensitivity.
+ */
+ protected CaseSensitivity getCaseSensitivity() throws GuacamoleException {
+
+ // Identifiers are not case-sensitive by default.
+ return CaseSensitivity.DISABLED;
+ }
+
+ /**
+ * Returns the mapper which provides low-level access to the database
+ * models which drive the relation represented by this RelatedObjectSet.
+ *
+ * @return
+ * The mapper which provides low-level access to the database
+ * models which drive the relation represented by this
+ * RelatedObjectSet.
+ */
+ protected abstract ObjectRelationMapper getObjectRelationMapper();
+
+ /**
+ * Returns the permission set which exposes the effective permissions
+ * available to the current user regarding the objects on the parent side
+ * of the one-to-many relationship represented by this RelatedObjectSet.
+ * Permission inheritance through user groups is taken into account.
+ *
+ * @return
+ * The permission set which exposes the effective permissions
+ * available to the current user regarding the objects on the parent
+ * side of the one-to-many relationship represented by this
+ * RelatedObjectSet.
+ *
+ * @throws GuacamoleException
+ * If permission to query permission status is denied.
+ */
+ protected abstract ObjectPermissionSet getParentObjectEffectivePermissionSet()
+ throws GuacamoleException;
+
+ /**
+ * Returns the permission set which exposes the effective permissions
+ * available to the current user regarding the objects on the child side
+ * of the one-to-many relationship represented by this RelatedObjectSet.
+ * Permission inheritance through user groups is taken into account.
+ *
+ * @return
+ * The permission set which exposes the effective permissions
+ * available to the current user regarding the objects on the child
+ * side of the one-to-many relationship represented by this
+ * RelatedObjectSet.
+ *
+ * @throws GuacamoleException
+ * If permission to query permission status is denied.
+ */
+ protected abstract ObjectPermissionSet getChildObjectEffectivePermissionSet()
+ throws GuacamoleException;
+
+ /**
+ * Returns whether the current user has permission to alter the status of
+ * the relation between the parent object and the given child objects.
+ *
+ * @param identifiers
+ * The identifiers of all objects on the child side of the one-to-many
+ * relation being changed.
+ *
+ * @return
+ * true if the user has permission to make the described changes,
+ * false otherwise.
+ *
+ * @throws GuacamoleException
+ * If permission to query permission status is denied.
+ */
+ private boolean canAlterRelation(Collection identifiers)
+ throws GuacamoleException {
+
+ // Privileged users (such as system administrators) may alter any
+ // relations
+ if (getCurrentUser().isPrivileged())
+ return true;
+
+ // Non-admin users require UPDATE permission on the parent object ...
+ if (!getParentObjectEffectivePermissionSet().hasPermission(
+ ObjectPermission.Type.UPDATE, parent.getIdentifier()))
+ return false;
+
+ // ... as well as UPDATE permission on all child objects being changed
+ Collection accessibleIdentifiers =
+ getChildObjectEffectivePermissionSet().getAccessibleObjects(
+ Collections.singleton(ObjectPermission.Type.UPDATE),
+ identifiers);
+
+ return accessibleIdentifiers.size() == identifiers.size();
+
+ }
+
+ @Override
+ public Set getObjects() throws GuacamoleException {
+
+ // Bypass permission checks if the user is a privileged
+ ModeledAuthenticatedUser user = getCurrentUser();
+ if (user.isPrivileged())
+ return getObjectRelationMapper().selectChildIdentifiers(parent.getModel());
+
+ // Otherwise only return explicitly readable identifiers
+ return getObjectRelationMapper().selectReadableChildIdentifiers(
+ user.getUser().getModel(), user.getEffectiveUserGroups(),
+ getCaseSensitivity(),
+ parent.getModel());
+
+ }
+
+ @Override
+ public void addObjects(Set identifiers) throws GuacamoleException {
+
+ // Nothing to do if nothing provided
+ if (identifiers.isEmpty())
+ return;
+
+ // Create relations only if permission is granted
+ if (canAlterRelation(identifiers))
+ getObjectRelationMapper().insert(parent.getModel(), identifiers,
+ getCaseSensitivity());
+
+ // User lacks permission to add user groups
+ else
+ throw new GuacamoleSecurityException("Permission denied.");
+
+ }
+
+ @Override
+ public void removeObjects(Set identifiers) throws GuacamoleException {
+
+ // Nothing to do if nothing provided
+ if (identifiers.isEmpty())
+ return;
+
+ // Delete relations only if permission is granted
+ if (canAlterRelation(identifiers))
+ getObjectRelationMapper().delete(parent.getModel(), identifiers,
+ getCaseSensitivity());
+
+ // User lacks permission to remove user groups
+ else
+ throw new GuacamoleSecurityException("Permission denied.");
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/RestrictedObject.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/RestrictedObject.java
new file mode 100644
index 0000000..66979d4
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/RestrictedObject.java
@@ -0,0 +1,71 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.base;
+
+import org.apache.guacamole.auth.jdbc.user.ModeledAuthenticatedUser;
+
+/**
+ * Common base class for objects that are associated with the users that
+ * obtain them.
+ */
+public abstract class RestrictedObject {
+
+ /**
+ * The user this object belongs to. Access is based on his/her permission
+ * settings.
+ */
+ private ModeledAuthenticatedUser currentUser;
+
+ /**
+ * Initializes this object, associating it with the current authenticated
+ * user and populating it with data from the given model object
+ *
+ * @param currentUser
+ * The user that created or retrieved this object.
+ */
+ public void init(ModeledAuthenticatedUser currentUser) {
+ setCurrentUser(currentUser);
+ }
+
+ /**
+ * Returns the user that created or queried this object. This user's
+ * permissions dictate what operations can be performed on or through this
+ * object.
+ *
+ * @return
+ * The user that created or queried this object.
+ */
+ public ModeledAuthenticatedUser getCurrentUser() {
+ return currentUser;
+ }
+
+ /**
+ * Sets the user that created or queried this object. This user's
+ * permissions dictate what operations can be performed on or through this
+ * object.
+ *
+ * @param currentUser
+ * The user that created or queried this object.
+ */
+ public void setCurrentUser(ModeledAuthenticatedUser currentUser) {
+ this.currentUser = currentUser;
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/package-info.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/package-info.java
new file mode 100644
index 0000000..40911f3
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/package-info.java
@@ -0,0 +1,25 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * Base classes supporting JDBC-driven authentication providers and defining
+ * the relationships between the model and the implementations of guacamole-ext
+ * classes.
+ */
+package org.apache.guacamole.auth.jdbc.base;
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionDirectory.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionDirectory.java
new file mode 100644
index 0000000..3e364f5
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionDirectory.java
@@ -0,0 +1,81 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.connection;
+
+
+import com.google.inject.Inject;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Set;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.auth.jdbc.base.JDBCDirectory;
+import org.apache.guacamole.net.auth.Connection;
+import org.mybatis.guice.transactional.Transactional;
+
+/**
+ * Implementation of the Connection Directory which is driven by an underlying,
+ * arbitrary database.
+ */
+public class ConnectionDirectory extends JDBCDirectory {
+
+ /**
+ * Service for managing connection objects.
+ */
+ @Inject
+ private ConnectionService connectionService;
+
+ @Override
+ public Connection get(String identifier) throws GuacamoleException {
+ return connectionService.retrieveObject(getCurrentUser(), identifier);
+ }
+
+ @Override
+ @Transactional
+ public Collection getAll(Collection identifiers) throws GuacamoleException {
+ Collection objects = connectionService.retrieveObjects(getCurrentUser(), identifiers);
+ return Collections.unmodifiableCollection(objects);
+ }
+
+ @Override
+ @Transactional
+ public Set getIdentifiers() throws GuacamoleException {
+ return connectionService.getIdentifiers(getCurrentUser());
+ }
+
+ @Override
+ @Transactional
+ public void add(Connection object) throws GuacamoleException {
+ connectionService.createObject(getCurrentUser(), object);
+ }
+
+ @Override
+ @Transactional
+ public void update(Connection object) throws GuacamoleException {
+ ModeledConnection connection = (ModeledConnection) object;
+ connectionService.updateObject(getCurrentUser(), connection);
+ }
+
+ @Override
+ @Transactional
+ public void remove(String identifier) throws GuacamoleException {
+ connectionService.deleteObject(getCurrentUser(), identifier);
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionMapper.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionMapper.java
new file mode 100644
index 0000000..5f3db38
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionMapper.java
@@ -0,0 +1,101 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.connection;
+
+import java.util.Collection;
+import java.util.Set;
+import org.apache.guacamole.auth.jdbc.base.ModeledDirectoryObjectMapper;
+import org.apache.guacamole.auth.jdbc.user.UserModel;
+import org.apache.guacamole.properties.CaseSensitivity;
+import org.apache.ibatis.annotations.Param;
+
+/**
+ * Mapper for connection objects.
+ */
+public interface ConnectionMapper extends ModeledDirectoryObjectMapper {
+
+ /**
+ * Selects the identifiers of all connections within the given parent
+ * connection group, regardless of whether they are readable by any
+ * particular user. This should only be called on behalf of a system
+ * administrator. If identifiers are needed by a non-administrative user
+ * who must have explicit read rights, use
+ * selectReadableIdentifiersWithin() instead.
+ *
+ * @param parentIdentifier
+ * The identifier of the parent connection group, or null if the root
+ * connection group is to be queried.
+ *
+ * @return
+ * A Set containing all identifiers of all objects.
+ */
+ Set selectIdentifiersWithin(@Param("parentIdentifier") String parentIdentifier);
+
+ /**
+ * Selects the identifiers of all connections within the given parent
+ * connection group that are explicitly readable by the given user. If
+ * identifiers are needed by a system administrator (who, by definition,
+ * does not need explicit read rights), use selectIdentifiersWithin()
+ * instead.
+ *
+ * @param user
+ * The user whose permissions should determine whether an identifier
+ * is returned.
+ *
+ * @param parentIdentifier
+ * The identifier of the parent connection group, or null if the root
+ * connection group is to be queried.
+ *
+ * @param effectiveGroups
+ * The identifiers of all groups that should be taken into account
+ * when determining the permissions effectively granted to the user. If
+ * no groups are given, only permissions directly granted to the user
+ * will be used.
+ *
+ * @param caseSensitivity
+ * The object that contains current configuration for case sensitivity
+ * for usernames and group names.
+ *
+ * @return
+ * A Set containing all identifiers of all readable objects.
+ */
+ Set selectReadableIdentifiersWithin(@Param("user") UserModel user,
+ @Param("parentIdentifier") String parentIdentifier,
+ @Param("effectiveGroups") Collection effectiveGroups,
+ @Param("caseSensitivity") CaseSensitivity caseSensitivity);
+
+ /**
+ * Selects the connection within the given parent group and having the
+ * given name. If no such connection exists, null is returned.
+ *
+ * @param parentIdentifier
+ * The identifier of the parent group to search within.
+ *
+ * @param name
+ * The name of the connection to find.
+ *
+ * @return
+ * The connection having the given name within the given parent group,
+ * or null if no such connection exists.
+ */
+ ConnectionModel selectOneByName(@Param("parentIdentifier") String parentIdentifier,
+ @Param("name") String name);
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionModel.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionModel.java
new file mode 100644
index 0000000..da45402
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionModel.java
@@ -0,0 +1,395 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.connection;
+
+import java.util.Date;
+import java.util.HashSet;
+import java.util.Set;
+import org.apache.guacamole.auth.jdbc.base.ChildObjectModel;
+import org.apache.guacamole.net.auth.GuacamoleProxyConfiguration.EncryptionMethod;
+
+/**
+ * Object representation of a Guacamole connection, as represented in the
+ * database.
+ */
+public class ConnectionModel extends ChildObjectModel {
+
+ /**
+ * The human-readable name associated with this connection.
+ */
+ private String name;
+
+ /**
+ * The name of the protocol to use when connecting to this connection.
+ */
+ private String protocol;
+
+ /**
+ * The maximum number of connections that can be established to this
+ * connection concurrently, zero if no restriction applies, or null if the
+ * default restrictions should be applied.
+ */
+ private Integer maxConnections;
+
+ /**
+ * The maximum number of connections that can be established to this
+ * connection concurrently by any one user, zero if no restriction applies,
+ * or null if the default restrictions should be applied.
+ */
+ private Integer maxConnectionsPerUser;
+
+ /**
+ * The weight of the connection for the purposes of calculating
+ * WLC algorithm. null indicates nothing has been set, and anything less
+ * than 1 eliminates the system from being used for connections.
+ */
+ private Integer connectionWeight;
+
+ /**
+ * Whether this connection should be reserved for failover. Failover-only
+ * connections within a balancing group are only used when all non-failover
+ * connections are unavailable.
+ */
+ private boolean failoverOnly;
+
+ /**
+ * The identifiers of all readable sharing profiles associated with this
+ * connection.
+ */
+ private Set sharingProfileIdentifiers = new HashSet();
+
+ /**
+ * The hostname of the guacd instance to use, or null if the hostname of the
+ * default guacd instance should be used.
+ */
+ private String proxyHostname;
+
+ /**
+ * The port of the guacd instance to use, or null if the port of the default
+ * guacd instance should be used.
+ */
+ private Integer proxyPort;
+
+ /**
+ * The encryption method required by the desired guacd instance, or null if
+ * the encryption method of the default guacd instance should be used.
+ */
+ private EncryptionMethod proxyEncryptionMethod;
+
+ /**
+ * The date and time that this connection was last used, or null if this
+ * connection has never been used.
+ */
+ private Date lastActive;
+
+ /**
+ * Creates a new, empty connection.
+ */
+ public ConnectionModel() {
+ }
+
+ /**
+ * Returns the name associated with this connection.
+ *
+ * @return
+ * The name associated with this connection.
+ */
+ public String getName() {
+ return name;
+ }
+
+ /**
+ * Sets the name associated with this connection.
+ *
+ * @param name
+ * The name to associate with this connection.
+ */
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ /**
+ * Returns the name of the protocol to use when connecting to this
+ * connection.
+ *
+ * @return
+ * The name of the protocol to use when connecting to this connection.
+ */
+ public String getProtocol() {
+ return protocol;
+ }
+
+ /**
+ * Sets the name of the protocol to use when connecting to this connection.
+ *
+ * @param protocol
+ * The name of the protocol to use when connecting to this connection.
+ */
+ public void setProtocol(String protocol) {
+ this.protocol = protocol;
+ }
+
+ /**
+ * Returns the maximum number of connections that can be established to
+ * this connection concurrently.
+ *
+ * @return
+ * The maximum number of connections that can be established to this
+ * connection concurrently, zero if no restriction applies, or null if
+ * the default restrictions should be applied.
+ */
+ public Integer getMaxConnections() {
+ return maxConnections;
+ }
+
+ /**
+ * Sets the maximum number of connections that can be established to this
+ * connection concurrently.
+ *
+ * @param maxConnections
+ * The maximum number of connections that can be established to this
+ * connection concurrently, zero if no restriction applies, or null if
+ * the default restrictions should be applied.
+ */
+ public void setMaxConnections(Integer maxConnections) {
+ this.maxConnections = maxConnections;
+ }
+
+ /**
+ * Returns the maximum number of connections that can be established to
+ * this connection concurrently by any one user.
+ *
+ * @return
+ * The maximum number of connections that can be established to this
+ * connection concurrently by any one user, zero if no restriction
+ * applies, or null if the default restrictions should be applied.
+ */
+ public Integer getMaxConnectionsPerUser() {
+ return maxConnectionsPerUser;
+ }
+
+ /**
+ * Sets the connection weight for load balancing.
+ *
+ * @param connectionWeight
+ * The weight of the connection used in load balancing.
+ * The value is not required for the connection (null), and
+ * values less than 1 will prevent the connection from being
+ * used.
+ */
+ public void setConnectionWeight(Integer connectionWeight) {
+ this.connectionWeight = connectionWeight;
+ }
+
+ /**
+ * Returns the connection weight used in applying weighted
+ * load balancing algorithms.
+ *
+ * @return
+ * The connection weight used in applying weighted
+ * load balancing aglorithms.
+ */
+ public Integer getConnectionWeight() {
+ return connectionWeight;
+ }
+
+ /**
+ * Returns whether this connection should be reserved for failover.
+ * Failover-only connections within a balancing group are only used when
+ * all non-failover connections are unavailable.
+ *
+ * @return
+ * true if this connection should be reserved for failover, false
+ * otherwise.
+ */
+ public boolean isFailoverOnly() {
+ return failoverOnly;
+ }
+
+ /**
+ * Sets whether this connection should be reserved for failover.
+ * Failover-only connections within a balancing group are only used when
+ * all non-failover connections are unavailable.
+ *
+ * @param failoverOnly
+ * true if this connection should be reserved for failover, false
+ * otherwise.
+ */
+ public void setFailoverOnly(boolean failoverOnly) {
+ this.failoverOnly = failoverOnly;
+ }
+
+ /**
+ * Sets the maximum number of connections that can be established to this
+ * connection concurrently by any one user.
+ *
+ * @param maxConnectionsPerUser
+ * The maximum number of connections that can be established to this
+ * connection concurrently by any one user, zero if no restriction
+ * applies, or null if the default restrictions should be applied.
+ */
+ public void setMaxConnectionsPerUser(Integer maxConnectionsPerUser) {
+ this.maxConnectionsPerUser = maxConnectionsPerUser;
+ }
+
+ /**
+ * Returns the hostname of the guacd instance to use. If the hostname of the
+ * default guacd instance should be used instead, null is returned.
+ *
+ * @return
+ * The hostname of the guacd instance to use, or null if the hostname
+ * of the default guacd instance should be used.
+ */
+ public String getProxyHostname() {
+ return proxyHostname;
+ }
+
+ /**
+ * Sets the hostname of the guacd instance to use.
+ *
+ * @param proxyHostname
+ * The hostname of the guacd instance to use, or null if the hostname
+ * of the default guacd instance should be used.
+ */
+ public void setProxyHostname(String proxyHostname) {
+ this.proxyHostname = proxyHostname;
+ }
+
+ /**
+ * Returns the port of the guacd instance to use. If the port of the default
+ * guacd instance should be used instead, null is returned.
+ *
+ * @return
+ * The port of the guacd instance to use, or null if the port of the
+ * default guacd instance should be used.
+ */
+ public Integer getProxyPort() {
+ return proxyPort;
+ }
+
+ /**
+ * Sets the port of the guacd instance to use.
+ *
+ * @param proxyPort
+ * The port of the guacd instance to use, or null if the port of the
+ * default guacd instance should be used.
+ */
+ public void setProxyPort(Integer proxyPort) {
+ this.proxyPort = proxyPort;
+ }
+
+ /**
+ * Returns the type of encryption required by the desired guacd instance.
+ * If the encryption method of the default guacd instance should be used
+ * instead, null is returned.
+ *
+ * @return
+ * The type of encryption required by the desired guacd instance, or
+ * null if the encryption method of the default guacd instance should
+ * be used.
+ */
+ public EncryptionMethod getProxyEncryptionMethod() {
+ return proxyEncryptionMethod;
+ }
+
+ /**
+ * Sets the type of encryption which should be used when connecting to
+ * guacd, if any.
+ *
+ * @param proxyEncryptionMethod
+ * The type of encryption required by the desired guacd instance, or
+ * null if the encryption method of the default guacd instance should
+ * be used.
+ */
+ public void setProxyEncryptionMethod(EncryptionMethod proxyEncryptionMethod) {
+ this.proxyEncryptionMethod = proxyEncryptionMethod;
+ }
+
+ /**
+ * Returns the identifiers of all readable sharing profiles associated with
+ * this connection. This is set only when the connection is queried, and has
+ * no effect when a connection is inserted, updated, or deleted.
+ *
+ * @return
+ * The identifiers of all readable sharing profiles associated with
+ * this connection.
+ */
+ public Set getSharingProfileIdentifiers() {
+ return sharingProfileIdentifiers;
+ }
+
+ /**
+ * Sets the identifiers of all readable sharing profiles associated with
+ * this connection. This should be set only when the connection is queried,
+ * as it has no effect when a connection is inserted, updated, or deleted.
+ *
+ * @param sharingProfileIdentifiers
+ * The identifiers of all readable sharing profiles associated with
+ * this connection.
+ */
+ public void setSharingProfileIdentifiers(Set sharingProfileIdentifiers) {
+ this.sharingProfileIdentifiers = sharingProfileIdentifiers;
+ }
+
+ /**
+ * Returns the date and time that this connection was last used, or null if
+ * this connection has never been used.
+ *
+ * @return
+ * The date and time that this connection was last used, or null if this
+ * connection has never been used.
+ */
+ public Date getLastActive() {
+ return lastActive;
+ }
+
+ /**
+ * Sets the date and time that this connection was last used. This value is
+ * expected to be set automatically via queries, derived from connection
+ * history records. It does NOT correspond to an actual column, and values
+ * set manually through invoking this function will not persist.
+ *
+ * @param lastActive
+ * The date and time that this connection was last used, or null if this
+ * connection has never been used.
+ */
+ public void setLastActive(Date lastActive) {
+ this.lastActive = lastActive;
+ }
+
+ @Override
+ public String getIdentifier() {
+
+ // If no associated ID, then no associated identifier
+ Integer id = getObjectID();
+ if (id == null)
+ return null;
+
+ // Otherwise, the identifier is the ID as a string
+ return id.toString();
+
+ }
+
+ @Override
+ public void setIdentifier(String identifier) {
+ throw new UnsupportedOperationException("Connection identifiers are derived from IDs. They cannot be set.");
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionParameterMapper.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionParameterMapper.java
new file mode 100644
index 0000000..75ef1cf
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionParameterMapper.java
@@ -0,0 +1,70 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.connection;
+
+import java.util.Collection;
+import org.apache.ibatis.annotations.Param;
+
+/**
+ * Mapper for connection parameter objects.
+ */
+public interface ConnectionParameterMapper {
+
+ /**
+ * Returns a collection of all parameters associated with the connection
+ * having the given identifier.
+ *
+ * @param identifier
+ * The identifier of the connection whose parameters are to be
+ * retrieved.
+ *
+ * @return
+ * A collection of all parameters associated with the connection
+ * having the given identifier. This collection will be empty if no
+ * such connection exists.
+ */
+ Collection select(@Param("identifier") String identifier);
+
+ /**
+ * Inserts each of the parameter model objects in the given collection as
+ * new connection parameters.
+ *
+ * @param parameters
+ * The connection parameters to insert.
+ *
+ * @return
+ * The number of rows inserted.
+ */
+ int insert(@Param("parameters") Collection parameters);
+
+ /**
+ * Deletes all parameters associated with the connection having the given
+ * identifier.
+ *
+ * @param identifier
+ * The identifier of the connection whose parameters should be
+ * deleted.
+ *
+ * @return
+ * The number of rows deleted.
+ */
+ int delete(@Param("identifier") String identifier);
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionParameterModel.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionParameterModel.java
new file mode 100644
index 0000000..a09bae2
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionParameterModel.java
@@ -0,0 +1,102 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.connection;
+
+/**
+ * A single parameter name/value pair belonging to a connection.
+ */
+public class ConnectionParameterModel {
+
+ /**
+ * The identifier of the connection associated with this parameter.
+ */
+ private String connectionIdentifier;
+
+ /**
+ * The name of the parameter.
+ */
+ private String name;
+
+ /**
+ * The value the parameter is set to.
+ */
+ private String value;
+
+ /**
+ * Returns the identifier of the connection associated with this parameter.
+ *
+ * @return
+ * The identifier of the connection associated with this parameter.
+ */
+ public String getConnectionIdentifier() {
+ return connectionIdentifier;
+ }
+
+ /**
+ * Sets the identifier of the connection associated with this parameter.
+ *
+ * @param connectionIdentifier
+ * The identifier of the connection to associate with this parameter.
+ */
+ public void setConnectionIdentifier(String connectionIdentifier) {
+ this.connectionIdentifier = connectionIdentifier;
+ }
+
+ /**
+ * Returns the name of this parameter.
+ *
+ * @return
+ * The name of this parameter.
+ */
+ public String getName() {
+ return name;
+ }
+
+ /**
+ * Sets the name of this parameter.
+ *
+ * @param name
+ * The name of this parameter.
+ */
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ /**
+ * Returns the value of this parameter.
+ *
+ * @return
+ * The value of this parameter.
+ */
+ public String getValue() {
+ return value;
+ }
+
+ /**
+ * Sets the value of this parameter.
+ *
+ * @param value
+ * The value of this parameter.
+ */
+ public void setValue(String value) {
+ this.value = value;
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionRecordMapper.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionRecordMapper.java
new file mode 100644
index 0000000..34c9cfb
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionRecordMapper.java
@@ -0,0 +1,27 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.connection;
+
+import org.apache.guacamole.auth.jdbc.base.ActivityRecordMapper;
+
+/**
+ * Mapper for connection record objects.
+ */
+public interface ConnectionRecordMapper extends ActivityRecordMapper {}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionRecordModel.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionRecordModel.java
new file mode 100644
index 0000000..29c5556
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionRecordModel.java
@@ -0,0 +1,156 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.connection;
+
+import org.apache.guacamole.auth.jdbc.base.ActivityRecordModel;
+
+/**
+ * A single connection record representing a past usage of a particular
+ * connection. If the connection was being shared, the sharing profile used to
+ * join the connection is included in the record.
+ */
+public class ConnectionRecordModel extends ActivityRecordModel {
+
+ /**
+ * The identifier of the connection associated with this connection record.
+ */
+ private String connectionIdentifier;
+
+ /**
+ * The name of the connection associated with this connection record.
+ */
+ private String connectionName;
+
+ /**
+ * The identifier of the sharing profile associated with this connection
+ * record. If no sharing profile was used, or the sharing profile that was
+ * used was deleted, this will be null.
+ */
+ private String sharingProfileIdentifier;
+
+ /**
+ * The name of the sharing profile associated with this connection record.
+ * If no sharing profile was used, this will be null. If the sharing profile
+ * that was used was deleted, this will still contain the name of the
+ * sharing profile at the time that the connection was used.
+ */
+ private String sharingProfileName;
+
+ /**
+ * Returns the identifier of the connection associated with this connection
+ * record.
+ *
+ * @return
+ * The identifier of the connection associated with this connection
+ * record.
+ */
+ public String getConnectionIdentifier() {
+ return connectionIdentifier;
+ }
+
+ /**
+ * Sets the identifier of the connection associated with this connection
+ * record.
+ *
+ * @param connectionIdentifier
+ * The identifier of the connection to associate with this connection
+ * record.
+ */
+ public void setConnectionIdentifier(String connectionIdentifier) {
+ this.connectionIdentifier = connectionIdentifier;
+ }
+
+
+ /**
+ * Returns the name of the connection associated with this connection
+ * record.
+ *
+ * @return
+ * The name of the connection associated with this connection
+ * record.
+ */
+ public String getConnectionName() {
+ return connectionName;
+ }
+
+
+ /**
+ * Sets the name of the connection associated with this connection
+ * record.
+ *
+ * @param connectionName
+ * The name of the connection to associate with this connection
+ * record.
+ */
+ public void setConnectionName(String connectionName) {
+ this.connectionName = connectionName;
+ }
+
+ /**
+ * Returns the identifier of the sharing profile associated with this
+ * connection record. If no sharing profile was used, or the sharing profile
+ * that was used was deleted, this will be null.
+ *
+ * @return
+ * The identifier of the sharing profile associated with this connection
+ * record, or null if no sharing profile was used or if the sharing
+ * profile that was used was deleted.
+ */
+ public String getSharingProfileIdentifier() {
+ return sharingProfileIdentifier;
+ }
+
+ /**
+ * Sets the identifier of the sharing profile associated with this
+ * connection record. If no sharing profile was used, this should be null.
+ *
+ * @param sharingProfileIdentifier
+ * The identifier of the sharing profile associated with this
+ * connection record, or null if no sharing profile was used.
+ */
+ public void setSharingProfileIdentifier(String sharingProfileIdentifier) {
+ this.sharingProfileIdentifier = sharingProfileIdentifier;
+ }
+
+ /**
+ * Returns the human-readable name of the sharing profile associated with this
+ * connection record. If no sharing profile was used, this will be null.
+ *
+ * @return
+ * The human-readable name of the sharing profile associated with this
+ * connection record, or null if no sharing profile was used.
+ */
+ public String getSharingProfileName() {
+ return sharingProfileName;
+ }
+
+ /**
+ * Sets the human-readable name of the sharing profile associated with this
+ * connection record. If no sharing profile was used, this should be null.
+ *
+ * @param sharingProfileName
+ * The human-readable name of the sharing profile associated with this
+ * connection record, or null if no sharing profile was used.
+ */
+ public void setSharingProfileName(String sharingProfileName) {
+ this.sharingProfileName = sharingProfileName;
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionRecordSet.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionRecordSet.java
new file mode 100644
index 0000000..b788cab
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionRecordSet.java
@@ -0,0 +1,93 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.connection;
+
+import com.google.inject.Inject;
+import java.util.List;
+import java.util.Set;
+import java.util.UUID;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.auth.jdbc.base.ActivityRecordSearchTerm;
+import org.apache.guacamole.auth.jdbc.base.ActivityRecordSortPredicate;
+import org.apache.guacamole.auth.jdbc.base.ModeledActivityRecordSet;
+import org.apache.guacamole.auth.jdbc.user.ModeledAuthenticatedUser;
+import org.apache.guacamole.net.auth.AuthenticatedUser;
+import org.apache.guacamole.net.auth.ConnectionRecord;
+
+/**
+ * A JDBC implementation of ActivityRecordSet for ConnectionRecords. Calls to
+ * asCollection() will query connection history records from the database. Which
+ * records are returned will be determined by the values passed in earlier.
+ */
+public class ConnectionRecordSet extends ModeledActivityRecordSet {
+
+ /**
+ * The namespace for the type 3 UUIDs generated for connection history
+ * records. This UUID namespace is itself a type 3 UUID within the "ns:OID"
+ * namespace for the OID "1.3.6.1.4.1.18060.18.2.1.2", which has been
+ * specifically allocated for Apache Guacamole database connection
+ * history records.
+ */
+ public static final UUID UUID_NAMESPACE = UUID.fromString("8b55f070-95f4-3d31-93ee-9c5845e7aa40");
+
+ /**
+ * Service for managing connection objects.
+ */
+ @Inject
+ private ConnectionService connectionService;
+
+ /**
+ * The identifier of the connection to which this record set should be
+ * limited, if any. If null, the set should contain all records readable
+ * by the user making the request.
+ */
+ private String identifier = null;
+
+ /**
+ * Initializes this object, associating it with the current authenticated
+ * user and connection identifier.
+ *
+ * @param currentUser
+ * The user that created or retrieved this object.
+ *
+ * @param identifier
+ * The connection identifier to which this record set should be limited,
+ * or null if the record set should contain all records readable by the
+ * currentUser.
+ */
+ protected void init(ModeledAuthenticatedUser currentUser, String identifier) {
+ super.init(currentUser);
+ this.identifier = identifier;
+ }
+
+ @Override
+ protected List retrieveHistory(
+ AuthenticatedUser user, String recordIdentifier,
+ Set requiredContents,
+ List sortPredicates,
+ int limit) throws GuacamoleException {
+
+ // Retrieve history from database
+ return connectionService.retrieveHistory(identifier, getCurrentUser(),
+ recordIdentifier, requiredContents, sortPredicates, limit);
+
+ }
+
+}
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionService.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionService.java
new file mode 100644
index 0000000..3297d7f
--- /dev/null
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionService.java
@@ -0,0 +1,550 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.jdbc.connection;
+
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import org.apache.guacamole.GuacamoleClientException;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.GuacamoleSecurityException;
+import org.apache.guacamole.auth.jdbc.JDBCEnvironment;
+import org.apache.guacamole.auth.jdbc.base.ActivityRecordSearchTerm;
+import org.apache.guacamole.auth.jdbc.base.ActivityRecordSortPredicate;
+import org.apache.guacamole.auth.jdbc.user.ModeledAuthenticatedUser;
+import org.apache.guacamole.auth.jdbc.base.ModeledChildDirectoryObjectService;
+import org.apache.guacamole.auth.jdbc.base.ModeledDirectoryObjectMapper;
+import org.apache.guacamole.auth.jdbc.permission.ConnectionPermissionMapper;
+import org.apache.guacamole.auth.jdbc.permission.ObjectPermissionMapper;
+import org.apache.guacamole.auth.jdbc.tunnel.GuacamoleTunnelService;
+import org.apache.guacamole.language.TranslatableGuacamoleClientOverrunException;
+import org.apache.guacamole.language.TranslatableMessage;
+import org.apache.guacamole.net.GuacamoleTunnel;
+import org.apache.guacamole.net.auth.Connection;
+import org.apache.guacamole.net.auth.ConnectionRecord;
+import org.apache.guacamole.net.auth.permission.ObjectPermission;
+import org.apache.guacamole.net.auth.permission.ObjectPermissionSet;
+import org.apache.guacamole.net.auth.permission.SystemPermission;
+import org.apache.guacamole.net.auth.permission.SystemPermissionSet;
+import org.apache.guacamole.protocol.GuacamoleClientInformation;
+
+/**
+ * Service which provides convenience methods for creating, retrieving, and
+ * manipulating connections.
+ */
+public class ConnectionService extends ModeledChildDirectoryObjectService {
+
+ /**
+ * Mapper for accessing connections.
+ */
+ @Inject
+ private ConnectionMapper connectionMapper;
+
+ /**
+ * Mapper for manipulating connection permissions.
+ */
+ @Inject
+ private ConnectionPermissionMapper connectionPermissionMapper;
+
+ /**
+ * Mapper for accessing connection parameters.
+ */
+ @Inject
+ private ConnectionParameterMapper parameterMapper;
+
+ /**
+ * Mapper for accessing connection history.
+ */
+ @Inject
+ private ConnectionRecordMapper connectionRecordMapper;
+
+ /**
+ * Provider for creating connections.
+ */
+ @Inject
+ private Provider connectionProvider;
+
+ /**
+ * The server environment for retrieving configuration.
+ */
+ @Inject
+ private JDBCEnvironment environment;
+
+ /**
+ * Service for creating and tracking tunnels.
+ */
+ @Inject
+ private GuacamoleTunnelService tunnelService;
+
+ /**
+ * Known limit for the size of the connection parameter values.
+ */
+ private static final int CONNECTION_PARAMETER_VALUE_LIMIT = 4096;
+
+ @Override
+ protected ModeledDirectoryObjectMapper getObjectMapper() {
+ return connectionMapper;
+ }
+
+ @Override
+ protected ObjectPermissionMapper getPermissionMapper() {
+ return connectionPermissionMapper;
+ }
+
+ @Override
+ protected ModeledConnection getObjectInstance(ModeledAuthenticatedUser currentUser,
+ ConnectionModel model) {
+ ModeledConnection connection = connectionProvider.get();
+ connection.init(currentUser, model);
+ return connection;
+ }
+
+ @Override
+ protected ConnectionModel getModelInstance(ModeledAuthenticatedUser currentUser,
+ final Connection object) {
+
+ // Create new ModeledConnection backed by blank model
+ ConnectionModel model = new ConnectionModel();
+ ModeledConnection connection = getObjectInstance(currentUser, model);
+
+ // Set model contents through ModeledConnection, copying the provided connection
+ connection.setParentIdentifier(object.getParentIdentifier());
+ connection.setName(object.getName());
+ connection.setConfiguration(object.getConfiguration());
+ connection.setAttributes(object.getAttributes());
+
+ return model;
+
+ }
+
+ @Override
+ protected boolean hasCreatePermission(ModeledAuthenticatedUser user)
+ throws GuacamoleException {
+
+ // Return whether user has explicit connection creation permission
+ SystemPermissionSet permissionSet = user.getUser().getEffectivePermissions().getSystemPermissions();
+ return permissionSet.hasPermission(SystemPermission.Type.CREATE_CONNECTION);
+
+ }
+
+ @Override
+ protected ObjectPermissionSet getEffectivePermissionSet(ModeledAuthenticatedUser user)
+ throws GuacamoleException {
+
+ // Return permissions related to connections
+ return user.getUser().getEffectivePermissions().getConnectionPermissions();
+
+ }
+
+ @Override
+ protected ObjectPermissionSet getParentEffectivePermissionSet(ModeledAuthenticatedUser user)
+ throws GuacamoleException {
+
+ // Connections are contained by connection groups
+ return user.getUser().getEffectivePermissions().getConnectionGroupPermissions();
+
+ }
+
+ /**
+ * Validates that all connection parameter values are within the expected size limit.
+ *
+ * @param parameters
+ * The map of connection parameter name/value pairs to validate.
+ *
+ * @throws GuacamoleClientException
+ * If any of the parameter values exceed the defined limit.
+ */
+ private void validateParameters(Map parameters) throws GuacamoleClientException {
+ // Iterate through each parameter to validate its size
+ for (Map.Entry parameter : parameters.entrySet()) {
+ String value = parameter.getValue();
+
+ // Check if parameter value exceeds size limit
+ if (value != null && value.length() > CONNECTION_PARAMETER_VALUE_LIMIT) {
+
+ Map vars = new HashMap<>();
+ vars.put("MAX_SIZE", CONNECTION_PARAMETER_VALUE_LIMIT);
+ vars.put("PARAMETER_NAME", parameter.getKey());
+
+ // Create a translatable message with the error key and substitution variables
+ TranslatableMessage translatableMessage = new TranslatableMessage(
+ "CONNECTION_PARAMETERS.DATABASE_PARAMETER_VALUE_TOO_LONG",
+ vars
+ );
+
+ throw new TranslatableGuacamoleClientOverrunException(
+ "The value provided for connection parameter \"" + parameter.getKey() +
+ "\" exceeds the maximum allowed length.",
+ translatableMessage
+ );
+ }
+ }
+ }
+
+ @Override
+ protected void beforeCreate(ModeledAuthenticatedUser user,
+ Connection object, ConnectionModel model)
+ throws GuacamoleException {
+
+ // Validate parameters before saving
+ validateParameters(object.getConfiguration().getParameters());
+
+ super.beforeCreate(user, object, model);
+
+ // Name must not be blank
+ if (model.getName() == null || model.getName().trim().isEmpty())
+ throw new GuacamoleClientException("Connection names must not be blank.");
+
+ // Do not attempt to create duplicate connections
+ ConnectionModel existing = connectionMapper.selectOneByName(model.getParentIdentifier(), model.getName());
+ if (existing != null)
+ throw new GuacamoleClientException("The connection \"" + model.getName() + "\" already exists.");
+
+ }
+
+ @Override
+ protected void beforeUpdate(ModeledAuthenticatedUser user,
+ ModeledConnection object, ConnectionModel model)
+ throws GuacamoleException {
+
+ // Validate parameters before saving
+ validateParameters(object.getConfiguration().getParameters());
+
+ super.beforeUpdate(user, object, model);
+
+ // Name must not be blank
+ if (model.getName() == null || model.getName().trim().isEmpty())
+ throw new GuacamoleClientException("Connection names must not be blank.");
+
+ // Check whether such a connection is already present
+ ConnectionModel existing = connectionMapper.selectOneByName(model.getParentIdentifier(), model.getName());
+ if (existing != null) {
+
+ // If the specified name matches a DIFFERENT existing connection, the update cannot continue
+ if (!existing.getObjectID().equals(model.getObjectID()))
+ throw new GuacamoleClientException("The connection \"" + model.getName() + "\" already exists.");
+
+ }
+
+ }
+
+ /**
+ * Given an arbitrary Guacamole connection, produces a collection of
+ * parameter model objects containing the name/value pairs of that
+ * connection's parameters.
+ *
+ * @param connection
+ * The connection whose configuration should be used to produce the
+ * collection of parameter models.
+ *
+ * @return
+ * A collection of parameter models containing the name/value pairs
+ * of the given connection's parameters.
+ */
+ private Collection getParameterModels(ModeledConnection connection) {
+
+ Map parameters = connection.getConfiguration().getParameters();
+
+ // Convert parameters to model objects
+ Collection parameterModels = new ArrayList<>(parameters.size());
+ for (Map.Entry parameterEntry : parameters.entrySet()) {
+
+ // Get parameter name and value
+ String name = parameterEntry.getKey();
+ String value = parameterEntry.getValue();
+
+ // There is no need to insert empty parameters
+ if (value == null || value.isEmpty())
+ continue;
+
+ // Produce model object from parameter
+ ConnectionParameterModel model = new ConnectionParameterModel();
+ model.setConnectionIdentifier(connection.getIdentifier());
+ model.setName(name);
+ model.setValue(value);
+
+ // Add model to list
+ parameterModels.add(model);
+
+ }
+
+ return parameterModels;
+
+ }
+
+ @Override
+ public ModeledConnection createObject(ModeledAuthenticatedUser user, Connection object)
+ throws GuacamoleException {
+
+ // Create connection
+ ModeledConnection connection = super.createObject(user, object);
+ connection.setConfiguration(object.getConfiguration());
+
+ // Insert new parameters, if any
+ Collection parameterModels = getParameterModels(connection);
+ if (!parameterModels.isEmpty())
+ parameterMapper.insert(parameterModels);
+
+ return connection;
+
+ }
+
+ @Override
+ public void updateObject(ModeledAuthenticatedUser user, ModeledConnection object)
+ throws GuacamoleException {
+
+ // Update connection
+ super.updateObject(user, object);
+
+ // Replace existing parameters with new parameters, if any
+ Collection parameterModels = getParameterModels(object);
+ parameterMapper.delete(object.getIdentifier());
+ if (!parameterModels.isEmpty())
+ parameterMapper.insert(parameterModels);
+
+ }
+
+ /**
+ * Returns the set of all identifiers for all connections within the
+ * connection group having the given identifier. Only connections that the
+ * user has read access to will be returned.
+ *
+ * Permission to read the connection group having the given identifier is
+ * NOT checked.
+ *
+ * @param user
+ * The user retrieving the identifiers.
+ *
+ * @param identifier
+ * The identifier of the parent connection group, or null to check the
+ * root connection group.
+ *
+ * @return
+ * The set of all identifiers for all connections in the connection
+ * group having the given identifier that the user has read access to.
+ *
+ * @throws GuacamoleException
+ * If an error occurs while reading identifiers.
+ */
+ public Set getIdentifiersWithin(ModeledAuthenticatedUser user,
+ String identifier)
+ throws GuacamoleException {
+
+ // Bypass permission checks if the user is privileged
+ if (user.isPrivileged())
+ return connectionMapper.selectIdentifiersWithin(identifier);
+
+ // Otherwise only return explicitly readable identifiers
+ else
+ return connectionMapper.selectReadableIdentifiersWithin(
+ user.getUser().getModel(), identifier,
+ user.getEffectiveUserGroups(),
+ getCaseSensitivity());
+
+ }
+
+ /**
+ * Retrieves all parameters visible to the given user and associated with
+ * the connection having the given identifier. If the given user has no
+ * access to such parameters, or no such connection exists, the returned
+ * map will be empty.
+ *
+ * @param user
+ * The user retrieving connection parameters.
+ *
+ * @param identifier
+ * The identifier of the connection whose parameters are being
+ * retrieved.
+ *
+ * @return
+ * A new map of all parameter name/value pairs that the given user has
+ * access to.
+ */
+ public Map retrieveParameters(ModeledAuthenticatedUser user,
+ String identifier) {
+
+ Map parameterMap = new HashMap<>();
+
+ // Determine whether we have permission to read parameters
+ boolean canRetrieveParameters;
+ try {
+ canRetrieveParameters = hasObjectPermission(user, identifier,
+ ObjectPermission.Type.UPDATE);
+ }
+
+ // Provide empty (but mutable) map if unable to check permissions
+ catch (GuacamoleException e) {
+ return parameterMap;
+ }
+
+ // Populate parameter map if we have permission to do so
+ if (canRetrieveParameters) {
+ for (ConnectionParameterModel parameter : parameterMapper.select(identifier))
+ parameterMap.put(parameter.getName(), parameter.getValue());
+ }
+
+ return parameterMap;
+
+ }
+
+ /**
+ * Returns a connection records object which is backed by the given model.
+ *
+ * @param model
+ * The model object to use to back the returned connection record
+ * object.
+ *
+ * @return
+ * A connection record object which is backed by the given model.
+ */
+ protected ConnectionRecord getObjectInstance(ConnectionRecordModel model) {
+ return new ModeledConnectionRecord(model);
+ }
+
+ /**
+ * Returns a list of connection records objects which are backed by the
+ * models in the given list.
+ *
+ * @param models
+ * The model objects to use to back the connection record objects
+ * within the returned list.
+ *
+ * @return
+ * A list of connection record objects which are backed by the models
+ * in the given list.
+ */
+ protected List getObjectInstances(List models) {
+
+ // Create new list of records by manually converting each model
+ List objects = new ArrayList<>(models.size());
+ for (ConnectionRecordModel model : models)
+ objects.add(getObjectInstance(model));
+
+ return objects;
+
+ }
+
+ /**
+ * Retrieves the connection history records matching the given criteria.
+ * Retrieves up to limit connection history records matching
+ * the given terms and sorted by the given predicates. Only history records
+ * associated with data that the given user can read are returned.
+ *
+ * @param identifier
+ * The optional connection identifier for which history records should
+ * be retrieved, or null if all readable records should be retrieved.
+ *
+ * @param user
+ * The user retrieving the connection history.
+ *
+ * @param recordIdentifier
+ * The identifier of the specific history record to retrieve, if not
+ * all matching records. Search terms, etc. will still be applied to
+ * the single record.
+ *
+ * @param requiredContents
+ * The search terms that must be contained somewhere within each of the
+ * returned records.
+ *
+ * @param sortPredicates
+ * A list of predicates to sort the returned records by, in order of
+ * priority.
+ *
+ * @param limit
+ * The maximum number of records that should be returned.
+ *
+ * @return
+ * The connection history of the given connection, including any
+ * active connections.
+ *
+ * @throws GuacamoleException
+ * If permission to read the connection history is denied.
+ */
+ public List retrieveHistory(String identifier,
+ ModeledAuthenticatedUser user, String recordIdentifier,
+ Collection