Linux DSN Configuration

This section describes how to set up ODBC connectivity and configure DSNs on several Linux distributions: Debian-based systems, like Ubuntu, and Red Hat Linux platforms, like Red Hat Enterprise Linux (RHEL) and Fedora.

Minimum Linux Versions

Here are the minimum supported versions for Red Hat-based and Debian-based systems:


OS	Min. Version
Ubuntu	18.04
Debian	10
RHEL	8
Fedora	28
SUSE	15

Installing the Driver Dependencies

Run the following commands as root or with sudo to install the necessary dependencies:

Debian/Ubuntu:

apt-get install libc6 libstdc++6 zlib1g libgcc1

RHEL/Fedora:
```
yum install glibc libstdc++ zlib libgcc
```

Installing the Driver

You can use standard package management systems to install the driver.

On Debian-based systems, like Ubuntu, run the following command with root or sudo:

dpkg -i /path/to/driver/setup/ODataODBCDriverforUnix.deb

On systems that support the RPM package format, run the following command with root or sudo:

rpm -ivh /path/to/driver/ODataODBCDriverforUnix.rpm

Licensing the Driver

Run the following commands to license the driver. To activate a trial, omit the <key> input.

cd /opt/cdata/cdata-odbc-driver-for-odata/bin/
sudo ./install-license.sh <key>

Connecting through the Driver Manager

The driver manager loads the driver and passes function calls from the application to the driver. You need to register the driver with the driver manager and you define DSNs in the driver manager's configuration files.

The driver installation registers the driver with the unixODBC driver manager and creates a system DSN. The unixODBC driver manager can be used from Python and from many other applications. Your application may embed another driver manager.

Creating the DSN

See Using unixODBC to install unixODBC and configure DSNs. See Using the DataDirect Driver Manager to create a DSN to connect to OBIEE, Informatica, and SAS.

Connecting to OData

To connect to OData, you must set the Url to a valid OData service root URI. If your OData service does not have a root document, have FeedURL point to the specific entity you want to expose as a table.

You can also specify a CacheLocation to store the metadata of your OData organization. This keeps the CData ODBC Driver for OData from having to send requests for metadata on each connection.

Authenticating to OData

OData supports authentication via:

HTTP
Kerberos
SharePoint Online
OAuth
Azure AD

HTTP Auth Schemes

For authenticating via HTTP, set AuthScheme according to the following table.


Scheme	AuthScheme	Other Settings
None	None	Use if no authentication is desired.
Basic	Basic	User, Password
NTLM (1)	NTLM	User, Password
Digest (if supported)	Digest	User, Password

(1) NTLM is a type of Windows authentication often used across a LAN using your Windows user credentials. Set the User and Password if you are not connecting from a Windows machine, or if your currently logged in user account should not be used for the connection.

Kerberos

To authenticate to OData using Kerberos, set these properties:

hive.server2.authentication: Kerberos.
AuthScheme: NEGOTIATE.
KerberosKDC: The host name or IP Address of your Kerberos KDC machine.
KerberosSPN: The service and host of the OData Kerberos Principal. Find this value just before the '@' symbol of the principal value.

SharePoint Online

SharePoint Online connections are established by retrieving a SharePoint Online cookie. To authenticate, set these properties:

AuthScheme: SharePointOnline.
User: The authenticating SharePoint Online user account.
Password: The authenticating account's password.

OAuth

To enable this authentication from all OAuth flows in OData, you must create a custom OAuth application, and set AuthScheme to OAuth.

The following subsections describe how to authenticate to OData from three common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in OData, see Connection.

Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Set these properties:

OAuthClientId: The client Id assigned when you registered your custom OAuth application.
OAuthClientSecret: The client secret that was assigned when you registered your custom OAuth application.
CallbackURL: The redirect URI that was defined when you registered your custom OAuth application.

When you connect, the driver opens OData's OAuth endpoint in your default browser. Log in and grant permissions to the application.

When the access token expires, the driver refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the driver automatically refresh the OAuth access token:

Before connecting to data for the first time, set these connection parameters:
- InitiateOAuth: REFRESH.
- OAuthClientId: The client Id in your custom OAuth application settings.
- OAuthClientSecret: The client secret in your custom OAuth application settings.
- OAuthAccessToken: The access token returned by GetOAuthAccessToken.
- OAuthSettingsLocation: The path where you want the driver to save the OAuth values, which persist across connections.
On subsequent data connections, set:
- InitiateOAuth
- OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
Set these connection properties:
- OAuthClientId: The Client Id in your custom OAuth application settings.
- OAuthClientSecret: The Client Secret in your custom OAuth application settings.
Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

If you need to log in to a resource that resides on a headless machine, you must authenticate on another device that has an internet browser. You can do this in either of the following ways:

Option 1: Obtain the OAuthVerifier value.
Option 2: Install the driver on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.

After you execute either Option 1 or Option 2, configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtaining and Exchanging a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL as follows:

Authenticate from the machine with an internet browser, and obtain the OAuthVerifier connection property.

Set these properties:
- InitiateOAuth: OFF.
- OAuthClientId: The client Id assigned when you registered your custom OAuth application.
- OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
Call the GetOAuthAuthorizationUrl stored procedure. The stored procedure returns the CallbackURL established when the custom OAuth application was registered. (See Creating a Custom OAuth Application.)

Copy this URL and paste it into a new browser tab.
Log in and grant permissions to the driver. The OAuth application redirects you the redirect URI, with a parameter called code appended. Note the value of this parameter; you will need it later, to configure the OAuthVerifier connection property.
Exchange the OAuth verifier code for OAuth refresh and access tokens. On the headless machine, to obtain the OAuth authentication values, set these properties:
- InitiateOAuth: REFRESH.
- OAuthVerifier: The noted verifier code (the value of the code parameter in the redirect URI).
- OAuthSettingsLocation: Persist the encrypted OAuth authentication values to the specified file.
- OAuthClientId: The client Id in your custom OAuth application settings.
- OAuthClientSecret: The client secret in the custom OAuth application settings.
Test the connection to generate the OAuth settings file.
You are ready to connect after you re-set these properties:
- InitiateOAuth: REFRESH.
- OAuthSettingsLocation: The file containing the encrypted OAuth authentication values. To enable the automatic refreshing of the access token, be sure that this file gives read and write permissions to the driver.
- OAuthClientId: The client Id assigned when you registered your custom OAuth application.
- OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Option 2: Transferring OAuth Settings

Prior to connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described above in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set these connection properties:

InitiateOAuth: REFRESH
OAuthSettingsLocation: The path to the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the driver.
OAuthClientId: The client Id assigned when you registered your custom OAuth application.
OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Azure AD

Azure AD supports a form of OAuth that goes through Azure. Set the AuthScheme to AzureAD.

The CData ODBC Driver for OData automatically takes care of known Azure URLs internally, so it is not necessary to specify any of the usual OAuth connection properties, such as OAuthAccessTokenURL, OAuthAuthorizationURL,OAuthRefreshTokenURL, and OAuthRequestTokenURL.

Other connection properties may be required for this connection method including:

Scope: Must be specified if InitiateOAuth is set to GETANDREFRESH as the Scope is submitted to Microsoft during retrieval of credentials. This varies depending on the service, but is generally a combination of the resource (hostname in the URL) and permission name. For example: https://host/user_impersonation.
AzureADResource: The specific Azure Resource to authenticate against during Microsoft login. If none is specified, your user account's default resource is used.
AzureADTenant: The specific Azure Tenant to authenticate against during Microsoft login. If none is specified, your user account's default tenant via the common login endpoint is used. This may not be correct depending on the specific resource you are connecting to, or if the resource is stored on a seperate tenant.

Otherwise, the steps to authenticate are identical to the descriptions of Desktop, Web, and Headless Machine authentication.

For information about how to create a custom OAuth application for use with Azure AD, see Creating a Custom OAuth Application.

Securing OData Connections

By default, the driver attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats to do so.

Refreshing OAuth Values

The driver can refresh the temporary OAuth access tokens obtained during the browser-based OAuth authentication exchange. By default, the driver saves the encrypted tokens in the odbc.ini file corresponding to the DSN. Access to this odbc.ini file can be restricted in the case of System DSNs.

To enable the automatic token exchange, you can give the driver write access to the system odbc.ini. Or, you can set the OAuthSettingsLocation connection property to an alternate file path, to which the driver would have read and write access.

    OAuthSettingsLocation=/tmp/oauthsettings.txt

Installing Dependencies for OAuth Authentication

The OAuth authentication standard requires the authenticating user to interact with OData, using a web-browser. If the first OAuth interaction is to be done on the same machine the driver is installed on, for example, a desktop application, the driver needs access to the xdg-open program, which opens the default browser.

To satisfy this dependency, install the corresponding package with your package manager:


Debian/Ubuntu Package	RHEL/Fedora Package	File
xdg-utils	xdg-utils	xdg-open

Set the Driver Encoding

The ODBC drivers need to specify which encoding to use with the ODBC Driver Manager. By default, the CData ODBC Drivers for Unix are configured to use UTF-16 which is compatible with unixODBC, but other Driver Managers may require alternative encoding.

Alternatively, if you are using the ODBC driver from an application that uses the ANSI ODBC API it may be necessary to set the ANSI code page. For example, to import Japanese characters in an ANSI application, you can specify the code page in the config file '/opt/cdata/cdata-odbc-driver-for-odata/lib/cdata.odbc.odata.ini':

[Driver]
AnsiCodePage = 932