OAuth1 Delphi DLL Reference Documentation

OAuth1

Current Version: 10.1.2

Requires Chilkat Bundle License

OAuth 1.0a signature generator.

Create/Dispose

var
myObject: HCkOAuth1;

begin
myObject := CkOAuth1_Create();

// ...

CkOAuth1_Dispose(myObject);
end;

function CkOAuth1_Create: HCkOAuth1; stdcall;

Creates an instance of the HCkOAuth1 object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkOAuth1_Dispose(handle: HCkOAuth1); stdcall;

Objects created by calling CkOAuth1_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

AuthorizationHeader

procedure CkOAuth1_getAuthorizationHeader(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
function CkOAuth1__authorizationHeader(objHandle: HCkOAuth1): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

BaseString

procedure CkOAuth1_getBaseString(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
function CkOAuth1__baseString(objHandle: HCkOAuth1): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

ConsumerKey

procedure CkOAuth1_getConsumerKey(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
procedure CkOAuth1_putConsumerKey(objHandle: HCkOAuth1; newPropVal: PWideChar); stdcall;
function CkOAuth1__consumerKey(objHandle: HCkOAuth1): PWideChar; stdcall;

Introduced in version 9.5.0.53

The consumer key.

See the notes about PWideChar memory ownership and validity.

ConsumerSecret

procedure CkOAuth1_getConsumerSecret(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
procedure CkOAuth1_putConsumerSecret(objHandle: HCkOAuth1; newPropVal: PWideChar); stdcall;
function CkOAuth1__consumerSecret(objHandle: HCkOAuth1): PWideChar; stdcall;

Introduced in version 9.5.0.53

The consumer secret.

See the notes about PWideChar memory ownership and validity.

DebugLogFilePath

procedure CkOAuth1_getDebugLogFilePath(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
procedure CkOAuth1_putDebugLogFilePath(objHandle: HCkOAuth1; newPropVal: PWideChar); stdcall;
function CkOAuth1__debugLogFilePath(objHandle: HCkOAuth1): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

EncodedSignature

procedure CkOAuth1_getEncodedSignature(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
function CkOAuth1__encodedSignature(objHandle: HCkOAuth1): PWideChar; stdcall;

Introduced in version 9.5.0.53

The URL encoded representation of the Signature property

See the notes about PWideChar memory ownership and validity.

GeneratedUrl

procedure CkOAuth1_getGeneratedUrl(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
function CkOAuth1__generatedUrl(objHandle: HCkOAuth1): PWideChar; stdcall;

Introduced in version 9.5.0.53

The URL that includes the OAuth1 query params.

See the notes about PWideChar memory ownership and validity.

HmacKey

procedure CkOAuth1_getHmacKey(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
function CkOAuth1__hmacKey(objHandle: HCkOAuth1): PWideChar; stdcall;

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).

See the notes about PWideChar memory ownership and validity.

LastErrorHtml

procedure CkOAuth1_getLastErrorHtml(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
function CkOAuth1__lastErrorHtml(objHandle: HCkOAuth1): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkOAuth1_getLastErrorText(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
function CkOAuth1__lastErrorText(objHandle: HCkOAuth1): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkOAuth1_getLastErrorXml(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
function CkOAuth1__lastErrorXml(objHandle: HCkOAuth1): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkOAuth1_getLastMethodSuccess(objHandle: HCkOAuth1): wordbool; stdcall;
procedure CkOAuth1_putLastMethodSuccess(objHandle: HCkOAuth1; newPropVal: wordbool); stdcall;

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.

Nonce

procedure CkOAuth1_getNonce(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
procedure CkOAuth1_putNonce(objHandle: HCkOAuth1; newPropVal: PWideChar); stdcall;
function CkOAuth1__nonce(objHandle: HCkOAuth1): PWideChar; stdcall;

Introduced in version 9.5.0.53

The nonce.

See the notes about PWideChar memory ownership and validity.

OauthMethod

procedure CkOAuth1_getOauthMethod(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
procedure CkOAuth1_putOauthMethod(objHandle: HCkOAuth1; newPropVal: PWideChar); stdcall;
function CkOAuth1__oauthMethod(objHandle: HCkOAuth1): PWideChar; stdcall;

Introduced in version 9.5.0.53

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

See the notes about PWideChar memory ownership and validity.

OauthUrl

procedure CkOAuth1_getOauthUrl(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
procedure CkOAuth1_putOauthUrl(objHandle: HCkOAuth1; newPropVal: PWideChar); stdcall;
function CkOAuth1__oauthUrl(objHandle: HCkOAuth1): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

OauthVersion

procedure CkOAuth1_getOauthVersion(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
procedure CkOAuth1_putOauthVersion(objHandle: HCkOAuth1; newPropVal: PWideChar); stdcall;
function CkOAuth1__oauthVersion(objHandle: HCkOAuth1): PWideChar; stdcall;

Introduced in version 9.5.0.53

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

See the notes about PWideChar memory ownership and validity.

QueryString

procedure CkOAuth1_getQueryString(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
function CkOAuth1__queryString(objHandle: HCkOAuth1): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

Realm

procedure CkOAuth1_getRealm(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
procedure CkOAuth1_putRealm(objHandle: HCkOAuth1; newPropVal: PWideChar); stdcall;
function CkOAuth1__realm(objHandle: HCkOAuth1): PWideChar; stdcall;

Introduced in version 9.5.0.70

The realm (optional).

See the notes about PWideChar memory ownership and validity.

Signature

procedure CkOAuth1_getSignature(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
function CkOAuth1__signature(objHandle: HCkOAuth1): PWideChar; stdcall;

Introduced in version 9.5.0.53

The generated base64 signature.

See the notes about PWideChar memory ownership and validity.

SignatureMethod

procedure CkOAuth1_getSignatureMethod(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
procedure CkOAuth1_putSignatureMethod(objHandle: HCkOAuth1; newPropVal: PWideChar); stdcall;
function CkOAuth1__signatureMethod(objHandle: HCkOAuth1): PWideChar; stdcall;

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").

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Generate OAuth 1.0 Signature

Timestamp

procedure CkOAuth1_getTimestamp(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
procedure CkOAuth1_putTimestamp(objHandle: HCkOAuth1; newPropVal: PWideChar); stdcall;
function CkOAuth1__timestamp(objHandle: HCkOAuth1): PWideChar; stdcall;

Introduced in version 9.5.0.53

The timestamp, such as "1441632569".

See the notes about PWideChar memory ownership and validity.

Token

procedure CkOAuth1_getToken(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
procedure CkOAuth1_putToken(objHandle: HCkOAuth1; newPropVal: PWideChar); stdcall;
function CkOAuth1__token(objHandle: HCkOAuth1): PWideChar; stdcall;

Introduced in version 9.5.0.53

The token.

See the notes about PWideChar memory ownership and validity.

TokenSecret

procedure CkOAuth1_getTokenSecret(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
procedure CkOAuth1_putTokenSecret(objHandle: HCkOAuth1; newPropVal: PWideChar); stdcall;
function CkOAuth1__tokenSecret(objHandle: HCkOAuth1): PWideChar; stdcall;

Introduced in version 9.5.0.53

The token secret

See the notes about PWideChar memory ownership and validity.

UncommonOptions

procedure CkOAuth1_getUncommonOptions(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
procedure CkOAuth1_putUncommonOptions(objHandle: HCkOAuth1; newPropVal: PWideChar); stdcall;
function CkOAuth1__uncommonOptions(objHandle: HCkOAuth1): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

VerboseLogging

function CkOAuth1_getVerboseLogging(objHandle: HCkOAuth1): wordbool; stdcall;
procedure CkOAuth1_putVerboseLogging(objHandle: HCkOAuth1; newPropVal: wordbool); stdcall;

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.

Version

procedure CkOAuth1_getVersion(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
function CkOAuth1__version(objHandle: HCkOAuth1): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddParam

function CkOAuth1_AddParam(objHandle: HCkOAuth1;
name: PWideChar;
value: PWideChar): wordbool; stdcall;

Introduced in version 9.5.0.53

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

Returns True for success, False for failure.

More Information and Examples

REST OAuth1 with Params

Generate

function CkOAuth1_Generate(objHandle: HCkOAuth1): wordbool; stdcall;

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 True for success, False for failure.

More Information and Examples

Generate OAuth 1.0 Signature

GenNonce

function CkOAuth1_GenNonce(objHandle: HCkOAuth1;
numBytes: Integer): wordbool; stdcall;

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 True for success, False for failure.

GenTimestamp

function CkOAuth1_GenTimestamp(objHandle: HCkOAuth1): wordbool; stdcall;

Introduced in version 9.5.0.55

Sets the Timestamp property to the current date/time.

Returns True for success, False for failure.

RemoveParam

function CkOAuth1_RemoveParam(objHandle: HCkOAuth1;
name: PWideChar): wordbool; stdcall;

Introduced in version 9.5.0.53

Removes a name/value parameter from the OAuth1 signature.

Returns True for success, False for failure.

SetRsaKey

function CkOAuth1_SetRsaKey(objHandle: HCkOAuth1;
privKey: HCkPrivateKey): wordbool; stdcall;

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 True for success, False for failure.