OAuth1 Delphi DLL Reference Documentation

OAuth1

Current Version: 9.5.0.73

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.

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

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

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

top
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, 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
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

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

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

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

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
procedure CkOAuth1_getLastErrorText(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
function CkOAuth1__lastErrorText(objHandle: HCkOAuth1): PWideChar; stdcall;

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
procedure CkOAuth1_getLastErrorXml(objHandle: HCkOAuth1; outPropVal: HCkString); stdcall;
function CkOAuth1__lastErrorXml(objHandle: HCkOAuth1): PWideChar; stdcall;

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
function CkOAuth1_getLastMethodSuccess(objHandle: HCkOAuth1): wordbool; stdcall;
procedure CkOAuth1_putLastMethodSuccess(objHandle: HCkOAuth1; newPropVal: wordbool); stdcall;
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False 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 = True and failure = False.
  • 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 True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

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

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

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

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

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

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

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

top
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 "HMAC1-SHA256", "RSA-SHA1", and "RSA-SHA2".

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

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

top
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

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

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

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

top

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

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

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

top
SaveLastError
function CkOAuth1_SaveLastError(objHandle: HCkOAuth1;
    path: PWideChar): wordbool; stdcall;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns True for success, False for failure.

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

top