Merge pull request #5 from linuxfoundation/ems/megalinter

Add MegaLinter; module updates

Author: emsearcy

.github/workflows/license-header-check.yaml

@@ -11,6 +11,9 @@ name: License Header Check
     branches:
       - main
 
+permissions:
+  contents: read
+
 jobs:
   license-header-check:
     name: License Header Check

.github/workflows/mega-linter.yml

@@ -0,0 +1,33 @@
+---
+# Copyright The Linux Foundation and each contributor to LFX.
+# SPDX-License-Identifier: MIT
+
+name: MegaLinter
+
+"on":
+  pull_request: null
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  megalinter:
+    name: MegaLinter
+    runs-on: ubuntu-latest
+
+    steps:
+      # Git Checkout
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      # MegaLinter
+      - name: MegaLinter
+        id: ml
+        # Use the Go flavor.
+        uses: oxsecurity/megalinter/flavors/go@v7

.github/workflows/publish.yaml

@@ -9,10 +9,16 @@ name: Publish
       - main
   workflow_dispatch:
 
+permissions:
+  contents: read
+
 jobs:
   publish:
     name: Publish
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v4

.gitignore

@@ -2,5 +2,8 @@
 # SPDX-License-Identifier: MIT
 
 .env
-bin/
-sbom/
+go.work
+/bin/
+/sbom/
+
+/megalinter-reports/

.mega-linter.yml

@@ -0,0 +1,17 @@
+# Copyright The Linux Foundation and each contributor to LFX.
+# SPDX-License-Identifier: MIT
+---
+DISABLE_LINTERS:
+  # Revive covers this, plus golangci-lint has trouble with newer go toolchains
+  # in go.mod.
+  - GO_GOLANGCI_LINT
+  # cspell is laughably bad at code/comments/etc.
+  - SPELL_CSPELL
+  # Link checking more likely to cause false positives than be useful for us.
+  - SPELL_LYCHEE
+  # yamllint is sufficient for us.
+  - YAML_PRETTIER
+DISABLE_ERRORS_LINTERS:
+  # These are informative but don't need to break the build.
+  - COPYPASTE_JSCPD
+GITHUB_COMMENT_REPORTER: false

.trivyignore

@@ -0,0 +1,6 @@
+# No free access to Chainguard versioned labels.
+AVD-DS-0001
+
+# Allow no health check: Docker-built container is for local development only
+# (ko-build is used for build artifact).
+AVD-DS-0026

0_config.go

@@ -1,6 +1,7 @@
 // Copyright The Linux Foundation and its contributors.
 // SPDX-License-Identifier: MIT
 
+// The auth0-cas-service-go service.
 package main
 
 import (

Dockerfile

@@ -1,6 +1,9 @@
 # Copyright The Linux Foundation and its contributors.
 # SPDX-License-Identifier: MIT
 
+# checkov:skip=CKV_DOCKER_7:No free access to Chainguard versioned labels.
+# hadolint global ignore=DL3007
+
 FROM --platform=$BUILDPLATFORM cgr.dev/chainguard/go:latest AS builder
 
 # Set necessary environment variables needed for our image. Allow building to
@@ -24,6 +27,9 @@ RUN go build -o /go/bin/auth0-cas-server-go -trimpath -ldflags="-w -s" github.co
 # Run our go binary standalone
 FROM cgr.dev/chainguard/static:latest
 
+# Implicit with base image: setting explicitly for linters.
+USER nonroot
+
 EXPOSE 8080
 
 COPY --from=builder /go/bin/auth0-cas-server-go /auth0-cas-server-go

Makefile

@@ -12,6 +12,15 @@ bin/auth0-cas-server-go: *.go go.mod go.sum
 	@mkdir -p bin
 	go build -o bin/auth0-cas-server-go github.com/linuxfoundation/auth0-cas-server-go
 
+all: bin/auth0-cas-server-go docker-build
+
+lint:
+	docker pull --platform linux/amd64 oxsecurity/megalinter-go:v7
+	docker run --rm --platform linux/amd64 -v '$(CURDIR):/tmp/lint:rw' oxsecurity/megalinter-go:v7
+
+test:
+	@echo "No tests to run ... would you like to 'make lint'?"
+
 # Build and label a local Docker container of auth0-cas-server-go.
 docker-build:
 	docker build -t $(IMAGE_NAME):$(GIT_HASH) -t $(IMAGE_NAME):latest .

README.md

@@ -2,56 +2,89 @@
 
 ## Overview
 
-This service was inspired by Auth0, through their example at https://github.com/auth0-samples/auth0-cas-server. It is a simple authentication redirector which wraps an OpenID Connect authentication flow to expose it as server implementing the Central Authentication Service (CAS) SSO protocol. The service leverages configuration stored within Auth0 client metadata, which it reads using a privileged connection to the Auth0 API, in order to emulate multiple different clients dynamically per login session.
+This service was inspired by Auth0, through their example at
+[auth0-samples/auth0-cas-server](https://github.com/auth0-samples/auth0-cas-server).
+It is a simple authentication redirector which wraps an OpenID Connect
+authentication flow to expose it as server implementing the Central
+Authentication Service (CAS) SSO protocol. The service leverages configuration
+stored within Auth0 client metadata, which it reads using a privileged
+connection to the Auth0 API, in order to emulate multiple different clients
+dynamically per login session.
 
 Notable differeces with this implementation:
 
-- Rewritten in Go, including OpenTelemetry instrumentation and multi-arch build outputs including SPDX SBOMs.
-- Supports several additional CAS protocol endpoints implementing multiple CAS versions.
+- Rewritten in Go, including OpenTelemetry instrumentation and multi-arch build
+  outputs including SPDX SBOMs.
+- Supports several additional CAS protocol endpoints implementing multiple CAS
+  versions.
 - Implements CAS single-logout.
-- Implements CAS "gateway mode" to test for authentication without prompting the user.
+- Implements CAS "gateway mode" to test for authentication without prompting
+  the user.
 - Supports both XML and JSON CAS response formats.
-- Allows for path wildcards and multiple, comma-separated CAS service definitions in `client_metadata.cas_service` configuration.
+- Allows for path wildcards and multiple, comma-separated CAS service
+  definitions in `client_metadata.cas_service` configuration.
 
 ## Linux Foundation specific changes
 
-The following hardcoded behavior is specific to the Linux Foundation's Auth0 environment:
+The following hardcoded behavior is specific to the Linux Foundation's Auth0
+environment:
 
-- LF-namespaced OIDC claims used for username and group attributes coming from IdP.
-- Custom CAS attributes: `uid`, `field_lf_*` and `profile_name_*` added to match our reference implementation.
+- LF-namespaced OIDC claims used for username and group attributes coming from
+  IdP.
+- Custom CAS attributes: `uid`, `field_lf_*` and `profile_name_*` added to
+  match our reference implementation.
 
-Porting these into a dynamic configuration system would be useful for generalizing this tool. For instance, a toml file could map upstream OIDC claims to both required CAS fields as well as optional additional CAS attributes, and provide per-attribute customization of the mb4-filtering feature.
+Porting these into a dynamic configuration system would be useful for
+generalizing this tool. For instance, a toml file could map upstream OIDC
+claims to both required CAS fields as well as optional additional CAS
+attributes, and provide per-attribute customization of the mb4-filtering
+feature.
 
 ## Deploying and running the server
 
 You can pull the latest image from the GitHub Container Registry:
 
-```
+```bash
 docker pull ghcr.io/linuxfoundation/auth0-cas-server-go:latest
 ```
 
-Pinning your deployments to a release label (rather than ":latest") is recommended for production use.
+Pinning your deployments to a release label (rather than ":latest") is
+recommended for production use.
 
-Please see `env-example` for a list of required and optional environment variables that can be used to configure the server. For local development, you can copy this file to `.env` and modify it to suit your needs.
+Please see `env-example` for a list of required and optional environment
+variables that can be used to configure the server. For local development, you
+can copy this file to `.env` and modify it to suit your needs.
 
 ## Auth0 client configuration
 
 To create a CAS-enabled Auth0 application, specify the follow settings:
 
 - Application Type: Regular Web Application
 - Allowed Callback URLs: `https://<auth0-cas-server-go>/cas/oidc_callback`
-- Allowed Logout URLs (optional): the CAS logout return URL of your application, if passed by the CAS client ("service" for v3 logout, or "url" for v2 logout).
-- Advanced -> Application Metadata: add Key "cas\_service" with Value of one-or-more (comma-separated) URLs which match the "service" parameter of the CAS application's login request. A `*` will match any subdomain or a single path component, while `**` matches anything (including `/`).
+- Allowed Logout URLs (optional): the CAS logout return URL of your
+  application, if passed by the CAS client ("service" for v3 logout, or "url"
+  for v2 logout).
+- Advanced -> Application Metadata: add Key "cas\_service" with Value of
+  one-or-more (comma-separated) URLs which match the "service" parameter of the
+  CAS application's login request. A `*` will match any subdomain or a single
+  path component, while `**` matches anything (including `/`).
 - Advanced -> OAuth -> OIDC Conformant: Enabled
 
-Multiple apps CAS can be created for different sites: each will have the same callback URL, but they will have different `cas_service` URLs (and logout URLs, if needed).
+Multiple apps CAS can be created for different sites: each will have the same
+callback URL, but they will have different `cas_service` URLs (and logout URLs,
+if needed).
 
-Auth0 client configurations read by this service are cached for performance. New apps should work automatically, but changes to `cas_service` URL patterns for existing apps may require a restart of the service to take effect.
+Auth0 client configurations read by this service are cached for performance.
+New apps should work automatically, but changes to `cas_service` URL patterns
+for existing apps may require a restart of the service to take effect.
 
 ## License
 
 Copyright The Linux Foundation and its contributors.
 
-This project's source code is licensed under the MIT License. A copy of the license is available in LICENSE.
+This project's source code is licensed under the MIT License. A copy of the
+license is available in LICENSE.
 
-This project's documentation is licensed under the Creative Commons Attribution 4.0 International License (CC-BY-4.0). A copy of the license is available in LICENSE-docs.
+This project's documentation is licensed under the Creative Commons Attribution
+4.0 International License (CC-BY-4.0). A copy of the license is available in
+LICENSE-docs.