@oslokommune/auth-bff 2.0.0-beta5 → 2.0.0

package/README.md

@@ -4,14 +4,14 @@ A NodeJS Backend for frontend.
 
 Features:
 
+* Serves a static web app
+* Proxies API calls, with the user's access token
 * Two "modes" of operation
     * A vite plugin for use during development
     * A standalone mode for use in production (e.g. inside a docker container)
 * Supports generic OIDC auth code flow clients
 * Has special support for `okdata`-generated Idporten clients
 * Handles login/logout and sessions (using DynamoDb as a store)
-* Proxies API calls
-* Serves a static web app
 * Includes simple React components for handling login-state
 
 See https://github.com/oslokommune/auth-bff-example for an example React app using this package.
@@ -81,7 +81,7 @@ WORKDIR /application
 EXPOSE 8080
 COPY --from=react-build /home/react/dist /application/dist
 ENV NODE_ENV=production
-RUN npm install -g @oslokommune/auth-bff@2.0.0-beta4
+RUN npm install -g @oslokommune/auth-bff@2.0.0
 COPY bff.config.json /application/
 CMD ["auth-bff"]
 ```
@@ -161,7 +161,8 @@ AWS Parameter store:
 This loads from the configured AWS environment. For this to work on your local machine the `AWS_PROFILE` environment
 variable must be set, and you must be signed in to that profile
 
-ℹ️ [See `config.ts` for a description of all config parameters](src/config.ts)
+> [!NOTE]  
+>️ See [`config.ts`](src/config.ts) for a description of all config parameters
 
 ## Using with ID-porten (via `okdata`):
 
@@ -211,6 +212,25 @@ running locally.
 
 3. Done!
 
+
+## Using with Entra ID: 
+When using the package with Entra ID, you need to get credentials from Azure. You need to collect following credentials in order to be able to use this package:
+
+* issuer
+* client id
+* client secret
+
+With Entra ID you need to make sure to remove `"okDataIdPortenKeyName"`from the configuration file and replace it with client secret.
+
+```json
+{
+  "issuer": "https://login.microsoftonline.com/{TENANT_ID}/v2.0",
+  "clientId": "1111111q-2bab-3333-c444-5555e556cb55",
+  "clientSecret": "7dW3Q~_sdfj3-4f5g-6789-h0i1-2j3k4l5m6n7",
+  ...
+}
+```
+
 ## Configuring session storage
 
 Currently only dynamoDb is supported for storing sessions in production. It requires some setup.
@@ -221,7 +241,7 @@ sessions during front-channel logout)
 > If the table does not exist, it will be automatically created with settings not appropriate for production.
 
 
-Here is an example configuration in terraform. If you are using (https://km.oslo.systems/)[Golden Path],
+Here is an example configuration in terraform. If you are using [Golden Path](https://km.oslo.systems/),
 you can simply copy this to a file in your application stack, and run `terraform apply`
 
 ```terraform
@@ -352,6 +372,6 @@ if (authState === 'authenticated') {
 ## Content Security Policy
 
 To configure the content security policy returned by the server, use the `contentSecurityPolicy` config option. This
-configuration is passed almost as-is to (helmet)[https://github.com/helmetjs/helmet]. Since our configuration is json
+configuration is passed almost as-is to [helmet](https://github.com/helmetjs/helmet). Since our configuration is json
 only, not all features are supported. To set a nonce, use the special form `"{nonce}"` instead. It will be replaced by a
 generated nonce for each request.

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@oslokommune/auth-bff",
-    "version": "2.0.0-beta5",
+    "version": "2.0.0",
     "repository": "https://github.com/oslokommune/auth-bff.git",
     "publishConfig": {
         "access": "public"
@@ -37,11 +37,11 @@
         "react": "17.0.2",
         "supertest": "^7.2.2",
         "typescript": "^5.9.3",
-        "vitest": "^4.0.18"
+        "vitest": "^4.1.2"
     },
     "dependencies": {
-        "@aws-sdk/client-dynamodb": "^3.990.0",
-        "@aws-sdk/client-ssm": "^3.990.0",
+        "@aws-sdk/client-dynamodb": "^3.1018.0",
+        "@aws-sdk/client-ssm": "^3.1018.0",
         "command-line-args": "^6.0.1",
         "compression": "^1.8.1",
         "connect-dynamodb": "^3.0.5",
@@ -51,7 +51,7 @@
         "helmet": "^8.1.0",
         "http-proxy-middleware": "^3.0.5",
         "jose": "^6.1.3",
-        "node-forge": "1.3.3",
+        "node-forge": "1.4.0",
         "openid-client": "^6.8.2",
         "string-replace-middleware": "^1.1.0"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oslokommune/auth-bff",
-  "version": "2.0.0-beta5",
+  "version": "2.0.0",
   "repository": "https://github.com/oslokommune/auth-bff.git",
   "publishConfig": {
     "access": "public"
@@ -37,11 +37,11 @@
     "react": "17.0.2",
     "supertest": "^7.2.2",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.18"
+    "vitest": "^4.1.2"
   },
   "dependencies": {
-    "@aws-sdk/client-dynamodb": "^3.990.0",
-    "@aws-sdk/client-ssm": "^3.990.0",
+    "@aws-sdk/client-dynamodb": "^3.1018.0",
+    "@aws-sdk/client-ssm": "^3.1018.0",
     "command-line-args": "^6.0.1",
     "compression": "^1.8.1",
     "connect-dynamodb": "^3.0.5",
@@ -51,7 +51,7 @@
     "helmet": "^8.1.0",
     "http-proxy-middleware": "^3.0.5",
     "jose": "^6.1.3",
-    "node-forge": "1.3.3",
+    "node-forge": "1.4.0",
     "openid-client": "^6.8.2",
     "string-replace-middleware": "^1.1.0"
   }