PublicKey Swift Reference Documentation

CkoPublicKey

Current Version: 10.1.0

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

let obj = CkoPublicKey()!

Properties

DebugLogFilePath
debugLogFilePath: String!

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.

More Information and Examples
top
Empty
empty: Bool (read-only)
Introduced in version 9.5.0.87

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

top
KeySize
keySize: Int (read-only)
Introduced in version 9.5.0.67

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

top
KeyType
keyType: String! (read-only)
Introduced in version 9.5.0.52

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

top
LastErrorHtml
lastErrorHtml: String! (read-only)

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.

top
LastErrorText
lastErrorText: String! (read-only)

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.

top
LastErrorXml
lastErrorXml: String! (read-only)

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.

top
LastMethodSuccess
lastMethodSuccess: Bool

Indicates the success or failure of the most recent method call: true means success, false 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.

top
VerboseLogging
verboseLogging: Bool

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.

top
Version
version: String! (read-only)

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

More Information and Examples
top

Methods

GetDer
getDer(preferPkcs1: Bool) -> NSData
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

top
GetEncoded
getEncoded(preferPkcs1: Bool, encoding: String) -> 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

top
GetJwk
getJwk() -> 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"}

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

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

Returns nil on failure

top
GetJwkThumbprint
getJwkThumbprint(hashAlg: String) -> 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

top
GetPem
getPem(preferPkcs1: Bool) -> 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

top
GetXml
getXml() -> 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:

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

top
LoadBase64
loadBase64(keyStr: String) -> Bool
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.

top
LoadBd
loadBd(bd: CkoBinData) -> Bool
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 true for success, false for failure.

top
LoadEcdsa
loadEcdsa(curveName: String, qx: String, qy: String) -> Bool
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 true for success, false for failure.

More Information and Examples
top
LoadEd25519
loadEd25519(pubKey: String) -> Bool
Introduced in version 9.5.0.83

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

Returns true for success, false for failure.

top
LoadFromBinary
load(fromBinary: NSData) -> Bool
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.

top
LoadFromFile
load(fromFile: String) -> Bool
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.

top
LoadFromString
load(from: String) -> Bool
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.

More Information and Examples
top
SaveDerFile
saveDerFile(preferPkcs1: Bool, path: String) -> Bool
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.

top
SavePemFile
savePemFile(preferPkcs1: Bool, path: String) -> Bool
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.

More Information and Examples
top
SaveXmlFile
saveXmlFile(path: String) -> Bool

Saves the public key to an XML file.

Returns true for success, false for failure.

top