ドライバーは、MongoDB Enterprise Edition でのみ使用可能な認証メカニズムを含む、すべての MongoDB 認証メカニズムをサポートしています。
MongoCredential
次のインポート ステートメントを含めます。
import com.mongodb.MongoCredential; import com.mongodb.ConnectionString; import com.mongodb.reactivestreams.client.MongoClients; import com.mongodb.reactivestreams.client.MongoClient;
認証情報は MongoCredential
クラスのインスタンスとして表されます。 MongoCredential
クラスには、サポートされている各認証メカニズムの静的ファクトリー メソッドが含まれています。
デフォルトの認証メカニズム
デフォルトの認証メカニズム、SCRAM-SHA-256
を使用して認証する認証情報を作成するには、createCredential()
静的ファクトリー メソッドを使用して認証情報を作成します。
String user; // the user name String source; // the source where the user is defined char[] password; // the password as a character array // ... MongoCredential credential = MongoCredential.createCredential(user, source, password); MongoClient mongoClient = MongoClients.create( MongoClientSettings.builder() .applyToClusterSettings(builder -> builder.hosts(Arrays.asList(new ServerAddress("host1", 27017)))) .credential(credential) .build());
あるいは、認証メカニズムを明示的に指定せずに接続stringを使用することもできます。
MongoClient mongoClient = MongoClients.create("mongodb://user1:pwd1@host1/?authSource=db1");
チャレンジ メカニズムとレスポンス メカニズムには、デフォルトの認証メカニズムを使用することをお勧めします。これによりアップグレードが簡素化され、正しいハッシュアルゴリズムが使用されるようになります。
SCRAM ベースのメカニズム
Salted Challenge Response Authentication Mechanism(SCRAM
)は、パスワードを持つユーザーを認証するためのチャレンジ レスポンス メカニズムの実装に関するベスト プラクティスを定義する IETF RFC 5802 標準に基づいています。MongoDB は、SHA-1
ハッシュ関数を使用する SCRAM-SHA-1
と SHA-256
ハッシュ関数を使用する SCRAM-
SHA-256
の両方をサポートしています。
SCRAM-SHA-256
SCRAM-SHA-256
タイプの認証情報を明示的に作成するには、 createScramSha256Credential()
メソッドを使用します。
String user; // the user name String source; // the source where the user is defined char[] password; // the password as a character array // ... MongoCredential credential = MongoCredential.createScramSha256Credential(user, source, password); MongoClient mongoClient = MongoClients.create( MongoClientSettings.builder() .applyToClusterSettings(builder -> builder.hosts(Arrays.asList(new ServerAddress("host1", 27017)))) .credential(credential) .build());
または、authMechanism=SCRAM-SHA-256
を明示的に指定する接続stringを使用できます。
MongoClient mongoClient = MongoClients.create("mongodb://user1:pwd1@host1/?authSource=db1&authMechanism=SCRAM-SHA-256");
SCRAM-SHA-1
SCRAM-SHA-1
タイプの認証情報を明示的に作成するには、 createScramSha1Credential()
メソッドを使用します。
String user; // the user name String source; // the source where the user is defined char[] password; // the password as a character array // ... MongoCredential credential = MongoCredential.createScramSha1Credential(user, source, password); MongoClient mongoClient = MongoClients.create( MongoClientSettings.builder() .applyToClusterSettings(builder -> builder.hosts(Arrays.asList(new ServerAddress("host1", 27017)))) .credential(credential) .build());
または、authMechanism=SCRAM-SHA-1
を明示的に指定する接続stringを使用できます。
MongoClient mongoClient = MongoClients.create("mongodb://user1:pwd1@host1/?authSource=db1&authMechanism=SCRAM-SHA-1");
MONGODB-CR
重要
MongoDB、非推奨のMongoDB Challenge-Response(MONGODB-CR
)認証メカニズムのサポートを終了しました。デプロイメントでユーザー認証情報が MONGODB-CR
スキーマに保存されている場合は、SCRAM
ベースのメカニズムにアップグレードする必要があります。
MONGODB-CR
タイプの認証情報を明示的に作成するには、 createMongCRCredential()
静的ファクトリー メソッドを使用します。
String user; // the user name String database; // the name of the database in which the user is defined char[] password; // the password as a character array // ... MongoCredential credential = MongoCredential.createMongoCRCredential(user, database, password); MongoClient mongoClient = MongoClients.create( MongoClientSettings.builder() .applyToClusterSettings(builder -> builder.hosts(Arrays.asList(new ServerAddress("host1", 27017)))) .credential(credential) .build());
または、authMechanism=MONGODB-CR
を明示的に指定する接続stringを使用できます。
MongoClient mongoClient = MongoClients.create("mongodb://user1:pwd1@host1/?authSource=db1&authMechanism=MONGODB-CR");
注意
認証スキーマをMONGODB-CR
からSCRAM
にアップグレードすると、 MONGODB-CR
の認証情報は認証に失敗します。
x.509
X.509
メカニズムでは、MongoDB は SSL ネゴシエート中に提示された X. 509証明書を使用して、X. 509証明書の識別名から派生したユーザーを認証します。
X. 509認証では、証明書検証を使用した SSL 接続を使用する必要があります。 このタイプの認証情報を作成するには、 createMongoX509Credential()
静的ファクトリー メソッドを使用します。
String user; // The X.509 certificate derived user name, e.g. "CN=user,OU=OrgUnit,O=myOrg,..." // ... MongoCredential credential = MongoCredential.createMongoX509Credential(user); MongoClient mongoClient = MongoClients.create( MongoClientSettings.builder() .applyToClusterSettings(builder -> builder.hosts(Arrays.asList(new ServerAddress("host1", 27017)))) .credential(credential) .build());
または、authMechanism=MONGODB-X509
を明示的に指定する接続stringを使用できます。
MongoClient mongoClient = MongoClients.create("mongodb://subjectName@host1/?authMechanism=MONGODB-X509&ssl=true");
Kerberos (GSSAPI)
MongoDB Enterprise は、Kerberos サービスによるプロキシ認証をサポートしています。 Kerberos タイプ(GSSAPI)の認証情報を作成するには、 createGSSAPICredential()
静的ファクトリー メソッドを使用します。
String user; // The Kerberos user name, including the realm, e.g. "user1@MYREALM.ME" // ... MongoCredential credential = MongoCredential.createGSSAPICredential(user); MongoClient mongoClient = MongoClients.create( MongoClientSettings.builder() .applyToClusterSettings(builder -> builder.hosts(Arrays.asList(new ServerAddress("host1", 27017)))) .credential(credential) .build());
または、authMechanism=GSSAPI
を明示的に指定する接続stringを使用できます。
MongoClient mongoClient = MongoClients.create("mongodb://username%40REALM.ME@host1/?authMechanism=GSSAPI");
注意
ドライバーはGSSAPI
SASL メカニズムを使用して認証するため、 メソッドはKerberos
ではなくGSSAPI
認証メカニズムを参照します。
Kerberos を使用して正常に認証するには、アプリケーションは通常、基礎の GSSAPI Java ライブラリが Kerberos チケットを取得できるように、いくつかのシステム プロパティを指定する必要があります。
java.security.krb5.realm=MYREALM.ME java.security.krb5.kdc=mykdc.myrealm.me
Kerberos の設定によっては、アプリケーション コード内で、またはMongoCredential
インスタンスのwithMechanismProperty()
メソッドを使用して、追加のプロパティ指定が必要になる場合があります。
SERVICE_NAME
CANONICALIZE_HOST_NAME
JAVA_SUBJECT
JAVA_SASL_CLIENT_PROPERTIES
次のコードは、 MongoCredential
オブジェクト内でSERVICE_NAME
プロパティを指定する方法を示しています。
credential = credential.withMechanismProperty(MongoCredential.SERVICE_NAME_KEY, "othername");
または、 ConnectionString
内でSERVICE_NAME
プロパティを指定することもできます。
uri = "mongodb://username%40MYREALM.com@myserver/?authMechanism=GSSAPI&authMechanismProperties=SERVICE_NAME:othername"
LDAP (PLAIN)
MongoDB Enterprise は、 LDAP(Lightweight Directory Access Protocol)サービスを通してプロキシ認証をサポートしています。 LDAP
タイプの認証情報を作成するには、 createPlainCredential()
静的ファクトリー メソッドを使用します。
String user; // The LDAP user name char[] password; // The LDAP password // ... MongoCredential credential = MongoCredential.createPlainCredential(user, "$external", password); MongoClient mongoClient = MongoClients.create( MongoClientSettings.builder() .applyToClusterSettings(builder -> builder.hosts(Arrays.asList(new ServerAddress("host1", 27017)))) .credential(credential) .build());
または、authMechanism=PLAIN
を明示的に指定する接続stringを使用できます。
MongoClient mongoClient = MongoClients.create("mongodb://user1@host1/?authSource=$external&authMechanism=PLAIN");
注意
ドライバーはPLAIN
SASL メカニズムを使用して認証するため、 メソッドはLDAP
ではなくPLAIN
認証メカニズムを参照します。