diff --git a/1.3.2/Dockerfile b/1.3.2/Dockerfile new file mode 100644 index 0000000000000000000000000000000000000000..0c3346680d0af0e2601d397275e9d87c7b33b37e --- /dev/null +++ b/1.3.2/Dockerfile @@ -0,0 +1,58 @@ +ARG BASE_REGISTRY=nexus-docker-secure.levelup-dev.io +ARG BASE_IMAGE=ubi8/ubi +ARG BASE_TAG=8.1 +ARG BUILDER_REGISTRY=nexus-docker-secure.levelup-dev.io + +ARG UBI_BASE_IMAGE=${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG} + +FROM ${BUILDER_REGISTRY}/builder-vault:1.3.2 AS source + +FROM ${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG} AS final + +LABEL name="Vault" \ + description="Vault image based on the Red Hat Universal Base Image for DSOP." \ + vendor="Hashicorp" \ + summary="Vault (Red Hat UBI)" \ + maintainer="CloudFit Software " \ + version="1.3.2" + +ARG SERVICE_UNAME=vault + +COPY --from=source /bin/vault /bin/vault + +RUN echo ${SERVICE_UNAME} && \ + groupadd ${SERVICE_UNAME} && \ + adduser -g ${SERVICE_UNAME} ${SERVICE_UNAME} \ + && echo 'CtrlAltDelBurstAction=none' >> /etc/systemd/system.conf \ + && set -eux; \ + yum --nogpgcheck install ca-certificates openssl libcap tzdata -y \ + && rm -fr /var/cache/yum/* \ + && yum --nogpgcheck clean all && \ + mkdir -p /vault/logs && \ + mkdir -p /vault/file && \ + mkdir -p /vault/config && \ + chown -R ${SERVICE_UNAME}:${SERVICE_UNAME} /vault + +EXPOSE 8200 + +COPY bin/docker-entrypoint.sh /usr/local/bin/docker-entrypoint.sh + +RUN chown ${SERVICE_UNAME}:${SERVICE_UNAME} /usr/local/bin/docker-entrypoint.sh && \ + chmod +x /usr/local/bin/docker-entrypoint.sh \ + && chown -R ${SERVICE_UNAME}:${SERVICE_UNAME} /vault + +USER ${SERVICE_UNAME}:${SERVICE_UNAME} + +ENTRYPOINT ["docker-entrypoint.sh"] + +################################################################ +#### Health Check #### +#### Health checks are disabled in k8s #### +################################################################ +HEALTHCHECK --interval=5m --timeout=30s --start-period=1m --retries=3 CMD [ "curl -f http://locahost:8200" || exit 1 ] +################################################################ +#### Health Check #### +#### Health checks are disabled in k8s #### +################################################################ + +CMD ["server"] \ No newline at end of file diff --git a/1.3.2/LICENSE b/1.3.2/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..fa0086a952236971ab37901954d596efae9f4af6 --- /dev/null +++ b/1.3.2/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + 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 and Conditions +-------------------------------- + +2.1. Grants + +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 such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +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 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 every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, 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 any 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 under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, 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 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. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the 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. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +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. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. \ No newline at end of file diff --git a/1.3.2/README.md b/1.3.2/README.md new file mode 100644 index 0000000000000000000000000000000000000000..6982098ef99364a42d7727ccfd4018f07ce9b1ea --- /dev/null +++ b/1.3.2/README.md @@ -0,0 +1,91 @@ +# Introduction + +This guide will give an overview of important information related to the *Vault* container image. + +## Getting Started + +### How to Use the Container + +To run the Vault image, run the following commands: + +```shell +docker run -it -p 8200:8200 +``` + +**NOTE:** To run it must have a config file at the path */vault/vaultconfig/vault-config.json*. This is necessary for the helm chart to work properly. + +**Additional Debug Information** +If you want to run Vault locally, there are 2 methods. The first is to: + +1. Put a `COPY` statement below the one that copies that *entrypoint* file that copies a *vault-config.json* file from the *bin* folder into */vault/config*. +2. Change the `CMD` statement to read `CMD ["server", "--config=/vault/config/vault-config.json"]` + - This will allow Vault to run fully in memory. This should never be used for production setups. + - The *vault-config.json* file currently located in the *bin* folder should not be used as is. It needs to have some values configured before being used. + - `masterURL` can be set to 127.0.0.1 for local testing. + - `storage` can be changed to a local file for testing. + +The second is to: + +1. Change the `CMD` statement to read `CMD ["server", "-dev"]` +2. This will allow you to run Vault in *Dev* Server Mode. + - You can learn more about what can be done with this [here](https://www.vaultproject.io/docs/concepts/dev-server.html). + +### Configuration Notes + +The following changes must be made before deployment: + +- Change the **Build** arg in the dockerfile if a different version is being used. +- Helm chart changes: + - *tag* & *secret* values in *values.yml* Not currently stored in Helm repo. + - Add *vaults.secret.yml*. This is not stored in the Helm repo. + - *vaults.secrets.yml* will need a tls section, containing *hosts*, *cert*, *key*, and *secretname* values. + - The above are not stored in the repo currently due to security concerns. **(2020,01/09)** + - Before deploying, it + +### Additional Notes + +- */vault/logs* is made available to use as a location to store audit logs, if desired; */vault/file* is made available to use as a location with the file storage backend, if desired; the server will be started with */vault/config* as the configuration directory so you can add additional config files in that location. +- The entry point script uses dumb-init as the top-level process to reap any zombie processes created by Vault sub-processes. +- For production derivatives of this container, you shoud add the *IPC_LOCK* capability so that Vault can mlock memory. +- By default you'll get a single-node development server that stores everything in RAM and bootstraps itself. Don't use this configuration for production. +- There is an option for additional encryption to be added to Vault. To enable it, you will need to: + - `mkdir -p /vault/cert` in the run section where you create the multiple other directories. + - `VOLUME /vault/certs` just before you `EXPOSE 8200`. + - `COPY bin/tls.* /vault/certs/`, which also means creating the cert files to go in the *bin* folder. + +## Current Hardening Status + +Currently hardened. Read below for more details. + +- Uses the *ubi8* image as base. **(01/06/2020)** +- Confirmed running non-root. **(01/09/2020)** +- Passes STIG scan. **(01/09/2020)** + - *(CCE-27209-6) Verify and Correct File Permissions with RPM* acceptable risk present. +- Passes Twistlock scan. **(01/09/2020)** +- Passes Anchore scan. **(01/09/2020)** + +## Locations + +*Be sure to include the url for the location if necessary, and any additional notes that may be necessary to access it.* + +### Current Deployment Locations + +**Unhardened Version** +Deployment ring 3, with highest level achieved IL4. + +**Hardened Version** +Not deployed anywhere at this time. + +## Additional Documentation + +### Vault + +- [Vault Official Site](https://www.vaultproject.io/) +- [Vault 1.3.1](https://www.hashicorp.com/blog/vault-1-3/) +- [Hashicorp's Vault Courses](https://learn.hashicorp.com/vault) + +#### Installation + +- Installation - +- Commands - +- Configuration - \ No newline at end of file diff --git a/1.3.2/bin/docker-entrypoint.sh b/1.3.2/bin/docker-entrypoint.sh new file mode 100644 index 0000000000000000000000000000000000000000..773d58e5aa95ac3f3e48aa9ec675c6f06e35438a --- /dev/null +++ b/1.3.2/bin/docker-entrypoint.sh @@ -0,0 +1,105 @@ +#!/bin/bash +set -e + +# Note above that we run dumb-init as PID 1 in order to reap zombie processes +# as well as forward signals to all processes in its session. Normally, sh +# wouldn't do either of these functions so we'd leak zombies as well as do +# unclean termination of all our sub-processes. + +# Prevent core dumps +ulimit -c 0 + +# Allow setting VAULT_REDIRECT_ADDR and VAULT_CLUSTER_ADDR using an interface +# name instead of an IP address. The interface name is specified using +# VAULT_REDIRECT_INTERFACE and VAULT_CLUSTER_INTERFACE environment variables. If +# VAULT_*_ADDR is also set, the resulting URI will combine the protocol and port +# number with the IP of the named interface. +export VAULT_ADDR=http://127.0.0.1:8200 + +get_addr () { + local if_name=$1 + local uri_template=$2 + ip addr show dev $if_name | awk -v uri=$uri_template '/\s*inet\s/ { \ + ip=gensub(/(.+)\/.+/, "\\1", "g", $2); \ + print gensub(/^(.+:\/\/).+(:.+)$/, "\\1" ip "\\2", "g", uri); \ + exit}' +} + +if [ -n "$VAULT_REDIRECT_INTERFACE" ]; then + export VAULT_REDIRECT_ADDR=$(get_addr $VAULT_REDIRECT_INTERFACE ${VAULT_REDIRECT_ADDR:-"http://0.0.0.0:8200"}) + echo "Using $VAULT_REDIRECT_INTERFACE for VAULT_REDIRECT_ADDR: $VAULT_REDIRECT_ADDR" +fi +if [ -n "$VAULT_CLUSTER_INTERFACE" ]; then + export VAULT_CLUSTER_ADDR=$(get_addr $VAULT_CLUSTER_INTERFACE ${VAULT_CLUSTER_ADDR:-"https://0.0.0.0:8201"}) + echo "Using $VAULT_CLUSTER_INTERFACE for VAULT_CLUSTER_ADDR: $VAULT_CLUSTER_ADDR" +fi + +# VAULT_CONFIG_DIR isn't exposed as a volume but you can compose additional +# config files in there if you use this image as a base, or use +# VAULT_LOCAL_CONFIG below. +VAULT_CONFIG_DIR=/vault/config +# You can also set the VAULT_LOCAL_CONFIG environment variable to pass some +# Vault configuration JSON without having to bind any volumes. +if [ -n "$VAULT_LOCAL_CONFIG" ]; then + echo "$VAULT_LOCAL_CONFIG" > "$VAULT_CONFIG_DIR/local.json" +fi + +# If the user is trying to run Vault directly with some arguments, then +# pass them to Vault. +if [ "${1:0:1}" = '-' ]; then + set -- vault "$@" +fi + +# Look for Vault subcommands. +if [ "$1" = 'server' ]; then + shift + set -- vault server \ + -config="$VAULT_CONFIG_DIR" \ + -dev-root-token-id="$VAULT_DEV_ROOT_TOKEN_ID" \ + -dev-listen-address="${VAULT_DEV_LISTEN_ADDRESS:-"0.0.0.0:8200"}" \ + "$@" +elif [ "$1" = 'version' ]; then + # This needs a special case because there's no help output. + set -- vault "$@" +elif vault --help "$1" 2>&1 | grep -q "vault $1"; then + # We can't use the return code to check for the existence of a subcommand, so + # we have to use grep to look for a pattern in the help output. + set -- vault "$@" +fi + +# If we are running Vault, make sure it executes as the proper user. +if [ "$1" = 'vault' ]; then + if [ -z "$SKIP_CHOWN" ]; then + # If the config dir is bind mounted then chown it + if [ "$(stat -c %u /vault/config)" != "$(id -u vault)" ]; then + chown -R vault:vault /vault/config || echo "Could not chown /vault/config (may not have appropriate permissions)" + fi + + # If the logs dir is bind mounted then chown it + if [ "$(stat -c %u /vault/logs)" != "$(id -u vault)" ]; then + chown -R vault:vault /vault/logs + fi + + # If the file dir is bind mounted then chown it + if [ "$(stat -c %u /vault/file)" != "$(id -u vault)" ]; then + chown -R vault:vault /vault/file + fi + fi + + # if [ -z "$SKIP_SETCAP" ]; then + # # Allow mlock to avoid swapping Vault memory to disk + # setcap cap_ipc_lock=+ep $(readlink -f $(which vault)) + + # # In the case vault has been started in a container without IPC_LOCK privileges + # if ! vault -version 1>/dev/null 2>/dev/null; then + # >&2 echo "Couldn't start vault with IPC_LOCK. Disabling IPC_LOCK, please use --privileged or --cap-add IPC_LOCK" + # setcap cap_ipc_lock=-ep $(readlink -f $(which vault)) + # fi + # fi + + # if [ "$(id -u)" = '0' ]; then + # set -- su-exec vault "$@" + # fi +fi + +exec "$@" \ No newline at end of file diff --git a/1.3.2/bin/vault-config.json b/1.3.2/bin/vault-config.json new file mode 100644 index 0000000000000000000000000000000000000000..b8281d88cd197b7dd147c29af7f5ba1ea1c3b504 --- /dev/null +++ b/1.3.2/bin/vault-config.json @@ -0,0 +1,20 @@ +{ + "storage": { + "postgresql": { + "connection_url":"postgres://{{.Values.postgres.username}}:{{.Values.postgres.password}}@{{.Values.postgres.ip}}/{{.Values.postgres.table}}?sslmode=disable", + "ha_enabled": "true", + "ha_table": "vault_ha_locks" + } + }, + "api_addr":"https://{{.Values.masterURL}}:8200", + "default_lease_ttl": "168h", + "max_lease_ttl": "720h", + "disable_mlock": true, + "ui": true, + "listener": { + "tcp": { + "address": "0.0.0.0:8200", + "tls_disable": true + } + } + } \ No newline at end of file diff --git a/1.3.2/scripts/prebuild.sh b/1.3.2/scripts/prebuild.sh new file mode 100755 index 0000000000000000000000000000000000000000..bf50b6b887a35a3fa83c38286f62880733f17994 --- /dev/null +++ b/1.3.2/scripts/prebuild.sh @@ -0,0 +1,22 @@ +#!/bin/bash +VERSION=1.3.2 +IMAGE_NAME=vault +IMAGE_DIGEST=sha256:e6ed7d173e84765278879501b31ea7b475047f82a3b12e88aaf5640e8660f650 +IMAGE_ID=0542f65ae3d04bb12403061a9b15d63343c216b1752cfcad4fcc810e2a2d4d38 +NEXUS_REGISTRY=${NEXUS_REGISTRY:-nexus-docker-secure.levelup-dev.io} +NEXUS_TAG=${NEXUS_REGISTRY}/builder-${IMAGE_NAME}:${VERSION} +CONTAINER_TOOL=${CONTAINER_TOOL:-podman} # Default to podman, but allow use of other container image tools when not available + +set -xe #error if error + +# pull builder image; no GPG/sha checks are necessary because an explicit content hash (i.e. image digest) is used +sudo ${CONTAINER_TOOL} pull docker.io/${IMAGE_NAME}@${IMAGE_DIGEST} + +# re-tag image for Nexus Registry +sudo ${CONTAINER_TOOL} tag ${IMAGE_ID} ${NEXUS_TAG} + +# push newly tagged image +sudo ${CONTAINER_TOOL} push ${NEXUS_TAG} + +# clean up, including all tags for image +sudo ${CONTAINER_TOOL} rmi --force ${IMAGE_ID} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..fa0086a952236971ab37901954d596efae9f4af6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + 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 and Conditions +-------------------------------- + +2.1. Grants + +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 such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +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 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 every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, 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 any 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 under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, 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 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. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the 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. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +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. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. \ No newline at end of file diff --git a/README.md b/README.md index fa68bc0877411e19de601dd9aac12df138e7d21e..6982098ef99364a42d7727ccfd4018f07ce9b1ea 100644 --- a/README.md +++ b/README.md @@ -1 +1,91 @@ -# Vault \ No newline at end of file +# Introduction + +This guide will give an overview of important information related to the *Vault* container image. + +## Getting Started + +### How to Use the Container + +To run the Vault image, run the following commands: + +```shell +docker run -it -p 8200:8200 +``` + +**NOTE:** To run it must have a config file at the path */vault/vaultconfig/vault-config.json*. This is necessary for the helm chart to work properly. + +**Additional Debug Information** +If you want to run Vault locally, there are 2 methods. The first is to: + +1. Put a `COPY` statement below the one that copies that *entrypoint* file that copies a *vault-config.json* file from the *bin* folder into */vault/config*. +2. Change the `CMD` statement to read `CMD ["server", "--config=/vault/config/vault-config.json"]` + - This will allow Vault to run fully in memory. This should never be used for production setups. + - The *vault-config.json* file currently located in the *bin* folder should not be used as is. It needs to have some values configured before being used. + - `masterURL` can be set to 127.0.0.1 for local testing. + - `storage` can be changed to a local file for testing. + +The second is to: + +1. Change the `CMD` statement to read `CMD ["server", "-dev"]` +2. This will allow you to run Vault in *Dev* Server Mode. + - You can learn more about what can be done with this [here](https://www.vaultproject.io/docs/concepts/dev-server.html). + +### Configuration Notes + +The following changes must be made before deployment: + +- Change the **Build** arg in the dockerfile if a different version is being used. +- Helm chart changes: + - *tag* & *secret* values in *values.yml* Not currently stored in Helm repo. + - Add *vaults.secret.yml*. This is not stored in the Helm repo. + - *vaults.secrets.yml* will need a tls section, containing *hosts*, *cert*, *key*, and *secretname* values. + - The above are not stored in the repo currently due to security concerns. **(2020,01/09)** + - Before deploying, it + +### Additional Notes + +- */vault/logs* is made available to use as a location to store audit logs, if desired; */vault/file* is made available to use as a location with the file storage backend, if desired; the server will be started with */vault/config* as the configuration directory so you can add additional config files in that location. +- The entry point script uses dumb-init as the top-level process to reap any zombie processes created by Vault sub-processes. +- For production derivatives of this container, you shoud add the *IPC_LOCK* capability so that Vault can mlock memory. +- By default you'll get a single-node development server that stores everything in RAM and bootstraps itself. Don't use this configuration for production. +- There is an option for additional encryption to be added to Vault. To enable it, you will need to: + - `mkdir -p /vault/cert` in the run section where you create the multiple other directories. + - `VOLUME /vault/certs` just before you `EXPOSE 8200`. + - `COPY bin/tls.* /vault/certs/`, which also means creating the cert files to go in the *bin* folder. + +## Current Hardening Status + +Currently hardened. Read below for more details. + +- Uses the *ubi8* image as base. **(01/06/2020)** +- Confirmed running non-root. **(01/09/2020)** +- Passes STIG scan. **(01/09/2020)** + - *(CCE-27209-6) Verify and Correct File Permissions with RPM* acceptable risk present. +- Passes Twistlock scan. **(01/09/2020)** +- Passes Anchore scan. **(01/09/2020)** + +## Locations + +*Be sure to include the url for the location if necessary, and any additional notes that may be necessary to access it.* + +### Current Deployment Locations + +**Unhardened Version** +Deployment ring 3, with highest level achieved IL4. + +**Hardened Version** +Not deployed anywhere at this time. + +## Additional Documentation + +### Vault + +- [Vault Official Site](https://www.vaultproject.io/) +- [Vault 1.3.1](https://www.hashicorp.com/blog/vault-1-3/) +- [Hashicorp's Vault Courses](https://learn.hashicorp.com/vault) + +#### Installation + +- Installation - +- Commands - +- Configuration - \ No newline at end of file