Dh ActiveX Reference Documentation

Dh

Diffie-Hellman key-exchange component.

Diffie-Hellman (D-H) key exchange is a cryptographic protocol that allows two parties that have no prior knowledge of each other to jointly establish a shared secret key over an insecure communications channel. This key can then be used to encrypt subsequent communications using a symmetric key cipher.

Synonyms of Diffie-Hellman key exchange include:

  • Diffie-Hellman key agreement
  • Diffie-Hellman key establishment
  • Diffie-Hellman key negotiation
  • exponential key exchange

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatDh

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.Dh")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.Dh")

(Delphi)
obj := TChilkatDh.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.Dh')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.Dh")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Dh', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.Dh");

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.

G As Long (read-only)

The generator. The value of G should be either 2 or 5.

LastBinaryResult As Variant (read-only)

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

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 Long

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.

LastStringResult As String (read-only)

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen As Long (read-only)

Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

P As String (read-only)

A "safe" large prime returned as a hex string. The hex string represent a bignum in SSH1 format.

VerboseLogging As Long

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 As String (read-only)

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

Methods

CreateE(ByVal numBits As Long) As String

The 1st step in Diffie-Hellman key exchange (to generate a shared-secret). The numBits should be twice the size (in bits) of the shared secret to be generated. For example, if you are using DH to create a 128-bit AES session key, then numBits should be set to 256. Returns E as a bignum in SSH-format as a hex string.

Returns Nothing on failure

(Classic ASP) Diffie-Hellman Key Exchange (DH)

(Visual FoxPro) Diffie-Hellman Key Exchange (DH)

(PowerBuilder) Diffie-Hellman Key Exchange (DH)

(SQL Server) Diffie-Hellman Key Exchange (DH)

(Visual Basic 6.0) Diffie-Hellman Key Exchange (DH)

(VBScript) Diffie-Hellman Key Exchange (DH)

FindK(E As String) As String

The 2nd and final step in Diffie-Hellman (DH) key exchange. E is the E created by the other party. Returns the shared secret (K) as an SSH1-format bignum encoded as a hex string.

Returns Nothing on failure

(Classic ASP) Diffie-Hellman Key Exchange (DH)

(Visual FoxPro) Diffie-Hellman Key Exchange (DH)

(PowerBuilder) Diffie-Hellman Key Exchange (DH)

(SQL Server) Diffie-Hellman Key Exchange (DH)

(Visual Basic 6.0) Diffie-Hellman Key Exchange (DH)

(VBScript) Diffie-Hellman Key Exchange (DH)

GenPG(ByVal numBits As Long, ByVal G As Long) As Long

Generates a large safe prime that is numBits bits in size using the generator G. Generating a new (random) P is expensive in both time and CPU cycles. A prime should be 1024 or more bits in length.

Returns 1 for success, 0 for failure.

SetPG(p As String, ByVal g As Long) As Long

Sets explicit values for P and G. Returns 1 if P and G conform to the requirements for Diffie-Hellman. P is an SSH1-format bignum passed as a hexidecimalized string.

Returns 1 for success, 0 for failure.

(Classic ASP) Diffie-Hellman Key Exchange (DH)

(Visual FoxPro) Diffie-Hellman Key Exchange (DH)

(PowerBuilder) Diffie-Hellman Key Exchange (DH)

(SQL Server) Diffie-Hellman Key Exchange (DH)

(Visual Basic 6.0) Diffie-Hellman Key Exchange (DH)

(VBScript) Diffie-Hellman Key Exchange (DH)

UnlockComponent(unlockCode As String) As Long

Unlocks the component. This must be called once prior to calling any other method. A fully-functional 30-day trial is automatically started when an arbitrary string is passed to this method. For example, passing "Hello", or "abc123" will unlock the component for the 1st thirty days after the initial install.

Returns 1 for success, 0 for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Purchased Unlock Code

LastErrorText Standard Information

UseKnownPrime(ByVal index As Long)

Sets P and G to a known safe prime. The index may have the following values:

1: First Oakley Default Group from RFC2409, section 6.1. Generator is 2. The prime is: 2^768 - 2 ^704 - 1 + 2^64 * { [2^638 pi] + 149686 }

2: Prime for 2nd Oakley Group (RFC 2409) -- 1024-bit MODP Group. Generator is 2. The prime is: 2^1024 - 2^960 - 1 + 2^64 * { [2^894 pi] + 129093 }.

3: 1536-bit MODP Group from RFC3526, Section 2. Generator is 2. The prime is: 2^1536 - 2^1472 - 1 + 2^64 * { [2^1406 pi] + 741804 }

4: Prime for 14th Oakley Group (RFC 3526) -- 2048-bit MODP Group. Generator is 2. The prime is: 2^2048 - 2^1984 - 1 + 2^64 * { [2^1918 pi] + 124476 }

5: 3072-bit MODP Group from RFC3526, Section 4. Generator is 2. The prime is: 2^3072 - 2^3008 - 1 + 2^64 * { [2^2942 pi] + 1690314 }

6: 4096-bit MODP Group from RFC3526, Section 5. Generator is 2. The prime is: 2^4096 - 2^4032 - 1 + 2^64 * { [2^3966 pi] + 240904 }

7: 6144-bit MODP Group from RFC3526, Section 6. Generator is 2. The prime is: 2^6144 - 2^6080 - 1 + 2^64 * { [2^6014 pi] + 929484 }

8: 8192-bit MODP Group from RFC3526, Section 7. Generator is 2. The prime is: 2^8192 - 2^8128 - 1 + 2^64 * { [2^8062 pi] + 4743158 }

(Classic ASP) Diffie-Hellman Key Exchange (DH)

(Visual FoxPro) Diffie-Hellman Key Exchange (DH)

(PowerBuilder) Diffie-Hellman Key Exchange (DH)

(SQL Server) Diffie-Hellman Key Exchange (DH)

(Visual Basic 6.0) Diffie-Hellman Key Exchange (DH)

(VBScript) Diffie-Hellman Key Exchange (DH)