Navigation
This version of the documentation is archived and no longer supported.

Install the C Authentication Plugin

New in version 2.2.

The MongoDB Connector for BI provides a MySQL authentication plugin which implements the client side of MongoDB-supported authentication mechanisms. The mongosql_auth plugin allows you to use MongoDB Connector for BI with a MongoDB instance running with authentication enabled without needing to generate your own SSL certificates for authentication.

This plugin supports the following authentication mechanisms:

  • SCRAM-SHA-1
  • PLAIN

Note

  • The SCRAM-SHA-1 mechanism hashes the passwords in the client plugin; however, all other data is in cleartext. If possible, use with encrypted connections.
  • The PLAIN mechanism sends the password in cleartext. Use encrypted connections with the PLAIN mechanism .

Supported Platforms

The plugin is built and tested on the following platforms:

  • Windows 2008 R2 (32- and 64-bit)
  • macOS 10.12 (64-bit)
  • Ubuntu 14.04 (64-bit)
  • RHEL 7.0 (64-bit)

Testing Environment

The C Authentication plugin was developed against MySQL 5.7.18 Community Edition (64-bit), and tested with MySQL 5.7.18 Community Edition and the latest version of MongoDB Connector for BI. The plugin is not compatible with MySQL Server or Connector/ODBC driver version 8 and later.

Install on Windows

  1. Download the MySQL 5.7.x installer. The required product to install depends on your connection method:

    Connection Method Required MySQL Component
    DSN (Data Source Name) using the MySQL Connector/ODBC driver MySQL Connector/ODBC
    MySQL Shell MySQL Shell

    Note

    Install the version (64-bit or 32-bit) of the MySQL component that is appropriate for your operating system.

  2. Download the mongosql_auth plugin component .msi installer and install the mongosql_auth plugin component.

    The plugin is installed into one of the following directories depending on platform:

    Platform Default Location
    32-bit Windows C:\Program Files (x86)\MySQL\MySQL Server 5.7\lib\plugin
    64-bit Windows C:\Program Files\MySQL\MySQL Server 5.7\lib\plugin

Install on MacOS or Linux

  1. Download mongosql_auth plugin library from the releases page.

  2. After downloading, move the file mongosql_auth.so to either:

    • <mysql-home>/lib/plugin/ directory.

      The default location of <mysql-home> varies by platform.

      To discover the location of the plugin directory, run the following at the command line:

      mysql_config --plugindir
      

    - OR -

    • A directory of your choice if you provide the plugin-dir=<your-install-dir> option to your MySQL client.

For more information on usage, see Using the Plugin for Authentication.