SSHKey Type

SSHKey is used to store information about single compound public-key algorithm (such as RSA or DSA) key.

Remarks

SSH keys are used to secure the SSH protocol flow. They support different algorithms and key lengths, a very typical example being RSA-2048 bits.

Fields

Algorithm
String

Specifies the key algorithm.

Bits
Integer

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

Comment
String

The comment for the public key.

Curve
String

Specifies the elliptical curve when EC cryptography is used.

DSSG
TBytes

The G (Generator) parameter of the DSS signature key. The string should contain the binary data of G.

DSSP
TBytes

The P (Prime) parameter of the DSS signature key. The string should contain the binary data of P.

DSSQ
TBytes

The Q (Prime Factor) parameter of the DSS signature key. The string should contain the binary data of Q.

DSSX
TBytes

The X (Private key) parameter of the DSS signature key. The string should contain the binary data of X.

This parameter may be empty if there's no need to sign data with this key (e.g. if the key is a server public key needed only to authenticate the server).

DSSY
TBytes

The Y (Public key) parameter of the DSS signature key. The string should contain the binary data of Y.

ECCD
TBytes

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used. The string should contain the binary data of D.

ECCQX
TBytes

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of X.

ECCQY
TBytes

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of Y.

EdPrivate
TBytes

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

EdPublic
TBytes

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

FingerprintMD5
String

Contains the MD5 fingerprint (hash) of the key.

FingerprintSHA1
String

Contains the SHA-1 fingerprint (hash) of the key.

FingerprintSHA256
String

Contains the SHA-256 fingerprint (hash) of the key.

Handle
Int64

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

IsExtractable
Boolean

Whether the key is extractable (e.g., from a security token), or not.

IsPrivate
Boolean

Whether this key is a private key or not.

IsPublic
Boolean

Whether this key is a public key or not.

KDFRounds
Integer

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

KDFSalt
TBytes

The salt value used by the Key Derivation Function (KDF) to generate this key.

KeyFormat
TsbxSSHKeyFormats