Add optional auth tooling

.env.example

@@ -38,3 +38,8 @@ VSI_CACHE_SIZE=536870912
 MOSAIC_CONCURRENCY=1
 EOAPI_RASTER_ENABLE_MOSAIC_SEARCH=TRUE
 
+# AUTH
+EOAPI_AUTH_CLIENT_ID=my-client-id
+EOAPI_AUTH_OPENID_CONFIGURATION_URL=https://cognito-idp.us-east-1.amazonaws.com/<user pool id>/.well-known/openid-configuration
+EOAPI_AUTH_USE_PKCE=true
+SB_authConfig={ "type": "openIdConnect", "openIdConnectUrl": "https://cognito-idp.us-east-1.amazonaws.com/<user pool id>/.well-known/openid-configuration", "oidcOptions": { "client_id": "stac-browser" } }

.github/workflows/ci.yml

@@ -52,8 +52,7 @@ jobs:
       # see https://github.com/developmentseed/tipg/issues/37
       - name: Restart the Vector service
         run: |
-          docker compose stop vector
-          docker compose up -d vector
+          docker compose restart vector
 
       - name: Sleep for 10 seconds
         run: sleep 10s

docker-compose.yml

@@ -1,8 +1,8 @@
-version: "3"
-
 services:
   # change to official image when available https://github.com/radiantearth/stac-browser/pull/386
   stac-browser:
+    # build: https://github.com/radiantearth/stac-browser.git
+    # TODO: Rm when https://github.com/radiantearth/stac-browser/pull/461 is merged
     build:
       context: dockerfiles
       dockerfile: Dockerfile.browser

dockerfiles/Dockerfile.browser

@@ -12,7 +12,7 @@ RUN rm config.js
 RUN npm install
 # replace the default config.js with our config file
 COPY ./browser_config.js ./config.js
-RUN \[ "${DYNAMIC_CONFIG}" == "true" \] && sed -i 's/<!-- <script defer="defer" src=".\/config.js"><\/script> -->/<script defer="defer" src=".\/config.js"><\/script>/g' public/index.html
+RUN \[ "${DYNAMIC_CONFIG}" == "true" \] && sed -i "s|<!-- <script defer=\"defer\" src=\"/config.js\"></script> -->|<script defer=\"defer\" src=\"${pathPrefix}config.js\"></script>|g" public/index.html
 RUN npm run build
 
 
@@ -31,4 +31,4 @@ EXPOSE 8085
 STOPSIGNAL SIGTERM
 
 # override entrypoint, which calls nginx-entrypoint underneath
-COPY --from=build-step /app/docker/docker-entrypoint.sh ./docker-entrypoint.d/40-stac-browser-entrypoint.sh
+ADD ./docker-entrypoint.sh ./docker-entrypoint.d/40-stac-browser-entrypoint.sh

dockerfiles/Dockerfile.raster

@@ -9,6 +9,9 @@ RUN python -m pip install psycopg[binary,pool]
 COPY runtimes/eoapi/raster /tmp/raster
 RUN python -m pip install /tmp/raster
 RUN rm -rf /tmp/raster
+COPY runtimes/eoapi/auth /tmp/auth
+RUN pip install /tmp/auth
+RUN rm -rf /tmp/auth
 
 ENV MODULE_NAME eoapi.raster.app
 ENV VARIABLE_NAME app

dockerfiles/Dockerfile.stac

@@ -7,6 +7,9 @@ ENV CURL_CA_BUNDLE /etc/ssl/certs/ca-certificates.crt
 COPY runtimes/eoapi/stac /tmp/stac
 RUN python -m pip install /tmp/stac
 RUN rm -rf /tmp/stac
+COPY runtimes/eoapi/auth /tmp/auth
+RUN pip install /tmp/auth
+RUN rm -rf /tmp/auth
 
 ENV MODULE_NAME eoapi.stac.app
 ENV VARIABLE_NAME app

dockerfiles/Dockerfile.vector

@@ -5,6 +5,9 @@ FROM ghcr.io/vincentsarago/uvicorn-gunicorn:${PYTHON_VERSION}
 COPY runtimes/eoapi/vector /tmp/vector
 RUN python -m pip install /tmp/vector
 RUN rm -rf /tmp/vector
+COPY runtimes/eoapi/auth /tmp/auth
+RUN pip install /tmp/auth
+RUN rm -rf /tmp/auth
 
 ENV MODULE_NAME eoapi.vector.app
 ENV VARIABLE_NAME app

dockerfiles/docker-entrypoint.sh

@@ -0,0 +1,96 @@
+# TODO: Rm when https://github.com/radiantearth/stac-browser/pull/461 is merged
+# echo a string, handling different types
+safe_echo() {
+  # $1 = value
+  if [ -z "$1" ]; then
+    echo -n "null"
+  elif printf '%s\n' "$1" | grep -qE '\n.+\n$'; then
+    echo -n "\`$1\`"
+  else
+    echo -n "'$1'"
+  fi
+}
+
+#  handle boolean
+bool() {
+  # $1 = value
+  case "$1" in
+  true | TRUE | yes | t | True)
+    echo -n true
+    ;;
+  false | FALSE | no | n | False)
+    echo -n false
+    ;;
+  *)
+    echo "Err: Unknown boolean value \"$1\"" >&2
+    exit 1
+    ;;
+  esac
+}
+
+# handle array values
+array() {
+  # $1 = value
+  # $2 = arraytype
+  if [ -z "$1" ]; then
+    echo -n "[]"
+  else
+    case "$2" in
+    string)
+      echo -n "['$(echo "$1" | sed "s/,/', '/g")']"
+      ;;
+    *)
+      echo -n "[$1]"
+      ;;
+    esac
+  fi
+}
+
+# handle object values
+object() {
+  # $1 = value
+  if [ -z "$1" ]; then
+    echo -n "null"
+  else
+    echo -n "$1"
+  fi
+}
+
+config_schema=$(cat /etc/nginx/conf.d/config.schema.json)
+
+# Iterate over environment variables with "SB_" prefix
+env -0 | cut -f1 -d= | tr '\0' '\n' | grep "^SB_" | {
+  echo "window.STAC_BROWSER_CONFIG = {"
+  while IFS='=' read -r name; do
+    # Strip the prefix
+    argname="${name#SB_}"
+    # Read the variable's value
+    value="$(eval "echo \"\$$name\"")"
+
+    # Get the argument type from the schema
+    argtype="$(echo "$config_schema" | jq -r ".properties.$argname.type[0]")"
+    arraytype="$(echo "$config_schema" | jq -r ".properties.$argname.items.type[0]")"
+
+    # Encode key/value
+    echo -n "  $argname: "
+    case "$argtype" in
+    string)
+      safe_echo "$value"
+      ;;
+    boolean)
+      bool "$value"
+      ;;
+    integer | number | object)
+      object "$value"
+      ;;
+    array)
+      array "$value" "$arraytype"
+      ;;
+    *)
+      safe_echo "$value"
+      ;;
+    esac
+    echo ","
+  done
+  echo "}"
+} >/usr/share/nginx/html/config.js

runtimes/eoapi/auth/eoapi/auth/__init__.py

@@ -0,0 +1,4 @@
+from .auth import OpenIdConnectAuth  # noqa
+from .config import AuthSettings  # noqa
+
+__version__ = "0.1.0"

runtimes/eoapi/auth/eoapi/auth/auth.py

@@ -0,0 +1,145 @@
+import json
+import logging
+import urllib.request
+from dataclasses import dataclass, field
+from typing import Annotated, Any, Callable, Dict, Optional, Sequence
+
+import jwt
+from fastapi import HTTPException, Security, routing, security, status
+from fastapi.dependencies.utils import get_parameterless_sub_dependant
+from fastapi.security.base import SecurityBase
+from pydantic import AnyHttpUrl
+
+from .types import OidcFetchError
+
+logger = logging.getLogger(__name__)
+
+
+@dataclass
+class OpenIdConnectAuth:
+    openid_configuration_url: AnyHttpUrl
+    openid_configuration_internal_url: Optional[AnyHttpUrl] = None
+    allowed_jwt_audiences: Optional[Sequence[str]] = None
+    oauth2_supported_scopes: Dict[str, str] = field(default_factory=dict)
+
+    # Generated attributes
+    auth_scheme: SecurityBase = field(init=False)
+    jwks_client: jwt.PyJWKClient = field(init=False)
+    valid_token_dependency: Callable[..., Any] = field(init=False)
+
+    def __post_init__(self):
+        logger.debug("Requesting OIDC config")
+        with urllib.request.urlopen(
+            str(self.openid_configuration_internal_url or self.openid_configuration_url)
+        ) as response:
+            if response.status != 200:
+                logger.error(
+                    "Received a non-200 response when fetching OIDC config: %s",
+                    response.text,
+                )
+                raise OidcFetchError(
+                    f"Request for OIDC config failed with status {response.status}"
+                )
+            oidc_config = json.load(response)
+            self.jwks_client = jwt.PyJWKClient(oidc_config["jwks_uri"])
+
+        self.auth_scheme = security.OpenIdConnect(
+            openIdConnectUrl=str(self.openid_configuration_url)
+        )
+        self.valid_token_dependency = self.create_auth_token_dependency(
+            auth_scheme=self.auth_scheme,
+            jwks_client=self.jwks_client,
+            allowed_jwt_audiences=self.allowed_jwt_audiences,
+        )
+
+    @staticmethod
+    def create_auth_token_dependency(
+        auth_scheme: SecurityBase,
+        jwks_client: jwt.PyJWKClient,
+        allowed_jwt_audiences: Sequence[str],
+    ):
+        """
+        Create a dependency that validates JWT tokens & scopes.
+        """
+
+        def auth_token(
+            token_str: Annotated[str, Security(auth_scheme)],
+            required_scopes: security.SecurityScopes,
+        ):
+            token_parts = token_str.split(" ")
+            if len(token_parts) != 2 or token_parts[0].lower() != "bearer":
+                raise HTTPException(
+                    status_code=status.HTTP_401_UNAUTHORIZED,
+                    detail="Invalid authorization header",
+                    headers={"WWW-Authenticate": "Bearer"},
+                )
+            else:
+                [_, token] = token_parts
+            # Parse & validate token
+            try:
+                payload = jwt.decode(
+                    token,
+                    jwks_client.get_signing_key_from_jwt(token).key,
+                    algorithms=["RS256"],
+                    # NOTE: Audience validation MUST match audience claim if set in token (https://pyjwt.readthedocs.io/en/stable/changelog.html?highlight=audience#id40)
+                    audience=allowed_jwt_audiences,
+                )
+            except jwt.exceptions.InvalidTokenError as e:
+                logger.exception(f"InvalidTokenError: {e=}")
+                raise HTTPException(
+                    status_code=status.HTTP_401_UNAUTHORIZED,
+                    detail="Could not validate credentials",
+                    headers={"WWW-Authenticate": "Bearer"},
+                ) from e
+
+            # Validate scopes (if required)
+            for scope in required_scopes.scopes:
+                if scope not in payload["scope"]:
+                    raise HTTPException(
+                        status_code=status.HTTP_401_UNAUTHORIZED,
+                        detail="Not enough permissions",
+                        headers={
+                            "WWW-Authenticate": f'Bearer scope="{required_scopes.scope_str}"'
+                        },
+                    )
+
+            return payload
+
+        return auth_token
+
+    def apply_auth_dependencies(
+        self,
+        api_route: routing.APIRoute,
+        required_token_scopes: Optional[Sequence[str]] = None,
+        dependency: Optional[Callable[..., Any]] = None,
+    ):
+        """
+        Apply auth dependencies to a route.
+        """
+        # Ignore paths without dependants, e.g. /api, /api.html, /docs/oauth2-redirect
+        if not hasattr(api_route, "dependant"):
+            logger.warn(
+                f"Route {api_route} has no dependant, not apply auth dependency"
+            )
+            return
+
+        depends = Security(
+            dependency or self.valid_token_dependency, scopes=required_token_scopes
+        )
+        logger.debug(f"{depends} -> {','.join(api_route.methods)} @ {api_route.path}")
+
+        # Mimicking how APIRoute handles dependencies:
+        # https://github.com/tiangolo/fastapi/blob/1760da0efa55585c19835d81afa8ca386036c325/fastapi/routing.py#L408-L412
+        api_route.dependant.dependencies.insert(
+            0,
+            get_parameterless_sub_dependant(
+                depends=depends, path=api_route.path_format
+            ),
+        )
+
+        # Register dependencies directly on route so that they aren't ignored if
+        # the routes are later associated with an app (e.g.
+        # app.include_router(router))
+        # https://github.com/tiangolo/fastapi/blob/58ab733f19846b4875c5b79bfb1f4d1cb7f4823f/fastapi/applications.py#L337-L360
+        # https://github.com/tiangolo/fastapi/blob/58ab733f19846b4875c5b79bfb1f4d1cb7f4823f/fastapi/routing.py#L677-L678
+        api_route.dependencies.extend([depends])

runtimes/eoapi/auth/eoapi/auth/config.py

@@ -0,0 +1,22 @@
+from typing import Optional, Sequence
+
+from pydantic import AnyHttpUrl
+from pydantic_settings import BaseSettings
+
+
+class AuthSettings(BaseSettings):
+    # Swagger UI config for Authorization Code Flow
+    client_id: str = ""
+    use_pkce: bool = True
+    openid_configuration_url: Optional[AnyHttpUrl] = None
+    openid_configuration_internal_url: Optional[AnyHttpUrl] = None
+
+    allowed_jwt_audiences: Optional[Sequence[str]] = []
+
+    public_reads: bool = True
+
+    model_config = {
+        "env_prefix": "EOAPI_AUTH_",
+        "env_file": ".env",
+        "extra": "allow",
+    }

runtimes/eoapi/auth/eoapi/auth/types.py

@@ -0,0 +1,14 @@
+from typing import Optional, TypedDict
+
+
+class OidcFetchError(Exception):
+    pass
+
+
+class Scope(TypedDict, total=False):
+    """More strict version of Starlette's Scope."""
+
+    # https://github.com/encode/starlette/blob/6af5c515e0a896cbf3f86ee043b88f6c24200bcf/starlette/types.py#L3
+    path: str
+    method: str
+    type: Optional[str]