クラス: Mongo::Crypt::ExpriteEncryptionContext Private

継承:
Context
  • オブジェクト
すべて表示
定義:
lib/mongo/crypt/explit_encryption_context.rb

Overview

このクラスは、プライベート API の一部です。 このクラスは将来削除または変更される可能性があるため、可能な限り使用しないでください。

明示的な暗号化のために初期化された Context オブジェクト

既知のサブクラスを直接確認

ExplainEncryptionExpressionContext

インスタンス属性の概要

コンテキストから継承される属性

#ctx_p

インスタンス メソッドの概要を折りたたむ

Contextから継承されたメソッド

#bson_mode、#run_rate_ Machine、#状態

コンストラクターの詳細

#初期化（ mongocrypt , io, doc, オプション = {{}） = ExpressEncryptionContext

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

注：

Rangeアルゴリズムは実験的なもののみです。 対象ではありません

注：

"substring" は、クエリ タイプは不安定であり、下位互換性がありません。

新しい明示的暗号化コンテキスト オブジェクトの作成

パブリックで使用します。重大な変更。

パラメーター:

  • mongocrypt （ Mongo::Crypt::Handle ） —

    新しい mongocrypt_ctx_t の作成に使用される mongocrypt_t オブジェクトをラップするハンドル

  • io (ClientEncryption::IO) —

    ステート マシンの実行に必要なドライバー I/O メソッドを実装する IO クラスのインスタンス

  • doc （ BSON::Document ） —

    暗号化するドキュメント

  • options （ハッシュ） （デフォルトは{}です）

オプション ハッシュ（ options ）:

  • :key_id （ BSON::Binary ） —

    暗号化に使用するデータキーの UUID を表す :uuid の BSON::Binary オブジェクト。

  • :key_alt_name （ string ） —

    値を暗号化するために使用されるデータキーの別名。

  • : アルゴリズム （ string ） —

    値を暗号化するために使用されるアルゴリズム。有効なアルゴリズムは、"AEAD_AES_256 _CBC_HMAC_SHA_512 256512-Deのみごと。

  • :contention_factor (Integer | nil) —

    暗号化アルゴリズムが「Indexed」、「Range」、または「String」に設定されている場合に適用する競合係数。指定しない場合、デフォルトは 0 の値になります。競合係数は、暗号化アルゴリズムが "Indexed"、"Range"、または "String" に設定されている場合にのみ設定する必要があります。

  • query_type （ string | nil ） —

    暗号化アルゴリズムが "Indexed"、"Range"、または "String" に設定されている場合に適用するクエリタイプ。許可される値は、"Equality"")、"Range"、"prefix""、"sfix""、"substring"、"substring"") です。

  • :range_opts （ハッシュ | nil ） —

    「範囲」クエリをサポートするQueryable Encryptionフィールドのインデックスオプションを指定します。許可されるオプションは次のとおりです。

    • :min
    • :max
    • :trim_factor
    • :sparsity
    • :preference min、max、trim_factor、sparse、および精度は、宛先コレクションの encryptedField に設定されている値と一致する必要があります 。double と decimal128 の場合は、最小値/最大値/精度はすべて設定されるか、すべてが設定されていない必要があります。
  • :string_opts （ハッシュ | nil ） —

    「プレフィックス」、「サフィックス」、または「サブストリング」をサポートするQueryable Encryptionフィールドのインデックスオプションを指定します。クエリ（アルゴリズム "引用符"String": ）。許可されるオプションは次のとおりです。

    • :大文字と小文字の区別
    • :発音区別符号を区別する
    • :prefix（:str_min_query_Length、:str_max_query_Length でハッシュ）
    • :sfix（:str_min_query_Length、:str_max_query_Length でハッシュ）
    • :substring （ :str_max_long、 :str_min_query_Length、:str_max_query_Length でハッシュ） オプションは、宛先コレクションの encryptedField に設定されている値と一致する必要があります。

次の値が発生します。



79
80
81
82
83
84
 
# ファイル 'lib/mongo/crypt/explit_encryption_context.rb' 行 79

デフォルト 初期化(mongocrypt, io, doc, options = {})
  スーパー(mongocrypt, io)
  set_key_opts(options)
  set_algorithm_opts(options)
  init(doc)
end

インスタンス メソッドの詳細

# init （ドキュメント） =オブジェクト

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。 



86
87
88
 
# ファイル 'lib/mongo/crypt/explit_encryption_context.rb' 行 86

デフォルト init(doc)
  バインディング.ctx_explicit_encrypt_init(自己, doc)
end