diff --git a/.gitlab/issue_templates/Access Request.md b/.gitlab/issue_templates/Access Request.md index 2e3e8b7854eadd44949a59c36f367e9ebddeb6f8..1a7b224d6ccdad95fef69b5c8be1ce2b543f338e 100644 --- a/.gitlab/issue_templates/Access Request.md +++ b/.gitlab/issue_templates/Access Request.md @@ -13,7 +13,4 @@ The access level should be: - [ ] All accounts have been provided the necessary accesses - - - /label ~"Access" ~"To Do" \ No newline at end of file diff --git a/.gitlab/issue_templates/Application - Archive.md b/.gitlab/issue_templates/Application - Archive.md index 03042760908cfaf04f1da1ed0f44e42f6ba9aedd..a558faaf765e822f984fef16e3aba584000157a9 100644 --- a/.gitlab/issue_templates/Application - Archive.md +++ b/.gitlab/issue_templates/Application - Archive.md @@ -17,7 +17,4 @@ Requesting this application be archived due to one of the following reasons: - [ ] Iron Bank frontend no longer lists application as available or approved - - - /label ~"Container::Archive" \ No newline at end of file diff --git a/.gitlab/issue_templates/Application - Initial.md b/.gitlab/issue_templates/Application - Initial.md index 7ddab914be32ba1a5b110458609e7b178e7b75be..b7acebdd9071ad436e0b41d820acefdce379efb1 100644 --- a/.gitlab/issue_templates/Application - Initial.md +++ b/.gitlab/issue_templates/Application - Initial.md @@ -7,69 +7,25 @@ Requesting application to be hardened. This is only for initial hardening of a c Current version: (State the current version of the application as you see it) -## Communication - -All communication should occur through this issue. This ensures that all information is documented in a centralized location and also ensures that all of the assignees are notified of updates. It is imperative that all required parties are listed as assignees of this issue and that individuals are not removed. Please do not remove anyone from the assignee list. - -If you need to contact the Container Hardening team, please identify your assigned point of contact. You can find your point of contact by: -1. They should be listed as an assignee on this ticket -2. They should be listed in the `hardening_manifest.yaml` file under the `maintainers` section with a field of `cht_member: true` - -If you have no assignee, feel free to tag Container Hardening leadership in your issue by commenting on this issue with your questions/concerns and then add `/cc @ironbank-notifications/leadership`. Gitlab will automatically notify all Container Hardening leadership to look at this issue and respond. - - -## Responsibilities - -If this application is owned by a Contributor or Vendor (identifed as `Owner::Contributor` and `Owner::Vendor` respectively), then it is your responsibility to drive this issue through completion. This means that the Container Hardening team is not here to help push any deadlines/timeframes you may have with other customers or DoD agencies. If you have issues with the activity, you may notify Container Hardening leadership above. Do not change the ownership labels. +Under support: (Is the updated version within the same major version of the application or is this a new major version?) ## Definition of Done - Hardening: -- [ ] Hardening manifest is created and adheres to the schema (https://repo1.dsop.io/ironbank-tools/ironbank-pipeline/-/blob/master/schema/hardening_manifest.schema.json) -- [ ] Container builds successfully through the Gitlab CI pipeline +- [ ] Container builds successfully +- [ ] Greylist file has been created (requires a member from container hardening) - [ ] Branch has been merged into `development` -- [ ] Project is configured for automatic renovate updates (if possible) Justifications: - [ ] All findings have been justified per the above documentation -- [ ] Justifications have been attached to this issue -- [ ] Apply the label `Approval` to indicate this container is ready for the approval phase - -Note: The justifications must be provided in a timely fashion. Failure to do so could result in new findings being identified which may start this process over. +- [ ] Justifications have been provided to the container hardening team -Approval Process (Container Hardening Team processes): +Approval Process (container hardening team processes): - [ ] Peer review from Container Hardening Team - [ ] Findings Approver has reviewed and approved all justifications - [ ] Approval request has been sent to Authorizing Official - [ ] Approval request has been processed by Authorizing Official -Note: If the above approval process is kicked back for any reason, the `Approval` label will be removed and the issue will be sent back to `Open`. Any comments will be listed in this issue for you to address. Once they have been addressed, you may re-add the `Approval` label. - -## Post Approval - -### Continuous Monitoring - -Once a container is approved, the `Approved` label will be applied to this issue and it will be closed. You will be able to find your applications on http://ironbank.dsop.io and https://registry1.dsop.io. - -In addition to the above, your application will now be subscribed to continuous monitoring. This means that any new findings discovered as part of this will need justifications. To satisfy this process, any new findings will trigger a new Gitlab issue in this project with the label `Container::New Findings`. All members listed in the `maintainers` section of the `hardening_manifest.yaml` file will automatically be assigned. It is your responsibility as a Contributor or Vendor to monitor for this and provide justifications in a timely fashion. This newly created issue will have all the instructions necessary to complete the process. Failure to provide justifications could result in the revocation of the application's approval status. - -### Updates - -It is imperative that application updates be submitted as quickly as possible. We do not want applications to become stale. To help with this process, Ironbank recommends using a tool called [Renovate](https://github.com/renovatebot/renovate). This requires a `renovate.json` file to be placed in your project and can automate the creation of issues and merge requests. - -If not using Renovate, it will be up to you as a Contributor or Vendor to keep this image up-to-date at all times. When you wish to submit an application update, you must create a new issue in this project using the `Application - Update` template and associate it with the corresponding merge request. If you submit a merge request alone, work will not proceed until a related issue is created. These issues are tracked using the label `Container::Update`. - -Additionally, it is imperative that all updates must be followed through to completion. Simply submitting an application update but not following through on justifications and approvals does not suffice and risk your application's approval status being revoked. - -### Bugs - -Occassionally, users may file bug reports for your application. It is your responsibility to monitor for these since they are created inside your project repository. Assignees will automatically be populated by the `members` section of the `hardening_manifest.yaml` file and will have the label `Bug`. - - - - - /label ~"Container::Initial" \ No newline at end of file diff --git a/.gitlab/issue_templates/Application - Update.md b/.gitlab/issue_templates/Application - Update.md index 569e75d8a4ca8586187f741c405fbfbcf02bb309..15567bec2a87392a422b9c2b691f9eccb2ae2473 100644 --- a/.gitlab/issue_templates/Application - Update.md +++ b/.gitlab/issue_templates/Application - Update.md @@ -13,38 +13,18 @@ Updated version: (State the version you would like the application updated to) Under support: (Is the updated version within the same major version of the application or is this a new major version?) -## Communication - -All communication should occur through this issue. This ensures that all information is documented in a centralized location and also ensures that all of the assignees are notified of updates. It is imperative that all required parties are listed as assignees of this issue and that individuals are not removed. Please do not remove anyone from the assignee list. - -If you need to contact the Container Hardening team, please identify your assigned point of contact. You can find your point of contact by: -1. They should be listed as an assignee on this ticket -2. They should be listed in the `hardening_manifest.yaml` file under the `maintainers` section with a field of `cht_member: true` - -If you have no assignee, feel free to tag Container Hardening leadership in your issue by commenting on this issue with your questions/concerns and then add `/cc @ironbank-notifications/leadership`. Gitlab will automatically notify all Container Hardening leadership to look at this issue and respond. - - -## Responsibilities - -If this application is owned by a Contributor or Vendor (identifed as `Owner::Contributor` and `Owner::Vendor` respectively), then it is your responsibility to drive this issue through completion. This means that the Container Hardening team is not here to help push any deadlines/timeframes you may have with other customers or DoD agencies. If you have issues with the activity, you may notify Container Hardening leadership above. Do not change the ownership labels. - - ## Definition of Done Hardening: -- [ ] Hardening manifest has been updated and adheres to the schema (https://repo1.dsop.io/ironbank-tools/ironbank-pipeline/-/blob/master/schema/hardening_manifest.schema.json) -- [ ] Container builds successfully throughthe Gitlab CI pipeline +- [ ] Container builds successfully +- [ ] Container version has been updated in greylist file - [ ] Branch has been merged into `development` -- [ ] Project is configured for automatic renovate updates (if possible) No new findings: -- [ ] There are no new findings in this update. Skip the Justifications and Approval Process steps and apply the label `Approval` +- [ ] There are no new findings in this update. Skip the Justifications and Approval Process steps and apply the label ~"Approval". Justifications: - [ ] All findings have been justified per the above documentation - [ ] Justifications have been provided to the container hardening team -- [ ] Skip the Justifications and Approval Process steps and apply the label `Approval` - -Note: The justifications must be provided in a timely fashion. Failure to do so could result in new findings being identified which may start this process over. Approval Process: - [ ] Peer review from Container Hardening Team @@ -52,31 +32,6 @@ Approval Process: - [ ] Approval request has been sent to Authorizing Official - [ ] Approval request has been processed by Authorizing Official -Note: If the above approval process is kicked back for any reason, the `Approval` label will be removed and the issue will be sent back to `Open`. Any comments will be listed in this issue for you to address. Once they have been addressed, you may re-add the `Approval` label. - - -## Post Approval - -### Continuous Monitoring - -Once a container is approved, the `Approved` label will be applied to this issue and it will be closed. You will be able to find your applications on http://ironbank.dsop.io and https://registry1.dsop.io. - -In addition to the above, your application will now be subscribed to continuous monitoring. This means that any new findings discovered as part of this will need justifications. To satisfy this process, any new findings will trigger a new Gitlab issue in this project with the label `Container::New Findings`. All members listed in the `maintainers` section of the `hardening_manifest.yaml` file will automatically be assigned. It is your responsibility as a Contributor or Vendor to monitor for this and provide justifications in a timely fashion. This newly created issue will have all the instructions necessary to complete the process. Failure to provide justifications could result in the revocation of the application's approval status. - -### Updates - -It is imperative that application updates be submitted as quickly as possible. We do not want applications to become stale. To help with this process, Ironbank recommends using a tool called [Renovate](https://github.com/renovatebot/renovate). This requires a `renovate.json` file to be placed in your project and can automate the creation of issues and merge requests. - -If not using Renovate, it will be up to you as a Contributor or Vendor to keep this image up-to-date at all times. When you wish to submit an application update, you must create a new issue in this project using the `Application - Update` template and associate it with the corresponding merge request. If you submit a merge request alone, work will not proceed until a related issue is created. These issues are tracked using the label `Container::Update`. - -Additionally, it is imperative that all updates must be followed through to completion. Simply submitting an application update but not following through on justifications and approvals does not suffice and risk your application's approval status being revoked. - -### Bugs - -Occassionally, users may file bug reports for your application. It is your responsibility to monitor for these since they are created inside your project repository. Assignees will automatically be populated by the `members` section of the `hardening_manifest.yaml` file and will have the label `Bug`. - - - /label ~"Container::Update" \ No newline at end of file diff --git a/.gitlab/issue_templates/Bug.md b/.gitlab/issue_templates/Bug.md index 069eaf011d42a47b30c06a6e532be5f191b063f7..2030c2450a9b50ff04118e5b241a3ea67700d11d 100644 --- a/.gitlab/issue_templates/Bug.md +++ b/.gitlab/issue_templates/Bug.md @@ -33,9 +33,4 @@ logs, and code as it's very hard to read otherwise.) - [ ] Bug has been identified and corrected within the container - - - - - /label ~Bug \ No newline at end of file diff --git a/.gitlab/issue_templates/CODEOWNERS b/.gitlab/issue_templates/CODEOWNERS new file mode 100644 index 0000000000000000000000000000000000000000..64a2c68c3ababda8d526d6cd995f02cd36f837ab --- /dev/null +++ b/.gitlab/issue_templates/CODEOWNERS @@ -0,0 +1,6 @@ +[Pipelines] +.gitlab-ci.yml @ironbank-notifications/cht +.gitlab-ci.yaml @ironbank-notifications/cht + +[Gitlab Configuration Files] +.gitlab/* @ironbank-notifications/cht diff --git a/.gitlab/issue_templates/Feature Request.md b/.gitlab/issue_templates/Feature Request.md index aad067130061ed0a1f0f82def17a6d74597d1184..94aea9ad692dc00d86f01baf1e550a980d740ffd 100644 --- a/.gitlab/issue_templates/Feature Request.md +++ b/.gitlab/issue_templates/Feature Request.md @@ -28,9 +28,4 @@ - [ ] Feature has been implemented - - - - - /label ~Feature \ No newline at end of file diff --git a/.gitlab/issue_templates/Leadership Question.md b/.gitlab/issue_templates/Leadership Question.md index b2cf9e5ed349dfa03f6099b19cb92c8c9ca3ba36..4674f82f930085f34f51b4ecbb4d396519f53192 100644 --- a/.gitlab/issue_templates/Leadership Question.md +++ b/.gitlab/issue_templates/Leadership Question.md @@ -3,10 +3,5 @@ (Detailed description of the question you'd like to ask the leadership team) - - - - - /label ~"Question::Leadership" ~"To Do" /cc @ironbank-notifications/leadership \ No newline at end of file diff --git a/.gitlab/issue_templates/New Findings.md b/.gitlab/issue_templates/New Findings.md index 867f8325e650bae70a6bbb793cd7ff304b015681..1fd613df303a19d7d7c458e6b614428ab7106aa6 100644 --- a/.gitlab/issue_templates/New Findings.md +++ b/.gitlab/issue_templates/New Findings.md @@ -8,20 +8,12 @@ Container has new findings discovered during continuous monitoring. Justifications: - [ ] All findings have been justified - [ ] Justifications have been provided to the container hardening team -- [ ] `Approval` label has been applied - -Note: The justifications must be provided in a timely fashion. Failure to do so could result in new findings being identified which may start this process over. Approval Process: - [ ] Findings Approver has reviewed and approved all justifications - [ ] Approval request has been sent to Authorizing Official - [ ] Approval request has been processed by Authorizing Official -Note: If the above approval process is kicked back for any reason, the `Approval` label will be removed and the issue will be sent back to `Open`. Any comments will be listed in this issue for you to address. Once they have been addressed, you may re-add the `Approval` label. - - - - /label ~"Container::New Findings" \ No newline at end of file diff --git a/.gitlab/issue_templates/Onboarding Question.md b/.gitlab/issue_templates/Onboarding Question.md index ae8011ecfe1e0b95ed4c5658c122d47e21b89b1a..77dea11e56c87d3fb65a1cf2ce7901621058f970 100644 --- a/.gitlab/issue_templates/Onboarding Question.md +++ b/.gitlab/issue_templates/Onboarding Question.md @@ -3,10 +3,5 @@ (Detailed description of the question you'd like to ask the onboarding team) - - - - - /label ~"Question::Onboarding" ~"To Do" /cc @ironbank-notifications/onboarding \ No newline at end of file diff --git a/.gitlab/issue_templates/Pipeline Failure.md b/.gitlab/issue_templates/Pipeline Failure.md index 36aa982dd3d0710f880e30138e42bbec870a7e94..dd6ab988a361e6afd67065a522e883f8d11e6aec 100644 --- a/.gitlab/issue_templates/Pipeline Failure.md +++ b/.gitlab/issue_templates/Pipeline Failure.md @@ -27,10 +27,4 @@ - [ ] Pipeline failure has been resolved - - - - - - /label ~Pipeline \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000000000000000000000000000000000000..83769199d27eaca96668313a39f8a2db3ed0eb8f --- /dev/null +++ b/Dockerfile @@ -0,0 +1,46 @@ +ARG BASE_REGISTRY=registry1.dso.mil +ARG BASE_IMAGE=ironbank/redhat/ubi/ubi8 +ARG BASE_TAG=8.4 + +FROM quay.io/coreos/clair:v4.1.1 as base + +FROM ${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG} as build + +COPY musl.tar.gz / + +RUN dnf install -y gcc make && \ + mkdir -p /usr/local/src/musl && \ + tar -zxf /musl.tar.gz -C /usr/local/src/musl --strip-components=1 && \ + cd /usr/local/src/musl && \ + ./configure && \ + make && \ + make install + +FROM ${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG} + +ENV CLAIR_CONF=/config/config.yaml CLAIR_MODE=combo +ENV SSL_CERT_DIR="/etc/ssl/certs:/etc/pki/tls/certs:/var/run/certs" + +RUN groupadd -g 1000 clair && \ + useradd -r -u 1000 -m -s /sbin/nologin -g clair clair && \ + mkdir /etc/clair && \ + dnf upgrade -y && \ + dnf install --nodocs -y git xz && \ + dnf clean all && \ + rm -rf /var/cache/dnf && \ + chmod -s /usr/libexec/openssh/ssh-keysign + +COPY --from=base /bin/clair /bin/clair +COPY --from=base /bin/clairctl /bin/clairctl +COPY --from=base /usr/local/bin/dumb-init /usr/local/bin/dumb-init +COPY --from=build /usr/local/musl/lib/libc.so /usr/local/musl/lib/libc.so +COPY --from=build /lib/ld-musl-x86_64.so.1 /lib/ld-musl-x86_64.so.1 + +USER 1000 +VOLUME /config +WORKDIR /run +EXPOSE 6060 6061 + +HEALTHCHECK CMD curl -fs http://127.0.0.1:6061/health || curl -fsk https://127.0.0.1:6061/health || exit 1 + +ENTRYPOINT ["/usr/local/bin/dumb-init", "--", "/bin/clair"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..e06d2081865a766a8668acc12878f98b27fc9ea0 --- /dev/null +++ b/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/README.md b/README.md index 5a016b4999ca93922bad895ce6e711c0ae020412..83489cb25a11c61150128540aa46638566ec19b5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ -# clair +# Clair +![Clair Logo](https://cloud.githubusercontent.com/assets/343539/21630811/c5081e5c-d202-11e6-92eb-919d5999c77a.png) + +Clair is an open source project for the static analysis of vulnerabilities in application containers (currently including appc and docker). + +1. In regular intervals, Clair ingests vulnerability metadata from a configured set of sources and stores it in the database. +2. Clients use the Clair API to index their container images; this creates a list of _features_ present in the image and stores them in the database. +3. Clients use the Clair API to query the database for vulnerabilities of a particular image; correlating vulnerabilities and features is done for each request, avoiding the need to rescan images. +4. When updates to vulnerability metadata occur, a notification can be sent to alert systems that a change has occurred. + +Our goal is to enable a more transparent view of the security of container-based infrastructure. +Thus, the project was named `Clair` after the French term which translates to *clear*, *bright*, *transparent*. + +## Documentation + +To learn more about Clair [go to the complete documentation](https://coreos.com/clair/docs/latest/). diff --git a/hardening_manifest.yaml b/hardening_manifest.yaml new file mode 100644 index 0000000000000000000000000000000000000000..482c7b947e4987f77a2dddc09bda5ba50a1e4801 --- /dev/null +++ b/hardening_manifest.yaml @@ -0,0 +1,55 @@ +--- +apiVersion: v1 + +# The repository name in registry1, excluding /ironbank/ +name: "opensource/quay/clair" + +# List of tags to push for the repository in registry1 +# The most specific version should be the first tag and will be shown +# on ironbank.dsop.io +tags: +- "v4.1.1" +- "latest" + +# Build args passed to Dockerfile ARGs +args: + BASE_IMAGE: "redhat/ubi/ubi8" + BASE_TAG: "8.4" + +# Docker image labels +labels: + org.opencontainers.image.title: "clair" + # Human-readable description of the software packaged in the image + org.opencontainers.image.description: "Clair is an open source project for the static analysis of vulnerabilities in application containers" + # License(s) under which contained software is distributed + org.opencontainers.image.licenses: "Apache-2.0" + # URL to find more information on the image + org.opencontainers.image.url: "https://github.com/quay/clair" + # Name of the distributing entity, organization or individual + org.opencontainers.image.vendor: "Red Hat" + org.opencontainers.image.version: "v4.1.1" + # Keywords to help with search (ex. "cicd,gitops,golang") + mil.dso.ironbank.image.keywords: "security,scanning,container" + # This value can be "opensource" or "commercial" + mil.dso.ironbank.image.type: "opensource" + # Product the image belongs to for grouping multiple images + mil.dso.ironbank.product.name: "clair" + +# List of resources to make available to the offline build context +resources: +- tag: quay.io/coreos/clair:v4.1.1 + url: docker://quay.io/coreos/clair@sha256:fe4b5f32b8bbc6f4ba276d441e4aaf57bbf6e55092e5f4497f8767aa65fc7c4a +- filename: musl.tar.gz + url: https://musl.libc.org/releases/musl-1.2.0.tar.gz + validation: + type: sha256 + value: c6de7b191139142d3f9a7b5b702c9cae1b5ee6e7f57e582da9328629408fd4e8 + +# List of project maintainers +maintainers: +- email: "melissari_sean@bah.com" + # The name of the current container owner + name: "Sean Melissari" + # The gitlab username of the current container owner + username: "melissari_sean" + cht_member: true diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000000000000000000000000000000000000..9a2a9b89e420b38616514d601009f21f30c965ab --- /dev/null +++ b/renovate.json @@ -0,0 +1,32 @@ +{ + "assignees": [ + "@sean.melissari" + ], + "baseBranches": [ + "development" + ], + "automerge": true, + "gitLabAutomerge": true, + "regexManagers": [ + { + "fileMatch": [ + "^hardening_manifest.yaml$" + ], + "matchStrings": [ + "org\\.opencontainers\\.image\\.version:\\s+\"(?.+?)\"" + ], + "depNameTemplate": "quay.io/coreos/clair", + "datasourceTemplate": "docker" + }, + { + "fileMatch": [ + "^hardening_manifest.yaml$" + ], + "matchStrings": [ + "tags:\\s+-\\s+\"(?.+?)\"" + ], + "depNameTemplate": "quay.io/coreos/clair", + "datasourceTemplate": "docker" + } + ] +}