org.gluu.credmanager.ui.vm.user.OTPViewModel クラス

org.gluu.credmanager.ui.vm.user.OTPViewModel の継承関係図

org.gluu.credmanager.ui.vm.user.OTPViewModel 連携図

公開メンバ関数
boolean	isUiCorrectCode ()
boolean	isUiPanelOpened ()
boolean	isUiQRShown ()
boolean	isUiTokenPressing ()
int	getEditingId ()
int	getDigitLength ()
String	getTokenType ()
OTPType	getHardTokenType ()
String	getCode ()
OTPDevice	getNewDevice ()
List< OTPDevice >	getDevices ()
String	getSecretKeyString ()
void	setSecretKeyString (String secretKeyString)
void	setNewDevice (OTPDevice newDevice)
void	setCode (String code)
void	setUiPanelOpened (boolean uiPanelOpened)
void	childInit () throws Exception
void	chooseType (@BindingParam("type") String type, @BindingParam("component") HtmlBasedComponent comp)
void	showQR ()
void	afterCompose (@ContextParam(ContextType.VIEW) Component view)
void	timedOut (Event event) throws Exception
void	cancel ()
void	changeHardType (@BindingParam("time") boolean timeBased)
void	changeTokenPressing (@BindingParam("component") HtmlBasedComponent comp)
void	validateCode (@BindingParam("ref") Component ref)
void	add ()
void	prepareForUpdate (@BindingParam("device") OTPDevice dev)
void	cancelUpdate ()
void	update ()
void	delete (@BindingParam("device") OTPDevice device)
void	init ()
void	logoutFromAuthzServer ()

関数
int	getScreenWidth ()
BrowserInfo	getBrowserInfo ()
Pair< String, String >	getDeleteMessages (String nick, String extraMessage)
String	resetPreferenceMessage (String credentialType, int nCredsOfType)

変数
UserService	userService
User	user

非公開メンバ関数
OTPType	getApplicableAlgorithmType ()
boolean	enroll ()

非公開変数類
Logger	logger = LoggerFactory.getLogger(getClass())
OTPService	otpService
String	code
List< OTPDevice >	devices
OTPDevice	newDevice
int	editingId
String	secretKeyString
byte []	secretKey
OTPConfig	otpConfig
String	tokenType
OTPType	hardTokenType
boolean	uiPanelOpened
boolean	uiQRShown
boolean	uiCorrectCode
boolean	uiTokenPressing

静的非公開変数類
static final int	QR_SCAN_TIMEOUT = 60

詳解

This is the ViewModel of page otp-detail.zul. It controls the CRUD of HOTP/TOTP devices

著者

jgomer

関数詳解

add()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.add ( )

inline

                      {

        //Adds the new device if user typed a nickname in the text box
        if (Utils.isNotEmpty(newDevice.getNickName())) {
            if (enroll()) {
                UIUtils.showMessageUI(true, Labels.getLabel("usr.enroll.success"));
                uiPanelOpened = false;
                cancel();
            } else {
                UIUtils.showMessageUI(false, Labels.getLabel("usr.enroll.error"));
            }
        }
    }

afterCompose()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.afterCompose ( @ContextParam(ContextType.VIEW) Component  view )

inline

                                                                            {
        Selectors.wireEventListeners(view, this);
    }

cancel()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.cancel ( )

inline

                         {
        if (uiQRShown) {
            Clients.response(new AuInvoke("clean"));
            uiQRShown = false;
        }
        uiCorrectCode = false;
        uiTokenPressing = false;
        code = null;
        newDevice = new OTPDevice();
        tokenType = null;
    }

cancelUpdate()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.cancelUpdate ( )

inline

                               {
        newDevice.setNickName(null);
        editingId = 0;
    }

changeHardType()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.changeHardType ( @BindingParam("time") boolean  timeBased )

inline

                                                                        {
        hardTokenType = timeBased ? OTPType.TOTP : OTPType.HOTP;
    }

changeTokenPressing()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.changeTokenPressing ( @BindingParam("component") HtmlBasedComponent  comp )

inline

                                                                                        {

        uiTokenPressing = !uiTokenPressing;

        //Generate the binary key based on user input
        logger.trace("Computing key based on key typed for hard token");
        String skey = secretKeyString.replaceAll("\\s", "");
        secretKey = new byte[skey.length()/2];
        for (int i = 0; i < secretKey.length; i++) {
            secretKey[i] = (byte) (Integer.valueOf(skey.substring(i * 2, (i + 1) * 2), 16).intValue());
        }

        if (comp != null) {
            comp.focus();
        }

    }

childInit()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.childInit ( ) throws Exception

inline

                                             {
        newDevice = new OTPDevice();
        uiPanelOpened = true;
        devices = otpService.getDevices(user.getId());
        otpConfig = otpService.getConf();
    }

chooseType()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.chooseType ( @BindingParam("type") String  type, @BindingParam("component") HtmlBasedComponent  comp  )

inline

                                                                                                                  {
        tokenType = type;
        if (comp != null) {
            comp.focus();
        }
    }

delete()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.delete ( @BindingParam("device") OTPDevice  device )

inline

                                                                 {

        String resetMessages = resetPreferenceMessage(OTPExtension.ACR, devices.size());
        boolean reset = resetMessages != null;
        Pair<String, String> delMessages = getDeleteMessages(device.getNickName(), resetMessages);

        Messagebox.show(delMessages.getY(), delMessages.getX(), Messagebox.YES | Messagebox.NO, reset ? Messagebox.EXCLAMATION : Messagebox.QUESTION,
                event -> {
                    if (Messagebox.ON_YES.equals(event.getName())) {
                        try {
                            if (devices.remove(device)) {
                                if (reset) {
                                    userService.setPreferredMethod(user, null);
                                }

                                otpService.updateDevicesAdd(user.getId(), devices, null);
                                //trigger refresh (this method is asynchronous...)
                                BindUtils.postNotifyChange(null, null, OTPViewModel.this, "devices");

                                UIUtils.showMessageUI(true);
                            }
                        } catch (Exception e) {
                            UIUtils.showMessageUI(false);
                            logger.error(e.getMessage(), e);
                        }
                    }
                });
    }

enroll()

boolean org.gluu.credmanager.ui.vm.user.OTPViewModel.enroll ( )

inlineprivate

                             {

        boolean success = false;
        try {
            logger.trace("Updating/adding device {} for user {}", newDevice.getNickName(), user.getId());
            newDevice.setAddedOn(new Date().getTime());
            newDevice.setTimeBased(OTPType.TOTP.equals(hardTokenType));
            newDevice.setSoft(tokenType.equals("SOFT"));
            otpService.updateDevicesAdd(user.getId(), devices, newDevice);
            success = true;
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return success;

    }

getApplicableAlgorithmType()

OTPType org.gluu.credmanager.ui.vm.user.OTPViewModel.getApplicableAlgorithmType ( )

inlineprivate

                                                 {
        //Assume TOTP if no selections have been made
        return tokenType != null && tokenType.equals("HARD") && hardTokenType != null
                && hardTokenType.equals(OTPType.HOTP) ? OTPType.HOTP : OTPType.TOTP;
    }

getBrowserInfo()

BrowserInfo org.gluu.credmanager.ui.vm.user.UserViewModel.getBrowserInfo ( )

inlinepackageinherited

                                 {
        return sessionContext.getBrowser();
    }

getCode()

String org.gluu.credmanager.ui.vm.user.OTPViewModel.getCode ( )

inline

                            {
        return code;
    }

getDeleteMessages()

Pair<String, String> org.gluu.credmanager.ui.vm.user.UserViewModel.getDeleteMessages ( String  nick, String  extraMessage  )

inlinepackageinherited

                                                                            {

        StringBuilder text=new StringBuilder();
        if (extraMessage != null) {
            text.append(extraMessage).append("\n\n");
        }
        text.append(Labels.getLabel("usr.del_confirm", new String[]{ nick==null ? Labels.getLabel("general.no_named") : nick }));
        if (extraMessage != null) {
            text.append("\n");
        }

        return new Pair<>(Labels.getLabel("usr.del_title"), text.toString());

    }

getDevices()

List<OTPDevice> org.gluu.credmanager.ui.vm.user.OTPViewModel.getDevices ( )

inline

                                        {
        return devices;
    }

getDigitLength()

int org.gluu.credmanager.ui.vm.user.OTPViewModel.getDigitLength ( )

inline

                                {

        int len;
        switch (getApplicableAlgorithmType()) {
            case TOTP:
                len = otpConfig.getTotp().getDigits();
                break;
            case HOTP:
                len = otpConfig.getHotp().getDigits();
                break;
            default:
                len = 0;
        }
        return len;

    }

getEditingId()

int org.gluu.credmanager.ui.vm.user.OTPViewModel.getEditingId ( )

inline

                              {
        return editingId;
    }

getHardTokenType()

OTPType org.gluu.credmanager.ui.vm.user.OTPViewModel.getHardTokenType ( )

inline

                                      {
        return hardTokenType;
    }

getNewDevice()

OTPDevice org.gluu.credmanager.ui.vm.user.OTPViewModel.getNewDevice ( )

inline

                                    {
        return newDevice;
    }

getScreenWidth()

int org.gluu.credmanager.ui.vm.user.UserViewModel.getScreenWidth ( )

inlinepackageinherited

                         {
        return sessionContext.getScreenWidth();
    }

getSecretKeyString()

String org.gluu.credmanager.ui.vm.user.OTPViewModel.getSecretKeyString ( )

inline

                                       {
        return secretKeyString;
    }

getTokenType()

String org.gluu.credmanager.ui.vm.user.OTPViewModel.getTokenType ( )

inline

                                 {
        return tokenType;
    }

init()

void org.gluu.credmanager.ui.vm.user.UserViewModel.init ( )

inlineinherited

                       {
        user = sessionContext.getUser();
        minCredsFor2FA = confHandler.getSettings().getMinCredsFor2FA();
    }

isUiCorrectCode()

boolean org.gluu.credmanager.ui.vm.user.OTPViewModel.isUiCorrectCode ( )

inline

                                     {
        return uiCorrectCode;
    }

isUiPanelOpened()

boolean org.gluu.credmanager.ui.vm.user.OTPViewModel.isUiPanelOpened ( )

inline

                                     {
        return uiPanelOpened;
    }

isUiQRShown()

boolean org.gluu.credmanager.ui.vm.user.OTPViewModel.isUiQRShown ( )

inline

                                 {
        return uiQRShown;
    }

isUiTokenPressing()

boolean org.gluu.credmanager.ui.vm.user.OTPViewModel.isUiTokenPressing ( )

inline

                                       {
        return uiTokenPressing;
    }

logoutFromAuthzServer()

void org.gluu.credmanager.ui.vm.user.UserViewModel.logoutFromAuthzServer ( )

inlineinherited

                                        {

        try {
            logger.trace("Log off attempt");
            purgeSession();
            //After End-User has logged out, the Client might request to log him out of the OP too
            //TODO: what happens after session expiration?
            String idToken = authFlowContext.getIdToken();
            Executions.sendRedirect(oxdService.getLogoutUrl(idToken));
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }

    }

prepareForUpdate()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.prepareForUpdate ( @BindingParam("device") OTPDevice  dev )

inline

                                                                        {
        //This will make the modal window to become visible
        editingId = dev.getId();
        newDevice = new OTPDevice();
        newDevice.setNickName(dev.getNickName());
    }

resetPreferenceMessage()

String org.gluu.credmanager.ui.vm.user.UserViewModel.resetPreferenceMessage ( String  credentialType, int  nCredsOfType  )

inlinepackageinherited

                                                                           {

        //Assume removal has no problem
        String message = null;
        Set<String> enabledMethods = confHandler.getEnabledAcrs();
        List<Pair<AuthnMethod, Integer>> userMethodsCount = userService.getUserMethodsCount(user.getId(), enabledMethods);
        int totalCreds = userMethodsCount.stream().mapToInt(Pair::getY).sum();

        if (totalCreds == minCredsFor2FA) {
            message = CredRemovalConflict.CREDS2FA_NUMBER_UNDERFLOW.getMessage(minCredsFor2FA);
        } else if (nCredsOfType == 1 && credentialType.equals(user.getPreferredMethod())){
            message = CredRemovalConflict.PREFERRED_CREDENTIAL_REMOVED.getMessage();
        } else {
            List<AuthnMethod> methods = userService.get2FARequisiteMethods();
            boolean typeOfCredIs2FARequisite = methods.stream().map(AuthnMethod::getAcr).anyMatch(acr -> acr.equals(credentialType));

            if (typeOfCredIs2FARequisite) {
                int nCredsBelongingTo2FARequisite = userMethodsCount.stream()
                        .filter(pair -> pair.getX().mayBe2faActivationRequisite()).mapToInt(Pair::getY).sum();
                if (nCredsBelongingTo2FARequisite == 1) {
                    //Compute the names of those authentication methods which are requisite for 2FA activation
                    String commaSepNames = methods.stream().map(aMethod -> Labels.getLabel(aMethod.getUINameKey()))
                            .collect(Collectors.toList()).toString();
                    commaSepNames = commaSepNames.substring(1, commaSepNames.length() - 1);
                    message = CredRemovalConflict.REQUISITE_NOT_FULFILED.getMessage(commaSepNames);
                }
            }
        }
        return message;

    }

setCode()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.setCode ( String  code )

inline

                                     {
        this.code = code;
    }

setNewDevice()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.setNewDevice ( OTPDevice  newDevice )

inline

                                                  {
        this.newDevice = newDevice;
    }

setSecretKeyString()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.setSecretKeyString ( String  secretKeyString )

inline

                                                           {
        this.secretKeyString = secretKeyString;
    }

setUiPanelOpened()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.setUiPanelOpened ( boolean  uiPanelOpened )

inline

                                                        {
        this.uiPanelOpened = uiPanelOpened;
    }

showQR()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.showQR ( )

inline

                         {

        uiQRShown = true;
        uiCorrectCode = false;
        code = null;

        //For QR scan TOTP is used
        IOTPAlgorithm totpService = otpService.getAlgorithmService(OTPType.TOTP);
        secretKey = totpService.generateSecretKey();
        String request = totpService.generateSecretKeyUri(secretKey, user.getGivenName());

        JavaScriptValue jvalue = new JavaScriptValue(otpConfig.getFormattedQROptions(getScreenWidth()));

        //Calls the startQR javascript function supplying suitable params
        Clients.response(new AuInvoke("startQR", request, otpConfig.getLabel(), jvalue, QR_SCAN_TIMEOUT));

    }

timedOut()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.timedOut ( Event  event ) throws Exception

inline

                                                       {
        if (uiQRShown) {
            //Restore UI because user did not scan code
            uiQRShown = false;
            BindUtils.postNotifyChange(null, null, this, "uiQRShown");
        }
    }

update()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.update ( )

inline

                         {

        String nick = newDevice.getNickName();
        if (Utils.isNotEmpty(nick)) {
            //Find the index of the current device in the device list
            int i = Utils.firstTrue(devices, dev -> dev.getId() == editingId);
            OTPDevice dev = devices.get(i);
            //Updates its nickname
            dev.setNickName(nick);
            cancelUpdate();     //This doesn't undo anything we already did (just controls UI aspects)

            try {
                otpService.updateDevicesAdd(user.getId(), devices, null);
                UIUtils.showMessageUI(true);
            } catch (Exception e) {
                UIUtils.showMessageUI(false);
                logger.error(e.getMessage(), e);
            }
        }

    }

validateCode()

void org.gluu.credmanager.ui.vm.user.OTPViewModel.validateCode ( @BindingParam("ref") Component  ref )

inline

                                                                 {

        String uid = null;
        if (code != null) {
            logger.trace("Validating code entered");
            //Determines if numeric code is valid with respect to secret key
            IOTPAlgorithm service = otpService.getAlgorithmService(getApplicableAlgorithmType());
            uid = service.getExternalUid(secretKey, code);
            if (uid != null) {

                //User may have entered the same key manually in the past
                int semicolon = uid.indexOf(";");
                final String shorterUid = semicolon == -1 ? uid : uid.substring(0, semicolon);

                if (devices.stream().anyMatch(dev -> dev.getUid().startsWith(shorterUid))) {
                    UIUtils.showMessageUI(false, Labels.getLabel("usr.otp_duplicated_device"));
                } else {
                    newDevice.setUid(uid);
                    uiCorrectCode = true;
                }
            }
        }
        if (uid == null) {
            uid = Labels.getLabel("usr.code_wrong");
            Clients.showNotification(uid, Clients.NOTIFICATION_TYPE_WARNING, ref, "before_center", UIUtils.FEEDBACK_DELAY_ERR);
        }

    }

メンバ詳解

code

String org.gluu.credmanager.ui.vm.user.OTPViewModel.code

private

devices

List<OTPDevice> org.gluu.credmanager.ui.vm.user.OTPViewModel.devices

private

editingId

int org.gluu.credmanager.ui.vm.user.OTPViewModel.editingId

private

hardTokenType

OTPType org.gluu.credmanager.ui.vm.user.OTPViewModel.hardTokenType

private

logger

Logger org.gluu.credmanager.ui.vm.user.OTPViewModel.logger = LoggerFactory.getLogger(getClass())

private

newDevice

OTPDevice org.gluu.credmanager.ui.vm.user.OTPViewModel.newDevice

private

otpConfig

OTPConfig org.gluu.credmanager.ui.vm.user.OTPViewModel.otpConfig

private

otpService

OTPService org.gluu.credmanager.ui.vm.user.OTPViewModel.otpService

private

QR_SCAN_TIMEOUT

final int org.gluu.credmanager.ui.vm.user.OTPViewModel.QR_SCAN_TIMEOUT = 60

staticprivate

secretKey

byte [] org.gluu.credmanager.ui.vm.user.OTPViewModel.secretKey

private

secretKeyString

String org.gluu.credmanager.ui.vm.user.OTPViewModel.secretKeyString

private

tokenType

String org.gluu.credmanager.ui.vm.user.OTPViewModel.tokenType

private

uiCorrectCode

boolean org.gluu.credmanager.ui.vm.user.OTPViewModel.uiCorrectCode

private

uiPanelOpened

boolean org.gluu.credmanager.ui.vm.user.OTPViewModel.uiPanelOpened

private

uiQRShown

boolean org.gluu.credmanager.ui.vm.user.OTPViewModel.uiQRShown

private

uiTokenPressing

boolean org.gluu.credmanager.ui.vm.user.OTPViewModel.uiTokenPressing

private

user

User org.gluu.credmanager.ui.vm.user.UserViewModel.user

packageinherited

userService

UserService org.gluu.credmanager.ui.vm.user.UserViewModel.userService

packageinherited

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/OpenId/gluu/src/cred-manager/app/src/main/java/org/gluu/credmanager/ui/vm/user/OTPViewModel.java