File: kms_context.rb

package info (click to toggle)
ruby-mongo 2.21.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 14,764 kB
  • sloc: ruby: 108,806; makefile: 5; sh: 2
file content (70 lines) | stat: -rw-r--r-- 2,292 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# frozen_string_literal: true
# rubocop:todo all

# Copyright (C) 2019-2020 MongoDB Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

module Mongo
  module Crypt

    # Wraps a libmongocrypt mongocrypt_kms_ctx_t object. Contains information
    # about making an HTTP request to fetch information about a KMS
    # data key.
    class KmsContext
      # Create a new KmsContext object.
      #
      # @param [ FFI::Pointer ] kms_ctx A pointer to a mongocrypt_kms_ctx_t
      #   object. This object is managed by the mongocrypt_ctx_t object that
      #   created it; this class is not responsible for de-allocating resources.
      def initialize(kms_ctx)
        @kms_ctx_p = kms_ctx
      end

      # Return the pointer to the underlying mongocrypt_kms_ctx_t object.
      #
      # @return [ FFI::Pointer ] A pointer to a mongocrypt_kms_ctx_t object.
      attr_reader :kms_ctx_p

      # Return the endpoint at which to make the HTTP request.
      #
      # @return [ String ] The endpoint.
      def endpoint
        Binding.kms_ctx_endpoint(self)
      end

      # Return the HTTP message to send to fetch information about the relevant
      # KMS data key.
      #
      # @return [ String ] The HTTP message.
      def message
        Binding.kms_ctx_message(self)
      end

      # Return the number of bytes still needed by libmongocrypt to complete
      # the request for information about the AWS data key.
      #
      # @return [ Integer ] The number of bytes needed.
      def bytes_needed
        Binding.kms_ctx_bytes_needed(self)
      end

      # Feed a response from the HTTP request to libmongocrypt.
      #
      # @param [ String ] data Data to feed to libmongocrypt.
      def feed(data)
        Binding.kms_ctx_feed(self, data)
      end
    end
  end
end