PublicKey

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.

Returns 1 if no public key is currently loaded, and 0 if this object contains a public key. A newly constructed PublicKey object is empty.

A PublicKey object holds at most one key. Every successful load replaces the current key. Every failed load clears the object; a previously loaded key is never preserved after a load failure.

Returns the key size in bits. The meaning is algorithm-specific:

Returns the type of public key currently held by this object.

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.

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.

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.

Indicates the success or failure of the most recent method call: 1 means success, 0 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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

When set to 1, all string arguments and return values are interpreted as UTF-8 strings. When set to 0, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is 1. Before v11.0.0, it was 0.

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

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

Writes the public key as binary DER to bd. preferPkcs1 selects the representation using the same RSA, EC, DSA, and Ed25519 rules described for GetDer.

bd is replaced; data already present in the BinData is not appended to. If the method fails, including when this object is empty, bd is cleared.

Returns 1 for success, 0 for failure.

Returns the DER representation selected by preferPkcs1, encoded as text using the binary encoding named by encoding. The DER-selection rules are the same as for GetDer.

Encoding names are case-insensitive. See the Chilkat Binary Encoding List for the complete set of supported encoding names. An empty or unsupported encoding name causes the method to fail. The method also fails if this object is empty.

Returns 1 for success, 0 for failure.

Returns the public key as a compact JWK (JSON Web Key). Binary values use Base64url encoding without padding. Repeated calls for the same key produce the same compact member order.

RSA:

{"kty":"RSA","n":"BASE64URL_MODULUS","e":"BASE64URL_EXPONENT"}

EC:

{"kty":"EC","crv":"P-256","x":"BASE64URL_X","y":"BASE64URL_Y"}

Ed25519:

{"kty":"OKP","crv":"Ed25519","x":"BASE64URL_PUBLIC_KEY"}

Only public key parameters are emitted. Private members and optional JWK metadata are not included. The method fails if this object is empty or if the loaded key type cannot be represented as a supported JWK.

Returns 1 for success, 0 for failure.

Returns the RFC 7638 JWK thumbprint for this public key. Chilkat constructs the required canonical JSON object from the public JWK members, hashes its UTF-8 representation using the algorithm named by hashAlg, and returns the digest using Base64url encoding without padding.

Accepted algorithm names are md5, sha1, sha256, sha384, and sha512. Names are case-insensitive. An empty or unsupported algorithm name causes the method to fail. sha256 is the conventional choice for RFC 7638 thumbprints.

The method fails if this object is empty or if the key cannot be represented as a supported JWK.

Returns 1 for success, 0 for failure.

Returns the public key in PEM format. preferPkcs1 selects the underlying DER representation as follows:

PEM output uses CRLF line endings, Base64 body lines of at most 64 characters, and a final CRLF after the closing boundary line. The method fails if this object is empty.

Returns 1 for success, 0 for failure.

Returns the public key in Chilkat XML format. The exact representation depends on the key type.

RSA:

<RSAPublicKey><Modulus>BASE64_MODULUS</Modulus><Exponent>BASE64_EXPONENT</Exponent></RSAPublicKey>

DSA:

<DSAPublicKey>
  <P>BASE64_P</P>
  <Q>BASE64_Q</Q>
  <G>BASE64_G</G>
  <Y>BASE64_Y</Y>
</DSAPublicKey>

EC:

<ECCPublicKey curve="secp256r1" x="UPPERCASE_HEX_X" y="UPPERCASE_HEX_Y">BASE64_DER</ECCPublicKey>

For EC keys, the curve attribute contains the Chilkat curve name, the x and y attributes contain full-width uppercase hexadecimal coordinates, and the element text contains a Base64-encoded DER public-key structure with explicit curve parameters.

Ed25519:

<Ed25519PublicKey>BASE64_32_BYTE_PUBLIC_KEY</Ed25519PublicKey>

The returned XML can be loaded by LoadFromString, LoadFromFile, or LoadBd. The method fails if this object is empty.

Returns 1 for success, 0 for failure.

Loads a public key from standard Base64-encoded DER in keyStr. Whitespace within the Base64 text is permitted. The decoded DER is inspected to determine the key type and structure. For RSA, both PKCS #1 RSAPublicKey and X.509 SubjectPublicKeyInfo are recognized.

A complete PEM string is also accepted, including its BEGIN/END boundary lines. Base64url text, arbitrary non-PEM text surrounding the encoded data, X.509 certificates, and encrypted private keys are not accepted.

A successful load replaces the current key. A failed load clears this object.

Returns 1 for success, 0 for failure.

Loads a public key from the data in bd. The BinData may contain binary DER or any textual representation recognized by LoadFromString, including PEM, Chilkat XML, JWK, standard Base64 DER, and supported RFC 4716 SSH2 public-key blocks.

Public keys and unencrypted private keys are accepted; when private-key material is supplied, only the public portion is retained. For binary DER, the first recognized DER object is loaded and trailing bytes are ignored. Hex-encoded DER, Base64url-encoded DER, one-line OpenSSH public keys, X.509 certificates, and encrypted private keys are not recognized.

JWK required-member and metadata behavior is the same as described for LoadFromString. A successful load replaces the current key. A failed load clears this object.

Returns 1 for success, 0 for failure.

Loads an elliptic-curve public key directly from its affine point coordinates. curveName names the curve, Qx is the hexadecimal x-coordinate (Qx), and Qy is the hexadecimal y-coordinate (Qy).

The coordinate strings must contain exactly the full field width for the selected curve. Uppercase and lowercase hexadecimal are accepted. A 0x prefix, whitespace, separators, extra leading zero bytes, shortened coordinates, non-hexadecimal characters, empty values, and all-zero coordinates are rejected. Curve names are case-insensitive.

A successful load replaces the current key. A failed load clears this object. The method validates syntax, coordinate width, and obvious zero values, but it does not fully verify that the supplied coordinates form a point on the named curve.

Returns 1 for success, 0 for failure.

Loads a raw Ed25519 public key from the hexadecimal string in pubKey. pubKey must contain exactly 64 hexadecimal characters representing 32 bytes. Uppercase and lowercase hexadecimal are accepted.

A 0x prefix, whitespace, separators, non-hexadecimal characters, odd-length input, and values shorter or longer than 32 bytes are rejected. A successful load replaces the current key; a failed load clears this object.

This method validates the hexadecimal syntax and exact byte count. It does not determine whether every 32-byte value is a usable Ed25519 public point; for example, an all-zero 32-byte value is accepted.

Returns 1 for success, 0 for failure.

Loads a public key from the local filesystem path specified by path. Chilkat examines the file contents rather than the filename extension. Supported content includes binary DER, PEM, Chilkat XML, JWK, standard Base64 DER, and RFC 4716 SSH2 public-key blocks for supported RSA and Ed25519 keys.

Public keys and unencrypted private keys are accepted. When private-key material is supplied, only the public portion is retained. Hex-encoded DER, Base64url-encoded DER, one-line OpenSSH public keys, X.509 certificates, and encrypted private keys are not recognized.

For PEM files, UTF-8 BOMs, CRLF or LF line endings, surrounding text, and unrelated PEM blocks are tolerated. If multiple recognized key blocks are present, the first recognized key is loaded. For binary DER, the first recognized DER object is loaded and trailing bytes are ignored.

JWK required-member and metadata behavior is the same as described for LoadFromString. A successful load replaces the current key. A failed load clears this object.

Returns 1 for success, 0 for failure.

Loads a public key from the string in keyString. Chilkat examines the content and recognizes these textual representations:

• PEM public keys.
• Unencrypted PEM private keys, from which only the public portion is retained.
• Chilkat XML public or private keys.
• Public or private JWK.
• Standard Base64-encoded DER.
• RFC 4716 SSH2 public-key blocks for supported RSA and Ed25519 keys.

Hex-encoded DER, Base64url-encoded DER, one-line OpenSSH forms such as ssh-rsa ... and ssh-ed25519 ..., X.509 certificates, and encrypted private keys are not recognized.

For PEM input, UTF-8 BOMs, CRLF or LF line endings, leading and trailing whitespace, unrelated surrounding text, and unrelated PEM blocks are tolerated. If multiple recognized key blocks are present, the first recognized key is loaded.

For JWK input, required public members must be present. Private members such as d may be present but are discarded. Optional metadata such as kid, use, alg, key_ops, and x5c is not retained.

A successful load replaces the current key. A failed load clears this object.

Returns 1 for success, 0 for failure.

Saves the public key to path as binary DER. preferPkcs1 selects the representation using the same RSA, EC, and Ed25519 rules described for GetDer.

An existing destination file is overwritten. Parent directories are not created automatically. The method fails if path names a directory. If this object is empty, the method fails without creating the file.

Returns 1 for success, 0 for failure.

Saves the public key to path in PEM format. preferPkcs1 selects the representation and PEM label using the same rules described for GetPem.

The generated file uses CRLF line endings, Base64 body lines of at most 64 characters, and a final CRLF. An existing destination file is overwritten. If this object is empty, the method fails without creating the file.

Returns 1 for success, 0 for failure.

Saves the public key to the local filesystem path specified by path using exactly the same key-type-specific XML text returned by GetXml. No additional BOM or line ending is added.

An existing destination file is overwritten. If this object is empty, the method fails without creating the destination file.

Returns 1 for success, 0 for failure.

Returns the public key as binary DER. preferPkcs1 is a historical format-preference flag whose exact effect depends on the key type:

For DSA, Chilkat returns its supported DSA DER representation. The method fails if this object is empty.

Returns 1 for success, 0 for failure.

Loads a public key from binary DER in keyBytes. The DER structure and key type are detected automatically. Public-key DER and unencrypted private-key DER are accepted; when private-key material is supplied, only the public portion is retained.

For RSA, both PKCS #1 RSAPublicKey and X.509 SubjectPublicKeyInfo are recognized. The loader parses the first recognized DER object and ignores trailing bytes, including a second concatenated DER object.

A successful load replaces the current key. A failed load clears this object.

Returns 1 for success, 0 for failure.