---
product: Chilkat
product_version: 11.7.0
language: c
language_label: C
class: OAuth1
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/c_CkOAuth1Ref.html
---
# Chilkat OAuth1 — C — v11.7.0

> Chilkat 11.7.0 · language=c · class=OAuth1
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/OAuth1.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/c/guide.md`.

## Purpose

**Generate OAuth 1.0 signatures, authorization headers, and signed request URLs.**

`Chilkat.OAuth1` builds the signed OAuth 1.0 authentication data needed for APIs that still require OAuth 1.0 request signing. It can generate the signature base string, HMAC key, signature, URL-encoded signature, normalized signed parameter string, Authorization header, and generated URL containing OAuth query parameters. It supports consumer credentials, access tokens, nonce and timestamp generation, extra signed parameters, optional realm handling, HMAC-SHA1, HMAC-SHA256, RSA-SHA1, and RSA-SHA256 signing.

**OAuth 1.0 signing**

Generate the OAuth 1.0 signature and related authentication values from the HTTP method, request URL, credentials, token, nonce, and timestamp.

**Authorization header**

Produce the value to send in the HTTP `Authorization` header when OAuth parameters should be supplied as a header.

**Signed URL output**

Generate a URL that includes the OAuth 1.0 query parameters when the API expects authentication data in the request URL.

**Extra signed parameters**

Add or remove request-specific name/value parameters that must be included in the normalized parameter string and signature calculation.

**HMAC or RSA signatures**

Sign with `HMAC-SHA1`, `HMAC-SHA256`, `RSA-SHA1`, or `RSA-SHA256`, with RSA private keys supplied by `SetRsaKey`.

**Debuggable signing details**

Inspect the exact `BaseString`, `HmacKey`, `QueryString`, `Signature`, and `EncodedSignature` used to build the OAuth request.

**Common pattern:** Set `OauthMethod` and `OauthUrl`, provide the consumer key and secret, set any token and token secret, generate or assign `Nonce` and `Timestamp`, add request parameters with `AddParam`, then call `Generate`. Use `AuthorizationHeader` when sending OAuth data in an HTTP header, or `GeneratedUrl` when the signed OAuth parameters should be placed in the URL.

**URL guidance:** Set `OauthUrl` to the base request URL without query parameters. Add query parameters separately with `AddParam` so they are included correctly in the OAuth 1.0 signature calculation.

## Object creation, unlocking and error handling

**Create/Dispose**

```c
HCkOAuth1 instance = CkOAuth1_Create();
// ...
CkOAuth1_Dispose(instance);
```

`HCkOAuth1 CkOAuth1_Create(void);`

Creates an instance of the HCkOAuth1 object and returns a handle ("void \*" pointer). The handle is passed in the 1st argument for the functions listed on this page.

`void CkOAuth1_Dispose(HCkOAuth1 handle);`

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. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkOAuth1_Dispose.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in C.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `void CkOAuth1_getDebugLogFilePath(HCkOAuth1 cHandle, HCkString retval); void CkOAuth1_putDebugLogFilePath(HCkOAuth1 cHandle, const char *newVal); const char *CkOAuth1_debugLogFilePath(HCkOAuth1 cHandle);` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `void CkOAuth1_getLastErrorHtml(HCkOAuth1 cHandle, HCkString retval); const char *CkOAuth1_lastErrorHtml(HCkOAuth1 cHandle);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void CkOAuth1_getLastErrorText(HCkOAuth1 cHandle, HCkString retval); const char *CkOAuth1_lastErrorText(HCkOAuth1 cHandle);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void CkOAuth1_getLastErrorXml(HCkOAuth1 cHandle, HCkString retval); const char *CkOAuth1_lastErrorXml(HCkOAuth1 cHandle);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `BOOL CkOAuth1_getLastMethodSuccess(HCkOAuth1 cHandle); void CkOAuth1_putLastMethodSuccess(HCkOAuth1 cHandle, BOOL newVal);` | read/write | Indicates the success or failure of the most recent method call: `TRUE` means success, `FALSE` means failure. |
| `Utf8` | `BOOL CkOAuth1_getUtf8(HCkOAuth1 cHandle); void CkOAuth1_putUtf8(HCkOAuth1 cHandle, BOOL newVal);` | read/write | When set to `TRUE`, all `const char *` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `BOOL CkOAuth1_getVerboseLogging(HCkOAuth1 cHandle); void CkOAuth1_putVerboseLogging(HCkOAuth1 cHandle, BOOL newVal);` | read/write | If set to `TRUE`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void CkOAuth1_getVersion(HCkOAuth1 cHandle, HCkString retval); const char *CkOAuth1_version(HCkOAuth1 cHandle);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AuthorizationHeader` | property, read-only | `void CkOAuth1_getAuthorizationHeader(HCkOAuth1 cHandle, HCkString retval); const char *CkOAuth1_authorizationHeader(HCkOAuth1 cHandle);` |
| `BaseString` | property, read-only | `void CkOAuth1_getBaseString(HCkOAuth1 cHandle, HCkString retval); const char *CkOAuth1_baseString(HCkOAuth1 cHandle);` |
| `ConsumerKey` | property, read/write | `void CkOAuth1_getConsumerKey(HCkOAuth1 cHandle, HCkString retval); void CkOAuth1_putConsumerKey(HCkOAuth1 cHandle, const char *newVal); const char *CkOAuth1_consumerKey(HCkOAuth1 cHandle);` |
| `ConsumerSecret` | property, read/write | `void CkOAuth1_getConsumerSecret(HCkOAuth1 cHandle, HCkString retval); void CkOAuth1_putConsumerSecret(HCkOAuth1 cHandle, const char *newVal); const char *CkOAuth1_consumerSecret(HCkOAuth1 cHandle);` |
| `EncodedSignature` | property, read-only | `void CkOAuth1_getEncodedSignature(HCkOAuth1 cHandle, HCkString retval); const char *CkOAuth1_encodedSignature(HCkOAuth1 cHandle);` |
| `GeneratedUrl` | property, read-only | `void CkOAuth1_getGeneratedUrl(HCkOAuth1 cHandle, HCkString retval); const char *CkOAuth1_generatedUrl(HCkOAuth1 cHandle);` |
| `HmacKey` | property, read-only | `void CkOAuth1_getHmacKey(HCkOAuth1 cHandle, HCkString retval); const char *CkOAuth1_hmacKey(HCkOAuth1 cHandle);` |
| `Nonce` | property, read/write | `void CkOAuth1_getNonce(HCkOAuth1 cHandle, HCkString retval); void CkOAuth1_putNonce(HCkOAuth1 cHandle, const char *newVal); const char *CkOAuth1_nonce(HCkOAuth1 cHandle);` |
| `OauthMethod` | property, read/write | `void CkOAuth1_getOauthMethod(HCkOAuth1 cHandle, HCkString retval); void CkOAuth1_putOauthMethod(HCkOAuth1 cHandle, const char *newVal); const char *CkOAuth1_oauthMethod(HCkOAuth1 cHandle);` |
| `OauthUrl` | property, read/write | `void CkOAuth1_getOauthUrl(HCkOAuth1 cHandle, HCkString retval); void CkOAuth1_putOauthUrl(HCkOAuth1 cHandle, const char *newVal); const char *CkOAuth1_oauthUrl(HCkOAuth1 cHandle);` |
| `OauthVersion` | property, read/write | `void CkOAuth1_getOauthVersion(HCkOAuth1 cHandle, HCkString retval); void CkOAuth1_putOauthVersion(HCkOAuth1 cHandle, const char *newVal); const char *CkOAuth1_oauthVersion(HCkOAuth1 cHandle);` |
| `QueryString` | property, read-only | `void CkOAuth1_getQueryString(HCkOAuth1 cHandle, HCkString retval); const char *CkOAuth1_queryString(HCkOAuth1 cHandle);` |
| `Realm` | property, read/write | `void CkOAuth1_getRealm(HCkOAuth1 cHandle, HCkString retval); void CkOAuth1_putRealm(HCkOAuth1 cHandle, const char *newVal); const char *CkOAuth1_realm(HCkOAuth1 cHandle);` |
| `Signature` | property, read-only | `void CkOAuth1_getSignature(HCkOAuth1 cHandle, HCkString retval); const char *CkOAuth1_signature(HCkOAuth1 cHandle);` |
| `SignatureMethod` | property, read/write | `void CkOAuth1_getSignatureMethod(HCkOAuth1 cHandle, HCkString retval); void CkOAuth1_putSignatureMethod(HCkOAuth1 cHandle, const char *newVal); const char *CkOAuth1_signatureMethod(HCkOAuth1 cHandle);` |
| `Timestamp` | property, read/write | `void CkOAuth1_getTimestamp(HCkOAuth1 cHandle, HCkString retval); void CkOAuth1_putTimestamp(HCkOAuth1 cHandle, const char *newVal); const char *CkOAuth1_timestamp(HCkOAuth1 cHandle);` |
| `Token` | property, read/write | `void CkOAuth1_getToken(HCkOAuth1 cHandle, HCkString retval); void CkOAuth1_putToken(HCkOAuth1 cHandle, const char *newVal); const char *CkOAuth1_token(HCkOAuth1 cHandle);` |
| `TokenSecret` | property, read/write | `void CkOAuth1_getTokenSecret(HCkOAuth1 cHandle, HCkString retval); void CkOAuth1_putTokenSecret(HCkOAuth1 cHandle, const char *newVal); const char *CkOAuth1_tokenSecret(HCkOAuth1 cHandle);` |
| `UncommonOptions` | property, read/write | `void CkOAuth1_getUncommonOptions(HCkOAuth1 cHandle, HCkString retval); void CkOAuth1_putUncommonOptions(HCkOAuth1 cHandle, const char *newVal); const char *CkOAuth1_uncommonOptions(HCkOAuth1 cHandle);` |
| `AddParam` | method | `BOOL CkOAuth1_AddParam(HCkOAuth1 cHandle, const char *name, const char *value);` |
| `Generate` | method | `BOOL CkOAuth1_Generate(HCkOAuth1 cHandle);` |
| `GenNonce` | method | `BOOL CkOAuth1_GenNonce(HCkOAuth1 cHandle, int numBytes);` |
| `GenTimestamp` | method | `BOOL CkOAuth1_GenTimestamp(HCkOAuth1 cHandle);` |
| `RemoveParam` | method | `BOOL CkOAuth1_RemoveParam(HCkOAuth1 cHandle, const char *name);` |
| `SetRsaKey` | method | `BOOL CkOAuth1_SetRsaKey(HCkOAuth1 cHandle, HCkPrivateKey privKey);` |

## Properties

### OAuth1.AuthorizationHeader

`Chilkat 11.7.0 · c · OAuth1 · AuthorizationHeader · property · read-only · since 9.5.0.53`

```c
void CkOAuth1_getAuthorizationHeader(HCkOAuth1 cHandle, HCkString retval);
const char *CkOAuth1_authorizationHeader(HCkOAuth1 cHandle);
```

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.

### OAuth1.BaseString

`Chilkat 11.7.0 · c · OAuth1 · BaseString · property · read-only · since 9.5.0.53`

```c
void CkOAuth1_getBaseString(HCkOAuth1 cHandle, HCkString retval);
const char *CkOAuth1_baseString(HCkOAuth1 cHandle);
```

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.

### OAuth1.ConsumerKey

`Chilkat 11.7.0 · c · OAuth1 · ConsumerKey · property · read/write · since 9.5.0.53`

```c
void CkOAuth1_getConsumerKey(HCkOAuth1 cHandle, HCkString retval);
void CkOAuth1_putConsumerKey(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_consumerKey(HCkOAuth1 cHandle);
```

The consumer key.

### OAuth1.ConsumerSecret

`Chilkat 11.7.0 · c · OAuth1 · ConsumerSecret · property · read/write · since 9.5.0.53`

```c
void CkOAuth1_getConsumerSecret(HCkOAuth1 cHandle, HCkString retval);
void CkOAuth1_putConsumerSecret(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_consumerSecret(HCkOAuth1 cHandle);
```

The consumer secret.

### OAuth1.EncodedSignature

`Chilkat 11.7.0 · c · OAuth1 · EncodedSignature · property · read-only · since 9.5.0.53`

```c
void CkOAuth1_getEncodedSignature(HCkOAuth1 cHandle, HCkString retval);
const char *CkOAuth1_encodedSignature(HCkOAuth1 cHandle);
```

The URL encoded representation of the Signature property

### OAuth1.GeneratedUrl

`Chilkat 11.7.0 · c · OAuth1 · GeneratedUrl · property · read-only · since 9.5.0.53`

```c
void CkOAuth1_getGeneratedUrl(HCkOAuth1 cHandle, HCkString retval);
const char *CkOAuth1_generatedUrl(HCkOAuth1 cHandle);
```

The URL that includes the OAuth1 query params.

### OAuth1.HmacKey

`Chilkat 11.7.0 · c · OAuth1 · HmacKey · property · read-only · since 9.5.0.53`

```c
void CkOAuth1_getHmacKey(HCkOAuth1 cHandle, HCkString retval);
const char *CkOAuth1_hmacKey(HCkOAuth1 cHandle);
```

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

### OAuth1.Nonce

`Chilkat 11.7.0 · c · OAuth1 · Nonce · property · read/write · since 9.5.0.53`

```c
void CkOAuth1_getNonce(HCkOAuth1 cHandle, HCkString retval);
void CkOAuth1_putNonce(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_nonce(HCkOAuth1 cHandle);
```

The nonce.

### OAuth1.OauthMethod

`Chilkat 11.7.0 · c · OAuth1 · OauthMethod · property · read/write · since 9.5.0.53`

```c
void CkOAuth1_getOauthMethod(HCkOAuth1 cHandle, HCkString retval);
void CkOAuth1_putOauthMethod(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_oauthMethod(HCkOAuth1 cHandle);
```

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

### OAuth1.OauthUrl

`Chilkat 11.7.0 · c · OAuth1 · OauthUrl · property · read/write · since 9.5.0.53`

```c
void CkOAuth1_getOauthUrl(HCkOAuth1 cHandle, HCkString retval);
void CkOAuth1_putOauthUrl(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_oauthUrl(HCkOAuth1 cHandle);
```

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.

### OAuth1.OauthVersion

`Chilkat 11.7.0 · c · OAuth1 · OauthVersion · property · read/write · since 9.5.0.53`

```c
void CkOAuth1_getOauthVersion(HCkOAuth1 cHandle, HCkString retval);
void CkOAuth1_putOauthVersion(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_oauthVersion(HCkOAuth1 cHandle);
```

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

### OAuth1.QueryString

`Chilkat 11.7.0 · c · OAuth1 · QueryString · property · read-only · since 9.5.0.53`

```c
void CkOAuth1_getQueryString(HCkOAuth1 cHandle, HCkString retval);
const char *CkOAuth1_queryString(HCkOAuth1 cHandle);
```

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

### OAuth1.Realm

`Chilkat 11.7.0 · c · OAuth1 · Realm · property · read/write · since 9.5.0.70`

```c
void CkOAuth1_getRealm(HCkOAuth1 cHandle, HCkString retval);
void CkOAuth1_putRealm(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_realm(HCkOAuth1 cHandle);
```

The realm (optional).

### OAuth1.Signature

`Chilkat 11.7.0 · c · OAuth1 · Signature · property · read-only · since 9.5.0.53`

```c
void CkOAuth1_getSignature(HCkOAuth1 cHandle, HCkString retval);
const char *CkOAuth1_signature(HCkOAuth1 cHandle);
```

The generated base64 signature.

### OAuth1.SignatureMethod

`Chilkat 11.7.0 · c · OAuth1 · SignatureMethod · property · read/write · since 9.5.0.53`

```c
void CkOAuth1_getSignatureMethod(HCkOAuth1 cHandle, HCkString retval);
void CkOAuth1_putSignatureMethod(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_signatureMethod(HCkOAuth1 cHandle);
```

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

### OAuth1.Timestamp

`Chilkat 11.7.0 · c · OAuth1 · Timestamp · property · read/write · since 9.5.0.53`

```c
void CkOAuth1_getTimestamp(HCkOAuth1 cHandle, HCkString retval);
void CkOAuth1_putTimestamp(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_timestamp(HCkOAuth1 cHandle);
```

The timestamp, such as `1441632569`.

### OAuth1.Token

`Chilkat 11.7.0 · c · OAuth1 · Token · property · read/write · since 9.5.0.53`

```c
void CkOAuth1_getToken(HCkOAuth1 cHandle, HCkString retval);
void CkOAuth1_putToken(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_token(HCkOAuth1 cHandle);
```

The token.

### OAuth1.TokenSecret

`Chilkat 11.7.0 · c · OAuth1 · TokenSecret · property · read/write · since 9.5.0.53`

```c
void CkOAuth1_getTokenSecret(HCkOAuth1 cHandle, HCkString retval);
void CkOAuth1_putTokenSecret(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_tokenSecret(HCkOAuth1 cHandle);
```

The token secret

### OAuth1.UncommonOptions

`Chilkat 11.7.0 · c · OAuth1 · UncommonOptions · property · read/write · since 9.5.0.85`

```c
void CkOAuth1_getUncommonOptions(HCkOAuth1 cHandle, HCkString retval);
void CkOAuth1_putUncommonOptions(HCkOAuth1 cHandle, const char *newVal);
const char *CkOAuth1_uncommonOptions(HCkOAuth1 cHandle);
```

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.

## Methods

### OAuth1.AddParam

`Chilkat 11.7.0 · c · OAuth1 · AddParam · method · since 9.5.0.53`

```c
BOOL CkOAuth1_AddParam(HCkOAuth1 cHandle, const char *name, const char *value);
```

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

Returns TRUE for success, FALSE for failure.

### OAuth1.Generate

`Chilkat 11.7.0 · c · OAuth1 · Generate · method · since 9.5.0.53`

```c
BOOL CkOAuth1_Generate(HCkOAuth1 cHandle);
```

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.

### OAuth1.GenNonce

`Chilkat 11.7.0 · c · OAuth1 · GenNonce · method · since 9.5.0.55`

```c
BOOL CkOAuth1_GenNonce(HCkOAuth1 cHandle, int numBytes);
```

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

Returns TRUE for success, FALSE for failure.

### OAuth1.GenTimestamp

`Chilkat 11.7.0 · c · OAuth1 · GenTimestamp · method · since 9.5.0.55`

```c
BOOL CkOAuth1_GenTimestamp(HCkOAuth1 cHandle);
```

Sets the Timestamp property to the current date/time.

Returns TRUE for success, FALSE for failure.

### OAuth1.RemoveParam

`Chilkat 11.7.0 · c · OAuth1 · RemoveParam · method · since 9.5.0.53`

```c
BOOL CkOAuth1_RemoveParam(HCkOAuth1 cHandle, const char *name);
```

Removes a name/value parameter from the OAuth1 signature.

Returns TRUE for success, FALSE for failure.

### OAuth1.SetRsaKey

`Chilkat 11.7.0 · c · OAuth1 · SetRsaKey · method · since 9.5.0.64`

```c
BOOL CkOAuth1_SetRsaKey(HCkOAuth1 cHandle, HCkPrivateKey privKey);
```

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.

## Related classes

[`PrivateKey`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/c/classes/PrivateKey.md)

