org.keycloak.models.OTPPolicy クラス

org.keycloak.models.OTPPolicy の継承関係図

org.keycloak.models.OTPPolicy 連携図

クラス
class	FreeOTP
class	GoogleAuthenticator
interface	OtpApp

公開メンバ関数
	OTPPolicy ()
	OTPPolicy (String type, String algorithm, int initialCounter, int digits, int lookAheadWindow, int period)
String	getAlgorithmKey ()
String	getType ()
void	setType (String type)
String	getAlgorithm ()
void	setAlgorithm (String algorithm)
int	getInitialCounter ()
void	setInitialCounter (int initialCounter)
int	getDigits ()
void	setDigits (int digits)
int	getLookAheadWindow ()
void	setLookAheadWindow (int lookAheadWindow)
int	getPeriod ()
void	setPeriod (int period)
String	getKeyURI (RealmModel realm, UserModel user, String secret)
List< String >	getSupportedApplications ()

静的公開変数類
static OTPPolicy	DEFAULT_POLICY = new OTPPolicy(UserCredentialModel.TOTP, HmacOTP.HMAC_SHA1, 0, 6, 1, 30)

限定公開変数類
String	type
String	algorithm
int	initialCounter
int	digits
int	lookAheadWindow
int	period

静的限定公開変数類
static final Logger	logger = Logger.getLogger(OTPPolicy.class)

静的関数
	[static initializer]

静的非公開変数類
static final Map< String, String >	algToKeyUriAlg = new HashMap<>()
static final OtpApp []	allApplications = new OtpApp[] { new FreeOTP(), new GoogleAuthenticator() }

詳解

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

OTPPolicy() [1/2]

org.keycloak.models.OTPPolicy.OTPPolicy ( )

inline

                       {
    }

OTPPolicy() [2/2]

org.keycloak.models.OTPPolicy.OTPPolicy ( String  type, String  algorithm, int  initialCounter, int  digits, int  lookAheadWindow, int  period  )

inline

                                                                                                                     {
        this.type = type;
        this.algorithm = algorithm;
        this.initialCounter = initialCounter;
        this.digits = digits;
        this.lookAheadWindow = lookAheadWindow;
        this.period = period;
    }

関数詳解

[static initializer]()

org.keycloak.models.OTPPolicy.[static initializer] ( )

inlinestaticpackage

getAlgorithm()

String org.keycloak.models.OTPPolicy.getAlgorithm ( )

inline

                                 {
        return algorithm;
    }

getAlgorithmKey()

String org.keycloak.models.OTPPolicy.getAlgorithmKey ( )

inline

                                    {
        return algToKeyUriAlg.containsKey(algorithm) ? algToKeyUriAlg.get(algorithm) : algorithm;
    }

getDigits()

int org.keycloak.models.OTPPolicy.getDigits ( )

inline

                           {
        return digits;
    }

getInitialCounter()

int org.keycloak.models.OTPPolicy.getInitialCounter ( )

inline

                                   {
        return initialCounter;
    }

getKeyURI()

String org.keycloak.models.OTPPolicy.getKeyURI ( RealmModel  realm, UserModel  user, String  secret  )

inline

Constructs the otpauth:// URI based on the Key-Uri-Format.

引数

realm
user
secret

戻り値

the otpauth:// URI

                                                                             {

        try {

            String displayName = realm.getDisplayName() != null && !realm.getDisplayName().isEmpty() ? realm.getDisplayName() : realm.getName();

            String accountName = URLEncoder.encode(user.getUsername(), "UTF-8");
            String issuerName = URLEncoder.encode(displayName, "UTF-8") .replaceAll("\\+", "%20");

            /*
             * The issuerName component in the label is usually shown in a authenticator app, such as
             * Google Authenticator or FreeOTP, as a hint for the user to which system an username
             * belongs to.
             */
            String label = issuerName + ":" + accountName;

            String parameters = "secret=" + Base32.encode(secret.getBytes()) //
                                + "&digits=" + digits //
                                + "&algorithm=" + algToKeyUriAlg.get(algorithm) //
                                + "&issuer=" + issuerName;

            if (type.equals(UserCredentialModel.HOTP)) {
                parameters += "&counter=" + initialCounter;
            } else if (type.equals(UserCredentialModel.TOTP)) {
                parameters += "&period=" + period;
            }

            return "otpauth://" + type + "/" + label+ "?" + parameters;
        } catch (UnsupportedEncodingException e) {
            throw new RuntimeException(e);
        }
    }

getLookAheadWindow()

int org.keycloak.models.OTPPolicy.getLookAheadWindow ( )

inline

                                    {
        return lookAheadWindow;
    }

getPeriod()

int org.keycloak.models.OTPPolicy.getPeriod ( )

inline

                           {
        return period;
    }

getSupportedApplications()

List<String> org.keycloak.models.OTPPolicy.getSupportedApplications ( )

inline

                                                   {
        List<String> applications = new LinkedList<>();
        for (OtpApp a : allApplications) {
            if (a.supports(this)) {
                applications.add(a.getName());
            }
        }
        return applications;
    }

getType()

String org.keycloak.models.OTPPolicy.getType ( )

inline

                            {
        return type;
    }

setAlgorithm()

void org.keycloak.models.OTPPolicy.setAlgorithm ( String  algorithm )

inline

                                               {
        this.algorithm = algorithm;
    }

setDigits()

void org.keycloak.models.OTPPolicy.setDigits ( int  digits )

inline

                                      {
        this.digits = digits;
    }

setInitialCounter()

void org.keycloak.models.OTPPolicy.setInitialCounter ( int  initialCounter )

inline

                                                      {
        this.initialCounter = initialCounter;
    }

setLookAheadWindow()

void org.keycloak.models.OTPPolicy.setLookAheadWindow ( int  lookAheadWindow )

inline

                                                        {
        this.lookAheadWindow = lookAheadWindow;
    }

setPeriod()

void org.keycloak.models.OTPPolicy.setPeriod ( int  period )

inline

                                      {
        this.period = period;
    }

setType()

void org.keycloak.models.OTPPolicy.setType ( String  type )

inline

                                     {
        this.type = type;
    }

メンバ詳解

algorithm

String org.keycloak.models.OTPPolicy.algorithm

protected

algToKeyUriAlg

final Map<String, String> org.keycloak.models.OTPPolicy.algToKeyUriAlg = new HashMap<>()

staticprivate

allApplications

final OtpApp [] org.keycloak.models.OTPPolicy.allApplications = new OtpApp[] { new FreeOTP(), new GoogleAuthenticator() }

staticprivate

DEFAULT_POLICY

OTPPolicy org.keycloak.models.OTPPolicy.DEFAULT_POLICY = new OTPPolicy(UserCredentialModel.TOTP, HmacOTP.HMAC_SHA1, 0, 6, 1, 30)

static

digits

int org.keycloak.models.OTPPolicy.digits

protected

initialCounter

int org.keycloak.models.OTPPolicy.initialCounter

protected

logger

final Logger org.keycloak.models.OTPPolicy.logger = Logger.getLogger(OTPPolicy.class)

staticprotected

lookAheadWindow

int org.keycloak.models.OTPPolicy.lookAheadWindow

protected

period

int org.keycloak.models.OTPPolicy.period

protected

type

String org.keycloak.models.OTPPolicy.type

protected

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/models/OTPPolicy.java