# 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

algorithmString |
Specifies the key algorithm. | |||||||||||||||||||||||||||

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

commentString |
The comment for the public key. | |||||||||||||||||||||||||||

curveString |
Specifies the elliptical curve when EC cryptography is used. | |||||||||||||||||||||||||||

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

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

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

dssxData |
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). | |||||||||||||||||||||||||||

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

eccdData |
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. | |||||||||||||||||||||||||||

eccqxData |
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. | |||||||||||||||||||||||||||

eccqyData |
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. | |||||||||||||||||||||||||||

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

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

fingerprintMD5String |
Contains the MD5 fingerprint (hash) of the key. | |||||||||||||||||||||||||||

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

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

handleInt64 |
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()); | |||||||||||||||||||||||||||

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

isPrivateBool |
Whether this key is a private key or not. | |||||||||||||||||||||||||||

isPublicBool |
Whether this key is a public key or not. | |||||||||||||||||||||||||||

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

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

keyFormatSSHKeyFormats |
Specifies the format in which the key is stored.
| |||||||||||||||||||||||||||

keyProtectionAlgorithmString |
Specifies the key protection algorithm. | |||||||||||||||||||||||||||

rsaExponentData |
Returns the e parameter (public exponent) of the RSA key. | |||||||||||||||||||||||||||

rsaiqmpData |
Returns the iqmp parameter of the RSA key. | |||||||||||||||||||||||||||

rsaModulusData |
Returns the m parameter (public modulus) of the RSA key. | |||||||||||||||||||||||||||

rsapData |
Returns the p parameter (first factor of the common modulus n) of the RSA key. | |||||||||||||||||||||||||||

rsaPrivateExponentData |
Returns the d parameter (private exponent) of the RSA key. | |||||||||||||||||||||||||||

rsaqData |
Returns the q parameter (second factor of the common modulus n) of the RSA key. | |||||||||||||||||||||||||||

subjectString |
Specifies the public key owner (subject). This property is used only for IETF-keys. |

## Constructors

public init()

Creates a new key.