PublicKey Ruby Reference Documentation
CkPublicKey
Current Version: 10.1.0
Contains an RSA, DSA, or ECC public key. Provides methods for importing and exporting to/from PEM, DER, PKCS8, PKCS1, and XML formats. Public keys can be imported/exported to both memory and files.
Object Creation
obj = Chilkat::CkPublicKey.new()
Properties
DebugLogFilePath
# ckStr is a CkString
publicKey.get_DebugLogFilePath(ckStr);
strVal = publicKey.debugLogFilePath();
publicKey.put_DebugLogFilePath(strVal);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
Empty
boolVal = publicKey.get_Empty();
Indicates whether this object is empty or holds a public key.
topKeySize
intVal = publicKey.get_KeySize();
Gets the size (in bits) of the public key. For example: 1024, 2048, etc.
topKeyType
# ckStr is a CkString
publicKey.get_KeyType(ckStr);
strVal = publicKey.keyType();
The type of public key. Can be "empty", "rsa", "dsa", or "ecc".
topLastErrorHtml
# ckStr is a CkString
publicKey.get_LastErrorHtml(ckStr);
strVal = publicKey.lastErrorHtml();
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
# ckStr is a CkString
publicKey.get_LastErrorText(ckStr);
strVal = publicKey.lastErrorText();
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
# ckStr is a CkString
publicKey.get_LastErrorXml(ckStr);
strVal = publicKey.lastErrorXml();
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
boolVal = publicKey.get_LastMethodSuccess();
publicKey.put_LastMethodSuccess(boolVal);
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
topUtf8
boolVal = publicKey.get_Utf8();
publicKey.put_Utf8(boolVal);
When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.
topVerboseLogging
boolVal = publicKey.get_VerboseLogging();
publicKey.put_VerboseLogging(boolVal);
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
# ckStr is a CkString
publicKey.get_Version(ckStr);
strVal = publicKey.version();
Methods
GetDer
# outBytes is a CkByteData (output)
status = publicKey.GetDer(preferPkcs1, outData);
Returns the public key in binary DER format. If the key type (such as RSA) supports both PKCS1 and PKCS8 formats, then preferPkcs1 determine which format is returned.
Returns true for success, false for failure.
topGetEncoded
# encoding is a string
# outStr is a CkString (output)
status = publicKey.GetEncoded(preferPkcs1, encoding, outStr);
retStr = publicKey.getEncoded(preferPkcs1, encoding);
Returns the public key in DER format as an encoded string (such as base64 or hex). If the key type (such as RSA) supports both PKCS1 and PKCS8 formats, then preferPkcs1 determine which format is returned. The encoding specifies the encoding, which is typically "base64".
Returns true for success, false for failure.
topGetJwk
Gets the public key in JWK (JSON Web Key) format.
RSA public keys have this JWK format:
{"kty":"RSA", "n": "0vx7agoebGcQSuuPiLJXZptN9 ... U8awapJzKnqDKgw", "e":"AQAB"}
ECC public keys have this JWK format:
{"kty":"EC", "crv":"P-256", "x":"MKBCTNIcKUSDii11ySs3526iDZ8AiTo7Tu6KPAqv7D4", "y":"4Etl6SRW2YiLUrN5vfvVHuhp7x8PxltmWWlbbM4IFyM"}
Ed25519 public keys (added in v9.5.0.83) have this JWK format:
{"kty":"OKP", "crv":"Ed25519", "x": "SE2Kne5xt51z1eciMH2T2ftDQp96Gl6FhY6zSQujiP0"}
Returns true for success, false for failure.
GetJwkThumbprint
# outStr is a CkString (output)
status = publicKey.GetJwkThumbprint(hashAlg, outStr);
retStr = publicKey.getJwkThumbprint(hashAlg);
Returns the JWK thumbprint for the public key. This is the thumbprint of the JSON Web Key (JWK) as per RFC 7638.
Returns true for success, false for failure.
GetPem
# outStr is a CkString (output)
status = publicKey.GetPem(preferPkcs1, outStr);
retStr = publicKey.getPem(preferPkcs1);
Returns the public key in PEM format. If the key type (such as RSA) supports both PKCS1 and PKCS8 formats, then preferPkcs1 determine which format is returned.
Returns true for success, false for failure.
topGetXml
Gets the public key in XML format. The format depends on the key type. The key parts indicated by "..." are base64 encoded.
RSA public keys have this XML format:
<RSAPublicKey> <Modulus>...</Modulus> <Exponent>...</Exponent> </RSAPublicKey>
DSA public keys have this XML format:
<DSAPublicKey> <P>...</P> <Q>...</Q> <G>...</G> <Y>...</Y> </DSAPublicKey>
ECC public keys have this XML format:
<ECCPublicKey curve="CURVE_NAME" x="HEX_DATA" y="HEX_DATA">...</ECCPublicKey>
Returns true for success, false for failure.
topLoadBase64
status = publicKey.LoadBase64(keyStr);
Loads a public key from base64-encoded DER (can be PKCS1 or PKCS8).
Returns true for success, false for failure.
topLoadBd
Loads a public key from any binary or string format where the data is contained in bd. Chilkat automatically recognizes the format and key type (RSA, EC, DSA, Ed25519, ..)
Returns true for success, false for failure.
topLoadEcdsa
# Qx is a string
# Qy is a string
status = publicKey.LoadEcdsa(curveName, Qx, Qy);
Loads an ECDSA public key directly from Qx, Qy values specified as a hex strings. The curveName can be one of the following:
- secp256r1
- secp384r1
- secp521r1
- secp256k1
- secp192r1
- secp224r1
- brainpoolp256r1
- brainpoolp160r1
- brainpoolp192r1
- brainpoolp224r1
- brainpoolp320r1
- brainpoolp384r1
- brainpoolp512r1
Note: ECDSA public keys of various formats, such as PKCS8, PKCS1, JWK, XML, binary DER, PEM, etc., can be loaded using the LoadBd, LoadFromBinary, LoadFromFile, and LoadFromString methods.
Returns true for success, false for failure.
LoadEd25519
status = publicKey.LoadEd25519(pubKey);
Loads the public key object from a 32-byte ed25519 key specified as a hex string.
Returns true for success, false for failure.
topLoadFromBinary
Loads a public key from binary DER. Auto-recognizes both PKCS1 and PKCS8 formats.
Returns true for success, false for failure.
topLoadFromFile
status = publicKey.LoadFromFile(path);
Loads a public key from a file. The file can be in any string or binary format such as binary DER (PKCS1 or PKCS8), PEM, XML, or encoded binary DER (such as base64 encoded binary DER). The format of the contents of the file is auto-recognized.
Starting in version 9.5.0.66, this method also supports loading the JWK (JSON Web Key) format.
Returns true for success, false for failure.
topLoadFromString
status = publicKey.LoadFromString(keyString);
Loads a public key from any string format, such as PEM, XML, or encoded binary DER (such as base64 encoded binary DER). The format of the keyString is auto-recognized.
Starting in version 9.5.0.66, this method also supports loading the JWK (JSON Web Key) format.
Returns true for success, false for failure.
SaveDerFile
# path is a string
status = publicKey.SaveDerFile(preferPkcs1, path);
Saves the public key to a file in binary DER format. If the key type (such as RSA) supports both PKCS1 and PKCS8 formats, then preferPkcs1 determine which format is returned.
Returns true for success, false for failure.
topSavePemFile
# path is a string
status = publicKey.SavePemFile(preferPkcs1, path);
Saves the public key to a file in PEM format. If the key type (such as RSA) supports both PKCS1 and PKCS8 formats, then preferPkcs1 determine which format is returned.
Returns true for success, false for failure.
SaveXmlFile
status = publicKey.SaveXmlFile(path);