passbolt-styleguide
Version:
Passbolt styleguide contains common styling assets used by the different sites, plugin, etc.
278 lines (254 loc) • 9.87 kB
JavaScript
/**
* Passbolt ~ Open source password manager for teams
* Copyright (c) 2022 Passbolt SA (https://www.passbolt.com)
*
* Licensed under GNU Affero General Public License version 3 of the or any later version.
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) 2022 Passbolt SA (https://www.passbolt.com)
* @license https://opensource.org/licenses/AGPL-3.0 AGPL License
* @link https://www.passbolt.com Passbolt(tm)
* @since 3.6.0
*/
import React from "react";
import PropTypes from "prop-types";
import { withAppContext } from "../../../shared/context/AppContext/AppContext";
// The authentication account recovery workflow states.
export const AuthenticationAccountRecoveryWorkflowStates = {
VERIFY_PASSPHRASE: "Validate Passphrase",
RECOVERING_ACCOUNT: "Recovering Account",
SIGNING_IN: "Signing in",
DOWNLOAD_RECOVERY_KIT: "Downloading Recovery Kit",
LOADING: "Loading",
UNEXPECTED_ERROR: "Unexpected Error",
HELP_CREDENTIALS_LOST: "Help Credentials lost",
CHECK_MAILBOX: "Check mailbox",
};
/**
* The authentication account recovery context.
* Handle the business logic of the account recovery and the associated workflow
* @type {React.Context<Object>}
*/
export const AuthenticationAccountRecoveryContext = React.createContext({
// Workflow data.
state: null, // The recover workflow current state
error: null, // The current error
// Workflow mutators.
verifyPassphrase: () => {}, // Verify the user wants to check the account recovery temporary gpgkey passphrase
complete: () => {}, // Complete the account recovery
needHelpCredentialsLost: () => {}, // Whenever the user lost its passphrase.
goToValidatePassphrase: () => {}, // Whenever the user wants to go to the validate passphrase.
requestHelpCredentialsLost: () => {}, // Whenever the user wants to request help because it lost its credentials.
downloadRecoveryKit: () => {}, // Go to the download recovery kit step
handleRecoveryKitDownloaded: () => {}, // Go to the step after the download recovery kit
});
/**
* The authentication recover context provider.
* Handle the business logic of the recover and the associated workflow.
*/
export class AuthenticationAccountRecoveryContextProvider extends React.Component {
/**
* Default constructor
* @param props The component props
*/
constructor(props) {
super(props);
this.state = this.defaultState;
//This is not on state as it's not related to rendering
this.passphrase = null;
this.rememberMe = null;
}
/**
* Returns the default component state
*/
get defaultState() {
return {
// Workflow data.
state: AuthenticationAccountRecoveryWorkflowStates.LOADING, // The account recovery workflow current state
error: null, // The current error
account: null, // The account recovery associated account.
// Public workflow mutators.
verifyPassphrase: this.verifyPassphrase.bind(this), // Verify the user wants to check the account recovery temporary gpgkey passphrase
complete: this.complete.bind(this), // Complete the account recovery request
needHelpCredentialsLost: this.needHelpCredentialsLost.bind(this), // Whenever the user lost its passphrase.
goToValidatePassphrase: this.goToValidatePassphrase.bind(this), // Whenever the user wants to go to the validate passphrase.
requestHelpCredentialsLost: this.requestHelpCredentialsLost.bind(this), // Whenever the user wants to request help because it lost its credentials.
downloadRecoveryKit: this.downloadRecoveryKit.bind(this), // Go to the download recovery kit step
handleRecoveryKitDownloaded: this.handleRecoveryKitDownloaded.bind(this), // Go to the step after the download recovery kit
};
}
/**
* Whenever the component is initialized
*/
componentDidMount() {
this.initialize();
}
/**
* Initialize the authentication account recovery workflow
* @returns {Promise<void>}
*/
async initialize() {
if (!(await this.verifyCanContinueAccountRecovery())) {
return;
}
await this.goToValidatePassphrase();
}
/**
* Verify the user can continue the account recovery process.
* @returns {Promise<void>}
*/
async verifyCanContinueAccountRecovery() {
try {
await this.props.context.port.request("passbolt.account-recovery.continue");
return true;
} catch (error) {
// It shouldn't occur. For any errors at this stage, the background page will destroy the iframe an let the application served by the API take care of it.
this.handleUnexpectedError(error);
return false;
}
}
/**
* Go to the validate account passphrase.
* @returns {Promise<void>}
*/
async goToValidatePassphrase() {
try {
const account = await this.props.context.port.request("passbolt.account-recovery.get-account");
this.setState({ state: AuthenticationAccountRecoveryWorkflowStates.VERIFY_PASSPHRASE, account: account });
} catch (error) {
this.handleUnexpectedError(error);
}
}
/**
* Verify the user account recovery temporary gpgkey passphrase.
* @param {string} passphrase The passphrase.
* @returns {Promise<void>}
* @throw {Error} If an expected errors is returned by the background page, rethrow it for the caller component.
* Errors of type: InvalidMasterPasswordError.
*/
async verifyPassphrase(passphrase) {
try {
await this.props.context.port.request("passbolt.account-recovery.verify-passphrase", passphrase);
} catch (error) {
if (error.name === "InvalidMasterPasswordError") {
throw error;
}
this.handleUnexpectedError(error);
}
}
/**
* Complete the account recovery.
* @param {string} passphrase The passphrase.
* @param {boolean} rememberMe (Optional) Should the passphrase be remembered? Default false.
* @returns {Promise<void>}
*/
async complete(passphrase, rememberMe = false) {
this.setState({ state: AuthenticationAccountRecoveryWorkflowStates.RECOVERING_ACCOUNT });
try {
await this.props.context.port.request("passbolt.account-recovery.recover-account", passphrase);
this.passphrase = passphrase;
this.rememberMe = rememberMe;
this.setState({ state: AuthenticationAccountRecoveryWorkflowStates.DOWNLOAD_RECOVERY_KIT });
} catch (error) {
this.handleUnexpectedError(error);
}
}
/**
* Whenever the user wants to download the recovery kit.
* @returns {Promise<void>}
*/
async downloadRecoveryKit() {
try {
await this.props.context.port.request("passbolt.account-recovery.download-recovery-kit");
} catch (error) {
this.setState({ state: AuthenticationAccountRecoveryWorkflowStates.UNEXPECTED_ERROR, error: error });
}
}
/**
* Whenever the user finished to download the recovery kit.
* @returns {Promise<void>}
*/
async handleRecoveryKitDownloaded() {
await this.signIn(this.passphrase, this.rememberMe);
this.passphrase = null;
this.rememberMe = null;
}
/**
* Sign-in.
* @param {string} passphrase The passphrase.
* @param {boolean} rememberMe (Optional) Should the passphrase be remembered? Default false.
* @returns {Promise<void>}
*/
async signIn(passphrase, rememberMe = false) {
this.setState({ state: AuthenticationAccountRecoveryWorkflowStates.SIGNING_IN });
try {
await this.props.context.port.request("passbolt.account-recovery.sign-in", passphrase, rememberMe);
} catch (error) {
this.handleUnexpectedError(error);
}
}
/**
* Handle unexpected error.
* @param {Object} error The error.
* @returns {void}
*/
handleUnexpectedError(error) {
this.setState({ state: AuthenticationAccountRecoveryWorkflowStates.UNEXPECTED_ERROR, error: error });
}
/**
* Whenever the user lost its passphrase.
* @returns {Promise<void>}
*/
needHelpCredentialsLost() {
this.setState({ state: AuthenticationAccountRecoveryWorkflowStates.HELP_CREDENTIALS_LOST });
}
/**
* Whenever the user wants to request help because it lost its credentials.
* @returns {Promise<void>}
*/
async requestHelpCredentialsLost() {
try {
await this.props.context.port.request("passbolt.account-recovery.request-help-credentials-lost");
this.setState({ state: AuthenticationAccountRecoveryWorkflowStates.CHECK_MAILBOX });
} catch (error) {
this.setState({ state: AuthenticationAccountRecoveryWorkflowStates.UNEXPECTED_ERROR, error: error });
}
}
/**
* Render the component
* @returns {JSX}
*/
render() {
return (
<AuthenticationAccountRecoveryContext.Provider value={this.state}>
{this.props.children}
</AuthenticationAccountRecoveryContext.Provider>
);
}
}
AuthenticationAccountRecoveryContextProvider.propTypes = {
context: PropTypes.any, // The application context
children: PropTypes.any, // The children components
};
export default withAppContext(AuthenticationAccountRecoveryContextProvider);
/**
* Authentication account recovery context consumer HOC
* @param {React.Component} WrappedComponent The component to wrap
*/
export function withAuthenticationAccountRecoveryContext(WrappedComponent) {
return class WithAuthenticationContext extends React.Component {
render() {
return (
<AuthenticationAccountRecoveryContext.Consumer>
{(authenticationAccountRecoveryContext) => (
<WrappedComponent
authenticationAccountRecoveryContext={authenticationAccountRecoveryContext}
{...this.props}
/>
)}
</AuthenticationAccountRecoveryContext.Consumer>
);
}
};
}