$totp.genKey

Description

Retourne une table décrivant les modèles définis dans la descript.

Syntaxe

$totp.genKey( [ options ] )

Paramètres

options string

Paramètres de configuration du générateur de clé. Les options reconnues sont données ci-après. Les descriptifs sont issus de la classe GoogleAuthenticatorConfig.java en charge du traitement.

timeStepSizeInMillis number

The time step size, in milliseconds, as specified by RFC 6238. The default value is 30.000.

La valeur doit être un nombre strictement positif. La valeur par défaut est 30000.

windowSize number

Integer value representing the number of windows of size timeStepSizeInMillis that are checked during the validation process, to account for differences between the server and the client clocks. The bigger the window, the more tolerant the library code is about clock skews.

We are using Google's default behaviour of using a window size equal to 3. The limit on the maximum window size, present in older versions of this library, has been removed.

La valeur doit être un nombre strictement positif. La valeur par défaut est 3.

codeDigits number

The number of digits in the generated code.

La valeur doit être un nombre compris entre 6 et 8. La valeur par défaut est 6

numberOfScratchCodes number

The number of scratch codes to generate. We are using Google's default of providing 5 scratch codes.

La valeur doit être un nombre strictement positif compris entre 1 et 1000. La valeur par défaut est 5.

secretBits number

The number of bits of the secret keys to generate. The length should always be a multiple of 8. The default value is 160 bits, and a value smaller than 128 is disallowed, as recommended by RFC 4226 §4.

La valeur par défaut est 160.

keyRepresentation string

The key representation.

Les valeurs possibles sont "base32" et "base64". La valeur par défaut est "base32".

hmacHashFunction string

The cryptographic hash function used to calculate the HMAC (Hash-based Message Authentication Code). This implementation uses the SHA1 hash function by default.

Les valeurs possibles sont "hmacsha1", "hmacsha256" et "hmacsha512". La valeur par défaut est "hmacsha1".

removePadding boolean

Cette option est spécifique à Ewt. Elle indique si on souhaite que la méthode retire les caractères "=" de padding en fin de clé.

En effet, selon la taille de secret définie via l'option secretBits, il est possible que des caractères de padding soit ajoutés. Par exemple, avec une taille de 128, la méthode génère une clé du genre "F3XWZBVOFM4TBZUV5A7CLLFRRA======". Avec l'option removePadding, la méthode se charge de retirer les "=" superflus.

L'option est false par défaut.

Retour

Clé secrète TOTP.

Exemple

Voir $totp.getCode