@webiny/app-security NPM

@webiny/app-security

Exposes a simple SecurityProvider React provider component and enables you to quickly retrieve the currently signed-in user via the useSecurity React hook.

Install

npm install --save @webiny/app-security

Or if you prefer yarn:

yarn add @webiny/app-security

Quick Example

First, make sure you mount the SecurityProvider React provider component in your application's entrypoint component, for example the App component:

import React from "react";
import { Routes } from "@webiny/app/components/Routes";
import { BrowserRouter } from "@webiny/react-router";
import { SecurityProvider } from "@webiny/app-security";
import Authenticator from "./components/Authenticator";

export const App = () => (
    <>
        {/*
        <SecurityProvider> is a generic provider of identity information. 3rd party identity providers (like Cognito,
        Okta, Auth0) will handle the authentication, and set the information about the user into this provider,
        so other parts of the system have a centralized place to fetch user information from.
    */}
        <SecurityProvider>
            {/* This is the component that might trigger the initial authentication
        process and set the retrieved user data into the Security provider.*/}
            <Authenticator>
                <BrowserRouter basename={process.env.PUBLIC_URL}>
                    <Routes />
                </BrowserRouter>
            </Authenticator>
        </SecurityProvider>
    </>
);

A simple Authenticator React component (uses Amazon Cognito and AWS Amplify's Auth class):

import React, { useEffect } from "react";
import { Auth } from "@aws-amplify/auth";
import { useSecurity, SecurityIdentity } from "@webiny/app-security";

// Apart from the React component, we also configure the Auth class here.
Auth.configure({
    region: process.env.REACT_APP_USER_POOL_REGION,
    userPoolId: process.env.REACT_APP_USER_POOL_ID,
    userPoolWebClientId: process.env.REACT_APP_USER_POOL_WEB_CLIENT_ID,
    oauth: {
        domain: process.env.REACT_APP_USER_POOL_DOMAIN,
        redirectSignIn: `${location.origin}?signIn`,
        redirectSignOut: `${location.origin}?signOut`,
        responseType: "token"
    }
});

interface AuthenticatorProps {
    children: React.ReactNode;
}
// The `Authenticator` component.
const Authenticator = (props: AuthenticatorProps) => {
    const { setIdentity } = useSecurity();

    useEffect(() => {
        // Get the currently signed-in user.
        Auth.currentSession().then(response => {
            const user = response.getIdToken().payload;
            setIdentity(
                new SecurityIdentity({
                    login: user.email,
                    firstName: user.given_name,
                    lastName: user.family_name,
                    logout: () => {
                        Auth.signOut();
                        setIdentity(null);
                    }
                })
            );
        }).catch(() => { /* Do nothing. */ });
    }, []);

    return <>{props.children}</>;
};

export default Authenticator;

Finally, use the useSecurity React hook in any of your components:

import React from "react";
import { useSecurity } from "@webiny/app-security";

const MyComponent = () => {
  const { identity } = useSecurity();

  if (identity) {
    return <>Logged in.</>;
  }

  return <>Not logged in.</>;
};

export default MyComponent;

@webiny/app @webiny/plugins minimatch react react-dom

@infinitebrahmanuniverse/nolb-_webi @everything-registry/sub-chunk-1008 @webiny/app-admin-auth0 @webiny/app-admin-okta @webiny/app-aco @webiny/app-admin @webiny/app-admin-cognito @webiny/app-page-builder @webiny/app-plugin-security-cognito @webiny/app-plugin-security-cognito-theme @webiny/app-security-access-management @webiny/app-security-admin-users @webiny/app-security-cognito-authentication @webiny/app-serverless-cms @webiny/app-template-admin @webiny/app-tenant-manager @webiny/app-headless-cms @webiny/app-headless-cms-common @webiny/app-i18n-content @webiny/app-mailchimp @webiny/app-mailer @webiny/app-form-builder @webiny/app-forms @webiny/app-google-tag-manager @webiny/app-graphql-playground @webiny/app-admin-rmwc @webiny/app-admin-users-cognito @webiny/app-apw @webiny/app-audit-logs @webiny/app-cookie-policy @webiny/app-i18n @webiny/app-file-manager @webiny/app-security-tenancy

1 day ago

2 days ago

1 day ago

15 days ago

15 days ago

15 days ago

21 days ago

28 days ago

29 days ago

1 month ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

0.0.0-unstable.de38392959

4 months ago

5.38.5-beta.0

4 months ago

0.0.0-unstable.a9593f74dd

4 months ago

5.38.5

4 months ago

5.38.4

4 months ago

5.38.4-beta.0

4 months ago

0.0.0-unstable.2696f9d9e8

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

7 months ago

7 months ago

0.0.0-unstable.99666aeb00

10 months ago

6 months ago

6 months ago

8 months ago

7 months ago

8 months ago

7 months ago

8 months ago

0.0.0-unstable.8feaff8c32

10 months ago

0.0.0-unstable.085ff6572f

11 months ago

8 months ago

9 months ago

9 months ago

6 months ago

9 months ago

9 months ago

7 months ago

7 months ago

0.0.0-unstable.c7dec08bb0

10 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

0.0.0-unstable.acacc54f0e

10 months ago

6 months ago

9 months ago

9 months ago

9 months ago

9 months ago

8 months ago

8 months ago

10 months ago

10 months ago

10 months ago

7 months ago

7 months ago

7 months ago

7 months ago

8 months ago

8 months ago

9 months ago

9 months ago

0.0.0-unstable.98511f29f1

10 months ago

10 months ago

6 months ago

6 months ago

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-unstable.60a863e033

1 year ago

0.0.0-unstable.df6d94b531

1 year ago

5.33.2-beta.0

1 year ago

5.33.2-beta.2

1 year ago

0.0.0-unstable.97a151f74d

1 year ago

5.31.0

2 years ago

0.0.0-unstable.b02d94bba0

1 year ago

0.0.0-unstable.ad3a7a4920

1 year ago

0.0.0-unstable.615a930a68

1 year ago

11 months ago

11 months ago

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-unstable.1145e7667f

1 year ago

2 years ago

1 year ago

11 months ago

12 months ago

1 year ago

1 year ago

2 years ago

1 year ago

1 year ago

1 year ago

2 years ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.0.0-unstable.d4f203fa97

1 year ago

5.34.6

1 year ago

0.0.0-unstable.1e66d121db

2 years ago

2 years ago

1 year ago

1 year ago

2 years ago

1 year ago

2 years ago

12 months ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

0.0.0-unstable.d13302545b

12 months ago

0.0.0-unstable.d16f688daf

1 year ago

0.0.0-unstable.60e968001a

1 year ago

0.0.0-unstable.5e7233243f

2 years ago

0.0.0-unstable.e3f4727c56

1 year ago

0.0.0-unstable.611c5af35e

1 year ago

0.0.0-unstable.496cf268ac

1 year ago

5.30.0-beta.0

2 years ago

0.0.0-unstable.78f581c1d2

1 year ago

5.30.0-beta.1

2 years ago

5.35.4-beta.0

11 months ago

5.35.4-beta.1

11 months ago

0.0.0-unstable.2af142b57e

1 year ago

0.0.0-unstable.b14eaecf38

1 year ago

5.27.0-beta.0

2 years ago

0.0.0-unstable.c59b9cc5b9

12 months ago

0.0.0-unstable.7f63ea0744

1 year ago

5.34.5-beta.0

1 year ago

5.34.5-beta.1

1 year ago

0.0.0-unstable.8c4d9f045a

2 years ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-unstable.9e825fd5fb

1 year ago

5.25.0-beta.1

2 years ago

5.25.0-beta.0

2 years ago

0.0.0-unstable.3386f66516

1 year ago

5.33.4-beta.0

1 year ago

0.0.0-unstable.40876133bb

1 year ago

5.28.0

2 years ago

0.0.0-unstable.8acc9e8892

1 year ago

5.28.0-beta.0

2 years ago

0.0.0-unstable.c2780f51fe

1 year ago

5.33.5-beta.0

1 year ago

0.0.0-unstable.aa00eecd97

12 months ago

0.0.0-unstable.d7f521b032

1 year ago

5.29.0

2 years ago

0.0.0-unstable.d65ec29d44

1 year ago

0.0.0-unstable.aad28a72ae

1 year ago

0.0.0-ee-vpcs.549378cf03

1 year ago

2 years ago

2 years ago

1 year ago

1 year ago

1 year ago

0.0.0-unstable.fcdad0bc61

1 year ago

5.34.8-beta.0

1 year ago

0.0.0-unstable.ecd8734205

1 year ago

5.34.8-beta.1

1 year ago

5.35.1-beta.0

12 months ago

0.0.0-unstable.bca7b3e350

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.0.0-unstable.b6408e0dea

1 year ago

5.35.3

12 months ago

5.35.4

11 months ago

0.0.0-unstable.da99e0b846

1 year ago

0.0.0-unstable.13771d80a8

1 year ago

2 years ago

2 years ago

12 months ago

12 months ago

1 year ago

0.0.0-unstable.990c3ab1b6

1 year ago

0.0.0-unstable.606fc9c866

1 year ago

2 years ago

11 months ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

11 months ago

2 years ago

0.0.0-unstable.6e5425ee89

1 year ago

5.36.1-beta.0

12 months ago

5.36.1-beta.1

12 months ago

0.0.0-unstable.6509387258

1 year ago

0.0.0-unstable.cc58a6566b

1 year ago

1 year ago

1 year ago

1 year ago

12 months ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago