revise readmes

Author: derisen

.github/PULL_REQUEST_TEMPLATE.md

@@ -40,14 +40,6 @@ What kind of change does this Pull Request introduce?
     npm install
 ```
 
-* Test the code
-
-<!-- Add steps to run the tests suite and/or manually test -->
-
-```console
-
-```
-
 ## What to check
 
 ex: verify that the following are valid:

1-Authentication/1-sign-in/App/app.js

@@ -2,28 +2,38 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License.
  */
+
 const express = require('express');
 const session = require('express-session');
-const bodyParser = require('body-parser');
 const path = require('path');
 
 const router = require('./routes/router');
-
 const SERVER_PORT = process.env.PORT || 4000;
 
-const app = express();
+// initialize express
+const app = express(); 
 
 app.set('views', path.join(__dirname, './views'));
 app.set('view engine', 'ejs');
 
 app.use('/css', express.static(path.join(__dirname, 'node_modules/bootstrap/dist/css')));
 app.use('/js', express.static(path.join(__dirname, 'node_modules/bootstrap/dist/js')));
 
-app.use(bodyParser.urlencoded({extended: false}));
+app.use(express.urlencoded({ extended: false }));
 
 app.use(express.static(path.join(__dirname, './public')));
 
-app.use(session({secret: 'your-secret', resave: false, saveUninitialized: false}));
+app.use(express.json());
+
+/**
+ * Using express-session middleware. Be sure to familiarize yourself with available options
+ * and set as desired. Visit: https://www.npmjs.com/package/express-session
+ */
+app.use(session({ 
+    secret: 'ENTER_YOUR_SECRET_HERE', 
+    resave: false, 
+    saveUninitialized: false 
+}));
 
 app.use(router);
 

1-Authentication/1-sign-in/App/controllers/mainController.js

@@ -4,7 +4,6 @@ exports.getHomePage = (req, res, next) => {
 }
 
 exports.getIdPage = (req, res, next) => {
-    console.log(req.session.account);
     const isAuthenticated = req.session.isAuthenticated;
 
     const claims = {

1-Authentication/2-sign-in-b2c/cache.json …entication/1-sign-in/App/data/cache.json1-Authentication/2-sign-in-b2c/cache.json renamed to 1-Authentication/1-sign-in/App/data/cache.json 1-Authentication/2-sign-in-b2c/cache.json renamed to 1-Authentication/1-sign-in/App/data/cache.json

@@ -2,7 +2,7 @@ const express = require('express');
 
 const mainController = require('../controllers/mainController');
 
-const config = require('../../auth.json');
+const config = require('../../appSettings.json');
 const cache = require('../utils/cachePlugin');
 const msalWrapper = require('msal-express-wrapper');
 
@@ -16,12 +16,12 @@ const router = express.Router();
 router.get('/', (req, res, next) => res.redirect('/home'));
 router.get('/home', mainController.getHomePage);
 
-// // authentication routes
+// authentication routes
 router.get('/signin', authProvider.signIn);
 router.get('/signout', authProvider.signOut);
 router.get('/redirect', authProvider.handleRedirect);
 
-// authenticated routes
+// secure routes
 router.get('/id', authProvider.isAuthenticated, mainController.getIdPage);
 
 // 404

1-Authentication/1-sign-in/App/routes/router.js

@@ -1,5 +1,10 @@
 const fs = require("fs");
-const cachePath = './cache.json' // replace this string with the path to your valid cache file.
+const cachePath = './App/data/cache.json' // replace this string with the path to your valid cache file.
+
+/**
+ * This implements ICachePlugin for persistent caching. For more information, visit: 
+ * https://azuread.github.io/microsoft-authentication-library-for-js/ref/interfaces/_azure_msal_common.icacheplugin.html
+ */
 
 const beforeCacheAccess = async (cacheContext) => {
     return new Promise(async (resolve, reject) => {
@@ -13,7 +18,7 @@ const beforeCacheAccess = async (cacheContext) => {
                 }
             });
         } else {
-        fs.writeFile(cachePath, cacheContext.tokenCache.serialize(), (err) => {
+            fs.writeFile(cachePath, cacheContext.tokenCache.serialize(), (err) => {
                 if (err) {
                     reject();
                 }
@@ -23,7 +28,7 @@ const beforeCacheAccess = async (cacheContext) => {
 };
 
 const afterCacheAccess = async (cacheContext) => {
-    if(cacheContext.cacheHasChanged){
+    if (cacheContext.cacheHasChanged) {
         await fs.writeFile(cachePath, cacheContext.tokenCache.serialize(), (err) => {
             if (err) {
                 console.log(err);

1-Authentication/1-sign-in/App/utils/cachePlugin.js

@@ -1,45 +1,37 @@
-# Registering the sample apps with the Microsoft identity platform and updating the configuration files using PowerShell
+# Registering sample apps with the Microsoft identity platform and updating the configuration files using PowerShell
 
 ## Overview
 
 ### Quick summary
 
-1. On Windows run PowerShell as **Administrator** and navigate to the root of the cloned directory
+1. On Windows, run PowerShell as **Administrator** and navigate to the root of the cloned directory
 1. In PowerShell run:
 
    ```PowerShell
    Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process -Force
    ```
 
-1. Run the script to create your Azure AD application and configure the code of the sample application accordingly. (Other ways of running the scripts are described below)
+1. Run the script to create your Azure AD application and configure the code of the sample application accordingly.
 
    ```PowerShell
    cd .\AppCreationScripts\
    .\Configure.ps1
    ```
 
-1. Open the Visual Studio solution and click start
-
 ### More details
 
-The following paragraphs:
-
-- [Registering the sample apps with the Microsoft identity platform and updating the configuration files using PowerShell](#Registering-the-sample-apps-with-the-Microsoft-identity-platform-and-updating-the-configuration-files-using-PowerShell)
-  - [Overview](#Overview)
-    - [Quick summary](#Quick-summary)
-    - [More details](#More-details)
-  - [Goal of the provided scripts](#Goal-of-the-provided-scripts)
-    - [Presentation of the scripts](#Presentation-of-the-scripts)
-    - [Usage pattern for tests and DevOps scenarios](#Usage-pattern-for-tests-and-DevOps-scenarios)
-  - [How to use the app creation scripts?](#How-to-use-the-app-creation-scripts)
-    - [Pre-requisites](#Pre-requisites)
-    - [Run the script and start running](#Run-the-script-and-start-running)
-    - [Four ways to run the script](#Four-ways-to-run-the-script)
-      - [Option 1 (interactive)](#Option-1-interactive)
-      - [Option 2 (non-interactive)](#Option-2-non-interactive)
-      - [Option 3 (Interactive, but create apps in a specified tenant)](#Option-3-Interactive-but-create-apps-in-a-specified-tenant)
-      - [Option 4 (non-interactive, and create apps in a specified tenant)](#Option-4-non-interactive-and-create-apps-in-a-specified-tenant)
-    - [Running the script on Azure Sovereign clouds](#Running-the-script-on-Azure-Sovereign-clouds)
+- [Goal of the provided scripts](#goal-of-the-provided-scripts)
+  - [Presentation of the scripts](#presentation-of-the-scripts)
+  - [Usage pattern for tests and DevOps scenarios](#usage-pattern-for-tests-and-DevOps-scenarios)
+- [How to use the app creation scripts?](#how-to-use-the-app-creation-scripts)
+  - [Pre-requisites](#pre-requisites)
+  - [Run the script and start running](#run-the-script-and-start-running)
+  - [Four ways to run the script](#four-ways-to-run-the-script)
+    - [Option 1 (interactive)](#option-1-interactive)
+    - [Option 2 (non-interactive)](#option-2-non-interactive)
+    - [Option 3 (Interactive, but create apps in a specified tenant)](#option-3-Interactive-but-create-apps-in-a-specified-tenant)
+    - [Option 4 (non-interactive, and create apps in a specified tenant)](#option-4-non-interactive-and-create-apps-in-a-specified-tenant)
+  - [Running the script on Azure Sovereign clouds](#running-the-script-on-Azure-Sovereign-clouds)
 
 ## Goal of the provided scripts
 
@@ -51,13 +43,13 @@ These scripts are:
 
 - `Configure.ps1` which:
   - creates Azure AD applications and their related objects (permissions, dependencies, secrets),
-  - changes the configuration files in the C# and JavaScript projects.
+  - changes the configuration files in the sample projects.
   - creates a summary file named `createdApps.html` in the folder from which you ran the script, and containing, for each Azure AD application it created:
     - the identifier of the application
     - the AppId of the application
     - the url of its registration in the [Azure portal](https://portal.azure.com).
 
-- `Cleanup.ps1` which cleans-up the Azure AD objects created by `Configure.ps1`. Note that this script does not revert the changes done in the configuration files, though. You will need to undo the change from source control (from Visual Studio, or from the command line using, for instance, git reset).
+- `Cleanup.ps1` which cleans-up the Azure AD objects created by `Configure.ps1`. Note that this script does not revert the changes done in the configuration files, though. You will need to undo the change from source control (from Visual Studio, or from the command line using, for instance, `git reset`).
 
 ### Usage pattern for tests and DevOps scenarios
 
@@ -81,15 +73,15 @@ The scripts install the required PowerShell module (AzureAD) for the current use
 
 1. If you have never done it already, in the PowerShell window, install the AzureAD PowerShell modules. For this:
 
-   1. Open PowerShell as admin (On Windows, Search Powershell in the search bar, right click on it and select Run as administrator).
+   1. Open PowerShell as admin (On Windows, Search Powershell in the search bar, right click on it and select **Run as administrator**).
    2. Type:
- 
+
       ```PowerShell
       Install-Module AzureAD
       ```
 
       or if you cannot be administrator on your machine, run:
- 
+
       ```PowerShell
       Install-Module AzureAD -Scope CurrentUser
       ```
@@ -106,22 +98,22 @@ The scripts install the required PowerShell module (AzureAD) for the current use
 1. Open the Visual Studio solution, and in the solution's context menu, choose **Set Startup Projects**.
 1. select **Start** for the projects
 
-You're done. this just works!
+You're done!
 
 ### Four ways to run the script
 
 We advise four ways of running the script:
 
 - Interactive: you will be prompted for credentials, and the scripts decide in which tenant to create the objects,
 - non-interactive: you will provide credentials, and the scripts decide in which tenant to create the objects,
-- Interactive in specific tenant:  you will provide the tenant in which you want to create the objects and then you will be prompted for credentials, and the scripts will create the objects,
-- non-interactive in specific tenant: you will provide tenant in which you want to create the objects and credentials, and the scripts will create the objects.
+- Interactive in specific tenant: you will provide the tenant in which you want to create the objects and then you will be prompted for credentials, and the scripts will create the objects,
+- non-interactive in specific tenant: you will provide the tenant in which you want to create the objects and credentials, and the scripts will create the objects.
 
 Here are the details on how to do this.
 
 #### Option 1 (interactive)
 
-- Just run ``. .\Configure.ps1``, and you will be prompted to sign-in (email address, password, and if needed MFA).
+- Just run ``.\Configure.ps1``, and you will be prompted to sign-in (email address, password, and if needed MFA).
 - The script will be run as the signed-in user and will use the tenant in which the user is defined.
 
 Note that the script will choose the tenant in which to create the applications, based on the user. Also to run the `Cleanup.ps1` script, you will need to re-sign-in.
@@ -137,13 +129,13 @@ $mycreds = New-Object System.Management.Automation.PSCredential ("[login@tenantN
 . .\Configure.ps1 -Credential $mycreds
 ```
 
-Of course, in real life, you might already get the password as a `SecureString`. You might also want to get the password from KeyVault.
+Of course, in real life, you might already get the password as a `SecureString`. You might also want to get the password from **Azure Key Vault**.
 
 #### Option 3 (Interactive, but create apps in a specified tenant)
 
   if you want to create the apps in a particular tenant, you can use the following option:
 
-- open the [Azure portal](https://portal.azure.com)
+- Open the [Azure portal](https://portal.azure.com)
 - Select the Azure Active directory you are interested in (in the combo-box below your name on the top right of the browser window)
 - Find the "Active Directory" object in this tenant
 - Go to **Properties** and copy the content of the **Directory Id** property
@@ -169,7 +161,7 @@ $tenantId = "yourTenantIdGuid"
 
 ### Running the script on Azure Sovereign clouds
 
-All the four options listed above, can be used on any Azure Sovereign clouds. By default, the script targets `AzureCloud`, but it can be changed using the parameter `-AzureEnvironmentName`.
+All the four options listed above can be used on any Azure Sovereign clouds. By default, the script targets `AzureCloud`, but it can be changed using the parameter `-AzureEnvironmentName`.
 
 The acceptable values for this parameter are:
 

1-Authentication/1-sign-in/AppCreationScripts/AppCreationScripts.md

@@ -11,7 +11,7 @@ param(
 
 
 if ($null -eq (Get-Module -ListAvailable -Name "AzureAD")) { 
-    Install-Module "AzureAD" -Scope CurrentUser 
+    Install-Module "AzureAD" -Scope CurrentUser                                            
 } 
 Import-Module AzureAD
 $ErrorActionPreference = "Stop"
@@ -59,9 +59,16 @@ Function Cleanup
     # Removes the applications
     Write-Host "Cleaning-up applications from tenant '$tenantName'"
 
-    Write-Host "Removing 'webApp' (ExpressWebApp-c1s1) if needed"
-    Get-AzureADApplication -Filter "DisplayName eq 'ExpressWebApp-c1s1'"  | ForEach-Object {Remove-AzureADApplication -ObjectId $_.ObjectId }
-    $apps = Get-AzureADApplication -Filter "DisplayName eq 'ExpressWebApp-c1s1'"
+    Write-Host "Removing 'client' (msal-node-webapp) if needed"
+    try
+    {
+        Get-AzureADApplication -Filter "DisplayName eq 'msal-node-webapp'"  | ForEach-Object {Remove-AzureADApplication -ObjectId $_.ObjectId }
+    }
+    catch
+    {
+	    Write-Host "Unable to remove the 'msal-node-webapp' . Try deleting manually." -ForegroundColor White -BackgroundColor Red
+    }
+    $apps = Get-AzureADApplication -Filter "DisplayName eq 'msal-node-webapp'"
     if ($apps)
     {
         Remove-AzureADApplication -ObjectId $apps.ObjectId
@@ -70,11 +77,18 @@ Function Cleanup
     foreach ($app in $apps) 
     {
         Remove-AzureADApplication -ObjectId $app.ObjectId
-        Write-Host "Removed ExpressWebApp-c1s1.."
+        Write-Host "Removed msal-node-webapp.."
     }
     # also remove service principals of this app
-    Get-AzureADServicePrincipal -filter "DisplayName eq 'ExpressWebApp-c1s1'" | ForEach-Object {Remove-AzureADServicePrincipal -ObjectId $_.Id -Confirm:$false}
-    
+    try
+    {
+        Get-AzureADServicePrincipal -filter "DisplayName eq 'msal-node-webapp'" | ForEach-Object {Remove-AzureADServicePrincipal -ObjectId $_.Id -Confirm:$false}
+    }
+    catch
+    {
+	    Write-Host "Unable to remove ServicePrincipal 'msal-node-webapp' . Try deleting manually from Enterprise applications." -ForegroundColor White -BackgroundColor Red
+    }
 }
 
-Cleanup -Credential $Credential -tenantId $TenantId
+Cleanup -Credential $Credential -tenantId $TenantId
+