PublicKey Xojo Plugin Reference Documentation

PublicKey

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

Dim publicKey As New Chilkat.PublicKey

Properties

DebugLogFilePath As String

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.

KeySize As Int32 (read-only)

Introduced in version 9.5.0.67

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

KeyType As String (read-only)

Introduced in version 9.5.0.52

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

LastErrorHtml As String (read-only)

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.

LastErrorText As String (read-only)

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

LastErrorXml As String (read-only)

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.

LastMethodSuccess As Boolean

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.

VerboseLogging As Boolean

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.

Version As String (read-only)

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

Methods

Function GetDer(preferPkcs1 As Boolean) As MemoryBlock

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 Nil on failure

Function GetEncoded(preferPkcs1 As Boolean, encoding As String) As String

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 Nil on failure

Function GetJwk() As String

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 Nil on failure

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

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

Function GetJwkThumbprint(hashAlg As String) As String

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 Nil on failure

Compute JWK Thumbprint for RSA and EC Public Keys

Function GetOpenSslDer() As MemoryBlock

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 Nil on failure

Function GetOpenSslPem() As String

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 Nil on failure

Function GetPem(preferPkcs1 As Boolean) As String

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 Nil on failure

Function GetPkcs1ENC(encoding As String) As String

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 Nil on failure

Supported Binary Encodings

Function GetPkcs8ENC(encoding As String) As String

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 Nil on failure

Supported Binary Encodings

Function GetRsaDer() As MemoryBlock

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 Nil on failure

Function GetXml() As String

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 Nil on failure

Function LoadBase64(keyStr As String) As Boolean

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.

Function LoadFromBinary(keyBytes As MemoryBlock) As Boolean

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.

Function LoadFromFile(path As String) As Boolean

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.

Function LoadFromString(keyString As String) As Boolean

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.

Function LoadOpenSslDer(data As MemoryBlock) As Boolean

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.

Function LoadOpenSslDerFile(path As String) As Boolean

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.

Function LoadOpenSslPem(str As String) As Boolean

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.

Function LoadOpenSslPemFile(path As String) As Boolean

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.

Function LoadPkcs1Pem(str As String) As Boolean

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.

Function LoadRsaDer(data As MemoryBlock) As Boolean

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.

Function LoadRsaDerFile(path As String) As Boolean

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.

Function LoadXml(xml As String) As Boolean

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.

Function LoadXmlFile(path As String) As Boolean

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.

Function SaveDerFile(preferPkcs1 As Boolean, path As String) As Boolean

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.

Function SaveLastError(path As String) As Boolean

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

Returns True for success, False for failure.

Function SaveOpenSslDerFile(path As String) As Boolean

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.

Function SaveOpenSslPemFile(path As String) As Boolean

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

Function SavePemFile(preferPkcs1 As Boolean, path As String) As Boolean

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

Function SaveRsaDerFile(path As String) As Boolean

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.

Function SaveXmlFile(path As String) As Boolean

Saves the public key to an XML file.

Returns True for success, False for failure.