@pandolink/utils

README

USE OIDC

useIDC is a client side SDK that establishes commnication between Open ID Connect Identity Server. This library is designed for Web Apps and Node.js applications. useOIDC adheres to PCKE extension to OAuth which facilitates secure authorization code in public clients.

Import useOIDC to an existing project

yarn add @cafegene/utils

or

npm install @cafegene/utils

    // Add the following env to existing react project
    // It should have a REACT_APP_ prefix
    REACT_APP_LOGIN_URI = 'https://login.staging.yourcompany.com',
    REACT_APP_REDIRECT_URI = 'https://yourcompany.com/sample',
    REACT_APP_SCOPE = 'xyz',
    REACT_APP_CLIENT_SECRET = '123xyz',
    REACT_APP_CLIENT_ID = '1234',

// Top Level Component
import { useOIDC } from '@cafegene/utils';

const App: React.FC = () => {
    const [user] = useOIDC()
    return (
        <Route to='/admin'>
            {
                user.isAuthenticated && </Admin>
            }
        </Route>
    );

}

useOIDC performs authorization, authentication and request an access token for your react application.

1: AUTHORIZATION

It will first check if you have an access token. If access token does not exist then it will start the Open Id Connection flow.

2: REDIRECT

Your application will be redirected to the url you provided in the REACT_APP_LOGIN_URI env. If login credentials is correct then you'll be authorize in a code will be return in the url.

3: GET ACCESS TOKEN

To request for an access token, that code will then be taken by useOIDC and use it to authenticate you. If authenticated the Open ID Identity server will return an acceess token.

Use that access token to to request for data from the GRPC server.