Important

This repository has been integrated with a new combined pre-award-frontend.

Funding Service Design - Authenticator

This is the authenticator repository for funding service design microservices. This service provides an API and associated model implementation required for authentication of frontend, assessment and other FSD services.

Developer setup guide

This service depends on:

• A redis instance for storing magic links
• fund-store
• account-store
• notification

Overview

If you want an overview of how this service functions including architecture and features there's a fuller description in the /docs/README here.

Translations

This repo uses pybable for translation. Useful commands contained in tasks.py, more detail available here

Testing

Testing in Python repos

IDE Setup

Python IDE Setup

Builds and Deploys

Details on how our pipelines work and the release process is available here

Paketo

Paketo is used to build the docker image which gets deployed to our test and production environments. Details available here

For Authenticator, envs needs to include values for each of:

• AUTHENTICATOR_HOST
• ACCOUNT_STORE_API_HOST
• APPLICANT_FRONTEND_HOST
• ASSESSMENT_FRONTEND_HOST
• FUND_STORE_API_HOST
• RSA256_PUBLIC_KEY_BASE64
• RSA256_PRIVATE_KEY_BASE64
• AZURE_AD_CLIENT_ID
• AZURE_AD_CLIENT_SECRET
• AZURE_AD_TENANT_ID
• SECRET_KEY
• COOKIE_DOMAIN
• SENTRY_DSN
• GITHUB_SHA
• ALLOW_ASSESSMENT_LOGIN_VIA_MAGIC_LINK
• POST_AWARD_FRONTEND_HOST

Copilot

Copilot is used for infrastructure deployment. Instructions are available here, with the following values for the authenticator:

• service-name: fsd-authenticator
• image-name: funding-service-design-authenticator

Pull Requests

Authenticator has a different set of requirements for PR reviews, as it is relied upon by multiple services. It requires a minimum of 2 reviewers to approve a PR before merging.