Fix: GCP IAP Config and Docs

Corrected the documentation for the GCP IAP auth module and updated the configuration to follow proxy configuration conventions by ignoring authEnv

Signed-off-by: Brian Saltz Jr <brian.saltzjr@gocrisp.com>
This commit is contained in:
Brian Saltz Jr
2024-08-13 14:59:40 -04:00
parent edb89a2ee7
commit 13a9c63294
4 changed files with 25 additions and 21 deletions
+6
View File
@@ -0,0 +1,6 @@
---
'@backstage/plugin-auth-backend-module-gcp-iap-provider': patch
'@backstage/core-components': patch
---
Corrected the documentation for the GCP IAP auth module and updated the configuration to follow proxy configuration conventions by ignoring authEnv
+2 -2
View File
@@ -24,7 +24,7 @@ Let's start by adding the following `auth` configuration in your
```yaml
auth:
providers:
gcp-iap:
gcpIap:
audience: '/projects/<project number>/global/backendServices/<backend service id>'
jwtHeader: x-custom-header # Optional: Only if you are using a custom header for the IAP JWT
signIn:
@@ -77,6 +77,6 @@ backend.add(import('@backstage/plugin-auth-backend-module-gcp-iap-provider'));
## Adding the provider to the Backstage frontend
See [Sign-In with Proxy Providers](../index.md#sign-in-with-proxy-providers) for pointers on how to set up the sign-in page, and to also make it work smoothly for local development. You'll use `gcp-iap` as the provider name.
See [Sign-In with Proxy Providers](../index.md#sign-in-with-proxy-providers) for pointers on how to set up the sign-in page, and to also make it work smoothly for local development. You'll use `gcpiap` as the provider name.
If you [provide a custom sign in resolver](https://backstage.io/docs/auth/identity-resolver#building-custom-resolvers), you can skip the `signIn` block entirely.
@@ -34,7 +34,7 @@ import { useTranslationRef } from '@backstage/core-plugin-api/alpha';
*/
export type ProxiedSignInPageProps = SignInPageProps & {
/**
* The provider to use, e.g. "gcp-iap" or "awsalb". This must correspond to
* The provider to use, e.g. "gcpiap" or "awsalb". This must correspond to
* a properly configured auth provider ID in the auth backend.
*/
provider: string;
+16 -18
View File
@@ -21,26 +21,24 @@ export interface Config {
* Configuration for the Google Cloud Platform Identity-Aware Proxy (IAP) auth provider.
*/
gcpIap?: {
[authEnv: string]: {
/**
* The audience to use when validating incoming JWT tokens.
* See https://backstage.io/docs/auth/google/gcp-iap-auth
*/
audience: string;
/**
* The audience to use when validating incoming JWT tokens.
* See https://backstage.io/docs/auth/google/gcp-iap-auth
*/
audience: string;
/**
* The name of the header to read the JWT token from, defaults to `'x-goog-iap-jwt-assertion'`.
*/
jwtHeader?: string;
/**
* The name of the header to read the JWT token from, defaults to `'x-goog-iap-jwt-assertion'`.
*/
jwtHeader?: string;
signIn?: {
resolvers: Array<
| { resolver: 'emailMatchingUserEntityAnnotation' }
| { resolver: 'idMatchingUserEntityAnnotation' }
| { resolver: 'emailLocalPartMatchingUserEntityName' }
| { resolver: 'emailMatchingUserEntityProfileEmail' }
>;
};
signIn?: {
resolvers: Array<
| { resolver: 'emailMatchingUserEntityAnnotation' }
| { resolver: 'idMatchingUserEntityAnnotation' }
| { resolver: 'emailLocalPartMatchingUserEntityName' }
| { resolver: 'emailMatchingUserEntityProfileEmail' }
>;
};
};
};