TOTP One-Time Password Generator

Dieser Adapter generiert ein TOTP-Einmalpasswort, das mit Google Authenticator und anderen Tools kompatibel ist.

Eigenschaften (Properties)

Operation

Vom Adapter ausgeführte Operation

Mögliche Werte:

GenerateSecret: 20 Byte lange Base32-Zeichenkette erstellen, die als geheimer Schlüssel für die Passwort-Generierung oder -Validierung oder als Basis für ein QR-Code-Bild verwendet werden kann
GeneratePassword: Einmalpasswort auf Basis des im XML-Inputdokument bereitgestellten geheimen Schlüssels erstellen
VerifyPassword: Einmalpasswort in Kombination mit dem geheimen Schlüssel überprüfen – beides wird im XML-Inputdokument angegeben
GenerateAuthenticatorQRCode: 512x512 px Bilsd (.png) auf Basis des im XML-Inputdokument bereitgestellten geheimen Schlüssels erstellen

Diese Operation verwendet auch die Parameter issuer und account, um den QR-Code zu kommentieren. Diese Informationen werden sichtbar, wenn der Code von Google Authenticator oder einem ähnlichen Tool gescannt wird.

Parameter

Adapter

Hauptklasse des Adapters (nicht verändern!)

Mögliche Werte: de.softproject.x4.adapter.totpgenerator.TOTPGenerator: Hauptklasse (Standard)

issuer

Name der Firma oder Organisation, die das Einmalpasswort ausstellt

Dieser Parameter sollte wie ein Anzeigename behandelt werden, da er in der Authenticator App wie angegeben angezeigt wird, z. B. SoftProject GmbH.

account

Konto, das an den geheimen Schlüssel gebunden ist – typischerweise ein Benutzername oder eine E-Mail-Adresse

Dieser Parameter sollte wie ein Anzeigename behandelt werden, da er in der Authenticator App wie angegeben angezeigt wird, z. B. John Doe oder john.doe@example.org.

Statuswerte

`1`	Die Operation wurde erfolgreich ausgeführt.
`-1`	Während der Ausführung der Operation kam es zu einem Fehler.
`403`	Das Passwort stimmt nicht überein, z. B. weil die Eingabestruktur nicht wohlgeformt ist.

Input

Der Adapter erwartet je nach gewählter Operation eine andere Inputstruktur.

Operation GenerateSecret:
Diese Operation benötigt keinen Input.

Operation GeneratePassword:

Input

XML

<Secret>
        <!-- 20-byte BASE32 character string -->
    </Secret>

Operation VerifyPassword:

Input

XML

 <TOTP>
        <Password>
            <!-- 6-digit number with leading zeroes -->
        </Password>
        <Secret>
            <!-- 20-byte BASE32 character string -->
        </Secret>
    </TOTP>

Operation GenerateAuthenticatorQRCode:

Input

XML

<Secret>
	<!-- 20-byte BASE32 character string -->
</Secret>

Output

Der Adapter gibt abhängig von der gewählten Operation verschiedene Ausgabestrukturen aus.

Operation GenerateSecret:

Output

XML

<Secret>
	<!-- 20-byte BASE32 character string -->
</Secret>

Operation GeneratePassword:

Output

XML

 <Password>
        <!-- 6-digit number with leading zeroes -->
    </Password>

Operation VerifyPassword:

Output

XML

 <Ok description="The password matches."/>
               <!-- or -->  
 <Error description="The password provided is incorrect."/>

Operation GenerateAuthenticatorQRCode:
Ein Bild (.png) mit einem QR-Code wird ausgegeben.