类：Mongo::Crypt::KMS::Local::Credentials Private

继承：
对象
  • 对象
显示全部
扩展方式：
可转发
包括：
验证
定义于：
lib/ Mongo/crypt/ KMS/local/凭证.rb

Overview

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

本地KMS凭据对象包含使用本地KMS提供商的凭证。

常量摘要折叠

FORMAT_HINT =

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

' 本地KMS提供商选项必须采用以下格式： ' +
"{ key: 'MASTER-KEY' }"

实例属性摘要折叠

实例方法摘要折叠

验证中包含的方法

#validate_param , validate_tls_options

构造函数详情

#initialize (opts) ⇒档案

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

从参数哈希中创建本地 KMS 凭证对象。

参数：

  • opts (哈希) —

    包含本地凭证提供商KMS的哈希值

选项哈希 ( opts )：

  • :key （ string ） —

    主密钥。

引发：

  • ( ArgumentError ) —

    如果必需的选项丢失或格式不正确。



45
46
47
48
49
50
 
# File 'lib/ Mongo/crypt/ KMS 凭证', line 45

def 初始化(opts)
  @opts = opts
  return if 空？

  @key = validate_param(:key, opts, FORMAT_HINT)
end

实例属性详细信息

# key ⇒ string (readonly)

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

返回主密钥。

返回：

  • ( string ) —

    主密钥。



29
30
31
 
# File 'lib/ Mongo/crypt/ KMS 凭证', line 29

def key
  @key
end

实例方法详细信息

# to_document ⇒ BSON::Document

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

以凭证格式返回本地KMS档案。

返回：

  • ( BSON::Document ) —

    凭证格式的本地KMS档案。



53
54
55
56
57
58
59
 
# File 'lib/ Mongo/crypt/ KMS 凭证', line 53

def to_document
  return BSON::文档.new({}) if 空？

  BSON::文档.new({
                       键： BSON::二进制文件.new(@key, :generic),
                     })
end