OAuth1 Delphi ActiveX Reference Documentation

TChilkatOAuth1

Current Version: 10.1.2

Requires Chilkat Bundle License

OAuth 1.0a signature generator.

Importing the Chilkat ActiveX into Delphi

Important: When upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.

Chilkat v9.5.*: If using Chilkat v9.5.*, then use "Chilkat_v9_5_0_TLB" instead of "Chilkat_TLB", and the DLLs are named ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll).

Two things are required to use an ActiveX in Delphi:

The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
See also: ActiveX Registration Tutorial
The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_TLB.pas and Chilkat_TLB.dcr. The Chilkat_TLB.pas should be added to your project.

To import the Chilkat type library, do the following:

In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
Find "Chilkat ActiveX" in the list and select it. This will only appear in the list if the ChilkatAx-win32.dll (or ChilkatAx-x64.dll) has been registered w/ regsvr32.
Check the "Generate Component Wrappers" checkbox.
Select a directory where the unit files (.pas and .dcr) should be generated.
Select "Create Unit" and then "Finish".
Add the .pas to your Delphi project.

To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_TLB" to the "uses" statement. For example:

uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
  Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

Object Creation

var
obj: TChilkatOAuth1;
...
begin
obj := TChilkatOAuth1.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

AuthorizationHeader

property AuthorizationHeader: WideString readonly

Introduced in version 9.5.0.53

The authorization header. This is what would be included in the Authorization HTTP request header if it is going to be used as the means for providing the OAuth1 authorization information.

BaseString

property BaseString: WideString readonly

Introduced in version 9.5.0.53

This is the exact string that was signed. For example, if the signature method is HMAC-SHA1, the BaseString is the exact string that passed to the HMAC-SHA1. An application does not set the BaseString property. The BaseString is exposed as a property to allow for debugging and to see the exact string that is signed.

ConsumerKey

property ConsumerKey: WideString

Introduced in version 9.5.0.53

The consumer key.

ConsumerSecret

property ConsumerSecret: WideString

Introduced in version 9.5.0.53

The consumer secret.

DebugLogFilePath

property DebugLogFilePath: WideString

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

Example showing how to use DebugLogFilePath.

EncodedSignature

property EncodedSignature: WideString readonly

Introduced in version 9.5.0.53

The URL encoded representation of the Signature property

GeneratedUrl

property GeneratedUrl: WideString readonly

Introduced in version 9.5.0.53

The URL that includes the OAuth1 query params.

HmacKey

property HmacKey: WideString readonly

Introduced in version 9.5.0.53

The exact HMAC key used to sign the BaseString. An application does not directly set the HmacKey. The HmacKey property is read-only and is provided for debugging to see the exact HMAC key used to sign the BaseString. The HMAC key is composed from the consumer secret (if it exists) and the token secret (if it exists).

LastBinaryResult

property LastBinaryResult: OleVariant readonly

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

LastErrorHtml

property LastErrorHtml: WideString readonly

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.

LastErrorText

property LastErrorText: WideString readonly

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

property LastErrorXml: WideString readonly

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.

LastMethodSuccess

property LastMethodSuccess: Integer

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

LastStringResult

property LastStringResult: WideString readonly

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

property LastStringResultLen: Integer readonly

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

Nonce

property Nonce: WideString

Introduced in version 9.5.0.53

The nonce.

OauthMethod

property OauthMethod: WideString

Introduced in version 9.5.0.53

The HTTP method, such as "GET", "POST", "PUT", "DELETE", or "HEAD". Defaults to "GET".

OauthUrl

property OauthUrl: WideString

Introduced in version 9.5.0.53

The OAuth URL, such as "http://echo.lab.madgex.com/echo.ashx". See http://bettiolo.github.io/oauth-reference-page/ to compare Chilkat results with another tool's results.

Note: The OAuthUrl should not include query parameters. For example, do not set the OAuthUrl equal to

https://rest.sandbox.netsuite.com/app/site/hosting/restlet.nl?script=165&deploy=1

Instead, set OAuthUrl equal to

https://rest.sandbox.netsuite.com/app/site/hosting/restlet.nl

and then subsequently call AddParam for each query parameter.

OauthVersion

property OauthVersion: WideString

Introduced in version 9.5.0.53

The oauth_version. Defaults to "1.0". May be set to the empty string to exclude.

QueryString

property QueryString: WideString readonly

Introduced in version 9.5.0.53

Contains the normalized set of request parameters that are signed. This is a read-only property made available for debugging purposes.

Realm

property Realm: WideString

Introduced in version 9.5.0.70

The realm (optional).

Signature

property Signature: WideString readonly

Introduced in version 9.5.0.53

The generated base64 signature.

SignatureMethod

property SignatureMethod: WideString

Introduced in version 9.5.0.53

The signature method. Defaults to "HMAC-SHA1". Other possible choices are "HMAC-SHA256", "RSA-SHA1", and "RSA-SHA256" (or the equivalent "RSA-SHA2").

More Information and Examples

Generate OAuth 1.0 Signature

Timestamp

property Timestamp: WideString

Introduced in version 9.5.0.53

The timestamp, such as "1441632569".

Token

property Token: WideString

Introduced in version 9.5.0.53

The token.

TokenSecret

property TokenSecret: WideString

Introduced in version 9.5.0.53

The token secret

UncommonOptions

property UncommonOptions: WideString

Introduced in version 9.5.0.85

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.

Can be set to a list of the following comma separated keywords:

"INCLUDE_REALM" - Introduced in v9.5.0.85. Include the Realm in the signature calculation and outputs.

VerboseLogging

property VerboseLogging: Integer

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

property Version: WideString readonly

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddParam

function AddParam(name: WideString; value: WideString): Integer;

Introduced in version 9.5.0.53

Adds an extra name/value parameter to the OAuth1 signature.

Returns 1 for success, 0 for failure.

More Information and Examples

REST OAuth1 with Params

Generate

function Generate(): Integer;

Introduced in version 9.5.0.53

Generate the signature based on the property settings. Input properties are OauthVersion, OauthMethod, Url, ConsumerKey, ConsumerSecret, Token, TokenSecret, Nonce, and Timestamp. Properties set by this method include: BaseString, Signature, HmacKey, EncodedSignature, QueryString, GeneratedUrl, andAuthorizationHeader.

Returns 1 for success, 0 for failure.

More Information and Examples

Generate OAuth 1.0 Signature

GenNonce

function GenNonce(numBytes: Integer): Integer;

Introduced in version 9.5.0.55

Generates a random nonce numBytes in length and sets the Nonce property to the hex encoded value.

Returns 1 for success, 0 for failure.

GenTimestamp

function GenTimestamp(): Integer;

Introduced in version 9.5.0.55

Sets the Timestamp property to the current date/time.

Returns 1 for success, 0 for failure.

RemoveParam

function RemoveParam(name: WideString): Integer;

Introduced in version 9.5.0.53

Removes a name/value parameter from the OAuth1 signature.

Returns 1 for success, 0 for failure.

SetRsaKey

function SetRsaKey(privKey: TPrivateKey): Integer;

Introduced in version 9.5.0.64

Sets the RSA key to be used when the SignatureMethod is set to "RSA-SHA1" or "RSA-SHA2".

Returns 1 for success, 0 for failure.