Initial commit for the GitHub Action

.github/workflows/lint.yml

@@ -0,0 +1,25 @@
+name: Lint
+
+on:
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js 20.x
+        uses: actions/setup-node@v3.8.1
+        with:
+          node-version: 20.x
+
+      - name: Deps
+        run: |
+          npm install
+
+      - name: Lint
+        run: |
+          npm run lint

.github/workflows/package.yml

@@ -31,10 +31,6 @@ jobs:
         run: |
           npm ci
 
-      - name: Lint
-        run: |
-          npm run lint
-
       - name: Package
         run: |
           npm run build

CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Code of Conduct
+
+The Stackrox code of conduct can be found [here](https://stackrox.io/code-conduct).

CONTRIBUTING.md

@@ -0,0 +1,20 @@
+## Contributing to Central Login
+
+Thank you for your interest in contributing to the Central Login Action!
+
+### Code Contributions
+
+We welcome code contributions from the community. Anyone is welcome to create a pull request,
+and request a review from any of the project maintainers.
+
+By default, your pull requests should be linked to an [issue](https://github.com/stackrox/central-login/issues).
+If you're addressing an existing issue, great! If your change is unrelated to an existing issue,
+please file an issue first, and make sure you get buy-in from the maintainers.
+
+However, if your change is relatively trivial (say, a documentation update, or a simple bugfix),
+feel free to directly create a pull request, and explain your changes in the pull request.
+
+### Feature Requests and Bug Reports
+
+If you find a bug, or have a request for a feature,
+please [create a GitHub issue](https://github.com/stackrox/central-login/issues/new/choose).

LICENSE

@@ -0,0 +1,201 @@
+                                 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.

README.md

@@ -1 +1,109 @@
-# Central Login
+# Central Login GitHub Action
+
+Configure your Central login credentials for use in other GitHub Actions.
+
+This action obtains an access token to
+a [Red Hat Advanced Cluster Security (ACS)](https://www.redhat.com/en/technologies/cloud-computing/openshift/advanced-cluster-security-kubernetes)
+Central instance and configures environment variables for your
+other actions to use.
+
+This is as simple as adding the following step to your workflow:
+
+```yaml
+    - name: Central Login
+      uses: stackrox/central-login@v1
+      with:
+        endpoint: https://<central-endpoint>:443
+```
+
+## Parameters
+
+| Parameter name    | Required?      | Description                                                      |
+|-------------------|----------------|------------------------------------------------------------------|
+| `endpoint`        | **(required)** | API endpoint of the ACS Central instance.                        |
+| `skip-tls-verify` | (optional)     | Skip TLS certificat verification for ACS Central's API endpoint. |
+
+## Overview
+
+It is currently only supported to retrieve credentials by
+using [GitHub's OIDC provider](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers).
+
+With [GitHub's OIDC provider](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers),
+this action will be issued with an ID token unique to this workflow run, which will then
+be exchanged for a ACS Central access token.
+
+For creating the ID
+token, [it is required for your workflow to have the `id-token: write` permission](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers#adding-permissions-settings):
+
+```yaml
+permissions:
+  id-token: write # This is required for requesting the JWT
+```
+
+### Sample Central configuration
+
+Before being able to exchange tokens, the ACS Central instance needs to be configured to allow exchanging tokens
+originating from GitHub Action workflow runs.
+
+At the current time, this only works via API, see the sample configuration below:
+
+```bash
+curl \
+  https://<central-endpoint>/v1/auth/m2m \
+  -d  @- << EOF
+  {
+    "config": {
+      "type": "GITHUB_ACTIONS",
+      "tokenExpirationDuration": "5m", // This can be used to specify the expiration of the exchanged access token.
+      "mappings": [ // Mappings configure which token claims to map to which roles within the ACS Central instance.
+        {
+          "key": "sub",
+          "valueExpression": "repo:octo-org/octo-repo.*", // This supports https://github.com/google/re2/wiki/Syntax expressions.
+          "role": "Continuous Integration"
+        }
+      ],
+    }
+  }
+  EOF
+```
+
+**Recommendations**
+
+- For specifics on the claim values on the ID tokens issued by GitHub's OIDC
+  provider, [check out this documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#understanding-the-oidc-token).
+- Make sure to map claim values _specific_ to your repository. It is recommended to use the `sub` claim for that.
+  For more information about the subject claim's structure for tokens issued by GitHub's OIDC
+  provider, [check out this documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims).
+
+## Using this action in your workflow
+
+After the ACS Central instance has been configured to allow exchanging tokens from GitHub Action workflow runs, you can
+add the following step to your workflow:
+
+```yaml
+    - name: Central Login
+      uses: stackrox/central-login@v1
+      with:
+        endpoint: https://<central-endpoint>:443
+```
+
+After the central login step has succeeded, the following environment variables are configured for other steps to use:
+
+- `ROX_API_TOKEN` which contains the exchanged access token for the ACS Central instance.
+- `ROX_ENDPOINT` which contains the ACS Central instance endpoint correlated with the access token.
+
+For verifying everything works correctly, the example below can be used:
+
+```yaml
+    - name: Central Login
+      uses: stackrox/central-login@v1
+      with:
+        endpoint: https://<central-endpoint>:443
+
+    - name: roxctl central whoami
+      image: quay.io/stackrox-io/roxctl:4.3.0
+      script: central whoami
+```
+
+This will output the specifics about the access token (i.e. it's associated permissions and roles) as well as the
+originating user.

SECURITY.md

@@ -0,0 +1,4 @@
+# Reporting a Vulnerability
+
+If you've found a security issue that you'd like to disclose confidentially please contact Red Hat's Product Security team.  
+Details at https://access.redhat.com/security/team/contact

action.yml

@@ -0,0 +1,13 @@
+name: 'central-login'
+description: A GitHub Action to configure login credentials for an ACS Central instance for use in subsequent steps
+inputs:
+  endpoint:
+    required: true
+    description: 'Central API endpoint in the format of https://<host>:<port>'
+  skip-tls-verify:
+    default: "false"
+    required: false
+    description: "Skip TLS certificate verification for Central's API Endpoint"
+runs:
+  using: 'node20'
+  main: 'dist/index.js'