認証

このバージョンのドキュメントはアーカイブされており、サポートされなくなりました。Scalaドライバーのバージョンをアップグレードする方法については、現在のドキュメントを表示してください。

ドライバーは、MongoDB Enterprise Edition でのみ使用可能な認証メカニズムを含む、すべての MongoDB 認証メカニズムをサポートしています。

MongoCredential

次のインポートステートメントを含めます。

import org.mongodb.scala._
import scala.collection.JavaConverters._

認証情報は MongoCredentialクラスのインスタンスとして表されます。 MongoCredentialクラスには、サポートされている各認証メカニズムのヘルパーメソッドが含まれています。

デフォルトの認証メカニズム

MongoDB 3.0では、 MongoDB はデフォルトの認証メカニズムをMONGODB-CRからSCRAM-SHA-1に変更しました。 MongoDB 4.0では、非推奨のMONGODB-CRメカニズムのサポートが削除され、 SCRAM-SHA-256のサポートが追加されました。

サーバーのバージョンに関係なく、デフォルトの認証メカニズムを使用して認証する認証情報を作成するには、 createCredential()ヘルパーメソッドを使用して認証情報を作成します。

val user: String = ...          // the user name
val source: String = ...        // the source where the user is defined
val password: Array[Char] = ... // the password as a character array
// ...
val credential = MongoCredential.createCredential(user, source, password)
val mongoClient: MongoClient = MongoClient(
  MongoClientSettings.builder()
    .applyToClusterSettings((builder: ClusterSettings.Builder) => builder.hosts(List(new ServerAddress("host1", 27017)).asJava))
    .credential(credential)
    .build())

あるいは、認証メカニズムを明示的に指定せずに接続stringを使用することもできます。

val mongoClient: MongoClient = MongoClient("mongodb://user1:pwd1@host1/?authSource=db1")

チャレンジメカニズムとレスポンスメカニズムでは、認証スキーマをアップグレードした後でも、MongoDB 2.6から MongoDB 3.0へのアップグレードがより簡単になるため、デフォルトの認証メカニズムを使用することをお勧めします。 MongoDB 4.0ユーザーの場合、メカニズムがチェックされ、正しいハッシュアルゴリズムが使用されているため、デフォルトの認証メカニズムを使用することも推奨されます。

SCRAM ベースのメカニズム

Salted Challenge-Response Authentication Mechanism (SCRAM) has been the default authentication mechanism for MongoDB since 3.0. SCRAM is based on the IETF RFC 5802 standard that defines best practices for implementation of challenge-response mechanisms for authenticating users with passwords.

MongoDB 3.0は、 SHA-1ハッシュ関数を使用するSCRAM-SHA-1のサポートを導入しました。 MongoDB 4.0は、 SHA-256ハッシュ関数を使用するSCRAM-SHA-256のサポートを導入しました。

SCRAM-SHA-256

このメカニズムを使用するには、MongoDB 4.0とfeatureCompatibilityVersionを4.0に設定する必要があります。

SCRAM-SHA-256タイプの認証情報を明示的に作成するには、 createScramSha256Credential()メソッドを使用します。

val user: String = ...          // the user name
val source: String = ...        // the source where the user is defined
val password: Array[Char] = ... // the password as a character array
// ...
val credential = MongoCredential.createScramSha256Credential(user, source, password)
val mongoClient: MongoClient = MongoClient(
  MongoClientSettings.builder()
    .applyToClusterSettings((builder: ClusterSettings.Builder) => builder.hosts(List(new ServerAddress("host1", 27017)).asJava))
    .credential(credential)
    .build())

または、authMechanism=SCRAM-SHA-256 を明示的に指定する接続stringを使用できます。

val mongoClient: MongoClient = MongoClient("mongodb://user1:pwd1@host1/?authSource=db1&authMechanism=SCRAM-SHA-256")

SCRAM-SHA-1

SCRAM-SHA-1タイプの認証情報を明示的に作成するには、 createScramSha1Credential()メソッドを使用します。

val user: String = ...          // the user name
val source: String = ...        // the source where the user is defined
val password: Array[Char] = ... // the password as a character array
// ...
val credential = MongoCredential.createScramSha1Credential(user, source, password)
val mongoClient: MongoClient = MongoClient(
  MongoClientSettings.builder()
    .applyToClusterSettings((builder: ClusterSettings.Builder) => builder.hosts(List(new ServerAddress("host1", 27017)).asJava))
    .credential(credential)
    .build())

または、authMechanism=SCRAM-SHA-1 を明示的に指定する接続stringを使用できます。

val mongoClient: MongoClient = MongoClient("mongodb://user1:pwd1@host1/?authSource=db1&authMechanism=SCRAM-SHA-1")

MONGODB-CR

重要

MongoDB バージョン 4.0 以降では、非推奨の MongoDB Challenge-Response（ MONGODB-CR ）認証メカニズムのサポートが削除されます。

配置にユーザー認証情報がMONGODB-CRスキーマに保存されている場合は、バージョン4.0にアップグレードする前に、 SCRAMベースのメカニズムを使用するようにアップグレードする必要があります。

MONGODB-CRタイプの認証情報を明示的に作成するには、 createMongCRCredential()ヘルパーメソッドを使用します。

val user: String = ...          // the user name
val source: String = ...        // the source where the user is defined
val password: Array[Char] = ... // the password as a character array
// ...
val credential = MongoCredential.createMongoCRCredential(user, database, password)
val mongoClient: MongoClient = MongoClient(
  MongoClientSettings.builder()
    .applyToClusterSettings((builder: ClusterSettings.Builder) => builder.hosts(List(new ServerAddress("host1", 27017)).asJava))
    .credential(credential)
    .build())

または、authMechanism=MONGODB-CR を明示的に指定する接続stringを使用できます。

val mongoClient: MongoClient = MongoClient("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()ヘルパーメソッドを使用します。

val user: String = ...     // The X.509 certificate derived user name, e.g. "CN=user,OU=OrgUnit,O=myOrg,..."
// ...
val credential = MongoCredential.createMongoX509Credential(user)
val mongoClient: MongoClient = MongoClient(
  MongoClientSettings.builder()
    .applyToClusterSettings((builder: ClusterSettings.Builder) => builder.hosts(List(new ServerAddress("host1", 27017)).asJava))
    .credential(credential)
    .build())

または、authMechanism=MONGODB-X509 を明示的に指定する接続stringを使用できます。

val mongoClient: MongoClient = MongoClient("mongodb://subjectName@host1/?authMechanism=MONGODB-X509&ssl=true")

「 x509 を使用する」を参照してください。証明書からサブジェクト名を決定する方法の詳細については、サーバーマニュアルの「クライアントを認証するための証明書」のチュートリアルを参照してください。

Kerberos （GSSAPI）

MongoDB Enterprise は、Kerberos サービスによるプロキシ認証をサポートしています。 Kerberos（GSSAPI）タイプの認証情報を作成するには、 createGSSAPICredential()ヘルパーメソッドを使用します。

val user: String = ...   // The Kerberos user name, including the realm, e.g. "user1@MYREALM.ME"
// ...
val credential = MongoCredential.createGSSAPICredential(user)
val mongoClient: MongoClient = MongoClient(
  MongoClientSettings.builder()
    .applyToClusterSettings((builder: ClusterSettings.Builder) => builder.hosts(List(new ServerAddress("host1", 27017)).asJava))
    .credential(credential)
    .build())

または、authMechanism=GSSAPI を明示的に指定する接続stringを使用できます。

val mongoClient: MongoClient = MongoClient("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プロパティを指定する方法を示しています。

val credentialWithProperty = credential.withMechanismProperty(MongoCredential.SERVICE_NAME_KEY, "othername")

または、 ConnectionString内でSERVICE_NAMEプロパティを指定することもできます。

val uri = "mongodb://username%40MYREALM.com@myserver/?authMechanism=GSSAPI&authMechanismProperties=SERVICE_NAME:othername"

注意

On Windows, Oracles JRE uses LSA rather than SSPI in its implementation of GSSAPI, which limits interoperability with Windows Active Directory and in particular the ability to implement single sign-on.

LDAP (PLAIN)

MongoDB Enterprise は、 LDAP（Lightweight Directory Access Protocol）サービスを通してプロキシ認証をサポートしています。 LDAPタイプの認証情報を作成するには、 createPlainCredential()ヘルパーメソッドを使用します。

val user: String = ...            // The LDAP user name
val password: Array[Char] = ...   // The LDAP password
// ...
val credential = MongoCredential.createPlainCredential(user, "$external", password)
val mongoClient: MongoClient = MongoClient(
  MongoClientSettings.builder()
    .applyToClusterSettings((builder: ClusterSettings.Builder) => builder.hosts(List(new ServerAddress("host1", 27017)).asJava))
    .credential(credential)
    .build())

または、authMechanism=PLAIN を明示的に指定する接続stringを使用できます。

val mongoClient: MongoClient = MongoClient("mongodb://user1@host1/?authSource=$external&authMechanism=PLAIN")

注意

ドライバーはPLAIN SASL メカニズムを使用して認証するため、メソッドはLDAPではなくPLAIN認証メカニズムを参照します。

戻る

TLS/SSL

圧縮