NATS.Client.DefaultUserJWTHandler Class Reference

Public Member Functions
	DefaultUserJWTHandler (string jwtFilePath, string credsFilePath)
void	DefaultUserJWTEventHandler (object sender, UserJWTEventArgs args)
void	DefaultUserSignatureHandler (object sender, UserSignatureEventArgs args)

Static Public Member Functions
static string	LoadUserFromFile (string path)
static NkeyPair	LoadNkeyPairFromSeedFile (string path)
static void	SignNonceFromFile (string credsFile, UserSignatureEventArgs args)

Properties
string	JwtFile [get]
string	CredsFile [get]

Detailed Description

This class is contains the default handlers for the Options.UserJWTEventHandler and the Options.UserSignatureEventHandler. This class is not normally used directly, but is provided to extend or use for utility methods to read a private seed or user JWT.

Constructor & Destructor Documentation

DefaultUserJWTHandler()

NATS.Client.DefaultUserJWTHandler.DefaultUserJWTHandler	(	string	jwtFilePath,
		string	credsFilePath
	)

Creates the default user jwt handler.

Parameters

jwtFilePath	Full path the to user JWT
credsFilePath	Full path to the user private credentials file. May be the same as the jwt file if they are chained.

Member Function Documentation

DefaultUserJWTEventHandler()

void NATS.Client.DefaultUserJWTHandler.DefaultUserJWTEventHandler	(	object	sender,
		UserJWTEventArgs	args
	)

The default User JWT Event Handler.

Parameters

sender	Usually the connection.
args	Arguments

DefaultUserSignatureHandler()

void NATS.Client.DefaultUserJWTHandler.DefaultUserSignatureHandler	(	object	sender,
		UserSignatureEventArgs	args
	)

The default User Signature event handler.

Parameters

sender
args

LoadNkeyPairFromSeedFile()

static NkeyPair NATS.Client.DefaultUserJWTHandler.LoadNkeyPairFromSeedFile ( string  path )

static

Generates a NATS Ed25519 keypair, used to sign server nonces, from a private credentials file.

Parameters

path	The credentials file, could be a "*.nk" or "*.creds" file.

Returns

A NATS Ed25519 KeyPair

LoadUserFromFile()

static string NATS.Client.DefaultUserJWTHandler.LoadUserFromFile ( string  path )

static

Gets a user JWT from a user JWT or chained credentials file.

Parameters

path	Full path to the JWT or cred file.

Returns

The encoded JWT

SignNonceFromFile()

static void NATS.Client.DefaultUserJWTHandler.SignNonceFromFile ( string  credsFile, UserSignatureEventArgs  args  )

static

Utility method to signs the UserSignatureEventArgs server nonce from a private credentials file.

Parameters

credsFile	A file with the private Nkey
args	Arguments

---

The documentation for this class was generated from the following file:

• DefaultUserJWTHandler.cs