@backstage/plugin-auth-backend 0.0.0-nightly-20220919030347 → 0.0.0-nightly-20220921030342

package/dist/index.d.ts

@@ -5,12 +5,12 @@ import { GetEntitiesRequest, CatalogApi } from '@backstage/catalog-client';
 import { Entity, UserEntity } from '@backstage/catalog-model';
 import { Config } from '@backstage/config';
 import { BackstageSignInResult, BackstageIdentityResponse } from '@backstage/plugin-auth-node';
+import { JsonValue } from '@backstage/types';
 import { Profile } from 'passport';
 import * as _backstage_backend_common from '@backstage/backend-common';
 import { PluginDatabaseManager, PluginEndpointDiscovery, TokenManager } from '@backstage/backend-common';
 import { IncomingHttpHeaders } from 'http';
 import { TokenSet, UserinfoResponse } from 'openid-client';
-import { JsonValue } from '@backstage/types';
 
 /**
  * Parameters used to issue new ID Tokens
@@ -18,13 +18,20 @@ import { JsonValue } from '@backstage/types';
  * @public
  */
 declare type TokenParams = {
-    /** The claims that will be embedded within the token */
+    /**
+     * The claims that will be embedded within the token. At a minimum, this should include
+     * the subject claim, `sub`. It is common to also list entity ownership relations in the
+     * `ent` list. Additional claims may also be added at the developer's discretion except
+     * for the following list, which will be overwritten by the TokenIssuer: `iss`, `aud`,
+     * `iat`, and `exp`. The Backstage team also maintains the right add new claims in the future
+     * without listing the change as a "breaking change".
+     */
     claims: {
         /** The token subject, i.e. User ID */
         sub: string;
         /** A list of entity references that the user claims ownership through */
         ent?: string[];
-    };
+    } & Record<string, JsonValue>;
 };
 
 /**
@@ -200,10 +207,13 @@ declare type CookieConfigurer = (ctx: {
     baseUrl: string;
     /** The configured callback URL of the auth provider */
     callbackUrl: string;
+    /** The origin URL of the app */
+    appOrigin: string;
 }) => {
     domain: string;
     path: string;
     secure: boolean;
+    sameSite?: 'none' | 'lax' | 'strict';
 };
 /** @public */
 declare type AuthProviderConfig = {
@@ -402,11 +412,10 @@ declare class OAuthEnvironmentHandler implements AuthProviderRouteHandlers {
 /** @public */
 declare type OAuthAdapterOptions = {
     providerId: string;
-    secure: boolean;
     persistScopes?: boolean;
-    cookieDomain: string;
-    cookiePath: string;
     appOrigin: string;
+    baseUrl: string;
+    cookieConfigurer: CookieConfigurer;
     isOriginAllowed: (origin: string) => boolean;
     callbackUrl: string;
 };
@@ -431,6 +440,7 @@ declare class OAuthAdapter implements AuthProviderRouteHandlers {
     private getGrantedScopeFromCookie;
     private setRefreshTokenCookie;
     private removeRefreshTokenCookie;
+    private getCookieConfig;
 }
 
 /** @public */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-auth-backend",
   "description": "A Backstage backend plugin that handles authentication",
-  "version": "0.0.0-nightly-20220919030347",
+  "version": "0.0.0-nightly-20220921030342",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -32,12 +32,12 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/backend-common": "0.0.0-nightly-20220919030347",
-    "@backstage/catalog-client": "0.0.0-nightly-20220919030347",
-    "@backstage/catalog-model": "0.0.0-nightly-20220919030347",
-    "@backstage/config": "0.0.0-nightly-20220919030347",
-    "@backstage/errors": "0.0.0-nightly-20220919030347",
-    "@backstage/plugin-auth-node": "0.0.0-nightly-20220919030347",
+    "@backstage/backend-common": "^0.15.1",
+    "@backstage/catalog-client": "^1.1.0",
+    "@backstage/catalog-model": "^1.1.1",
+    "@backstage/config": "^1.0.2",
+    "@backstage/errors": "^1.1.1",
+    "@backstage/plugin-auth-node": "^0.2.5",
     "@backstage/types": "^1.0.0",
     "@davidzemon/passport-okta-oauth": "^0.0.5",
     "@google-cloud/firestore": "^6.0.0",
@@ -76,8 +76,8 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "0.0.0-nightly-20220919030347",
-    "@backstage/cli": "0.0.0-nightly-20220919030347",
+    "@backstage/backend-test-utils": "0.0.0-nightly-20220921030342",
+    "@backstage/cli": "0.0.0-nightly-20220921030342",
     "@types/body-parser": "^1.19.0",
     "@types/cookie-parser": "^1.4.2",
     "@types/express-session": "^1.17.2",