@nait-aits/azure-ad-auth v0.0.16

azure-ad-auth

This package helps with the setup of react applications using Azure AD authentication.

This currently does not support B2C, but that will be coming.

Installation

npm install @nait-aits/azure-ad-auth

Requirements

• @azure/msal-browser
• @azure/msal-react

Hooks and Providers

• NaitAzureADAuthProvider
• useGetToken

Setup

NaitAzureADAuthProvider

You will need to wrap your application (or specific components) in a NaitAzureADAuthProvider. This will apply the configuration across all children.

You will need to provide a clientId and tenantId at a minimum.

App.ts (or app entry point)

import { NaitAzureADAuthProvider } from "@nait-aits/azure-ad-auth";

function App() {
  return (
    <NaitAzureADAuthProvider
      config={{
        clientId: "GUID",
        tenantId: "GUID",
      }}
    >
      <Control />
    </NaitAzureADAuthProvider>
  );
}

Azure B2C

If you are using Azure B2C, there are a few differences.

1. Do not include the tenant id
2. Specify signinAuthority

• will be something like "https://xxx.b2clogin.com/xxx.onmicrosoft.com/signinsignup"

3. Specify the knownAuthorities

• Will be something like "xxx.b2clogin.com"

App.ts (or app entry point)

import { NaitAzureADAuthProvider } from "@nait-aits/azure-ad-auth";

function App() {
  return (
    <NaitAzureADAuthProvider
      config={{
        clientId: "GUID",
        signinAuthority: "https://xxx.b2clogin.com/xxx.onmicrosoft.com/signinsignup",
        knownAuthorities: ["xxx.b2clogin.com"],
        defaultScopes: ["https://xxx.onmicrosoft.com/clientId/tasks.read"],
        redirectUri: "http://localhost:3000",
      }}
    >
      <Control />
    </NaitAzureADAuthProvider>
  );
}

Usage

You should now be at a point where everything works. Now what about logging in/out? What is the username? Are they even logged in?

To do this, you just use the azure msal items.

Here is a very simple example page.

import { useIsAuthenticated, useMsal } from "@azure/msal-react";

function SamplePage() {
  var { instance, accounts } = useMsal();
  var isAuthenticated = useIsAuthenticated();

  return (
    <div>
      {isAuthenticated && <div>Hello {accounts[0]?.name}</div>}
      {!isAuthenticated && <div>Please log in.</div>}
      <button
        onClick={() => {
          isAuthenticated && instance.logout();
          !isAuthenticated && instance.loginPopup();
        }}
      >
        Log {isAuthenticated ? "Out" : "In"}
      </button>
    </div>
  );
}

export default SamplePage;

NaitAzureADAuthProvider config (optional)

If you have any overrides, you can specify the configuration here as well

Only need to specify the items you are overriding/need.

For example:

<NaitAzureADAuthProvider
  config={{
    redirectUri: `${window.location.origin}/login-complete`,
  }}
>
  <Control />
</NaitAzureADAuthProvider>

useGetToken

If you ever need to get the token for a user, you can use the useGetToken hook. This will return a token, and perform any token refresh if needed.

import { useGetToken } from "@azure/msal-react";

...

const tokenRetreiver = useGetToken();

var tokenResult = useGetToken();

if( tokenResult)

Debug

If you are having issues, you can enable the debug panel by setting the debug value to true. This will output a div that contains the values that the provider is using.

All Config values

{
    clientId?: string;
    tenantId?: string;
    redirectUri?: string;
    maxLogLevel?: 0 | 1 | 2 | 3 | 4;
    defaultScopes?: string[];
    debug?:boolean;
    //from @azure/msal-browser
    cacheOptions?: CacheOptions;

    //B2C Values
    signinAuthority?:string;
    knownAuthorities?: string[];
}

Integration with @nait-aits/fetch-state or @nait-aits/signalr

if you are using the package @nait-aits/fetch-state or @nait-aits/signalr, you can easily tap into the useGetToken hook and all auth is take care of for you.

import "./App.css";
import TestAuth from "./TestAuth";
import { NaitAzureADAuthProvider, useGetToken } from "@nait-aits/azure-ad-auth";

import { StateLoaderConfigurationProvider } from "@nait-aits/fetch-state";

function App() {
  return (
    <NaitAzureADAuthProvider>
      <StateLoaderConfigurationProvider
        options={{
          getAuthToken: useGetToken,
        }}
      >
        <TestAuth />
      </StateLoaderConfigurationProvider>
    </NaitAzureADAuthProvider>
  );
}

export default App;