PublicKey Tcl Reference Documentation

PublicKey

Current Version: 9.5.0.97

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

set myPublicKey [new CkPublicKey]

Properties

DebugLogFilePath
string
# ckStr is a CkString
CkPublicKey_get_DebugLogFilePath $myPublicKey $ckStr
set strVal [CkPublicKey_get_debugLogFilePath $myPublicKey]
CkPublicKey_put_DebugLogFilePath $myPublicKey $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.

top
Empty
boolean 1/0
set boolVal [CkPublicKey_get_Empty $myPublicKey]
Introduced in version 9.5.0.87

Indicates whether this object is empty or holds a public key.

top
KeySize
integer
set intVal [CkPublicKey_get_KeySize $myPublicKey]
Introduced in version 9.5.0.67

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

top
KeyType
string
# ckStr is a CkString
CkPublicKey_get_KeyType $myPublicKey $ckStr
set strVal [CkPublicKey_get_keyType $myPublicKey]
Introduced in version 9.5.0.52

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

top
LastErrorHtml
string
# ckStr is a CkString
CkPublicKey_get_LastErrorHtml $myPublicKey $ckStr
set strVal [CkPublicKey_get_lastErrorHtml $myPublicKey]

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.

top
LastErrorText
string
# ckStr is a CkString
CkPublicKey_get_LastErrorText $myPublicKey $ckStr
set strVal [CkPublicKey_get_lastErrorText $myPublicKey]

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.

top
LastErrorXml
string
# ckStr is a CkString
CkPublicKey_get_LastErrorXml $myPublicKey $ckStr
set strVal [CkPublicKey_get_lastErrorXml $myPublicKey]

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.

top
LastMethodSuccess
boolean 1/0
set boolVal [CkPublicKey_get_LastMethodSuccess $myPublicKey]
CkPublicKey_put_LastMethodSuccess $myPublicKey $boolVal

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.

top
Utf8
boolean 1/0
set boolVal [CkPublicKey_get_Utf8 $myPublicKey]
CkPublicKey_put_Utf8 $myPublicKey $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top
VerboseLogging
boolean 1/0
set boolVal [CkPublicKey_get_VerboseLogging $myPublicKey]
CkPublicKey_put_VerboseLogging $myPublicKey $boolVal

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.

top
Version
string
# ckStr is a CkString
CkPublicKey_get_Version $myPublicKey $ckStr
set strVal [CkPublicKey_get_version $myPublicKey]

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

More Information and Examples
top

Methods

GetDer
# preferPkcs1 is a boolean
# outBytes is a CkByteData (output)
set status [CkPublicKey_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 1 for success, 0 for failure.

top
GetEncoded
# preferPkcs1 is a boolean
# encoding is a string
# outStr is a CkString (output)
set status [CkPublicKey_GetEncoded $preferPkcs1 $encoding $outStr]
set retStr [CkPublicKey_getEncoded $myPublicKey $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 1 for success, 0 for failure.

top
GetJwk
# outStr is a CkString (output)
set status [CkPublicKey_GetJwk $outStr]
set retStr [CkPublicKey_getJwk $myPublicKey]
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"}

Ed25519 public keys (added in v9.5.0.83) have this JWK format:

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

Returns 1 for success, 0 for failure.

top
GetJwkThumbprint
# hashAlg is a string
# outStr is a CkString (output)
set status [CkPublicKey_GetJwkThumbprint $hashAlg $outStr]
set retStr [CkPublicKey_getJwkThumbprint $myPublicKey $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 1 for success, 0 for failure.

top
GetPem
# preferPkcs1 is a boolean
# outStr is a CkString (output)
set status [CkPublicKey_GetPem $preferPkcs1 $outStr]
set retStr [CkPublicKey_getPem $myPublicKey $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 1 for success, 0 for failure.

top
GetXml
# outStr is a CkString (output)
set status [CkPublicKey_GetXml $outStr]
set retStr [CkPublicKey_getXml $myPublicKey]

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

top
LoadBase64
# keyStr is a string
set status [CkPublicKey_LoadBase64 $keyStr]
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.

top
LoadBd
# bd is a CkBinData
set status [CkPublicKey_LoadBd $bd]
Introduced in version 9.5.0.83

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

top
LoadEcdsa
# curveName is a string
# Qx is a string
# Qy is a string
set status [CkPublicKey_LoadEcdsa $curveName $Qx $Qy]
Introduced in version 9.5.0.85

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

More Information and Examples
top
LoadEd25519
# pubKey is a string
set status [CkPublicKey_LoadEd25519 $pubKey]
Introduced in version 9.5.0.83

Loads the public key object from a 32-byte ed25519 key specified as a hex string.

Returns 1 for success, 0 for failure.

top
LoadFromBinary
# keyBytes is a CkByteData
set status [CkPublicKey_LoadFromBinary $keyBytes]
Introduced in version 9.5.0.58

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

Returns 1 for success, 0 for failure.

top
LoadFromFile
# path is a string
set status [CkPublicKey_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 1 for success, 0 for failure.

top
LoadFromString
# keyString is a string
set status [CkPublicKey_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 1 for success, 0 for failure.

More Information and Examples
top
SaveDerFile
# preferPkcs1 is a boolean
# path is a string
set status [CkPublicKey_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 1 for success, 0 for failure.

top
SavePemFile
# preferPkcs1 is a boolean
# path is a string
set status [CkPublicKey_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 1 for success, 0 for failure.

More Information and Examples
top
SaveXmlFile
# path is a string
set status [CkPublicKey_SaveXmlFile $path]

Saves the public key to an XML file.

Returns 1 for success, 0 for failure.

top