[DOCS-9255] Documentation for BI-265: Support pass-through authentication from proxy client to MongoDB Created: 31/Oct/16  Updated: 01/Dec/16  Resolved: 01/Dec/16

Status: Closed
Project: Documentation
Component/s: BI Connector
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Critical - P2
Reporter: Emily Hall Assignee: Andrew Aldridge
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents DOCS-9232 Instruction for Authenticated Connect... Closed
Participants:
Days since reply: 7 years, 13 weeks ago
Epic Link: BI-227
Story Points: 1

 Description   

Engineering Ticket Description:

Add support for MONGODB-CR, SCRAM-SHA-1, and PLAIN mechanisms, including an option for no authentication.

By default, authentication is disabled. To turn on auth, use the --auth command line option:

      --auth                                  use authentication/authorization ('sslPEMKeyFile' is required when using auth)

Note that SSL from the client to mongosqld will be required when authentication is enabled.

The default authentication mechanism is SCRAM-SHA-1. The default authentication source is the current database (e.g. as specified on the mysql shell command line).

To override either of these defaults, a convention is used to tack them on as suffixes to the user name as query parameters. The syntax is:

jeff_yemin?mechanism=PLAIN&source=$external
craig_wilson?source=testdb
mike_obrien?mechanism=MONGODB-CR&source=testdb

Using the mysql shell it would look something like this:

mysql --protocol tcp --port 3307 -u "jeff_yemin?mechanism=PLAIN&source=\$external" --ssl --ssl-ca ~/certs/mdbca.crt -p



 Comments   
Comment by Jeffrey Yemin [ 16/Nov/16 ]

Note that there is a bug in the beta docs. It says that --mongo-sslPEMKeyFile is required when --auth is specified, but it's --sslPEMKeyFile that is required:

      --auth                                  use authentication/authorization ('sslPEMKeyFile' is required when using auth)

Comment by Jeffrey Yemin [ 09/Nov/16 ]

This is one of the more important DOCS tickets for BI 2.0.

Generated at Thu Feb 08 07:57:55 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.