FB_JwtEncode

Der Funktionsbaustein ermöglicht die Erzeugung und Signierung eines JSON Web Token (JWT).

Syntax

Definition:

FUNCTION_BLOCK FB_JwtEncode
VAR_INPUT
  bExecute       : BOOL; 
  sHeaderAlg     : STRING(46);
  sPayload       : STRING(1023);
  sKeyFilePath   : STRING(511);
  tTimeout       : TIME;
  pKey           : PVOID;
  nKeySize       : UDINT;
  nJwtSize       : UDINT;
END_VAR
VAR_IN_OUT CONSTANT
  sJwt           : STRING;  
END_VAR
VAR_OUTPUT
  bBusy          : BOOL;
  bError         : BOOL;
  hrErrorCode    : HRESULT;
  initStatus     : HRESULT;
END_VAR

Eingänge

Name	Typ	Beschreibung
bExecute	BOOL	Steigende Flanke aktiviert die Abarbeitung des Funktionsbausteins.
sHeaderAlg	STRING(46)	Der zu verwendende Algorithmus für den JWT Header, z. B. RS256.
sPayload	STRING(1023	Der zu verwendende Payload des JWT.
sKeyFilePath	STRING(511)	Pfad zum Private Key, welcher für die Signatur des JWT verwendet werden soll.
tTimeout	TIME	ADS Timeout, welcher intern für den Dateizugriff auf den Private Key verwendet wird.
pKey	PVOID	Buffer für den auszulesenden Private Key.
nKeySize	UDINT	Maximalgröße des Buffers.
sJwt	STRING	Enthält nach Abarbeitung des Funktionsbausteins das fertig kodierte und signierte JWT.
nJwtSize	UDINT	Größe des erzeugten JWT inklusive Nullterminierung.

Ausgänge

Name	Typ	Beschreibung
bBusy	BOOL	Ist TRUE, solange die Abarbeitung des Funktionsbausteins noch nicht beendet ist.
bError	BOOL	Wird TRUE, sobald eine Fehlersituation eintritt.
hrErrorCode	HRESULT	Liefert bei einem gesetzten Ausgang `bError` einen Fehlercode. Eine Erläuterung zu den möglichen Fehlercodes befindet sich im Anhang.
initStatus	HRESULT	Liefert im Fall einer fehlgeschlagenen Initialisierung des Funktionsbausteins einen Fehlercode.

Voraussetzungen

TwinCAT Version	Hardware	Einzubindende Bibliotheken
TwinCAT 3.1, Build 4024.4	x86, x64, ARM	Tc3_JsonXml 3.3.6.0