CkPublicKey Ruby Reference Documentation

CkPublicKey

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

# strVal is a string
# ckStr is a CkString
publicKey.get_DebugLogFilePath(ckStr);
strVal = publicKey.debugLogFilePath();
publicKey.put_DebugLogFilePath(strVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

# intVal is an integer
intVal = publicKey.get_KeySize();

Introduced in version 9.5.0.67

Gets the size (in bits) of the public key. For example: 1024, 2048, etc.

# strVal is a string
# ckStr is a CkString
publicKey.get_KeyType(ckStr);
strVal = publicKey.keyType();

Introduced in version 9.5.0.52

The type of public key. Can be "empty", "rsa", "dsa", or "ecc".

# strVal is a string
# ckStr is a CkString
publicKey.get_LastErrorHtml(ckStr);
strVal = publicKey.lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

# strVal is a string
# ckStr is a CkString
publicKey.get_LastErrorText(ckStr);
strVal = publicKey.lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

# strVal is a string
# ckStr is a CkString
publicKey.get_LastErrorXml(ckStr);
strVal = publicKey.lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

# boolVal is a boolean
boolVal = publicKey.get_LastMethodSuccess();
publicKey.put_LastMethodSuccess(boolVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

# boolVal is a boolean
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.

# boolVal is a boolean
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.

# strVal is a string
# ckStr is a CkString
publicKey.get_Version(ckStr);
strVal = publicKey.version();

Version of the component/library, such as "9.5.0.63"

Methods

# preferPkcs1 is a boolean
# outBytes is a CkByteData (output)
status = publicKey.GetDer(preferPkcs1, outData);

Introduced in version 9.5.0.58

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.

# preferPkcs1 is a boolean
# encoding is a string
# outStr is a CkString (output)
status = publicKey.GetEncoded(preferPkcs1, encoding, outStr);
retStr = publicKey.getEncoded(preferPkcs1, encoding);

Introduced in version 9.5.0.58

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.

# outStr is a CkString (output)
status = publicKey.GetJwk(outStr);
retStr = publicKey.getJwk();

Introduced in version 9.5.0.66

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"}

Returns true for success, false for failure.

Get ECC Public Key in JWK Format (JSON Web Key)

Get RSA Public Key in JWK Format (JSON Web Key)

# hashAlg is a string
# outStr is a CkString (output)
status = publicKey.GetJwkThumbprint(hashAlg, outStr);
retStr = publicKey.getJwkThumbprint(hashAlg);

Introduced in version 9.5.0.66

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.

Compute JWK Thumbprint for RSA and EC Public Keys

# outData is a CkByteData (output)
status = publicKey.GetOpenSslDer(outData);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call GetDer with preference for PKCS8 instead.

Gets the public key in PKCS8 DER format.

Returns true for success, false for failure.

# outStr is a CkString (output)
status = publicKey.GetOpenSslPem(outStr);
retStr = publicKey.getOpenSslPem();

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call GetPem with preference for PKCS8 instead.

Gets the public key in PKCS8 PEM format.

Returns true for success, false for failure.

# preferPkcs1 is a boolean
# outStr is a CkString (output)
status = publicKey.GetPem(preferPkcs1, outStr);
retStr = publicKey.getPem(preferPkcs1);

Introduced in version 9.5.0.58

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.

# encoding is a string
# outStr is a CkString (output)
status = publicKey.GetPkcs1ENC(encoding, outStr);
retStr = publicKey.getPkcs1ENC(encoding);

Introduced in version 9.5.0.52
This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call GetEncoded with preference for PKCS1 instead.

Gets the public key in PKCS1 format and returns in an encoded string, as specified by the encoding argument.

Returns true for success, false for failure.

Supported Binary Encodings

# encoding is a string
# outStr is a CkString (output)
status = publicKey.GetPkcs8ENC(encoding, outStr);
retStr = publicKey.getPkcs8ENC(encoding);

Introduced in version 9.5.0.52
This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call GetEncoded with preference for PKCS8 instead.

Gets the public key in PKCS8 format and returns in an encoded string, as specified by the encoding argument.

Returns true for success, false for failure.

Supported Binary Encodings

# outData is a CkByteData (output)
status = publicKey.GetRsaDer(outData);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call GetDer with preference for PKCS1 instead.

Gets the public key in PKCS1 DER format.

Returns true for success, false for failure.

# outStr is a CkString (output)
status = publicKey.GetXml(outStr);
retStr = publicKey.getXml();

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:

<RSAKeyValue>
  <Modulus>...</Modulus>
  <Exponent>...</Exponent>
</RSAKeyValue>

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.

# keyStr is a string
status = publicKey.LoadBase64(keyStr);

Introduced in version 9.5.0.47

Loads a public key from base64-encoded DER (can be PKCS1 or PKCS8).

Returns true for success, false for failure.

# keyBytes is a CkByteData
status = publicKey.LoadFromBinary(keyBytes);

Introduced in version 9.5.0.58

Loads a public key from binary DER. Auto-recognizes both PKCS1 and PKCS8 formats.

Returns true for success, false for failure.

# path is a string
status = publicKey.LoadFromFile(path);

Introduced in version 9.5.0.58

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.

# keyString is a string
status = publicKey.LoadFromString(keyString);

Introduced in version 9.5.0.58

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.

# data is a CkByteData
status = publicKey.LoadOpenSslDer(data);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call LoadFromBinary instead.

Loads a public key from in-memory PKCS8 DER formatted byte data.

Returns true for success, false for failure.

# path is a string
status = publicKey.LoadOpenSslDerFile(path);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call LoadFromFile instead.

Loads a public key from an PKCS8 DER format file.

Returns true for success, false for failure.

# str is a string
status = publicKey.LoadOpenSslPem(str);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call LoadFromString instead.

Loads a public key from an PKCS8 PEM string.

Returns true for success, false for failure.

# path is a string
status = publicKey.LoadOpenSslPemFile(path);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call LoadFromFile instead.

Loads a public key from an PKCS8 PEM file.

Returns true for success, false for failure.

# str is a string
retBool = publicKey.LoadPkcs1Pem(str);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call LoadFromString instead.

Loads an RSA public key from PKCS#1 PEM format.

# data is a CkByteData
status = publicKey.LoadRsaDer(data);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call LoadFromBinary instead.

Loads a public key from in-memory PKCS1 DER formatted byte data.

Returns true for success, false for failure.

# path is a string
status = publicKey.LoadRsaDerFile(path);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call LoadFromFile instead.

Loads a public key from an PKCS1 DER formatted file.

Returns true for success, false for failure.

# xml is a string
status = publicKey.LoadXml(xml);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call LoadFromString instead.

Loads a public key from an XML string.

Returns true for success, false for failure.

# path is a string
status = publicKey.LoadXmlFile(path);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call LoadFromFile instead.

Loads a public key from an XML file.

Returns true for success, false for failure.

# preferPkcs1 is a boolean
# path is a string
status = publicKey.SaveDerFile(preferPkcs1, path);

Introduced in version 9.5.0.58

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.

# path is a string
status = publicKey.SaveLastError(path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

# path is a string
status = publicKey.SaveOpenSslDerFile(path);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call SaveDerFile with preference for PKCS8 instead.

Saves the public key to an PKCS8 DER format file.

Returns true for success, false for failure.

# path is a string
status = publicKey.SaveOpenSslPemFile(path);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call SavePemFile with preference for PKCS8 instead.

Saves the public key to an PKCS8 PEM format file.

Returns true for success, false for failure.

Generate RSA Public/Private Key Pair and Export to PEM

# preferPkcs1 is a boolean
# path is a string
status = publicKey.SavePemFile(preferPkcs1, path);

Introduced in version 9.5.0.58

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.

Convert RSA Private Key to Public Key

# path is a string
status = publicKey.SaveRsaDerFile(path);

This method is deprecated. It will be removed in a future version.

This method is deprecated. Applications should call SaveDerFile with preference for PKCS1 instead.

Saves the public key to an PKCS1 DER format file.

Returns true for success, false for failure.

# path is a string
status = publicKey.SaveXmlFile(path);

Saves the public key to an XML file.

Returns true for success, false for failure.