module Botan

Constants

DEFAULT_AEAD
DEFAULT_EME
DEFAULT_EMSA
DEFAULT_KDF_ALGO
DEFAULT_KDF_ITERATIONS
DEFAULT_KDF_SALT_LENGTH
DEFAULT_PBKDF_ALGO
VERSION

Public Class Methods

Digest(algo) click to toggle source

Returns a Digest subclass by name.

@param algo [String] the hash algorithm name @return [Class]

# File lib/botan/digest.rb, line 139
def Digest(algo)
  Botan::Digest.const_get(algo)
end

call_ffi(fn, *args) click to toggle source

@api private

Calls the LibBotan FFI function indicated. If the return code is <0, an error will be raised.

@param fn [Symbol] the name of the function to call @param args the arguments to pass to the FFI function @return [void]

# File lib/botan/utils.rb, line 49
def self.call_ffi(fn, *args)
  call_ffi_rc(fn, *args)
  nil
end

call_ffi_rc(fn, *args) click to toggle source

@api private

Calls the LibBotan FFI function indicated and returns the return code. If the return code is <0, an error will be raised.

@param fn [Symbol] the name of the function to call @param args the arguments to pass to the FFI function @return [Integer] the return code

# File lib/botan/utils.rb, line 35
def self.call_ffi_rc(fn, *args)
  rc = LibBotan.method(fn).call(*args)
  raise Botan::Error, "FFI call to #{fn} failed (rc: #{rc})" if rc.negative?
  rc
end

call_ffi_with_buffer(fn, guess: 4096, string: false) click to toggle source

@api private

Calls the LibBotan FFI function indicated If the return code is <0, an error will be raised.

@param fn [#call] a proc/lambda taking two parameters. @param guess [Integer] an initial guess for the buffer size @param string [Boolean] true if the returned buffer is expected

to be a NULL-terminated string.

@return [String] the data

# File lib/botan/utils.rb, line 64
def self.call_ffi_with_buffer(fn, guess: 4096, string: false)
  buf = FFI::MemoryPointer.new(:uint8, guess)
  buf_len_ptr = FFI::MemoryPointer.new(:size_t)
  buf_len_ptr.write(:size_t, buf.size)

  rc = fn.call(buf, buf_len_ptr)
  buf_len = buf_len_ptr.read(:size_t)
  # Call should only fail if buffer was inadequate, and should
  # only succeed if buffer was adequate.
  if (rc.negative? && buf_len <= buf.size) || (rc >= 0 && buf_len > buf.size)
    raise Botan::Error, 'FFI call unexpectedly failed'
  end

  if rc.negative?
    return call_ffi_with_buffer(fn, guess: buf_len, string: string)
  else
    string ? buf.read_string : buf.read_bytes(buf_len)
  end
end

hex_decode(hexs) click to toggle source

Decodes the provided hexadecimal string to a byte string.

@param hexs [String] the hexadecimal string @return [String] the decoded data

# File lib/botan/utils.rb, line 23
def self.hex_decode(hexs)
  [hexs].pack('H*')
end

hex_encode(data) click to toggle source

Encodes the provided data as a hexadecimal string.

@param data [String] the data to encode @return [String] the data as a hexadecimal string

# File lib/botan/utils.rb, line 15
def self.hex_encode(data)
  data.unpack('H*')[0]
end

inspect_ptr(myself) click to toggle source

@api private

# File lib/botan/utils.rb, line 85
def self.inspect_ptr(myself)
  ptr_format = "0x%0#{FFI::Pointer.size * 2}x"
  ptr_s = format(ptr_format, myself.instance_variable_get(:@ptr).address)
  class_name = myself.class.to_s
  "#<#{class_name}:#{ptr_s}>"
end

Private Instance Methods

Digest(algo) click to toggle source

Returns a Digest subclass by name.

@param algo [String] the hash algorithm name @return [Class]

# File lib/botan/digest.rb, line 139
def Digest(algo)
  Botan::Digest.const_get(algo)
end