模块:Mongo::Auth::StringPrep Private

扩展方式:
StringPrep
包含在:
StringPrep
定义于:
构建/ruby-driver-v2.19/lib/ mongo /auth/stringprep.rb
构建/ruby-driver-v2.19/lib/ mongo /auth/stringprep/tables.rb,
构建/ruby-driver-v2.19/lib/ mongo /auth/stringprep/profiles/sasl.rb

Overview

该模块是私有 API 的一部分。 您应尽可能避免使用此模块,因为它将来可能会被删除或更改。

此命名空间包含与string准备 (RFC 3454) 相关的所有行为。 它用于实施 SCRAM-SHA- 256身份验证,MongoDB 服务器版本4.0及更高版本中提供该身份验证。

由于:

  • 2.6.0

在命名空间下定义

模块: 配置文件表格

实例方法摘要折叠

实例方法详细信息

#prepare (data,mappings,improved,options={}) ⇒对象

此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

根据给定的一组映射和禁用字符表准备一个string 。

例子:

准备string 。

StringPrep.prepare("some string",
                   StringPrep::Profiles::SASL::MAPPINGS,
                   StringPrep::Profiles::SASL::PROHIBITED,
                   normalize: true, bidi: true)

参数:

  • 数据 ( string )

    要准备的string 。

  • mappings ( Array )

    要应用数据的映射列表。

  • 禁止 ( Array )

    禁止的字符列表,用于确保在映射和规范化数据后数据不包含这些字符。

  • 选项 哈希 (默认为: {}

    在string准备期间执行的可选操作。

选项哈希 ( options ):

  • :normalize 布尔值

    是否对数据应用Unicode 规范化。

  • :bidi 布尔值

    是否确保数据包含有效的双向输入。

引发:

由于:

  • 2.6.0



54
55
56
57
58
59
60
# File 'build/Ruby-driver-v 2.19 /lib/mongo/auth/stringprep.rb', 第54行

def 准备(数据, mappings, 禁止, 选项 = {})
  apply_maps(数据, mappings).点击 do |映射|
    正常化!(映射) if 选项[:normalize]
    check_prohibited!(映射, 禁止)
    check_bidi!(映射) if 选项[:bidi]
  end
end