├── httpd-foreground ├── Dockerfile ├── README.md └── LICENSE /httpd-foreground: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -e 3 | 4 | # Apache gets grumpy about PID files pre-existing 5 | rm -f /usr/local/apache2/logs/httpd.pid /run/httpd/httpd.pid 6 | 7 | # start fpm 8 | if [ ! -d "/run/php-fpm" ] 9 | then 10 | mkdir /run/php-fpm 11 | fi 12 | 13 | php-fpm -D 14 | 15 | exec httpd -DFOREGROUND 16 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM rockylinux/rockylinux:8.4 as download_ssp 2 | 3 | ARG SIMPLE_SAML_PHP_VERSION=1.19.6 4 | ARG SIMPLE_SAML_PHP_HASH=834bb4a89d63d7498e77cceb49e01b919d1c0a6a3d38a992f905810dad424b7c 5 | 6 | RUN dnf install -y wget \ 7 | && ssp_version=$SIMPLE_SAML_PHP_VERSION; \ 8 | ssp_hash=$SIMPLE_SAML_PHP_HASH; \ 9 | wget https://github.com/simplesamlphp/simplesamlphp/releases/download/v$ssp_version/simplesamlphp-$ssp_version.tar.gz \ 10 | && echo "$ssp_hash simplesamlphp-$ssp_version.tar.gz" | sha256sum -c - \ 11 | && cd /var \ 12 | && tar xzf /simplesamlphp-$ssp_version.tar.gz \ 13 | && mv simplesamlphp-$ssp_version simplesamlphp 14 | 15 | FROM rockylinux/rockylinux:8.4 16 | 17 | LABEL maintainer="Unicon, Inc." 18 | 19 | ARG PHP_VERSION=7.4.19 20 | ARG HTTPD_VERSION=2.4.37 21 | 22 | COPY --from=download_ssp /var/simplesamlphp /var/simplesamlphp 23 | 24 | RUN dnf module enable -y php:7.4 \ 25 | && dnf install -y httpd-$HTTPD_VERSION php-$PHP_VERSION \ 26 | && dnf clean all \ 27 | && rm -rf /var/cache/yum 28 | 29 | RUN echo $'\nSetEnv SIMPLESAMLPHP_CONFIG_DIR /var/simplesamlphp/config\nAlias /simplesaml /var/simplesamlphp/www\n \ 30 | \n \ 31 | Require all granted\n \ 32 | \n' \ 33 | >> /etc/httpd/conf/httpd.conf 34 | 35 | COPY httpd-foreground /usr/local/bin/ 36 | 37 | EXPOSE 80 443 38 | 39 | CMD ["httpd-foreground"] 40 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![](https://badge.imagelayers.io/unicon/simplesamlphp:latest.svg)](https://imagelayers.io/?images=unicon/simplesamlphp:latest 'image layer analysis') 2 | 3 | ## Important Note for 1.19.3+ 4 | 5 | Starting with the 1.19.3 image, only the bare minimum requirements to run are being included in the base image. The 6 | following (and their dependencies) will need to be installed in a custom image if needed: 7 | 8 | * wget 9 | * mod_ssl 10 | * php-ldap 11 | * php-memcache 12 | * php-pear 13 | 14 | Also not included is the remirepo RPM repository. 15 | 16 | ## Overview 17 | This Docker image contains a deployed SimpleSAMLphp IdP/SP based on PHP 7.2 running on Apache HTTP Server 2.4 on the latest CentOS 7 base. This image is a base image and should be used to set the content and configuration with local changes. It is suitable for use as a standalone IdP application or as a base to deploy another PHP application that will be protected by the service provider module. 18 | 19 | ``` 20 | [rootdir] 21 | |-- etc/ 22 | | |-- httpd/ 23 | | | |-- conf/ - The Apache HTTP Server configuration 24 | |-- var/ 25 | | |-- log/ 26 | | | |-- httpd/ - The log files for Apache HTTP Server 27 | | |-- simplesamlphp/ - The base SimpleSAMLphp directory 28 | | | |-- config/ - The SimpleSAMLphp configuration directory 29 | | |-- www/ 30 | | | |-- html/ - The base Apache HTTP Server document root directory 31 | ``` 32 | 33 | SimpleSAMLphp is verified using cryptographic hashes obtained from the vendor and stored in the Dockerfile directly. 34 | 35 | A working example of how this image can be used can be found at https://github.com/UniconLabs/dockerized-idp-testbed. 36 | 37 | ## Tags 38 | It is recommended that only the highest version tag is used as each previous tag/version is generally associated to fixes of the SimpleSAMLphp application. 39 | 40 | ## Creating a SimpleSAMLphp Configuration 41 | Image adopters should follow the SimpleSAMLphp documentation (https://simplesamlphp.org/docs/stable/) to configure the IdP/SP and/or other features. Include other directories that one would often customized, such as the images, css, and application files themselves. 42 | 43 | ## Using the Image 44 | You should use this image as a base image for one's own IdP/SP deployment. The directory structure could look like: 45 | 46 | ``` 47 | [rootdir] 48 | |-- .dockerignore 49 | |-- Dockerfile 50 | |-- etc-httpd/ 51 | | |-- conf.d/ 52 | | | |-- httpd.conf 53 | |-- var-simplesamlphp/ 54 | | |-- config/ 55 | | | |-- config.php 56 | |-- var-www/ 57 | | |-- html/ 58 | | | |-- index.php 59 | ``` 60 | 61 | Next, assuming you create a Dockerfile similar to this example: 62 | 63 | ``` 64 | FROM unicon/simplesamlphp 65 | 66 | MAINTAINER 67 | 68 | COPY etc-httpd/ /etc/httpd/ 69 | COPY var-simplesamlphp/ /var/simplesamlphp/ 70 | COPY var-www/ /var/www/ 71 | ``` 72 | 73 | The dependant image can be built by running: 74 | 75 | ``` 76 | docker pull centos:centos7 77 | docker build --tag="/simplesamlphp-idp:" . 78 | ``` 79 | 80 | or 81 | 82 | ``` 83 | docker pull centos:centos7 84 | docker build --tag="/ourapplication:" . 85 | ``` 86 | 87 | > This will download the base image from the Docker Hub repository. Next, your files are overlaid replacing the base image's counter-parts. 88 | 89 | Now, execute the new/customized image: 90 | 91 | ``` 92 | $ docker run -d --name="ssp-local-test" /simplesamlphp-idp 93 | ``` 94 | 95 | or 96 | 97 | ``` 98 | $ docker run -d --name="ourapplication-local-test" /ourapplication 99 | ``` 100 | 101 | > This is the base command-line used to start the container. The container will likely fail to initialize if this limited command-line is used. You'll likely need to specify additional parameters to start-up the container. 102 | 103 | ## Run-time Parameters 104 | Start the IdP will take several parameters. The following parameters can be specified when `run`ning a new container: 105 | 106 | ### Port Mappings 107 | The image exposes two ports. `80` is the for standard browser-based HTTP communication. `443` is the standard browser-based HTTPS/TLS communication port. These ports will need to be mapped to the Docker host so that communication can occur. 108 | 109 | * `-P`: Used to indicate that the Docker Service should map all exposed container ports to ephemeral host ports. Use `docker ps` to see the mappings. 110 | * `-p :`: Explicitly maps the host ports to the container's exposed ports. This parameters can be used multiple times to map multiple sets of ports. `-p 443:443` would make the service accessible on `https:///simplesaml/`. 111 | 112 | ### Environmental variables 113 | No explicit envinonmental variables are used by this container. Any that SimpleSAMLphp might use can be used per the application documentation. 114 | 115 | ### Volume Mount 116 | The container does not explicitally need any volumes mapped for operation, but the option does exist using the following format: 117 | 118 | * `-v hostDir:containerDir` 119 | 120 | It maybe desirable to map things like `/var/log/httpd/` or `/var/simplesamlphp/cert/` to host-side storage. 121 | 122 | ## Notables 123 | There are a few things that implementors should be aware of. 124 | 125 | ### Browser-based TLS Certificate and Key 126 | Adapters should generate their own private key and get the CSR signed by a trusted certificate authority. The resulting files should be included in the image (directly or mounted to the container at start-up). The standard Apache HTTPD TLS config can be changed by adding/modifying the files in `/etc/httpd/conf.d/`. 127 | 128 | ### Logging 129 | This image does not use the standard Docker logging mechanism, but the native OS-based logging. 130 | 131 | ## Building from source: 132 | 133 | ``` 134 | $ docker build --tag="/simplesamlphp" github.com/unicon/simplesamlphp-dockerized 135 | ``` 136 | 137 | 138 | ## Authors/Contributors 139 | 140 | * John Gasper () 141 | 142 | ## LICENSE 143 | 144 | Copyright 2020 Unicon, Inc. 145 | 146 | Licensed under the Apache License, Version 2.0 (the "License"); 147 | you may not use this file except in compliance with the License. 148 | You may obtain a copy of the License at 149 | 150 | http://www.apache.org/licenses/LICENSE-2.0 151 | 152 | Unless required by applicable law or agreed to in writing, software 153 | distributed under the License is distributed on an "AS IS" BASIS, 154 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 155 | See the License for the specific language governing permissions and 156 | limitations under the License. 157 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------