Skip to main content

Overview

Allows the client to retrieve a list of available cryptographic algorithms on the server. These algorithms can be used to create keys. These keys are necessary in order to apply for legal identities, which are then used to sign smart contracts.

HTTP request

POST /Agent/Crypto/GetAlgorithms

Authentication

Requires a valid JWT bearer token.

Request (JSON)

{
}

Response (JSON)

{
	"Algorithms": 
	{
		"localName":Required(Str(PLocalName)),
		"namespace":Required(Str(PNamespace)),
		"securityStrength":Required(Int(PSecurityStrength)),
		"safe":Required(Boolean(PSafe)),
		"slow":Required(Boolean(PSlow)),
		"pqc":Required(Boolean(PPqc)),
		"score":Required(Int(PScore))
	}?[]
}

Response parameters

ParameterDescription
PLocalNameLocal Name of the algorithm.
PNamespaceNamespace, defining the algorithm.
PSecurityStrengthSecurity strength of algorithm (in bits).
PSafeIf the algorithm is considered safe according to https://safecurves.cr.yp.to/.
PSlowIf the algorithm is slow (i.e. computation intensive).
PPqcIf the algorithm represents Post Quantum Cryptography (PQC).
PScoreAlgorithm score. Can be used, together with PSecurityStrength to order algorithms.

Notes

This endpoint uses the request schema notation described in Pattern matching.