mongodb/mongo-python-driver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

PYTHON-764 Update auth examples for MongoDB 2.8.

Browse Source
This commit is contained in:
A. Jesse Jiryu Davis 2014-10-21 15:58:21 -04:00
parent e3d6510761
commit 3ca47b804b
1 changed files with 37 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
doc/examples/authentication.rst
View File

@ -5,24 +5,50 @@ MongoDB supports several different authentication mechanisms. These examples
cover all authentication methods currently supported by PyMongo, documenting cover all authentication methods currently supported by PyMongo, documenting
Python module and MongoDB version dependencies. Python module and MongoDB version dependencies.
MONGODB-CR SCRAM-SHA-1 (RFC 5802)
---------- ----------------------
MONGODB-CR is the default authentication mechanism supported by a MongoDB .. versionadded:: 2.8
cluster configured for authentication. Authentication is per-database and
credentials can be specified through the MongoDB URI or passed to the SCRAM-SHA-1 is the default authentication mechanism supported by a cluster
:meth:`~pymongo.database.Database.authenticate` method:: configured for authentication with MongoDB 2.8 or later. Authentication is
per-database and credentials can be specified through the MongoDB URI or
passed to the :meth:`~pymongo.database.Database.authenticate` method::
>>> from pymongo import MongoClient >>> from pymongo import MongoClient
>>> client = MongoClient('example.com') >>> client = MongoClient('example.com')
>>> client.the_database.authenticate('user', 'password') >>> client.the_database.authenticate('user', 'password', mechanism='SCRAM-SHA-1')
True True
>>> >>>
>>> uri = "mongodb://user:password@example.com/the_database" >>> uri = "mongodb://user:password@example.com/the_database?authMechanism=SCRAM-SHA-1"
>>> client = MongoClient(uri) >>> client = MongoClient(uri)
>>>
When using MongoDB's delegated authentication features, a separate MONGODB-CR
authentication source can be specified (using PyMongo 2.5 or newer):: ----------
Before MongoDB 2.8 the default authentication mechanism was MONGODB-CR,
the "MongoDB Challenge-Response" protocol::
>>> from pymongo import MongoClient
>>> client = MongoClient('example.com')
>>> client.the_database.authenticate('user', 'password', mechanism='MONGODB-CR')
True
>>>
>>> uri = "mongodb://user:password@example.com/the_database?authMechanism=MONGODB-CR"
>>> client = MongoClient(uri)
Default Authentication Mechanism
--------------------------------
If no mechanism is specified, PyMongo automatically uses MONGODB-CR when
connected to a pre-2.8 version of MongoDB, and SCRAM-SHA-1 when connected to
a recent version.
Delegated Authentication
------------------------
.. versionadded: 2.5
In MongoDB 2.4.x a separate authentication source can be specified.
This feature was introduced in MongoDB 2.4 and removed in 2.6::
>>> from pymongo import MongoClient >>> from pymongo import MongoClient
>>> client = MongoClient('example.com') >>> client = MongoClient('example.com')
@ -177,20 +203,3 @@ the SASL PLAIN mechanism::
... ssl_cert_reqs=ssl.CERT_REQUIRED, ... ssl_cert_reqs=ssl.CERT_REQUIRED,
... ssl_ca_certs='/path/to/ca.pem') ... ssl_ca_certs='/path/to/ca.pem')
>>> >>>
SCRAM-SHA-1 (RFC 5802)
----------------------
.. versionadded:: 2.8
MongoDB 2.7.2 and above support the SCRAM-SHA-1 mechanism. Authentication is
per-database and credentials can be specified through the MongoDB URI or passed
to the :meth:`~pymongo.database.Database.authenticate` method::
>>> from pymongo import MongoClient
>>> client = MongoClient('example.com')
>>> client.the_database.authenticate('user', 'password', mechanism='SCRAM-SHA-1')
True
>>>
>>> uri = "mongodb://user:password@example.com/the_database?authMechanism=SCRAM-SHA-1"
>>> client = MongoClient(uri)
>>>