TL;DR - View the Live Demo
You can see a complete working example here. The code for the demo is here.
Click this button to deploy the demo app to your own server:
--
- Supports isomorphic / universal / server-side rendering
- OAuth2 authentication components
- Email authentication components, including:
- Seamless integration with the devise token auth Rails gem.
- Includes the following themes:
- Material UI
- React Bootstrap
- A plain theme that you can style from scratch
- Support for multiple user types
- coming soon React Native support
- coming soon I18n support
- coming soon Can be configured to work with any API
This project comes bundled with a test app. You can run the demo locally by following these instructions, or you can use it here in production.
The demo uses React, and the source can be found here.
--
- About this plugin
- Installation
- Components
- Methods
- Configuration
- Using Multiple User Types
- API Expectations
- Contributing
- Development
- Callouts
This plugin relies on token based authentication. This requires coordination between the client and the server. Diagrams are included to illustrate this relationship.
This plugin was designed to work out of the box with the wonderful devise token auth gem, but it's flexible enough to be used in just about any environment.
About security: read here for more information on securing your token auth system. The devise token auth gem has adequate security measures in place, and this plugin was built to work seamlessly with that gem.
--
Only npm is currently supported.
npm install redux-auth --saveIf you want to use the Material UI or Bootstrap themes, you will need to install those libraries as well.
# install material ui
npm install material-ui --save
# or bootstrap
npm install react-bootstrap --saveMaterial UI uses inline styles so no further configuration is needed. But with the bootstrap theme, the CSS will also need to be included. Read more at the React Bootstrap project page.
You must also install and use a json loader
--
There are 3 Themes included in this module.
- Material UI
- Bootstrap
- A default theme
The default theme has no styling, and honestly it just looks really bad. But if you hate heavy UI frameworks and you like to style everything yourself, then you will love the default theme.
All components can make their own API requests, display errors, and display success messages out of the box.
The examples shown below use the Material UI theme.
--
A form used for email based registration.
endpoint: The key of the target provider service as represented in the endpoint configuration block.inputProps: An object containing the following attributes:email: An object that will override the email input component's default props.password: An object that will override the password input component's default props.passwordConfirmation: An object that will override the password confirmation input component's default props.submit: An object that will override the submit button component's default props.
// default theme
import { EmailSignUpForm } from "redux-auth/default-theme";
// material ui theme
import { EmailSignUpForm } from "redux-auth/material-ui-theme";
// bootstrap theme
import { EmailSignUpForm } from "redux-auth/bootstrap-theme";
// render
render: () {
return <EmailSignUpForm />;
}View EmailSignUpForm API Expectations
--
A form used to sign in using accounts that were registered by email.
endpoint: The key of the target provider service as represented in the endpoint configuration block.next: A method to call on successful sign-in.inputProps: An object containing the following attributes:email: An object that will override the email input component's default props.password: An object that will override the password input component's default props.submit: An object that will override the submit button component's default props.
// default theme
import { EmailSignInForm } from "redux-auth/default-theme";
// material ui theme
import { EmailSignInForm } from "redux-auth/material-ui-theme";
// bootstrap theme
import { EmailSignInForm } from "redux-auth/bootstrap-theme";
// render
render: () {
return <EmailSignInForm />;
}View EmailSignInForm API expectations
--
A button used to authenticate using an OAuth provider (facebook, github, etc.).
endpoint: The key of the target provider service as represented in the endpoint configuration block.provider: The name of the target provider service as represented in theauthProviderPathsendpoint configuration.next: A method to call on successful sign-in.
Any additional properties will be passed on the button component of the given theme.
// default theme
import { OAuthSignInButton } from "redux-auth/default-theme";
// material ui theme
import { OAuthSignInButton } from "redux-auth/material-ui-theme";
// bootstrap theme
import { OAuthSignInButton } from "redux-auth/bootstrap-theme";
// render
render: () {
// using the default label
return <OAuthSignInButton />;
// or using custom label text
return <OAuthSignInButton>Custom Label</OAuthSignInButton>;
}View OAuthSignInButton API expectations
--
A button used to end the current user's session.
endpoint: The key of the target provider service as represented in the endpoint configuration block. If this property isn't provided, the current signed in user will be signed out regardless of their user type.next: A method to call upon successful sign-out.
Any additional properties will be passed on the button component of the given theme.
// default theme
import { SignOutButton } from "redux-auth/default-theme";
// material ui theme
import { SignOutButton } from "redux-auth/material-ui-theme";
// bootstrap theme
import { SignOutButton } from "redux-auth/bootstrap-theme";
// render
render: () {
// using the default label
return <SignOutButton />;
// or using custom label text
return <SignOutButton>Custom Label</SignOutButton>;
}View SignOutButton API expectations
--
A button used to destroy the account of the current user. This will also end the destroyed user's session.
endpoint: The key of the target provider service as represented in the endpoint configuration block. If this property isn't provided, the current signed in user's account will be destroyed regardless of their user type.
Any additional properties will be passed on the button component of the given theme.
// default theme
import { DestroyAccountButton } from "redux-auth/default-theme";
// material ui theme
import { DestroyAccountButton } from "redux-auth/material-ui-theme";
// bootstrap theme
import { DestroyAccountButton } from "redux-auth/bootstrap-theme";
// render
render: () {
// using the default label
return <DestroyAccountButton />;
// or using custom label text
return <DestroyAccountButton>Custom Label</DestroyAccountButton>;
}View DestroyAccountButton API Expectations
--
A form used to send password reset emails to users that forgot their password. When users click the link included in the email, they will be redirected to the site that the request was made from. A modal will appear that contains a form allowing the user to create a new password.
endpoint: The key of the target provider service as represented in the endpoint configuration block.inputProps: An object containing the following attributes:email: An object that will override the email input component's default props.submit: An object that will override the submit button component's default props.
// default theme
import { RequestPasswordResetForm } from "redux-auth/default-theme";
// material ui theme
import { RequestPasswordResetForm } from "redux-auth/material-ui-theme";
// bootstrap theme
import { RequestPasswordResetForm } from "redux-auth/bootstrap-theme";
// render
render: () {
return <RequestPassswordResetForm />;
}View RequestPasswordResetForm API Expectations
--
A form that can be used to change the current user's password.
endpoint: The key of the target provider service as represented in the endpoint configuration block. If this value is not provided, the current user's password will be updated regardless of their user type.inputProps: An object containing the following attributes:password: An object that will override the password input component's default props.passwordConfirmation: An object that will override the password confirmation input component's default props.submit: An object that will override the submit button component's default props.
// default theme
import { UpdatePasswordForm } from "redux-auth/default-theme";
// material ui theme
import { UpdatePasswordForm } from "redux-auth/material-ui-theme";
// bootstrap theme
import { UpdatePasswordForm } from "redux-auth/bootstrap-theme";
// render
render: () {
return <UpdatePasswordForm />;
}View UpdatePasswordForm API Expectations
--
This component contains all of the modals used in authentication, and also the component that is used to pass credentials from the server to the client when using server side rendering.
This component MUST live at the top level of your application outside of your routes.
The following example shows the relevant router configuration. Note that this is not a complete example. See the demo app for a complete, working setup.
// default theme
import { AuthGlobals } from "redux-auth/default-theme";
// material ui theme
import { AuthGlobals } from "redux-auth/material-ui-theme";
// bootstrap theme
import { AuthGlobals } from "redux-auth/bootstrap-theme";
// your main app component. notice that AuthGlobals lives at the same level
// as the app's children.
class App extends React.Component {
render() {
return (
<div>
<AuthGlobals />
{this.props.children}
</div>
);
}
}
// example routes. the nested routes here will replace "this.props.children"
// in the example above
var routes = (
<Route path="/" component={App}>
<IndexRoute component={Main} />
<Route path="alt" component={Alt} />
<Route path="login" component={SignIn} />
<Route path="account" component={Account} onEnter={requireAuth} />
</Route>
);--
This must be run before your app is initialized. This should be run on both the server, and on the client. The server will need an additional argument containing information about the current request's cookies and location.
endpoints: An object containing information about your API. This at least needs to contain the full path to your URL as theapiUrlproperty. See here for a complete list of endpoint config options.settings: When rendering serverside, this will need to be an object that contains the following attributes:isServer: A boolean that must be set totruewhen rendering server-side.cookies: A string representation of the cookies from the current request. This will be parsed for any auth credentials.location: A string representation of the current request's URL.
Additionaly when rendering on client side some additional settings can be passed in settings object.
cleanSession: A boolean that tells if all locally stored credentials will be flushed.clientOnly: A boolean that tells if code is run only on client side. Should be settruewith only client-side usage.
--
import { configure } from "redux-auth";
// server-side usage
store.dispatch(configure(
{apiUrl: "https://api.graveflex.com"},
{isServer: true, cookies, currentLocation}
)).then(({redirectPath, blank} = {}) => {
// if `blank` is true, this is an OAuth redirect and should not
// be rendered
// use your server to render your app, or redirect
// to another location if the user is unauthorized.
// see the demo app for a more complete example.
});
// client-side usage
store.dispatch(configure(
{apiUrl: "https://api.graveflex.com"},
{serverSideRendering: true, cleanSession: true}
)).then(() => {
// your store should now have the current user. now render your
// app to the DOM. see the demo app for a more complete example.
});--
A wrapper around the whatwg fetch implementation that automatically sends and tracks authentication headers. See here for the complete spec.
Any requests to the API that rely on authentication will need to use the fetch function included in this library.
--
import { fetch } from "redux-auth";
// usage
fetch("http://api.mysite.com").then(resp => {
alert(`Api response: `${resp}`);
});--
This is the most difficult step, but only because configuring a redux app is inherently difficult.
The following example assumes that you are familiar with redux, and that you know how to create a store. Also keep in mind that this is a really basic example that does not even include routing. See the demo app for a more complete example.
This example assumes a directory structure that looks like this:
src/
app.js
client.js
server.js
// app.js
import React from "react";
import {Provider} from "react-redux";
import {configure, authStateReducer} from "redux-auth";
import {createStore, compose, applyMiddleware, combineReducers} from "redux";
import {AuthGlobals} from "redux-auth/default-theme";
class App extends React.Component {
render() {
return (
<div>
<AuthGlobals />
{this.props.children}
</div>
);
}
}
// create your main reducer
const reducer = combineReducers({
auth: authStateReducer,
// ... add your own reducers here
});
// create your app's store.
// note that thunk is required to use redux-auth
const store = compose(
applyMiddleware(thunk),
// ... add additional middleware here (router, etc.)
)(createStore)(reducer);
// a single function can be used for both client and server-side rendering.
// when run from the server, this function will need to know the cookies and
// url of the current request. also be sure to set `isServer` to true.
export function renderApp({cookies, isServer, currentLocation} = {}) {
// configure redux-auth BEFORE rendering the page
store.dispatch(configure(
// use the FULL PATH to your API
{apiUrl: "http://api.catfancy.com"},
{isServer, cookies, currentLocation}
)).then(({redirectPath, blank} = {}) => {
if (blank) {
// if `blank` is true, this is an OAuth redirect and should not
// be rendered
return <noscript />;
} else {
return (
<Provider store={store} key="provider">
<App />
</Provider>
);
}
});
}// server.js
import qs from "query-string";
import {renderToString} from "react-dom/server";
import { renderApp } from "./app";
// render the main app component into an html page
function getMarkup(appComponent) {
var markup = renderToString(appComponent)
return `<!doctype html>
<html>
<head>
<title>Redux Auth – Isomorphic Example</title>
</head>
<body>
<div id="react-root">${markup}</div>
<script src="/path/to/my/scripts.js"></script>
</body>
</html>`;
}
// this function will differ depending on the serverside framework that
// you decide to use (express, hapi, etc.). The following example uses hapi
server.ext("onPreResponse", (request, reply) => {
var query = qs.stringify(request.query);
var currentLocation = request.path + (query.length ? "?" + query : "");
var cookies = request.headers.cookies;
renderApp({
isServer: true,
cookies,
currentLocation
}).then(appComponent => {
reply(getMarkup(appComponent));
});
}// client.js
import React from "react";
import ReactDOM from "react-dom";
import { renderApp } from "./app";
const reactRoot = window.document.getElementById("react-root");
renderApp().then(appComponent => {
ReactDOM.render(appComponent, reactRoot);
});Note: be sure to include the AuthGlobals component at the top level of your application. This means outside of your Routes if you're using something like react-router.
See below for the complete list of configuration options.
This plugin allows for the use of multiple user authentication endpoint configurations. The following example assumes that the API supports two user classes, User and EvilUser. The following examples assume that User authentication routes are mounted at /auth, and the EvilUser authentication routes are mounted at evil_user_auth.
When using a single user type, you will pass a single object to the configure method as shown in the following example.
store.dispatch(configure({
apiUrl: 'https://devise-token-auth.dev'
}));When using multiple user types, you will instead pass an array of configurations, as shown in the following example.
store.dispatch(configure([
{
default: {
apiUrl: 'https://devise-token-auth.dev'
}
}, {
evilUser: {
apiUrl: 'https://devise-token-auth.dev',
signOutUrl: '/evil_user_auth/sign_out',
emailSignInPath: '/evil_user_auth/sign_in',
emailRegistrationPath: '/evil_user_auth',
accountUpdatePath: '/evil_user_auth',
accountDeletePath: '/evil_user_auth',
passwordResetPath: '/evil_user_auth/password',
passwordUpdatePath: '/evil_user_auth/password',
tokenValidationPath: '/evil_user_auth/validate_token',
authProviderPaths: {
github: '/evil_user_auth/github',
facebook: '/evil_user_auth/facebook',
google: '/evil_user_auth/google_oauth2'
}
}
}
], {
isServer,
cookies,
currentLocation
));All components accept an endpoint attribute that will determine which of the endpoint configurations the component should use. For forms that are used by non-authenticated users users (EmailSignInForm, OAuthSignInButton, etc.), the first configuration in the endpoint config will be used as the default if this value is not provided. For forms used by authenticated users (SignOutButton, UpdatePassword, etc.), the current user's endpoint will be used by default if this value is not provided.
The following example assumes a configuration where two endpoints have been defined, default and auth:
import { EmailSignInForm } from "redux-auth/default-theme";
// within render method
<EmailSignInForm endpoint="alt" />--
This is the complete list of options that can be passed to the endpoint config.
import { configure } from "redux-auth";
// ... configure store, routes, etc... //
store.dispatch(configure({
apiUrl: 'https://devise-token-auth.dev',
signOutPath: '/evil_user_auth/sign_out',
emailSignInPath: '/evil_user_auth/sign_in',
emailRegistrationPath: '/evil_user_auth',
accountUpdatePath: '/evil_user_auth',
accountDeletePath: '/evil_user_auth',
passwordResetPath: '/evil_user_auth/password',
passwordUpdatePath: '/evil_user_auth/password',
tokenValidationPath: '/evil_user_auth/validate_token',
authProviderPaths: {
github: '/evil_user_auth/github',
facebook: '/evil_user_auth/facebook',
google: '/evil_user_auth/google_oauth2'
}
}).then(// ... render your app ... //The base route to your api. Each of the following paths will be relative to this URL. Authentication headers will only be added to requests with this value as the base URL.
--
Path (relative to apiUrl) to validate authentication tokens. Read more.
--
Path (relative to apiUrl) to de-authenticate the current user. This will destroy the user's token both server-side and client-side.
--
An object containing paths to auth endpoints. Keys should be the names of the providers, and the values should be the auth paths relative to the apiUrl. Read more.
--
Path (relative to apiUrl) for submitting new email registrations. Read more.
--
Path (relative to apiUrl) for submitting account update requests.
--
Path (relative to apiUrl) for submitting account deletion requests.
--
Path (relative to apiUrl) for signing in to an existing email account.
--
Path (relative to apiUrl) for requesting password reset emails.
--
Path (relative to apiUrl) for submitting new passwords for authenticated users.
--
Follow these links to learn more about what the API expects from this library, and to see diagrams on how it all fits together. All of this stuff happens automatically when using this library with the devise token auth gem, but this information will be useful if you need to implement your own API.
- Signing In With Email
- Signing In With OAuth
- Validating Returning Users
- Managing Session Tokens
- Signing Out
- Registering With Email
- Requesting Password Resets
- Destroying Accounts
- Updating Passwords
- Create a feature branch with your changes.
- Write some test cases.
- Make all the tests pass.
- Issue a pull request.
I will grant you commit access if you send quality pull requests.
There is a test project in the demo directory of this app. To start a dev server, perform the following steps.
cdto the root of this project.cd dummynpm installnpm run watch
A hot-reloading dev server will start on localhost:8000. The test suite will be run as well.
If you just want to run the tests, follow these steps:
cdinto the root of this projectnpm installnpm test
This plugin was built against this API. You can use this, or feel free to use your own.
Thanks to the following contributors:
- @transedward for letting me use the name
redux-auth. - @bruz
Code and ideas were stolen from the following sources:
- this SO post on token-auth security
- this SO post on string templating
- this brilliant AngularJS module
WTFPL © Lynn Dylan Hurley
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent