PublicKey PureBasic 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

obj.i = CkPublicKey::ckCreate()

; Make sure to dispose of the object when finished like this:
CkPublicKey::ckDispose(obj);

Properties

Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

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.

Declare.i ckKeySize(obj.i) ; (read-only)

Introduced in version 9.5.0.67

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

Declare.s ckKeyType(obj.i) ; (read-only)

Introduced in version 9.5.0.52

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

Declare.s ckLastErrorHtml(obj.i) ; (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.

Declare.s ckLastErrorText(obj.i) ; (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

Declare.s ckLastErrorXml(obj.i) ; (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.

Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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.

Declare.s ckVersion(obj.i) ; (read-only)

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

Methods

Declare.s ckGetEncoded(obj.i, preferPkcs1.l, encoding.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.s ckGetJwk(obj.i)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

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

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

Declare.s ckGetJwkThumbprint(obj.i, hashAlg.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

Compute JWK Thumbprint for RSA and EC Public Keys

Declare.s ckGetOpenSslPem(obj.i)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.s ckGetPem(obj.i, preferPkcs1.l)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.s ckGetPkcs1ENC(obj.i, encoding.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

Supported Binary Encodings

Declare.s ckGetPkcs8ENC(obj.i, encoding.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

Supported Binary Encodings

Declare.s ckGetXml(obj.i)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.i ckLoadBase64(obj.i, keyStr.s)

Introduced in version 9.5.0.47

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

Returns 1 for success, 0 for failure.

Declare.i ckLoadFromFile(obj.i, path.s)

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 1 for success, 0 for failure.

Declare.i ckLoadFromString(obj.i, keyString.s)

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 1 for success, 0 for failure.

Declare.i ckLoadOpenSslDerFile(obj.i, path.s)

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 1 for success, 0 for failure.

Declare.i ckLoadOpenSslPem(obj.i, str.s)

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 1 for success, 0 for failure.

Declare.i ckLoadOpenSslPemFile(obj.i, path.s)

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 1 for success, 0 for failure.

Declare.i ckLoadPkcs1Pem(obj.i, str.s)

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.

Declare.i ckLoadRsaDerFile(obj.i, path.s)

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 1 for success, 0 for failure.

Declare.i ckLoadXml(obj.i, xml.s)

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 1 for success, 0 for failure.

Declare.i ckLoadXmlFile(obj.i, path.s)

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 1 for success, 0 for failure.

Declare.i ckSaveDerFile(obj.i, preferPkcs1.l, path.s)

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 1 for success, 0 for failure.

Declare.i ckSaveLastError(obj.i, path.s)

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

Returns 1 for success, 0 for failure.

Declare.i ckSaveOpenSslDerFile(obj.i, path.s)

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 1 for success, 0 for failure.

Declare.i ckSaveOpenSslPemFile(obj.i, path.s)

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 1 for success, 0 for failure.

Generate RSA Public/Private Key Pair and Export to PEM

Declare.i ckSavePemFile(obj.i, preferPkcs1.l, path.s)

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 1 for success, 0 for failure.

Convert RSA Private Key to Public Key

Declare.i ckSaveRsaDerFile(obj.i, path.s)

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 1 for success, 0 for failure.

Declare.i ckSaveXmlFile(obj.i, path.s)

Saves the public key to an XML file.

Returns 1 for success, 0 for failure.